Schedule

The expression that defines when the schedule runs.

Can be either a `at`, `rate`
or `cron` expression.

schedule

target

The description you specify for the schedule.

description

Indicates whether the schedule is enabled.

enabled

The date, in UTC, before which the schedule can invoke its target.

EventBridge Scheduler ignores end for one-time schedules.

The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

scheduleGroup

The name of the schedule.

Up to 64 letters (uppercase and lowercase), numbers, hyphens, underscores and dots are allowed.

scheduleName

The date, in UTC, after which the schedule can begin invoking its target.

EventBridge Scheduler ignores start for one-time schedules.

start

A time window during which EventBridge Scheduler invokes the schedule.

timeWindow

Grant the indicated permissions on this schedule group to the given principal [disable-awslint:no-grants].

grant

Grant delete schedule permission for schedules in this group to the given principal.

The use of this method is discouraged. Please use `grants.deleteSchedules()` instead.

[disable-awslint:no-grants]

grantDeleteSchedules

Grant list and get schedule permissions for schedules in this group to the given principal.

The use of this method is discouraged. Please use `grants.readSchedules()` instead.

[disable-awslint:no-grants]

grantReadSchedules

Grant create and update schedule permissions for schedules in this group to the given principal.

The use of this method is discouraged. Please use `grants.writeSchedules()` instead.

[disable-awslint:no-grants]

grantWriteSchedules

Return the given named metric for this schedule group.

metric

metricAttempts

Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.

metricDropped

Metric for failed invocations that also failed to deliver to DLQ.

metricFailedToBeSentToDLQ

Metric for invocations delivered to the DLQ.

metricSentToDLQ

Metric for delivery of failed invocations to DLQ when the payload of the event sent to the DLQ exceeds the maximum size allowed by Amazon SQS.

metricSentToDLQTruncated

Emitted when the target returns an exception after EventBridge Scheduler calls the target API.

metricTargetErrors

Metric for invocation failures due to API throttling by the target.

metricTargetThrottled

Metric for the number of invocations that were throttled because it exceeds your service quotas.

metricThrottled

ScheduleGroup

The removal policy for the group.

If the group is removed also all schedules are removed.

removalPolicy

The name of the schedule group.

Up to 64 letters (uppercase and lowercase), numbers, hyphens, underscores and dots are allowed.

scheduleGroupName

A *schedule* is the main resource you create, configure, and manage using Amazon EventBridge Scheduler.

Every schedule has a *schedule expression* that determines when, and with what frequency, the schedule runs. EventBridge Scheduler supports three types of schedules: rate, cron, and one-time schedules. For more information about different schedule types, see [Schedule types](https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html) in the *EventBridge Scheduler User Guide* .

When you create a schedule, you configure a target for the schedule to invoke. A target is an API operation that EventBridge Scheduler calls on your behalf every time your schedule runs. EventBridge Scheduler supports two types of targets: *templated* targets invoke common API operations across a core groups of services, and customizeable *universal* targets that you can use to call more than 6,000 operations across over 270 services. For more information about configuring targets, see [Managing targets](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-targets.html) in the *EventBridge Scheduler User Guide* .

For more information about managing schedules, changing the schedule state, setting up flexible time windows, and configuring a dead-letter queue for a schedule, see [Managing a schedule](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule.html) in the *EventBridge Scheduler User Guide* .

CfnSchedule

Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

flexibleTimeWindow

The expression that defines when the schedule runs. The following formats are supported.

- `at` expression - `at(yyyy-mm-ddThh:mm:ss)`
- `rate` expression - `rate(value unit)`
- `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 use `rate` and `cron` 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](https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html) in the *EventBridge Scheduler User Guide* .

scheduleExpression

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 ignores `EndDate` for one-time schedules.

endDate

The name of the schedule group associated with this schedule.

groupName

The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

kmsKeyArn

name

The timezone in which the scheduling expression is evaluated.

scheduleExpressionTimezone

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 ignores `StartDate` for one-time schedules.

startDate

Specifies whether the schedule is enabled or disabled.

*Allowed Values* : `ENABLED` | `DISABLED`

state

A *schedule group* is an Amazon EventBridge Scheduler resource you use to organize your schedules.

Your AWS account comes with a `default` scheduler group. You associate a new schedule with the `default` group or with schedule groups that you create and manage. You can create up to [500 schedule groups](https://docs.aws.amazon.com/scheduler/latest/UserGuide/scheduler-quotas.html) in your AWS account. With EventBridge Scheduler, you apply [tags](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) to schedule groups, not to individual schedules to organize your resources.

For more information about managing schedule groups, see [Managing a schedule group](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-group.html) in the *EventBridge Scheduler User Guide* .

CfnScheduleGroup

An array of key-value pairs to apply to this resource.

For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

AWS scheduler

L2 Constructs2

Schedule

ScheduleGroup

L1 Constructs2

CfnSchedule

CfnScheduleGroup

Learn AWS the Practical Way

Quick Facts

Related Links