aws_sdk_elasticache/operation/decrease_replica_count/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::decrease_replica_count::_decrease_replica_count_output::DecreaseReplicaCountOutputBuilder;
3
4pub use crate::operation::decrease_replica_count::_decrease_replica_count_input::DecreaseReplicaCountInputBuilder;
5
6impl crate::operation::decrease_replica_count::builders::DecreaseReplicaCountInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::decrease_replica_count::DecreaseReplicaCountOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::decrease_replica_count::DecreaseReplicaCountError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.decrease_replica_count();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DecreaseReplicaCount`.
24///
25/// <p>Dynamically decreases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct DecreaseReplicaCountFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::decrease_replica_count::builders::DecreaseReplicaCountInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::decrease_replica_count::DecreaseReplicaCountOutput,
35        crate::operation::decrease_replica_count::DecreaseReplicaCountError,
36    > for DecreaseReplicaCountFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::decrease_replica_count::DecreaseReplicaCountOutput,
44            crate::operation::decrease_replica_count::DecreaseReplicaCountError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl DecreaseReplicaCountFluentBuilder {
51    /// Creates a new `DecreaseReplicaCountFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the DecreaseReplicaCount as a reference.
60    pub fn as_input(&self) -> &crate::operation::decrease_replica_count::builders::DecreaseReplicaCountInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::decrease_replica_count::DecreaseReplicaCountOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::decrease_replica_count::DecreaseReplicaCountError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::decrease_replica_count::DecreaseReplicaCount::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::decrease_replica_count::DecreaseReplicaCount::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::decrease_replica_count::DecreaseReplicaCountOutput,
97        crate::operation::decrease_replica_count::DecreaseReplicaCountError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>The id of the replication group from which you want to remove replica nodes.</p>
112    pub fn replication_group_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.replication_group_id(input.into());
114        self
115    }
116    /// <p>The id of the replication group from which you want to remove replica nodes.</p>
117    pub fn set_replication_group_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_replication_group_id(input);
119        self
120    }
121    /// <p>The id of the replication group from which you want to remove replica nodes.</p>
122    pub fn get_replication_group_id(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_replication_group_id()
124    }
125    /// <p>The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.</p>
126    /// <p>The minimum number of replicas in a shard or replication group is:</p>
127    /// <ul>
128    /// <li>
129    /// <p>Valkey or Redis OSS (cluster mode disabled)</p>
130    /// <ul>
131    /// <li>
132    /// <p>If Multi-AZ is enabled: 1</p></li>
133    /// <li>
134    /// <p>If Multi-AZ is not enabled: 0</p></li>
135    /// </ul></li>
136    /// <li>
137    /// <p>Valkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)</p></li>
138    /// </ul>
139    pub fn new_replica_count(mut self, input: i32) -> Self {
140        self.inner = self.inner.new_replica_count(input);
141        self
142    }
143    /// <p>The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.</p>
144    /// <p>The minimum number of replicas in a shard or replication group is:</p>
145    /// <ul>
146    /// <li>
147    /// <p>Valkey or Redis OSS (cluster mode disabled)</p>
148    /// <ul>
149    /// <li>
150    /// <p>If Multi-AZ is enabled: 1</p></li>
151    /// <li>
152    /// <p>If Multi-AZ is not enabled: 0</p></li>
153    /// </ul></li>
154    /// <li>
155    /// <p>Valkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)</p></li>
156    /// </ul>
157    pub fn set_new_replica_count(mut self, input: ::std::option::Option<i32>) -> Self {
158        self.inner = self.inner.set_new_replica_count(input);
159        self
160    }
161    /// <p>The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.</p>
162    /// <p>The minimum number of replicas in a shard or replication group is:</p>
163    /// <ul>
164    /// <li>
165    /// <p>Valkey or Redis OSS (cluster mode disabled)</p>
166    /// <ul>
167    /// <li>
168    /// <p>If Multi-AZ is enabled: 1</p></li>
169    /// <li>
170    /// <p>If Multi-AZ is not enabled: 0</p></li>
171    /// </ul></li>
172    /// <li>
173    /// <p>Valkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)</p></li>
174    /// </ul>
175    pub fn get_new_replica_count(&self) -> &::std::option::Option<i32> {
176        self.inner.get_new_replica_count()
177    }
178    ///
179    /// Appends an item to `ReplicaConfiguration`.
180    ///
181    /// To override the contents of this collection use [`set_replica_configuration`](Self::set_replica_configuration).
182    ///
183    /// <p>A list of <code>ConfigureShard</code> objects that can be used to configure each shard in a Valkey or Redis OSS (cluster mode enabled) replication group. The <code>ConfigureShard</code> has three members: <code>NewReplicaCount</code>, <code>NodeGroupId</code>, and <code>PreferredAvailabilityZones</code>.</p>
184    pub fn replica_configuration(mut self, input: crate::types::ConfigureShard) -> Self {
185        self.inner = self.inner.replica_configuration(input);
186        self
187    }
188    /// <p>A list of <code>ConfigureShard</code> objects that can be used to configure each shard in a Valkey or Redis OSS (cluster mode enabled) replication group. The <code>ConfigureShard</code> has three members: <code>NewReplicaCount</code>, <code>NodeGroupId</code>, and <code>PreferredAvailabilityZones</code>.</p>
189    pub fn set_replica_configuration(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ConfigureShard>>) -> Self {
190        self.inner = self.inner.set_replica_configuration(input);
191        self
192    }
193    /// <p>A list of <code>ConfigureShard</code> objects that can be used to configure each shard in a Valkey or Redis OSS (cluster mode enabled) replication group. The <code>ConfigureShard</code> has three members: <code>NewReplicaCount</code>, <code>NodeGroupId</code>, and <code>PreferredAvailabilityZones</code>.</p>
194    pub fn get_replica_configuration(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ConfigureShard>> {
195        self.inner.get_replica_configuration()
196    }
197    ///
198    /// Appends an item to `ReplicasToRemove`.
199    ///
200    /// To override the contents of this collection use [`set_replicas_to_remove`](Self::set_replicas_to_remove).
201    ///
202    /// <p>A list of the node ids to remove from the replication group or node group (shard).</p>
203    pub fn replicas_to_remove(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
204        self.inner = self.inner.replicas_to_remove(input.into());
205        self
206    }
207    /// <p>A list of the node ids to remove from the replication group or node group (shard).</p>
208    pub fn set_replicas_to_remove(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
209        self.inner = self.inner.set_replicas_to_remove(input);
210        self
211    }
212    /// <p>A list of the node ids to remove from the replication group or node group (shard).</p>
213    pub fn get_replicas_to_remove(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
214        self.inner.get_replicas_to_remove()
215    }
216    /// <p>If <code>True</code>, the number of replica nodes is decreased immediately. <code>ApplyImmediately=False</code> is not currently supported.</p>
217    pub fn apply_immediately(mut self, input: bool) -> Self {
218        self.inner = self.inner.apply_immediately(input);
219        self
220    }
221    /// <p>If <code>True</code>, the number of replica nodes is decreased immediately. <code>ApplyImmediately=False</code> is not currently supported.</p>
222    pub fn set_apply_immediately(mut self, input: ::std::option::Option<bool>) -> Self {
223        self.inner = self.inner.set_apply_immediately(input);
224        self
225    }
226    /// <p>If <code>True</code>, the number of replica nodes is decreased immediately. <code>ApplyImmediately=False</code> is not currently supported.</p>
227    pub fn get_apply_immediately(&self) -> &::std::option::Option<bool> {
228        self.inner.get_apply_immediately()
229    }
230}