Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class SignUpRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

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

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<SignUpRequest.Builder,SignUpRequest>

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

Represents the request to register a user.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SignUpRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static SignUpRequest.Builder	builder()
String	clientId()	The ID of the client associated with the user pool.
boolean	equals(Object obj)
int	hashCode()
String	password()	The password of the user you wish to register.
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()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<AttributeType>	userAttributes()	An array of name-value pairs representing user attributes.
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.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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.

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.

Returns:

The validation data in the request to register a user.

toBuilder

public SignUpRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SignUpRequest.Builder,SignUpRequest>

Returns:

a builder for type T

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

Overrides:

toString in class Object