AWS CDK Reference

Appearance

v2.275.0

CfnDBClusterParameterGroupPropsMixin Mixin ​

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

For more information, see DBClusterParameterGroup in the Amazon DocumentDB Developer Guide .

Parameters in a cluster parameter group apply to all of the instances in a cluster.

A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the cluster without failover.

After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the cluster parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.

CloudFormation
AWS::DocDB::DBClusterParameterGroup
Source
Generated code
Type last changed
v2.269.0 · 16 Sep 2026

Initializer ​

ts
new CfnDBClusterParameterGroupPropsMixin(props: CfnDBClusterParameterGroupMixinProps, options?: CfnPropertyMixinOptions)
python
CfnDBClusterParameterGroupPropsMixin(props: CfnDBClusterParameterGroupMixinProps, options: typing.Optional[CfnPropertyMixinOptions] = None)
java
new CfnDBClusterParameterGroupPropsMixin(CfnDBClusterParameterGroupMixinProps props, CfnPropertyMixinOptions options)
csharp
new CfnDBClusterParameterGroupPropsMixin(CfnDBClusterParameterGroupMixinProps props, CfnPropertyMixinOptions? options = null)
go
NewCfnDBClusterParameterGroupPropsMixin(Props CfnDBClusterParameterGroupMixinProps, Options CfnPropertyMixinOptions)

Methods ​

applyTo(construct: IConstruct): voiddef apply_to(self, construct: IConstruct) -> Nonepublic void applyTo(IConstruct construct)public void ApplyTo(IConstruct construct)func ApplyTo(Construct IConstruct)#
Apply the mixin properties to the construct.
isMixin(x: any): boolean@staticmethod def is_mixin(x: Any) -> boolpublic static Boolean isMixin(Object x)public static bool IsMixin(object x)func IsMixin(X interface{}) *boolstatic#
Checks if `x` is a Mixin.
1 parameter · returns

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Mixin.

supports(construct: IConstruct): booleandef supports(self, construct: IConstruct) -> boolpublic Boolean supports(IConstruct construct)public bool Supports(IConstruct construct)func Supports(Construct IConstruct) *bool#
Check if this mixin supports the given construct.