AWS SDK Version 2 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.

.NET Framework 3.5
 
Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance.

Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB 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.

Namespace: Amazon.RDS
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public abstract FailoverDBClusterResponse FailoverDBCluster(
         FailoverDBClusterRequest request
)

Parameters

request
Type: Amazon.RDS.Model.FailoverDBClusterRequest

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

Return Value
Type: Amazon.RDS.Model.FailoverDBClusterResponse
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 supplied value is not a valid DB cluster state.

Version Information

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