class Schedule
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.Tasks.Schedule |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#Schedule |
![]() | software.amazon.awscdk.services.stepfunctions.tasks.Schedule |
![]() | aws_cdk.aws_stepfunctions_tasks.Schedule |
![]() | aws-cdk-lib » aws_stepfunctions_tasks » Schedule |
Schedule for EventBridge Scheduler.
Example
import * as scheduler from 'aws-cdk-lib/aws-scheduler';
import * as kms from 'aws-cdk-lib/aws-kms';
declare const key: kms.Key;
declare const scheduleGroup: scheduler.CfnScheduleGroup;
declare const targetQueue: sqs.Queue;
declare const deadLetterQueue: sqs.Queue;
const schedulerRole = new iam.Role(this, 'SchedulerRole', {
assumedBy: new iam.ServicePrincipal('scheduler.amazonaws.com'),
});
// To send the message to the queue
// This policy changes depending on the type of target.
schedulerRole.addToPrincipalPolicy(new iam.PolicyStatement({
actions: ['sqs:SendMessage'],
resources: [targetQueue.queueArn],
}));
const createScheduleTask1 = new tasks.EventBridgeSchedulerCreateScheduleTask(this, 'createSchedule', {
scheduleName: 'TestSchedule',
actionAfterCompletion: tasks.ActionAfterCompletion.NONE,
clientToken: 'testToken',
description: 'TestDescription',
startDate: new Date(),
endDate: new Date(new Date().getTime() + 1000 * 60 * 60),
flexibleTimeWindow: Duration.minutes(5),
groupName: scheduleGroup.ref,
kmsKey: key,
schedule: tasks.Schedule.rate(Duration.minutes(5)),
timezone: 'UTC',
enabled: true,
target: new tasks.EventBridgeSchedulerTarget({
arn: targetQueue.queueArn,
role: schedulerRole,
retryPolicy: {
maximumRetryAttempts: 2,
maximumEventAge: Duration.minutes(5),
},
deadLetterQueue,
}),
});
Properties
Name | Type | Description |
---|---|---|
expression | string | The Schedule expression. |
expressionString
Type:
string
The Schedule expression.
Methods
Name | Description |
---|---|
static cron(options) | Create a cron-based schedule from a set of cron fields. |
static one | Construct a one-time schedule from a Date. |
static rate(duration) | Construct a rate-based schedule from an interval. |
static cron(options)
public static cron(options: CronOptions): Schedule
Parameters
- options
Cron
Options
Returns
Create a cron-based schedule from a set of cron fields.
static oneTime(time)
public static oneTime(time: date): Schedule
Parameters
- time
date
Returns
Construct a one-time schedule from a Date.
static rate(duration)
public static rate(duration: Duration): Schedule
Parameters
- duration
Duration
Returns
Construct a rate-based schedule from an interval.
The minimum interval is 1 minute.