CreateUserPoolRequest (aws-android-sdk-cognitoidentityprovider 2.81.1 API)

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class CreateUserPoolRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more
- Signing Amazon Web Services API Requests
- Using the Amazon Cognito user pools API and user pool endpoints
See Also:

Serialized Form

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(java.lang.String key, java.lang.String value)` The tag keys and values to assign to the user pool.
`CreateUserPoolRequest`	`clearUserPoolTagsEntries()` Removes all the entries added into UserPoolTags.
`boolean`	`equals(java.lang.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.
`java.util.List<java.lang.String>`	`getAliasAttributes()` Attributes supported as an alias for this user pool.
`java.util.List<java.lang.String>`	`getAutoVerifiedAttributes()` The attributes to be auto-verified.
`java.lang.String`	`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.
`java.lang.String`	`getEmailVerificationMessage()` This parameter is no longer used.
`java.lang.String`	`getEmailVerificationSubject()` This parameter is no longer used.
`LambdaConfigType`	`getLambdaConfig()` The Lambda trigger configuration information for the new user pool.
`java.lang.String`	`getMfaConfiguration()` Specifies MFA configuration details.
`UserPoolPolicyType`	`getPolicies()` The policies associated with the new user pool.
`java.lang.String`	`getPoolName()` A string used to name the user pool.
`java.util.List<SchemaAttributeType>`	`getSchema()` An array of schema attributes for the new user pool.
`java.lang.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.
`java.lang.String`	`getSmsVerificationMessage()` This parameter is no longer used.
`UserAttributeUpdateSettingsType`	`getUserAttributeUpdateSettings()` The settings for updates to user attributes.
`java.util.List<java.lang.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.
`java.util.Map<java.lang.String,java.lang.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(java.util.Collection<java.lang.String> aliasAttributes)` Attributes supported as an alias for this user pool.
`void`	`setAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)` The attributes to be auto-verified.
`void`	`setDeletionProtection(DeletionProtectionType deletionProtection)` When active, `DeletionProtection` prevents accidental deletion of your user pool.
`void`	`setDeletionProtection(java.lang.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(java.lang.String emailVerificationMessage)` This parameter is no longer used.
`void`	`setEmailVerificationSubject(java.lang.String emailVerificationSubject)` This parameter is no longer used.
`void`	`setLambdaConfig(LambdaConfigType lambdaConfig)` The Lambda trigger configuration information for the new user pool.
`void`	`setMfaConfiguration(java.lang.String mfaConfiguration)` Specifies MFA configuration details.
`void`	`setMfaConfiguration(UserPoolMfaType mfaConfiguration)` Specifies MFA configuration details.
`void`	`setPolicies(UserPoolPolicyType policies)` The policies associated with the new user pool.
`void`	`setPoolName(java.lang.String poolName)` A string used to name the user pool.
`void`	`setSchema(java.util.Collection<SchemaAttributeType> schema)` An array of schema attributes for the new user pool.
`void`	`setSmsAuthenticationMessage(java.lang.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(java.lang.String smsVerificationMessage)` This parameter is no longer used.
`void`	`setUserAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)` The settings for updates to user attributes.
`void`	`setUsernameAttributes(java.util.Collection<java.lang.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(java.util.Map<java.lang.String,java.lang.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.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`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(java.util.Collection<java.lang.String> aliasAttributes)` Attributes supported as an alias for this user pool.
`CreateUserPoolRequest`	`withAliasAttributes(java.lang.String... aliasAttributes)` Attributes supported as an alias for this user pool.
`CreateUserPoolRequest`	`withAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)` The attributes to be auto-verified.
`CreateUserPoolRequest`	`withAutoVerifiedAttributes(java.lang.String... autoVerifiedAttributes)` The attributes to be auto-verified.
`CreateUserPoolRequest`	`withDeletionProtection(DeletionProtectionType deletionProtection)` When active, `DeletionProtection` prevents accidental deletion of your user pool.
`CreateUserPoolRequest`	`withDeletionProtection(java.lang.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(java.lang.String emailVerificationMessage)` This parameter is no longer used.
`CreateUserPoolRequest`	`withEmailVerificationSubject(java.lang.String emailVerificationSubject)` This parameter is no longer used.
`CreateUserPoolRequest`	`withLambdaConfig(LambdaConfigType lambdaConfig)` The Lambda trigger configuration information for the new user pool.
`CreateUserPoolRequest`	`withMfaConfiguration(java.lang.String mfaConfiguration)` Specifies MFA configuration details.
`CreateUserPoolRequest`	`withMfaConfiguration(UserPoolMfaType mfaConfiguration)` Specifies MFA configuration details.
`CreateUserPoolRequest`	`withPolicies(UserPoolPolicyType policies)` The policies associated with the new user pool.
`CreateUserPoolRequest`	`withPoolName(java.lang.String poolName)` A string used to name the user pool.
`CreateUserPoolRequest`	`withSchema(java.util.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(java.lang.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(java.lang.String smsVerificationMessage)` This parameter is no longer used.
`CreateUserPoolRequest`	`withUserAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)` The settings for updates to user attributes.
`CreateUserPoolRequest`	`withUsernameAttributes(java.util.Collection<java.lang.String> usernameAttributes)` Specifies whether a user can use an email address or phone number as a username when they sign up.
`CreateUserPoolRequest`	`withUsernameAttributes(java.lang.String... 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(java.util.Map<java.lang.String,java.lang.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 com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - CreateUserPoolRequest
```
public CreateUserPoolRequest()
```
- Method Detail
  - getPoolName
```
public java.lang.String getPoolName()
```
    A string used to name the user pool.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w\s+=,.@-]+
    
    Returns:
    
    A string used to name the user pool.
  - setPoolName
```
public void setPoolName(java.lang.String poolName)
```
    A string used to name the user pool.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w\s+=,.@-]+
    
    Parameters:
    
    poolName -
    A string used to name the user pool.
  - withPoolName
```
public CreateUserPoolRequest withPoolName(java.lang.String poolName)
```
    A string used to name 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:
    
    poolName -
    A string used to name 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 new user pool.
    
    Returns:
    
    The policies associated with the new user pool.
  - setPolicies
```
public void setPolicies(UserPoolPolicyType policies)
```
    The policies associated with the new user pool.
    
    Parameters:
    
    policies -
    The policies associated with the new user pool.
  - withPolicies
```
public CreateUserPoolRequest withPolicies(UserPoolPolicyType policies)
```
    The policies associated with the new user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    policies -
    The policies associated with the new user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDeletionProtection
```
public java.lang.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.
    
    Constraints:
    Allowed Values: ACTIVE, INACTIVE
    
    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
  - setDeletionProtection
```
public void setDeletionProtection(java.lang.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.
    
    Constraints:
    Allowed Values: ACTIVE, INACTIVE
    
    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(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ACTIVE, INACTIVE
    
    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:
    
    A reference to this updated 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.
    
    Constraints:
    Allowed Values: ACTIVE, INACTIVE
    
    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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ACTIVE, INACTIVE
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DeletionProtectionType
  - 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 .
  - 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 .
  - 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 .
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getAutoVerifiedAttributes
```
public java.util.List<java.lang.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.
  - setAutoVerifiedAttributes
```
public void setAutoVerifiedAttributes(java.util.Collection<java.lang.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.
  - withAutoVerifiedAttributes
```
public CreateUserPoolRequest withAutoVerifiedAttributes(java.lang.String... autoVerifiedAttributes)
```
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    autoVerifiedAttributes -
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withAutoVerifiedAttributes
```
public CreateUserPoolRequest withAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
```
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    autoVerifiedAttributes -
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAliasAttributes
```
public java.util.List<java.lang.String> getAliasAttributes()
```
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Returns:
    
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
  - setAliasAttributes
```
public void setAliasAttributes(java.util.Collection<java.lang.String> aliasAttributes)
```
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Parameters:
    
    aliasAttributes -
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
  - withAliasAttributes
```
public CreateUserPoolRequest withAliasAttributes(java.lang.String... aliasAttributes)
```
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    aliasAttributes -
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withAliasAttributes
```
public CreateUserPoolRequest withAliasAttributes(java.util.Collection<java.lang.String> aliasAttributes)
```
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    aliasAttributes -
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUsernameAttributes
```
public java.util.List<java.lang.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.
  - setUsernameAttributes
```
public void setUsernameAttributes(java.util.Collection<java.lang.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.
  - withUsernameAttributes
```
public CreateUserPoolRequest withUsernameAttributes(java.lang.String... usernameAttributes)
```
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    usernameAttributes -
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withUsernameAttributes
```
public CreateUserPoolRequest withUsernameAttributes(java.util.Collection<java.lang.String> usernameAttributes)
```
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    usernameAttributes -
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSmsVerificationMessage
```
public java.lang.String getSmsVerificationMessage()
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Returns:
    
    This parameter is no longer used. See VerificationMessageTemplateType.
  - setSmsVerificationMessage
```
public void setSmsVerificationMessage(java.lang.String smsVerificationMessage)
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Parameters:
    
    smsVerificationMessage -
    This parameter is no longer used. See VerificationMessageTemplateType.
  - withSmsVerificationMessage
```
public CreateUserPoolRequest withSmsVerificationMessage(java.lang.String smsVerificationMessage)
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Parameters:
    
    smsVerificationMessage -
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEmailVerificationMessage
```
public java.lang.String getEmailVerificationMessage()
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    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:
    
    This parameter is no longer used. See VerificationMessageTemplateType.
  - setEmailVerificationMessage
```
public void setEmailVerificationMessage(java.lang.String emailVerificationMessage)
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    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 -
    This parameter is no longer used. See VerificationMessageTemplateType.
  - withEmailVerificationMessage
```
public CreateUserPoolRequest withEmailVerificationMessage(java.lang.String emailVerificationMessage)
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    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 -
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEmailVerificationSubject
```
public java.lang.String getEmailVerificationSubject()
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Constraints:
    Length: 1 - 140
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
    
    Returns:
    
    This parameter is no longer used. See VerificationMessageTemplateType.
  - setEmailVerificationSubject
```
public void setEmailVerificationSubject(java.lang.String emailVerificationSubject)
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Constraints:
    Length: 1 - 140
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
    
    Parameters:
    
    emailVerificationSubject -
    This parameter is no longer used. See VerificationMessageTemplateType.
  - withEmailVerificationSubject
```
public CreateUserPoolRequest withEmailVerificationSubject(java.lang.String emailVerificationSubject)
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    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 -
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    verificationMessageTemplate -
    The template for the verification message that the user sees when the app requests permission to access the user's information.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSmsAuthenticationMessage
```
public java.lang.String getSmsAuthenticationMessage()
```
    A string representing the SMS authentication message.
    
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Returns:
    
    A string representing the SMS authentication message.
  - setSmsAuthenticationMessage
```
public void setSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage)
```
    A string representing the SMS authentication message.
    
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Parameters:
    
    smsAuthenticationMessage -
    A string representing the SMS authentication message.
  - withSmsAuthenticationMessage
```
public CreateUserPoolRequest withSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage)
```
    A string representing 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 -
    A string representing the SMS authentication message.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMfaConfiguration
```
public java.lang.String getMfaConfiguration()
```
    Specifies MFA configuration details.
    
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    
    Returns:
    
    Specifies MFA configuration details.
    
    See Also:
    
    UserPoolMfaType
  - setMfaConfiguration
```
public void setMfaConfiguration(java.lang.String mfaConfiguration)
```
    Specifies MFA configuration details.
    
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    
    Parameters:
    
    mfaConfiguration -
    Specifies MFA configuration details.
    
    See Also:
    
    UserPoolMfaType
  - withMfaConfiguration
```
public CreateUserPoolRequest withMfaConfiguration(java.lang.String mfaConfiguration)
```
    Specifies MFA configuration details.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    
    Parameters:
    
    mfaConfiguration -
    Specifies MFA configuration details.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType
  - setMfaConfiguration
```
public void setMfaConfiguration(UserPoolMfaType mfaConfiguration)
```
    Specifies MFA configuration details.
    
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    
    Parameters:
    
    mfaConfiguration -
    Specifies MFA configuration details.
    
    See Also:
    
    UserPoolMfaType
  - withMfaConfiguration
```
public CreateUserPoolRequest withMfaConfiguration(UserPoolMfaType mfaConfiguration)
```
    Specifies MFA configuration details.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    
    Parameters:
    
    mfaConfiguration -
    Specifies MFA configuration details.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType
  - 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.
  - 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.
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserPoolTags
```
public java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - addUserPoolTagsEntry
```
public CreateUserPoolRequest addUserPoolTagsEntry(java.lang.String key,
                                                  java.lang.String value)
```
    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.
    
    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 CreateUserPoolRequest clearUserPoolTagsEntries()
```
    Removes all the entries added into UserPoolTags.
    Returns a reference to this 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 CreateUserPoolRequest 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.
  - getSchema
```
public java.util.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(java.util.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    schema -
    An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withSchema
```
public CreateUserPoolRequest withSchema(java.util.Collection<SchemaAttributeType> schema)
```
    An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    schema -
    An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class CreateUserPoolRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateUserPoolRequest

Method Detail

getPoolName

setPoolName

withPoolName

getPolicies

setPolicies

withPolicies

getDeletionProtection

setDeletionProtection

withDeletionProtection

setDeletionProtection

withDeletionProtection

getLambdaConfig

setLambdaConfig

withLambdaConfig

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

getUserAttributeUpdateSettings

setUserAttributeUpdateSettings

withUserAttributeUpdateSettings

getDeviceConfiguration

setDeviceConfiguration

withDeviceConfiguration

getEmailConfiguration

setEmailConfiguration

withEmailConfiguration

getSmsConfiguration

setSmsConfiguration

withSmsConfiguration

getUserPoolTags

setUserPoolTags

withUserPoolTags

addUserPoolTagsEntry

clearUserPoolTagsEntries

getAdminCreateUserConfig

setAdminCreateUserConfig

withAdminCreateUserConfig

getSchema

setSchema

withSchema

withSchema

getUserPoolAddOns

setUserPoolAddOns