@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:28:02.870Z") public class CfnDBParameterGroup extends CfnResource implements IInspectable
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 DB parameter groups in the Amazon RDS User Guide .
For information about configuring parameters for Amazon Aurora DB instances, see Working with DB parameter groups and DB cluster 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 .parameters(parameters) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnDBParameterGroup.Builder
A fluent builder for
CfnDBParameterGroup . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnDBParameterGroup(Construct scope,
java.lang.String id,
CfnDBParameterGroupProps props)
Create a new `AWS::RDS::DBParameterGroup`.
|
protected |
CfnDBParameterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnDBParameterGroup(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrDbParameterGroupName() |
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDescription()
Provides the customer-specified description for this DB parameter group.
|
java.lang.String |
getFamily()
The DB parameter group family name.
|
java.lang.Object |
getParameters()
An array of parameter names and values for the parameter update.
|
TagManager |
getTags()
Tags to assign to the DB parameter group.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDescription(java.lang.String value)
Provides the customer-specified description for this DB parameter group.
|
void |
setFamily(java.lang.String value)
The DB parameter group family name.
|
void |
setParameters(java.lang.Object value)
An array of parameter names and values for the parameter update.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDBParameterGroup(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDBParameterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDBParameterGroup(Construct scope, java.lang.String id, CfnDBParameterGroupProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrDbParameterGroupName()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getFamily()
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)
.
public void setFamily(java.lang.String value)
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)
.
public java.lang.Object getParameters()
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.
public void setParameters(java.lang.Object value)
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.