software.amazon.awssdk.services.cognitoidentityprovider.model

Interface SignUpRequest.Builder

All Superinterfaces:

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

Enclosing class:

SignUpRequest

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

Method Summary

Modifier and Type	Method and Description
SignUpRequest.Builder	analyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for SignUp calls.
default SignUpRequest.Builder	analyticsMetadata(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for SignUp calls.
SignUpRequest.Builder	clientId(String clientId) The ID of the client associated with the user pool.
SignUpRequest.Builder	clientMetadata(Map<String,String> clientMetadata) A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
SignUpRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SignUpRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SignUpRequest.Builder	password(String password) The password of the user you wish to register.
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.
default SignUpRequest.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.
SignUpRequest.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.
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

overrideConfiguration

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

equalsBySdkFields, 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

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)

analyticsMetadata

SignUpRequest.Builder analyticsMetadata(AnalyticsMetadataType analyticsMetadata)

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

Parameters:

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

Returns:

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

analyticsMetadata

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

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

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

clientMetadata

SignUpRequest.Builder clientMetadata(Map<String,String> clientMetadata)

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

• Amazon Cognito does not validate the ClientMetadata value.

• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

Parameters:

clientMetadata - A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

• Amazon Cognito does not validate the ClientMetadata value.

• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

Returns:

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

overrideConfiguration

SignUpRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder