cloudwatchevents/aws.sdk.kotlin.services.cloudwatchevents.model/Target/Builder

Builder

Properties

The Amazon Resource Name (ARN) of the target.

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

deadLetterConfig

var deadLetterConfig: DeadLetterConfig?

The DeadLetterConfig that defines the target queue to send dead-letter queue events to.

ecsParameters

var ecsParameters: EcsParameters?

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.

httpParameters

var httpParameters: HttpParameters?

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.

var id: String?

The ID of the target. We recommend using a memorable and unique string.

input

var input: 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.

inputPath

var inputPath: 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.

inputTransformer

var inputTransformer: InputTransformer?

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.

kinesisParameters

var kinesisParameters: KinesisParameters?

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.

redshiftDataParameters

var redshiftDataParameters: RedshiftDataParameters?

Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.

retryPolicy

var retryPolicy: RetryPolicy?

The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.

roleArn

var roleArn: String?

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.

runCommandParameters

var runCommandParameters: RunCommandParameters?

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

sageMakerPipelineParameters

var sageMakerPipelineParameters: SageMakerPipelineParameters?

Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.

sqsParameters

var sqsParameters: SqsParameters?

Contains the message group ID to use when the target is a FIFO queue.