Struct aws_sdk_secretsmanager::client::fluent_builders::GetRandomPassword

pub struct GetRandomPassword<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to GetRandomPassword.

Generates a random password of the specified complexity. This operation is intended for use in the Lambda rotation function. Per best practice, we recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.

Minimum permissions

To run this command, you must have the following permissions:

• secretsmanager:GetRandomPassword

Implementations

impl<C, M, R> GetRandomPassword<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<GetRandomPasswordOutput, SdkError<GetRandomPasswordError>> where
    R::Policy: SmithyRetryPolicy<GetRandomPasswordInputOperationOutputAlias, GetRandomPasswordOutput, GetRandomPasswordError, GetRandomPasswordInputOperationRetryAlias>, 

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 password_length(self, inp: i64) -> Self

The desired length of the generated password. The default value if you do not include this parameter is 32 characters.

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

The desired length of the generated password. The default value if you do not include this parameter is 32 characters.

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

A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.

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

A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.

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

Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.

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

Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.

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

Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.

The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation:

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

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

Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.

The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation:

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

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

Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.

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

Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.

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

Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.

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

Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.

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

Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.

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

Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.

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

A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True and the operation requires at least one of every character type.

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

A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True and the operation requires at least one of every character type.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for GetRandomPassword<C, M, R>

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

Formats the value using the given formatter.