Target

public struct Target : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]
  • arn

    The Amazon Resource Name (ARN) of the target.

    Declaration

    Swift

    public let arn: String

  • If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide.

    Declaration

    Swift

    public let batchParameters: BatchParameters?

  • Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide.

    Declaration

    Swift

    public let ecsParameters: EcsParameters?

  • Contains the HTTP parameters to use when the target is a API Gateway REST endpoint. If you specify an API Gateway REST API as a target, you can use this parameter to specify headers, path parameter, query string keys/values as part of your target invoking request.

    Declaration

    Swift

    public let httpParameters: HttpParameters?
  • id

    The ID of the target.

    Declaration

    Swift

    public let id: String

  • Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.

    Declaration

    Swift

    public let input: String?

  • The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath.

    Declaration

    Swift

    public let inputPath: String?

  • Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.

    Declaration

    Swift

    public let inputTransformer: InputTransformer?

  • The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the eventId as the partition key.

    Declaration

    Swift

    public let kinesisParameters: KinesisParameters?

  • The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.

    Declaration

    Swift

    public let roleArn: String?

  • Parameters used when you are using the rule to invoke Amazon EC2 Run Command.

    Declaration

    Swift

    public let runCommandParameters: RunCommandParameters?

  • Contains the message group ID to use when the target is a FIFO queue. If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.

    Declaration

    Swift

    public let sqsParameters: SqsParameters?

  • Undocumented

    Declaration

    Swift

    public init(arn: String, batchParameters: BatchParameters? = nil, ecsParameters: EcsParameters? = nil, httpParameters: HttpParameters? = nil, id: String, input: String? = nil, inputPath: String? = nil, inputTransformer: InputTransformer? = nil, kinesisParameters: KinesisParameters? = nil, roleArn: String? = nil, runCommandParameters: RunCommandParameters? = nil, sqsParameters: SqsParameters? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws