Package software.amazon.awscdk.services.rds

Class CfnDBParameterGroup

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.CfnDBParameterGroup
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:23.326Z") @Stability(Stable) public class CfnDBParameterGroup extends CfnResource implements IInspectable, ITaggable
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();

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

    • CfnDBParameterGroup

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

    • CfnDBParameterGroup

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

    • CfnDBParameterGroup

      @Stability(Stable) public CfnDBParameterGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDBParameterGroupProps props)
      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

    • 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()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

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

    • setFamily

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

    • getDbParameterGroupName

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

    • setDbParameterGroupName

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

    • getParameters

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

    • setParameters

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

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An optional array of key-value pairs to apply to this DB parameter group.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An optional array of key-value pairs to apply to this DB parameter group.