Package software.amazon.awscdk.services.docdbelastic

Class CfnCluster

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.CfnCluster
All Implemented Interfaces:
IInspectable, ITaggable, IClusterRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:35.176Z") @Stability(Stable) public class CfnCluster extends CfnResource implements IInspectable, IClusterRef, ITaggable
Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.

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.*;
 CfnCluster cfnCluster = CfnCluster.Builder.create(this, "MyCfnCluster")
         .adminUserName("adminUserName")
         .authType("authType")
         .clusterName("clusterName")
         .shardCapacity(123)
         .shardCount(123)
         // the properties below are optional
         .adminUserPassword("adminUserPassword")
         .backupRetentionPeriod(123)
         .kmsKeyId("kmsKeyId")
         .preferredBackupWindow("preferredBackupWindow")
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .shardInstanceCount(123)
         .subnetIds(List.of("subnetIds"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .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

    • CfnCluster

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

    • CfnCluster

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

    • CfnCluster

      @Stability(Stable) public CfnCluster(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnClusterProps 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

    • 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.

    • getAttrClusterArn

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

    • getAttrClusterEndpoint

      @Stability(Stable) @NotNull public String getAttrClusterEndpoint()
      The URL used to connect to the elastic cluster.

    • getCfnProperties

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

    • getClusterRef

      @Stability(Stable) @NotNull public ClusterReference getClusterRef()
      A reference to a Cluster resource.
      Specified by:
      getClusterRef in interface IClusterRef

    • getTags

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

    • getAdminUserName

      @Stability(Stable) @NotNull public String getAdminUserName()
      The name of the Amazon DocumentDB elastic clusters administrator.

    • setAdminUserName

      @Stability(Stable) public void setAdminUserName(@NotNull String value)
      The name of the Amazon DocumentDB elastic clusters administrator.

    • getAuthType

      @Stability(Stable) @NotNull public String getAuthType()
      The authentication type used to determine where to fetch the password used for accessing the elastic cluster.

    • setAuthType

      @Stability(Stable) public void setAuthType(@NotNull String value)
      The authentication type used to determine where to fetch the password used for accessing the elastic cluster.

    • getClusterName

      @Stability(Stable) @NotNull public String getClusterName()
      The name of the new elastic cluster.

      This parameter is stored as a lowercase string.

    • setClusterName

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

      This parameter is stored as a lowercase string.

    • getShardCapacity

      @Stability(Stable) @NotNull public Number getShardCapacity()
      The number of vCPUs assigned to each elastic cluster shard.

    • setShardCapacity

      @Stability(Stable) public void setShardCapacity(@NotNull Number value)
      The number of vCPUs assigned to each elastic cluster shard.

    • getShardCount

      @Stability(Stable) @NotNull public Number getShardCount()
      The number of shards assigned to the elastic cluster.

    • setShardCount

      @Stability(Stable) public void setShardCount(@NotNull Number value)
      The number of shards assigned to the elastic cluster.

    • getAdminUserPassword

      @Stability(Stable) @Nullable public String getAdminUserPassword()
      The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.

    • setAdminUserPassword

      @Stability(Stable) public void setAdminUserPassword(@Nullable String value)
      The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.

    • getBackupRetentionPeriod

      @Stability(Stable) @Nullable public Number getBackupRetentionPeriod()
      The number of days for which automatic snapshots are retained.

    • setBackupRetentionPeriod

      @Stability(Stable) public void setBackupRetentionPeriod(@Nullable Number value)
      The number of days for which automatic snapshots are retained.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The KMS key identifier to use to encrypt the new elastic cluster.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The KMS key identifier to use to encrypt the new elastic cluster.

    • getPreferredBackupWindow

      @Stability(Stable) @Nullable public String getPreferredBackupWindow()
      The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod .

    • setPreferredBackupWindow

      @Stability(Stable) public void setPreferredBackupWindow(@Nullable String value)
      The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod .

    • getPreferredMaintenanceWindow

      @Stability(Stable) @Nullable public String getPreferredMaintenanceWindow()
      The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    • setPreferredMaintenanceWindow

      @Stability(Stable) public void setPreferredMaintenanceWindow(@Nullable String value)
      The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    • getShardInstanceCount

      @Stability(Stable) @Nullable public Number getShardInstanceCount()
      The number of replica instances applying to all shards in the cluster.

    • setShardInstanceCount

      @Stability(Stable) public void setShardInstanceCount(@Nullable Number value)
      The number of replica instances applying to all shards in the cluster.

    • getSubnetIds

      @Stability(Stable) @Nullable public List<String> getSubnetIds()
      The Amazon EC2 subnet IDs for the new elastic cluster.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@Nullable List<String> value)
      The Amazon EC2 subnet IDs for the new elastic cluster.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags to be assigned to the new elastic cluster.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags to be assigned to the new elastic cluster.

    • getVpcSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getVpcSecurityGroupIds()
      A list of EC2 VPC security groups to associate with the new elastic cluster.

    • setVpcSecurityGroupIds

      @Stability(Stable) public void setVpcSecurityGroupIds(@Nullable List<String> value)
      A list of EC2 VPC security groups to associate with the new elastic cluster.