software.amazon.awssdk.services.cognitoidentityprovider.model

Interface SignUpRequest.Builder

All Superinterfaces:

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

Enclosing class:

SignUpRequest

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

Method Summary

Modifier and Type	Method and Description
SignUpRequest.Builder	clientId(String clientId) The ID of the client associated with the user pool.
SignUpRequest.Builder	password(String password) The password of the user you wish to register.
SignUpRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
SignUpRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
SignUpRequest.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.
SignUpRequest.Builder	userAttributes(AttributeType... userAttributes) An array of name-value pairs representing user attributes.
SignUpRequest.Builder	userAttributes(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.
SignUpRequest.Builder	userAttributes(Consumer<AttributeType.Builder>... userAttributes) An array of name-value pairs representing user attributes.
SignUpRequest.Builder	username(String username) The user name of the user you wish to register.
SignUpRequest.Builder	validationData(AttributeType... validationData) The validation data in the request to register a user.
SignUpRequest.Builder	validationData(Collection<AttributeType> validationData) The validation data in the request to register a user.
SignUpRequest.Builder	validationData(Consumer<AttributeType.Builder>... validationData) The validation data in the request to register a user.

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

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

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

SignUpRequest.Builder username(String username)

The user name of the user you wish to register.

Parameters:

username - The user name of the user you wish to register.

Returns:

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

password

SignUpRequest.Builder password(String password)

The password of the user you wish to register.

Parameters:

password - The password of the user you wish to register.

Returns:

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

userAttributes

SignUpRequest.Builder userAttributes(Collection<AttributeType> userAttributes)

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Parameters:

userAttributes - An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Returns:

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

userAttributes

SignUpRequest.Builder userAttributes(AttributeType... userAttributes)

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Parameters:

userAttributes - An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Returns:

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

userAttributes

SignUpRequest.Builder userAttributes(Consumer<AttributeType.Builder>... userAttributes)

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

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

Parameters:

userAttributes - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#userAttributes(List)

validationData

SignUpRequest.Builder validationData(Collection<AttributeType> validationData)

The validation data in the request to register a user.

Parameters:

validationData - The validation data in the request to register a user.

Returns:

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

validationData

SignUpRequest.Builder validationData(AttributeType... validationData)

The validation data in the request to register a user.

Parameters:

validationData - The validation data in the request to register a user.

Returns:

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

validationData

SignUpRequest.Builder validationData(Consumer<AttributeType.Builder>... validationData)

The validation data in the request to register a user.

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

Parameters:

validationData - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#validationData(List)

requestOverrideConfig

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

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