aws_sdk_rds/operation/describe_db_cluster_parameters/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_db_cluster_parameters::_describe_db_cluster_parameters_output::DescribeDbClusterParametersOutputBuilder;
3
4pub use crate::operation::describe_db_cluster_parameters::_describe_db_cluster_parameters_input::DescribeDbClusterParametersInputBuilder;
5
6impl crate::operation::describe_db_cluster_parameters::builders::DescribeDbClusterParametersInputBuilder {
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::describe_db_cluster_parameters::DescribeDbClusterParametersOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_db_cluster_parameters::DescribeDBClusterParametersError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_db_cluster_parameters();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeDBClusterParameters`.
24///
25/// <p>Returns the detailed parameter list for a particular DB cluster parameter group.</p>
26/// <p>For more information on Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
27/// <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB cluster deployments</a> in the <i>Amazon RDS User Guide</i>.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct DescribeDBClusterParametersFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::describe_db_cluster_parameters::builders::DescribeDbClusterParametersInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::describe_db_cluster_parameters::DescribeDbClusterParametersOutput,
37        crate::operation::describe_db_cluster_parameters::DescribeDBClusterParametersError,
38    > for DescribeDBClusterParametersFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::describe_db_cluster_parameters::DescribeDbClusterParametersOutput,
46            crate::operation::describe_db_cluster_parameters::DescribeDBClusterParametersError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl DescribeDBClusterParametersFluentBuilder {
53    /// Creates a new `DescribeDBClusterParametersFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the DescribeDBClusterParameters as a reference.
62    pub fn as_input(&self) -> &crate::operation::describe_db_cluster_parameters::builders::DescribeDbClusterParametersInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::describe_db_cluster_parameters::DescribeDbClusterParametersOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::describe_db_cluster_parameters::DescribeDBClusterParametersError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::describe_db_cluster_parameters::DescribeDBClusterParameters::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::describe_db_cluster_parameters::DescribeDBClusterParameters::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::describe_db_cluster_parameters::DescribeDbClusterParametersOutput,
99        crate::operation::describe_db_cluster_parameters::DescribeDBClusterParametersError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// Create a paginator for this request
114    ///
115    /// Paginators are used by calling [`send().await`](crate::operation::describe_db_cluster_parameters::paginator::DescribeDbClusterParametersPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
116    pub fn into_paginator(self) -> crate::operation::describe_db_cluster_parameters::paginator::DescribeDbClusterParametersPaginator {
117        crate::operation::describe_db_cluster_parameters::paginator::DescribeDbClusterParametersPaginator::new(self.handle, self.inner)
118    }
119    /// <p>The name of a specific DB cluster parameter group to return parameter details for.</p>
120    /// <p>Constraints:</p>
121    /// <ul>
122    /// <li>
123    /// <p>If supplied, must match the name of an existing DBClusterParameterGroup.</p></li>
124    /// </ul>
125    pub fn db_cluster_parameter_group_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
126        self.inner = self.inner.db_cluster_parameter_group_name(input.into());
127        self
128    }
129    /// <p>The name of a specific DB cluster parameter group to return parameter details for.</p>
130    /// <p>Constraints:</p>
131    /// <ul>
132    /// <li>
133    /// <p>If supplied, must match the name of an existing DBClusterParameterGroup.</p></li>
134    /// </ul>
135    pub fn set_db_cluster_parameter_group_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
136        self.inner = self.inner.set_db_cluster_parameter_group_name(input);
137        self
138    }
139    /// <p>The name of a specific DB cluster parameter group to return parameter details for.</p>
140    /// <p>Constraints:</p>
141    /// <ul>
142    /// <li>
143    /// <p>If supplied, must match the name of an existing DBClusterParameterGroup.</p></li>
144    /// </ul>
145    pub fn get_db_cluster_parameter_group_name(&self) -> &::std::option::Option<::std::string::String> {
146        self.inner.get_db_cluster_parameter_group_name()
147    }
148    /// <p>A specific source to return parameters for.</p>
149    /// <p>Valid Values:</p>
150    /// <ul>
151    /// <li>
152    /// <p><code>engine-default</code></p></li>
153    /// <li>
154    /// <p><code>system</code></p></li>
155    /// <li>
156    /// <p><code>user</code></p></li>
157    /// </ul>
158    pub fn source(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
159        self.inner = self.inner.source(input.into());
160        self
161    }
162    /// <p>A specific source to return parameters for.</p>
163    /// <p>Valid Values:</p>
164    /// <ul>
165    /// <li>
166    /// <p><code>engine-default</code></p></li>
167    /// <li>
168    /// <p><code>system</code></p></li>
169    /// <li>
170    /// <p><code>user</code></p></li>
171    /// </ul>
172    pub fn set_source(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
173        self.inner = self.inner.set_source(input);
174        self
175    }
176    /// <p>A specific source to return parameters for.</p>
177    /// <p>Valid Values:</p>
178    /// <ul>
179    /// <li>
180    /// <p><code>engine-default</code></p></li>
181    /// <li>
182    /// <p><code>system</code></p></li>
183    /// <li>
184    /// <p><code>user</code></p></li>
185    /// </ul>
186    pub fn get_source(&self) -> &::std::option::Option<::std::string::String> {
187        self.inner.get_source()
188    }
189    ///
190    /// Appends an item to `Filters`.
191    ///
192    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
193    ///
194    /// <p>A filter that specifies one or more DB cluster parameters to describe.</p>
195    /// <p>The only supported filter is <code>parameter-name</code>. The results list only includes information about the DB cluster parameters with these names.</p>
196    pub fn filters(mut self, input: crate::types::Filter) -> Self {
197        self.inner = self.inner.filters(input);
198        self
199    }
200    /// <p>A filter that specifies one or more DB cluster parameters to describe.</p>
201    /// <p>The only supported filter is <code>parameter-name</code>. The results list only includes information about the DB cluster parameters with these names.</p>
202    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
203        self.inner = self.inner.set_filters(input);
204        self
205    }
206    /// <p>A filter that specifies one or more DB cluster parameters to describe.</p>
207    /// <p>The only supported filter is <code>parameter-name</code>. The results list only includes information about the DB cluster parameters with these names.</p>
208    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
209        self.inner.get_filters()
210    }
211    /// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
212    /// <p>Default: 100</p>
213    /// <p>Constraints: Minimum 20, maximum 100.</p>
214    pub fn max_records(mut self, input: i32) -> Self {
215        self.inner = self.inner.max_records(input);
216        self
217    }
218    /// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
219    /// <p>Default: 100</p>
220    /// <p>Constraints: Minimum 20, maximum 100.</p>
221    pub fn set_max_records(mut self, input: ::std::option::Option<i32>) -> Self {
222        self.inner = self.inner.set_max_records(input);
223        self
224    }
225    /// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
226    /// <p>Default: 100</p>
227    /// <p>Constraints: Minimum 20, maximum 100.</p>
228    pub fn get_max_records(&self) -> &::std::option::Option<i32> {
229        self.inner.get_max_records()
230    }
231    /// <p>An optional pagination token provided by a previous <code>DescribeDBClusterParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
232    pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
233        self.inner = self.inner.marker(input.into());
234        self
235    }
236    /// <p>An optional pagination token provided by a previous <code>DescribeDBClusterParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
237    pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
238        self.inner = self.inner.set_marker(input);
239        self
240    }
241    /// <p>An optional pagination token provided by a previous <code>DescribeDBClusterParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
242    pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
243        self.inner.get_marker()
244    }
245}