AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
For .NET Core this operation is only available in asynchronous form. Please refer to FailoverDBClusterAsync.
Namespace: Amazon.Neptune
Assembly: AWSSDK.Neptune.dll
Version: 3.x.y.z
public abstract FailoverDBClusterResponse FailoverDBCluster( FailoverDBClusterRequest request )
Container for the necessary parameters to execute the FailoverDBCluster service method.
| Exception | Condition |
|---|---|
| DBClusterNotFoundException | DBClusterIdentifier does not refer to an existing DB cluster. |
| InvalidDBClusterStateException | The DB cluster is not in a valid state. |
| InvalidDBInstanceStateException | The specified DB instance is not in the available state. |
This example performs a failover for the specified DB cluster to the specified DB instance.
var response = client.FailoverDBCluster(new FailoverDBClusterRequest
{
DBClusterIdentifier = "myaurorainstance-cluster",
TargetDBInstanceIdentifier = "myaurorareplica"
});
DBCluster dbCluster = response.DBCluster;
.NET Framework:
Supported in: 4.5 and newer, 3.5