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
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#The description you specify for the schedule.
Default: no value
enabledoptionalbooleanenabledoptionalboolenabledoptionalBooleanEnabledoptionalboolEnabledoptional*bool= true#Indicates whether the schedule is enabled.
The date, in UTC, before which the schedule can invoke its target.
Default: no value
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: 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.
scheduleGroupoptionalIScheduleGroupschedule_groupoptionalIScheduleGroupscheduleGroupoptionalIScheduleGroupScheduleGroupoptionalIScheduleGroupScheduleGroupoptionalIScheduleGroup#The schedule's group.
Default: By default a schedule will be associated with the default group.
scheduleNameoptionalstringschedule_nameoptionalstrscheduleNameoptionalStringScheduleNameoptionalstringScheduleNameoptional*string#The name of the schedule.
Default: A unique name will be generated
Up to 64 letters (uppercase and lowercase), numbers, hyphens, underscores and dots are allowed.
startoptionaldatestartoptionaldatetimestartoptionalInstantStartoptionalDateTimeStartoptional*time.Time#The date, in UTC, after which the schedule can begin invoking its target.
Default: no value
EventBridge Scheduler ignores start for one-time schedules.
targetIScheduleTargettargetIScheduleTargettargetIScheduleTargetTargetIScheduleTargetTargetIScheduleTargetrequired#The schedule's target details.
timeWindowoptionalTimeWindowtime_windowoptionalTimeWindowtimeWindowoptionalTimeWindowTimeWindowoptionalTimeWindowTimeWindowoptionalTimeWindow= TimeWindow.off()#A time window during which EventBridge Scheduler invokes the schedule.