Package software.amazon.awscdk.services.rds

Interface CfnDBParameterGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBParameterGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:43.735Z")
@Stability(Stable)
public interface CfnDBParameterGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDBParameterGroup.

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;
 CfnDBParameterGroupProps cfnDBParameterGroupProps = CfnDBParameterGroupProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDBParameterGroupProps.Builder	A builder for CfnDBParameterGroupProps
static final class	CfnDBParameterGroupProps.Jsii$Proxy	An implementation for CfnDBParameterGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnDBParameterGroupProps.Builder	builder()
default String	getDbParameterGroupName()	The name of the DB parameter group.
String	getDescription()	Provides the customer-specified description for this DB parameter group.
String	getFamily()	The DB parameter group family name.
default Object	getParameters()	A mapping of parameter names and values for the parameter update.
default List<CfnTag>	getTags()	Tags to assign to the DB parameter group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@NotNull
String getDescription()

Provides the customer-specified description for this DB parameter group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-description

getFamily

@Stability(Stable)
@NotNull
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 database engine and engine version compatible with that DB parameter group family.

To list all of the available parameter group families for a DB engine, use the following command:

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

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

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

The output contains duplicates.

The following are the valid DB engine values:

• aurora-mysql
• aurora-postgresql
• db2-ae
• db2-se
• mysql
• oracle-ee
• oracle-ee-cdb
• oracle-se2
• oracle-se2-cdb
• postgres
• sqlserver-ee
• sqlserver-se
• sqlserver-ex
• sqlserver-web

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-family

getDbParameterGroupName

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-dbparametergroupname

getParameters

@Stability(Stable)
@Nullable
default Object getParameters()

A mapping of parameter names and values for the parameter update.

You must specify at least one parameter name and value.

For more information about parameter groups, see Working with parameter groups in the Amazon RDS User Guide , or Working with 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-parameters

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Tags to assign to the DB parameter group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-tags

builder

@Stability(Stable)
static CfnDBParameterGroupProps.Builder builder()

Returns:

a CfnDBParameterGroupProps.Builder of CfnDBParameterGroupProps