software.amazon.awssdk.services.cognitoidentityprovider.model

Interface ConfirmForgotPasswordRequest.Builder

All Superinterfaces:

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

Enclosing class:

ConfirmForgotPasswordRequest

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

Method Summary

Modifier and Type	Method and Description
ConfirmForgotPasswordRequest.Builder	analyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
default ConfirmForgotPasswordRequest.Builder	analyticsMetadata(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
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	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ConfirmForgotPasswordRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
ConfirmForgotPasswordRequest.Builder	password(String password) The password sent by a user's request to retrieve a forgotten password.
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.
default ConfirmForgotPasswordRequest.Builder	userContextData(Consumer<UserContextDataType.Builder> userContextData) Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
ConfirmForgotPasswordRequest.Builder	userContextData(UserContextDataType userContextData) Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
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

overrideConfiguration

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

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

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

Parameters:

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

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.

analyticsMetadata

ConfirmForgotPasswordRequest.Builder analyticsMetadata(AnalyticsMetadataType analyticsMetadata)

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

Parameters:

analyticsMetadata - The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

Returns:

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

analyticsMetadata

default ConfirmForgotPasswordRequest.Builder analyticsMetadata(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata)

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

This is a convenience that creates an instance of the AnalyticsMetadataType.Builder avoiding the need to create one manually via AnalyticsMetadataType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to analyticsMetadata(AnalyticsMetadataType).

Parameters:

analyticsMetadata - a consumer that will call methods on AnalyticsMetadataType.Builder

Returns:

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

See Also:

analyticsMetadata(AnalyticsMetadataType)

userContextData

ConfirmForgotPasswordRequest.Builder userContextData(UserContextDataType userContextData)

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Parameters:

userContextData - Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Returns:

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

userContextData

default ConfirmForgotPasswordRequest.Builder userContextData(Consumer<UserContextDataType.Builder> userContextData)

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

This is a convenience that creates an instance of the UserContextDataType.Builder avoiding the need to create one manually via UserContextDataType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userContextData(UserContextDataType).

Parameters:

userContextData - a consumer that will call methods on UserContextDataType.Builder

Returns:

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

See Also:

userContextData(UserContextDataType)

overrideConfiguration

ConfirmForgotPasswordRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.