aws-cdk-lib.aws_scheduler.ScheduleGroupProps

ScheduleGroupProps Struct

Properties for a Schedule Group.

ScheduleGroupProps

used as props by

• ScheduleGroup

Source

aws-scheduler/lib/schedule-group.ts

Type last changed

v2.186.0 · 27 Mar 2025

Example

declare const target: targets.LambdaInvoke;

const scheduleGroup = new ScheduleGroup(this, "ScheduleGroup", {
    scheduleGroupName: "MyScheduleGroup",
});

new Schedule(this, 'Schedule', {
    schedule: ScheduleExpression.rate(Duration.minutes(10)),
    target,
    scheduleGroup,
});

Properties

removalPolicy?optionalRemovalPolicyremoval_policy?optionalRemovalPolicyremovalPolicy?optionalRemovalPolicyRemovalPolicy?optionalRemovalPolicyRemovalPolicy?optionalRemovalPolicy= RemovalPolicy.RETAIN#

The removal policy for the group.

If the group is removed also all schedules are removed.

scheduleGroupName?optionalstringschedule_group_name?optionalstrscheduleGroupName?optionalStringScheduleGroupName?optionalstringScheduleGroupName?optional*string#

The name of the schedule group.

Default: A unique name will be generated

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