CreateUserPoolRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidp.model.CreateUserPoolRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateUserPoolRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Represents the request to create a user pool.

See Also:

AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateUserPoolRequest()

Constructors
Constructor and Description
`CreateUserPoolRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateUserPoolRequest`	`addUserPoolTagsEntry(String key, String value)` Add a single UserPoolTags entry
`CreateUserPoolRequest`	`clearUserPoolTagsEntries()` Removes all the entries added into UserPoolTags.
`CreateUserPoolRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`AccountRecoverySettingType`	`getAccountRecoverySetting()` The available verified method a user can use to recover their password when they call `ForgotPassword` .
`AdminCreateUserConfigType`	`getAdminCreateUserConfig()` The configuration for `AdminCreateUser` requests.
`List<String>`	`getAliasAttributes()` Attributes supported as an alias for this user pool.
`List<String>`	`getAutoVerifiedAttributes()` The attributes to be auto-verified.
`String`	`getDeletionProtection()` When active, `DeletionProtection` prevents accidental deletion of your user pool.
`DeviceConfigurationType`	`getDeviceConfiguration()` The device-remembering configuration for a user pool.
`EmailConfigurationType`	`getEmailConfiguration()` The email configuration of your user pool.
`String`	`getEmailVerificationMessage()` This parameter is no longer used.
`String`	`getEmailVerificationSubject()` This parameter is no longer used.
`LambdaConfigType`	`getLambdaConfig()` The Lambda trigger configuration information for the new user pool.
`String`	`getMfaConfiguration()` Specifies MFA configuration details.
`UserPoolPolicyType`	`getPolicies()` The policies associated with the new user pool.
`String`	`getPoolName()` A string used to name the user pool.
`List<SchemaAttributeType>`	`getSchema()` An array of schema attributes for the new user pool.
`String`	`getSmsAuthenticationMessage()` A string representing the SMS authentication message.
`SmsConfigurationType`	`getSmsConfiguration()` The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service.
`String`	`getSmsVerificationMessage()` This parameter is no longer used.
`UserAttributeUpdateSettingsType`	`getUserAttributeUpdateSettings()` The settings for updates to user attributes.
`List<String>`	`getUsernameAttributes()` Specifies whether a user can use an email address or phone number as a username when they sign up.
`UsernameConfigurationType`	`getUsernameConfiguration()` Case sensitivity on the username input for the selected sign-in option.
`UserPoolAddOnsType`	`getUserPoolAddOns()` User pool add-ons.
`Map<String,String>`	`getUserPoolTags()` The tag keys and values to assign to the user pool.
`VerificationMessageTemplateType`	`getVerificationMessageTemplate()` The template for the verification message that the user sees when the app requests permission to access the user's information.
`int`	`hashCode()`
`void`	`setAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)` The available verified 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)` Attributes supported as an alias for this user pool.
`void`	`setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)` The attributes to be auto-verified.
`void`	`setDeletionProtection(DeletionProtectionType deletionProtection)` When active, `DeletionProtection` prevents accidental deletion of your user pool.
`void`	`setDeletionProtection(String deletionProtection)` When active, `DeletionProtection` prevents accidental deletion of your user pool.
`void`	`setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)` The device-remembering configuration for a user pool.
`void`	`setEmailConfiguration(EmailConfigurationType emailConfiguration)` The email configuration of your user pool.
`void`	`setEmailVerificationMessage(String emailVerificationMessage)` This parameter is no longer used.
`void`	`setEmailVerificationSubject(String emailVerificationSubject)` This parameter is no longer used.
`void`	`setLambdaConfig(LambdaConfigType lambdaConfig)` The Lambda trigger configuration information for the new user pool.
`void`	`setMfaConfiguration(String mfaConfiguration)` Specifies MFA configuration details.
`void`	`setMfaConfiguration(UserPoolMfaType mfaConfiguration)` Specifies MFA configuration details.
`void`	`setPolicies(UserPoolPolicyType policies)` The policies associated with the new user pool.
`void`	`setPoolName(String poolName)` A string used to name the user pool.
`void`	`setSchema(Collection<SchemaAttributeType> schema)` An array of schema attributes for the new user pool.
`void`	`setSmsAuthenticationMessage(String smsAuthenticationMessage)` A string representing the SMS authentication message.
`void`	`setSmsConfiguration(SmsConfigurationType smsConfiguration)` The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service.
`void`	`setSmsVerificationMessage(String smsVerificationMessage)` This parameter is no longer used.
`void`	`setUserAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)` The settings for updates to user attributes.
`void`	`setUsernameAttributes(Collection<String> usernameAttributes)` Specifies whether a user can use an email address or phone number as a username when they sign up.
`void`	`setUsernameConfiguration(UsernameConfigurationType usernameConfiguration)` Case sensitivity on the username input for the selected sign-in option.
`void`	`setUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)` User pool add-ons.
`void`	`setUserPoolTags(Map<String,String> userPoolTags)` The tag keys and values to assign to the user pool.
`void`	`setVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)` The template for the verification message that the user sees when the app requests permission to access the user's information.
`String`	`toString()` Returns a string representation of this object.
`CreateUserPoolRequest`	`withAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)` The available verified method a user can use to recover their password when they call `ForgotPassword` .
`CreateUserPoolRequest`	`withAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)` The configuration for `AdminCreateUser` requests.
`CreateUserPoolRequest`	`withAliasAttributes(AliasAttributeType... aliasAttributes)` Attributes supported as an alias for this user pool.
`CreateUserPoolRequest`	`withAliasAttributes(Collection<String> aliasAttributes)` Attributes supported as an alias for this user pool.
`CreateUserPoolRequest`	`withAliasAttributes(String... aliasAttributes)` Attributes supported as an alias for this user pool.
`CreateUserPoolRequest`	`withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)` The attributes to be auto-verified.
`CreateUserPoolRequest`	`withAutoVerifiedAttributes(String... autoVerifiedAttributes)` The attributes to be auto-verified.
`CreateUserPoolRequest`	`withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)` The attributes to be auto-verified.
`CreateUserPoolRequest`	`withDeletionProtection(DeletionProtectionType deletionProtection)` When active, `DeletionProtection` prevents accidental deletion of your user pool.
`CreateUserPoolRequest`	`withDeletionProtection(String deletionProtection)` When active, `DeletionProtection` prevents accidental deletion of your user pool.
`CreateUserPoolRequest`	`withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)` The device-remembering configuration for a user pool.
`CreateUserPoolRequest`	`withEmailConfiguration(EmailConfigurationType emailConfiguration)` The email configuration of your user pool.
`CreateUserPoolRequest`	`withEmailVerificationMessage(String emailVerificationMessage)` This parameter is no longer used.
`CreateUserPoolRequest`	`withEmailVerificationSubject(String emailVerificationSubject)` This parameter is no longer used.
`CreateUserPoolRequest`	`withLambdaConfig(LambdaConfigType lambdaConfig)` The Lambda trigger configuration information for the new user pool.
`CreateUserPoolRequest`	`withMfaConfiguration(String mfaConfiguration)` Specifies MFA configuration details.
`CreateUserPoolRequest`	`withMfaConfiguration(UserPoolMfaType mfaConfiguration)` Specifies MFA configuration details.
`CreateUserPoolRequest`	`withPolicies(UserPoolPolicyType policies)` The policies associated with the new user pool.
`CreateUserPoolRequest`	`withPoolName(String poolName)` A string used to name the user pool.
`CreateUserPoolRequest`	`withSchema(Collection<SchemaAttributeType> schema)` An array of schema attributes for the new user pool.
`CreateUserPoolRequest`	`withSchema(SchemaAttributeType... schema)` An array of schema attributes for the new user pool.
`CreateUserPoolRequest`	`withSmsAuthenticationMessage(String smsAuthenticationMessage)` A string representing the SMS authentication message.
`CreateUserPoolRequest`	`withSmsConfiguration(SmsConfigurationType smsConfiguration)` The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service.
`CreateUserPoolRequest`	`withSmsVerificationMessage(String smsVerificationMessage)` This parameter is no longer used.
`CreateUserPoolRequest`	`withUserAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)` The settings for updates to user attributes.
`CreateUserPoolRequest`	`withUsernameAttributes(Collection<String> usernameAttributes)` Specifies whether a user can use an email address or phone number as a username when they sign up.
`CreateUserPoolRequest`	`withUsernameAttributes(String... usernameAttributes)` Specifies whether a user can use an email address or phone number as a username when they sign up.
`CreateUserPoolRequest`	`withUsernameAttributes(UsernameAttributeType... usernameAttributes)` Specifies whether a user can use an email address or phone number as a username when they sign up.
`CreateUserPoolRequest`	`withUsernameConfiguration(UsernameConfigurationType usernameConfiguration)` Case sensitivity on the username input for the selected sign-in option.
`CreateUserPoolRequest`	`withUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)` User pool add-ons.
`CreateUserPoolRequest`	`withUserPoolTags(Map<String,String> userPoolTags)` The tag keys and values to assign to the user pool.
`CreateUserPoolRequest`	`withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)` The template for the verification message that the user sees when the app requests permission to access the user's information.

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

- Constructor Detail
  - CreateUserPoolRequest
```
public CreateUserPoolRequest()
```
- Method Detail
  - setPoolName
```
public void setPoolName(String poolName)
```
    A string used to name the user pool.
    
    Parameters:
    
    poolName - A string used to name the user pool.
  - getPoolName
```
public String getPoolName()
```
    A string used to name the user pool.
    
    Returns:
    
    A string used to name the user pool.
  - withPoolName
```
public CreateUserPoolRequest withPoolName(String poolName)
```
    A string used to name the user pool.
    
    Parameters:
    
    poolName - A string used to name the user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicies
```
public void setPolicies(UserPoolPolicyType policies)
```
    The policies associated with the new user pool.
    
    Parameters:
    
    policies - The policies associated with the new user pool.
  - getPolicies
```
public UserPoolPolicyType getPolicies()
```
    The policies associated with the new user pool.
    
    Returns:
    
    The policies associated with the new user pool.
  - withPolicies
```
public CreateUserPoolRequest withPolicies(UserPoolPolicyType policies)
```
    The policies associated with the new user pool.
    
    Parameters:
    
    policies - The policies associated with the new user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeletionProtection
```
public void setDeletionProtection(String deletionProtection)
```
    When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    Parameters:
    
    deletionProtection - When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    See Also:
    
    DeletionProtectionType
  - getDeletionProtection
```
public String getDeletionProtection()
```
    When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    Returns:
    
    When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    See Also:
    
    DeletionProtectionType
  - withDeletionProtection
```
public CreateUserPoolRequest withDeletionProtection(String deletionProtection)
```
    When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    Parameters:
    
    deletionProtection - When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeletionProtectionType
  - setDeletionProtection
```
public void setDeletionProtection(DeletionProtectionType deletionProtection)
```
    When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    Parameters:
    
    deletionProtection - When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    See Also:
    
    DeletionProtectionType
  - withDeletionProtection
```
public CreateUserPoolRequest withDeletionProtection(DeletionProtectionType deletionProtection)
```
    When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    Parameters:
    
    deletionProtection - When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeletionProtectionType
  - setLambdaConfig
```
public void setLambdaConfig(LambdaConfigType lambdaConfig)
```
    The Lambda trigger configuration information for the new user pool.
    
    In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.
    
    For more information on using the Lambda API to add permission, see AddPermission .
    
    For adding permission using the CLI, see add-permission .
    
    Parameters:
    
    lambdaConfig - The Lambda trigger configuration information for the new user pool.
    
    In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.
    
    For more information on using the Lambda API to add permission, see AddPermission .
    
    For adding permission using the CLI, see add-permission .
  - getLambdaConfig
```
public LambdaConfigType getLambdaConfig()
```
    The Lambda trigger configuration information for the new user pool.
    
    In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.
    
    For more information on using the Lambda API to add permission, see AddPermission .
    
    For adding permission using the CLI, see add-permission .
    
    Returns:
    
    The Lambda trigger configuration information for the new user pool.
    
    In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.
    
    For more information on using the Lambda API to add permission, see AddPermission .
    
    For adding permission using the CLI, see add-permission .
  - withLambdaConfig
```
public CreateUserPoolRequest withLambdaConfig(LambdaConfigType lambdaConfig)
```
    The Lambda trigger configuration information for the new user pool.
    
    In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.
    
    For more information on using the Lambda API to add permission, see AddPermission .
    
    For adding permission using the CLI, see add-permission .
    
    Parameters:
    
    lambdaConfig - The Lambda trigger configuration information for the new user pool.
    
    In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.
    
    For more information on using the Lambda API to add permission, see AddPermission .
    
    For adding permission using the CLI, see add-permission .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAutoVerifiedAttributes
```
public List<String> getAutoVerifiedAttributes()
```
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    Returns:
    
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    See Also:
    
    VerifiedAttributeType
  - setAutoVerifiedAttributes
```
public void setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
```
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.
    
    See Also:
    
    VerifiedAttributeType
  - withAutoVerifiedAttributes
```
public CreateUserPoolRequest withAutoVerifiedAttributes(String... autoVerifiedAttributes)
```
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    NOTE: This method appends the values to the existing list (if any). Use setAutoVerifiedAttributes(java.util.Collection) or withAutoVerifiedAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerifiedAttributeType
  - withAutoVerifiedAttributes
```
public CreateUserPoolRequest withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
```
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerifiedAttributeType
  - withAutoVerifiedAttributes
```
public CreateUserPoolRequest withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
```
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerifiedAttributeType
  - getAliasAttributes
```
public List<String> getAliasAttributes()
```
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Returns:
    
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    See Also:
    
    AliasAttributeType
  - setAliasAttributes
```
public void setAliasAttributes(Collection<String> aliasAttributes)
```
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Parameters:
    
    aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    See Also:
    
    AliasAttributeType
  - withAliasAttributes
```
public CreateUserPoolRequest withAliasAttributes(String... aliasAttributes)
```
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    NOTE: This method appends the values to the existing list (if any). Use setAliasAttributes(java.util.Collection) or withAliasAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AliasAttributeType
  - withAliasAttributes
```
public CreateUserPoolRequest withAliasAttributes(Collection<String> aliasAttributes)
```
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Parameters:
    
    aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AliasAttributeType
  - withAliasAttributes
```
public CreateUserPoolRequest withAliasAttributes(AliasAttributeType... aliasAttributes)
```
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Parameters:
    
    aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AliasAttributeType
  - getUsernameAttributes
```
public List<String> getUsernameAttributes()
```
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    
    Returns:
    
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    
    See Also:
    
    UsernameAttributeType
  - setUsernameAttributes
```
public void setUsernameAttributes(Collection<String> usernameAttributes)
```
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    
    Parameters:
    
    usernameAttributes - Specifies whether a user can use an email address or phone number as a username when they sign up.
    
    See Also:
    
    UsernameAttributeType
  - withUsernameAttributes
```
public CreateUserPoolRequest withUsernameAttributes(String... usernameAttributes)
```
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    
    NOTE: This method appends the values to the existing list (if any). Use setUsernameAttributes(java.util.Collection) or withUsernameAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    usernameAttributes - Specifies whether a user can use an email address or phone number as a username when they sign up.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UsernameAttributeType
  - withUsernameAttributes
```
public CreateUserPoolRequest withUsernameAttributes(Collection<String> usernameAttributes)
```
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    
    Parameters:
    
    usernameAttributes - Specifies whether a user can use an email address or phone number as a username when they sign up.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UsernameAttributeType
  - withUsernameAttributes
```
public CreateUserPoolRequest withUsernameAttributes(UsernameAttributeType... usernameAttributes)
```
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    
    Parameters:
    
    usernameAttributes - Specifies whether a user can use an email address or phone number as a username when they sign up.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UsernameAttributeType
  - setSmsVerificationMessage
```
public void setSmsVerificationMessage(String smsVerificationMessage)
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Parameters:
    
    smsVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.
  - getSmsVerificationMessage
```
public String getSmsVerificationMessage()
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Returns:
    
    This parameter is no longer used. See VerificationMessageTemplateType.
  - withSmsVerificationMessage
```
public CreateUserPoolRequest withSmsVerificationMessage(String smsVerificationMessage)
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Parameters:
    
    smsVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmailVerificationMessage
```
public void setEmailVerificationMessage(String emailVerificationMessage)
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Parameters:
    
    emailVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.
  - getEmailVerificationMessage
```
public String getEmailVerificationMessage()
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Returns:
    
    This parameter is no longer used. See VerificationMessageTemplateType.
  - withEmailVerificationMessage
```
public CreateUserPoolRequest withEmailVerificationMessage(String emailVerificationMessage)
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Parameters:
    
    emailVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmailVerificationSubject
```
public void setEmailVerificationSubject(String emailVerificationSubject)
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Parameters:
    
    emailVerificationSubject - This parameter is no longer used. See VerificationMessageTemplateType.
  - getEmailVerificationSubject
```
public String getEmailVerificationSubject()
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Returns:
    
    This parameter is no longer used. See VerificationMessageTemplateType.
  - withEmailVerificationSubject
```
public CreateUserPoolRequest withEmailVerificationSubject(String emailVerificationSubject)
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Parameters:
    
    emailVerificationSubject - This parameter is no longer used. See VerificationMessageTemplateType.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVerificationMessageTemplate
```
public void setVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
```
    The template for the verification message that the user sees when the app requests permission to access the user's information.
    
    Parameters:
    
    verificationMessageTemplate - The template for the verification message that the user sees when the app requests permission to access the user's information.
  - getVerificationMessageTemplate
```
public VerificationMessageTemplateType getVerificationMessageTemplate()
```
    The template for the verification message that the user sees when the app requests permission to access the user's information.
    
    Returns:
    
    The template for the verification message that the user sees when the app requests permission to access the user's information.
  - withVerificationMessageTemplate
```
public CreateUserPoolRequest withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
```
    The template for the verification message that the user sees when the app requests permission to access the user's information.
    
    Parameters:
    
    verificationMessageTemplate - The template for the verification message that the user sees when the app requests permission to access the user's information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSmsAuthenticationMessage
```
public void setSmsAuthenticationMessage(String smsAuthenticationMessage)
```
    A string representing the SMS authentication message.
    
    Parameters:
    
    smsAuthenticationMessage - A string representing the SMS authentication message.
  - getSmsAuthenticationMessage
```
public String getSmsAuthenticationMessage()
```
    A string representing the SMS authentication message.
    
    Returns:
    
    A string representing the SMS authentication message.
  - withSmsAuthenticationMessage
```
public CreateUserPoolRequest withSmsAuthenticationMessage(String smsAuthenticationMessage)
```
    A string representing the SMS authentication message.
    
    Parameters:
    
    smsAuthenticationMessage - A string representing the SMS authentication message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMfaConfiguration
```
public void setMfaConfiguration(String mfaConfiguration)
```
    Specifies MFA configuration details.
    
    Parameters:
    
    mfaConfiguration - Specifies MFA configuration details.
    
    See Also:
    
    UserPoolMfaType
  - getMfaConfiguration
```
public String getMfaConfiguration()
```
    Specifies MFA configuration details.
    
    Returns:
    
    Specifies MFA configuration details.
    
    See Also:
    
    UserPoolMfaType
  - withMfaConfiguration
```
public CreateUserPoolRequest withMfaConfiguration(String mfaConfiguration)
```
    Specifies MFA configuration details.
    
    Parameters:
    
    mfaConfiguration - Specifies MFA configuration details.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType
  - setMfaConfiguration
```
public void setMfaConfiguration(UserPoolMfaType mfaConfiguration)
```
    Specifies MFA configuration details.
    
    Parameters:
    
    mfaConfiguration - Specifies MFA configuration details.
    
    See Also:
    
    UserPoolMfaType
  - withMfaConfiguration
```
public CreateUserPoolRequest withMfaConfiguration(UserPoolMfaType mfaConfiguration)
```
    Specifies MFA configuration details.
    
    Parameters:
    
    mfaConfiguration - Specifies MFA configuration details.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType
  - setUserAttributeUpdateSettings
```
public void setUserAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)
```
    The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
    
    Parameters:
    
    userAttributeUpdateSettings - The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
  - getUserAttributeUpdateSettings
```
public UserAttributeUpdateSettingsType getUserAttributeUpdateSettings()
```
    The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
    
    Returns:
    
    The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
  - withUserAttributeUpdateSettings
```
public CreateUserPoolRequest withUserAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)
```
    The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
    
    Parameters:
    
    userAttributeUpdateSettings - The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeviceConfiguration
```
public void setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
```
    The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
    
    When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
    
    Parameters:
    
    deviceConfiguration - The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
    
    When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
  - getDeviceConfiguration
```
public DeviceConfigurationType getDeviceConfiguration()
```
    The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
    
    When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
    
    Returns:
    
    The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
    
    When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
  - withDeviceConfiguration
```
public CreateUserPoolRequest withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
```
    The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
    
    When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
    
    Parameters:
    
    deviceConfiguration - The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
    
    When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmailConfiguration
```
public void setEmailConfiguration(EmailConfigurationType emailConfiguration)
```
    The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
    
    Parameters:
    
    emailConfiguration - The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
  - getEmailConfiguration
```
public EmailConfigurationType getEmailConfiguration()
```
    The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
    
    Returns:
    
    The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
  - withEmailConfiguration
```
public CreateUserPoolRequest withEmailConfiguration(EmailConfigurationType emailConfiguration)
```
    The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
    
    Parameters:
    
    emailConfiguration - The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSmsConfiguration
```
public void setSmsConfiguration(SmsConfigurationType smsConfiguration)
```
    The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
    
    Parameters:
    
    smsConfiguration - The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
  - getSmsConfiguration
```
public SmsConfigurationType getSmsConfiguration()
```
    The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
    
    Returns:
    
    The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
  - withSmsConfiguration
```
public CreateUserPoolRequest withSmsConfiguration(SmsConfigurationType smsConfiguration)
```
    The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
    
    Parameters:
    
    smsConfiguration - The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUserPoolTags
```
public Map<String,String> getUserPoolTags()
```
    The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
    
    Returns:
    
    The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
  - setUserPoolTags
```
public void setUserPoolTags(Map<String,String> userPoolTags)
```
    The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
    
    Parameters:
    
    userPoolTags - The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
  - withUserPoolTags
```
public CreateUserPoolRequest withUserPoolTags(Map<String,String> userPoolTags)
```
    The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
    
    Parameters:
    
    userPoolTags - The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addUserPoolTagsEntry
```
public CreateUserPoolRequest addUserPoolTagsEntry(String key,
                                                  String value)
```
    Add a single UserPoolTags entry
    
    See Also:
    
    withUserPoolTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearUserPoolTagsEntries
```
public CreateUserPoolRequest clearUserPoolTagsEntries()
```
    Removes all the entries added into UserPoolTags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAdminCreateUserConfig
```
public void setAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
```
    The configuration for AdminCreateUser requests.
    
    Parameters:
    
    adminCreateUserConfig - The configuration for AdminCreateUser requests.
  - getAdminCreateUserConfig
```
public AdminCreateUserConfigType getAdminCreateUserConfig()
```
    The configuration for AdminCreateUser requests.
    
    Returns:
    
    The configuration for AdminCreateUser requests.
  - withAdminCreateUserConfig
```
public CreateUserPoolRequest withAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
```
    The configuration for AdminCreateUser requests.
    
    Parameters:
    
    adminCreateUserConfig - The configuration for AdminCreateUser requests.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSchema
```
public List<SchemaAttributeType> getSchema()
```
    An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
    
    Returns:
    
    An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
  - setSchema
```
public void setSchema(Collection<SchemaAttributeType> schema)
```
    An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
    
    Parameters:
    
    schema - An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
  - withSchema
```
public CreateUserPoolRequest withSchema(SchemaAttributeType... schema)
```
    An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
    
    NOTE: This method appends the values to the existing list (if any). Use setSchema(java.util.Collection) or withSchema(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    schema - An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSchema
```
public CreateUserPoolRequest withSchema(Collection<SchemaAttributeType> schema)
```
    An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
    
    Parameters:
    
    schema - An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserPoolAddOns
```
public void setUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
```
    User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
    
    For more information, see Adding advanced security to a user pool.
    
    Parameters:
    
    userPoolAddOns - User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
    
    For more information, see Adding advanced security to a user pool.
  - getUserPoolAddOns
```
public UserPoolAddOnsType getUserPoolAddOns()
```
    User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
    
    For more information, see Adding advanced security to a user pool.
    
    Returns:
    
    User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
    
    For more information, see Adding advanced security to a user pool.
  - withUserPoolAddOns
```
public CreateUserPoolRequest withUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
```
    User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
    
    For more information, see Adding advanced security to a user pool.
    
    Parameters:
    
    userPoolAddOns - User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
    
    For more information, see Adding advanced security to a user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUsernameConfiguration
```
public void setUsernameConfiguration(UsernameConfigurationType usernameConfiguration)
```
    Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to False (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username, USERNAME, or UserName, or for email, email@example.com or EMaiL@eXamplE.Com. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.
    
    This configuration is immutable after you set it. For more information, see UsernameConfigurationType.
    
    Parameters:
    
    usernameConfiguration - Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to False (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username, USERNAME, or UserName, or for email, email@example.com or EMaiL@eXamplE.Com. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.
    
    This configuration is immutable after you set it. For more information, see UsernameConfigurationType.
  - getUsernameConfiguration
```
public UsernameConfigurationType getUsernameConfiguration()
```
    Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to False (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username, USERNAME, or UserName, or for email, email@example.com or EMaiL@eXamplE.Com. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.
    
    This configuration is immutable after you set it. For more information, see UsernameConfigurationType.
    
    Returns:
    
    Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to False (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username, USERNAME, or UserName, or for email, email@example.com or EMaiL@eXamplE.Com. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.
    
    This configuration is immutable after you set it. For more information, see UsernameConfigurationType.
  - withUsernameConfiguration
```
public CreateUserPoolRequest withUsernameConfiguration(UsernameConfigurationType usernameConfiguration)
```
    Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to False (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username, USERNAME, or UserName, or for email, email@example.com or EMaiL@eXamplE.Com. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.
    
    This configuration is immutable after you set it. For more information, see UsernameConfigurationType.
    
    Parameters:
    
    usernameConfiguration - Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to False (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username, USERNAME, or UserName, or for email, email@example.com or EMaiL@eXamplE.Com. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.
    
    This configuration is immutable after you set it. For more information, see UsernameConfigurationType.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccountRecoverySetting
```
public void setAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
```
    The available verified method a user can use to recover their password when they call ForgotPassword . You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
    
    Parameters:
    
    accountRecoverySetting - The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
  - getAccountRecoverySetting
```
public AccountRecoverySettingType getAccountRecoverySetting()
```
    The available verified method a user can use to recover their password when they call ForgotPassword . You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
    
    Returns:
    
    The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
  - withAccountRecoverySetting
```
public CreateUserPoolRequest withAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
```
    The available verified method a user can use to recover their password when they call ForgotPassword . You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
    
    Parameters:
    
    accountRecoverySetting - The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateUserPoolRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.773

Class CreateUserPoolRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateUserPoolRequest

Method Detail

setPoolName

getPoolName

withPoolName

setPolicies

getPolicies

withPolicies

setDeletionProtection

getDeletionProtection

withDeletionProtection

setDeletionProtection

withDeletionProtection

setLambdaConfig

getLambdaConfig

withLambdaConfig

getAutoVerifiedAttributes

setAutoVerifiedAttributes

withAutoVerifiedAttributes

withAutoVerifiedAttributes

withAutoVerifiedAttributes

getAliasAttributes

setAliasAttributes

withAliasAttributes

withAliasAttributes

withAliasAttributes

getUsernameAttributes

setUsernameAttributes

withUsernameAttributes

withUsernameAttributes

withUsernameAttributes

setSmsVerificationMessage

getSmsVerificationMessage

withSmsVerificationMessage

setEmailVerificationMessage

getEmailVerificationMessage

withEmailVerificationMessage

setEmailVerificationSubject

getEmailVerificationSubject

withEmailVerificationSubject

setVerificationMessageTemplate

getVerificationMessageTemplate

withVerificationMessageTemplate

setSmsAuthenticationMessage

getSmsAuthenticationMessage

withSmsAuthenticationMessage

setMfaConfiguration

getMfaConfiguration

withMfaConfiguration

setMfaConfiguration

withMfaConfiguration

setUserAttributeUpdateSettings

getUserAttributeUpdateSettings

withUserAttributeUpdateSettings

setDeviceConfiguration

getDeviceConfiguration

withDeviceConfiguration

setEmailConfiguration

getEmailConfiguration

withEmailConfiguration

setSmsConfiguration

getSmsConfiguration

withSmsConfiguration

getUserPoolTags

setUserPoolTags

withUserPoolTags

addUserPoolTagsEntry

clearUserPoolTagsEntries

setAdminCreateUserConfig

getAdminCreateUserConfig

withAdminCreateUserConfig