Interface CfnDBParameterGroupProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDBParameterGroupProps.Jsii$Proxy
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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDBParameterGroupProps
static final class
An implementation forCfnDBParameterGroupProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The name of the DB parameter group.Provides the customer-specified description for this DB parameter group.The DB parameter group family name.default Object
An array of parameter names and values for the parameter update.getTags()
Tags to assign to the DB parameter group.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDescription
Provides the customer-specified description for this DB parameter group.- See Also:
-
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:
-
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:
-
getParameters
An array 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:
-
getTags
Tags to assign to the DB parameter group.- See Also:
-
builder
- Returns:
- a
CfnDBParameterGroupProps.Builder
ofCfnDBParameterGroupProps
-