Package software.amazon.awscdk.services.redshift

Class CfnSnapshotSchedule

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.redshift.CfnSnapshotSchedule
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ISnapshotScheduleRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:17.555Z") @Stability(Stable) public class CfnSnapshotSchedule extends CfnResource implements IInspectable, ISnapshotScheduleRef, ITaggableV2
Creates a snapshot schedule that lets you set up automatic snapshots of your Amazon Redshift cluster at regular intervals.

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.redshift.*;
 CfnSnapshotSchedule cfnSnapshotSchedule = CfnSnapshotSchedule.Builder.create(this, "MyCfnSnapshotSchedule")
         .scheduleDefinitions(List.of("scheduleDefinitions"))
         .scheduleIdentifier("scheduleIdentifier")
         // the properties below are optional
         .scheduleDescription("scheduleDescription")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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

    • CfnSnapshotSchedule

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

    • CfnSnapshotSchedule

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

    • CfnSnapshotSchedule

      @Stability(Stable) public CfnSnapshotSchedule(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSnapshotScheduleProps props)
      Create a new AWS::Redshift::SnapshotSchedule.

      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

    • arnForSnapshotSchedule

      @Stability(Stable) @NotNull public static String arnForSnapshotSchedule(@NotNull ISnapshotScheduleRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnSnapshotSchedule

      @Stability(Stable) @NotNull public static Boolean isCfnSnapshotSchedule(@NotNull Object x)
      Checks whether the given object is a CfnSnapshotSchedule.

      Parameters:
      x - 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) of the snapshot schedule.

    • getAttrAssociatedClusterCount

      @Stability(Stable) @NotNull public Number getAttrAssociatedClusterCount()
      The number of clusters associated with the schedule.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getSnapshotScheduleRef

      @Stability(Stable) @NotNull public SnapshotScheduleReference getSnapshotScheduleRef()
      A reference to a SnapshotSchedule resource.
      Specified by:
      getSnapshotScheduleRef in interface ISnapshotScheduleRef

    • getScheduleDefinitions

      @Stability(Stable) @NotNull public List<String> getScheduleDefinitions()
      The definition of the snapshot schedule.

    • setScheduleDefinitions

      @Stability(Stable) public void setScheduleDefinitions(@NotNull List<String> value)
      The definition of the snapshot schedule.

    • getScheduleIdentifier

      @Stability(Stable) @NotNull public String getScheduleIdentifier()
      A unique identifier for the snapshot schedule.

    • setScheduleIdentifier

      @Stability(Stable) public void setScheduleIdentifier(@NotNull String value)
      A unique identifier for the snapshot schedule.

    • getScheduleDescription

      @Stability(Stable) @Nullable public String getScheduleDescription()
      The description of the snapshot schedule.

    • setScheduleDescription

      @Stability(Stable) public void setScheduleDescription(@Nullable String value)
      The description of the snapshot schedule.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An optional set of tags for the snapshot schedule.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An optional set of tags for the snapshot schedule.