aws_sdk_elasticache/waiters/
replication_group_available.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3///
4/// Fluent builder for the `replication_group_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 ReplicationGroupAvailableFluentBuilder {
16    handle: ::std::sync::Arc<crate::client::Handle>,
17    inner: crate::operation::describe_replication_groups::builders::DescribeReplicationGroupsInputBuilder,
18}
19impl ReplicationGroupAvailableFluentBuilder {
20    /// Creates a new `ReplicationGroupAvailableFluentBuilder`.
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 DescribeReplicationGroups as a reference.
28    pub fn as_input(&self) -> &crate::operation::describe_replication_groups::builders::DescribeReplicationGroupsInputBuilder {
29        &self.inner
30    }
31    /// Wait until ElastiCache replication group is available.
32    pub async fn wait(
33        self,
34        max_wait: ::std::time::Duration,
35    ) -> ::std::result::Result<
36        crate::waiters::replication_group_available::ReplicationGroupAvailableFinalPoll,
37        crate::waiters::replication_group_available::WaitUntilReplicationGroupAvailableError,
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_replication_groups::DescribeReplicationGroups::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_replication_groups::DescribeReplicationGroupsOutput,
59            &crate::operation::describe_replication_groups::DescribeReplicationGroupsError,
60        >| {
61            // Matches: {"output":{"path":"ReplicationGroups[].Status","expected":"available","comparator":"allStringEquals"}}
62            if crate::waiters::matchers::match_describe_replication_groups_d13a4075701004c5b(result) {
63                return ::aws_smithy_runtime::client::waiters::AcceptorState::Success;
64            }
65            // Matches: {"output":{"path":"ReplicationGroups[].Status","expected":"deleted","comparator":"anyStringEquals"}}
66            if crate::waiters::matchers::match_describe_replication_groups_f27f835974b2d0bb2(result) {
67                return ::aws_smithy_runtime::client::waiters::AcceptorState::Failure;
68            }
69            ::aws_smithy_runtime::client::waiters::AcceptorState::NoAcceptorsMatched
70        };
71        let operation = move || {
72            let input = input.clone();
73            let runtime_plugins = runtime_plugins.clone();
74            async move { crate::operation::describe_replication_groups::DescribeReplicationGroups::orchestrate(&runtime_plugins, input).await }
75        };
76        let orchestrator = ::aws_smithy_runtime::client::waiters::WaiterOrchestrator::builder()
77            .min_delay(::std::time::Duration::from_secs(15))
78            .max_delay(::std::time::Duration::from_secs(120))
79            .max_wait(max_wait)
80            .time_source(time_source)
81            .sleep_impl(sleep_impl)
82            .acceptor(acceptor)
83            .operation(operation)
84            .build();
85        ::aws_smithy_runtime::client::waiters::attach_waiter_tracing_span(orchestrator.orchestrate()).await
86    }
87    /// <p>The identifier for the replication group to be described. This parameter is not case sensitive.</p>
88    /// <p>If you do not specify this parameter, information about all replication groups is returned.</p>
89    pub fn replication_group_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
90        self.inner = self.inner.replication_group_id(input.into());
91        self
92    }
93    /// <p>The identifier for the replication group to be described. This parameter is not case sensitive.</p>
94    /// <p>If you do not specify this parameter, information about all replication groups is returned.</p>
95    pub fn set_replication_group_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
96        self.inner = self.inner.set_replication_group_id(input);
97        self
98    }
99    /// <p>The identifier for the replication group to be described. This parameter is not case sensitive.</p>
100    /// <p>If you do not specify this parameter, information about all replication groups is returned.</p>
101    pub fn get_replication_group_id(&self) -> &::std::option::Option<::std::string::String> {
102        self.inner.get_replication_group_id()
103    }
104    /// <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>
105    /// <p>Default: 100</p>
106    /// <p>Constraints: minimum 20; maximum 100.</p>
107    pub fn max_records(mut self, input: i32) -> Self {
108        self.inner = self.inner.max_records(input);
109        self
110    }
111    /// <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>
112    /// <p>Default: 100</p>
113    /// <p>Constraints: minimum 20; maximum 100.</p>
114    pub fn set_max_records(mut self, input: ::std::option::Option<i32>) -> Self {
115        self.inner = self.inner.set_max_records(input);
116        self
117    }
118    /// <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>
119    /// <p>Default: 100</p>
120    /// <p>Constraints: minimum 20; maximum 100.</p>
121    pub fn get_max_records(&self) -> &::std::option::Option<i32> {
122        self.inner.get_max_records()
123    }
124    /// <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>
125    pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
126        self.inner = self.inner.marker(input.into());
127        self
128    }
129    /// <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>
130    pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
131        self.inner = self.inner.set_marker(input);
132        self
133    }
134    /// <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>
135    pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
136        self.inner.get_marker()
137    }
138}
139
140/// Successful return type for the `replication_group_available` waiter.
141pub type ReplicationGroupAvailableFinalPoll = ::aws_smithy_runtime_api::client::waiters::FinalPoll<
142    crate::operation::describe_replication_groups::DescribeReplicationGroupsOutput,
143    ::aws_smithy_runtime_api::client::result::SdkError<
144        crate::operation::describe_replication_groups::DescribeReplicationGroupsError,
145        ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
146    >,
147>;
148
149/// Error type for the `replication_group_available` waiter.
150pub type WaitUntilReplicationGroupAvailableError = ::aws_smithy_runtime_api::client::waiters::error::WaiterError<
151    crate::operation::describe_replication_groups::DescribeReplicationGroupsOutput,
152    crate::operation::describe_replication_groups::DescribeReplicationGroupsError,
153>;
aws_sdk_elasticache/waiters/replication_group_available.rs

aws_sdk_elasticache/waiters/
replication_group_available.rs
