testFailover method

Future<TestFailoverResult> testFailover({ required String nodeGroupId, required String replicationGroupId, })

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

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 AWS 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 AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:
  1. Replication group message: Test Failover API called for node group <node-group-id>
  2. Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed
  3. Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed
  4. Cache cluster message: Recovering cache nodes <node-id>
  5. Cache cluster message: Finished recovery for cache nodes <node-id>
  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.

May throw APICallRateForCustomerExceededFault. May throw InvalidCacheClusterStateFault. May throw InvalidReplicationGroupStateFault. May throw NodeGroupNotFoundFault. May throw ReplicationGroupNotFoundFault. May throw TestFailoverNotAvailableFault. May throw InvalidKMSKeyFault. May throw InvalidParameterValueException. May throw InvalidParameterCombinationException.

Parameter nodeGroupId : The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 5 node groups in any rolling 24-hour period.

Parameter replicationGroupId : The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.

Implementation

Future<TestFailoverResult> testFailover({
  required String nodeGroupId,
  required String replicationGroupId,
}) async {
  ArgumentError.checkNotNull(nodeGroupId, 'nodeGroupId');
  _s.validateStringLength(
    'nodeGroupId',
    nodeGroupId,
    1,
    4,
    isRequired: true,
  );
  ArgumentError.checkNotNull(replicationGroupId, 'replicationGroupId');
  final $request = <String, dynamic>{};
  $request['NodeGroupId'] = nodeGroupId;
  $request['ReplicationGroupId'] = replicationGroupId;
  final $result = await _protocol.send(
    $request,
    action: 'TestFailover',
    version: '2015-02-02',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['TestFailoverMessage'],
    shapes: shapes,
    resultWrapper: 'TestFailoverResult',
  );
  return TestFailoverResult.fromXml($result);
}