AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::EventBridge::Model::Target Class Reference

#include <Target.h>

Public Member Functions

 Target ()
 
 Target (Aws::Utils::Json::JsonView jsonValue)
 
Targetoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
TargetWithId (const Aws::String &value)
 
TargetWithId (Aws::String &&value)
 
TargetWithId (const char *value)
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
TargetWithArn (const Aws::String &value)
 
TargetWithArn (Aws::String &&value)
 
TargetWithArn (const char *value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
TargetWithRoleArn (const Aws::String &value)
 
TargetWithRoleArn (Aws::String &&value)
 
TargetWithRoleArn (const char *value)
 
const Aws::StringGetInput () const
 
bool InputHasBeenSet () const
 
void SetInput (const Aws::String &value)
 
void SetInput (Aws::String &&value)
 
void SetInput (const char *value)
 
TargetWithInput (const Aws::String &value)
 
TargetWithInput (Aws::String &&value)
 
TargetWithInput (const char *value)
 
const Aws::StringGetInputPath () const
 
bool InputPathHasBeenSet () const
 
void SetInputPath (const Aws::String &value)
 
void SetInputPath (Aws::String &&value)
 
void SetInputPath (const char *value)
 
TargetWithInputPath (const Aws::String &value)
 
TargetWithInputPath (Aws::String &&value)
 
TargetWithInputPath (const char *value)
 
const InputTransformerGetInputTransformer () const
 
bool InputTransformerHasBeenSet () const
 
void SetInputTransformer (const InputTransformer &value)
 
void SetInputTransformer (InputTransformer &&value)
 
TargetWithInputTransformer (const InputTransformer &value)
 
TargetWithInputTransformer (InputTransformer &&value)
 
const KinesisParametersGetKinesisParameters () const
 
bool KinesisParametersHasBeenSet () const
 
void SetKinesisParameters (const KinesisParameters &value)
 
void SetKinesisParameters (KinesisParameters &&value)
 
TargetWithKinesisParameters (const KinesisParameters &value)
 
TargetWithKinesisParameters (KinesisParameters &&value)
 
const RunCommandParametersGetRunCommandParameters () const
 
bool RunCommandParametersHasBeenSet () const
 
void SetRunCommandParameters (const RunCommandParameters &value)
 
void SetRunCommandParameters (RunCommandParameters &&value)
 
TargetWithRunCommandParameters (const RunCommandParameters &value)
 
TargetWithRunCommandParameters (RunCommandParameters &&value)
 
const EcsParametersGetEcsParameters () const
 
bool EcsParametersHasBeenSet () const
 
void SetEcsParameters (const EcsParameters &value)
 
void SetEcsParameters (EcsParameters &&value)
 
TargetWithEcsParameters (const EcsParameters &value)
 
TargetWithEcsParameters (EcsParameters &&value)
 
const BatchParametersGetBatchParameters () const
 
bool BatchParametersHasBeenSet () const
 
void SetBatchParameters (const BatchParameters &value)
 
void SetBatchParameters (BatchParameters &&value)
 
TargetWithBatchParameters (const BatchParameters &value)
 
TargetWithBatchParameters (BatchParameters &&value)
 
const SqsParametersGetSqsParameters () const
 
bool SqsParametersHasBeenSet () const
 
void SetSqsParameters (const SqsParameters &value)
 
void SetSqsParameters (SqsParameters &&value)
 
TargetWithSqsParameters (const SqsParameters &value)
 
TargetWithSqsParameters (SqsParameters &&value)
 
const HttpParametersGetHttpParameters () const
 
bool HttpParametersHasBeenSet () const
 
void SetHttpParameters (const HttpParameters &value)
 
void SetHttpParameters (HttpParameters &&value)
 
TargetWithHttpParameters (const HttpParameters &value)
 
TargetWithHttpParameters (HttpParameters &&value)
 
const RedshiftDataParametersGetRedshiftDataParameters () const
 
bool RedshiftDataParametersHasBeenSet () const
 
void SetRedshiftDataParameters (const RedshiftDataParameters &value)
 
void SetRedshiftDataParameters (RedshiftDataParameters &&value)
 
TargetWithRedshiftDataParameters (const RedshiftDataParameters &value)
 
TargetWithRedshiftDataParameters (RedshiftDataParameters &&value)
 
const DeadLetterConfigGetDeadLetterConfig () const
 
bool DeadLetterConfigHasBeenSet () const
 
void SetDeadLetterConfig (const DeadLetterConfig &value)
 
void SetDeadLetterConfig (DeadLetterConfig &&value)
 
TargetWithDeadLetterConfig (const DeadLetterConfig &value)
 
TargetWithDeadLetterConfig (DeadLetterConfig &&value)
 
const RetryPolicyGetRetryPolicy () const
 
bool RetryPolicyHasBeenSet () const
 
void SetRetryPolicy (const RetryPolicy &value)
 
void SetRetryPolicy (RetryPolicy &&value)
 
TargetWithRetryPolicy (const RetryPolicy &value)
 
TargetWithRetryPolicy (RetryPolicy &&value)
 

Detailed Description

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 AWS Accounts in the Amazon EventBridge User Guide.

See Also:

AWS API Reference

Definition at line 50 of file Target.h.

Constructor & Destructor Documentation

◆ Target() [1/2]

Aws::EventBridge::Model::Target::Target ( )

◆ Target() [2/2]

Aws::EventBridge::Model::Target::Target ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ArnHasBeenSet()

bool Aws::EventBridge::Model::Target::ArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the target.

Definition at line 108 of file Target.h.

◆ BatchParametersHasBeenSet()

bool Aws::EventBridge::Model::Target::BatchParametersHasBeenSet ( ) const
inline

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.

Definition at line 520 of file Target.h.

◆ DeadLetterConfigHasBeenSet()

bool Aws::EventBridge::Model::Target::DeadLetterConfigHasBeenSet ( ) const
inline

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

Definition at line 706 of file Target.h.

◆ EcsParametersHasBeenSet()

bool Aws::EventBridge::Model::Target::EcsParametersHasBeenSet ( ) const
inline

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.

Definition at line 467 of file Target.h.

◆ GetArn()

const Aws::String& Aws::EventBridge::Model::Target::GetArn ( ) const
inline

The Amazon Resource Name (ARN) of the target.

Definition at line 103 of file Target.h.

◆ GetBatchParameters()

const BatchParameters& Aws::EventBridge::Model::Target::GetBatchParameters ( ) const
inline

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.

Definition at line 512 of file Target.h.

◆ GetDeadLetterConfig()

const DeadLetterConfig& Aws::EventBridge::Model::Target::GetDeadLetterConfig ( ) const
inline

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

Definition at line 700 of file Target.h.

◆ GetEcsParameters()

const EcsParameters& Aws::EventBridge::Model::Target::GetEcsParameters ( ) const
inline

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.

Definition at line 458 of file Target.h.

◆ GetHttpParameters()

const HttpParameters& Aws::EventBridge::Model::Target::GetHttpParameters ( ) const
inline

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.

Definition at line 604 of file Target.h.

◆ GetId()

const Aws::String& Aws::EventBridge::Model::Target::GetId ( ) const
inline

The ID of the target.

Definition at line 62 of file Target.h.

◆ GetInput()

const Aws::String& Aws::EventBridge::Model::Target::GetInput ( ) const
inline

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.

Definition at line 204 of file Target.h.

◆ GetInputPath()

const Aws::String& Aws::EventBridge::Model::Target::GetInputPath ( ) const
inline

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.

Definition at line 269 of file Target.h.

◆ GetInputTransformer()

const InputTransformer& Aws::EventBridge::Model::Target::GetInputTransformer ( ) const
inline

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.

Definition at line 333 of file Target.h.

◆ GetKinesisParameters()

const KinesisParameters& Aws::EventBridge::Model::Target::GetKinesisParameters ( ) const
inline

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.

Definition at line 376 of file Target.h.

◆ GetRedshiftDataParameters()

const RedshiftDataParameters& Aws::EventBridge::Model::Target::GetRedshiftDataParameters ( ) const
inline

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

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

Definition at line 653 of file Target.h.

◆ GetRetryPolicy()

const RetryPolicy& Aws::EventBridge::Model::Target::GetRetryPolicy ( ) const
inline

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

Definition at line 737 of file Target.h.

◆ GetRoleArn()

const Aws::String& Aws::EventBridge::Model::Target::GetRoleArn ( ) const
inline

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.

Definition at line 146 of file Target.h.

◆ GetRunCommandParameters()

const RunCommandParameters& Aws::EventBridge::Model::Target::GetRunCommandParameters ( ) const
inline

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

Definition at line 418 of file Target.h.

◆ GetSqsParameters()

const SqsParameters& Aws::EventBridge::Model::Target::GetSqsParameters ( ) const
inline

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.

Definition at line 560 of file Target.h.

◆ HttpParametersHasBeenSet()

bool Aws::EventBridge::Model::Target::HttpParametersHasBeenSet ( ) const
inline

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.

Definition at line 612 of file Target.h.

◆ IdHasBeenSet()

bool Aws::EventBridge::Model::Target::IdHasBeenSet ( ) const
inline

The ID of the target.

Definition at line 67 of file Target.h.

◆ InputHasBeenSet()

bool Aws::EventBridge::Model::Target::InputHasBeenSet ( ) const
inline

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.

Definition at line 212 of file Target.h.

◆ InputPathHasBeenSet()

bool Aws::EventBridge::Model::Target::InputPathHasBeenSet ( ) const
inline

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.

Definition at line 277 of file Target.h.

◆ InputTransformerHasBeenSet()

bool Aws::EventBridge::Model::Target::InputTransformerHasBeenSet ( ) const
inline

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.

Definition at line 340 of file Target.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::EventBridge::Model::Target::Jsonize ( ) const

◆ KinesisParametersHasBeenSet()

bool Aws::EventBridge::Model::Target::KinesisParametersHasBeenSet ( ) const
inline

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.

Definition at line 383 of file Target.h.

◆ operator=()

Target& Aws::EventBridge::Model::Target::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RedshiftDataParametersHasBeenSet()

bool Aws::EventBridge::Model::Target::RedshiftDataParametersHasBeenSet ( ) const
inline

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

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

Definition at line 661 of file Target.h.

◆ RetryPolicyHasBeenSet()

bool Aws::EventBridge::Model::Target::RetryPolicyHasBeenSet ( ) const
inline

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

Definition at line 743 of file Target.h.

◆ RoleArnHasBeenSet()

bool Aws::EventBridge::Model::Target::RoleArnHasBeenSet ( ) const
inline

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.

Definition at line 153 of file Target.h.

◆ RunCommandParametersHasBeenSet()

bool Aws::EventBridge::Model::Target::RunCommandParametersHasBeenSet ( ) const
inline

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

Definition at line 424 of file Target.h.

◆ SetArn() [1/3]

void Aws::EventBridge::Model::Target::SetArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the target.

Definition at line 113 of file Target.h.

◆ SetArn() [2/3]

void Aws::EventBridge::Model::Target::SetArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the target.

Definition at line 118 of file Target.h.

◆ SetArn() [3/3]

void Aws::EventBridge::Model::Target::SetArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the target.

Definition at line 123 of file Target.h.

◆ SetBatchParameters() [1/2]

void Aws::EventBridge::Model::Target::SetBatchParameters ( const BatchParameters value)
inline

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.

Definition at line 528 of file Target.h.

◆ SetBatchParameters() [2/2]

void Aws::EventBridge::Model::Target::SetBatchParameters ( BatchParameters &&  value)
inline

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.

Definition at line 536 of file Target.h.

◆ SetDeadLetterConfig() [1/2]

void Aws::EventBridge::Model::Target::SetDeadLetterConfig ( const DeadLetterConfig value)
inline

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

Definition at line 712 of file Target.h.

◆ SetDeadLetterConfig() [2/2]

void Aws::EventBridge::Model::Target::SetDeadLetterConfig ( DeadLetterConfig &&  value)
inline

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

Definition at line 718 of file Target.h.

◆ SetEcsParameters() [1/2]

void Aws::EventBridge::Model::Target::SetEcsParameters ( const EcsParameters value)
inline

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.

Definition at line 476 of file Target.h.

◆ SetEcsParameters() [2/2]

void Aws::EventBridge::Model::Target::SetEcsParameters ( EcsParameters &&  value)
inline

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.

Definition at line 485 of file Target.h.

◆ SetHttpParameters() [1/2]

void Aws::EventBridge::Model::Target::SetHttpParameters ( const HttpParameters value)
inline

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.

Definition at line 620 of file Target.h.

◆ SetHttpParameters() [2/2]

void Aws::EventBridge::Model::Target::SetHttpParameters ( HttpParameters &&  value)
inline

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.

Definition at line 628 of file Target.h.

◆ SetId() [1/3]

void Aws::EventBridge::Model::Target::SetId ( const Aws::String value)
inline

The ID of the target.

Definition at line 72 of file Target.h.

◆ SetId() [2/3]

void Aws::EventBridge::Model::Target::SetId ( Aws::String &&  value)
inline

The ID of the target.

Definition at line 77 of file Target.h.

◆ SetId() [3/3]

void Aws::EventBridge::Model::Target::SetId ( const char *  value)
inline

The ID of the target.

Definition at line 82 of file Target.h.

◆ SetInput() [1/3]

void Aws::EventBridge::Model::Target::SetInput ( const Aws::String value)
inline

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.

Definition at line 220 of file Target.h.

◆ SetInput() [2/3]

void Aws::EventBridge::Model::Target::SetInput ( Aws::String &&  value)
inline

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.

Definition at line 228 of file Target.h.

◆ SetInput() [3/3]

void Aws::EventBridge::Model::Target::SetInput ( const char *  value)
inline

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.

Definition at line 236 of file Target.h.

◆ SetInputPath() [1/3]

void Aws::EventBridge::Model::Target::SetInputPath ( const Aws::String value)
inline

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.

Definition at line 285 of file Target.h.

◆ SetInputPath() [2/3]

void Aws::EventBridge::Model::Target::SetInputPath ( Aws::String &&  value)
inline

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.

Definition at line 293 of file Target.h.

◆ SetInputPath() [3/3]

void Aws::EventBridge::Model::Target::SetInputPath ( const char *  value)
inline

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.

Definition at line 301 of file Target.h.

◆ SetInputTransformer() [1/2]

void Aws::EventBridge::Model::Target::SetInputTransformer ( const InputTransformer value)
inline

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.

Definition at line 347 of file Target.h.

◆ SetInputTransformer() [2/2]

void Aws::EventBridge::Model::Target::SetInputTransformer ( InputTransformer &&  value)
inline

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.

Definition at line 354 of file Target.h.

◆ SetKinesisParameters() [1/2]

void Aws::EventBridge::Model::Target::SetKinesisParameters ( const KinesisParameters value)
inline

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.

Definition at line 390 of file Target.h.

◆ SetKinesisParameters() [2/2]

void Aws::EventBridge::Model::Target::SetKinesisParameters ( KinesisParameters &&  value)
inline

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.

Definition at line 397 of file Target.h.

◆ SetRedshiftDataParameters() [1/2]

void Aws::EventBridge::Model::Target::SetRedshiftDataParameters ( const RedshiftDataParameters value)
inline

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

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

Definition at line 669 of file Target.h.

◆ SetRedshiftDataParameters() [2/2]

void Aws::EventBridge::Model::Target::SetRedshiftDataParameters ( RedshiftDataParameters &&  value)
inline

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

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

Definition at line 677 of file Target.h.

◆ SetRetryPolicy() [1/2]

void Aws::EventBridge::Model::Target::SetRetryPolicy ( const RetryPolicy value)
inline

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

Definition at line 749 of file Target.h.

◆ SetRetryPolicy() [2/2]

void Aws::EventBridge::Model::Target::SetRetryPolicy ( RetryPolicy &&  value)
inline

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

Definition at line 755 of file Target.h.

◆ SetRoleArn() [1/3]

void Aws::EventBridge::Model::Target::SetRoleArn ( const Aws::String value)
inline

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.

Definition at line 160 of file Target.h.

◆ SetRoleArn() [2/3]

void Aws::EventBridge::Model::Target::SetRoleArn ( Aws::String &&  value)
inline

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.

Definition at line 167 of file Target.h.

◆ SetRoleArn() [3/3]

void Aws::EventBridge::Model::Target::SetRoleArn ( const char *  value)
inline

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.

Definition at line 174 of file Target.h.

◆ SetRunCommandParameters() [1/2]

void Aws::EventBridge::Model::Target::SetRunCommandParameters ( const RunCommandParameters value)
inline

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

Definition at line 430 of file Target.h.

◆ SetRunCommandParameters() [2/2]

void Aws::EventBridge::Model::Target::SetRunCommandParameters ( RunCommandParameters &&  value)
inline

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

Definition at line 436 of file Target.h.

◆ SetSqsParameters() [1/2]

void Aws::EventBridge::Model::Target::SetSqsParameters ( const SqsParameters value)
inline

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.

Definition at line 574 of file Target.h.

◆ SetSqsParameters() [2/2]

void Aws::EventBridge::Model::Target::SetSqsParameters ( SqsParameters &&  value)
inline

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.

Definition at line 581 of file Target.h.

◆ SqsParametersHasBeenSet()

bool Aws::EventBridge::Model::Target::SqsParametersHasBeenSet ( ) const
inline

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.

Definition at line 567 of file Target.h.

◆ WithArn() [1/3]

Target& Aws::EventBridge::Model::Target::WithArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the target.

Definition at line 128 of file Target.h.

◆ WithArn() [2/3]

Target& Aws::EventBridge::Model::Target::WithArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the target.

Definition at line 133 of file Target.h.

◆ WithArn() [3/3]

Target& Aws::EventBridge::Model::Target::WithArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the target.

Definition at line 138 of file Target.h.

◆ WithBatchParameters() [1/2]

Target& Aws::EventBridge::Model::Target::WithBatchParameters ( const BatchParameters value)
inline

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.

Definition at line 544 of file Target.h.

◆ WithBatchParameters() [2/2]

Target& Aws::EventBridge::Model::Target::WithBatchParameters ( BatchParameters &&  value)
inline

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.

Definition at line 552 of file Target.h.

◆ WithDeadLetterConfig() [1/2]

Target& Aws::EventBridge::Model::Target::WithDeadLetterConfig ( const DeadLetterConfig value)
inline

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

Definition at line 724 of file Target.h.

◆ WithDeadLetterConfig() [2/2]

Target& Aws::EventBridge::Model::Target::WithDeadLetterConfig ( DeadLetterConfig &&  value)
inline

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

Definition at line 730 of file Target.h.

◆ WithEcsParameters() [1/2]

Target& Aws::EventBridge::Model::Target::WithEcsParameters ( const EcsParameters value)
inline

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.

Definition at line 494 of file Target.h.

◆ WithEcsParameters() [2/2]

Target& Aws::EventBridge::Model::Target::WithEcsParameters ( EcsParameters &&  value)
inline

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.

Definition at line 503 of file Target.h.

◆ WithHttpParameters() [1/2]

Target& Aws::EventBridge::Model::Target::WithHttpParameters ( const HttpParameters value)
inline

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.

Definition at line 636 of file Target.h.

◆ WithHttpParameters() [2/2]

Target& Aws::EventBridge::Model::Target::WithHttpParameters ( HttpParameters &&  value)
inline

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.

Definition at line 644 of file Target.h.

◆ WithId() [1/3]

Target& Aws::EventBridge::Model::Target::WithId ( const Aws::String value)
inline

The ID of the target.

Definition at line 87 of file Target.h.

◆ WithId() [2/3]

Target& Aws::EventBridge::Model::Target::WithId ( Aws::String &&  value)
inline

The ID of the target.

Definition at line 92 of file Target.h.

◆ WithId() [3/3]

Target& Aws::EventBridge::Model::Target::WithId ( const char *  value)
inline

The ID of the target.

Definition at line 97 of file Target.h.

◆ WithInput() [1/3]

Target& Aws::EventBridge::Model::Target::WithInput ( const Aws::String value)
inline

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.

Definition at line 244 of file Target.h.

◆ WithInput() [2/3]

Target& Aws::EventBridge::Model::Target::WithInput ( Aws::String &&  value)
inline

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.

Definition at line 252 of file Target.h.

◆ WithInput() [3/3]

Target& Aws::EventBridge::Model::Target::WithInput ( const char *  value)
inline

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.

Definition at line 260 of file Target.h.

◆ WithInputPath() [1/3]

Target& Aws::EventBridge::Model::Target::WithInputPath ( const Aws::String value)
inline

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.

Definition at line 309 of file Target.h.

◆ WithInputPath() [2/3]

Target& Aws::EventBridge::Model::Target::WithInputPath ( Aws::String &&  value)
inline

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.

Definition at line 317 of file Target.h.

◆ WithInputPath() [3/3]

Target& Aws::EventBridge::Model::Target::WithInputPath ( const char *  value)
inline

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.

Definition at line 325 of file Target.h.

◆ WithInputTransformer() [1/2]

Target& Aws::EventBridge::Model::Target::WithInputTransformer ( const InputTransformer value)
inline

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.

Definition at line 361 of file Target.h.

◆ WithInputTransformer() [2/2]

Target& Aws::EventBridge::Model::Target::WithInputTransformer ( InputTransformer &&  value)
inline

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.

Definition at line 368 of file Target.h.

◆ WithKinesisParameters() [1/2]

Target& Aws::EventBridge::Model::Target::WithKinesisParameters ( const KinesisParameters value)
inline

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.

Definition at line 404 of file Target.h.

◆ WithKinesisParameters() [2/2]

Target& Aws::EventBridge::Model::Target::WithKinesisParameters ( KinesisParameters &&  value)
inline

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.

Definition at line 411 of file Target.h.

◆ WithRedshiftDataParameters() [1/2]

Target& Aws::EventBridge::Model::Target::WithRedshiftDataParameters ( const RedshiftDataParameters value)
inline

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

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

Definition at line 685 of file Target.h.

◆ WithRedshiftDataParameters() [2/2]

Target& Aws::EventBridge::Model::Target::WithRedshiftDataParameters ( RedshiftDataParameters &&  value)
inline

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

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

Definition at line 693 of file Target.h.

◆ WithRetryPolicy() [1/2]

Target& Aws::EventBridge::Model::Target::WithRetryPolicy ( const RetryPolicy value)
inline

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

Definition at line 761 of file Target.h.

◆ WithRetryPolicy() [2/2]

Target& Aws::EventBridge::Model::Target::WithRetryPolicy ( RetryPolicy &&  value)
inline

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

Definition at line 767 of file Target.h.

◆ WithRoleArn() [1/3]

Target& Aws::EventBridge::Model::Target::WithRoleArn ( const Aws::String value)
inline

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.

Definition at line 181 of file Target.h.

◆ WithRoleArn() [2/3]

Target& Aws::EventBridge::Model::Target::WithRoleArn ( Aws::String &&  value)
inline

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.

Definition at line 188 of file Target.h.

◆ WithRoleArn() [3/3]

Target& Aws::EventBridge::Model::Target::WithRoleArn ( const char *  value)
inline

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.

Definition at line 195 of file Target.h.

◆ WithRunCommandParameters() [1/2]

Target& Aws::EventBridge::Model::Target::WithRunCommandParameters ( const RunCommandParameters value)
inline

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

Definition at line 442 of file Target.h.

◆ WithRunCommandParameters() [2/2]

Target& Aws::EventBridge::Model::Target::WithRunCommandParameters ( RunCommandParameters &&  value)
inline

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

Definition at line 448 of file Target.h.

◆ WithSqsParameters() [1/2]

Target& Aws::EventBridge::Model::Target::WithSqsParameters ( const SqsParameters value)
inline

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.

Definition at line 588 of file Target.h.

◆ WithSqsParameters() [2/2]

Target& Aws::EventBridge::Model::Target::WithSqsParameters ( SqsParameters &&  value)
inline

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.

Definition at line 595 of file Target.h.


The documentation for this class was generated from the following file: