CronOptionsWithTimezone

class aws_cdk.aws_scheduler_alpha.CronOptionsWithTimezone(*, day=None, hour=None, minute=None, month=None, week_day=None, year=None, time_zone=None)

Bases: CronOptions

(experimental) 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.

Parameters:

day (Optional[str]) – The day of the month to run this rule at. Default: - Every day of the month
hour (Optional[str]) – The hour to run this rule at. Default: - Every hour
minute (Optional[str]) – The minute to run this rule at. Default: - Every minute
month (Optional[str]) – The month to run this rule at. Default: - Every month
week_day (Optional[str]) – The day of the week to run this rule at. Default: - Any day of the week
year (Optional[str]) – The year to run this rule at. Default: - Every year
time_zone (Optional[TimeZone]) – (experimental) The timezone to run the schedule in. Default: - TimeZone.ETC_UTC

See:

https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html#cron-expressions

Stability:

experimental

ExampleMetadata:

infused

Example:

# target: targets.LambdaInvoke


rate_based_schedule = Schedule(self, "Schedule",
    schedule=ScheduleExpression.rate(Duration.minutes(10)),
    target=target,
    description="This is a test rate-based schedule"
)

cron_based_schedule = Schedule(self, "Schedule",
    schedule=ScheduleExpression.cron(
        minute="0",
        hour="23",
        day="20",
        month="11",
        time_zone=TimeZone.AMERICA_NEW_YORK
    ),
    target=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"
)

Attributes

day

The day of the month to run this rule at.

Default:

Every day of the month

hour

The hour to run this rule at.

Default:

Every hour

minute

The minute to run this rule at.

Default:

Every minute

month

The month to run this rule at.

Default:

Every month

time_zone

(experimental) The timezone to run the schedule in.

Default:

TimeZone.ETC_UTC

Stability:

experimental

week_day

The day of the week to run this rule at.

Default:

Any day of the week

year

The year to run this rule at.

Default:

Every year