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:
JSON
{ "Arn" :String, "DeadLetterConfig" :DeadLetterConfig, "EcsParameters" :EcsParameters, "EventBridgeParameters" :EventBridgeParameters, "Input" :String, "KinesisParameters" :KinesisParameters, "RetryPolicy" :RetryPolicy, "RoleArn" :String, "SageMakerPipelineParameters" :SageMakerPipelineParameters, "SqsParameters" :SqsParameters}
YAML
Arn:StringDeadLetterConfig:DeadLetterConfigEcsParameters:EcsParametersEventBridgeParameters:EventBridgeParametersInput:StringKinesisParameters:KinesisParametersRetryPolicy:RetryPolicyRoleArn:StringSageMakerPipelineParameters:SageMakerPipelineParametersSqsParameters:SqsParameters
Properties
Arn-
The Amazon Resource Name (ARN) of the target.
Required: Yes
Type: String
Minimum:
1Maximum:
1600Update 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
RunTaskAPI operation.Required: No
Type: EcsParameters
Update requires: No interruption
EventBridgeParameters-
The templated target type for the EventBridge
PutEventsAPI 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
Minimum:
1Update requires: No interruption
KinesisParameters-
The templated target type for the Amazon Kinesis
PutRecordAPI operation.Required: No
Type: KinesisParameters
Update requires: No interruption
RetryPolicy-
A
RetryPolicyobject 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
Pattern:
^arn:aws(-[a-z]+)?:iam::\d{12}:role\/[\w+=,.@\/-]+$Minimum:
1Maximum:
1600Update requires: No interruption
SageMakerPipelineParameters-
The templated target type for the Amazon SageMaker
StartPipelineExecutionAPI operation.Required: No
Type: SageMakerPipelineParameters
Update requires: No interruption
SqsParameters-
The templated target type for the Amazon SQS
SendMessageAPI 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