Package software.amazon.awscdk.services.rds

Class CfnDBClusterParameterGroup

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.rds.CfnDBClusterParameterGroup
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IDBClusterParameterGroupRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:43.659Z") @Stability(Stable) public class CfnDBClusterParameterGroup extends CfnResource implements IInspectable, IDBClusterParameterGroupRef, ITaggable
The AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group.

For information about configuring parameters for Amazon Aurora DB clusters, see Working with parameter groups in the Amazon Aurora User Guide .

If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.

If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started.

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.rds.*;
 Object parameters;
 CfnDBClusterParameterGroup cfnDBClusterParameterGroup = CfnDBClusterParameterGroup.Builder.create(this, "MyCfnDBClusterParameterGroup")
         .description("description")
         .family("family")
         .parameters(parameters)
         // the properties below are optional
         .dbClusterParameterGroupName("dbClusterParameterGroupName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnDBClusterParameterGroup

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

    • CfnDBClusterParameterGroup

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

    • CfnDBClusterParameterGroup

      @Stability(Stable) public CfnDBClusterParameterGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDBClusterParameterGroupProps props)
      Create a new AWS::RDS::DBClusterParameterGroup.

      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

    • isCfnDBClusterParameterGroup

      @Stability(Stable) @NotNull public static Boolean isCfnDBClusterParameterGroup(@NotNull Object x)
      Checks whether the given object is a CfnDBClusterParameterGroup.

      Parameters:
      x - This parameter is required.

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

    • getCfnProperties

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

    • getDbClusterParameterGroupRef

      @Stability(Stable) @NotNull public DBClusterParameterGroupReference getDbClusterParameterGroupRef()
      A reference to a DBClusterParameterGroup resource.
      Specified by:
      getDbClusterParameterGroupRef in interface IDBClusterParameterGroupRef

    • getTags

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

    • getDescription

      @Stability(Stable) @NotNull public String getDescription()
      The description for the DB cluster parameter group.

    • setDescription

      @Stability(Stable) public void setDescription(@NotNull String value)
      The description for the DB cluster parameter group.

    • getFamily

      @Stability(Stable) @NotNull public String getFamily()
      The DB cluster parameter group family name.

    • setFamily

      @Stability(Stable) public void setFamily(@NotNull String value)
      The DB cluster parameter group family name.

    • getParameters

      @Stability(Stable) @NotNull public Object getParameters()
      Provides a list of parameters for the DB cluster parameter group.

    • setParameters

      @Stability(Stable) public void setParameters(@NotNull Object value)
      Provides a list of parameters for the DB cluster parameter group.

    • getDbClusterParameterGroupName

      @Stability(Stable) @Nullable public String getDbClusterParameterGroupName()
      The name of the DB cluster parameter group.

    • setDbClusterParameterGroupName

      @Stability(Stable) public void setDbClusterParameterGroupName(@Nullable String value)
      The name of the DB cluster parameter group.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Tags to assign to the DB cluster parameter group.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Tags to assign to the DB cluster parameter group.