CfnSchedule (software.amazon.awscdk:scheduler 1.182.0 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.core.Construct
    - - software.amazon.awscdk.core.CfnElement
      - software.amazon.awscdk.core.CfnRefElement
        
        software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.scheduler.CfnSchedule

All Implemented Interfaces:: IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:38.344Z")
 @Stability(value=Stable)
public class CfnSchedule
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Scheduler::Schedule`.

Creates the specified schedule.

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(List.of(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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and 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 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`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API operation.
`static interface`	`CfnSchedule.EventBridgeParametersProperty` The templated target type for the EventBridge [`PutEvents`](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) 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`](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html) 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`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) API operation.
`static interface`	`CfnSchedule.SqsParametersProperty` The templated target type for the Amazon SQS [`SendMessage`](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) 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.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnSchedule(Construct scope, String id, CfnScheduleProps props)` Create a new `AWS::Scheduler::Schedule`.
`protected`	`CfnSchedule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnSchedule(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`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(CfnSchedule.FlexibleTimeWindowProperty value)` Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
`void`	`setFlexibleTimeWindow(IResolvable 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(CfnSchedule.TargetProperty value)` The schedule's target details.
`void`	`setTarget(IResolvable value)` The schedule's target details.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnSchedule
```
protected CfnSchedule(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnSchedule
```
protected CfnSchedule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnSchedule
```
@Stability(value=Stable)
public CfnSchedule(@NotNull
                                            Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnScheduleProps props)
```
    Create a new `AWS::Scheduler::Schedule`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()
```
    The Amazon Resource Name (ARN) for the Amazon EventBridge Scheduler schedule.
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getFlexibleTimeWindow
```
@Stability(value=Stable)
 @NotNull
public Object getFlexibleTimeWindow()
```
    Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
  - setFlexibleTimeWindow
```
@Stability(value=Stable)
public void setFlexibleTimeWindow(@NotNull
                                                           CfnSchedule.FlexibleTimeWindowProperty value)
```
    Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
  - setFlexibleTimeWindow
```
@Stability(value=Stable)
public void setFlexibleTimeWindow(@NotNull
                                                           IResolvable value)
```
    Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
  - getScheduleExpression
```
@Stability(value=Stable)
 @NotNull
public 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(unit value)
    - 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 .
  - setScheduleExpression
```
@Stability(value=Stable)
public void setScheduleExpression(@NotNull
                                                           String value)
```
    The expression that defines when the schedule runs. The following formats are supported.
    - at expression - at(yyyy-mm-ddThh:mm:ss)
    - rate expression - rate(unit value)
    - 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 .
  - getTarget
```
@Stability(value=Stable)
 @NotNull
public Object getTarget()
```
    The schedule's target details.
  - setTarget
```
@Stability(value=Stable)
public void setTarget(@NotNull
                                               IResolvable value)
```
    The schedule's target details.
  - setTarget
```
@Stability(value=Stable)
public void setTarget(@NotNull
                                               CfnSchedule.TargetProperty value)
```
    The schedule's target details.
  - getDescription
```
@Stability(value=Stable)
 @Nullable
public String getDescription()
```
    The description you specify for the schedule.
  - setDescription
```
@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)
```
    The description you specify for the schedule.
  - getEndDate
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setEndDate
```
@Stability(value=Stable)
public void setEndDate(@Nullable
                                                String value)
```
    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.
  - getGroupName
```
@Stability(value=Stable)
 @Nullable
public String getGroupName()
```
    The name of the schedule group associated with this schedule.
  - setGroupName
```
@Stability(value=Stable)
public void setGroupName(@Nullable
                                                  String value)
```
    The name of the schedule group associated with this schedule.
  - getKmsKeyArn
```
@Stability(value=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(value=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(value=Stable)
 @Nullable
public String getName()
```
    The name of the schedule.
  - setName
```
@Stability(value=Stable)
public void setName(@Nullable
                                             String value)
```
    The name of the schedule.
  - getScheduleExpressionTimezone
```
@Stability(value=Stable)
 @Nullable
public String getScheduleExpressionTimezone()
```
    The timezone in which the scheduling expression is evaluated.
  - setScheduleExpressionTimezone
```
@Stability(value=Stable)
public void setScheduleExpressionTimezone(@Nullable
                                                                   String value)
```
    The timezone in which the scheduling expression is evaluated.
  - getStartDate
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setStartDate
```
@Stability(value=Stable)
public void setStartDate(@Nullable
                                                  String value)
```
    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.
  - getState
```
@Stability(value=Stable)
 @Nullable
public String getState()
```
    Specifies whether the schedule is enabled or disabled.
  - setState
```
@Stability(value=Stable)
public void setState(@Nullable
                                              String value)
```
    Specifies whether the schedule is enabled or disabled.

Class CfnSchedule

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnSchedule

CfnSchedule

CfnSchedule

Method Detail

inspect

renderProperties

getAttrArn

getCfnProperties

getFlexibleTimeWindow

setFlexibleTimeWindow

setFlexibleTimeWindow

getScheduleExpression

setScheduleExpression

getTarget

setTarget

setTarget

getDescription

setDescription

getEndDate

setEndDate

getGroupName

setGroupName

getKmsKeyArn

setKmsKeyArn

getName

setName

getScheduleExpressionTimezone

setScheduleExpressionTimezone

getStartDate

setStartDate

getState

setState