Struct aws_sdk_elasticache::client::fluent_builders::TestFailover [−][src]
pub struct TestFailover<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to TestFailover
.
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 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
to replica node completed -
Replication group message:
Failover from primary node
to replica node completed -
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.
Implementations
impl<C, M, R> TestFailover<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> TestFailover<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<TestFailoverOutput, SdkError<TestFailoverError>> where
R::Policy: SmithyRetryPolicy<TestFailoverInputOperationOutputAlias, TestFailoverOutput, TestFailoverError, TestFailoverInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<TestFailoverOutput, SdkError<TestFailoverError>> where
R::Policy: SmithyRetryPolicy<TestFailoverInputOperationOutputAlias, TestFailoverOutput, TestFailoverError, TestFailoverInputOperationRetryAlias>,
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.
The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.
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.
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.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !RefUnwindSafe for TestFailover<C, M, R>
impl<C, M, R> Unpin for TestFailover<C, M, R>
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !UnwindSafe for TestFailover<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more