Struct aws_sdk_secretsmanager::operation::get_random_password::builders::GetRandomPasswordFluentBuilder

pub struct GetRandomPasswordFluentBuilder { /* private fields */ }

Fluent builder constructing a request to GetRandomPassword.

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: !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~

Secrets Manager generates a CloudTrail log entry when you call this action.

Required permissions: secretsmanager:GetRandomPassword. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Implementations

impl GetRandomPasswordFluentBuilder

pub fn as_input(&self) -> &GetRandomPasswordInputBuilder

Access the GetRandomPassword as a reference.

pub async fn send( self, ) -> Result<GetRandomPasswordOutput, SdkError<GetRandomPasswordError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<GetRandomPasswordOutput, GetRandomPasswordError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn password_length(self, input: i64) -> Self

The length of the password. If you don't include this parameter, the default length is 32 characters.

pub fn set_password_length(self, input: Option<i64>) -> Self

The length of the password. If you don't include this parameter, the default length is 32 characters.

pub fn get_password_length(&self) -> &Option<i64>

The length of the password. If you don't include this parameter, the default length is 32 characters.

pub fn exclude_characters(self, input: impl Into<String>) -> Self

A string of the characters that you don't want in the password.

pub fn set_exclude_characters(self, input: Option<String>) -> Self

A string of the characters that you don't want in the password.

pub fn get_exclude_characters(&self) -> &Option<String>

A string of the characters that you don't want in the password.

pub fn exclude_numbers(self, input: bool) -> Self

Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.

pub fn set_exclude_numbers(self, input: Option<bool>) -> Self

Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.

pub fn get_exclude_numbers(&self) -> &Option<bool>

Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.

pub fn exclude_punctuation(self, input: bool) -> Self

Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.

pub fn set_exclude_punctuation(self, input: Option<bool>) -> Self

Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.

pub fn get_exclude_punctuation(&self) -> &Option<bool>

Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.

pub fn exclude_uppercase(self, input: bool) -> Self

Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.

pub fn set_exclude_uppercase(self, input: Option<bool>) -> Self

Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.

pub fn get_exclude_uppercase(&self) -> &Option<bool>

Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.

pub fn exclude_lowercase(self, input: bool) -> Self

Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.

pub fn set_exclude_lowercase(self, input: Option<bool>) -> Self

Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.

pub fn get_exclude_lowercase(&self) -> &Option<bool>

Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.

pub fn include_space(self, input: bool) -> Self

Specifies whether to include the space character. If you include this switch, the password can contain space characters.

pub fn set_include_space(self, input: Option<bool>) -> Self

Specifies whether to include the space character. If you include this switch, the password can contain space characters.

pub fn get_include_space(&self) -> &Option<bool>

Specifies whether to include the space character. If you include this switch, the password can contain space characters.

pub fn require_each_included_type(self, input: bool) -> Self

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.

pub fn set_require_each_included_type(self, input: Option<bool>) -> Self

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.

pub fn get_require_each_included_type(&self) -> &Option<bool>

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.

Trait Implementations

impl Clone for GetRandomPasswordFluentBuilder

fn clone(&self) -> GetRandomPasswordFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetRandomPasswordFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.