Amazon DocumentDB Operational Tasks Overview

This section covers operational tasks for your Amazon DocumentDB (with MongoDB compatibility) cluster, and how to accomplish these tasks using the AWS CLI.

Adding a Replica to an Amazon DocumentDB Cluster

After you create the primary instance for your Amazon DocumentDB cluster, you can add one or more replicas. A replica is a read-only instance that serves two purposes:

  • Scalability — If you have a large number of clients that require concurrent access, you can add more replicas for read-scaling.

  • High availability — If the primary instance fails, Amazon DocumentDB automatically fails over to a replica instance and designates it as the new primary. If a replica fails, other instances in the cluster can still serve requests until the failed node can be recovered.

Each Amazon DocumentDB cluster can support up to 15 replicas.

Note

For maximum fault tolerance, you should deploy replicas in separate Availability Zones. This helps ensure that your Amazon DocumentDB cluster can continue to function, even if an entire Availability Zone becomes unavailable.

The following AWS CLI example shows how to add a new replica. The --availability-zone parameter places the replica in the specified Availability Zone.

  1. aws docdb create-db-instance \
  2.     --db-instance-identifier sample-instance \
  3.     --db-cluster-identifier sample-cluster \
  4.     --engine docdb \
  5.     --db-instance-class db.r5.large \
  6.     --availability-zone us-east-1a

Describing Clusters and Instances

The following AWS CLI example lists all Amazon DocumentDB clusters in a Region. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS. The filterName=engine,Values=docdb filter parameter returns only Amazon DocumentDB clusters.

For more information on describing and modifying clusters, see the .

  1. aws docdb describe-db-clusters --filter Name=engine,Values=docdb

Output from this operation looks something like the following.

  1. {
  2.     "DBClusters": [
  3.         {
  4.             "AvailabilityZones": [
  5.                 "us-east-1c",
  6.                 "us-east-1b",
  7.                 "us-east-1a"
  8.             ],
  9.             "BackupRetentionPeriod": 1,
  10.             "DBClusterIdentifier": "sample-cluster-1",
  11.             "DBClusterParameterGroup": "sample-parameter-group",
  12.             "DBSubnetGroup": "default",
  13.             "Status": "available",
  14.             ...
  15.         },
  16.         {
  17.             "AvailabilityZones": [
  18.                 "us-east-1c",
  19.                 "us-east-1b",
  20.                 "us-east-1a"
  21.             ],
  22.             "BackupRetentionPeriod": 1,
  23.             "DBClusterIdentifier": "sample-cluster-2",
  24.             "DBClusterParameterGroup": "sample-parameter-group",
  25.             "DBSubnetGroup": "default",
  26.             "Status": "available",
  27.             ...
  28.         },
  29.         {
  30.             "AvailabilityZones": [
  31.                 "us-east-1c",
  32.                 "us-east-1b",
  33.                 "us-east-1a"
  34.             ],
  35.             "BackupRetentionPeriod": 1,
  36.             "DBClusterIdentifier": "sample-cluster-3",
  37.             "DBClusterParameterGroup": "sample-parameter-group",
  38.             "DBSubnetGroup": "default",
  39.             "Status": "available",
  40.             ...
  41.         }
  42.     ]
  43. }

The following AWS CLI example lists the instances in an Amazon DocumentDB cluster. For more information on describing and modifying clusters, see the .

  1. aws docdb describe-db-clusters \
  2.     --db-cluster-identifier sample-cluster \
  3.     --query 'DBClusters[*].[DBClusterMembers]'

The output looks like something like below. In this output, there are two instances. The primary instance is sample-instance-1 ("IsClusterWriter": true). There is also a replica instance, sample-instance2 ("IsClusterWriter: false").

  1. [
  2.     [
  3.         [
  4.             {
  5.                 "DBInstanceIdentifier": "sample-instance-1",
  6.                 "IsClusterWriter": true,
  7.                 "DBClusterParameterGroupStatus": "in-sync",
  8.                 "PromotionTier": 1
  9.             },
  10.             {
  11.                 "DBInstanceIdentifier": "sample-cluster-2",
  12.                 "IsClusterWriter": false,
  13.                 "DBClusterParameterGroupStatus": "in-sync",
  14.                 "PromotionTier": 1
  15.             }
  16.         ]
  17.     ]
  18. ]

Creating a Cluster Snapshot

A cluster snapshot is a complete backup of the data in your Amazon DocumentDB cluster. When the snapshot is being created, Amazon DocumentDB reads your data directly from the cluster volume. Because of this, you can create a snapshot even if your cluster doesn’t have any instances running at the time. The amount of time it takes to create a snapshot depends on the size of your cluster volume.

Amazon DocumentDB supports automatic backups, which occur daily during the preferred backup window — a 30-minute period of time during the day. The following AWS CLI example shows how to view the backup window for your cluster:

  1. aws docdb describe-db-clusters \
  2.     --db-cluster-identifier sample-cluster \
  3.     --query 'DBClusters[*].PreferredBackupWindow'

The output shows the backup window (in UTC):

  1. [
  2.     "00:18-00:48"
  3. ]

You can define the backup window when you create your Amazon DocumentDB cluster. You can also change the backup window, as shown in the following example. If you don’t define a backup window, Amazon DocumentDB automatically assigns one to your cluster.

  1. aws docdb modify-db-cluster \
  2.     --db-cluster-identifier sample-cluster \
  3.     --preferred-backup-window "02:00-02:30"

In addition to automatic backups, you can manually create a cluster snapshot at any time. When you do this, you specify which cluster you want to back up, and a unique name for your snapshot so that you can restore from it later.

The following AWS CLI example shows how to create a snapshot of your data.

  1. aws docdb create-db-cluster-snapshot \
  2.     --db-cluster-identifier sample-cluster \
  3.     --db-cluster-snapshot-identifier sample-cluster-snapshot

Restoring from a Snapshot

You can restore a cluster snapshot to a new Amazon DocumentDB cluster. To do this, you provide the name of the snapshot and the name of a new cluster. You can’t restore from a snapshot to an existing cluster; instead, Amazon DocumentDB creates a new cluster when you restore and then populates it with your snapshot data.

The following example shows all the snapshots for the cluster sample-cluster.

  1. aws docdb describe-db-cluster-snapshots \
  2.     --db-cluster-identifier sample-cluster \
  3.     --query 'DBClusterSnapshots[*].[DBClusterSnapshotIdentifier,SnapshotType,Status]'

The output looks something like the following. A manual snapshot is one that you created manually, whereas an automated snapshot is created by Amazon DocumentDB within the cluster backup window.

  1. [
  2.         "sample-cluster-snapshot", 
  3.         "manual", 
  4.         "available"
  5.     ], 
  6.     [
  7.         "rds:sample-cluster", 
  8.         "automated", 
  9.         "available"
  10.     ]
  11. ]

The following example shows how to restore an Amazon DocumentDB cluster from a snapshot.

  1. aws docdb restore-db-cluster-from-snapshot \
  2.     --engine docdb \
  3.     --db-cluster-identifier new-sample-cluster \
  4.     --snapshot-identifier sample-cluster-snapshot

The new cluster does not have any instances associated with it; so if you want to interact with the cluster, you must add an instance to it.

  1. aws docdb create-db-instance \
  2.     --db-instance-identifier new-sample-instance \
  3.     --db-instance-class db.r5.large \
  4.     --engine docdb \
  5.     --db-cluster-identifier new-sample-cluster

You can use the following AWS CLI operations to monitor the progress of cluster and instance creation. When the cluster and instance statuses are available, you can connect to the new cluster’s endpoint and access your data.

  1. aws docdb describe-db-clusters \
  2.     --db-cluster-identifier new-sample-cluster  \
  3.     --query 'DBClusters[*].[Status,Endpoint]'
  1. aws docdb describe-db-instances \
  2.     --db-instance-identifier new-sample-instance \
  3.     --query 'DBInstances[*].[DBInstanceStatus]'

Removing an Instance from a Cluster

Amazon DocumentDB stores all of your data in the cluster volume. The data persists in that cluster volume, even if you remove all the instances from your cluster. If you need to access the data again, you can add an instance to the cluster at any time, and pick up where you left off.

The following example shows how to remove an instance from your Amazon DocumentDB cluster.

  1. aws docdb delete-db-instance \
  2.     --db-instance-identifier sample-instance

Deleting a Cluster

Before you can delete an Amazon DocumentDB cluster, you must first remove all of its instances. The following AWS CLI example returns information about the instances in a cluster. If this operation returns any instance identifiers, you have to delete each of the instances. For more information, see Removing an Instance from a Cluster.

  1. aws docdb describe-db-clusters \
  2.     --db-cluster-identifier sample-cluster \
  3.     --query 'DBClusters[*].DBClusterMembers[*].DBInstanceIdentifier'

When there are no more instances remaining, you can delete the cluster. At that time, you must choose one of the following options:

  • Create a final snapshot — Capture all the cluster data in a snapshot so that you can re-create a new instance with that data later. The following example shows how to do this:

    1. aws docdb delete-db-cluster \
    2.     --db-cluster-identifier sample-cluster \
    3.     --final-db-snapshot-identifier sample-cluster-snapshot

  • Skip the final snapshot — Permanently discard all the cluster data. This cannot be reversed. The following example shows how to do this:

    1. aws docdb delete-db-cluster \
    2.     --db-cluster-identifier sample-cluster \
    3.     --skip-final-snapshot