Struct aws_sdk_elasticache::client::fluent_builders::TestFailover

pub struct TestFailover { /* private fields */ }

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

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:

  1. Replication group message: Test Failover API called for node group

  2. Cache cluster message: Failover from primary node to replica node completed

  3. Replication group message: Failover from primary node to replica node completed

  4. Cache cluster message: Recovering cache nodes

  5. 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 TestFailover

pub async fn customize(
    self
) -> Result<CustomizableOperation<TestFailover, AwsResponseRetryClassifier>, SdkError<TestFailoverError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<TestFailoverOutput, SdkError<TestFailoverError>>

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.

pub fn replication_group_id(self, input: impl Into<String>) -> Self

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

pub fn set_replication_group_id(self, input: Option<String>) -> Self

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

pub fn node_group_id(self, input: impl Into<String>) -> Self

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.

pub fn set_node_group_id(self, input: Option<String>) -> Self

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

impl Clone for TestFailover

fn clone(&self) -> TestFailover

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TestFailover

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.