CronOptions

class aws_cdk.aws_events.CronOptions(*, day=None, hour=None, minute=None, month=None, week_day=None, year=None)

Bases: object

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

See

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

Example:

import aws_cdk.aws_events as events
import aws_cdk.aws_events_targets as targets

# fn is of type Function

rule = events.Rule(self, "Schedule Rule",
    schedule=events.Schedule.cron(minute="0", hour="4")
)
rule.add_target(targets.LambdaFunction(fn))

Attributes

day

The day of the month to run this rule at.

Default

  • Every day of the month

Return type

Optional[str]

hour

The hour to run this rule at.

Default

  • Every hour

Return type

Optional[str]

minute

The minute to run this rule at.

Default

  • Every minute

Return type

Optional[str]

month

The month to run this rule at.

Default

  • Every month

Return type

Optional[str]

week_day

The day of the week to run this rule at.

Default

  • Any day of the week

Return type

Optional[str]

year

The year to run this rule at.

Default

  • Every year

Return type

Optional[str]