ScheduleProps Struct
Construction properties for Schedule.
Example
ts
import * as firehose from 'aws-cdk-lib/aws-kinesisfirehose';
declare const deliveryStream: firehose.IDeliveryStream;
const payload = {
Data: "record",
};
new Schedule(this, 'Schedule', {
schedule: ScheduleExpression.rate(Duration.minutes(60)),
target: new targets.FirehosePutRecord(deliveryStream, {
input: ScheduleTargetInput.fromObject(payload),
}),
});
Properties
The description you specify for the schedule.
Indicates whether the schedule is enabled.
The date, in UTC, before which the schedule can invoke its target.
EventBridge Scheduler ignores end for one-time schedules.
The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
default
Default: All events in Scheduler are encrypted with a key that AWS owns and manages.
scheduleScheduleExpressionscheduleScheduleExpressionscheduleScheduleExpressionScheduleScheduleExpressionScheduleScheduleExpressionrequired#The expression that defines when the schedule runs.
Can be either a at, rate or cron expression.
scheduleGroupIScheduleGroupschedule_groupIScheduleGroupscheduleGroupIScheduleGroupScheduleGroupIScheduleGroupScheduleGroupIScheduleGroup= By default a schedule will be as…#The schedule's group.
default
Default: By default a schedule will be associated with the default group.
scheduleNamestringschedule_namestrscheduleNameStringScheduleNamestringScheduleName*string= A unique name will be generated#The name of the schedule.
Up to 64 letters (uppercase and lowercase), numbers, hyphens, underscores and dots are allowed.
The date, in UTC, after which the schedule can begin invoking its target.
EventBridge Scheduler ignores start for one-time schedules.
targetIScheduleTargettargetIScheduleTargettargetIScheduleTargetTargetIScheduleTargetTargetIScheduleTargetrequired#The schedule's target details.
timeWindowTimeWindowtime_windowTimeWindowtimeWindowTimeWindowTimeWindowTimeWindowTimeWindowTimeWindow= TimeWindow.off()#A time window during which EventBridge Scheduler invokes the schedule.