Package software.amazon.awscdk.services.rds

Class CfnDBParameterGroup

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.CfnDBParameterGroup
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:49.020Z") @Stability(Stable) public class CfnDBParameterGroup extends CfnResource implements IInspectable
A CloudFormation AWS::RDS::DBParameterGroup.

The AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family.

This type can be declared in a template and referenced in the DBParameterGroupName property of an [AWS::RDS::DBInstance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html) resource.

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

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

Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.

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;
 CfnDBParameterGroup cfnDBParameterGroup = CfnDBParameterGroup.Builder.create(this, "MyCfnDBParameterGroup")
         .description("description")
         .family("family")
         // the properties below are optional
         .dbParameterGroupName("dbParameterGroupName")
         .parameters(parameters)
         .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

    • CfnDBParameterGroup

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

    • CfnDBParameterGroup

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

    • CfnDBParameterGroup

      @Stability(Stable) public CfnDBParameterGroup(@NotNull Construct scope, @NotNull String id, @NotNull CfnDBParameterGroupProps props)
      Create a new AWS::RDS::DBParameterGroup.

      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.

    • getAttrDbParameterGroupName

      @Stability(Stable) @NotNull public String getAttrDbParameterGroupName()
      The name of the DB parameter group.

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

      Currently, this is the only property that supports drift detection.

    • getDescription

      @Stability(Stable) @NotNull public String getDescription()
      Provides the customer-specified description for this DB parameter group.

    • setDescription

      @Stability(Stable) public void setDescription(@NotNull String value)
      Provides the customer-specified description for this DB parameter group.

    • getFamily

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

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

      The DB parameter group family can't be changed when updating a DB 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 [CreateDBParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html) .

    • setFamily

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

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

      The DB parameter group family can't be changed when updating a DB 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 [CreateDBParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html) .

    • getParameters

      @Stability(Stable) @NotNull public Object getParameters()
      An array of parameter names and values for the parameter update.

      At least one parameter name and value must be supplied. Subsequent arguments are optional.

      For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see Working with DB Parameter Groups in the Amazon RDS User Guide .

      For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see Working with DB Parameter Groups and DB Cluster Parameter Groups in the Amazon Aurora User Guide .

      AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.

    • setParameters

      @Stability(Stable) public void setParameters(@NotNull Object value)
      An array of parameter names and values for the parameter update.

      At least one parameter name and value must be supplied. Subsequent arguments are optional.

      For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see Working with DB Parameter Groups in the Amazon RDS User Guide .

      For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see Working with DB Parameter Groups and DB Cluster Parameter Groups in the Amazon Aurora User Guide .

      AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.

    • getDbParameterGroupName

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

      Constraints:

      • Must be 1 to 255 letters, numbers, or hyphens.
      • First character must be a letter
      • Can't end with a hyphen or contain two consecutive hyphens

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

      This value is stored as a lowercase string.

    • setDbParameterGroupName

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

      Constraints:

      • Must be 1 to 255 letters, numbers, or hyphens.
      • First character must be a letter
      • Can't end with a hyphen or contain two consecutive hyphens

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

      This value is stored as a lowercase string.