Package com.amazonaws.services.cognitoidp.model

Class CreateUserPoolRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.CreateUserPoolRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateUserPoolRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the request to create a user pool.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
CreateUserPoolRequest()

Method Summary

Modifier and Type	Method	Description
CreateUserPoolRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getAliasAttributes()	Attributes supported as an alias for this user pool.
List<String>	getAutoVerifiedAttributes()	The attributes to be auto-verified.
String	getEmailVerificationMessage()	A string representing the email verification message.
String	getEmailVerificationSubject()	A string representing the email verification subject.
LambdaConfigType	getLambdaConfig()	The Lambda trigger configuration information for the new user pool.
String	getMfaConfiguration()	Specifies MFA configuration details.
UserPoolPolicyType	getPolicies()	The policies associated with the new user pool.
String	getPoolName()	A string used to name the user pool.
String	getSmsAuthenticationMessage()	A string representing the SMS authentication message.
String	getSmsVerificationMessage()	A string representing the SMS verification message.
int	hashCode()
void	setAliasAttributes(Collection<String> aliasAttributes)	Attributes supported as an alias for this user pool.
void	setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)	The attributes to be auto-verified.
void	setEmailVerificationMessage(String emailVerificationMessage)	A string representing the email verification message.
void	setEmailVerificationSubject(String emailVerificationSubject)	A string representing the email verification subject.
void	setLambdaConfig(LambdaConfigType lambdaConfig)	The Lambda trigger configuration information for the new user pool.
void	setMfaConfiguration(UserPoolMfaType mfaConfiguration)	Specifies MFA configuration details.
void	setMfaConfiguration(String mfaConfiguration)	Specifies MFA configuration details.
void	setPolicies(UserPoolPolicyType policies)	The policies associated with the new user pool.
void	setPoolName(String poolName)	A string used to name the user pool.
void	setSmsAuthenticationMessage(String smsAuthenticationMessage)	A string representing the SMS authentication message.
void	setSmsVerificationMessage(String smsVerificationMessage)	A string representing the SMS verification message.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
CreateUserPoolRequest	withAliasAttributes(AliasAttributeType... aliasAttributes)	Attributes supported as an alias for this user pool.
CreateUserPoolRequest	withAliasAttributes(String... aliasAttributes)	Attributes supported as an alias for this user pool.
CreateUserPoolRequest	withAliasAttributes(Collection<String> aliasAttributes)	Attributes supported as an alias for this user pool.
CreateUserPoolRequest	withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)	The attributes to be auto-verified.
CreateUserPoolRequest	withAutoVerifiedAttributes(String... autoVerifiedAttributes)	The attributes to be auto-verified.
CreateUserPoolRequest	withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)	The attributes to be auto-verified.
CreateUserPoolRequest	withEmailVerificationMessage(String emailVerificationMessage)	A string representing the email verification message.
CreateUserPoolRequest	withEmailVerificationSubject(String emailVerificationSubject)	A string representing the email verification subject.
CreateUserPoolRequest	withLambdaConfig(LambdaConfigType lambdaConfig)	The Lambda trigger configuration information for the new user pool.
CreateUserPoolRequest	withMfaConfiguration(UserPoolMfaType mfaConfiguration)	Specifies MFA configuration details.
CreateUserPoolRequest	withMfaConfiguration(String mfaConfiguration)	Specifies MFA configuration details.
CreateUserPoolRequest	withPolicies(UserPoolPolicyType policies)	The policies associated with the new user pool.
CreateUserPoolRequest	withPoolName(String poolName)	A string used to name the user pool.
CreateUserPoolRequest	withSmsAuthenticationMessage(String smsAuthenticationMessage)	A string representing the SMS authentication message.
CreateUserPoolRequest	withSmsVerificationMessage(String smsVerificationMessage)	A string representing the SMS verification message.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateUserPoolRequest

public CreateUserPoolRequest()

Method Detail

setPoolName

public void setPoolName(String poolName)

A string used to name the user pool.

Parameters:

poolName - A string used to name the user pool.

getPoolName

public String getPoolName()

A string used to name the user pool.

Returns:

A string used to name the user pool.

withPoolName

public CreateUserPoolRequest withPoolName(String poolName)

A string used to name the user pool.

Parameters:

poolName - A string used to name the user pool.

Returns:

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

setPolicies

public void setPolicies(UserPoolPolicyType policies)

The policies associated with the new user pool.

Parameters:

policies - The policies associated with the new user pool.

getPolicies

public UserPoolPolicyType getPolicies()

The policies associated with the new user pool.

Returns:

The policies associated with the new user pool.

withPolicies

public CreateUserPoolRequest withPolicies(UserPoolPolicyType policies)

The policies associated with the new user pool.

Parameters:

policies - The policies associated with the new user pool.

Returns:

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

setLambdaConfig

public void setLambdaConfig(LambdaConfigType lambdaConfig)

The Lambda trigger configuration information for the new user pool.

Parameters:

lambdaConfig - The Lambda trigger configuration information for the new user pool.

getLambdaConfig

public LambdaConfigType getLambdaConfig()

The Lambda trigger configuration information for the new user pool.

Returns:

The Lambda trigger configuration information for the new user pool.

withLambdaConfig

public CreateUserPoolRequest withLambdaConfig(LambdaConfigType lambdaConfig)

The Lambda trigger configuration information for the new user pool.

Parameters:

lambdaConfig - The Lambda trigger configuration information for the new user pool.

Returns:

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

getAutoVerifiedAttributes

public List<String> getAutoVerifiedAttributes()

The attributes to be auto-verified. Possible values: email, phone_number.

Returns:

The attributes to be auto-verified. Possible values: email, phone_number.

See Also:

VerifiedAttributeType

setAutoVerifiedAttributes

public void setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)

The attributes to be auto-verified. Possible values: email, phone_number.

Parameters:

autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.

See Also:

VerifiedAttributeType

withAutoVerifiedAttributes

public CreateUserPoolRequest withAutoVerifiedAttributes(String... autoVerifiedAttributes)

The attributes to be auto-verified. Possible values: email, phone_number.

NOTE: This method appends the values to the existing list (if any). Use setAutoVerifiedAttributes(java.util.Collection) or withAutoVerifiedAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.

Returns:

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

See Also:

VerifiedAttributeType

withAutoVerifiedAttributes

public CreateUserPoolRequest withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)

The attributes to be auto-verified. Possible values: email, phone_number.

Parameters:

autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.

Returns:

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

See Also:

VerifiedAttributeType

withAutoVerifiedAttributes

public CreateUserPoolRequest withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)

The attributes to be auto-verified. Possible values: email, phone_number.

Parameters:

autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.

Returns:

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

See Also:

VerifiedAttributeType

getAliasAttributes

public List<String> getAliasAttributes()

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Returns:

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

See Also:

AliasAttributeType

setAliasAttributes

public void setAliasAttributes(Collection<String> aliasAttributes)

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Parameters:

aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

See Also:

AliasAttributeType

withAliasAttributes

public CreateUserPoolRequest withAliasAttributes(String... aliasAttributes)

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

NOTE: This method appends the values to the existing list (if any). Use setAliasAttributes(java.util.Collection) or withAliasAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Returns:

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

See Also:

AliasAttributeType

withAliasAttributes

public CreateUserPoolRequest withAliasAttributes(Collection<String> aliasAttributes)

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Parameters:

aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Returns:

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

See Also:

AliasAttributeType

withAliasAttributes

public CreateUserPoolRequest withAliasAttributes(AliasAttributeType... aliasAttributes)

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Parameters:

aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Returns:

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

See Also:

AliasAttributeType

setSmsVerificationMessage

public void setSmsVerificationMessage(String smsVerificationMessage)

A string representing the SMS verification message.

Parameters:

smsVerificationMessage - A string representing the SMS verification message.

getSmsVerificationMessage

public String getSmsVerificationMessage()

A string representing the SMS verification message.

Returns:

A string representing the SMS verification message.

withSmsVerificationMessage

public CreateUserPoolRequest withSmsVerificationMessage(String smsVerificationMessage)

A string representing the SMS verification message.

Parameters:

smsVerificationMessage - A string representing the SMS verification message.

Returns:

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

setEmailVerificationMessage

public void setEmailVerificationMessage(String emailVerificationMessage)

A string representing the email verification message.

Parameters:

emailVerificationMessage - A string representing the email verification message.

getEmailVerificationMessage

public String getEmailVerificationMessage()

A string representing the email verification message.

Returns:

A string representing the email verification message.

withEmailVerificationMessage

public CreateUserPoolRequest withEmailVerificationMessage(String emailVerificationMessage)

A string representing the email verification message.

Parameters:

emailVerificationMessage - A string representing the email verification message.

Returns:

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

setEmailVerificationSubject

public void setEmailVerificationSubject(String emailVerificationSubject)

A string representing the email verification subject.

Parameters:

emailVerificationSubject - A string representing the email verification subject.

getEmailVerificationSubject

public String getEmailVerificationSubject()

A string representing the email verification subject.

Returns:

A string representing the email verification subject.

withEmailVerificationSubject

public CreateUserPoolRequest withEmailVerificationSubject(String emailVerificationSubject)

A string representing the email verification subject.

Parameters:

emailVerificationSubject - A string representing the email verification subject.

Returns:

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

setSmsAuthenticationMessage

public void setSmsAuthenticationMessage(String smsAuthenticationMessage)

A string representing the SMS authentication message.

Parameters:

smsAuthenticationMessage - A string representing the SMS authentication message.

getSmsAuthenticationMessage

public String getSmsAuthenticationMessage()

A string representing the SMS authentication message.

Returns:

A string representing the SMS authentication message.

withSmsAuthenticationMessage

public CreateUserPoolRequest withSmsAuthenticationMessage(String smsAuthenticationMessage)

A string representing the SMS authentication message.

Parameters:

smsAuthenticationMessage - A string representing the SMS authentication message.

Returns:

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

setMfaConfiguration

public void setMfaConfiguration(String mfaConfiguration)

Specifies MFA configuration details.

Parameters:

mfaConfiguration - Specifies MFA configuration details.

See Also:

UserPoolMfaType

getMfaConfiguration

public String getMfaConfiguration()

Specifies MFA configuration details.

Returns:

Specifies MFA configuration details.

See Also:

UserPoolMfaType

withMfaConfiguration

public CreateUserPoolRequest withMfaConfiguration(String mfaConfiguration)

Specifies MFA configuration details.

Parameters:

mfaConfiguration - Specifies MFA configuration details.

Returns:

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

See Also:

UserPoolMfaType

setMfaConfiguration

public void setMfaConfiguration(UserPoolMfaType mfaConfiguration)

Specifies MFA configuration details.

Parameters:

mfaConfiguration - Specifies MFA configuration details.

See Also:

UserPoolMfaType

withMfaConfiguration

public CreateUserPoolRequest withMfaConfiguration(UserPoolMfaType mfaConfiguration)

Specifies MFA configuration details.

Parameters:

mfaConfiguration - Specifies MFA configuration details.

Returns:

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

See Also:

UserPoolMfaType

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateUserPoolRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()