Restoring from a Cluster Snapshot

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

In the navigation pane, choose Snapshots, and then choose the button to the left of the snapshot that you want to use to restore a cluster.

On the Actions menu, choose Restore.

On the Restore snapshot page, complete the Configuration section.

1. Cluster identifier — The name for the new cluster. You can accept the Amazon DocumentDB supplied name or type a name that you prefer. The Amazon DocumentDBsupplied name is in the format of docdb- plus a UTC timestamp; for example, docdb-yyyy-mm-dd-hh-mm-ss.

2. Instance class — The instance class for the new cluster. You can accept the default instance class or choose an instance class from the drop-down list.

3. Number of instances — The number of instances you want created with this cluster. You can accept the default of 3 instances (1 primary read/write and 2 read-only replicas) or choose the number of instances from the drop-down list.

For Cluster storage configuration, choose a storage option.

If you are satisfied with the cluster configuration, choose Restore cluster and wait while your cluster is restored.

If you prefer to change some configurations, such as specifying a non-default Amazon VPC or security group, choose Show advanced settings from the bottom left of the page, and then continue with the following steps.

1. Complete the Network settings section.

   • Virtual Private Cloud (VPC) — Accept the current VPC, or choose a VPC from the drop-down list.

   • Subnet Group — Accept the default subnet group, or choose one from the drop-down list.

   • VPC Security Groups — Accept the default (VPC) security group, or choose one from the list.

2. Complete the Cluster options section.

   • Database port — Accept the default port, 27017, or use the up or down arrow to set the port that you want to use for application connections.

3. Complete the Encryption section.

   • Encryption at rest — If your snapshot is encrypted, these options are not available to you. If it is not encrypted, you can choose one of the following:

     • To encrypt all your cluster's data, choose Enable encryption-at-rest. If you choose this option, you must designate a Master key.

     • To not encrypt your cluster's data, choose Disable encryption-at-rest. If you choose this option, you are finished with the encryption section.

   • Master key — Choose one of the following from the drop-down list:

     • (default) aws/rds — The account number and Amazon KMS key ID are listed following this option.

     • Customer-managed key — This option is available only if you created an IAM encryption key in the Amazon Identity and Access Management (IAM) console. You can choose the key to encrypt your cluster.

     • Enter a key ARN — In the ARN box, enter the Amazon Resource Name (ARN) for your Amazon KMS key. The format of the ARN is arn:aws:kms:<region>:<accountID>:key/<key-id>.

4. Complete the Log exports section.

   • Select the log types to publish to CloudWatch — Choose one of the following:

     • Enabled — Enables your cluster to export DDL logging to Amazon CloudWatch Logs.

     • Disabled — Prevents your cluster from exporting DDL logs to Amazon CloudWatch Logs. Disabled is the default.

   • IAM role—From the list, choose RDS Service Linked Role.

5. Complete the Tags section.

   • Add Tag — In the Key box, enter the name for the tag for your cluster. In the Value box, optionally enter the tag value. Tags are used with Amazon Identity and Access Management (IAM) policies to manage access to Amazon DocumentDB resources and to control what actions can be applied to the resources.

6. Complete the Deletion protection section.

   • Enable deletion protection — Protects the cluster from being accidentally deleted. While this option is enabled, you can't delete the cluster.

Choose Restore cluster.