Interface SignUpRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CognitoIdentityProviderRequest.Builder
,CopyableBuilder<SignUpRequest.Builder,
,SignUpRequest> SdkBuilder<SignUpRequest.Builder,
,SignUpRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SignUpRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault SignUpRequest.Builder
analyticsMetadata
(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata) The Amazon Pinpoint analytics metadata that contributes to your metrics forSignUp
calls.analyticsMetadata
(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata that contributes to your metrics forSignUp
calls.The ID of the client associated with the user pool.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.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The password of the user you want to register.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.userAttributes
(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.userAttributes
(Consumer<AttributeType.Builder>... userAttributes) An array of name-value pairs representing user attributes.userAttributes
(AttributeType... userAttributes) An array of name-value pairs representing user attributes.default SignUpRequest.Builder
userContextData
(Consumer<UserContextDataType.Builder> userContextData) Contextual data about your user session, such as the device fingerprint, IP address, or location.userContextData
(UserContextDataType userContextData) Contextual data about your user session, such as the device fingerprint, IP address, or location.The username of the user that you want to sign up.validationData
(Collection<AttributeType> validationData) Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.validationData
(Consumer<AttributeType.Builder>... validationData) Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.validationData
(AttributeType... validationData) Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
The username of the user that you want to sign up. The value of this parameter is typically a username, but can be any alias attribute in your user pool.
- Parameters:
username
- The username of the user that you want to sign up. The value of this parameter is typically a username, but can be any alias attribute in your user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
password
The password of the user you want to register.
- Parameters:
password
- The password of the user you want to register.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the
This is a convenience method that creates an instance of thecustom:
prefix to the attribute name.AttributeType.Builder
avoiding the need to create one manually viaAttributeType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed touserAttributes(List<AttributeType>)
.- Parameters:
userAttributes
- a consumer that will call methods onAttributeType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
validationData
Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.
Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.
For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
- Parameters:
validationData
- Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.
For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
validationData
Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.
Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.
For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
- Parameters:
validationData
- Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.
For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
validationData
Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.
Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.
For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
This is a convenience method that creates an instance of theAttributeType.Builder
avoiding the need to create one manually viaAttributeType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovalidationData(List<AttributeType>)
.- Parameters:
validationData
- a consumer that will call methods onAttributeType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
analyticsMetadata
The Amazon Pinpoint analytics metadata that contributes to your metrics for
SignUp
calls.- Parameters:
analyticsMetadata
- The Amazon Pinpoint analytics metadata that contributes to your metrics forSignUp
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 that contributes to your metrics for
This is a convenience method that creates an instance of theSignUp
calls.AnalyticsMetadataType.Builder
avoiding the need to create one manually viaAnalyticsMetadataType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toanalyticsMetadata(AnalyticsMetadataType)
.- Parameters:
analyticsMetadata
- a consumer that will call methods onAnalyticsMetadataType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
userContextData
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
- Parameters:
userContextData
- Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.- 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 about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
This is a convenience method that creates an instance of theUserContextDataType.Builder
avoiding the need to create one manually viaUserContextDataType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed touserContextData(UserContextDataType)
.- Parameters:
userContextData
- a consumer that will call methods onUserContextDataType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 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 Lambda, you can process theclientMetadata
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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
-
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
-
Validate the ClientMetadata value.
-
Encrypt the ClientMetadata value. Don't use Amazon Cognito 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 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 Lambda, you can process theclientMetadata
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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
-
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
-
Validate the ClientMetadata value.
-
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SignUpRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-