Schedule
An EventBridge Schedule.
Import
import { Schedule } from 'aws-cdk-lib/aws-scheduler';Or use the module namespace:
import * as scheduler from 'aws-cdk-lib/aws-scheduler';
// scheduler.ScheduleProperties
Configuration passed to the constructor as ScheduleProps.
scheduleRequiredScheduleExpressionThe expression that defines when the schedule runs. Can be either a `at`, `rate` or `cron` expression.
targetRequiredIScheduleTargetThe schedule's target details.
descriptionOptionalstringThe description you specify for the schedule.
Default: - no value
enabledOptionalbooleanIndicates whether the schedule is enabled.
Default: true
endOptionaldateThe date, in UTC, before which the schedule can invoke its target. EventBridge Scheduler ignores end for one-time schedules.
Default: - no value
keyOptionalIKeyThe customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
Default: - All events in Scheduler are encrypted with a key that AWS owns and manages.
scheduleGroupOptionalIScheduleGroupThe schedule's group.
Default: - By default a schedule will be associated with the `default` group.
scheduleNameOptionalstringThe name of the schedule. Up to 64 letters (uppercase and lowercase), numbers, hyphens, underscores and dots are allowed.
Default: - A unique name will be generated
startOptionaldateThe date, in UTC, after which the schedule can begin invoking its target. EventBridge Scheduler ignores start for one-time schedules.
Default: - no value
timeWindowOptionalTimeWindowA time window during which EventBridge Scheduler invokes the schedule.
Default: TimeWindow.off()
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-scheduler