Creating Amazon DocumentDB Cluster Parameter Groups - Amazon DocumentDB

Creating Amazon DocumentDB Cluster Parameter Groups

Amazon DocumentDB provides a default cluster parameter group based on the docdb3.6 family named default.docdb3.6. You cannot modify the default.docdb3.6 cluster parameter group directly. To customize the parameters within a cluster parameter group and associate it to your Amazon DocumentDB cluster, you must first create a new, non-default cluster parameter group. Then you can modify the parameters within that new, custom parameter group and associate it to your Amazon DocumentDB cluster.

The following procedure guides you through creating a custom cluster parameter group based on the docdb3.6 family. You can then modify the parameters within that parameter group.

Note

After you create a cluster parameter group, you should wait at least 5 minutes before using that particular 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 AWS Management Console or the describe-db-cluster-parameter-groups AWS CLI operation to verify that your cluster parameter group has been created. For more information, see Describing Amazon DocumentDB Cluster Parameter Groups.

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 don't 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 Cluster parameter groups pane, choose Create.

  4. In the Create cluster parameter group pane, enter the following:

    1. Group name — Enter a name for the cluster parameter group. For example, sample-parameter-group. Cluster parameter groups have the following 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.

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

  6. After you choose Create, the following text appears at the top of the page to verify that your cluster parameter group has been successfully created:

    Successfully created cluster parameter group 'sample-parameter-group'.

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

  • --db-cluster-parameter-group-name — The name of the custom cluster parameter group. For example, sample-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. The following example uses "Custom docdb3.6 parameter group".

For Linux, macOS, or Unix:

aws docdb create-db-cluster-parameter-group \ --db-cluster-parameter-group-name sample-parameter-group \ --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 sample-parameter-group ^ --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": "sample-parameter-group", "DBParameterGroupFamily": "docdb3.6", "Description": "Custom docdb3.6 parameter group", "DBClusterParameterGroupArn": "sample-parameter-group-arn" } }