software.amazon.awssdk.services.cognitoidentityprovider.model

Interface ConfirmForgotPasswordRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CognitoIdentityProviderRequest.Builder, CopyableBuilder<ConfirmForgotPasswordRequest.Builder,ConfirmForgotPasswordRequest>, SdkBuilder<ConfirmForgotPasswordRequest.Builder,ConfirmForgotPasswordRequest>, SdkRequest.Builder

Enclosing class:

ConfirmForgotPasswordRequest

public static interface ConfirmForgotPasswordRequest.Builder
extends CognitoIdentityProviderRequest.Builder, CopyableBuilder<ConfirmForgotPasswordRequest.Builder,ConfirmForgotPasswordRequest>

Method Summary

Modifier and Type	Method and Description
ConfirmForgotPasswordRequest.Builder	clientId(String clientId) The app client ID of the app associated with the user pool.
ConfirmForgotPasswordRequest.Builder	confirmationCode(String confirmationCode) The confirmation code sent by a user's request to retrieve a forgotten password.
ConfirmForgotPasswordRequest.Builder	password(String password) The password sent by a user's request to retrieve a forgotten password.
ConfirmForgotPasswordRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
ConfirmForgotPasswordRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
ConfirmForgotPasswordRequest.Builder	secretHash(String secretHash) A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
ConfirmForgotPasswordRequest.Builder	username(String username) The user name of the user for whom you want to enter a code to retrieve a forgotten password.

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder

build

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

requestOverrideConfig

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

copy

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

apply, build

Method Detail

clientId

ConfirmForgotPasswordRequest.Builder clientId(String clientId)

The app client ID of the app associated with the user pool.

Parameters:

clientId - The app client ID of the app associated with the user pool.

Returns:

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

secretHash

ConfirmForgotPasswordRequest.Builder secretHash(String secretHash)

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Parameters:

secretHash - A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Returns:

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

username

ConfirmForgotPasswordRequest.Builder username(String username)

The user name of the user for whom you want to enter a code to retrieve a forgotten password.

Parameters:

username - The user name of the user for whom you want to enter a code to retrieve a forgotten password.

Returns:

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

confirmationCode

ConfirmForgotPasswordRequest.Builder confirmationCode(String confirmationCode)

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see ForgotPassword

Parameters:

confirmationCode - The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see ForgotPassword

Returns:

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

password

ConfirmForgotPasswordRequest.Builder password(String password)

The password sent by a user's request to retrieve a forgotten password.

Parameters:

password - The password sent by a user's request to retrieve a forgotten password.

Returns:

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

requestOverrideConfig

ConfirmForgotPasswordRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

ConfirmForgotPasswordRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.