Monitoring an Amazon DocumentDB Instance’s Status

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.

Valid Values for an Instance’s Status
Instance status	Billed	Description
`available`	Billed	The instance is healthy and available.
`backing-up`	Billed	The instance is currently being backed up.
`configuring-log-exports`	Billed	Publishing log files to Amazon CloudWatch Logs is being enabled or disabled for this instance.
`creating`	Not billed	The instance is being created. The instance is not accessible while it is being created.
`deleting`	Not billed	The instance is being deleted.
`failed`	Not billed	The instance has failed and Amazon DocumentDB was unable to recover it. To recover the data, perform a point-in-time restore to the latest restorable time of the instance.
`inaccessible-encryption-credentials`	Not billed	The AWS KMS key that is used to encrypt or decrypt the instance could not be accessed.
`incompatible-network`	Not billed	Amazon DocumentDB is attempting to perform a recovery action on an instance but is unable to do so because the VPC is in a state that is preventing the action from being completed. This status can occur if, for example, all available IP addresses in a subnet were in use and Amazon DocumentDB was unable to get an IP address for the instance.
`maintenance`	Billed	Amazon DocumentDB is applying a maintenance update to the instance. This status is used for instance-level maintenance that Amazon DocumentDB schedules well in advance. We’re evaluating ways to expose additional maintenance actions to customers through this status.
`modifying`	Billed	The instance is being modified because of a request to modify the instance.
`rebooting`	Billed	The instance is being rebooted because of a request or an Amazon DocumentDB process that requires the rebooting of the instance.
`renaming`	Billed	The instance is being renamed because of a request to rename it.
`resetting-master-credentials`	Billed	The master credentials for the instance are being reset because of a request to reset them.
`restore-error`	Billed	The instance encountered an error attempting to restore to a point-in-time or from a snapshot.
`starting`	Billed for storage	The instance is starting.
`stopped`	Billed for storage	The instance is stopped.
`stopping`	Billed for storage	The instance is being stopped.
`storage-full`	Billed	The instance has reached its storage capacity allocation. This is a critical status and should be remedied immediately; scale up your storage by modifying the instance. Set Amazon CloudWatch alarms to warn you when storage space is getting low so you don’t run into this situation.

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.

Sign in to the AWS Management Console, and open the Amazon DocumentDB console at https://console.aws.amazon.com/docdb.
In the navigation pane, choose Clusters.
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.
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:

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

For Windows:

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

Output from this operation looks something like the following.

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