software.amazon.awssdk.services.secretsmanager.model

Interface GetRandomPasswordRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetRandomPasswordRequest.Builder,GetRandomPasswordRequest>, SdkBuilder<GetRandomPasswordRequest.Builder,GetRandomPasswordRequest>, SdkPojo, SdkRequest.Builder, SecretsManagerRequest.Builder

Enclosing class:

GetRandomPasswordRequest

public static interface GetRandomPasswordRequest.Builder
extends SecretsManagerRequest.Builder, SdkPojo, CopyableBuilder<GetRandomPasswordRequest.Builder,GetRandomPasswordRequest>

Method Summary

Modifier and Type	Method and Description
GetRandomPasswordRequest.Builder	excludeCharacters(String excludeCharacters) A string that includes characters that should not be included in the generated password.
GetRandomPasswordRequest.Builder	excludeLowercase(Boolean excludeLowercase) Specifies that the generated password should not include lowercase letters.
GetRandomPasswordRequest.Builder	excludeNumbers(Boolean excludeNumbers) Specifies that the generated password should not include digits.
GetRandomPasswordRequest.Builder	excludePunctuation(Boolean excludePunctuation) Specifies that the generated password should not include punctuation characters.
GetRandomPasswordRequest.Builder	excludeUppercase(Boolean excludeUppercase) Specifies that the generated password should not include uppercase letters.
GetRandomPasswordRequest.Builder	includeSpace(Boolean includeSpace) Specifies that the generated password can include the space character.
GetRandomPasswordRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetRandomPasswordRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetRandomPasswordRequest.Builder	passwordLength(Long passwordLength) The desired length of the generated password.
GetRandomPasswordRequest.Builder	requireEachIncludedType(Boolean requireEachIncludedType) A boolean value that specifies whether the generated password must include at least one of every allowed character type.

Methods inherited from interface software.amazon.awssdk.services.secretsmanager.model.SecretsManagerRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

passwordLength

GetRandomPasswordRequest.Builder passwordLength(Long passwordLength)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

excludeCharacters

GetRandomPasswordRequest.Builder excludeCharacters(String excludeCharacters)

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.

Parameters:

excludeCharacters - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

excludeNumbers

GetRandomPasswordRequest.Builder excludeNumbers(Boolean excludeNumbers)

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.

Parameters:

excludeNumbers - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

excludePunctuation

GetRandomPasswordRequest.Builder excludePunctuation(Boolean excludePunctuation)

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:

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

Parameters:

excludePunctuation - 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:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

excludeUppercase

GetRandomPasswordRequest.Builder excludeUppercase(Boolean excludeUppercase)

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.

Parameters:

excludeUppercase - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

excludeLowercase

GetRandomPasswordRequest.Builder excludeLowercase(Boolean excludeLowercase)

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.

Parameters:

excludeLowercase - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

includeSpace

GetRandomPasswordRequest.Builder includeSpace(Boolean includeSpace)

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.

Parameters:

includeSpace - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

requireEachIncludedType

GetRandomPasswordRequest.Builder requireEachIncludedType(Boolean requireEachIncludedType)

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.

Parameters:

requireEachIncludedType - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

GetRandomPasswordRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

GetRandomPasswordRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder