public class CreateUserPoolRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Represents the request to create a user pool.
Modifier and Type | Field and Description |
---|---|
private java.util.List<java.lang.String> |
aliasAttributes
Attributes supported as an alias for this user pool.
|
private java.util.List<java.lang.String> |
autoVerifiedAttributes
The attributes to be auto-verified.
|
private java.lang.String |
emailVerificationMessage
A string representing the email verification message.
|
private java.lang.String |
emailVerificationSubject
A string representing the email verification subject.
|
private LambdaConfigType |
lambdaConfig
The Lambda trigger configuration information for the new user pool.
|
private java.lang.String |
mfaConfiguration
Specifies MFA configuration details.
|
private UserPoolPolicyType |
policies
The policies associated with the new user pool.
|
private java.lang.String |
poolName
A string used to name the user pool.
|
private java.lang.String |
smsAuthenticationMessage
A string representing the SMS authentication message.
|
private java.lang.String |
smsVerificationMessage
A string representing the SMS verification message.
|
NOOP
Constructor and Description |
---|
CreateUserPoolRequest() |
Modifier and Type | Method and Description |
---|---|
CreateUserPoolRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.util.List<java.lang.String> |
getAliasAttributes()
Attributes supported as an alias for this user pool.
|
java.util.List<java.lang.String> |
getAutoVerifiedAttributes()
The attributes to be auto-verified.
|
java.lang.String |
getEmailVerificationMessage()
A string representing the email verification message.
|
java.lang.String |
getEmailVerificationSubject()
A string representing the email verification subject.
|
LambdaConfigType |
getLambdaConfig()
The Lambda trigger configuration information for the new user pool.
|
java.lang.String |
getMfaConfiguration()
Specifies MFA configuration details.
|
UserPoolPolicyType |
getPolicies()
The policies associated with the new user pool.
|
java.lang.String |
getPoolName()
A string used to name the user pool.
|
java.lang.String |
getSmsAuthenticationMessage()
A string representing the SMS authentication message.
|
java.lang.String |
getSmsVerificationMessage()
A string representing the SMS verification message.
|
int |
hashCode() |
void |
setAliasAttributes(java.util.Collection<java.lang.String> aliasAttributes)
Attributes supported as an alias for this user pool.
|
void |
setAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
The attributes to be auto-verified.
|
void |
setEmailVerificationMessage(java.lang.String emailVerificationMessage)
A string representing the email verification message.
|
void |
setEmailVerificationSubject(java.lang.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(java.lang.String mfaConfiguration)
Specifies MFA configuration details.
|
void |
setMfaConfiguration(UserPoolMfaType mfaConfiguration)
Specifies MFA configuration details.
|
void |
setPolicies(UserPoolPolicyType policies)
The policies associated with the new user pool.
|
void |
setPoolName(java.lang.String poolName)
A string used to name the user pool.
|
void |
setSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage)
A string representing the SMS authentication message.
|
void |
setSmsVerificationMessage(java.lang.String smsVerificationMessage)
A string representing the SMS verification message.
|
java.lang.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(java.util.Collection<java.lang.String> aliasAttributes)
Attributes supported as an alias for this user pool.
|
CreateUserPoolRequest |
withAliasAttributes(java.lang.String... aliasAttributes)
Attributes supported as an alias for this user pool.
|
CreateUserPoolRequest |
withAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
The attributes to be auto-verified.
|
CreateUserPoolRequest |
withAutoVerifiedAttributes(java.lang.String... autoVerifiedAttributes)
The attributes to be auto-verified.
|
CreateUserPoolRequest |
withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
The attributes to be auto-verified.
|
CreateUserPoolRequest |
withEmailVerificationMessage(java.lang.String emailVerificationMessage)
A string representing the email verification message.
|
CreateUserPoolRequest |
withEmailVerificationSubject(java.lang.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(java.lang.String mfaConfiguration)
Specifies MFA configuration details.
|
CreateUserPoolRequest |
withMfaConfiguration(UserPoolMfaType mfaConfiguration)
Specifies MFA configuration details.
|
CreateUserPoolRequest |
withPolicies(UserPoolPolicyType policies)
The policies associated with the new user pool.
|
CreateUserPoolRequest |
withPoolName(java.lang.String poolName)
A string used to name the user pool.
|
CreateUserPoolRequest |
withSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage)
A string representing the SMS authentication message.
|
CreateUserPoolRequest |
withSmsVerificationMessage(java.lang.String smsVerificationMessage)
A string representing the SMS verification message.
|
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
private java.lang.String poolName
A string used to name the user pool.
private UserPoolPolicyType policies
The policies associated with the new user pool.
private LambdaConfigType lambdaConfig
The Lambda trigger configuration information for the new user pool.
private java.util.List<java.lang.String> autoVerifiedAttributes
The attributes to be auto-verified. Possible values: email, phone_number.
private java.util.List<java.lang.String> aliasAttributes
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
private java.lang.String smsVerificationMessage
A string representing the SMS verification message.
private java.lang.String emailVerificationMessage
A string representing the email verification message.
private java.lang.String emailVerificationSubject
A string representing the email verification subject.
private java.lang.String smsAuthenticationMessage
A string representing the SMS authentication message.
private java.lang.String mfaConfiguration
Specifies MFA configuration details.
public void setPoolName(java.lang.String poolName)
A string used to name the user pool.
poolName
- A string used to name the user pool.public java.lang.String getPoolName()
A string used to name the user pool.
public CreateUserPoolRequest withPoolName(java.lang.String poolName)
A string used to name the user pool.
poolName
- A string used to name the user pool.public void setPolicies(UserPoolPolicyType policies)
The policies associated with the new user pool.
policies
- The policies associated with the new user pool.public UserPoolPolicyType getPolicies()
The policies associated with the new user pool.
public CreateUserPoolRequest withPolicies(UserPoolPolicyType policies)
The policies associated with the new user pool.
policies
- The policies associated with the new user pool.public void setLambdaConfig(LambdaConfigType lambdaConfig)
The Lambda trigger configuration information for the new user pool.
lambdaConfig
- The Lambda trigger configuration information for the new user
pool.public LambdaConfigType getLambdaConfig()
The Lambda trigger configuration information for the new user pool.
public CreateUserPoolRequest withLambdaConfig(LambdaConfigType lambdaConfig)
The Lambda trigger configuration information for the new user pool.
lambdaConfig
- The Lambda trigger configuration information for the new user
pool.public java.util.List<java.lang.String> getAutoVerifiedAttributes()
The attributes to be auto-verified. Possible values: email, phone_number.
VerifiedAttributeType
public void setAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
The attributes to be auto-verified. Possible values: email, phone_number.
autoVerifiedAttributes
- The attributes to be auto-verified. Possible values: email,
phone_number.VerifiedAttributeType
public CreateUserPoolRequest withAutoVerifiedAttributes(java.lang.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.
autoVerifiedAttributes
- The attributes to be auto-verified. Possible values: email,
phone_number.VerifiedAttributeType
public CreateUserPoolRequest withAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
The attributes to be auto-verified. Possible values: email, phone_number.
autoVerifiedAttributes
- The attributes to be auto-verified. Possible values: email,
phone_number.VerifiedAttributeType
public CreateUserPoolRequest withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
The attributes to be auto-verified. Possible values: email, phone_number.
autoVerifiedAttributes
- The attributes to be auto-verified. Possible values: email,
phone_number.VerifiedAttributeType
public java.util.List<java.lang.String> getAliasAttributes()
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
AliasAttributeType
public void setAliasAttributes(java.util.Collection<java.lang.String> aliasAttributes)
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
aliasAttributes
- Attributes supported as an alias for this user pool. Possible
values: phone_number, email, or
preferred_username.AliasAttributeType
public CreateUserPoolRequest withAliasAttributes(java.lang.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.
aliasAttributes
- Attributes supported as an alias for this user pool. Possible
values: phone_number, email, or
preferred_username.AliasAttributeType
public CreateUserPoolRequest withAliasAttributes(java.util.Collection<java.lang.String> aliasAttributes)
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
aliasAttributes
- Attributes supported as an alias for this user pool. Possible
values: phone_number, email, or
preferred_username.AliasAttributeType
public CreateUserPoolRequest withAliasAttributes(AliasAttributeType... aliasAttributes)
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
aliasAttributes
- Attributes supported as an alias for this user pool. Possible
values: phone_number, email, or
preferred_username.AliasAttributeType
public void setSmsVerificationMessage(java.lang.String smsVerificationMessage)
A string representing the SMS verification message.
smsVerificationMessage
- A string representing the SMS verification message.public java.lang.String getSmsVerificationMessage()
A string representing the SMS verification message.
public CreateUserPoolRequest withSmsVerificationMessage(java.lang.String smsVerificationMessage)
A string representing the SMS verification message.
smsVerificationMessage
- A string representing the SMS verification message.public void setEmailVerificationMessage(java.lang.String emailVerificationMessage)
A string representing the email verification message.
emailVerificationMessage
- A string representing the email verification message.public java.lang.String getEmailVerificationMessage()
A string representing the email verification message.
public CreateUserPoolRequest withEmailVerificationMessage(java.lang.String emailVerificationMessage)
A string representing the email verification message.
emailVerificationMessage
- A string representing the email verification message.public void setEmailVerificationSubject(java.lang.String emailVerificationSubject)
A string representing the email verification subject.
emailVerificationSubject
- A string representing the email verification subject.public java.lang.String getEmailVerificationSubject()
A string representing the email verification subject.
public CreateUserPoolRequest withEmailVerificationSubject(java.lang.String emailVerificationSubject)
A string representing the email verification subject.
emailVerificationSubject
- A string representing the email verification subject.public void setSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage)
A string representing the SMS authentication message.
smsAuthenticationMessage
- A string representing the SMS authentication message.public java.lang.String getSmsAuthenticationMessage()
A string representing the SMS authentication message.
public CreateUserPoolRequest withSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage)
A string representing the SMS authentication message.
smsAuthenticationMessage
- A string representing the SMS authentication message.public void setMfaConfiguration(java.lang.String mfaConfiguration)
Specifies MFA configuration details.
mfaConfiguration
- Specifies MFA configuration details.UserPoolMfaType
public java.lang.String getMfaConfiguration()
Specifies MFA configuration details.
UserPoolMfaType
public CreateUserPoolRequest withMfaConfiguration(java.lang.String mfaConfiguration)
Specifies MFA configuration details.
mfaConfiguration
- Specifies MFA configuration details.UserPoolMfaType
public void setMfaConfiguration(UserPoolMfaType mfaConfiguration)
Specifies MFA configuration details.
mfaConfiguration
- Specifies MFA configuration details.UserPoolMfaType
public CreateUserPoolRequest withMfaConfiguration(UserPoolMfaType mfaConfiguration)
Specifies MFA configuration details.
mfaConfiguration
- Specifies MFA configuration details.UserPoolMfaType
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public CreateUserPoolRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()