Package software.amazon.awscdk.services.rds

Class CfnDBClusterParameterGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.rds.CfnDBClusterParameterGroup
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:48.929Z") @Stability(Stable) public class CfnDBClusterParameterGroup extends CfnResource implements IInspectable
A CloudFormation AWS::RDS::DBClusterParameterGroup.

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 update 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();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An optional array of key-value pairs to apply to this DB cluster parameter group.

    • getDescription

      @Stability(Stable) @NotNull public String getDescription()
      A friendly description for this DB cluster parameter group.

    • setDescription

      @Stability(Stable) public void setDescription(@NotNull String value)
      A friendly description for this DB cluster parameter group.

    • getFamily

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

      A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family.

      The DB cluster parameter group family can't be changed when updating a DB cluster parameter group.

      To list all of the available parameter group families, use the following command:

      aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"

      The output contains duplicates.

      For more information, see [CreateDBClusterParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBClusterParameterGroup.html) .

    • setFamily

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

      A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family.

      The DB cluster parameter group family can't be changed when updating a DB cluster parameter group.

      To list all of the available parameter group families, use the following command:

      aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"

      The output contains duplicates.

      For more information, see [CreateDBClusterParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBClusterParameterGroup.html) .

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

      Constraints:

      • Must not match the name of an existing DB cluster parameter group.

      If you don't specify a value for DBClusterParameterGroupName property, a name is automatically created for the DB cluster parameter group.

      This value is stored as a lowercase string.

    • setDbClusterParameterGroupName

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

      Constraints:

      • Must not match the name of an existing DB cluster parameter group.

      If you don't specify a value for DBClusterParameterGroupName property, a name is automatically created for the DB cluster parameter group.

      This value is stored as a lowercase string.