software.amazon.awssdk.services.cognitoidentityprovider.model

Class SignUpRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.SignUpRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SignUpRequest.Builder,SignUpRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SignUpRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<SignUpRequest.Builder,SignUpRequest>

Represents the request to register a user.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SignUpRequest.Builder

Method Summary

Modifier and Type	Method and Description
AnalyticsMetadataType	analyticsMetadata() The Amazon Pinpoint analytics metadata that contributes to your metrics for SignUp calls.
static SignUpRequest.Builder	builder()
String	clientId() The ID of the client associated with the user pool.
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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasClientMetadata() For responses, this returns true if the service returned a value for the ClientMetadata property.
int	hashCode()
boolean	hasUserAttributes() For responses, this returns true if the service returned a value for the UserAttributes property.
boolean	hasValidationData() For responses, this returns true if the service returned a value for the ValidationData property.
String	password() The password of the user you want to register.
List<SdkField<?>>	sdkFields()
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.
static Class<? extends SignUpRequest.Builder>	serializableBuilderClass()
SignUpRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<AttributeType>	userAttributes() An array of name-value pairs representing user attributes.
UserContextDataType	userContextData() Contextual data about your user session, such as the device fingerprint, IP address, or location.
String	username() The user name of the user you want to register.
List<AttributeType>	validationData() The validation data in the request to register a user.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

clientId

public final String clientId()

The ID of the client associated with the user pool.

Returns:

The ID of the client associated with the user pool.

secretHash

public final 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.

Returns:

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.

username

public final String username()

The user name of the user you want to register.

Returns:

The user name of the user you want to register.

password

public final String password()

The password of the user you want to register.

Returns:

The password of the user you want to register.

hasUserAttributes

public final boolean hasUserAttributes()

For responses, this returns true if the service returned a value for the UserAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

userAttributes

public final List<AttributeType> userAttributes()

An array of name-value pairs representing user attributes.

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserAttributes() method.

Returns:

An array of name-value pairs representing user attributes.

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

hasValidationData

public final boolean hasValidationData()

For responses, this returns true if the service returned a value for the ValidationData property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

validationData

public final List<AttributeType> validationData()

The validation data in the request to register a user.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValidationData() method.

Returns:

The validation data in the request to register a user.

analyticsMetadata

public final AnalyticsMetadataType analyticsMetadata()

The Amazon Pinpoint analytics metadata that contributes to your metrics for SignUp calls.

Returns:

The Amazon Pinpoint analytics metadata that contributes to your metrics for SignUp calls.

userContextData

public final UserContextDataType 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:

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.

hasClientMetadata

public final boolean hasClientMetadata()

For responses, this returns true if the service returned a value for the ClientMetadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

clientMetadata

public final 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 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 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.

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasClientMetadata() method.

Returns:

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

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.

toBuilder

public SignUpRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SignUpRequest.Builder,SignUpRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static SignUpRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SignUpRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo