Package software.amazon.awscdk.services.docdb

Interface CfnDBClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:34.381Z")
@Stability(Stable)
public interface CfnDBClusterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDBCluster.

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.docdb.*;
 CfnDBClusterProps cfnDBClusterProps = CfnDBClusterProps.builder()
         .availabilityZones(List.of("availabilityZones"))
         .backupRetentionPeriod(123)
         .copyTagsToSnapshot(false)
         .dbClusterIdentifier("dbClusterIdentifier")
         .dbClusterParameterGroupName("dbClusterParameterGroupName")
         .dbSubnetGroupName("dbSubnetGroupName")
         .deletionProtection(false)
         .enableCloudwatchLogsExports(List.of("enableCloudwatchLogsExports"))
         .engineVersion("engineVersion")
         .globalClusterIdentifier("globalClusterIdentifier")
         .kmsKeyId("kmsKeyId")
         .manageMasterUserPassword(false)
         .masterUsername("masterUsername")
         .masterUserPassword("masterUserPassword")
         .masterUserSecretKmsKeyId("masterUserSecretKmsKeyId")
         .networkType("networkType")
         .port(123)
         .preferredBackupWindow("preferredBackupWindow")
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .restoreToTime("restoreToTime")
         .restoreType("restoreType")
         .rotateMasterUserPassword(false)
         .serverlessV2ScalingConfiguration(ServerlessV2ScalingConfigurationProperty.builder()
                 .maxCapacity(123)
                 .minCapacity(123)
                 .build())
         .snapshotIdentifier("snapshotIdentifier")
         .sourceDbClusterIdentifier("sourceDbClusterIdentifier")
         .storageEncrypted(false)
         .storageType("storageType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .useLatestRestorableTime(false)
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDBClusterProps.Builder	A builder for CfnDBClusterProps
static final class	CfnDBClusterProps.Jsii$Proxy	An implementation for CfnDBClusterProps

Method Summary

Modifier and Type	Method	Description
static CfnDBClusterProps.Builder	builder()
default List<String>	getAvailabilityZones()	A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
default Number	getBackupRetentionPeriod()	The number of days for which automated backups are retained.
default Object	getCopyTagsToSnapshot()	Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false .
default String	getDbClusterIdentifier()	The cluster identifier.
default String	getDbClusterParameterGroupName()	The name of the cluster parameter group to associate with this cluster.
default String	getDbSubnetGroupName()	A subnet group to associate with this cluster.
default Object	getDeletionProtection()	Protects clusters from being accidentally deleted.
default List<String>	getEnableCloudwatchLogsExports()	The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
default String	getEngineVersion()	The version number of the database engine to use.
default String	getGlobalClusterIdentifier()	The cluster identifier of the new global cluster.
default String	getKmsKeyId()	The AWS key identifier for an encrypted cluster.
default Object	getManageMasterUserPassword()	Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
default String	getMasterUsername()	The name of the master user for the cluster.
default String	getMasterUserPassword()	The password for the master database user.
default String	getMasterUserSecretKmsKeyId()	The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
default String	getNetworkType()	The network type of the cluster.
default Number	getPort()	Specifies the port that the database engine is listening on.
default String	getPreferredBackupWindow()	The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
default String	getPreferredMaintenanceWindow()	The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
default String	getRestoreToTime()	The date and time to restore the cluster to.
default String	getRestoreType()	The type of restore to be performed.
default Object	getRotateMasterUserPassword()	Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
default Object	getServerlessV2ScalingConfiguration()	Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.
default String	getSnapshotIdentifier()	The identifier for the snapshot or cluster snapshot to restore from.
default String	getSourceDbClusterIdentifier()	The identifier of the source cluster from which to restore.
default Object	getStorageEncrypted()	Specifies whether the cluster is encrypted.
default String	getStorageType()	The storage type to associate with the DB cluster.
default List<CfnTag>	getTags()	The tags to be assigned to the cluster.
default Object	getUseLatestRestorableTime()	A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.
default List<String>	getVpcSecurityGroupIds()	A list of EC2 VPC security groups to associate with this cluster.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAvailabilityZones

@Stability(Stable)
@Nullable
default List<String> getAvailabilityZones()

A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-availabilityzones

getBackupRetentionPeriod

@Stability(Stable)
@Nullable
default Number getBackupRetentionPeriod()

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

• Must be a value from 1 to 35.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-backupretentionperiod

getCopyTagsToSnapshot

@Stability(Stable)
@Nullable
default Object getCopyTagsToSnapshot()

Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false .

The default is false .

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-copytagstosnapshot

getDbClusterIdentifier

@Stability(Stable)
@Nullable
default String getDbClusterIdentifier()

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbclusteridentifier

getDbClusterParameterGroupName

@Stability(Stable)
@Nullable
default String getDbClusterParameterGroupName()

The name of the cluster parameter group to associate with this cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbclusterparametergroupname

getDbSubnetGroupName

@Stability(Stable)
@Nullable
default String getDbSubnetGroupName()

A subnet group to associate with this cluster.

Constraints: Must match the name of an existing DBSubnetGroup . Must not be default.

Example: mySubnetgroup

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbsubnetgroupname

getDeletionProtection

@Stability(Stable)
@Nullable
default Object getDeletionProtection()

Protects clusters from being accidentally deleted.

If enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-deletionprotection

getEnableCloudwatchLogsExports

@Stability(Stable)
@Nullable
default List<String> getEnableCloudwatchLogsExports()

The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.

You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-enablecloudwatchlogsexports

getEngineVersion

@Stability(Stable)
@Nullable
default String getEngineVersion()

The version number of the database engine to use.

The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

If you intend to trigger an in-place upgrade, please refer to Amazon DocumentDB in-place major version upgrade . Note that for an in-place engine version upgrade, you need to remove other cluster properties changes (e.g. SecurityGroupId) from the CFN template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-engineversion

getGlobalClusterIdentifier

@Stability(Stable)
@Nullable
default String getGlobalClusterIdentifier()

The cluster identifier of the new global cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-globalclusteridentifier

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

The AWS key identifier for an encrypted cluster.

The AWS key identifier is the Amazon Resource Name (ARN) for the AWS encryption key. If you are creating a cluster using the same AWS account that owns the AWS encryption key that is used to encrypt the new cluster, you can use the AWS key alias instead of the ARN for the AWS encryption key.

If an encryption key is not specified in KmsKeyId :

• If the StorageEncrypted parameter is true , Amazon DocumentDB uses your default encryption key.

AWS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Regions .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-kmskeyid

getManageMasterUserPassword

@Stability(Stable)
@Nullable
default Object getManageMasterUserPassword()

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

Constraint: You can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-managemasteruserpassword

getMasterUsername

@Stability(Stable)
@Nullable
default String getMasterUsername()

The name of the master user for the cluster.

Constraints:

• Must be from 1 to 63 letters or numbers.
• The first character must be a letter.
• Cannot be a reserved word for the chosen database engine.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masterusername

getMasterUserPassword

@Stability(Stable)
@Nullable
default String getMasterUserPassword()

The password for the master database user.

This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masteruserpassword

getMasterUserSecretKmsKeyId

@Stability(Stable)
@Nullable
default String getMasterUserSecretKmsKeyId()

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

If you don't specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masterusersecretkmskeyid

getNetworkType

@Stability(Stable)
@Nullable
default String getNetworkType()

The network type of the cluster.

The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL ).

For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.

Valid Values: IPV4 | DUAL

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-networktype

getPort

@Stability(Stable)
@Nullable
default Number getPort()

Specifies the port that the database engine is listening on.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-port

getPreferredBackupWindow

@Stability(Stable)
@Nullable
default String getPreferredBackupWindow()

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region .

Constraints:

• Must be in the format hh24:mi-hh24:mi .
• Must be in Universal Coordinated Time (UTC).
• Must not conflict with the preferred maintenance window.
• Must be at least 30 minutes.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-preferredbackupwindow

getPreferredMaintenanceWindow

@Stability(Stable)
@Nullable
default String getPreferredMaintenanceWindow()

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-preferredmaintenancewindow

getRestoreToTime

@Stability(Stable)
@Nullable
default String getRestoreToTime()

The date and time to restore the cluster to.

Valid values: A time in Universal Coordinated Time (UTC) format.

Constraints:

• Must be before the latest restorable time for the instance.
• Must be specified if the UseLatestRestorableTime parameter is not provided.
• Cannot be specified if the UseLatestRestorableTime parameter is true .
• Cannot be specified if the RestoreType parameter is copy-on-write .

Example: 2015-03-07T23:45:00Z

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-restoretotime

getRestoreType

@Stability(Stable)
@Nullable
default String getRestoreType()

The type of restore to be performed. You can specify one of the following values:.

• full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
• copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-restoretype

getRotateMasterUserPassword

@Stability(Stable)
@Nullable
default Object getRotateMasterUserPassword()

Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.

This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.

Constraint: You must apply the change immediately when rotating the master user password.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-rotatemasteruserpassword

getServerlessV2ScalingConfiguration

@Stability(Stable)
@Nullable
default Object getServerlessV2ScalingConfiguration()

Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.

Returns union: either IResolvable or CfnDBCluster.ServerlessV2ScalingConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-serverlessv2scalingconfiguration

getSnapshotIdentifier

@Stability(Stable)
@Nullable
default String getSnapshotIdentifier()

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

• Must match the identifier of an existing snapshot.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-snapshotidentifier

getSourceDbClusterIdentifier

@Stability(Stable)
@Nullable
default String getSourceDbClusterIdentifier()

The identifier of the source cluster from which to restore.

Constraints:

• Must match the identifier of an existing DBCluster .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-sourcedbclusteridentifier

getStorageEncrypted

@Stability(Stable)
@Nullable
default Object getStorageEncrypted()

Specifies whether the cluster is encrypted.

If you specify SourceDBClusterIdentifier or SnapshotIdentifier and don’t specify StorageEncrypted , the encryption property is inherited from the source cluster or snapshot (unless KMSKeyId is specified, in which case the restored cluster will be encrypted with that KMS key). If the source is encrypted and StorageEncrypted is specified to be true, the restored cluster will be encrypted (if you want to use a different KMS key, specify the KMSKeyId property as well). If the source is unencrypted and StorageEncrypted is specified to be true, then the KMSKeyId property must be specified. If the source is encrypted, don’t specify StorageEncrypted to be false as opting out of encryption is not allowed.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-storageencrypted

getStorageType

@Stability(Stable)
@Nullable
default String getStorageType()

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide .

Valid values for storage type - standard | iopt1

Default value is standard

When you create an Amazon DocumentDB cluster with the storage type set to iopt1 , the storage type is returned in the response. The storage type isn't returned when you set it to standard .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-storagetype

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags to be assigned to the cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-tags

getUseLatestRestorableTime

@Stability(Stable)
@Nullable
default Object getUseLatestRestorableTime()

A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-uselatestrestorabletime

getVpcSecurityGroupIds

@Stability(Stable)
@Nullable
default List<String> getVpcSecurityGroupIds()

A list of EC2 VPC security groups to associate with this cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-vpcsecuritygroupids

builder

@Stability(Stable)
static CfnDBClusterProps.Builder builder()

Returns:

a CfnDBClusterProps.Builder of CfnDBClusterProps