aws_sdk_secretsmanager/operation/get_random_password/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_random_password::_get_random_password_output::GetRandomPasswordOutputBuilder;
3
4pub use crate::operation::get_random_password::_get_random_password_input::GetRandomPasswordInputBuilder;
5
6impl crate::operation::get_random_password::builders::GetRandomPasswordInputBuilder {
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::get_random_password::GetRandomPasswordOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_random_password::GetRandomPasswordError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_random_password();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetRandomPassword`.
24///
25/// <p>Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. By default, Secrets Manager uses uppercase and lowercase letters, numbers, and the following characters in passwords: <code>!\"#$%&amp;'()*+,-./:;&lt;=&gt;?@\[\\\]^_`{|}~</code></p>
26/// <p>Secrets Manager generates a CloudTrail log entry when you call this action.</p>
27/// <p><b>Required permissions: </b> <code>secretsmanager:GetRandomPassword</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions"> IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication and access control in Secrets Manager</a>.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct GetRandomPasswordFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::get_random_password::builders::GetRandomPasswordInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::get_random_password::GetRandomPasswordOutput,
37        crate::operation::get_random_password::GetRandomPasswordError,
38    > for GetRandomPasswordFluentBuilder
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::get_random_password::GetRandomPasswordOutput,
46            crate::operation::get_random_password::GetRandomPasswordError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl GetRandomPasswordFluentBuilder {
53    /// Creates a new `GetRandomPasswordFluentBuilder`.
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 GetRandomPassword as a reference.
62    pub fn as_input(&self) -> &crate::operation::get_random_password::builders::GetRandomPasswordInputBuilder {
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::get_random_password::GetRandomPasswordOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::get_random_password::GetRandomPasswordError,
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::get_random_password::GetRandomPassword::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::get_random_password::GetRandomPassword::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::get_random_password::GetRandomPasswordOutput,
99        crate::operation::get_random_password::GetRandomPasswordError,
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    /// <p>The length of the password. If you don't include this parameter, the default length is 32 characters.</p>
114    pub fn password_length(mut self, input: i64) -> Self {
115        self.inner = self.inner.password_length(input);
116        self
117    }
118    /// <p>The length of the password. If you don't include this parameter, the default length is 32 characters.</p>
119    pub fn set_password_length(mut self, input: ::std::option::Option<i64>) -> Self {
120        self.inner = self.inner.set_password_length(input);
121        self
122    }
123    /// <p>The length of the password. If you don't include this parameter, the default length is 32 characters.</p>
124    pub fn get_password_length(&self) -> &::std::option::Option<i64> {
125        self.inner.get_password_length()
126    }
127    /// <p>A string of the characters that you don't want in the password.</p>
128    pub fn exclude_characters(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129        self.inner = self.inner.exclude_characters(input.into());
130        self
131    }
132    /// <p>A string of the characters that you don't want in the password.</p>
133    pub fn set_exclude_characters(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134        self.inner = self.inner.set_exclude_characters(input);
135        self
136    }
137    /// <p>A string of the characters that you don't want in the password.</p>
138    pub fn get_exclude_characters(&self) -> &::std::option::Option<::std::string::String> {
139        self.inner.get_exclude_characters()
140    }
141    /// <p>Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.</p>
142    pub fn exclude_numbers(mut self, input: bool) -> Self {
143        self.inner = self.inner.exclude_numbers(input);
144        self
145    }
146    /// <p>Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.</p>
147    pub fn set_exclude_numbers(mut self, input: ::std::option::Option<bool>) -> Self {
148        self.inner = self.inner.set_exclude_numbers(input);
149        self
150    }
151    /// <p>Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.</p>
152    pub fn get_exclude_numbers(&self) -> &::std::option::Option<bool> {
153        self.inner.get_exclude_numbers()
154    }
155    /// <p>Specifies whether to exclude the following punctuation characters from the password: <code>! " # $ % &amp; ' ( ) * + , - . / : ; &lt; = &gt; ? @ \[ \ \] ^ _ ` { | } ~</code>. If you don't include this switch, the password can contain punctuation.</p>
156    pub fn exclude_punctuation(mut self, input: bool) -> Self {
157        self.inner = self.inner.exclude_punctuation(input);
158        self
159    }
160    /// <p>Specifies whether to exclude the following punctuation characters from the password: <code>! " # $ % &amp; ' ( ) * + , - . / : ; &lt; = &gt; ? @ \[ \ \] ^ _ ` { | } ~</code>. If you don't include this switch, the password can contain punctuation.</p>
161    pub fn set_exclude_punctuation(mut self, input: ::std::option::Option<bool>) -> Self {
162        self.inner = self.inner.set_exclude_punctuation(input);
163        self
164    }
165    /// <p>Specifies whether to exclude the following punctuation characters from the password: <code>! " # $ % &amp; ' ( ) * + , - . / : ; &lt; = &gt; ? @ \[ \ \] ^ _ ` { | } ~</code>. If you don't include this switch, the password can contain punctuation.</p>
166    pub fn get_exclude_punctuation(&self) -> &::std::option::Option<bool> {
167        self.inner.get_exclude_punctuation()
168    }
169    /// <p>Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.</p>
170    pub fn exclude_uppercase(mut self, input: bool) -> Self {
171        self.inner = self.inner.exclude_uppercase(input);
172        self
173    }
174    /// <p>Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.</p>
175    pub fn set_exclude_uppercase(mut self, input: ::std::option::Option<bool>) -> Self {
176        self.inner = self.inner.set_exclude_uppercase(input);
177        self
178    }
179    /// <p>Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.</p>
180    pub fn get_exclude_uppercase(&self) -> &::std::option::Option<bool> {
181        self.inner.get_exclude_uppercase()
182    }
183    /// <p>Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.</p>
184    pub fn exclude_lowercase(mut self, input: bool) -> Self {
185        self.inner = self.inner.exclude_lowercase(input);
186        self
187    }
188    /// <p>Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.</p>
189    pub fn set_exclude_lowercase(mut self, input: ::std::option::Option<bool>) -> Self {
190        self.inner = self.inner.set_exclude_lowercase(input);
191        self
192    }
193    /// <p>Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.</p>
194    pub fn get_exclude_lowercase(&self) -> &::std::option::Option<bool> {
195        self.inner.get_exclude_lowercase()
196    }
197    /// <p>Specifies whether to include the space character. If you include this switch, the password can contain space characters.</p>
198    pub fn include_space(mut self, input: bool) -> Self {
199        self.inner = self.inner.include_space(input);
200        self
201    }
202    /// <p>Specifies whether to include the space character. If you include this switch, the password can contain space characters.</p>
203    pub fn set_include_space(mut self, input: ::std::option::Option<bool>) -> Self {
204        self.inner = self.inner.set_include_space(input);
205        self
206    }
207    /// <p>Specifies whether to include the space character. If you include this switch, the password can contain space characters.</p>
208    pub fn get_include_space(&self) -> &::std::option::Option<bool> {
209        self.inner.get_include_space()
210    }
211    /// <p>Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.</p>
212    pub fn require_each_included_type(mut self, input: bool) -> Self {
213        self.inner = self.inner.require_each_included_type(input);
214        self
215    }
216    /// <p>Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.</p>
217    pub fn set_require_each_included_type(mut self, input: ::std::option::Option<bool>) -> Self {
218        self.inner = self.inner.set_require_each_included_type(input);
219        self
220    }
221    /// <p>Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.</p>
222    pub fn get_require_each_included_type(&self) -> &::std::option::Option<bool> {
223        self.inner.get_require_each_included_type()
224    }
225}
aws_sdk_secretsmanager/operation/get_random_password/builders.rs

aws_sdk_secretsmanager/operation/get_random_password/
builders.rs
