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.

Viewing Amazon DocumentDB Cluster Parameter Groups

You can see the details of a single Amazon DocumentDB cluster parameter group or all cluster parameter groups using the AWS Management Console or the AWS CLI.

Using the AWS Management Console

Follow these steps on the console to view details of a cluster parameter group.

To view the details of 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 the name of the parameter group that you want to see the details of.

  4. Under Parameters, each line shows the parameter's name, current value, allowed values, whether the parameter is modifiable, source, data type, and description.

    Under Tags, you can see the tags that are on this cluster parameter group.

Using the AWS CLI

To see a listing of your cluster parameter groups and their details, use the describe-db-cluster-parameter-groups operation with the following parameters.

  • --db-cluster-parameter-group-name—Optional. The name of the cluster parameter group that you want described. If this parameter is omitted, all cluster parameter groups are described.

The following code lists up to 100 cluster parameter groups and their details.

aws docdb describe-db-cluster-parameter-groups

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

{ "DBClusterParameterGroups": [ { "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:012345678912:cluster-pg:default.docdb3.6", "DBParameterGroupFamily": "docdb3.6", "Description": "Default cluster parameter group for docdb3.6", "DBClusterParameterGroupName": "default.docdb3.6" }, { "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:012345678912:cluster-pg:sample-parameter-group", "DBParameterGroupFamily": "docdb3.6", "Description": "Custom docdb3.6 parameter group", "DBClusterParameterGroupName": "sample-parameter-group" } ] }

The following code lists the details for the cluster parameter group sample-parameter-group.

For Linux, macOS, or Unix:

aws docdb describe-db-cluster-parameter-groups \ --db-cluster-parameter-group-name sample-parameter-group

For Windows:

aws docdb describe-db-cluster-parameter-groups ^ --db-cluster-parameter-group-name sample-parameter-group

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

{ "DBClusterParameterGroups": [ { "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:sample-parameter-group", "Description": "Custom docdb3.6 parameter group", "DBParameterGroupFamily": "docdb3.6", "DBClusterParameterGroupName": "sample-parameter-group" } ] }