Smaws_Client_ElastiCache.TestFailoverRepresents 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
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 to replica node completedReplication group message:
Failover from primary node to replica node completedCache cluster message:
Recovering cache nodes Cache cluster message:
Finished recovery for cache nodes For more information see:
Also see, Testing Multi-AZ in the ElastiCache User Guide.
val error_to_string :
[ Smaws_Lib.Protocols.AwsQuery.error
| `APICallRateForCustomerExceededFault of
Types.api_call_rate_for_customer_exceeded_fault
| `InvalidCacheClusterStateFault of Types.invalid_cache_cluster_state_fault
| `InvalidKMSKeyFault of Types.invalid_kms_key_fault
| `InvalidParameterCombinationException of
Types.invalid_parameter_combination_exception
| `InvalidParameterValueException of Types.invalid_parameter_value_exception
| `InvalidReplicationGroupStateFault of
Types.invalid_replication_group_state_fault
| `NodeGroupNotFoundFault of Types.node_group_not_found_fault
| `ReplicationGroupNotFoundFault of Types.replication_group_not_found_fault
| `TestFailoverNotAvailableFault of Types.test_failover_not_available_fault ] ->
stringval request :
'http_type Smaws_Lib.Context.t ->
Types.test_failover_message ->
(Types.test_failover_result,
[> Smaws_Lib.Protocols.AwsQuery.error
| `APICallRateForCustomerExceededFault of
Types.api_call_rate_for_customer_exceeded_fault
| `InvalidCacheClusterStateFault of Types.invalid_cache_cluster_state_fault
| `InvalidKMSKeyFault of Types.invalid_kms_key_fault
| `InvalidParameterCombinationException of
Types.invalid_parameter_combination_exception
| `InvalidParameterValueException of
Types.invalid_parameter_value_exception
| `InvalidReplicationGroupStateFault of
Types.invalid_replication_group_state_fault
| `NodeGroupNotFoundFault of Types.node_group_not_found_fault
| `ReplicationGroupNotFoundFault of Types.replication_group_not_found_fault
| `TestFailoverNotAvailableFault of Types.test_failover_not_available_fault ])
Stdlib.resultval request_with_metadata :
'http_type Smaws_Lib.Context.t ->
Types.test_failover_message ->
(Types.test_failover_result Smaws_Lib.Response.t,
[> Smaws_Lib.Protocols.AwsQuery.error
| `APICallRateForCustomerExceededFault of
Types.api_call_rate_for_customer_exceeded_fault
| `InvalidCacheClusterStateFault of Types.invalid_cache_cluster_state_fault
| `InvalidKMSKeyFault of Types.invalid_kms_key_fault
| `InvalidParameterCombinationException of
Types.invalid_parameter_combination_exception
| `InvalidParameterValueException of
Types.invalid_parameter_value_exception
| `InvalidReplicationGroupStateFault of
Types.invalid_replication_group_state_fault
| `NodeGroupNotFoundFault of Types.node_group_not_found_fault
| `ReplicationGroupNotFoundFault of Types.replication_group_not_found_fault
| `TestFailoverNotAvailableFault of Types.test_failover_not_available_fault ]
* Smaws_Lib.Response.metadata)
Stdlib.result