Class CfnDBParameterGroup
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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();
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnDBParameterGroup
(Construct scope, String id, CfnDBParameterGroupProps props) Create a newAWS::RDS::DBParameterGroup
.protected
CfnDBParameterGroup
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDBParameterGroup
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe name of the DB parameter group.The name of the DB parameter group.Provides the customer-specified description for this DB parameter group.The DB parameter group family name.An array of parameter names and values for the parameter update.getTags()
An optional array of key-value pairs to apply to this DB parameter group.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDbParameterGroupName
(String value) The name of the DB parameter group.void
setDescription
(String value) Provides the customer-specified description for this DB parameter group.void
The DB parameter group family name.void
setParameters
(Object value) An array of parameter names and values for the parameter update.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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 newAWS::RDS::DBParameterGroup
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrDbParameterGroupName
The name of the DB parameter group. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
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
Provides the customer-specified description for this DB parameter group. -
setDescription
Provides the customer-specified description for this DB parameter group. -
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
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
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
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
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
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.
-