software.amazon.awssdk.services.cognitoidentityprovider.model

Interface ConfirmSignUpRequest.Builder

All Superinterfaces:

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

Enclosing class:

ConfirmSignUpRequest

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

Method Summary

Modifier and Type	Method and Description
ConfirmSignUpRequest.Builder	analyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.
default ConfirmSignUpRequest.Builder	analyticsMetadata(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.
ConfirmSignUpRequest.Builder	clientId(String clientId) The ID of the app 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	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ConfirmSignUpRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
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.
default ConfirmSignUpRequest.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.
ConfirmSignUpRequest.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.
ConfirmSignUpRequest.Builder	username(String username) The user name of the user whose registration you wish to confirm.

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

ConfirmSignUpRequest.Builder clientId(String clientId)

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

Parameters:

clientId - The ID of the app 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.

analyticsMetadata

ConfirmSignUpRequest.Builder analyticsMetadata(AnalyticsMetadataType analyticsMetadata)

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

Parameters:

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

Returns:

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

analyticsMetadata

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

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp 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

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

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

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