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

Class CfnDBClusterParameterGroupPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.docdb.CfnDBClusterParameterGroupPropsMixin
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.253Z") @Stability(Stable) public class CfnDBClusterParameterGroupPropsMixin extends Mixin implements software.constructs.IMixin
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.

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;
 Object parameters;
 CfnDBClusterParameterGroupPropsMixin cfnDBClusterParameterGroupPropsMixin = CfnDBClusterParameterGroupPropsMixin.Builder.create(CfnDBClusterParameterGroupMixinProps.builder()
         .description("description")
         .family("family")
         .name("name")
         .parameters(parameters)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

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

  • Constructor Details

    • CfnDBClusterParameterGroupPropsMixin

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

    • CfnDBClusterParameterGroupPropsMixin

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

    • CfnDBClusterParameterGroupPropsMixin

      @Stability(Stable) public CfnDBClusterParameterGroupPropsMixin(@NotNull CfnDBClusterParameterGroupMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::DocDB::DBClusterParameterGroup.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnDBClusterParameterGroupPropsMixin

      @Stability(Stable) public CfnDBClusterParameterGroupPropsMixin(@NotNull CfnDBClusterParameterGroupMixinProps props)
      Create a mixin to apply properties to AWS::DocDB::DBClusterParameterGroup.

      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 CfnDBClusterParameterGroupMixinProps getProps()

    • getStrategy

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