Class CfnDBClusterParameterGroup
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnDBClusterParameterGroup
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnDBClusterParameterGroup
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDBClusterParameterGroup
(software.amazon.jsii.JsiiObjectRef objRef) CfnDBClusterParameterGroup
(software.constructs.Construct scope, String id, CfnDBClusterParameterGroupProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe description for the cluster parameter group.The cluster parameter group family name.getName()
The name of the DB cluster parameter group.Provides a list of parameters for the cluster parameter group.getTags()
Tag Manager which manages the tags for this resource.The tags to be assigned to the cluster parameter group.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDescription
(String value) The description for the cluster parameter group.void
The cluster parameter group family name.void
The name of the DB cluster parameter group.void
setParameters
(Object value) Provides a list of parameters for the cluster parameter group.void
setTagsRaw
(List<CfnTag> value) The tags to be assigned to the cluster parameter group.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
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
-
CfnDBClusterParameterGroup
protected CfnDBClusterParameterGroup(software.amazon.jsii.JsiiObjectRef objRef) -
CfnDBClusterParameterGroup
protected CfnDBClusterParameterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnDBClusterParameterGroup
@Stability(Stable) public CfnDBClusterParameterGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDBClusterParameterGroupProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getDescription
The description for the cluster parameter group. -
setDescription
The description for the cluster parameter group. -
getFamily
The cluster parameter group family name. -
setFamily
The cluster parameter group family name. -
getParameters
Provides a list of parameters for the cluster parameter group. -
setParameters
Provides a list of parameters for the cluster parameter group. -
getName
The name of the DB cluster parameter group. -
setName
The name of the DB cluster parameter group. -
getTagsRaw
The tags to be assigned to the cluster parameter group. -
setTagsRaw
The tags to be assigned to the cluster parameter group.
-