logo
pub struct Target {
Show 16 fields pub arn: String, pub batch_parameters: Option<BatchParameters>, pub dead_letter_config: Option<DeadLetterConfig>, pub ecs_parameters: Option<EcsParameters>, pub http_parameters: Option<HttpParameters>, pub id: String, pub input: Option<String>, pub input_path: Option<String>, pub input_transformer: Option<InputTransformer>, pub kinesis_parameters: Option<KinesisParameters>, pub redshift_data_parameters: Option<RedshiftDataParameters>, pub retry_policy: Option<RetryPolicy>, pub role_arn: Option<String>, pub run_command_parameters: Option<RunCommandParameters>, pub sage_maker_pipeline_parameters: Option<SageMakerPipelineParameters>, pub sqs_parameters: Option<SqsParameters>,
}
Expand 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.

Fields

arn: String

The Amazon Resource Name (ARN) of the target.

batch_parameters: Option<BatchParameters>

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.

dead_letter_config: Option<DeadLetterConfig>

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

ecs_parameters: Option<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.

http_parameters: Option<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.

id: String

The ID of the target.

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

input_path: Option<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.

input_transformer: Option<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.

kinesis_parameters: Option<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.

redshift_data_parameters: Option<RedshiftDataParameters>

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.

retry_policy: Option<RetryPolicy>

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

role_arn: Option<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.

run_command_parameters: Option<RunCommandParameters>

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

sage_maker_pipeline_parameters: Option<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.

sqs_parameters: Option<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.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Deserialize this value from the given Serde deserializer. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more