Determining a cluster's status - Amazon DocumentDB
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Determining a cluster's status

You can determine a cluster's status using the Amazon Web Services Management Console or Amazon CLI.

Using the Amazon Web Services Management Console

Use the following procedure to see the status of your Amazon DocumentDB cluster using the Amazon Web Services Management Console

  1. Sign in to the Amazon Web Services Management Console, and open the Amazon DocumentDB console at https://console.amazonaws.cn/docdb.

  2. In the navigation pane, choose Clusters.

  3. In the Cluster identifier column, find the name of the cluster that you are interested in. Then, to find the status of the cluster, read across that row to the Status column, as shown below.

    Screenshot of clusters page with sample-cluster showing active status.
Using the Amazon CLI

Use the describe-db-clusters operation to see the the status of your Amazon DocumentDB cluster using the Amazon CLI.

The following code finds the status of the cluster sample-cluster.

For Linux, macOS, or Unix:

aws docdb describe-db-clusters \
    --db-cluster-identifier sample-cluster  \
    --query 'DBClusters[*].[DBClusterIdentifier,Status]'

For Windows:

aws docdb describe-db-clusters ^
    --db-cluster-identifier sample-cluster  ^
    --query 'DBClusters[*].[DBClusterIdentifier,Status]'

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

[
    [
        "sample-cluster",
        "available"
    ]
]