Package software.amazon.awscdk.services.scheduler

Class CfnSchedule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.scheduler.CfnSchedule

All Implemented Interfaces:

IInspectable, IScheduleRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:20.303Z")
@Stability(Stable)
public class CfnSchedule
extends CfnResource
implements IInspectable, IScheduleRef

A schedule is the main resource you create, configure, and manage using Amazon EventBridge Scheduler.

Every schedule has a schedule expression that determines when, and with what frequency, the schedule runs. EventBridge Scheduler supports three types of schedules: rate, cron, and one-time schedules. For more information about different schedule types, see Schedule types in the EventBridge Scheduler User Guide .

When you create a schedule, you configure a target for the schedule to invoke. A target is an API operation that EventBridge Scheduler calls on your behalf every time your schedule runs. EventBridge Scheduler supports two types of targets: templated targets invoke common API operations across a core groups of services, and customizeable universal targets that you can use to call more than 6,000 operations across over 270 services. For more information about configuring targets, see Managing targets in the EventBridge Scheduler User Guide .

For more information about managing schedules, changing the schedule state, setting up flexible time windows, and configuring a dead-letter queue for a schedule, see Managing a schedule in the EventBridge Scheduler User Guide .

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;
 CfnSchedule cfnSchedule = CfnSchedule.Builder.create(this, "MyCfnSchedule")
         .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	Class	Description
static interface	CfnSchedule.AwsVpcConfigurationProperty	This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used.
static final class	CfnSchedule.Builder	A fluent builder for CfnSchedule.
static interface	CfnSchedule.CapacityProviderStrategyItemProperty	The details of a capacity provider strategy.
static interface	CfnSchedule.DeadLetterConfigProperty	An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.
static interface	CfnSchedule.EcsParametersProperty	The templated target type for the Amazon ECS RunTask API operation.
static interface	CfnSchedule.EventBridgeParametersProperty	The templated target type for the EventBridge PutEvents API operation.
static interface	CfnSchedule.FlexibleTimeWindowProperty	Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
static interface	CfnSchedule.KinesisParametersProperty	The templated target type for the Amazon Kinesis PutRecord API operation.
static interface	CfnSchedule.NetworkConfigurationProperty	Specifies the network configuration for an ECS task.
static interface	CfnSchedule.PlacementConstraintProperty	An object representing a constraint on task placement.
static interface	CfnSchedule.PlacementStrategyProperty	The task placement strategy for a task or service.
static interface	CfnSchedule.RetryPolicyProperty	A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
static interface	CfnSchedule.SageMakerPipelineParameterProperty	The name and value pair of a parameter to use to start execution of a SageMaker Model Building Pipeline.
static interface	CfnSchedule.SageMakerPipelineParametersProperty	The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
static interface	CfnSchedule.SqsParametersProperty	The templated target type for the Amazon SQS SendMessage API operation.
static interface	CfnSchedule.TargetProperty	The schedule's target.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.scheduler.IScheduleRef

IScheduleRef.Jsii$Default, IScheduleRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnSchedule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSchedule(software.amazon.jsii.JsiiObjectRef objRef)
	CfnSchedule(software.constructs.Construct scope, String id, CfnScheduleProps props)

Method Summary

Modifier and Type	Method	Description
static IScheduleRef	fromScheduleArn(software.constructs.Construct scope, String id, String arn)	Creates a new IScheduleRef from an ARN.
String	getAttrArn()	The Amazon Resource Name (ARN) for the Amazon EventBridge Scheduler schedule.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	The description you specify for the schedule.
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.
String	getGroupName()	The name of the schedule group associated with this schedule.
String	getKmsKeyArn()	The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
String	getName()	The name of the schedule.
String	getScheduleExpression()	The expression that defines when the schedule runs.
String	getScheduleExpressionTimezone()	The timezone in which the scheduling expression is evaluated.
ScheduleReference	getScheduleRef()	A reference to a Schedule resource.
String	getStartDate()	The date, in UTC, after which the schedule can begin invoking its target.
String	getState()	Specifies whether the schedule is enabled or disabled.
Object	getTarget()	The schedule's target details.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	The description you specify for the schedule.
void	setEndDate(String value)	The date, in UTC, before which the schedule can invoke its target.
void	setFlexibleTimeWindow(IResolvable value)	Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
void	setFlexibleTimeWindow(CfnSchedule.FlexibleTimeWindowProperty value)	Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
void	setGroupName(String value)	The name of the schedule group associated with this schedule.
void	setKmsKeyArn(String value)	The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
void	setName(String value)	The name of the schedule.
void	setScheduleExpression(String value)	The expression that defines when the schedule runs.
void	setScheduleExpressionTimezone(String value)	The timezone in which the scheduling expression is evaluated.
void	setStartDate(String value)	The date, in UTC, after which the schedule can begin invoking its target.
void	setState(String value)	Specifies whether the schedule is enabled or disabled.
void	setTarget(IResolvable value)	The schedule's target details.
void	setTarget(CfnSchedule.TargetProperty value)	The schedule's target details.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnSchedule

protected CfnSchedule(software.amazon.jsii.JsiiObjectRef objRef)

CfnSchedule

protected CfnSchedule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSchedule

@Stability(Stable)
public CfnSchedule(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnScheduleProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

fromScheduleArn

@Stability(Stable)
@NotNull
public static IScheduleRef fromScheduleArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String arn)

Creates a new IScheduleRef from an ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

arn - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) for the Amazon EventBridge Scheduler schedule.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getScheduleRef

@Stability(Stable)
@NotNull
public ScheduleReference getScheduleRef()

A reference to a Schedule resource.

Specified by:

getScheduleRef in interface IScheduleRef

getFlexibleTimeWindow

@Stability(Stable)
@NotNull
public Object getFlexibleTimeWindow()

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

setFlexibleTimeWindow

@Stability(Stable)
public void setFlexibleTimeWindow(@NotNull
 IResolvable value)

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

setFlexibleTimeWindow

@Stability(Stable)
public void setFlexibleTimeWindow(@NotNull
 CfnSchedule.FlexibleTimeWindowProperty value)

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

getScheduleExpression

@Stability(Stable)
@NotNull
public String getScheduleExpression()

The expression that defines when the schedule runs.

The following formats are supported.

setScheduleExpression

@Stability(Stable)
public void setScheduleExpression(@NotNull
 String value)

The expression that defines when the schedule runs.

The following formats are supported.

getTarget

@Stability(Stable)
@NotNull
public Object getTarget()

The schedule's target details.

setTarget

@Stability(Stable)
public void setTarget(@NotNull
 IResolvable value)

The schedule's target details.

setTarget

@Stability(Stable)
public void setTarget(@NotNull
 CfnSchedule.TargetProperty value)

The schedule's target details.

getDescription

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

The description you specify for the schedule.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description you specify for the schedule.

getEndDate

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

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

setEndDate

@Stability(Stable)
public void setEndDate(@Nullable
 String value)

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

getGroupName

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

The name of the schedule group associated with this schedule.

setGroupName

@Stability(Stable)
public void setGroupName(@Nullable
 String value)

The name of the schedule group associated with this schedule.

getKmsKeyArn

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

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

setKmsKeyArn

@Stability(Stable)
public void setKmsKeyArn(@Nullable
 String value)

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

getName

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

The name of the schedule.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

The name of the schedule.

getScheduleExpressionTimezone

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

The timezone in which the scheduling expression is evaluated.

setScheduleExpressionTimezone

@Stability(Stable)
public void setScheduleExpressionTimezone(@Nullable
 String value)

The timezone in which the scheduling expression is evaluated.

getStartDate

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

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

setStartDate

@Stability(Stable)
public void setStartDate(@Nullable
 String value)

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

getState

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

Specifies whether the schedule is enabled or disabled.

setState

@Stability(Stable)
public void setState(@Nullable
 String value)

Specifies whether the schedule is enabled or disabled.