interface CronOptions
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Events.CronOptions |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsevents#CronOptions |
![]() | software.amazon.awscdk.services.events.CronOptions |
![]() | aws_cdk.aws_events.CronOptions |
![]() | aws-cdk-lib » aws_events » CronOptions |
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.
Example
import * as events from 'aws-cdk-lib/aws-events';
import * as targets from 'aws-cdk-lib/aws-events-targets';
declare const fn: lambda.Function;
const rule = new events.Rule(this, 'Schedule Rule', {
schedule: events.Schedule.cron({ minute: '0', hour: '4' }),
});
rule.addTarget(new targets.LambdaFunction(fn));
Properties
Name | Type | Description |
---|---|---|
day? | string | The day of the month to run this rule at. |
hour? | string | The hour to run this rule at. |
minute? | string | The minute to run this rule at. |
month? | string | The month to run this rule at. |
week | string | The day of the week to run this rule at. |
year? | string | The year to run this rule at. |
day?
Type:
string
(optional, default: Every day of the month)
The day of the month to run this rule at.
hour?
Type:
string
(optional, default: Every hour)
The hour to run this rule at.
minute?
Type:
string
(optional, default: Every minute)
The minute to run this rule at.
month?
Type:
string
(optional, default: Every month)
The month to run this rule at.
weekDay?
Type:
string
(optional, default: Any day of the week)
The day of the week to run this rule at.
year?
Type:
string
(optional, default: Every year)
The year to run this rule at.