aws_sdk_elasticache/waiters/
cache_cluster_available.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3///
4/// Fluent builder for the `cache_cluster_available` waiter.
5///
6/// This builder is intended to be used similar to the other fluent builders for
7/// normal operations on the client. However, instead of a `send` method, it has
8/// a `wait` method that takes a maximum amount of time to wait.
9///
10/// Construct this fluent builder using the client by importing the
11/// [`Waiters`](crate::client::Waiters) trait and calling the methods
12/// prefixed with `wait_until`.
13///
14#[derive(::std::clone::Clone, ::std::fmt::Debug)]
15pub struct CacheClusterAvailableFluentBuilder {
16    handle: ::std::sync::Arc<crate::client::Handle>,
17    inner: crate::operation::describe_cache_clusters::builders::DescribeCacheClustersInputBuilder,
18}
19impl CacheClusterAvailableFluentBuilder {
20    /// Creates a new `CacheClusterAvailableFluentBuilder`.
21    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
22        Self {
23            handle,
24            inner: ::std::default::Default::default(),
25        }
26    }
27    /// Access the DescribeCacheClusters as a reference.
28    pub fn as_input(&self) -> &crate::operation::describe_cache_clusters::builders::DescribeCacheClustersInputBuilder {
29        &self.inner
30    }
31    /// Wait until ElastiCache cluster is available.
32    pub async fn wait(
33        self,
34        max_wait: ::std::time::Duration,
35    ) -> ::std::result::Result<
36        crate::waiters::cache_cluster_available::CacheClusterAvailableFinalPoll,
37        crate::waiters::cache_cluster_available::WaitUntilCacheClusterAvailableError,
38    > {
39        let input = self
40            .inner
41            .build()
42            .map_err(::aws_smithy_runtime_api::client::waiters::error::WaiterError::construction_failure)?;
43        let runtime_plugins = crate::operation::describe_cache_clusters::DescribeCacheClusters::operation_runtime_plugins(
44            self.handle.runtime_plugins.clone(),
45            &self.handle.conf,
46            ::std::option::Option::None,
47        )
48        .with_operation_plugin(crate::sdk_feature_tracker::waiter::WaiterFeatureTrackerRuntimePlugin::new());
49        let mut cfg = ::aws_smithy_types::config_bag::ConfigBag::base();
50        let runtime_components_builder = runtime_plugins
51            .apply_client_configuration(&mut cfg)
52            .map_err(::aws_smithy_runtime_api::client::waiters::error::WaiterError::construction_failure)?;
53        let time_components = runtime_components_builder.into_time_components();
54        let sleep_impl = time_components.sleep_impl().expect("a sleep impl is required by waiters");
55        let time_source = time_components.time_source().expect("a time source is required by waiters");
56
57        let acceptor = move |result: ::std::result::Result<
58            &crate::operation::describe_cache_clusters::DescribeCacheClustersOutput,
59            &crate::operation::describe_cache_clusters::DescribeCacheClustersError,
60        >| {
61            // Matches: {"output":{"path":"CacheClusters[].CacheClusterStatus","expected":"available","comparator":"allStringEquals"}}
62            if crate::waiters::matchers::match_describe_cache_clusters_a9fc40b8034e15559(result) {
63                return ::aws_smithy_runtime::client::waiters::AcceptorState::Success;
64            }
65            // Matches: {"output":{"path":"CacheClusters[].CacheClusterStatus","expected":"deleted","comparator":"anyStringEquals"}}
66            if crate::waiters::matchers::match_describe_cache_clusters_c8c67f1604362d6d1(result) {
67                return ::aws_smithy_runtime::client::waiters::AcceptorState::Failure;
68            }
69            // Matches: {"output":{"path":"CacheClusters[].CacheClusterStatus","expected":"deleting","comparator":"anyStringEquals"}}
70            if crate::waiters::matchers::match_describe_cache_clusters_bca147da1a8d059ec(result) {
71                return ::aws_smithy_runtime::client::waiters::AcceptorState::Failure;
72            }
73            // Matches: {"output":{"path":"CacheClusters[].CacheClusterStatus","expected":"incompatible-network","comparator":"anyStringEquals"}}
74            if crate::waiters::matchers::match_describe_cache_clusters_6ff5fd2b4d5851182(result) {
75                return ::aws_smithy_runtime::client::waiters::AcceptorState::Failure;
76            }
77            // Matches: {"output":{"path":"CacheClusters[].CacheClusterStatus","expected":"restore-failed","comparator":"anyStringEquals"}}
78            if crate::waiters::matchers::match_describe_cache_clusters_723593c7b9870d199(result) {
79                return ::aws_smithy_runtime::client::waiters::AcceptorState::Failure;
80            }
81            ::aws_smithy_runtime::client::waiters::AcceptorState::NoAcceptorsMatched
82        };
83        let operation = move || {
84            let input = input.clone();
85            let runtime_plugins = runtime_plugins.clone();
86            async move { crate::operation::describe_cache_clusters::DescribeCacheClusters::orchestrate(&runtime_plugins, input).await }
87        };
88        let orchestrator = ::aws_smithy_runtime::client::waiters::WaiterOrchestrator::builder()
89            .min_delay(::std::time::Duration::from_secs(15))
90            .max_delay(::std::time::Duration::from_secs(120))
91            .max_wait(max_wait)
92            .time_source(time_source)
93            .sleep_impl(sleep_impl)
94            .acceptor(acceptor)
95            .operation(operation)
96            .build();
97        ::aws_smithy_runtime::client::waiters::attach_waiter_tracing_span(orchestrator.orchestrate()).await
98    }
99    /// <p>The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.</p>
100    pub fn cache_cluster_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
101        self.inner = self.inner.cache_cluster_id(input.into());
102        self
103    }
104    /// <p>The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.</p>
105    pub fn set_cache_cluster_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
106        self.inner = self.inner.set_cache_cluster_id(input);
107        self
108    }
109    /// <p>The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.</p>
110    pub fn get_cache_cluster_id(&self) -> &::std::option::Option<::std::string::String> {
111        self.inner.get_cache_cluster_id()
112    }
113    /// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</p>
114    /// <p>Default: 100</p>
115    /// <p>Constraints: minimum 20; maximum 100.</p>
116    pub fn max_records(mut self, input: i32) -> Self {
117        self.inner = self.inner.max_records(input);
118        self
119    }
120    /// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</p>
121    /// <p>Default: 100</p>
122    /// <p>Constraints: minimum 20; maximum 100.</p>
123    pub fn set_max_records(mut self, input: ::std::option::Option<i32>) -> Self {
124        self.inner = self.inner.set_max_records(input);
125        self
126    }
127    /// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</p>
128    /// <p>Default: 100</p>
129    /// <p>Constraints: minimum 20; maximum 100.</p>
130    pub fn get_max_records(&self) -> &::std::option::Option<i32> {
131        self.inner.get_max_records()
132    }
133    /// <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
134    pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
135        self.inner = self.inner.marker(input.into());
136        self
137    }
138    /// <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
139    pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
140        self.inner = self.inner.set_marker(input);
141        self
142    }
143    /// <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
144    pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
145        self.inner.get_marker()
146    }
147    /// <p>An optional flag that can be included in the <code>DescribeCacheCluster</code> request to retrieve information about the individual cache nodes.</p>
148    pub fn show_cache_node_info(mut self, input: bool) -> Self {
149        self.inner = self.inner.show_cache_node_info(input);
150        self
151    }
152    /// <p>An optional flag that can be included in the <code>DescribeCacheCluster</code> request to retrieve information about the individual cache nodes.</p>
153    pub fn set_show_cache_node_info(mut self, input: ::std::option::Option<bool>) -> Self {
154        self.inner = self.inner.set_show_cache_node_info(input);
155        self
156    }
157    /// <p>An optional flag that can be included in the <code>DescribeCacheCluster</code> request to retrieve information about the individual cache nodes.</p>
158    pub fn get_show_cache_node_info(&self) -> &::std::option::Option<bool> {
159        self.inner.get_show_cache_node_info()
160    }
161    /// <p>An optional flag that can be included in the <code>DescribeCacheCluster</code> request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this means Memcached and single node Valkey or Redis OSS clusters.</p>
162    pub fn show_cache_clusters_not_in_replication_groups(mut self, input: bool) -> Self {
163        self.inner = self.inner.show_cache_clusters_not_in_replication_groups(input);
164        self
165    }
166    /// <p>An optional flag that can be included in the <code>DescribeCacheCluster</code> request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this means Memcached and single node Valkey or Redis OSS clusters.</p>
167    pub fn set_show_cache_clusters_not_in_replication_groups(mut self, input: ::std::option::Option<bool>) -> Self {
168        self.inner = self.inner.set_show_cache_clusters_not_in_replication_groups(input);
169        self
170    }
171    /// <p>An optional flag that can be included in the <code>DescribeCacheCluster</code> request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this means Memcached and single node Valkey or Redis OSS clusters.</p>
172    pub fn get_show_cache_clusters_not_in_replication_groups(&self) -> &::std::option::Option<bool> {
173        self.inner.get_show_cache_clusters_not_in_replication_groups()
174    }
175}
176
177/// Successful return type for the `cache_cluster_available` waiter.
178pub type CacheClusterAvailableFinalPoll = ::aws_smithy_runtime_api::client::waiters::FinalPoll<
179    crate::operation::describe_cache_clusters::DescribeCacheClustersOutput,
180    ::aws_smithy_runtime_api::client::result::SdkError<
181        crate::operation::describe_cache_clusters::DescribeCacheClustersError,
182        ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
183    >,
184>;
185
186/// Error type for the `cache_cluster_available` waiter.
187pub type WaitUntilCacheClusterAvailableError = ::aws_smithy_runtime_api::client::waiters::error::WaiterError<
188    crate::operation::describe_cache_clusters::DescribeCacheClustersOutput,
189    crate::operation::describe_cache_clusters::DescribeCacheClustersError,
190>;
aws_sdk_elasticache/waiters/cache_cluster_available.rs

aws_sdk_elasticache/waiters/
cache_cluster_available.rs
