@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:45.101Z") public class CfnDBClusterParameterGroup extends CfnResource implements IInspectable
The AWS::DocDB::DBClusterParameterGroup
Amazon DocumentDB (with MongoDB compatibility) resource describes a DBClusterParameterGroup. For more information, see DBClusterParameterGroup in the Amazon DocumentDB Developer Guide .
Parameters in a cluster parameter group apply to all of the instances in a cluster.
A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the cluster without failover.
After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the cluster parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the
character_set_database
parameter.
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.docdb.*; Object parameters; CfnDBClusterParameterGroup cfnDBClusterParameterGroup = CfnDBClusterParameterGroup.Builder.create(this, "MyCfnDBClusterParameterGroup") .description("description") .family("family") .parameters(parameters) // the properties below are optional .name("name") .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::DocDB::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 |
getDescription()
The description for the cluster parameter group.
|
java.lang.String |
getFamily()
The cluster parameter group family name.
|
java.lang.String |
getName()
The name of the DB cluster parameter group.
|
java.lang.Object |
getParameters()
Provides a list of parameters for the cluster parameter group.
|
TagManager |
getTags()
The tags to be assigned to the 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 |
setDescription(java.lang.String value)
The description for the cluster parameter group.
|
void |
setFamily(java.lang.String value)
The cluster parameter group family name.
|
void |
setName(java.lang.String value)
The name of the DB cluster parameter group.
|
void |
setParameters(java.lang.Object value)
Provides a list of parameters for the 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()
public void setFamily(java.lang.String value)
public java.lang.Object getParameters()
public void setParameters(java.lang.Object value)
public java.lang.String getName()
Constraints:
DBClusterParameterGroup
.
This value is stored as a lowercase string.
public void setName(java.lang.String value)
Constraints:
DBClusterParameterGroup
.
This value is stored as a lowercase string.