Restoring a Neptune cluster - Amazon Backup
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Restoring a Neptune cluster

Use the Amazon Backup console to restore Amazon Neptune recovery points

Restoring an Amazon Neptune database requires that you specify multiple restore options. For information about these options, see Restoring from a DB Cluster Snapshot in the Neptune User Guide.

To restore an Neptune database
  1. Open the Amazon Backup console at

  2. In the navigation pane, choose Protected resources and the Neptune resource ID that you want to restore.

  3. On the Resource details page, a list of recovery points for the selected resource ID is shown. To restore a resource, in the Backups pane, choose the radio button next to the recovery point ID of the resource. In the upper-right corner of the pane, choose Restore.

  4. In the Instance specifications pane, accept the defaults or specify the DB engine and Version.

  5. In the Settings pane, specify a name that is unique for all DB cluster instances owned by your Amazon Web Services account in the current Region. The DB cluster identifier is case insensitive, but it is stored as all lowercase, as in "mydbclusterinstance". This is a required field.

  6. In the Database options pane, accept the defaults or specify the options for Database port and DB cluster parameter group.

  7. In the Encryption pane, accept the default or specify the options for the Enable encryption or Disable encryption settings.

  8. In the Log exports pane, choose the log types to publish to Amazon CloudWatch Logs. The IAM role is already defined.

  9. In the Restore role pane, choose the IAM role that Amazon Backup will assume for this restore.

  10. After specifying all your settings, choose Restore backup.

    The Restore jobs pane appears. A message at the top of the page provides information about the restore job.

  11. After your restore finishes, attach your restored Neptune cluster to an Amazon RDS instance.

Use the Amazon Backup API, CLI, or SDK to restore Neptune recovery points

First, restore your cluster. Use StartRestoreJob. You can specify the following metadata during Amazon DocumentDB restores:

availabilityZones backtrackWindow copyTagsToSnapshot // Boolean databaseName // string dbClusterIdentifier // string dbClusterParameterGroupName // string dbSubnetGroupName // string enableCloudwatchLogsExports // string enableIAMDatabaseAuthentication // Boolean engine // string engineMode // string engineVersion // string kmsKeyId // string port // integer optionGroupName // string ScalingConfiguration pcSecurityGroupIds // string

Then, attached your restored Neptune cluster to an Amazon RDS instance using create-db-instance.

  • For Linux, macOS, or Unix:

    aws neptune create-db-instance --db-instance-identifier sample-instance \ --db-instance-class db.r5.large --engine neptune --engine-version --db-cluster-identifier sample-cluster --region us-east-1
  • For Windows:

    aws neptune create-db-instance --db-instance-identifier sample-instance ^ --db-instance-class db.r5.large --engine neptune --engine-version --db-cluster-identifier sample-cluster --region us-east-1

For more information, see RestoreDBClusterFromSnapshot in the Neptune Management API reference and restore-db-cluster-from-snapshot in the Neptune CLI guide.