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.

Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.

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 BeginFailoverGlobalReplicationGroup and EndFailoverGlobalReplicationGroup.

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

Syntax

C#
public abstract Task<FailoverGlobalReplicationGroupResponse> FailoverGlobalReplicationGroupAsync(
         FailoverGlobalReplicationGroupRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ElastiCache.Model.FailoverGlobalReplicationGroupRequest

Container for the necessary parameters to execute the FailoverGlobalReplicationGroup 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 FailoverGlobalReplicationGroup service method, as returned by ElastiCache.

Exceptions

ExceptionCondition
GlobalReplicationGroupNotFoundException The Global datastore does not exist
InvalidGlobalReplicationGroupStateException The Global datastore is not available or in primary-only state.
InvalidParameterCombinationException Two or more incompatible parameters were specified.
InvalidParameterValueException The value for a parameter is invalid.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also