Describing Amazon DocumentDB Instances

    To view the details of your instances using the AWS Management Console, follow the steps below.

    1. Sign in to the AWS Management Console, and open the Amazon DocumentDB console at https://console.aws.amazon.com/docdb.

    2. In the Clusters navigation box, you’ll see the column Cluster Identifier. Your instances are listed under clusters, similar to the screenshot below.

    3. In the list of instances, choose the name of the instance that you want to see its details. The information about the instance is organized into the following groupings:

      • Configuration—The Details section lists the configurations and status of the instance, including the instance’s Amazon Resource Name (ARN), endpoint, role, class, and certificate authority. It also lists the instance’s security and network settings, and backup information. The Cluster details section lists the details of the cluster that this instance belongs to. The Cluster instances section lists all the instances that belong to your cluster with each instance’s role and cluster parameter group status.

        Note

        You can modify the cluster associated with your instance by selecting Modify next to the Cluster details header. For more information, see .

      • Monitoring—The CloudWatch Logs metrics for this instance. For more information, see Monitoring Amazon DocumentDB with CloudWatch.

      • Events & tags —The Recent events section lists the recent events for this instance. Amazon DocumentDB keeps a record of events that relate to your clusters, instances, snapshots, security groups, and cluster parameter groups. This information includes the date, time, and message associated with each event. The section lists the tags attached to this cluster. For more information, see .

    Using the AWS CLI

    To view the details of your Amazon DocumentDB instances using the AWS CLI, use the command as shown in the examples below. For more information, see in the Amazon DocumentDB Resource Management API Reference.

    Note

    1. List all details for a specified Amazon DocumentDB instance

      The following code lists the details for . Including the parameter with the name of an instance restricts the output to information on that particular instance.

      For Linux, macOS, or Unix:

      For Windows: