Struct Target 

#[non_exhaustive]
pub struct Target {
    pub arn: String,
    pub role_arn: String,
    pub dead_letter_config: Option<DeadLetterConfig>,
    pub retry_policy: Option<RetryPolicy>,
    pub input: Option<String>,
    pub ecs_parameters: Option<EcsParameters>,
    pub event_bridge_parameters: Option<EventBridgeParameters>,
    pub kinesis_parameters: Option<KinesisParameters>,
    pub sage_maker_pipeline_parameters: Option<SageMakerPipelineParameters>,
    pub sqs_parameters: Option<SqsParameters>,
}

The schedule's target. EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize to invoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

arn: String

The Amazon Resource Name (ARN) of the target.

role_arn: String

The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.

dead_letter_config: Option<DeadLetterConfig>

An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.

retry_policy: Option<RetryPolicy>

A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.

input: Option<String>

The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the target.

ecs_parameters: Option<EcsParameters>

The templated target type for the Amazon ECS RunTask API operation.

event_bridge_parameters: Option<EventBridgeParameters>

The templated target type for the EventBridge PutEvents API operation.

kinesis_parameters: Option<KinesisParameters>

The templated target type for the Amazon Kinesis PutRecord API operation.

sage_maker_pipeline_parameters: Option<SageMakerPipelineParameters>

The templated target type for the Amazon SageMaker StartPipelineExecution API operation.

sqs_parameters: Option<SqsParameters>

The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide.

Implementations

impl Target

pub fn arn(&self) -> &str

The Amazon Resource Name (ARN) of the target.

pub fn role_arn(&self) -> &str

The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.

pub fn dead_letter_config(&self) -> Option<&DeadLetterConfig>

An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.

pub fn retry_policy(&self) -> Option<&RetryPolicy>

A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.

pub fn input(&self) -> Option<&str>

The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the target.

pub fn ecs_parameters(&self) -> Option<&EcsParameters>

The templated target type for the Amazon ECS RunTask API operation.

pub fn event_bridge_parameters(&self) -> Option<&EventBridgeParameters>

The templated target type for the EventBridge PutEvents API operation.

pub fn kinesis_parameters(&self) -> Option<&KinesisParameters>

The templated target type for the Amazon Kinesis PutRecord API operation.

pub fn sage_maker_pipeline_parameters( &self, ) -> Option<&SageMakerPipelineParameters>

The templated target type for the Amazon SageMaker StartPipelineExecution API operation.

pub fn sqs_parameters(&self) -> Option<&SqsParameters>

The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide.

impl Target

pub fn builder() -> TargetBuilder

Creates a new builder-style object to manufacture Target.

Trait Implementations

impl Clone for Target

fn clone(&self) -> Target

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Target

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

Formats the value using the given formatter.

impl PartialEq for Target

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Target