com.amazonaws.services.cognitoidentityprovider.model

Class SignUpRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.SignUpRequest

All Implemented Interfaces:

Serializable, Cloneable

public class SignUpRequest
extends AmazonWebServiceRequest
implements Serializable

Registers the user in the specified user pool and creates a user name, password, and user attributes.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SignUpRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AnalyticsMetadataType	getAnalyticsMetadata() The Amazon Pinpoint analytics metadata for collecting metrics for SignUp calls.
String	getClientId() The ID of the client associated with the user pool.
String	getPassword() The password of the user you wish to register.
String	getSecretHash() 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.
List<AttributeType>	getUserAttributes() An array of name-value pairs representing user attributes.
UserContextDataType	getUserContextData() 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	getUsername() The user name of the user you wish to register.
List<AttributeType>	getValidationData() The validation data in the request to register a user.
int	hashCode()
void	setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for SignUp calls.
void	setClientId(String clientId) The ID of the client associated with the user pool.
void	setPassword(String password) The password of the user you wish to register.
void	setSecretHash(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.
void	setUserAttributes(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.
void	setUserContextData(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.
void	setUsername(String username) The user name of the user you wish to register.
void	setValidationData(Collection<AttributeType> validationData) The validation data in the request to register a user.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SignUpRequest	withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for SignUp calls.
SignUpRequest	withClientId(String clientId) The ID of the client associated with the user pool.
SignUpRequest	withPassword(String password) The password of the user you wish to register.
SignUpRequest	withSecretHash(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	withUserAttributes(AttributeType... userAttributes) An array of name-value pairs representing user attributes.
SignUpRequest	withUserAttributes(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.
SignUpRequest	withUserContextData(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	withUsername(String username) The user name of the user you wish to register.
SignUpRequest	withValidationData(AttributeType... validationData) The validation data in the request to register a user.
SignUpRequest	withValidationData(Collection<AttributeType> validationData) The validation data in the request to register a user.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

SignUpRequest

public SignUpRequest()

Method Detail

getClientId

public String getClientId()

The ID of the client associated with the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

Returns:

The ID of the client associated with the user pool.

setClientId

public void setClientId(String clientId)

The ID of the client associated with the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

Parameters:

clientId -

The ID of the client associated with the user pool.

withClientId

public SignUpRequest withClientId(String clientId)

The ID of the client associated with the user pool.

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

Constraints:
Length: 1 - 128
Pattern: [\w+]+

Parameters:

clientId -

The ID of the client associated with the user pool.

Returns:

A reference to this updated object so that method calls can be chained together.

getSecretHash

public String getSecretHash()

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.

Constraints:
Length: 1 - 128
Pattern: [\w+=/]+

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.

setSecretHash

public void setSecretHash(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.

Constraints:
Length: 1 - 128
Pattern: [\w+=/]+

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.

withSecretHash

public SignUpRequest withSecretHash(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 reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [\w+=/]+

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:

A reference to this updated object so that method calls can be chained together.

getUsername

public String getUsername()

The user name of the user you wish to register.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Returns:

The user name of the user you wish to register.

setUsername

public void setUsername(String username)

The user name of the user you wish to register.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

The user name of the user you wish to register.

withUsername

public SignUpRequest withUsername(String username)

The user name of the user you wish to register.

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

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

The user name of the user you wish to register.

Returns:

A reference to this updated object so that method calls can be chained together.

getPassword

public String getPassword()

The password of the user you wish to register.

Constraints:
Length: 6 - 256
Pattern: [\S]+

Returns:

The password of the user you wish to register.

setPassword

public void setPassword(String password)

The password of the user you wish to register.

Constraints:
Length: 6 - 256
Pattern: [\S]+

Parameters:

password -

The password of the user you wish to register.

withPassword

public SignUpRequest withPassword(String password)

The password of the user you wish to register.

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

Constraints:
Length: 6 - 256
Pattern: [\S]+

Parameters:

password -

The password of the user you wish to register.

Returns:

A reference to this updated object so that method calls can be chained together.

getUserAttributes

public List<AttributeType> getUserAttributes()

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.

setUserAttributes

public void setUserAttributes(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.

withUserAttributes

public SignUpRequest withUserAttributes(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 a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

withUserAttributes

public SignUpRequest withUserAttributes(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.

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

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:

A reference to this updated object so that method calls can be chained together.

getValidationData

public List<AttributeType> getValidationData()

The validation data in the request to register a user.

Returns:

The validation data in the request to register a user.

setValidationData

public void setValidationData(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.

withValidationData

public SignUpRequest withValidationData(AttributeType... validationData)

The validation data in the request to register a user.

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

Parameters:

validationData -

The validation data in the request to register a user.

Returns:

A reference to this updated object so that method calls can be chained together.

withValidationData

public SignUpRequest withValidationData(Collection<AttributeType> validationData)

The validation data in the request to register a user.

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

Parameters:

validationData -

The validation data in the request to register a user.

Returns:

A reference to this updated object so that method calls can be chained together.

getAnalyticsMetadata

public AnalyticsMetadataType getAnalyticsMetadata()

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

Returns:

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

setAnalyticsMetadata

public void setAnalyticsMetadata(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.

withAnalyticsMetadata

public SignUpRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)

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

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

Parameters:

analyticsMetadata -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getUserContextData

public UserContextDataType getUserContextData()

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.

setUserContextData

public void setUserContextData(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.

withUserContextData

public SignUpRequest withUserContextData(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 a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object