interface ScheduleProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Scheduler.Alpha.ScheduleProps |
![]() | github.com/aws/aws-cdk-go/awscdkscheduleralpha/v2#ScheduleProps |
![]() | software.amazon.awscdk.services.scheduler.alpha.ScheduleProps |
![]() | aws_cdk.aws_scheduler_alpha.ScheduleProps |
![]() | @aws-cdk/aws-scheduler-alpha ยป ScheduleProps |
Construction properties for Schedule
.
Example
import * as firehose from '@aws-cdk/aws-kinesisfirehose-alpha';
declare const deliveryStream: firehose.IDeliveryStream;
const payload = {
Data: "record",
};
new Schedule(this, 'Schedule', {
schedule: ScheduleExpression.rate(Duration.minutes(60)),
target: new targets.KinesisDataFirehosePutRecord(deliveryStream, {
input: ScheduleTargetInput.fromObject(payload),
}),
});
Properties
Name | Type | Description |
---|---|---|
schedule | Schedule | The expression that defines when the schedule runs. |
target | ISchedule | The schedule's target details. |
description? | string | The description you specify for the schedule. |
enabled? | boolean | Indicates whether the schedule is enabled. |
end? | date | The date, in UTC, before which the schedule can invoke its target. |
group? | IGroup | The schedule's group. |
key? | IKey | The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data. |
schedule | string | The name of the schedule. |
start? | date | The date, in UTC, after which the schedule can begin invoking its target. |
time | Time | A time window during which EventBridge Scheduler invokes the schedule. |
schedule
Type:
Schedule
The expression that defines when the schedule runs.
Can be either a at
, rate
or cron
expression.
target
Type:
ISchedule
The schedule's target details.
description?
Type:
string
(optional, default: no value)
The description you specify for the schedule.
enabled?
Type:
boolean
(optional, default: true)
Indicates whether the schedule is enabled.
end?
Type:
date
(optional, default: no value)
The date, in UTC, before which the schedule can invoke its target.
EventBridge Scheduler ignores end for one-time schedules.
group?
Type:
IGroup
(optional, default: By default a schedule will be associated with the default
group.)
The schedule's group.
key?
Type:
IKey
(optional, default: All events in Scheduler are encrypted with a key that AWS owns and manages.)
The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
scheduleName?
Type:
string
(optional, default: 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.
start?
Type:
date
(optional, default: no value)
The date, in UTC, after which the schedule can begin invoking its target.
EventBridge Scheduler ignores start for one-time schedules.
timeWindow?
Type:
Time
(optional, default: TimeWindow.off())
A time window during which EventBridge Scheduler invokes the schedule.