UserPoolType (AWS SDK for Android - Amazon Cognito Identity Provider 2.16.13 API)

java.lang.Object
- com.amazonaws.services.cognitoidentityprovider.model.UserPoolType

All Implemented Interfaces:

Serializable
```
public class UserPoolType
extends Object
implements Serializable
```
A container for information about the user pool.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

UserPoolType()

Constructors
Constructor and Description
`UserPoolType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserPoolType`	`addUserPoolTagsEntry(String key, String value)` The tags that are assigned to the user pool.
`UserPoolType`	`clearUserPoolTagsEntries()` Removes all the entries added into UserPoolTags.
`boolean`	`equals(Object obj)`
`AccountRecoverySettingType`	`getAccountRecoverySetting()` Use this setting to define which verified available method a user can use to recover their password when they call `ForgotPassword`.
`AdminCreateUserConfigType`	`getAdminCreateUserConfig()` The configuration for `AdminCreateUser` requests.
`List<String>`	`getAliasAttributes()` Specifies the attributes that are aliased in a user pool.
`String`	`getArn()` The Amazon Resource Name (ARN) for the user pool.
`List<String>`	`getAutoVerifiedAttributes()` Specifies the attributes that are auto-verified in a user pool.
`Date`	`getCreationDate()` The date the user pool was created.
`String`	`getCustomDomain()` A custom domain name that you provide to Amazon Cognito.
`DeviceConfigurationType`	`getDeviceConfiguration()` The device configuration.
`String`	`getDomain()` Holds the domain prefix if the user pool has a domain associated with it.
`EmailConfigurationType`	`getEmailConfiguration()` The email configuration.
`String`	`getEmailConfigurationFailure()` The reason why the email configuration cannot send the messages to your users.
`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()` The AWS Lambda triggers associated with the user pool.
`Date`	`getLastModifiedDate()` The date the user pool was last modified.
`String`	`getMfaConfiguration()` Can be one of the following values:
`String`	`getName()` The name of the user pool.
`UserPoolPolicyType`	`getPolicies()` The policies associated with the user pool.
`List<SchemaAttributeType>`	`getSchemaAttributes()` A container with the schema attributes of a user pool.
`String`	`getSmsAuthenticationMessage()` The contents of the SMS authentication message.
`SmsConfigurationType`	`getSmsConfiguration()` The SMS configuration.
`String`	`getSmsConfigurationFailure()` The reason why the SMS configuration cannot send the messages to your users.
`String`	`getSmsVerificationMessage()` The contents of the SMS verification message.
`String`	`getStatus()` The status of a user pool.
`List<String>`	`getUsernameAttributes()` Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
`UsernameConfigurationType`	`getUsernameConfiguration()` You can choose to enable case sensitivity on the username input for the selected sign-in option.
`UserPoolAddOnsType`	`getUserPoolAddOns()` The user pool add-ons.
`Map<String,String>`	`getUserPoolTags()` The tags that are assigned to the user pool.
`VerificationMessageTemplateType`	`getVerificationMessageTemplate()` The template for verification messages.
`int`	`hashCode()`
`void`	`setAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)` Use this setting to define which verified available method a user can use to recover their password when they call `ForgotPassword`.
`void`	`setAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)` The configuration for `AdminCreateUser` requests.
`void`	`setAliasAttributes(Collection<String> aliasAttributes)` Specifies the attributes that are aliased in a user pool.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) for the user pool.
`void`	`setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)` Specifies the attributes that are auto-verified in a user pool.
`void`	`setCreationDate(Date creationDate)` The date the user pool was created.
`void`	`setCustomDomain(String customDomain)` A custom domain name that you provide to Amazon Cognito.
`void`	`setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)` The device configuration.
`void`	`setDomain(String domain)` Holds the domain prefix if the user pool has a domain associated with it.
`void`	`setEmailConfiguration(EmailConfigurationType emailConfiguration)` The email configuration.
`void`	`setEmailConfigurationFailure(String emailConfigurationFailure)` The reason why the email configuration cannot send the messages to your users.
`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)` The AWS Lambda triggers associated with the user pool.
`void`	`setLastModifiedDate(Date lastModifiedDate)` The date the user pool was last modified.
`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)` The policies associated with the 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`	`setSmsConfiguration(SmsConfigurationType smsConfiguration)` The SMS configuration.
`void`	`setSmsConfigurationFailure(String smsConfigurationFailure)` The reason why the SMS configuration cannot send the messages to your users.
`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.
`void`	`setUsernameAttributes(Collection<String> usernameAttributes)` Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
`void`	`setUsernameConfiguration(UsernameConfigurationType usernameConfiguration)` You can choose to enable case sensitivity on the username input for the selected sign-in option.
`void`	`setUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)` The user pool add-ons.
`void`	`setUserPoolTags(Map<String,String> userPoolTags)` The tags that are assigned to the user pool.
`void`	`setVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)` The template for verification messages.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UserPoolType`	`withAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)` Use this setting to define which verified available method a user can use to recover their password when they call `ForgotPassword`.
`UserPoolType`	`withAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)` The configuration for `AdminCreateUser` requests.
`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`	`withArn(String arn)` The Amazon Resource Name (ARN) for the 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`	`withCreationDate(Date creationDate)` The date the user pool was created.
`UserPoolType`	`withCustomDomain(String customDomain)` A custom domain name that you provide to Amazon Cognito.
`UserPoolType`	`withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)` The device configuration.
`UserPoolType`	`withDomain(String domain)` Holds the domain prefix if the user pool has a domain associated with it.
`UserPoolType`	`withEmailConfiguration(EmailConfigurationType emailConfiguration)` The email configuration.
`UserPoolType`	`withEmailConfigurationFailure(String emailConfigurationFailure)` The reason why the email configuration cannot send the messages to your users.
`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)` The AWS Lambda triggers associated with the user pool.
`UserPoolType`	`withLastModifiedDate(Date lastModifiedDate)` The date the user pool was last modified.
`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)` The policies associated with the 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`	`withSmsConfiguration(SmsConfigurationType smsConfiguration)` The SMS configuration.
`UserPoolType`	`withSmsConfigurationFailure(String smsConfigurationFailure)` The reason why the SMS configuration cannot send the messages to your users.
`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.
`UserPoolType`	`withUsernameAttributes(Collection<String> usernameAttributes)` Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
`UserPoolType`	`withUsernameAttributes(String... usernameAttributes)` Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
`UserPoolType`	`withUsernameConfiguration(UsernameConfigurationType usernameConfiguration)` You can choose to enable case sensitivity on the username input for the selected sign-in option.
`UserPoolType`	`withUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)` The user pool add-ons.
`UserPoolType`	`withUserPoolTags(Map<String,String> userPoolTags)` The tags that are assigned to the user pool.
`UserPoolType`	`withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)` The template for verification messages.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UserPoolType
```
public UserPoolType()
```
- Method Detail
  - getId
```
public String getId()
```
    The ID of the user pool.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Returns:
    
    The ID of the user pool.
  - setId
```
public void setId(String id)
```
    The ID of the user pool.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    id -
    The ID of the user pool.
  - withId
```
public UserPoolType withId(String id)
```
    The ID of the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    id -
    The ID of the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getName
```
public String getName()
```
    The name of the user pool.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w\s+=,.@-]+
    
    Returns:
    
    The name of the user pool.
  - setName
```
public void setName(String name)
```
    The name of the user pool.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w\s+=,.@-]+
    
    Parameters:
    
    name -
    The name of the user pool.
  - withName
```
public UserPoolType withName(String name)
```
    The name of the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w\s+=,.@-]+
    
    Parameters:
    
    name -
    The name of the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPolicies
```
public UserPoolPolicyType getPolicies()
```
    The policies associated with the user pool.
    
    Returns:
    
    The policies associated with the user pool.
  - setPolicies
```
public void setPolicies(UserPoolPolicyType policies)
```
    The policies associated with the user pool.
    
    Parameters:
    
    policies -
    The policies associated with the user pool.
  - withPolicies
```
public UserPoolType withPolicies(UserPoolPolicyType policies)
```
    The policies associated with the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    policies -
    The policies associated with the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLambdaConfig
```
public LambdaConfigType getLambdaConfig()
```
    The AWS Lambda triggers associated with the user pool.
    
    Returns:
    
    The AWS Lambda triggers associated with the user pool.
  - setLambdaConfig
```
public void setLambdaConfig(LambdaConfigType lambdaConfig)
```
    The AWS Lambda triggers associated with the user pool.
    
    Parameters:
    
    lambdaConfig -
    The AWS Lambda triggers associated with the user pool.
  - withLambdaConfig
```
public UserPoolType withLambdaConfig(LambdaConfigType lambdaConfig)
```
    The AWS Lambda triggers associated with the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    lambdaConfig -
    The AWS Lambda triggers associated with the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getStatus
```
public String getStatus()
```
    The status of a user pool.
    
    Constraints:
    Allowed Values: Enabled, Disabled
    
    Returns:
    
    The status of a user pool.
    
    See Also:
    
    StatusType
  - setStatus
```
public void setStatus(String status)
```
    The status of a user pool.
    
    Constraints:
    Allowed Values: Enabled, Disabled
    
    Parameters:
    
    status -
    The status of a user pool.
    
    See Also:
    
    StatusType
  - withStatus
```
public UserPoolType withStatus(String status)
```
    The status of a user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: Enabled, Disabled
    
    Parameters:
    
    status -
    The status of a user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    StatusType
  - setStatus
```
public void setStatus(StatusType status)
```
    The status of a user pool.
    
    Constraints:
    Allowed Values: Enabled, Disabled
    
    Parameters:
    
    status -
    The status of a user pool.
    
    See Also:
    
    StatusType
  - withStatus
```
public UserPoolType withStatus(StatusType status)
```
    The status of a user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: Enabled, Disabled
    
    Parameters:
    
    status -
    The status of a user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    StatusType
  - getLastModifiedDate
```
public Date getLastModifiedDate()
```
    The date the user pool was last modified.
    
    Returns:
    
    The date the user pool was last modified.
  - setLastModifiedDate
```
public void setLastModifiedDate(Date lastModifiedDate)
```
    The date the user pool was last modified.
    
    Parameters:
    
    lastModifiedDate -
    The date the user pool was last modified.
  - withLastModifiedDate
```
public UserPoolType withLastModifiedDate(Date lastModifiedDate)
```
    The date the user pool was last modified.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    lastModifiedDate -
    The date the user pool was last modified.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCreationDate
```
public Date getCreationDate()
```
    The date the user pool was created.
    
    Returns:
    
    The date the user pool was created.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The date the user pool was created.
    
    Parameters:
    
    creationDate -
    The date the user pool was created.
  - withCreationDate
```
public UserPoolType withCreationDate(Date creationDate)
```
    The date the user pool was created.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    creationDate -
    The date the user pool was created.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSchemaAttributes
```
public List<SchemaAttributeType> getSchemaAttributes()
```
    A container with the schema attributes of a user pool.
    
    Returns:
    
    A container with the schema attributes of a user pool.
  - setSchemaAttributes
```
public void setSchemaAttributes(Collection<SchemaAttributeType> schemaAttributes)
```
    A container with the schema attributes of a user pool.
    
    Parameters:
    
    schemaAttributes -
    A container with the schema attributes of a user pool.
  - withSchemaAttributes
```
public UserPoolType withSchemaAttributes(SchemaAttributeType... schemaAttributes)
```
    A container with the schema attributes of a user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    schemaAttributes -
    A container with the schema attributes of a user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withSchemaAttributes
```
public UserPoolType withSchemaAttributes(Collection<SchemaAttributeType> schemaAttributes)
```
    A container with the schema attributes of a user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    schemaAttributes -
    A container with the schema attributes of a user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAutoVerifiedAttributes
```
public List<String> getAutoVerifiedAttributes()
```
    Specifies the attributes that are auto-verified in a user pool.
    
    Returns:
    
    Specifies the attributes that are auto-verified in a user pool.
  - setAutoVerifiedAttributes
```
public void setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
```
    Specifies the attributes that are auto-verified in a user pool.
    
    Parameters:
    
    autoVerifiedAttributes -
    Specifies the attributes that are auto-verified in a user pool.
  - withAutoVerifiedAttributes
```
public UserPoolType withAutoVerifiedAttributes(String... autoVerifiedAttributes)
```
    Specifies the attributes that are auto-verified in a user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    autoVerifiedAttributes -
    Specifies the attributes that are auto-verified in a user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withAutoVerifiedAttributes
```
public UserPoolType withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
```
    Specifies the attributes that are auto-verified in a user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    autoVerifiedAttributes -
    Specifies the attributes that are auto-verified in a user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAliasAttributes
```
public List<String> getAliasAttributes()
```
    Specifies the attributes that are aliased in a user pool.
    
    Returns:
    
    Specifies the attributes that are aliased in a user pool.
  - setAliasAttributes
```
public void setAliasAttributes(Collection<String> aliasAttributes)
```
    Specifies the attributes that are aliased in a user pool.
    
    Parameters:
    
    aliasAttributes -
    Specifies the attributes that are aliased in a user pool.
  - withAliasAttributes
```
public UserPoolType withAliasAttributes(String... aliasAttributes)
```
    Specifies the attributes that are aliased in a user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    aliasAttributes -
    Specifies the attributes that are aliased in a user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withAliasAttributes
```
public UserPoolType withAliasAttributes(Collection<String> aliasAttributes)
```
    Specifies the attributes that are aliased in a user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    aliasAttributes -
    Specifies the attributes that are aliased in a user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUsernameAttributes
```
public List<String> getUsernameAttributes()
```
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
    
    Returns:
    
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
  - setUsernameAttributes
```
public void setUsernameAttributes(Collection<String> usernameAttributes)
```
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
    
    Parameters:
    
    usernameAttributes -
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
  - withUsernameAttributes
```
public UserPoolType withUsernameAttributes(String... usernameAttributes)
```
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    usernameAttributes -
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withUsernameAttributes
```
public UserPoolType withUsernameAttributes(Collection<String> usernameAttributes)
```
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    usernameAttributes -
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSmsVerificationMessage
```
public String getSmsVerificationMessage()
```
    The contents of the SMS verification message.
    
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Returns:
    
    The contents of the SMS verification message.
  - setSmsVerificationMessage
```
public void setSmsVerificationMessage(String smsVerificationMessage)
```
    The contents of the SMS verification message.
    
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Parameters:
    
    smsVerificationMessage -
    The contents of the SMS verification message.
  - withSmsVerificationMessage
```
public UserPoolType withSmsVerificationMessage(String smsVerificationMessage)
```
    The contents of the SMS verification message.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Parameters:
    
    smsVerificationMessage -
    The contents of the SMS verification message.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEmailVerificationMessage
```
public String getEmailVerificationMessage()
```
    The contents of the email verification message.
    
    Constraints:
    Length: 6 - 20000
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{ N}\p{P}\s*]*
    
    Returns:
    
    The contents of the email verification message.
  - setEmailVerificationMessage
```
public void setEmailVerificationMessage(String emailVerificationMessage)
```
    The contents of the email verification message.
    
    Constraints:
    Length: 6 - 20000
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{ N}\p{P}\s*]*
    
    Parameters:
    
    emailVerificationMessage -
    The contents of the email verification message.
  - withEmailVerificationMessage
```
public UserPoolType withEmailVerificationMessage(String emailVerificationMessage)
```
    The contents of the email verification message.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 6 - 20000
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{ N}\p{P}\s*]*
    
    Parameters:
    
    emailVerificationMessage -
    The contents of the email verification message.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEmailVerificationSubject
```
public String getEmailVerificationSubject()
```
    The subject of the email verification message.
    
    Constraints:
    Length: 1 - 140
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
    
    Returns:
    
    The subject of the email verification message.
  - setEmailVerificationSubject
```
public void setEmailVerificationSubject(String emailVerificationSubject)
```
    The subject of the email verification message.
    
    Constraints:
    Length: 1 - 140
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
    
    Parameters:
    
    emailVerificationSubject -
    The subject of the email verification message.
  - withEmailVerificationSubject
```
public UserPoolType withEmailVerificationSubject(String emailVerificationSubject)
```
    The subject of the email verification message.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 140
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
    
    Parameters:
    
    emailVerificationSubject -
    The subject of the email verification message.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getVerificationMessageTemplate
```
public VerificationMessageTemplateType getVerificationMessageTemplate()
```
    The template for verification messages.
    
    Returns:
    
    The template for verification messages.
  - setVerificationMessageTemplate
```
public void setVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
```
    The template for verification messages.
    
    Parameters:
    
    verificationMessageTemplate -
    The template for verification messages.
  - withVerificationMessageTemplate
```
public UserPoolType withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
```
    The template for verification messages.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    verificationMessageTemplate -
    The template for verification messages.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSmsAuthenticationMessage
```
public String getSmsAuthenticationMessage()
```
    The contents of the SMS authentication message.
    
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Returns:
    
    The contents of the SMS authentication message.
  - setSmsAuthenticationMessage
```
public void setSmsAuthenticationMessage(String smsAuthenticationMessage)
```
    The contents of the SMS authentication message.
    
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Parameters:
    
    smsAuthenticationMessage -
    The contents of the SMS authentication message.
  - withSmsAuthenticationMessage
```
public UserPoolType withSmsAuthenticationMessage(String smsAuthenticationMessage)
```
    The contents of the SMS authentication message.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Parameters:
    
    smsAuthenticationMessage -
    The contents of the SMS authentication message.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMfaConfiguration
```
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.
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    Returns:
    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.
    See Also:
    
    UserPoolMfaType
  - setMfaConfiguration
```
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.
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    Parameters:
    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.
    See Also:
    
    UserPoolMfaType
  - withMfaConfiguration
```
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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    Parameters:
    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.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType
  - setMfaConfiguration
```
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.
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    Parameters:
    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.
    See Also:
    
    UserPoolMfaType
  - withMfaConfiguration
```
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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    Parameters:
    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.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType
  - getDeviceConfiguration
```
public DeviceConfigurationType getDeviceConfiguration()
```
    The device configuration.
    
    Returns:
    
    The device configuration.
  - setDeviceConfiguration
```
public void setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
```
    The device configuration.
    
    Parameters:
    
    deviceConfiguration -
    The device configuration.
  - withDeviceConfiguration
```
public UserPoolType withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
```
    The device configuration.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    deviceConfiguration -
    The device configuration.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEstimatedNumberOfUsers
```
public Integer getEstimatedNumberOfUsers()
```
    A number estimating the size of the user pool.
    
    Returns:
    
    A number estimating the size of the user pool.
  - setEstimatedNumberOfUsers
```
public void setEstimatedNumberOfUsers(Integer estimatedNumberOfUsers)
```
    A number estimating the size of the user pool.
    
    Parameters:
    
    estimatedNumberOfUsers -
    A number estimating the size of the user pool.
  - withEstimatedNumberOfUsers
```
public UserPoolType withEstimatedNumberOfUsers(Integer estimatedNumberOfUsers)
```
    A number estimating the size of the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    estimatedNumberOfUsers -
    A number estimating the size of the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEmailConfiguration
```
public EmailConfigurationType getEmailConfiguration()
```
    The email configuration.
    
    Returns:
    
    The email configuration.
  - setEmailConfiguration
```
public void setEmailConfiguration(EmailConfigurationType emailConfiguration)
```
    The email configuration.
    
    Parameters:
    
    emailConfiguration -
    The email configuration.
  - withEmailConfiguration
```
public UserPoolType withEmailConfiguration(EmailConfigurationType emailConfiguration)
```
    The email configuration.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    emailConfiguration -
    The email configuration.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSmsConfiguration
```
public SmsConfigurationType getSmsConfiguration()
```
    The SMS configuration.
    
    Returns:
    
    The SMS configuration.
  - setSmsConfiguration
```
public void setSmsConfiguration(SmsConfigurationType smsConfiguration)
```
    The SMS configuration.
    
    Parameters:
    
    smsConfiguration -
    The SMS configuration.
  - withSmsConfiguration
```
public UserPoolType withSmsConfiguration(SmsConfigurationType smsConfiguration)
```
    The SMS configuration.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    smsConfiguration -
    The SMS configuration.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserPoolTags
```
public Map<String,String> getUserPoolTags()
```
    The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
    
    Returns:
    
    The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
  - setUserPoolTags
```
public void setUserPoolTags(Map<String,String> userPoolTags)
```
    The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
    
    Parameters:
    
    userPoolTags -
    The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
  - withUserPoolTags
```
public UserPoolType withUserPoolTags(Map<String,String> userPoolTags)
```
    The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    userPoolTags -
    The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addUserPoolTagsEntry
```
public UserPoolType addUserPoolTagsEntry(String key,
                                         String value)
```
    The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
    
    The method adds a new key-value pair into UserPoolTags parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into UserPoolTags.
    
    value - The corresponding value of the entry to be added into UserPoolTags.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearUserPoolTagsEntries
```
public UserPoolType clearUserPoolTagsEntries()
```
    Removes all the entries added into UserPoolTags.
    Returns a reference to this object so that method calls can be chained together.
  - getSmsConfigurationFailure
```
public String getSmsConfigurationFailure()
```
    The reason why the SMS configuration cannot send the messages to your users.
    
    Returns:
    
    The reason why the SMS configuration cannot send the messages to your users.
  - setSmsConfigurationFailure
```
public void setSmsConfigurationFailure(String smsConfigurationFailure)
```
    The reason why the SMS configuration cannot send the messages to your users.
    
    Parameters:
    
    smsConfigurationFailure -
    The reason why the SMS configuration cannot send the messages to your users.
  - withSmsConfigurationFailure
```
public UserPoolType withSmsConfigurationFailure(String smsConfigurationFailure)
```
    The reason why the SMS configuration cannot send the messages to your users.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    smsConfigurationFailure -
    The reason why the SMS configuration cannot send the messages to your users.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEmailConfigurationFailure
```
public String getEmailConfigurationFailure()
```
    The reason why the email configuration cannot send the messages to your users.
    
    Returns:
    
    The reason why the email configuration cannot send the messages to your users.
  - setEmailConfigurationFailure
```
public void setEmailConfigurationFailure(String emailConfigurationFailure)
```
    The reason why the email configuration cannot send the messages to your users.
    
    Parameters:
    
    emailConfigurationFailure -
    The reason why the email configuration cannot send the messages to your users.
  - withEmailConfigurationFailure
```
public UserPoolType withEmailConfigurationFailure(String emailConfigurationFailure)
```
    The reason why the email configuration cannot send the messages to your users.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    emailConfigurationFailure -
    The reason why the email configuration cannot send the messages to your users.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDomain
```
public String getDomain()
```
    Holds the domain prefix if the user pool has a domain associated with it.
    
    Constraints:
    Length: 1 - 63
    Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
    
    Returns:
    
    Holds the domain prefix if the user pool has a domain associated with it.
  - setDomain
```
public void setDomain(String domain)
```
    Holds the domain prefix if the user pool has a domain associated with it.
    
    Constraints:
    Length: 1 - 63
    Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
    
    Parameters:
    
    domain -
    Holds the domain prefix if the user pool has a domain associated with it.
  - withDomain
```
public UserPoolType withDomain(String domain)
```
    Holds the domain prefix if the user pool has a domain associated with it.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 63
    Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
    
    Parameters:
    
    domain -
    Holds the domain prefix if the user pool has a domain associated with it.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCustomDomain
```
public String getCustomDomain()
```
    A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. For example: auth.example.com.
    
    For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
    
    Constraints:
    Length: 1 - 63
    Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
    
    Returns:
    
    A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. For example: auth.example.com.
    
    For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
  - setCustomDomain
```
public void setCustomDomain(String customDomain)
```
    A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. For example: auth.example.com.
    
    For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
    
    Constraints:
    Length: 1 - 63
    Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
    
    Parameters:
    
    customDomain -
    A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. For example: auth.example.com.
    
    For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
  - withCustomDomain
```
public UserPoolType withCustomDomain(String customDomain)
```
    A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. For example: auth.example.com.
    
    For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 63
    Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
    
    Parameters:
    
    customDomain -
    A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. For example: auth.example.com.
    
    For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAdminCreateUserConfig
```
public AdminCreateUserConfigType getAdminCreateUserConfig()
```
    The configuration for AdminCreateUser requests.
    
    Returns:
    
    The configuration for AdminCreateUser requests.
  - setAdminCreateUserConfig
```
public void setAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
```
    The configuration for AdminCreateUser requests.
    
    Parameters:
    
    adminCreateUserConfig -
    The configuration for AdminCreateUser requests.
  - withAdminCreateUserConfig
```
public UserPoolType withAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
```
    The configuration for AdminCreateUser requests.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    adminCreateUserConfig -
    The configuration for AdminCreateUser requests.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserPoolAddOns
```
public UserPoolAddOnsType getUserPoolAddOns()
```
    The user pool add-ons.
    
    Returns:
    
    The user pool add-ons.
  - setUserPoolAddOns
```
public void setUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
```
    The user pool add-ons.
    
    Parameters:
    
    userPoolAddOns -
    The user pool add-ons.
  - withUserPoolAddOns
```
public UserPoolType withUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
```
    The user pool add-ons.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    userPoolAddOns -
    The user pool add-ons.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUsernameConfiguration
```
public UsernameConfigurationType getUsernameConfiguration()
```
    You can choose to enable case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see .
    
    Returns:
    
    You can choose to enable case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see .
  - setUsernameConfiguration
```
public void setUsernameConfiguration(UsernameConfigurationType usernameConfiguration)
```
    You can choose to enable case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see .
    
    Parameters:
    
    usernameConfiguration -
    You can choose to enable case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see .
  - withUsernameConfiguration
```
public UserPoolType withUsernameConfiguration(UsernameConfigurationType usernameConfiguration)
```
    You can choose to enable case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see .
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    usernameConfiguration -
    You can choose to enable case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see .
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) for the user pool.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
    
    Returns:
    
    The Amazon Resource Name (ARN) for the user pool.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) for the user pool.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
    
    Parameters:
    
    arn -
    The Amazon Resource Name (ARN) for the user pool.
  - withArn
```
public UserPoolType withArn(String arn)
```
    The Amazon Resource Name (ARN) for the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
    
    Parameters:
    
    arn -
    The Amazon Resource Name (ARN) for the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAccountRecoverySetting
```
public AccountRecoverySettingType getAccountRecoverySetting()
```
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
    
    Returns:
    
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
  - setAccountRecoverySetting
```
public void setAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
```
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
    
    Parameters:
    
    accountRecoverySetting -
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
  - withAccountRecoverySetting
```
public UserPoolType withAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
```
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    accountRecoverySetting -
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
    
    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

Class UserPoolType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserPoolType

Method Detail

getId

setId

withId

getName

setName

withName

getPolicies

setPolicies

withPolicies

getLambdaConfig

setLambdaConfig

withLambdaConfig

getStatus

setStatus

withStatus

setStatus

withStatus

getLastModifiedDate

setLastModifiedDate

withLastModifiedDate

getCreationDate

setCreationDate

withCreationDate

getSchemaAttributes

setSchemaAttributes

withSchemaAttributes

withSchemaAttributes

getAutoVerifiedAttributes

setAutoVerifiedAttributes

withAutoVerifiedAttributes

withAutoVerifiedAttributes

getAliasAttributes

setAliasAttributes

withAliasAttributes

withAliasAttributes

getUsernameAttributes

setUsernameAttributes

withUsernameAttributes

withUsernameAttributes

getSmsVerificationMessage

setSmsVerificationMessage

withSmsVerificationMessage

getEmailVerificationMessage

setEmailVerificationMessage

withEmailVerificationMessage

getEmailVerificationSubject

setEmailVerificationSubject

withEmailVerificationSubject

getVerificationMessageTemplate

setVerificationMessageTemplate

withVerificationMessageTemplate

getSmsAuthenticationMessage

setSmsAuthenticationMessage

withSmsAuthenticationMessage

getMfaConfiguration

setMfaConfiguration

withMfaConfiguration

setMfaConfiguration

withMfaConfiguration

getDeviceConfiguration

setDeviceConfiguration

withDeviceConfiguration

getEstimatedNumberOfUsers

setEstimatedNumberOfUsers

withEstimatedNumberOfUsers

getEmailConfiguration

setEmailConfiguration

withEmailConfiguration

getSmsConfiguration

setSmsConfiguration

withSmsConfiguration

getUserPoolTags

setUserPoolTags