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 Parameters

You can see an Amazon DocumentDB cluster's parameters and their values using the AWS Management Console or AWS CLI.

Using the AWS Management Console

Follow these steps on the console to view a cluster parameter group's parameters and their values.

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 cluster 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.

    
                     Screenshot: Parameter names and values.

Using the AWS CLI

To see a cluster's parameter group's parameters and their values, use the describe-db-cluster-parameters operation with the following parameters.

  • --db-cluster-parameter-group-name—Required. The name of the cluster parameter group for which you want a detailed parameter list.

  • --source—Optional. If supplied, returns only parameters for a specific source. Parameter sources can be engine-default, system, or user.

The following code lists the parameters and their values for the custom3-6-param-grp parameter group. For more detailed information on the parameter group, omit the --query line. For information on all parameter groups, omit the --db-cluster-parameter-group-name line.

For Linux, macOS, or Unix:

aws docdb describe-db-cluster-parameters \ --db-cluster-parameter-group-name custom3-6-param-grp \ --query 'Parameters[*].[ParameterName,ParameterValue]'

For Windows:

aws docdb describe-db-cluster-parameters ^ --db-cluster-parameter-group-name custom3-6-param-grp ^ --query 'Parameters[*].[ParameterName,ParameterValue]'

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

[ [ "audit_logs", "disabled" ], [ "tls", "enabled" ], [ "ttl_monitor", "enabled" ] ]