AWS CDK Reference

Appearance

v2.274.0

CronOptionsWithTimezone Struct ​

Options to configure a cron expression.

All fields are strings so you can use complex expressions. Absence of a field implies '*' or '?', whichever one is appropriate.

Source
aws-scheduler/lib/schedule-expression.ts
Type last changed
v2.186.0 · 27 Mar 2025

Example ​

ts
declare const target: targets.LambdaInvoke;

const rateBasedSchedule = new Schedule(this, 'Schedule', {
    schedule: ScheduleExpression.rate(Duration.minutes(10)),
    target,
    description: 'This is a test rate-based schedule',
});

const cronBasedSchedule = new Schedule(this, 'Schedule', {
    schedule: ScheduleExpression.cron({
        minute: '0',
        hour: '23',
        day: '20',
        month: '11',
        timeZone: TimeZone.AMERICA_NEW_YORK,
    }),
    target,
    description: 'This is a test cron-based schedule that will run at 11:00 PM, on day 20 of the month, only in November in New York timezone',
});

Properties ​

daystringdaystrdayStringDaystringDay*string= Every day of the month#
The day of the month to run this rule at.
hourstringhourstrhourStringHourstringHour*string= Every hour#
The hour to run this rule at.
minutestringminutestrminuteStringMinutestringMinute*string= Every minute#
The minute to run this rule at.
monthstringmonthstrmonthStringMonthstringMonth*string= Every month#
The month to run this rule at.
timeZoneTimeZonetime_zoneTimeZonetimeZoneTimeZoneTimeZoneTimeZoneTimeZoneTimeZone= TimeZone.ETC_UTC#
The timezone to run the schedule in.
weekDaystringweek_daystrweekDayStringWeekDaystringWeekDay*string= Any day of the week#
The day of the week to run this rule at.
yearstringyearstryearStringYearstringYear*string= Every year#
The year to run this rule at.