AWS::Scheduler::Schedule Target - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

AWS::Scheduler::Schedule Target

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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

Properties

Arn

The Amazon Resource Name (ARN) of the target.

Required: Yes

Type: String

Update requires: No interruption

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.

Required: No

Type: DeadLetterConfig

Update requires: No interruption

EcsParameters

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

Required: No

Type: EcsParameters

Update requires: No interruption

EventBridgeParameters

The templated target type for the EventBridge PutEvents API operation.

Required: No

Type: EventBridgeParameters

Update requires: No interruption

Input

The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, Amazon 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, Amazon EventBridge Scheduler delivers a default notification to the target.

Required: No

Type: String

Update requires: No interruption

KinesisParameters

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

Required: No

Type: KinesisParameters

Update requires: No interruption

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.

Required: No

Type: RetryPolicy

Update requires: No interruption

RoleArn

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

Required: Yes

Type: String

Update requires: No interruption

SageMakerPipelineParameters

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

Required: No

Type: SageMakerPipelineParameters

Update requires: No interruption

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.

Required: No

Type: SqsParameters

Update requires: No interruption