@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:51.058Z") public class CfnDBClusterParameterGroup extends CfnResource implements IInspectable
The AWS::RDS::DBClusterParameterGroup
resource creates a new Amazon RDS DB cluster parameter group.
For information about configuring parameters for Amazon Aurora DB clusters, see Working with parameter groups in the Amazon Aurora User Guide .
If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.
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; CfnDBClusterParameterGroup cfnDBClusterParameterGroup = CfnDBClusterParameterGroup.Builder.create(this, "MyCfnDBClusterParameterGroup") .description("description") .family("family") .parameters(parameters) // the properties below are optional .dbClusterParameterGroupName("dbClusterParameterGroupName") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnDBClusterParameterGroup.Builder
A fluent builder for
CfnDBClusterParameterGroup . |
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 |
---|---|
|
CfnDBClusterParameterGroup(Construct scope,
java.lang.String id,
CfnDBClusterParameterGroupProps props)
Create a new `AWS::RDS::DBClusterParameterGroup`.
|
protected |
CfnDBClusterParameterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnDBClusterParameterGroup(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDbClusterParameterGroupName()
The name of the DB cluster parameter group.
|
java.lang.String |
getDescription()
A friendly description for this DB cluster parameter group.
|
java.lang.String |
getFamily()
The DB cluster parameter group family name.
|
java.lang.Object |
getParameters()
Provides a list of parameters for the DB cluster parameter group.
|
TagManager |
getTags()
An optional array of key-value pairs to apply to this DB cluster 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 |
setDbClusterParameterGroupName(java.lang.String value)
The name of the DB cluster parameter group.
|
void |
setDescription(java.lang.String value)
A friendly description for this DB cluster parameter group.
|
void |
setFamily(java.lang.String value)
The DB cluster parameter group family name.
|
void |
setParameters(java.lang.Object value)
Provides a list of parameters for the DB cluster parameter group.
|
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 CfnDBClusterParameterGroup(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDBClusterParameterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDBClusterParameterGroup(Construct scope, java.lang.String id, CfnDBClusterParameterGroupProps 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.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 cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family.
The DB cluster parameter group family can't be changed when updating a DB cluster 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 [CreateDBClusterParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBClusterParameterGroup.html)
.
public void setFamily(java.lang.String value)
A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family.
The DB cluster parameter group family can't be changed when updating a DB cluster 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 [CreateDBClusterParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBClusterParameterGroup.html)
.
public java.lang.Object getParameters()
public void setParameters(java.lang.Object value)
public java.lang.String getDbClusterParameterGroupName()
Constraints:
If you don't specify a value for DBClusterParameterGroupName
property, a name is automatically created for the DB cluster parameter group.
This value is stored as a lowercase string.
public void setDbClusterParameterGroupName(java.lang.String value)
Constraints:
If you don't specify a value for DBClusterParameterGroupName
property, a name is automatically created for the DB cluster parameter group.
This value is stored as a lowercase string.