software.amazon.awssdk.services.cognitoidentityprovider.model

Interface ForgotPasswordRequest.Builder

All Superinterfaces:

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

Enclosing class:

ForgotPasswordRequest

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

Method Summary

Modifier and Type	Method and Description
ForgotPasswordRequest.Builder	clientId(String clientId) The ID of the client associated with the user pool.
ForgotPasswordRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
ForgotPasswordRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
ForgotPasswordRequest.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.
ForgotPasswordRequest.Builder	username(String username) The user name of the user for whom you want to enter a code to reset 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

ForgotPasswordRequest.Builder clientId(String clientId)

The ID of the client associated with the user pool.

Parameters:

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

Returns:

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

secretHash

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

ForgotPasswordRequest.Builder username(String username)

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

Parameters:

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

Returns:

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

requestOverrideConfig

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

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