AWS SDK Version 3 for .NET
API Reference

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 Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

Amazon Aurora will automatically fail over to an Aurora 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 more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Note:

For PCL this operation is only available in asynchronous form. Please refer to FailoverDBClusterAsync.

Namespace: Amazon.RDS
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z

Syntax

C#
public virtual FailoverDBClusterResponse FailoverDBCluster(
         FailoverDBClusterRequest request
)
Parameters
request
Type: Amazon.RDS.Model.FailoverDBClusterRequest

Container for the necessary parameters to execute the FailoverDBCluster service method.

Return Value
The response from the FailoverDBCluster service method, as returned by RDS.

Exceptions

ExceptionCondition
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.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also