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.
Represents the input of a TestFailover operation which test automatic failover
on a specified node group (called shard in the console) in a replication group (called
cluster in the console).
This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.
Note the following
A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period.
If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.
To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:
Replication group message: Test Failover API called for node group
Cache cluster message: Failover from primary node
Replication group message: Failover from primary node
Cache cluster message: Recovering cache nodes
Cache cluster message: Finished recovery for cache nodes
For more information see:
Viewing ElastiCache Events in the ElastiCache User Guide
DescribeEvents in the ElastiCache API Reference
Also see, Testing Multi-AZ in the ElastiCache User Guide.
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 BeginTestFailover and EndTestFailover.
Namespace: Amazon.ElastiCache
Assembly: AWSSDK.ElastiCache.dll
Version: 3.x.y.z
public abstract Task<TestFailoverResponse> TestFailoverAsync( TestFailoverRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the TestFailover service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| APICallRateForCustomerExceededException | The customer has exceeded the allowed rate of API calls. |
| InvalidCacheClusterStateException | The requested cluster is not in the available state. |
| InvalidKMSKeyException | The KMS key supplied is not valid. |
| InvalidParameterCombinationException | Two or more incompatible parameters were specified. |
| InvalidParameterValueException | The value for a parameter is invalid. |
| InvalidReplicationGroupStateException | The requested replication group is not in the available state. |
| NodeGroupNotFoundException | The node group specified by the NodeGroupId parameter could not be found. Please verify that the node group exists and that you spelled the NodeGroupId value correctly. |
| ReplicationGroupNotFoundException | The specified replication group does not exist. |
| TestFailoverNotAvailableException | The TestFailover action is not available. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5