Package software.amazon.awscdk.services.scheduler

Interface CfnScheduleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScheduleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-08-02T00:29:17.431Z")
@Stability(Stable)
public interface CfnScheduleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSchedule.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.scheduler.*;
 Object tags;
 CfnScheduleProps cfnScheduleProps = CfnScheduleProps.builder()
         .flexibleTimeWindow(FlexibleTimeWindowProperty.builder()
                 .mode("mode")
                 // the properties below are optional
                 .maximumWindowInMinutes(123)
                 .build())
         .scheduleExpression("scheduleExpression")
         .target(TargetProperty.builder()
                 .arn("arn")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .deadLetterConfig(DeadLetterConfigProperty.builder()
                         .arn("arn")
                         .build())
                 .ecsParameters(EcsParametersProperty.builder()
                         .taskDefinitionArn("taskDefinitionArn")
                         // the properties below are optional
                         .capacityProviderStrategy(List.of(CapacityProviderStrategyItemProperty.builder()
                                 .capacityProvider("capacityProvider")
                                 // the properties below are optional
                                 .base(123)
                                 .weight(123)
                                 .build()))
                         .enableEcsManagedTags(false)
                         .enableExecuteCommand(false)
                         .group("group")
                         .launchType("launchType")
                         .networkConfiguration(NetworkConfigurationProperty.builder()
                                 .awsvpcConfiguration(AwsVpcConfigurationProperty.builder()
                                         .subnets(List.of("subnets"))
                                         // the properties below are optional
                                         .assignPublicIp("assignPublicIp")
                                         .securityGroups(List.of("securityGroups"))
                                         .build())
                                 .build())
                         .placementConstraints(List.of(PlacementConstraintProperty.builder()
                                 .expression("expression")
                                 .type("type")
                                 .build()))
                         .placementStrategy(List.of(PlacementStrategyProperty.builder()
                                 .field("field")
                                 .type("type")
                                 .build()))
                         .platformVersion("platformVersion")
                         .propagateTags("propagateTags")
                         .referenceId("referenceId")
                         .tags(tags)
                         .taskCount(123)
                         .build())
                 .eventBridgeParameters(EventBridgeParametersProperty.builder()
                         .detailType("detailType")
                         .source("source")
                         .build())
                 .input("input")
                 .kinesisParameters(KinesisParametersProperty.builder()
                         .partitionKey("partitionKey")
                         .build())
                 .retryPolicy(RetryPolicyProperty.builder()
                         .maximumEventAgeInSeconds(123)
                         .maximumRetryAttempts(123)
                         .build())
                 .sageMakerPipelineParameters(SageMakerPipelineParametersProperty.builder()
                         .pipelineParameterList(List.of(SageMakerPipelineParameterProperty.builder()
                                 .name("name")
                                 .value("value")
                                 .build()))
                         .build())
                 .sqsParameters(SqsParametersProperty.builder()
                         .messageGroupId("messageGroupId")
                         .build())
                 .build())
         // the properties below are optional
         .description("description")
         .endDate("endDate")
         .groupName("groupName")
         .kmsKeyArn("kmsKeyArn")
         .name("name")
         .scheduleExpressionTimezone("scheduleExpressionTimezone")
         .startDate("startDate")
         .state("state")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnScheduleProps.Builder	A builder for CfnScheduleProps
static final class	CfnScheduleProps.Jsii$Proxy	An implementation for CfnScheduleProps

Method Summary

Modifier and Type	Method	Description
static CfnScheduleProps.Builder	builder()
default String	getDescription()	The description you specify for the schedule.
default String	getEndDate()	The date, in UTC, before which the schedule can invoke its target.
Object	getFlexibleTimeWindow()	Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
default String	getGroupName()	The name of the schedule group associated with this schedule.
default String	getKmsKeyArn()	The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
default String	getName()	The name of the schedule.
String	getScheduleExpression()	The expression that defines when the schedule runs.
default String	getScheduleExpressionTimezone()	The timezone in which the scheduling expression is evaluated.
default String	getStartDate()	The date, in UTC, after which the schedule can begin invoking its target.
default String	getState()	Specifies whether the schedule is enabled or disabled.
Object	getTarget()	The schedule's target details.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFlexibleTimeWindow

@Stability(Stable)
@NotNull
Object getFlexibleTimeWindow()

Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-flexibletimewindow

getScheduleExpression

@Stability(Stable)
@NotNull
String getScheduleExpression()

The expression that defines when the schedule runs. The following formats are supported.

• at expression - at(yyyy-mm-ddThh:mm:ss)
• rate expression - rate(value unit)
• cron expression - cron(fields)

You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.

A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year) .

A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days

For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpression

getTarget

@Stability(Stable)
@NotNull
Object getTarget()

The schedule's target details.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-target

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description you specify for the schedule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-description

getEndDate

@Stability(Stable)
@Nullable
default String getEndDate()

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

Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-enddate

getGroupName

@Stability(Stable)
@Nullable
default String getGroupName()

The name of the schedule group associated with this schedule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-groupname

getKmsKeyArn

@Stability(Stable)
@Nullable
default String getKmsKeyArn()

The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-kmskeyarn

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the schedule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-name

getScheduleExpressionTimezone

@Stability(Stable)
@Nullable
default String getScheduleExpressionTimezone()

The timezone in which the scheduling expression is evaluated.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpressiontimezone

getStartDate

@Stability(Stable)
@Nullable
default String getStartDate()

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

Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-startdate

getState

@Stability(Stable)
@Nullable
default String getState()

Specifies whether the schedule is enabled or disabled.

Allowed Values : ENABLED | DISABLED

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-state

builder

@Stability(Stable)
static CfnScheduleProps.Builder builder()

Returns:

a CfnScheduleProps.Builder of CfnScheduleProps