Package software.amazon.awscdk.cfnpropertymixins.services.docdb

Class CfnDBClusterPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.docdb.CfnDBClusterPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:58.254Z")
@Stability(Stable)
public class CfnDBClusterPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::DocDB::DBCluster Amazon DocumentDB (with MongoDB compatibility) resource describes a DBCluster.

Amazon DocumentDB is a fully managed, MongoDB-compatible document database engine. For more information, see DBCluster in the Amazon DocumentDB Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.docdb.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnDBClusterPropsMixin cfnDBClusterPropsMixin = CfnDBClusterPropsMixin.Builder.create(CfnDBClusterMixinProps.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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDBClusterPropsMixin.Builder	A fluent builder for CfnDBClusterPropsMixin.
static interface	CfnDBClusterPropsMixin.ServerlessV2ScalingConfigurationProperty	Sets the scaling configuration of an Amazon DocumentDB Serverless cluster.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnDBClusterPropsMixin(CfnDBClusterMixinProps props)	Create a mixin to apply properties to AWS::DocDB::DBCluster.
	CfnDBClusterPropsMixin(CfnDBClusterMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::DocDB::DBCluster.
protected	CfnDBClusterPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDBClusterPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnDBClusterMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnDBClusterPropsMixin

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

CfnDBClusterPropsMixin

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

CfnDBClusterPropsMixin

@Stability(Stable)
public CfnDBClusterPropsMixin(@NotNull
 CfnDBClusterMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::DocDB::DBCluster.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnDBClusterPropsMixin

@Stability(Stable)
public CfnDBClusterPropsMixin(@NotNull
 CfnDBClusterMixinProps props)

Create a mixin to apply properties to AWS::DocDB::DBCluster.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnDBClusterMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()