AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::DocDB::DBClusterParameterGroup

CfnDBClusterParameterGroup

The `AWS::DocDB::DBClusterParameterGroup` Amazon DocumentDB (with MongoDB compatibility) resource describes a DBClusterParameterGroup. For more information, see [DBClusterParameterGroup](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBClusterParameterGroup.html) 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.

Import

import { CfnDBClusterParameterGroup } from 'aws-cdk-lib/aws-docdb';

Or use the module namespace:

import * as docdb from 'aws-cdk-lib/aws-docdb';
// docdb.CfnDBClusterParameterGroup

Properties

Configuration passed to the constructor as CfnDBClusterParameterGroupProps.

descriptionRequired
string

The description for the cluster parameter group.

familyRequired
string

The cluster parameter group family name.

parametersRequired
any

Provides a list of parameters for the cluster parameter group.

nameOptional
string

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.

tagsOptional
CfnTag[]

The tags to be assigned to the cluster parameter group.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter