eventbridge/aws.sdk.kotlin.services.eventbridge.model/Target

Target

Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see PutTargets.

If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.

Types

Builder

class Builder

Companion

object Companion

Properties

appSyncParameters

val appSyncParameters: AppSyncParameters?

Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.

arn

val arn: String

The Amazon Resource Name (ARN) of the target.

batchParameters

val batchParameters: BatchParameters?

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

val deadLetterConfig: DeadLetterConfig?

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

ecsParameters

val 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

val httpParameters: HttpParameters?

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

val id: String

The ID of the target within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.

input

val 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

val inputPath: String?

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

inputTransformer

val 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

val 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

val redshiftDataParameters: RedshiftDataParameters?

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

retryPolicy

val retryPolicy: RetryPolicy?

The retry policy configuration to use for the dead-letter queue.

roleArn

val 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

val runCommandParameters: RunCommandParameters?

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

sageMakerPipelineParameters

val sageMakerPipelineParameters: SageMakerPipelineParameters?

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

sqsParameters

val sqsParameters: SqsParameters?

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