aws_sdk_elasticache/client/
test_failover.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`TestFailover`](crate::operation::test_failover::builders::TestFailoverFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`replication_group_id(impl Into<String>)`](crate::operation::test_failover::builders::TestFailoverFluentBuilder::replication_group_id) / [`set_replication_group_id(Option<String>)`](crate::operation::test_failover::builders::TestFailoverFluentBuilder::set_replication_group_id):<br>required: **true**<br><p>The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.</p><br>
7    ///   - [`node_group_id(impl Into<String>)`](crate::operation::test_failover::builders::TestFailoverFluentBuilder::node_group_id) / [`set_node_group_id(Option<String>)`](crate::operation::test_failover::builders::TestFailoverFluentBuilder::set_node_group_id):<br>required: **true**<br><p>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 15 node groups in any rolling 24-hour period.</p><br>
8    /// - On success, responds with [`TestFailoverOutput`](crate::operation::test_failover::TestFailoverOutput) with field(s):
9    ///   - [`replication_group(Option<ReplicationGroup>)`](crate::operation::test_failover::TestFailoverOutput::replication_group): <p>Contains all of the attributes of a specific Valkey or Redis OSS replication group.</p>
10    /// - On failure, responds with [`SdkError<TestFailoverError>`](crate::operation::test_failover::TestFailoverError)
11    pub fn test_failover(&self) -> crate::operation::test_failover::builders::TestFailoverFluentBuilder {
12        crate::operation::test_failover::builders::TestFailoverFluentBuilder::new(self.handle.clone())
13    }
14}