Managing an Amazon Neptune global database - Amazon Neptune
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).

Managing an Amazon Neptune global database

With the exception of the managed planned failover process, you perform most management operations on the individual clusters that make up a Neptune global database. The managed planned failover process is available only to Neptune global databases, not to individual Neptune DB clusters. To learn more, see Performing managed planned failovers for Neptune global databases.

To recover a Neptune global database from an unplanned outage in its primary region, see Detach-and-promote a Neptune global database in the case of an unplanned outage.

Although you can configure the DB cluster parameter groups independently for each Neptune cluster in a global database, it is best to keep settings consistent among all the clusters to avoid unexpected behavior changes if a secondary cluster is promoted to be the primary. For example, use the same settings for object indexes, streams, and so forth in all the DB clusters.

Removing a DB cluster from a Neptune global database

There are several reasons you might want to remove a DB cluster from a global database. For example:

You can use the remove-from-global-cluster CLI command (which wraps the RemoveFromGlobalCluster API) to detach a Neptune DB cluster from a global database:

aws neptune remove-from-global-cluster \ --region (region of the cluster to remove) \ --global-cluster-identifier (global database ID) \ --db-cluster-identifier (ARN of the cluster to remove)

The detached DB cluster then becomes a standalone DB cluster.

Deleting a Neptune global database

You can't delete a global database and its associated clusters in a single step. Instead, you have to delete its components one by one:

  1. Detach all secondary DB clusters from the global database, as described in Removing a cluster. If you want to, you can now delete them individually.

  2. Detach the primary DB cluster from the global database.

  3. Delete all read-replica DB instances from the primary cluster.

  4. Delete the primary (writer) DB instance from the primary cluster. If you do this on the console, it deletes the DB cluster as well.

  5. Delete the global database itself. To do this using the Amazon CLI, use the delete-global-cluster CLI command (which wraps the DeleteGlobalCluster API), as follows:

    aws neptune delete-global-cluster \ --region (region of the DB cluster to delete) \ --global-cluster-identifier (global database ID)

Modifying a Neptune global database

The DB cluster parameter groups can be configured independently for each Neptune DB cluster in a global database, but it's best to keep settings consistent across the clusters to avoid unexpected behavior changes if a secondary cluster has to be promoted to primary.

You can modify the settings of the global database itself using the modify-global-cluster CLI command (which wraps the ModifyGlobalCluster API). For example, you could change the global database identifier and at the same time turn off deletion protection like this:

aws neptune modify-global-cluster \ --region (region of the DB cluster to modify) \ --global-cluster-identifier (current global database ID) \ --new-global-cluster-identifier (new global database ID to assign) \ --deletion-protection false