CreateUserPoolRequest (AWS SDK for Android - Amazon Cognito Identity Provider 2.16.10 API)

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class CreateUserPoolRequest
extends AmazonWebServiceRequest
implements Serializable
```
Creates a new Amazon Cognito user pool and sets the password policy for the pool.

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(String key, String value)` The tag keys and values to assign to the user pool.
`CreateUserPoolRequest`	`clearUserPoolTagsEntries()` Removes all the entries added into UserPoolTags.
`boolean`	`equals(Object obj)`
`AccountRecoverySettingType`	`getAccountRecoverySetting()` Use this setting to define which verified available method a user can use to recover their password when they call `ForgotPassword`.
`AdminCreateUserConfigType`	`getAdminCreateUserConfig()` The configuration for `AdminCreateUser` requests.
`List<String>`	`getAliasAttributes()` Attributes supported as an alias for this user pool.
`List<String>`	`getAutoVerifiedAttributes()` The attributes to be auto-verified.
`DeviceConfigurationType`	`getDeviceConfiguration()` The device configuration.
`EmailConfigurationType`	`getEmailConfiguration()` The email configuration.
`String`	`getEmailVerificationMessage()` A string representing the email verification message.
`String`	`getEmailVerificationSubject()` A string representing the email verification subject.
`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.
`String`	`getSmsVerificationMessage()` A string representing the SMS verification message.
`List<String>`	`getUsernameAttributes()` Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
`UsernameConfigurationType`	`getUsernameConfiguration()` You can choose to set case sensitivity on the username input for the selected sign-in option.
`UserPoolAddOnsType`	`getUserPoolAddOns()` Used to enable advanced security risk detection.
`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)` Use this setting to define which verified available method a user can use to recover their password when they call `ForgotPassword`.
`void`	`setAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)` The configuration for `AdminCreateUser` requests.
`void`	`setAliasAttributes(Collection<String> aliasAttributes)` Attributes supported as an alias for this user pool.
`void`	`setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)` The attributes to be auto-verified.
`void`	`setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)` The device configuration.
`void`	`setEmailConfiguration(EmailConfigurationType emailConfiguration)` The email configuration.
`void`	`setEmailVerificationMessage(String emailVerificationMessage)` A string representing the email verification message.
`void`	`setEmailVerificationSubject(String emailVerificationSubject)` A string representing the email verification subject.
`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.
`void`	`setSmsVerificationMessage(String smsVerificationMessage)` A string representing the SMS verification message.
`void`	`setUsernameAttributes(Collection<String> usernameAttributes)` Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
`void`	`setUsernameConfiguration(UsernameConfigurationType usernameConfiguration)` You can choose to set case sensitivity on the username input for the selected sign-in option.
`void`	`setUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)` Used to enable advanced security risk detection.
`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; useful for testing and debugging.
`CreateUserPoolRequest`	`withAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)` Use this setting to define which verified available method a user can use to recover their password when they call `ForgotPassword`.
`CreateUserPoolRequest`	`withAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)` The configuration for `AdminCreateUser` requests.
`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`	`withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)` The device configuration.
`CreateUserPoolRequest`	`withEmailConfiguration(EmailConfigurationType emailConfiguration)` The email configuration.
`CreateUserPoolRequest`	`withEmailVerificationMessage(String emailVerificationMessage)` A string representing the email verification message.
`CreateUserPoolRequest`	`withEmailVerificationSubject(String emailVerificationSubject)` A string representing the email verification subject.
`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.
`CreateUserPoolRequest`	`withSmsVerificationMessage(String smsVerificationMessage)` A string representing the SMS verification message.
`CreateUserPoolRequest`	`withUsernameAttributes(Collection<String> usernameAttributes)` Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
`CreateUserPoolRequest`	`withUsernameAttributes(String... usernameAttributes)` Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
`CreateUserPoolRequest`	`withUsernameConfiguration(UsernameConfigurationType usernameConfiguration)` You can choose to set case sensitivity on the username input for the selected sign-in option.
`CreateUserPoolRequest`	`withUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)` Used to enable advanced security risk detection.
`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 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 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(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(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.
  - 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 will need to 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 AWS 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 will need to 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 AWS 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 will need to 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 AWS 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 will need to 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 AWS 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 will need to 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 AWS 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 will need to 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 AWS CLI, see add-permission .
    
    Returns:
    
    A reference to this updated 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.
  - 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.
  - withAutoVerifiedAttributes
```
public CreateUserPoolRequest withAutoVerifiedAttributes(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(Collection<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 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.
  - 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.
  - withAliasAttributes
```
public CreateUserPoolRequest withAliasAttributes(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(Collection<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 List<String> getUsernameAttributes()
```
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
    
    Returns:
    
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
  - setUsernameAttributes
```
public void setUsernameAttributes(Collection<String> usernameAttributes)
```
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
    
    Parameters:
    
    usernameAttributes -
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
  - withUsernameAttributes
```
public CreateUserPoolRequest withUsernameAttributes(String... usernameAttributes)
```
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    usernameAttributes -
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withUsernameAttributes
```
public CreateUserPoolRequest withUsernameAttributes(Collection<String> usernameAttributes)
```
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    usernameAttributes -
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSmsVerificationMessage
```
public String getSmsVerificationMessage()
```
    A string representing the SMS verification message.
    
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Returns:
    
    A string representing the SMS verification message.
  - setSmsVerificationMessage
```
public void setSmsVerificationMessage(String smsVerificationMessage)
```
    A string representing the SMS verification message.
    
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Parameters:
    
    smsVerificationMessage -
    A string representing the SMS verification message.
  - withSmsVerificationMessage
```
public CreateUserPoolRequest withSmsVerificationMessage(String smsVerificationMessage)
```
    A string representing the SMS verification message.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Parameters:
    
    smsVerificationMessage -
    A string representing the SMS verification message.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEmailVerificationMessage
```
public String getEmailVerificationMessage()
```
    A string representing the email verification message.
    
    Constraints:
    Length: 6 - 20000
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{ N}\p{P}\s*]*
    
    Returns:
    
    A string representing the email verification message.
  - setEmailVerificationMessage
```
public void setEmailVerificationMessage(String emailVerificationMessage)
```
    A string representing the email verification message.
    
    Constraints:
    Length: 6 - 20000
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{ N}\p{P}\s*]*
    
    Parameters:
    
    emailVerificationMessage -
    A string representing the email verification message.
  - withEmailVerificationMessage
```
public CreateUserPoolRequest withEmailVerificationMessage(String emailVerificationMessage)
```
    A string representing the email verification message.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 6 - 20000
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{ N}\p{P}\s*]*
    
    Parameters:
    
    emailVerificationMessage -
    A string representing the email verification message.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEmailVerificationSubject
```
public String getEmailVerificationSubject()
```
    A string representing the email verification subject.
    
    Constraints:
    Length: 1 - 140
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
    
    Returns:
    
    A string representing the email verification subject.
  - setEmailVerificationSubject
```
public void setEmailVerificationSubject(String emailVerificationSubject)
```
    A string representing the email verification subject.
    
    Constraints:
    Length: 1 - 140
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
    
    Parameters:
    
    emailVerificationSubject -
    A string representing the email verification subject.
  - withEmailVerificationSubject
```
public CreateUserPoolRequest withEmailVerificationSubject(String emailVerificationSubject)
```
    A string representing the email verification subject.
    
    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 -
    A string representing the email verification subject.
    
    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 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(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(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 String getMfaConfiguration()
```
    Specifies MFA configuration details.
    
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    
    Returns:
    
    Specifies MFA configuration details.
    
    See Also:
    
    UserPoolMfaType
  - setMfaConfiguration
```
public void setMfaConfiguration(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(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
  - getDeviceConfiguration
```
public DeviceConfigurationType getDeviceConfiguration()
```
    The device configuration.
    
    Returns:
    
    The device configuration.
  - setDeviceConfiguration
```
public void setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
```
    The device configuration.
    
    Parameters:
    
    deviceConfiguration -
    The device configuration.
  - withDeviceConfiguration
```
public CreateUserPoolRequest withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
```
    The device configuration.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    deviceConfiguration -
    The device configuration.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEmailConfiguration
```
public EmailConfigurationType getEmailConfiguration()
```
    The email configuration.
    
    Returns:
    
    The email configuration.
  - setEmailConfiguration
```
public void setEmailConfiguration(EmailConfigurationType emailConfiguration)
```
    The email configuration.
    
    Parameters:
    
    emailConfiguration -
    The email configuration.
  - withEmailConfiguration
```
public CreateUserPoolRequest withEmailConfiguration(EmailConfigurationType emailConfiguration)
```
    The email configuration.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    emailConfiguration -
    The email configuration.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSmsConfiguration
```
public SmsConfigurationType getSmsConfiguration()
```
    The SMS configuration.
    
    Returns:
    
    The SMS configuration.
  - setSmsConfiguration
```
public void setSmsConfiguration(SmsConfigurationType smsConfiguration)
```
    The SMS configuration.
    
    Parameters:
    
    smsConfiguration -
    The SMS configuration.
  - withSmsConfiguration
```
public CreateUserPoolRequest withSmsConfiguration(SmsConfigurationType smsConfiguration)
```
    The SMS configuration.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    smsConfiguration -
    The SMS configuration.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserPoolTags
```
public Map<String,String> getUserPoolTags()
```
    The 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.
    
    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(String key,
                                                  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 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.
    
    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(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()
```
    Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
    
    Returns:
    
    Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
  - setUserPoolAddOns
```
public void setUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
```
    Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
    
    Parameters:
    
    userPoolAddOns -
    Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
  - withUserPoolAddOns
```
public CreateUserPoolRequest withUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
```
    Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    userPoolAddOns -
    Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUsernameConfiguration
```
public UsernameConfigurationType getUsernameConfiguration()
```
    You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see .
    
    Returns:
    
    You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see .
  - setUsernameConfiguration
```
public void setUsernameConfiguration(UsernameConfigurationType usernameConfiguration)
```
    You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see .
    
    Parameters:
    
    usernameConfiguration -
    You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see .
  - withUsernameConfiguration
```
public CreateUserPoolRequest withUsernameConfiguration(UsernameConfigurationType usernameConfiguration)
```
    You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see .
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    usernameConfiguration -
    You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see .
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAccountRecoverySetting
```
public AccountRecoverySettingType getAccountRecoverySetting()
```
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
    
    Starting February 1, 2020, the value of AccountRecoverySetting will default to verified_email first and verified_phone_number as the second option for newly created user pools if no value is provided.
    
    Returns:
    
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
    
    Starting February 1, 2020, the value of AccountRecoverySetting will default to verified_email first and verified_phone_number as the second option for newly created user pools if no value is provided.
  - setAccountRecoverySetting
```
public void setAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
```
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
    
    Starting February 1, 2020, the value of AccountRecoverySetting will default to verified_email first and verified_phone_number as the second option for newly created user pools if no value is provided.
    
    Parameters:
    
    accountRecoverySetting -
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
    
    Starting February 1, 2020, the value of AccountRecoverySetting will default to verified_email first and verified_phone_number as the second option for newly created user pools if no value is provided.
  - withAccountRecoverySetting
```
public CreateUserPoolRequest withAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
```
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
    
    Starting February 1, 2020, the value of AccountRecoverySetting will default to verified_email first and verified_phone_number as the second option for newly created user pools if no value is provided.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    accountRecoverySetting -
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
    
    Starting February 1, 2020, the value of AccountRecoverySetting will default to verified_email first and verified_phone_number as the second option for newly created user pools if no value is provided.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class 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

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

getDeviceConfiguration

setDeviceConfiguration

withDeviceConfiguration

getEmailConfiguration

setEmailConfiguration

withEmailConfiguration

getSmsConfiguration

setSmsConfiguration

withSmsConfiguration

getUserPoolTags

setUserPoolTags

withUserPoolTags

addUserPoolTagsEntry

clearUserPoolTagsEntries

getAdminCreateUserConfig

setAdminCreateUserConfig

withAdminCreateUserConfig

getSchema

setSchema

withSchema

withSchema

getUserPoolAddOns

setUserPoolAddOns

withUserPoolAddOns

getUsernameConfiguration

setUsernameConfiguration

withUsernameConfiguration

getAccountRecoverySetting

setAccountRecoverySetting

withAccountRecoverySetting

toString