Values.TestFailoverResultSourceRepresents the input of a TestFailover operation which tests 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 15 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 Valkey or Redis OSS (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 <node-group-id> Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed Cache cluster message: Recovering cache nodes <node-id> 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.
type error = [ | `APICallRateForCustomerExceededFault of APICallRateForCustomerExceededFault.t| `InvalidCacheClusterStateFault of InvalidCacheClusterStateFault.t| `InvalidKMSKeyFault of InvalidKMSKeyFault.t| `InvalidParameterCombinationException of InvalidParameterCombinationException.t| `InvalidParameterValueException of InvalidParameterValueException.t| `InvalidReplicationGroupStateFault of InvalidReplicationGroupStateFault.t| `NodeGroupNotFoundFault of NodeGroupNotFoundFault.t| `ReplicationGroupNotFoundFault of ReplicationGroupNotFoundFault.t| `TestFailoverNotAvailableFault of TestFailoverNotAvailableFault.t| `Unknown_operation_error of string * string option ]val error_of_json :
string ->
Yojson.Safe.t ->
[> `APICallRateForCustomerExceededFault of unit
| `InvalidCacheClusterStateFault of unit
| `InvalidKMSKeyFault of unit
| `InvalidParameterCombinationException of
InvalidParameterCombinationException.t
| `InvalidParameterValueException of InvalidParameterValueException.t
| `InvalidReplicationGroupStateFault of unit
| `NodeGroupNotFoundFault of unit
| `ReplicationGroupNotFoundFault of unit
| `TestFailoverNotAvailableFault of unit
| `Unknown_operation_error of string * string option ]val error_of_xml :
string ->
Awso.Xml.t ->
[> `APICallRateForCustomerExceededFault of unit
| `InvalidCacheClusterStateFault of unit
| `InvalidKMSKeyFault of unit
| `InvalidParameterCombinationException of
InvalidParameterCombinationException.t
| `InvalidParameterValueException of InvalidParameterValueException.t
| `InvalidReplicationGroupStateFault of unit
| `NodeGroupNotFoundFault of unit
| `ReplicationGroupNotFoundFault of unit
| `TestFailoverNotAvailableFault of unit
| `Unknown_operation_error of string * string option ]val to_value :
t ->
[> `Structure of
(string
* [> `Structure of
(string
* [> `Structure of
(string
* [> `Boolean of BooleanOptional.t
| `Enum of string
| `Integer of IntegerOptional.t
| `List of
[> `String of String_.t
| `Structure of
(string
* [> `Enum of string
| `List of
[> `Structure of
(string
* [> `String of String_.t
| `Structure of
(string
* [> `Integer of Integer.t
| `String of String_.t ])
list ])
list ]
list
| `String of String_.t
| `Structure of
(string
* [> `Integer of Integer.t
| `String of String_.t
| `Structure of
(string * [> `String of String_.t ])
list ])
list ])
list ]
list
| `String of String_.t
| `Structure of
(string
* [> `Boolean of BooleanOptional.t
| `Enum of string
| `Integer of Integer.t
| `List of
[> `Structure of
(string
* [> `Enum of string
| `Structure of
(string
* [> `Structure of
(string
* [> `String of String_.t ])
list ])
list ])
list ]
list
| `String of String_.t
| `Structure of
(string
* [> `List of
[> `String of UserGroupId.t ] list
| `Structure of
(string * [> `Double of Double.t ]) list ])
list ])
list
| `Timestamp of TStamp.t ])
list ])
list ])
list ]