public class UserPoolType
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
A container with information about the user pool type.
Modifier and Type | Field and Description |
---|---|
private java.util.List<java.lang.String> |
aliasAttributes
Specifies the attributes that are aliased in a user pool.
|
private java.util.List<java.lang.String> |
autoVerifiedAttributes
Specifies the attributes that are auto-verified in a user pool.
|
private java.util.Date |
creationDate
The creation date of a user pool.
|
private java.lang.String |
emailVerificationMessage
The contents of the email verification message.
|
private java.lang.String |
emailVerificationSubject
The subject of the email verification message.
|
private java.lang.Integer |
estimatedNumberOfUsers
A number estimating the size of the user pool.
|
private java.lang.String |
id
The ID of the user pool.
|
private LambdaConfigType |
lambdaConfig
A container describing the AWS Lambda triggers associated with a user
pool.
|
private java.util.Date |
lastModifiedDate
The last modified date of a user pool.
|
private java.lang.String |
mfaConfiguration
Can be one of the following values:
|
private java.lang.String |
name
The name of the user pool.
|
private UserPoolPolicyType |
policies
A container describing the policies associated with a user pool.
|
private java.util.List<SchemaAttributeType> |
schemaAttributes
A container with the schema attributes of a user pool.
|
private java.lang.String |
smsAuthenticationMessage
The contents of the SMS authentication message.
|
private java.lang.String |
smsVerificationMessage
The contents of the SMS verification message.
|
private java.lang.String |
status
The status of a user pool.
|
Constructor and Description |
---|
UserPoolType() |
Modifier and Type | Method and Description |
---|---|
UserPoolType |
clone() |
boolean |
equals(java.lang.Object obj) |
java.util.List<java.lang.String> |
getAliasAttributes()
Specifies the attributes that are aliased in a user pool.
|
java.util.List<java.lang.String> |
getAutoVerifiedAttributes()
Specifies the attributes that are auto-verified in a user pool.
|
java.util.Date |
getCreationDate()
The creation date of a user pool.
|
java.lang.String |
getEmailVerificationMessage()
The contents of the email verification message.
|
java.lang.String |
getEmailVerificationSubject()
The subject of the email verification message.
|
java.lang.Integer |
getEstimatedNumberOfUsers()
A number estimating the size of the user pool.
|
java.lang.String |
getId()
The ID of the user pool.
|
LambdaConfigType |
getLambdaConfig()
A container describing the AWS Lambda triggers associated with a user
pool.
|
java.util.Date |
getLastModifiedDate()
The last modified date of a user pool.
|
java.lang.String |
getMfaConfiguration()
Can be one of the following values:
|
java.lang.String |
getName()
The name of the user pool.
|
UserPoolPolicyType |
getPolicies()
A container describing the policies associated with a user pool.
|
java.util.List<SchemaAttributeType> |
getSchemaAttributes()
A container with the schema attributes of a user pool.
|
java.lang.String |
getSmsAuthenticationMessage()
The contents of the SMS authentication message.
|
java.lang.String |
getSmsVerificationMessage()
The contents of the SMS verification message.
|
java.lang.String |
getStatus()
The status of a user pool.
|
int |
hashCode() |
void |
setAliasAttributes(java.util.Collection<java.lang.String> aliasAttributes)
Specifies the attributes that are aliased in a user pool.
|
void |
setAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
|
void |
setCreationDate(java.util.Date creationDate)
The creation date of a user pool.
|
void |
setEmailVerificationMessage(java.lang.String emailVerificationMessage)
The contents of the email verification message.
|
void |
setEmailVerificationSubject(java.lang.String emailVerificationSubject)
The subject of the email verification message.
|
void |
setEstimatedNumberOfUsers(java.lang.Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
|
void |
setId(java.lang.String id)
The ID of the user pool.
|
void |
setLambdaConfig(LambdaConfigType lambdaConfig)
A container describing the AWS Lambda triggers associated with a user
pool.
|
void |
setLastModifiedDate(java.util.Date lastModifiedDate)
The last modified date of a user pool.
|
void |
setMfaConfiguration(java.lang.String mfaConfiguration)
Can be one of the following values:
|
void |
setMfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:
|
void |
setName(java.lang.String name)
The name of the user pool.
|
void |
setPolicies(UserPoolPolicyType policies)
A container describing the policies associated with a user pool.
|
void |
setSchemaAttributes(java.util.Collection<SchemaAttributeType> schemaAttributes)
A container with the schema attributes of a user pool.
|
void |
setSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage)
The contents of the SMS authentication message.
|
void |
setSmsVerificationMessage(java.lang.String smsVerificationMessage)
The contents of the SMS verification message.
|
void |
setStatus(StatusType status)
The status of a user pool.
|
void |
setStatus(java.lang.String status)
The status of a user pool.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
UserPoolType |
withAliasAttributes(AliasAttributeType... aliasAttributes)
Specifies the attributes that are aliased in a user pool.
|
UserPoolType |
withAliasAttributes(java.util.Collection<java.lang.String> aliasAttributes)
Specifies the attributes that are aliased in a user pool.
|
UserPoolType |
withAliasAttributes(java.lang.String... aliasAttributes)
Specifies the attributes that are aliased in a user pool.
|
UserPoolType |
withAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
|
UserPoolType |
withAutoVerifiedAttributes(java.lang.String... autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
|
UserPoolType |
withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
|
UserPoolType |
withCreationDate(java.util.Date creationDate)
The creation date of a user pool.
|
UserPoolType |
withEmailVerificationMessage(java.lang.String emailVerificationMessage)
The contents of the email verification message.
|
UserPoolType |
withEmailVerificationSubject(java.lang.String emailVerificationSubject)
The subject of the email verification message.
|
UserPoolType |
withEstimatedNumberOfUsers(java.lang.Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
|
UserPoolType |
withId(java.lang.String id)
The ID of the user pool.
|
UserPoolType |
withLambdaConfig(LambdaConfigType lambdaConfig)
A container describing the AWS Lambda triggers associated with a user
pool.
|
UserPoolType |
withLastModifiedDate(java.util.Date lastModifiedDate)
The last modified date of a user pool.
|
UserPoolType |
withMfaConfiguration(java.lang.String mfaConfiguration)
Can be one of the following values:
|
UserPoolType |
withMfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:
|
UserPoolType |
withName(java.lang.String name)
The name of the user pool.
|
UserPoolType |
withPolicies(UserPoolPolicyType policies)
A container describing the policies associated with a user pool.
|
UserPoolType |
withSchemaAttributes(java.util.Collection<SchemaAttributeType> schemaAttributes)
A container with the schema attributes of a user pool.
|
UserPoolType |
withSchemaAttributes(SchemaAttributeType... schemaAttributes)
A container with the schema attributes of a user pool.
|
UserPoolType |
withSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage)
The contents of the SMS authentication message.
|
UserPoolType |
withSmsVerificationMessage(java.lang.String smsVerificationMessage)
The contents of the SMS verification message.
|
UserPoolType |
withStatus(StatusType status)
The status of a user pool.
|
UserPoolType |
withStatus(java.lang.String status)
The status of a user pool.
|
private java.lang.String id
The ID of the user pool.
private java.lang.String name
The name of the user pool.
private UserPoolPolicyType policies
A container describing the policies associated with a user pool.
private LambdaConfigType lambdaConfig
A container describing the AWS Lambda triggers associated with a user pool.
private java.lang.String status
The status of a user pool.
private java.util.Date lastModifiedDate
The last modified date of a user pool.
private java.util.Date creationDate
The creation date of a user pool.
private java.util.List<SchemaAttributeType> schemaAttributes
A container with the schema attributes of a user pool.
private java.util.List<java.lang.String> autoVerifiedAttributes
Specifies the attributes that are auto-verified in a user pool.
private java.util.List<java.lang.String> aliasAttributes
Specifies the attributes that are aliased in a user pool.
private java.lang.String smsVerificationMessage
The contents of the SMS verification message.
private java.lang.String emailVerificationMessage
The contents of the email verification message.
private java.lang.String emailVerificationSubject
The subject of the email verification message.
private java.lang.String smsAuthenticationMessage
The contents of the SMS authentication message.
private java.lang.String mfaConfiguration
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user registrations.
You can only specify required when you are initially creating a user
pool.OPTIONAL
- Users have the option when registering to
create an MFA token.private java.lang.Integer estimatedNumberOfUsers
A number estimating the size of the user pool.
public void setId(java.lang.String id)
The ID of the user pool.
id
- The ID of the user pool.public java.lang.String getId()
The ID of the user pool.
public UserPoolType withId(java.lang.String id)
The ID of the user pool.
id
- The ID of the user pool.public void setName(java.lang.String name)
The name of the user pool.
name
- The name of the user pool.public java.lang.String getName()
The name of the user pool.
public UserPoolType withName(java.lang.String name)
The name of the user pool.
name
- The name of the user pool.public void setPolicies(UserPoolPolicyType policies)
A container describing the policies associated with a user pool.
policies
- A container describing the policies associated with a user pool.public UserPoolPolicyType getPolicies()
A container describing the policies associated with a user pool.
public UserPoolType withPolicies(UserPoolPolicyType policies)
A container describing the policies associated with a user pool.
policies
- A container describing the policies associated with a user pool.public void setLambdaConfig(LambdaConfigType lambdaConfig)
A container describing the AWS Lambda triggers associated with a user pool.
lambdaConfig
- A container describing the AWS Lambda triggers associated with a
user pool.public LambdaConfigType getLambdaConfig()
A container describing the AWS Lambda triggers associated with a user pool.
public UserPoolType withLambdaConfig(LambdaConfigType lambdaConfig)
A container describing the AWS Lambda triggers associated with a user pool.
lambdaConfig
- A container describing the AWS Lambda triggers associated with a
user pool.public void setStatus(java.lang.String status)
The status of a user pool.
status
- The status of a user pool.StatusType
public java.lang.String getStatus()
The status of a user pool.
StatusType
public UserPoolType withStatus(java.lang.String status)
The status of a user pool.
status
- The status of a user pool.StatusType
public void setStatus(StatusType status)
The status of a user pool.
status
- The status of a user pool.StatusType
public UserPoolType withStatus(StatusType status)
The status of a user pool.
status
- The status of a user pool.StatusType
public void setLastModifiedDate(java.util.Date lastModifiedDate)
The last modified date of a user pool.
lastModifiedDate
- The last modified date of a user pool.public java.util.Date getLastModifiedDate()
The last modified date of a user pool.
public UserPoolType withLastModifiedDate(java.util.Date lastModifiedDate)
The last modified date of a user pool.
lastModifiedDate
- The last modified date of a user pool.public void setCreationDate(java.util.Date creationDate)
The creation date of a user pool.
creationDate
- The creation date of a user pool.public java.util.Date getCreationDate()
The creation date of a user pool.
public UserPoolType withCreationDate(java.util.Date creationDate)
The creation date of a user pool.
creationDate
- The creation date of a user pool.public java.util.List<SchemaAttributeType> getSchemaAttributes()
A container with the schema attributes of a user pool.
public void setSchemaAttributes(java.util.Collection<SchemaAttributeType> schemaAttributes)
A container with the schema attributes of a user pool.
schemaAttributes
- A container with the schema attributes of a user pool.public UserPoolType withSchemaAttributes(SchemaAttributeType... schemaAttributes)
A container with the schema attributes of a user pool.
NOTE: This method appends the values to the existing list (if
any). Use setSchemaAttributes(java.util.Collection)
or
withSchemaAttributes(java.util.Collection)
if you want to
override the existing values.
schemaAttributes
- A container with the schema attributes of a user pool.public UserPoolType withSchemaAttributes(java.util.Collection<SchemaAttributeType> schemaAttributes)
A container with the schema attributes of a user pool.
schemaAttributes
- A container with the schema attributes of a user pool.public java.util.List<java.lang.String> getAutoVerifiedAttributes()
Specifies the attributes that are auto-verified in a user pool.
VerifiedAttributeType
public void setAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
autoVerifiedAttributes
- Specifies the attributes that are auto-verified in a user pool.VerifiedAttributeType
public UserPoolType withAutoVerifiedAttributes(java.lang.String... autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
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
- Specifies the attributes that are auto-verified in a user pool.VerifiedAttributeType
public UserPoolType withAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
autoVerifiedAttributes
- Specifies the attributes that are auto-verified in a user pool.VerifiedAttributeType
public UserPoolType withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
autoVerifiedAttributes
- Specifies the attributes that are auto-verified in a user pool.VerifiedAttributeType
public java.util.List<java.lang.String> getAliasAttributes()
Specifies the attributes that are aliased in a user pool.
AliasAttributeType
public void setAliasAttributes(java.util.Collection<java.lang.String> aliasAttributes)
Specifies the attributes that are aliased in a user pool.
aliasAttributes
- Specifies the attributes that are aliased in a user pool.AliasAttributeType
public UserPoolType withAliasAttributes(java.lang.String... aliasAttributes)
Specifies the attributes that are aliased in a user pool.
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
- Specifies the attributes that are aliased in a user pool.AliasAttributeType
public UserPoolType withAliasAttributes(java.util.Collection<java.lang.String> aliasAttributes)
Specifies the attributes that are aliased in a user pool.
aliasAttributes
- Specifies the attributes that are aliased in a user pool.AliasAttributeType
public UserPoolType withAliasAttributes(AliasAttributeType... aliasAttributes)
Specifies the attributes that are aliased in a user pool.
aliasAttributes
- Specifies the attributes that are aliased in a user pool.AliasAttributeType
public void setSmsVerificationMessage(java.lang.String smsVerificationMessage)
The contents of the SMS verification message.
smsVerificationMessage
- The contents of the SMS verification message.public java.lang.String getSmsVerificationMessage()
The contents of the SMS verification message.
public UserPoolType withSmsVerificationMessage(java.lang.String smsVerificationMessage)
The contents of the SMS verification message.
smsVerificationMessage
- The contents of the SMS verification message.public void setEmailVerificationMessage(java.lang.String emailVerificationMessage)
The contents of the email verification message.
emailVerificationMessage
- The contents of the email verification message.public java.lang.String getEmailVerificationMessage()
The contents of the email verification message.
public UserPoolType withEmailVerificationMessage(java.lang.String emailVerificationMessage)
The contents of the email verification message.
emailVerificationMessage
- The contents of the email verification message.public void setEmailVerificationSubject(java.lang.String emailVerificationSubject)
The subject of the email verification message.
emailVerificationSubject
- The subject of the email verification message.public java.lang.String getEmailVerificationSubject()
The subject of the email verification message.
public UserPoolType withEmailVerificationSubject(java.lang.String emailVerificationSubject)
The subject of the email verification message.
emailVerificationSubject
- The subject of the email verification message.public void setSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage)
The contents of the SMS authentication message.
smsAuthenticationMessage
- The contents of the SMS authentication message.public java.lang.String getSmsAuthenticationMessage()
The contents of the SMS authentication message.
public UserPoolType withSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage)
The contents of the SMS authentication message.
smsAuthenticationMessage
- The contents of the SMS authentication message.public void setMfaConfiguration(java.lang.String mfaConfiguration)
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user registrations.
You can only specify required when you are initially creating a user
pool.OPTIONAL
- Users have the option when registering to
create an MFA token.mfaConfiguration
- Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user
registrations. You can only specify required when you are
initially creating a user pool.OPTIONAL
- Users have the option when registering
to create an MFA token.UserPoolMfaType
public java.lang.String getMfaConfiguration()
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user registrations.
You can only specify required when you are initially creating a user
pool.OPTIONAL
- Users have the option when registering to
create an MFA token.OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user
registrations. You can only specify required when you are
initially creating a user pool.OPTIONAL
- Users have the option when
registering to create an MFA token.UserPoolMfaType
public UserPoolType withMfaConfiguration(java.lang.String mfaConfiguration)
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user registrations.
You can only specify required when you are initially creating a user
pool.OPTIONAL
- Users have the option when registering to
create an MFA token.mfaConfiguration
- Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user
registrations. You can only specify required when you are
initially creating a user pool.OPTIONAL
- Users have the option when registering
to create an MFA token.UserPoolMfaType
public void setMfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user registrations.
You can only specify required when you are initially creating a user
pool.OPTIONAL
- Users have the option when registering to
create an MFA token.mfaConfiguration
- Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user
registrations. You can only specify required when you are
initially creating a user pool.OPTIONAL
- Users have the option when registering
to create an MFA token.UserPoolMfaType
public UserPoolType withMfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user registrations.
You can only specify required when you are initially creating a user
pool.OPTIONAL
- Users have the option when registering to
create an MFA token.mfaConfiguration
- Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user
registrations. You can only specify required when you are
initially creating a user pool.OPTIONAL
- Users have the option when registering
to create an MFA token.UserPoolMfaType
public void setEstimatedNumberOfUsers(java.lang.Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
estimatedNumberOfUsers
- A number estimating the size of the user pool.public java.lang.Integer getEstimatedNumberOfUsers()
A number estimating the size of the user pool.
public UserPoolType withEstimatedNumberOfUsers(java.lang.Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
estimatedNumberOfUsers
- A number estimating the size of the user pool.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 UserPoolType clone()
clone
in class java.lang.Object