Monitoring an Amazon DocumentDB Instance’s Status

The status of an instance indicates the health of the instance. You can view the status of an instance in Amazon DocumentDB (with MongoDB compatibility) by using the AWS Management Console or the AWS CLI operation describe-db-instances.

Note

Amazon DocumentDB also uses another status called maintenance status, which is shown in the Maintenance column of the Amazon DocumentDB console. This value indicates the status of any maintenance patches that need to be applied to an instance. Maintenance status is independent of the Amazon DocumentDB instance status. For more information about maintenance status, see Applying Amazon DocumentDB Updates.

Instance Status Values

The following table lists the possible status values for instances and how you are billed for each status. It shows if you will be billed for the instance and storage, only storage, or not billed. For all instance statuses, you are always billed for backup usage.

Monitoring an Instance’s Status Using the AWS Management Console

When using the AWS CLI to determine the status of a cluster, use the following procedure.

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 Clusters.
3. Note that in the Clusters navigation box, the column Cluster Identifier shows both clusters and instances. Instances are listed underneath clusters, similar to the screenshot below.

4. Find the name of the instance that you are interested in. Then, to find the status of the instance, read across that row to the Status column, as shown following.

Monitoring an Instance’s Status Using the AWS CLI

When using the AWS CLI to determine the status of a cluster, use the describe-db-instances operation. The following code finds the status of the instance sample-cluster-instance-01.

For Linux, macOS, or Unix:

1. aws docdb describe-db-instances \
2. --db-instance-identifier sample-cluster-instance-01  \
3. --query 'DBInstances[*].[DBInstanceIdentifier,DBInstanceStatus]'

For Windows:

1. aws docdb describe-db-instances ^
2. --db-instance-identifier sample-cluster-instance-01  ^
3. --query 'DBInstances[*].[DBInstanceIdentifier,DBInstanceStatus]'

Output from this operation looks something like the following.

1. [
2. [
3. "sample-cluster-instance-01",
4. "available"
5. ]
6. ]