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.

Initiates the failover process for a Neptune global database.

A failover for a Neptune global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected target secondary DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Neptune global database.

This action applies only to Neptune global databases. This action is only intended for use on healthy Neptune global databases with healthy Neptune DB clusters and no region-wide outages, to test disaster recovery scenarios or to reconfigure the global database topology.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginFailoverGlobalCluster and EndFailoverGlobalCluster.

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

Syntax

C#
public abstract Task<FailoverGlobalClusterResponse> FailoverGlobalClusterAsync(
         FailoverGlobalClusterRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Neptune.Model.FailoverGlobalClusterRequest

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

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the FailoverGlobalCluster service method, as returned by Neptune.

Exceptions

ExceptionCondition
DBClusterNotFoundException DBClusterIdentifier does not refer to an existing DB cluster.
GlobalClusterNotFoundException The GlobalClusterIdentifier doesn't refer to an existing global database cluster.
InvalidDBClusterStateException The DB cluster is not in a valid state.
InvalidGlobalClusterStateException The global cluster is in an invalid state and can't perform the requested operation.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also