Package software.amazon.awscdk.cfnpropertymixins.services.scheduler

Class CfnSchedulePropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.scheduler.CfnSchedulePropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:05.279Z") @Stability(Stable) public class CfnSchedulePropsMixin extends Mixin implements software.constructs.IMixin
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.cfnpropertymixins.services.scheduler.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 Object tags;
 CfnSchedulePropsMixin cfnSchedulePropsMixin = CfnSchedulePropsMixin.Builder.create(CfnScheduleMixinProps.builder()
         .description("description")
         .endDate("endDate")
         .flexibleTimeWindow(FlexibleTimeWindowProperty.builder()
                 .maximumWindowInMinutes(123)
                 .mode("mode")
                 .build())
         .groupName("groupName")
         .kmsKeyArn("kmsKeyArn")
         .name("name")
         .scheduleExpression("scheduleExpression")
         .scheduleExpressionTimezone("scheduleExpressionTimezone")
         .startDate("startDate")
         .state("state")
         .target(TargetProperty.builder()
                 .arn("arn")
                 .deadLetterConfig(DeadLetterConfigProperty.builder()
                         .arn("arn")
                         .build())
                 .ecsParameters(EcsParametersProperty.builder()
                         .capacityProviderStrategy(List.of(CapacityProviderStrategyItemProperty.builder()
                                 .base(123)
                                 .capacityProvider("capacityProvider")
                                 .weight(123)
                                 .build()))
                         .enableEcsManagedTags(false)
                         .enableExecuteCommand(false)
                         .group("group")
                         .launchType("launchType")
                         .networkConfiguration(NetworkConfigurationProperty.builder()
                                 .awsvpcConfiguration(AwsVpcConfigurationProperty.builder()
                                         .assignPublicIp("assignPublicIp")
                                         .securityGroups(List.of("securityGroups"))
                                         .subnets(List.of("subnets"))
                                         .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)
                         .taskDefinitionArn("taskDefinitionArn")
                         .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())
                 .roleArn("roleArn")
                 .sageMakerPipelineParameters(SageMakerPipelineParametersProperty.builder()
                         .pipelineParameterList(List.of(SageMakerPipelineParameterProperty.builder()
                                 .name("name")
                                 .value("value")
                                 .build()))
                         .build())
                 .sqsParameters(SqsParametersProperty.builder()
                         .messageGroupId("messageGroupId")
                         .build())
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnSchedulePropsMixin

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

    • CfnSchedulePropsMixin

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

    • CfnSchedulePropsMixin

      @Stability(Stable) public CfnSchedulePropsMixin(@NotNull CfnScheduleMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::Scheduler::Schedule.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnSchedulePropsMixin

      @Stability(Stable) public CfnSchedulePropsMixin(@NotNull CfnScheduleMixinProps props)
      Create a mixin to apply properties to AWS::Scheduler::Schedule.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnScheduleMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()