Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface ConfirmSignUpRequest.Builder

All Superinterfaces:

CopyableBuilder<ConfirmSignUpRequest.Builder,ConfirmSignUpRequest>, SdkBuilder<ConfirmSignUpRequest.Builder,ConfirmSignUpRequest>

Enclosing class:

ConfirmSignUpRequest

public static interface ConfirmSignUpRequest.Builder
extends CopyableBuilder<ConfirmSignUpRequest.Builder,ConfirmSignUpRequest>

Method Summary

Modifier and Type	Method	Description
ConfirmSignUpRequest.Builder	clientId(String clientId)	The ID of the client associated with the user pool.
ConfirmSignUpRequest.Builder	confirmationCode(String confirmationCode)	The confirmation code sent by a user's request to confirm registration.
ConfirmSignUpRequest.Builder	forceAliasCreation(Boolean forceAliasCreation)	Boolean to be specified to force user confirmation irrespective of existing alias.
ConfirmSignUpRequest.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.
ConfirmSignUpRequest.Builder	username(String username)	The user name of the user whose registration you wish to confirm.

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

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

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

ConfirmSignUpRequest.Builder username(String username)

The user name of the user whose registration you wish to confirm.

Parameters:

username - The user name of the user whose registration you wish to confirm.

Returns:

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

confirmationCode

ConfirmSignUpRequest.Builder confirmationCode(String confirmationCode)

The confirmation code sent by a user's request to confirm registration.

Parameters:

confirmationCode - The confirmation code sent by a user's request to confirm registration.

Returns:

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

forceAliasCreation

ConfirmSignUpRequest.Builder forceAliasCreation(Boolean forceAliasCreation)

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

Parameters:

forceAliasCreation - Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

Returns:

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