Struct aws_sdk_eventbridge::types::builders::TargetBuilder

#[non_exhaustive]
pub struct TargetBuilder { /* private fields */ }

A builder for Target.

Implementations

impl TargetBuilder

pub fn id(self, input: impl Into<String>) -> Self

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.

pub fn set_id(self, input: Option<String>) -> Self

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.

pub fn arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the target.

pub fn set_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the target.

pub fn role_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_role_arn(self, input: Option<String>) -> Self

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.

pub fn input(self, input: impl Into<String>) -> Self

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.

pub fn set_input(self, input: Option<String>) -> Self

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.

pub fn input_path(self, input: impl Into<String>) -> Self

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.

pub fn set_input_path(self, input: Option<String>) -> Self

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.

pub fn input_transformer(self, input: InputTransformer) -> Self

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.

pub fn set_input_transformer(self, input: Option<InputTransformer>) -> Self

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.

pub fn kinesis_parameters(self, input: KinesisParameters) -> Self

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.

pub fn set_kinesis_parameters(self, input: Option<KinesisParameters>) -> Self

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.

pub fn run_command_parameters(self, input: RunCommandParameters) -> Self

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

pub fn set_run_command_parameters( self, input: Option<RunCommandParameters> ) -> Self

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

pub fn ecs_parameters(self, input: EcsParameters) -> Self

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.

pub fn set_ecs_parameters(self, input: Option<EcsParameters>) -> Self

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.

pub fn batch_parameters(self, input: BatchParameters) -> Self

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.

pub fn set_batch_parameters(self, input: Option<BatchParameters>) -> Self

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.

pub fn sqs_parameters(self, input: SqsParameters) -> Self

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.

pub fn set_sqs_parameters(self, input: Option<SqsParameters>) -> Self

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.

pub fn http_parameters(self, input: HttpParameters) -> Self

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

If you specify an API Gateway 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.

pub fn set_http_parameters(self, input: Option<HttpParameters>) -> Self

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

If you specify an API Gateway 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.

pub fn redshift_data_parameters(self, input: RedshiftDataParameters) -> Self

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.

pub fn set_redshift_data_parameters( self, input: Option<RedshiftDataParameters> ) -> Self

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.

pub fn sage_maker_pipeline_parameters( self, input: SageMakerPipelineParameters ) -> Self

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.

pub fn set_sage_maker_pipeline_parameters( self, input: Option<SageMakerPipelineParameters> ) -> Self

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.

pub fn dead_letter_config(self, input: DeadLetterConfig) -> Self

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

pub fn set_dead_letter_config(self, input: Option<DeadLetterConfig>) -> Self

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

pub fn retry_policy(self, input: RetryPolicy) -> Self

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

pub fn set_retry_policy(self, input: Option<RetryPolicy>) -> Self

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

pub fn build(self) -> Target

Consumes the builder and constructs a Target.

Trait Implementations

impl Clone for TargetBuilder

fn clone(&self) -> TargetBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TargetBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TargetBuilder

fn default() -> TargetBuilder

Returns the “default value” for a type.

impl PartialEq<TargetBuilder> for TargetBuilder

fn eq(&self, other: &TargetBuilder) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TargetBuilder