AWS::Scheduler::Schedule
Creates the specified schedule.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Scheduler::Schedule", "Properties" : { "Description" :
String
, "EndDate" :String
, "FlexibleTimeWindow" :FlexibleTimeWindow
, "GroupName" :String
, "KmsKeyArn" :String
, "Name" :String
, "ScheduleExpression" :String
, "ScheduleExpressionTimezone" :String
, "StartDate" :String
, "State" :String
, "Target" :Target
} }
YAML
Type: AWS::Scheduler::Schedule Properties: Description:
String
EndDate:String
FlexibleTimeWindow:FlexibleTimeWindow
GroupName:String
KmsKeyArn:String
Name:String
ScheduleExpression:String
ScheduleExpressionTimezone:String
StartDate:String
State:String
Target:Target
Properties
Description
-
The description you specify for the schedule.
Required: No
Type: String
Update requires: No interruption
EndDate
-
The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the
EndDate
you specify. EventBridge Scheduler ignoresEndDate
for one-time schedules.Required: No
Type: String
Update requires: No interruption
FlexibleTimeWindow
-
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
Required: Yes
Type: FlexibleTimeWindow
Update requires: No interruption
GroupName
-
The name of the schedule group associated with this schedule.
Required: No
Type: String
Update requires: No interruption
KmsKeyArn
-
The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
Required: No
Type: String
Update requires: No interruption
Name
-
The name of the schedule.
Required: No
Type: String
Update requires: Replacement
ScheduleExpression
-
The expression that defines when the schedule runs. The following formats are supported.
-
at
expression -at(yyyy-mm-ddThh:mm:ss)
-
rate
expression -rate(unit value)
-
cron
expression -cron(fields)
You can use
at
expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can userate
andcron
expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.A
cron
expression consists of six fields separated by white spaces:(minutes hours day_of_month month day_of_week year)
.A
rate
expression consists of a value as a positive integer, and a unit with the following options:minute
|minutes
|hour
|hours
|day
|days
For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.
Required: Yes
Type: String
Update requires: No interruption
-
ScheduleExpressionTimezone
-
The timezone in which the scheduling expression is evaluated.
Required: No
Type: String
Update requires: No interruption
StartDate
-
The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the
StartDate
you specify. EventBridge Scheduler ignoresStartDate
for one-time schedules.Required: No
Type: String
Update requires: No interruption
State
-
Specifies whether the schedule is enabled or disabled.
Required: No
Type: String
Update requires: No interruption
Target
-
The schedule's target details.
Required: Yes
Type: Target
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the Name
attribute of theschedule.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes that Fn::GetAtt
returns.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt.