aws_sdk_elasticache/operation/reboot_cache_cluster/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::reboot_cache_cluster::_reboot_cache_cluster_output::RebootCacheClusterOutputBuilder;
3
4pub use crate::operation::reboot_cache_cluster::_reboot_cache_cluster_input::RebootCacheClusterInputBuilder;
5
6impl crate::operation::reboot_cache_cluster::builders::RebootCacheClusterInputBuilder {
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::reboot_cache_cluster::RebootCacheClusterOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::reboot_cache_cluster::RebootCacheClusterError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.reboot_cache_cluster();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `RebootCacheCluster`.
24///
25/// <p>Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.</p>
26/// <p>The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.</p>
27/// <p>When the reboot is complete, a cluster event is created.</p>
28/// <p>Rebooting a cluster is currently supported on Memcached, Valkey and Redis OSS (cluster mode disabled) clusters. Rebooting is not supported on Valkey or Redis OSS (cluster mode enabled) clusters.</p>
29/// <p>If you make changes to parameters that require a Valkey or Redis OSS (cluster mode enabled) cluster reboot for the changes to be applied, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/nodes.rebooting.html">Rebooting a Cluster</a> for an alternate process.</p>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct RebootCacheClusterFluentBuilder {
32    handle: ::std::sync::Arc<crate::client::Handle>,
33    inner: crate::operation::reboot_cache_cluster::builders::RebootCacheClusterInputBuilder,
34    config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37    crate::client::customize::internal::CustomizableSend<
38        crate::operation::reboot_cache_cluster::RebootCacheClusterOutput,
39        crate::operation::reboot_cache_cluster::RebootCacheClusterError,
40    > for RebootCacheClusterFluentBuilder
41{
42    fn send(
43        self,
44        config_override: crate::config::Builder,
45    ) -> crate::client::customize::internal::BoxFuture<
46        crate::client::customize::internal::SendResult<
47            crate::operation::reboot_cache_cluster::RebootCacheClusterOutput,
48            crate::operation::reboot_cache_cluster::RebootCacheClusterError,
49        >,
50    > {
51        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52    }
53}
54impl RebootCacheClusterFluentBuilder {
55    /// Creates a new `RebootCacheClusterFluentBuilder`.
56    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57        Self {
58            handle,
59            inner: ::std::default::Default::default(),
60            config_override: ::std::option::Option::None,
61        }
62    }
63    /// Access the RebootCacheCluster as a reference.
64    pub fn as_input(&self) -> &crate::operation::reboot_cache_cluster::builders::RebootCacheClusterInputBuilder {
65        &self.inner
66    }
67    /// Sends the request and returns the response.
68    ///
69    /// If an error occurs, an `SdkError` will be returned with additional details that
70    /// can be matched against.
71    ///
72    /// By default, any retryable failures will be retried twice. Retry behavior
73    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74    /// set when configuring the client.
75    pub async fn send(
76        self,
77    ) -> ::std::result::Result<
78        crate::operation::reboot_cache_cluster::RebootCacheClusterOutput,
79        ::aws_smithy_runtime_api::client::result::SdkError<
80            crate::operation::reboot_cache_cluster::RebootCacheClusterError,
81            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82        >,
83    > {
84        let input = self
85            .inner
86            .build()
87            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88        let runtime_plugins = crate::operation::reboot_cache_cluster::RebootCacheCluster::operation_runtime_plugins(
89            self.handle.runtime_plugins.clone(),
90            &self.handle.conf,
91            self.config_override,
92        );
93        crate::operation::reboot_cache_cluster::RebootCacheCluster::orchestrate(&runtime_plugins, input).await
94    }
95
96    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97    pub fn customize(
98        self,
99    ) -> crate::client::customize::CustomizableOperation<
100        crate::operation::reboot_cache_cluster::RebootCacheClusterOutput,
101        crate::operation::reboot_cache_cluster::RebootCacheClusterError,
102        Self,
103    > {
104        crate::client::customize::CustomizableOperation::new(self)
105    }
106    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107        self.set_config_override(::std::option::Option::Some(config_override.into()));
108        self
109    }
110
111    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112        self.config_override = config_override;
113        self
114    }
115    /// <p>The cluster identifier. This parameter is stored as a lowercase string.</p>
116    pub fn cache_cluster_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
117        self.inner = self.inner.cache_cluster_id(input.into());
118        self
119    }
120    /// <p>The cluster identifier. This parameter is stored as a lowercase string.</p>
121    pub fn set_cache_cluster_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
122        self.inner = self.inner.set_cache_cluster_id(input);
123        self
124    }
125    /// <p>The cluster identifier. This parameter is stored as a lowercase string.</p>
126    pub fn get_cache_cluster_id(&self) -> &::std::option::Option<::std::string::String> {
127        self.inner.get_cache_cluster_id()
128    }
129    ///
130    /// Appends an item to `CacheNodeIdsToReboot`.
131    ///
132    /// To override the contents of this collection use [`set_cache_node_ids_to_reboot`](Self::set_cache_node_ids_to_reboot).
133    ///
134    /// <p>A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.</p>
135    pub fn cache_node_ids_to_reboot(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
136        self.inner = self.inner.cache_node_ids_to_reboot(input.into());
137        self
138    }
139    /// <p>A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.</p>
140    pub fn set_cache_node_ids_to_reboot(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
141        self.inner = self.inner.set_cache_node_ids_to_reboot(input);
142        self
143    }
144    /// <p>A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.</p>
145    pub fn get_cache_node_ids_to_reboot(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
146        self.inner.get_cache_node_ids_to_reboot()
147    }
148}
aws_sdk_elasticache/operation/reboot_cache_cluster/builders.rs

aws_sdk_elasticache/operation/reboot_cache_cluster/
builders.rs
