FailoverDBCluster
Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).
Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- DBClusterIdentifier
-
A DB cluster identifier to force a failover for. This parameter is not case-sensitive.
Constraints:
-
Must match the identifier of an existing DBCluster.
Type: String
Required: No
-
- TargetDBInstanceIdentifier
-
The name of the instance to promote to the primary instance.
You must specify the instance identifier for an Read Replica in the DB cluster. For example,
mydbcluster-replica1.Type: String
Required: No
Response Elements
The following element is returned by the service.
- DBCluster
-
Contains the details of an Amazon Neptune DB cluster.
This data type is used as a response element in the DescribeDBClusters.
Type: DBCluster object
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBClusterNotFoundFault
-
DBClusterIdentifier does not refer to an existing DB cluster.
HTTP Status Code: 404
- InvalidDBClusterStateFault
-
The DB cluster is not in a valid state.
HTTP Status Code: 400
- InvalidDBInstanceState
-
The specified DB instance is not in the available state.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
