ScheduleProps

class aws_cdk.aws_scheduler_alpha.ScheduleProps(*, schedule, target, description=None, enabled=None, end=None, group=None, key=None, schedule_name=None, start=None, target_overrides=None, time_window=None)

Bases: object

(experimental) Construction properties for Schedule.

Parameters:

  • schedule (ScheduleExpression) – (experimental) The expression that defines when the schedule runs. Can be either a at, rate or cron expression.

  • target (IScheduleTarget) – (experimental) The schedule’s target details.

  • description (Optional[str]) – (experimental) The description you specify for the schedule. Default: - no value

  • enabled (Optional[bool]) – (experimental) Indicates whether the schedule is enabled. Default: true

  • end (Optional[datetime]) – (experimental) The date, in UTC, before which the schedule can invoke its target. EventBridge Scheduler ignores end for one-time schedules. Default: - no value

  • group (Optional[IGroup]) – (experimental) The schedule’s group. Default: - By default a schedule will be associated with the default group.

  • key (Optional[IKey]) – (experimental) 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.

  • schedule_name (Optional[str]) – (experimental) The name of the schedule. Up to 64 letters (uppercase and lowercase), numbers, hyphens, underscores and dots are allowed. Default: - A unique name will be generated

  • start (Optional[datetime]) – (experimental) The date, in UTC, after which the schedule can begin invoking its target. EventBridge Scheduler ignores start for one-time schedules. Default: - no value

  • target_overrides (Union[ScheduleTargetProps, Dict[str, Any], None]) – (experimental) Allows to override target properties when creating a new schedule.

  • time_window (Optional[TimeWindow]) – (experimental) A time window during which EventBridge Scheduler invokes the schedule. Default: TimeWindow.off()

Stability:

experimental

ExampleMetadata:

infused

Example:

import aws_cdk.aws_kinesisfirehose as firehose
# delivery_stream: firehose.CfnDeliveryStream


payload = {
    "Data": "record"
}

Schedule(self, "Schedule",
    schedule=ScheduleExpression.rate(Duration.minutes(60)),
    target=targets.KinesisDataFirehosePutRecord(delivery_stream,
        input=ScheduleTargetInput.from_object(payload)
    )
)

Attributes

description

(experimental) The description you specify for the schedule.

Default:

  • no value

Stability:

experimental

enabled

(experimental) Indicates whether the schedule is enabled.

Default:

true

Stability:

experimental

end

(experimental) The date, in UTC, before which the schedule can invoke its target.

EventBridge Scheduler ignores end for one-time schedules.

Default:

  • no value

Stability:

experimental

group

(experimental) The schedule’s group.

Default:

  • By default a schedule will be associated with the default group.

Stability:

experimental

key

(experimental) 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.

Stability:

experimental

schedule

(experimental) The expression that defines when the schedule runs.

Can be either a at, rate or cron expression.

Stability:

experimental

schedule_name

(experimental) The name of the schedule.

Up to 64 letters (uppercase and lowercase), numbers, hyphens, underscores and dots are allowed.

Default:

  • A unique name will be generated

Stability:

experimental

start

(experimental) The date, in UTC, after which the schedule can begin invoking its target.

EventBridge Scheduler ignores start for one-time schedules.

Default:

  • no value

Stability:

experimental

target

(experimental) The schedule’s target details.

Stability:

experimental

target_overrides

(experimental) Allows to override target properties when creating a new schedule.

Stability:

experimental

time_window

(experimental) A time window during which EventBridge Scheduler invokes the schedule.

Default:

TimeWindow.off()

See:

https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-flexible-time-windows.html

Stability:

experimental