Amazon DocumentDB
Developer Guide

CreateDBClusterParameterGroup

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB 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 DB cluster. For the new DB cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the DB cluster without failover.

Important

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DBClusterParameterGroupName

The name of the DB cluster parameter group.

Constraints:

  • Must match the name of an existing DBClusterParameterGroup.

Note

This value is stored as a lowercase string.

Type: String

Required: Yes

DBParameterGroupFamily

The DB cluster parameter group family name.

Type: String

Required: Yes

Description

The description for the DB cluster parameter group.

Type: String

Required: Yes

Tags.Tag.N

The tags to be assigned to the DB cluster parameter group.

Type: Array of Tag objects

Required: No

Response Elements

The following element is returned by the service.

DBClusterParameterGroup

Detailed information about a DB cluster parameter group.

Type: DBClusterParameterGroup object

Errors

For information about the errors that are common to all actions, see Common Errors.

DBParameterGroupAlreadyExists

A DB parameter group with the same name already exists.

HTTP Status Code: 400

DBParameterGroupQuotaExceeded

This request would cause you to exceed the allowed number of DB parameter groups.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: