Package software.amazon.awscdk.services.docdbelastic

Class CfnClusterSnapshot

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.docdbelastic.CfnClusterSnapshot
All Implemented Interfaces:
IInspectable, IClusterSnapshotRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:04:49.580Z") @Stability(Stable) public class CfnClusterSnapshot extends CfnResource implements IInspectable, IClusterSnapshotRef, ITaggableV2
Resource Type definition for AWS::DocDBElastic::ClusterSnapshot.

Creates a manual snapshot of an Amazon DocumentDB elastic cluster.

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.docdbelastic.*;
 CfnClusterSnapshot cfnClusterSnapshot = CfnClusterSnapshot.Builder.create(this, "MyCfnClusterSnapshot")
         .clusterArn("clusterArn")
         .snapshotName("snapshotName")
         // the properties below are optional
         .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

    • CfnClusterSnapshot

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

    • CfnClusterSnapshot

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

    • CfnClusterSnapshot

      @Stability(Stable) public CfnClusterSnapshot(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnClusterSnapshotProps props)
      Create a new AWS::DocDBElastic::ClusterSnapshot.

      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

    • isCfnClusterSnapshot

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

      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.

    • getAttrAdminUserName

      @Stability(Stable) @NotNull public String getAttrAdminUserName()
      The name of the elastic cluster administrator.

    • getAttrClusterCreationTime

      @Stability(Stable) @NotNull public String getAttrClusterCreationTime()
      The time when the source elastic cluster was created, in Universal Coordinated Time (UTC).

    • getAttrKmsKeyId

      @Stability(Stable) @NotNull public String getAttrKmsKeyId()
      The KMS key identifier used to encrypt the source elastic cluster.

    • getAttrSnapshotArn

      @Stability(Stable) @NotNull public String getAttrSnapshotArn()
      The Amazon Resource Name (ARN) of the elastic cluster snapshot.

    • getAttrSnapshotCreationTime

      @Stability(Stable) @NotNull public String getAttrSnapshotCreationTime()
      The time when the elastic cluster snapshot was created, in Universal Coordinated Time (UTC).

    • getAttrSnapshotType

      @Stability(Stable) @NotNull public String getAttrSnapshotType()
      The type of the elastic cluster snapshot (manual or automated).

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the elastic cluster snapshot.

    • getAttrSubnetIds

      @Stability(Stable) @NotNull public List<String> getAttrSubnetIds()
      The Amazon EC2 subnet IDs associated with the source elastic cluster.

    • getAttrVpcSecurityGroupIds

      @Stability(Stable) @NotNull public List<String> getAttrVpcSecurityGroupIds()
      The Amazon EC2 security group IDs associated with the source elastic cluster.

    • 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

    • getClusterSnapshotRef

      @Stability(Stable) @NotNull public ClusterSnapshotReference getClusterSnapshotRef()
      A reference to a ClusterSnapshot resource.
      Specified by:
      getClusterSnapshotRef in interface IClusterSnapshotRef

    • getClusterArn

      @Stability(Stable) @NotNull public String getClusterArn()
      The ARN of the elastic cluster of which to create a snapshot.

    • setClusterArn

      @Stability(Stable) public void setClusterArn(@NotNull String value)
      The ARN of the elastic cluster of which to create a snapshot.

    • getSnapshotName

      @Stability(Stable) @NotNull public String getSnapshotName()
      The name of the elastic cluster snapshot.

    • setSnapshotName

      @Stability(Stable) public void setSnapshotName(@NotNull String value)
      The name of the elastic cluster snapshot.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to the elastic cluster snapshot.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to the elastic cluster snapshot.