/AWS1/CL_CWETARGET

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.

CONSTRUCTOR

IMPORTING

Required arguments:

IV_ID TYPE /AWS1/CWETARGETID /AWS1/CWETARGETID

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

IV_ARN TYPE /AWS1/CWETARGETARN /AWS1/CWETARGETARN

The Amazon Resource Name (ARN) of the target.

Optional arguments:

IV_ROLEARN TYPE /AWS1/CWEROLEARN /AWS1/CWEROLEARN

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.

IV_INPUT TYPE /AWS1/CWETARGETINPUT /AWS1/CWETARGETINPUT

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.

IV_INPUTPATH TYPE /AWS1/CWETARGETINPUTPATH /AWS1/CWETARGETINPUTPATH

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.

IO_INPUTTRANSFORMER TYPE REF TO /AWS1/CL_CWEINPUTTRANSFORMER /AWS1/CL_CWEINPUTTRANSFORMER

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.

IO_KINESISPARAMETERS TYPE REF TO /AWS1/CL_CWEKINESISPARAMETERS /AWS1/CL_CWEKINESISPARAMETERS

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.

IO_RUNCOMMANDPARAMETERS TYPE REF TO /AWS1/CL_CWERUNCOMMANDPARAMS /AWS1/CL_CWERUNCOMMANDPARAMS

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

IO_ECSPARAMETERS TYPE REF TO /AWS1/CL_CWEECSPARAMETERS /AWS1/CL_CWEECSPARAMETERS

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.

IO_BATCHPARAMETERS TYPE REF TO /AWS1/CL_CWEBATCHPARAMETERS /AWS1/CL_CWEBATCHPARAMETERS

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.

IO_SQSPARAMETERS TYPE REF TO /AWS1/CL_CWESQSPARAMETERS /AWS1/CL_CWESQSPARAMETERS

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.

IO_HTTPPARAMETERS TYPE REF TO /AWS1/CL_CWEHTTPPARAMETERS /AWS1/CL_CWEHTTPPARAMETERS

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

If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.

IO_REDSHIFTDATAPARAMETERS TYPE REF TO /AWS1/CL_CWEREDSHIFTDATAPARAMS /AWS1/CL_CWEREDSHIFTDATAPARAMS

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

If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

IO_SMPIPELINEPARAMETERS TYPE REF TO /AWS1/CL_CWESMPIPELINEPARAMS /AWS1/CL_CWESMPIPELINEPARAMS

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

If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.

IO_DEADLETTERCONFIG TYPE REF TO /AWS1/CL_CWEDEADLETTERCONFIG /AWS1/CL_CWEDEADLETTERCONFIG

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

IO_RETRYPOLICY TYPE REF TO /AWS1/CL_CWERETRYPOLICY /AWS1/CL_CWERETRYPOLICY

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

---

Queryable Attributes

Id

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

Accessible with the following methods

Method	Description
GET_ID()	Getter for ID, with configurable default
ASK_ID()	Getter for ID w/ exceptions if field has no value
HAS_ID()	Determine if ID has a value

Arn

The Amazon Resource Name (ARN) of the target.

Accessible with the following methods

Method	Description
GET_ARN()	Getter for ARN, with configurable default
ASK_ARN()	Getter for ARN w/ exceptions if field has no value
HAS_ARN()	Determine if ARN has a value

RoleArn

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.

Accessible with the following methods

Method	Description
GET_ROLEARN()	Getter for ROLEARN, with configurable default
ASK_ROLEARN()	Getter for ROLEARN w/ exceptions if field has no value
HAS_ROLEARN()	Determine if ROLEARN has a value

Input

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.

Accessible with the following methods

Method	Description
GET_INPUT()	Getter for INPUT, with configurable default
ASK_INPUT()	Getter for INPUT w/ exceptions if field has no value
HAS_INPUT()	Determine if INPUT has a value

InputPath

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.

Accessible with the following methods

Method	Description
GET_INPUTPATH()	Getter for INPUTPATH, with configurable default
ASK_INPUTPATH()	Getter for INPUTPATH w/ exceptions if field has no value
HAS_INPUTPATH()	Determine if INPUTPATH has a value

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.

Accessible with the following methods

Method	Description
GET_INPUTTRANSFORMER()	Getter for INPUTTRANSFORMER

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.

Accessible with the following methods

Method	Description
GET_KINESISPARAMETERS()	Getter for KINESISPARAMETERS

RunCommandParameters

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

Accessible with the following methods

Method	Description
GET_RUNCOMMANDPARAMETERS()	Getter for RUNCOMMANDPARAMETERS

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.

Accessible with the following methods

Method	Description
GET_ECSPARAMETERS()	Getter for ECSPARAMETERS

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.

Accessible with the following methods

Method	Description
GET_BATCHPARAMETERS()	Getter for BATCHPARAMETERS

SqsParameters

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.

Accessible with the following methods

Method	Description
GET_SQSPARAMETERS()	Getter for SQSPARAMETERS

HttpParameters

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

If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.

Accessible with the following methods

Method	Description
GET_HTTPPARAMETERS()	Getter for HTTPPARAMETERS

RedshiftDataParameters

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

If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

Accessible with the following methods

Method	Description
GET_REDSHIFTDATAPARAMETERS()	Getter for REDSHIFTDATAPARAMETERS

SageMakerPipelineParameters

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

If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.

Accessible with the following methods

Method	Description
GET_SMPIPELINEPARAMETERS()	Getter for SAGEMAKERPIPELINEPARAMETERS

DeadLetterConfig

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

Accessible with the following methods

Method	Description
GET_DEADLETTERCONFIG()	Getter for DEADLETTERCONFIG

RetryPolicy

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

Accessible with the following methods

Method	Description
GET_RETRYPOLICY()	Getter for RETRYPOLICY

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_TARGETLIST

TYPES TT_TARGETLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_CWETARGET WITH DEFAULT KEY
.