Schedule
The object describing a Schedule
event source type, which sets your state machine as the target of an EventBridge rule that triggers on a schedule. For more information, see What Is Amazon EventBridge? in the Amazon EventBridge User Guide.
AWS Serverless Application Model (AWS SAM) generates an AWS::Events::Rule resource when this event type is set.
Syntax
To declare this entity in your AWS Serverless Application Model (AWS SAM) template, use the following syntax.
YAML
DeadLetterConfig:
DeadLetterConfig
Description:String
Enabled:Boolean
Input:String
Name:String
RetryPolicy:RetryPolicy
Schedule:String
Properties
-
DeadLetterConfig
-
Configure the Amazon Simple Queue Service (Amazon SQS) queue where EventBridge sends events after a failed target invocation. Invocation can fail, for example, when sending an event to a Lambda function that doesn't exist, or when EventBridge has insufficient permissions to invoke the Lambda function. For more information, see Event retry policy and using dead-letter queues in the Amazon EventBridge User Guide.
Type: DeadLetterConfig
Required: No
AWS CloudFormation compatibility: This property is similar to the
DeadLetterConfig
property of theAWS::Events::Rule
Target
data type. The AWS SAM version of this property includes additional subproperties, in case you want AWS SAM to create the dead-letter queue for you. -
Description
-
A description of the rule.
Type: String
Required: No
AWS CloudFormation compatibility: This property is passed directly to the
Description
property of anAWS::Events::Rule
resource. -
Enabled
-
Indicates whether the rule is enabled.
To disable the rule, set this property to
false
.Type: Boolean
Required: No
AWS CloudFormation compatibility: This property is similar to the
State
property of anAWS::Events::Rule
resource. If this property is set totrue
then AWS SAM passesENABLED
, otherwise it passesDISABLED
. -
Input
-
Valid JSON text passed to the target. If you use this property, nothing from the event text itself is passed to the target.
Type: String
Required: No
AWS CloudFormation compatibility: This property is passed directly to the
Target
property of anAWS::Events::Rule Target
resource. -
Name
-
The name of the rule. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the rule name.
Type: String
Required: No
AWS CloudFormation compatibility: This property is passed directly to the
Name
property of anAWS::Events::Rule
resource. -
RetryPolicy
-
A
RetryPolicy
object that includes information about the retry policy settings. For more information, see Event retry policy and using dead-letter queues in the Amazon EventBridge User Guide.Type: RetryPolicy
Required: No
AWS CloudFormation compatibility: This property is passed directly to the
RetryPolicy
property of theAWS::Events::Rule
Target
data type. -
Schedule
-
The scheduling expression that determines when and how often the rule runs. For more information, see Schedule Expressions for Rules.
Type: String
Required: Yes
AWS CloudFormation compatibility: This property is passed directly to the
ScheduleExpression
property of anAWS::Events::Rule
resource.
Examples
CloudWatch Schedule Event
CloudWatch Schedule Event Example
YAML
CWSchedule: Type: Schedule Properties: Schedule: 'rate(1 minute)' Name: TestSchedule Description: test schedule Enabled: false