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 for collecting metrics for SignUp calls.
static SignUpRequest.Builder	builder()
String	clientId() The ID of the client associated with the user pool.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	password() The password of the user you wish 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 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.
String	username() The user name of the user you wish 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 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 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 String username()

The user name of the user you wish to register.

Returns:

The user name of the user you wish to register.

password

public String password()

The password of the user you wish to register.

Returns:

The password of the user you wish to register.

userAttributes

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

Returns:

An array of name-value pairs representing user attributes.

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

validationData

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

Returns:

The validation data in the request to register a user.

analyticsMetadata

public AnalyticsMetadataType analyticsMetadata()

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

Returns:

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

userContextData

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

Returns:

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.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo