public class UserPoolType extends Object implements Serializable, Cloneable
A container with information about the user pool type.
Constructor and Description |
---|
UserPoolType() |
Modifier and Type | Method and Description |
---|---|
UserPoolType |
clone() |
boolean |
equals(Object obj) |
List<String> |
getAliasAttributes()
Specifies the attributes that are aliased in a user pool.
|
List<String> |
getAutoVerifiedAttributes()
Specifies the attributes that are auto-verified in a user pool.
|
Date |
getCreationDate()
The creation date of a user pool.
|
String |
getEmailVerificationMessage()
The contents of the email verification message.
|
String |
getEmailVerificationSubject()
The subject of the email verification message.
|
Integer |
getEstimatedNumberOfUsers()
A number estimating the size of the user pool.
|
String |
getId()
The ID of the user pool.
|
LambdaConfigType |
getLambdaConfig()
A container describing the AWS Lambda triggers associated with a user
pool.
|
Date |
getLastModifiedDate()
The last modified date of a user pool.
|
String |
getMfaConfiguration()
Can be one of the following values:
|
String |
getName()
The name of the user pool.
|
UserPoolPolicyType |
getPolicies()
A container describing the policies associated with a user pool.
|
List<SchemaAttributeType> |
getSchemaAttributes()
A container with the schema attributes of a user pool.
|
String |
getSmsAuthenticationMessage()
The contents of the SMS authentication message.
|
String |
getSmsVerificationMessage()
The contents of the SMS verification message.
|
String |
getStatus()
The status of a user pool.
|
int |
hashCode() |
void |
setAliasAttributes(Collection<String> aliasAttributes)
Specifies the attributes that are aliased in a user pool.
|
void |
setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
|
void |
setCreationDate(Date creationDate)
The creation date of a user pool.
|
void |
setEmailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.
|
void |
setEmailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.
|
void |
setEstimatedNumberOfUsers(Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
|
void |
setId(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(Date lastModifiedDate)
The last modified date of a user pool.
|
void |
setMfaConfiguration(String mfaConfiguration)
Can be one of the following values:
|
void |
setMfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:
|
void |
setName(String name)
The name of the user pool.
|
void |
setPolicies(UserPoolPolicyType policies)
A container describing the policies associated with a user pool.
|
void |
setSchemaAttributes(Collection<SchemaAttributeType> schemaAttributes)
A container with the schema attributes of a user pool.
|
void |
setSmsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.
|
void |
setSmsVerificationMessage(String smsVerificationMessage)
The contents of the SMS verification message.
|
void |
setStatus(StatusType status)
The status of a user pool.
|
void |
setStatus(String status)
The status of a user pool.
|
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(Collection<String> aliasAttributes)
Specifies the attributes that are aliased in a user pool.
|
UserPoolType |
withAliasAttributes(String... aliasAttributes)
Specifies the attributes that are aliased in a user pool.
|
UserPoolType |
withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
|
UserPoolType |
withAutoVerifiedAttributes(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(Date creationDate)
The creation date of a user pool.
|
UserPoolType |
withEmailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.
|
UserPoolType |
withEmailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.
|
UserPoolType |
withEstimatedNumberOfUsers(Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
|
UserPoolType |
withId(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(Date lastModifiedDate)
The last modified date of a user pool.
|
UserPoolType |
withMfaConfiguration(String mfaConfiguration)
Can be one of the following values:
|
UserPoolType |
withMfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:
|
UserPoolType |
withName(String name)
The name of the user pool.
|
UserPoolType |
withPolicies(UserPoolPolicyType policies)
A container describing the policies associated with a user pool.
|
UserPoolType |
withSchemaAttributes(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(String smsAuthenticationMessage)
The contents of the SMS authentication message.
|
UserPoolType |
withSmsVerificationMessage(String smsVerificationMessage)
The contents of the SMS verification message.
|
UserPoolType |
withStatus(StatusType status)
The status of a user pool.
|
UserPoolType |
withStatus(String status)
The status of a user pool.
|
public void setId(String id)
The ID of the user pool.
id
- The ID of the user pool.public String getId()
The ID of the user pool.
public UserPoolType withId(String id)
The ID of the user pool.
id
- The ID of the user pool.public void setName(String name)
The name of the user pool.
name
- The name of the user pool.public String getName()
The name of the user pool.
public UserPoolType withName(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(String status)
The status of a user pool.
status
- The status of a user pool.StatusType
public String getStatus()
The status of a user pool.
StatusType
public UserPoolType withStatus(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(Date lastModifiedDate)
The last modified date of a user pool.
lastModifiedDate
- The last modified date of a user pool.public Date getLastModifiedDate()
The last modified date of a user pool.
public UserPoolType withLastModifiedDate(Date lastModifiedDate)
The last modified date of a user pool.
lastModifiedDate
- The last modified date of a user pool.public void setCreationDate(Date creationDate)
The creation date of a user pool.
creationDate
- The creation date of a user pool.public Date getCreationDate()
The creation date of a user pool.
public UserPoolType withCreationDate(Date creationDate)
The creation date of a user pool.
creationDate
- The creation date of a user pool.public List<SchemaAttributeType> getSchemaAttributes()
A container with the schema attributes of a user pool.
public void setSchemaAttributes(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(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 List<String> getAutoVerifiedAttributes()
Specifies the attributes that are auto-verified in a user pool.
VerifiedAttributeType
public void setAutoVerifiedAttributes(Collection<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(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(Collection<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 List<String> getAliasAttributes()
Specifies the attributes that are aliased in a user pool.
AliasAttributeType
public void setAliasAttributes(Collection<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(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(Collection<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(String smsVerificationMessage)
The contents of the SMS verification message.
smsVerificationMessage
- The contents of the SMS verification message.public String getSmsVerificationMessage()
The contents of the SMS verification message.
public UserPoolType withSmsVerificationMessage(String smsVerificationMessage)
The contents of the SMS verification message.
smsVerificationMessage
- The contents of the SMS verification message.public void setEmailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.
emailVerificationMessage
- The contents of the email verification message.public String getEmailVerificationMessage()
The contents of the email verification message.
public UserPoolType withEmailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.
emailVerificationMessage
- The contents of the email verification message.public void setEmailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.
emailVerificationSubject
- The subject of the email verification message.public String getEmailVerificationSubject()
The subject of the email verification message.
public UserPoolType withEmailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.
emailVerificationSubject
- The subject of the email verification message.public void setSmsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.
smsAuthenticationMessage
- The contents of the SMS authentication message.public String getSmsAuthenticationMessage()
The contents of the SMS authentication message.
public UserPoolType withSmsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.
smsAuthenticationMessage
- The contents of the SMS authentication message.public void setMfaConfiguration(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 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(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(Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
estimatedNumberOfUsers
- A number estimating the size of the user pool.public Integer getEstimatedNumberOfUsers()
A number estimating the size of the user pool.
public UserPoolType withEstimatedNumberOfUsers(Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
estimatedNumberOfUsers
- A number estimating the size of the user pool.public String toString()
toString
in class Object
Object.toString()
public UserPoolType clone()
Copyright © 2018. All rights reserved.