Amazon DocumentDB
Developer Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Creating an Amazon DocumentDB Cluster Parameter Group

A cluster parameter group is a collection of Amazon DocumentDB configuration values that make it easier to manage the parameters of your Amazon DocumentDB clusters. Amazon DocumentDB provides a default cluster parameter group default.docdb3.6, which you cannot modify. However, you can create a custom cluster parameter group based on the docdb3.6 family and then modify the parameters within your custom cluster parameter group.

You can create a custom cluster parameter group using the AWS Management Console or AWS CLI.

Important

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. This allows Amazon DocumentDB to fully complete the create action before the cluster parameter group is used for a new cluster. You can use the console or the describe-db-cluster-parameters operation to verify that your cluster parameter group has been created or modified.

Using the AWS Management Console

The following procedure guides you through creating a cluster parameter group using the console.

To create a cluster parameter group

  1. Sign in to the AWS Management Console, and open the Amazon DocumentDB console at https://console.aws.amazon.com/docdb.

  2. In the navigation pane, choose Parameter groups.

    Tip

    If you do not see the navigation pane on the left side of your screen, choose the menu icon () in the upper-left corner of the page.

  3. In the Parameter groups pane, choose Create.

  4. In the Create parameter group pane, do the following:

    1. Group name—Enter a name for the cluster parameter group.

      Parameter Group Naming Constraints:
      • Length is [1–255] alphanumeric characters.

      • First character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

    2. Description—Provide a description for this cluster parameter group.

    3. To create the cluster parameter group, choose Create. To cancel the operation, choose Cancel.

Using the AWS CLI

To create a new cluster parameter group, use the AWS CLI operation create-db-cluster-parameter-group with the following parameters.

  • --db-cluster-parameter-group-name—The name of the custom cluster parameter group.

  • --db-cluster-parameter-group-family—The cluster parameter group family that is used as the template for the custom cluster parameter group. Currently, this must be docdb3.6.

  • --description—The user-provided description for this cluster parameter group.

For Linux, macOS, or Unix:

aws docdb create-db-cluster-parameter-group \ --db-cluster-parameter-group-name custom3-6-param-grp \ --db-parameter-group-family docdb3.6 \ --description "Custom docdb3.6 parameter group"

For Windows:

aws docdb create-db-cluster-parameter-group \ --db-cluster-parameter-group-name custom3-6-param-grp \ --db-parameter-group-family docdb3.6 \ --description "Custom docdb3.6 parameter group"

Output from this operation looks something like the following (JSON format).

{ "DBClusterParameterGroup": { "DBClusterParameterGroupName": "custom3-6-param-grp", "DBParameterGroupFamily": "docdb3.6", "Description": "Custom docdb3.6 parameter group", "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:12345678901:cluster-pg:custom3-6-param-grp" } }