software.amazon.awscdk.services.docdb

Class CfnDBClusterParameterGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.docdb.CfnDBClusterParameterGroup

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.013Z")
 @Stability(value=Stable)
public class CfnDBClusterParameterGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DocDB::DBClusterParameterGroup`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDBClusterParameterGroup.Builder A fluent builder for CfnDBClusterParameterGroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDBClusterParameterGroup(software.constructs.Construct scope, 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)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description for the cluster parameter group.
String	getFamily() The cluster parameter group family name.
String	getName() The name of the DB cluster parameter group.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The description for the cluster parameter group.
void	setFamily(String value) The cluster parameter group family name.
void	setName(String value) The name of the DB cluster parameter group.
void	setParameters(Object value) Provides a list of parameters for the cluster parameter group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDBClusterParameterGroup

protected CfnDBClusterParameterGroup(software.amazon.jsii.JsiiObjectRef objRef)

CfnDBClusterParameterGroup

protected CfnDBClusterParameterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDBClusterParameterGroup

@Stability(value=Stable)
public CfnDBClusterParameterGroup(@NotNull
                                                           software.constructs.Construct scope,
                                                           @NotNull
                                                           String id,
                                                           @NotNull
                                                           CfnDBClusterParameterGroupProps props)

Create a new `AWS::DocDB::DBClusterParameterGroup`.

Parameters:

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.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags to be assigned to the cluster parameter group.

getDescription

@Stability(value=Stable)
 @NotNull
public String getDescription()

The description for the cluster parameter group.

setDescription

@Stability(value=Stable)
public void setDescription(@NotNull
                                                    String value)

The description for the cluster parameter group.

getFamily

@Stability(value=Stable)
 @NotNull
public String getFamily()

The cluster parameter group family name.

setFamily

@Stability(value=Stable)
public void setFamily(@NotNull
                                               String value)

The cluster parameter group family name.

getParameters

@Stability(value=Stable)
 @NotNull
public Object getParameters()

Provides a list of parameters for the cluster parameter group.

setParameters

@Stability(value=Stable)
public void setParameters(@NotNull
                                                   Object value)

Provides a list of parameters for the cluster parameter group.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the DB cluster parameter group.

Constraints:

• Must not match the name of an existing DBClusterParameterGroup .

This value is stored as a lowercase string.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the DB cluster parameter group.

Constraints:

• Must not match the name of an existing DBClusterParameterGroup .

This value is stored as a lowercase string.