CreateUserPoolRequest (AWS SDK for Java

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

All Implemented Interfaces:

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

See Also:

AWS API Documentation, Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

CreateUserPoolRequest()

Constructors
Constructor and Description
`CreateUserPoolRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateUserPoolRequest`	`addUserPoolTagsEntry(String key, String value)` Add a single UserPoolTags entry
`CreateUserPoolRequest`	`clearUserPoolTagsEntries()` Removes all the entries added into UserPoolTags.
`CreateUserPoolRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`AccountRecoverySettingType`	`getAccountRecoverySetting()` 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.
`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(AliasAttributeType... aliasAttributes)` Attributes supported as an alias for this user pool.
`CreateUserPoolRequest`	`withAliasAttributes(Collection<String> aliasAttributes)` Attributes supported as an alias for this user pool.
`CreateUserPoolRequest`	`withAliasAttributes(String... aliasAttributes)` Attributes supported as an alias for this user pool.
`CreateUserPoolRequest`	`withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)` The attributes to be auto-verified.
`CreateUserPoolRequest`	`withAutoVerifiedAttributes(String... autoVerifiedAttributes)` The attributes to be auto-verified.
`CreateUserPoolRequest`	`withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)` The attributes to be auto-verified.
`CreateUserPoolRequest`	`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`	`withUsernameAttributes(UsernameAttributeType... 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 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateUserPoolRequest
```
public CreateUserPoolRequest()
```
- Method Detail
  - setPoolName
```
public void setPoolName(String poolName)
```
    A string used to name the user pool.
    
    Parameters:
    
    poolName - A string used to name the user pool.
  - getPoolName
```
public String getPoolName()
```
    A string used to name the user pool.
    
    Returns:
    
    A string used to name the user pool.
  - withPoolName
```
public CreateUserPoolRequest withPoolName(String poolName)
```
    A string used to name the user pool.
    
    Parameters:
    
    poolName - A string used to name the user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicies
```
public void setPolicies(UserPoolPolicyType policies)
```
    The policies associated with the new user pool.
    
    Parameters:
    
    policies - The policies associated with the new user pool.
  - getPolicies
```
public UserPoolPolicyType getPolicies()
```
    The policies associated with the new user pool.
    
    Returns:
    
    The policies associated with the new user pool.
  - withPolicies
```
public CreateUserPoolRequest withPolicies(UserPoolPolicyType policies)
```
    The policies associated with the new user pool.
    
    Parameters:
    
    policies - The policies associated with the new user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 .
  - 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 .
  - 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 .
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAutoVerifiedAttributes
```
public List<String> getAutoVerifiedAttributes()
```
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    Returns:
    
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    See Also:
    
    VerifiedAttributeType
  - setAutoVerifiedAttributes
```
public void setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
```
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.
    
    See Also:
    
    VerifiedAttributeType
  - withAutoVerifiedAttributes
```
public CreateUserPoolRequest withAutoVerifiedAttributes(String... autoVerifiedAttributes)
```
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    NOTE: This method appends the values to the existing list (if any). Use setAutoVerifiedAttributes(java.util.Collection) or withAutoVerifiedAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerifiedAttributeType
  - withAutoVerifiedAttributes
```
public CreateUserPoolRequest withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
```
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerifiedAttributeType
  - withAutoVerifiedAttributes
```
public CreateUserPoolRequest withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
```
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerifiedAttributeType
  - getAliasAttributes
```
public List<String> getAliasAttributes()
```
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Returns:
    
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    See Also:
    
    AliasAttributeType
  - setAliasAttributes
```
public void setAliasAttributes(Collection<String> aliasAttributes)
```
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Parameters:
    
    aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    See Also:
    
    AliasAttributeType
  - withAliasAttributes
```
public CreateUserPoolRequest withAliasAttributes(String... aliasAttributes)
```
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    NOTE: This method appends the values to the existing list (if any). Use setAliasAttributes(java.util.Collection) or withAliasAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AliasAttributeType
  - withAliasAttributes
```
public CreateUserPoolRequest withAliasAttributes(Collection<String> aliasAttributes)
```
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Parameters:
    
    aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AliasAttributeType
  - withAliasAttributes
```
public CreateUserPoolRequest withAliasAttributes(AliasAttributeType... aliasAttributes)
```
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Parameters:
    
    aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AliasAttributeType
  - getUsernameAttributes
```
public List<String> getUsernameAttributes()
```
    Specifies whether 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.
    
    See Also:
    
    UsernameAttributeType
  - 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.
    
    See Also:
    
    UsernameAttributeType
  - withUsernameAttributes
```
public CreateUserPoolRequest withUsernameAttributes(String... usernameAttributes)
```
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
    
    NOTE: This method appends the values to the existing list (if any). Use setUsernameAttributes(java.util.Collection) or withUsernameAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    usernameAttributes - Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UsernameAttributeType
  - withUsernameAttributes
```
public CreateUserPoolRequest withUsernameAttributes(Collection<String> usernameAttributes)
```
    Specifies whether 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UsernameAttributeType
  - withUsernameAttributes
```
public CreateUserPoolRequest withUsernameAttributes(UsernameAttributeType... usernameAttributes)
```
    Specifies whether 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UsernameAttributeType
  - setSmsVerificationMessage
```
public void setSmsVerificationMessage(String smsVerificationMessage)
```
    A string representing the SMS verification message.
    
    Parameters:
    
    smsVerificationMessage - A string representing the SMS verification message.
  - getSmsVerificationMessage
```
public String getSmsVerificationMessage()
```
    A string representing the SMS verification message.
    
    Returns:
    
    A string representing the SMS verification message.
  - withSmsVerificationMessage
```
public CreateUserPoolRequest withSmsVerificationMessage(String smsVerificationMessage)
```
    A string representing the SMS verification message.
    
    Parameters:
    
    smsVerificationMessage - A string representing the SMS verification message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmailVerificationMessage
```
public void setEmailVerificationMessage(String emailVerificationMessage)
```
    A string representing the email verification message.
    
    Parameters:
    
    emailVerificationMessage - A string representing the email verification message.
  - getEmailVerificationMessage
```
public String getEmailVerificationMessage()
```
    A string representing the email verification message.
    
    Returns:
    
    A string representing the email verification message.
  - withEmailVerificationMessage
```
public CreateUserPoolRequest withEmailVerificationMessage(String emailVerificationMessage)
```
    A string representing the email verification message.
    
    Parameters:
    
    emailVerificationMessage - A string representing the email verification message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmailVerificationSubject
```
public void setEmailVerificationSubject(String emailVerificationSubject)
```
    A string representing the email verification subject.
    
    Parameters:
    
    emailVerificationSubject - A string representing the email verification subject.
  - getEmailVerificationSubject
```
public String getEmailVerificationSubject()
```
    A string representing the email verification subject.
    
    Returns:
    
    A string representing the email verification subject.
  - withEmailVerificationSubject
```
public CreateUserPoolRequest withEmailVerificationSubject(String emailVerificationSubject)
```
    A string representing the email verification subject.
    
    Parameters:
    
    emailVerificationSubject - A string representing the email verification subject.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVerificationMessageTemplate
```
public void setVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
```
    The template for the verification message that the user sees when the app requests permission to access the user's information.
    
    Parameters:
    
    verificationMessageTemplate - The template for the verification message that the user sees when the app requests permission to access the user's information.
  - getVerificationMessageTemplate
```
public VerificationMessageTemplateType getVerificationMessageTemplate()
```
    The template for the verification message that the user sees when the app requests permission to access the user's information.
    
    Returns:
    
    The template for the verification message that the user sees when the app requests permission to access the user's information.
  - withVerificationMessageTemplate
```
public CreateUserPoolRequest withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
```
    The template for the verification message that the user sees when the app requests permission to access the user's information.
    
    Parameters:
    
    verificationMessageTemplate - The template for the verification message that the user sees when the app requests permission to access the user's information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSmsAuthenticationMessage
```
public void setSmsAuthenticationMessage(String smsAuthenticationMessage)
```
    A string representing the SMS authentication message.
    
    Parameters:
    
    smsAuthenticationMessage - A string representing the SMS authentication message.
  - getSmsAuthenticationMessage
```
public String getSmsAuthenticationMessage()
```
    A string representing the SMS authentication message.
    
    Returns:
    
    A string representing the SMS authentication message.
  - withSmsAuthenticationMessage
```
public CreateUserPoolRequest withSmsAuthenticationMessage(String smsAuthenticationMessage)
```
    A string representing the SMS authentication message.
    
    Parameters:
    
    smsAuthenticationMessage - A string representing the SMS authentication message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMfaConfiguration
```
public void setMfaConfiguration(String mfaConfiguration)
```
    Specifies MFA configuration details.
    
    Parameters:
    
    mfaConfiguration - Specifies MFA configuration details.
    
    See Also:
    
    UserPoolMfaType
  - getMfaConfiguration
```
public String getMfaConfiguration()
```
    Specifies MFA configuration details.
    
    Returns:
    
    Specifies MFA configuration details.
    
    See Also:
    
    UserPoolMfaType
  - withMfaConfiguration
```
public CreateUserPoolRequest withMfaConfiguration(String mfaConfiguration)
```
    Specifies MFA configuration details.
    
    Parameters:
    
    mfaConfiguration - Specifies MFA configuration details.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType
  - setMfaConfiguration
```
public void setMfaConfiguration(UserPoolMfaType mfaConfiguration)
```
    Specifies MFA configuration details.
    
    Parameters:
    
    mfaConfiguration - Specifies MFA configuration details.
    
    See Also:
    
    UserPoolMfaType
  - withMfaConfiguration
```
public CreateUserPoolRequest withMfaConfiguration(UserPoolMfaType mfaConfiguration)
```
    Specifies MFA configuration details.
    
    Parameters:
    
    mfaConfiguration - Specifies MFA configuration details.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType
  - setDeviceConfiguration
```
public void setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
```
    The device configuration.
    
    Parameters:
    
    deviceConfiguration - The device configuration.
  - getDeviceConfiguration
```
public DeviceConfigurationType getDeviceConfiguration()
```
    The device configuration.
    
    Returns:
    
    The device configuration.
  - withDeviceConfiguration
```
public CreateUserPoolRequest withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
```
    The device configuration.
    
    Parameters:
    
    deviceConfiguration - The device configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmailConfiguration
```
public void setEmailConfiguration(EmailConfigurationType emailConfiguration)
```
    The email configuration.
    
    Parameters:
    
    emailConfiguration - The email configuration.
  - getEmailConfiguration
```
public EmailConfigurationType getEmailConfiguration()
```
    The email configuration.
    
    Returns:
    
    The email configuration.
  - withEmailConfiguration
```
public CreateUserPoolRequest withEmailConfiguration(EmailConfigurationType emailConfiguration)
```
    The email configuration.
    
    Parameters:
    
    emailConfiguration - The email configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSmsConfiguration
```
public void setSmsConfiguration(SmsConfigurationType smsConfiguration)
```
    The SMS configuration.
    
    Parameters:
    
    smsConfiguration - The SMS configuration.
  - getSmsConfiguration
```
public SmsConfigurationType getSmsConfiguration()
```
    The SMS configuration.
    
    Returns:
    
    The SMS configuration.
  - withSmsConfiguration
```
public CreateUserPoolRequest withSmsConfiguration(SmsConfigurationType smsConfiguration)
```
    The SMS configuration.
    
    Parameters:
    
    smsConfiguration - The SMS configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUserPoolTags
```
public Map<String,String> getUserPoolTags()
```
    The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
    
    Returns:
    
    The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
  - setUserPoolTags
```
public void setUserPoolTags(Map<String,String> userPoolTags)
```
    The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
    
    Parameters:
    
    userPoolTags - The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
  - withUserPoolTags
```
public CreateUserPoolRequest withUserPoolTags(Map<String,String> userPoolTags)
```
    The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
    
    Parameters:
    
    userPoolTags - The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addUserPoolTagsEntry
```
public CreateUserPoolRequest addUserPoolTagsEntry(String key,
                                                  String value)
```
    Add a single UserPoolTags entry
    
    See Also:
    
    withUserPoolTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearUserPoolTagsEntries
```
public CreateUserPoolRequest clearUserPoolTagsEntries()
```
    Removes all the entries added into UserPoolTags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAdminCreateUserConfig
```
public void setAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
```
    The configuration for AdminCreateUser requests.
    
    Parameters:
    
    adminCreateUserConfig - The configuration for AdminCreateUser requests.
  - getAdminCreateUserConfig
```
public AdminCreateUserConfigType getAdminCreateUserConfig()
```
    The configuration for AdminCreateUser requests.
    
    Returns:
    
    The configuration for AdminCreateUser requests.
  - withAdminCreateUserConfig
```
public CreateUserPoolRequest withAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
```
    The configuration for AdminCreateUser requests.
    
    Parameters:
    
    adminCreateUserConfig - The configuration for AdminCreateUser requests.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSchema
```
public List<SchemaAttributeType> getSchema()
```
    An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
    
    Returns:
    
    An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
  - setSchema
```
public void setSchema(Collection<SchemaAttributeType> schema)
```
    An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
    
    Parameters:
    
    schema - An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
  - withSchema
```
public CreateUserPoolRequest withSchema(SchemaAttributeType... schema)
```
    An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
    
    NOTE: This method appends the values to the existing list (if any). Use setSchema(java.util.Collection) or withSchema(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    schema - An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSchema
```
public CreateUserPoolRequest withSchema(Collection<SchemaAttributeType> schema)
```
    An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
    
    Parameters:
    
    schema - An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserPoolAddOns
```
public void setUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
```
    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".
  - 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".
  - withUserPoolAddOns
```
public CreateUserPoolRequest withUserPoolAddOns(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".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 UsernameConfigurationType.
    
    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 UsernameConfigurationType.
  - 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 UsernameConfigurationType.
    
    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 UsernameConfigurationType.
  - 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 UsernameConfigurationType.
    
    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 UsernameConfigurationType.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccountRecoverySetting
```
public void setAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
```
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
    
    Parameters:
    
    accountRecoverySetting - Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
  - getAccountRecoverySetting
```
public AccountRecoverySettingType getAccountRecoverySetting()
```
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
    
    Returns:
    
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
  - 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.
    
    Parameters:
    
    accountRecoverySetting - Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateUserPoolRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class CreateUserPoolRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateUserPoolRequest

Method Detail

setPoolName

getPoolName

withPoolName

setPolicies

getPolicies

withPolicies

setLambdaConfig

getLambdaConfig

withLambdaConfig

getAutoVerifiedAttributes

setAutoVerifiedAttributes

withAutoVerifiedAttributes

withAutoVerifiedAttributes

withAutoVerifiedAttributes

getAliasAttributes

setAliasAttributes

withAliasAttributes

withAliasAttributes

withAliasAttributes

getUsernameAttributes

setUsernameAttributes

withUsernameAttributes

withUsernameAttributes

withUsernameAttributes

setSmsVerificationMessage

getSmsVerificationMessage

withSmsVerificationMessage

setEmailVerificationMessage

getEmailVerificationMessage

withEmailVerificationMessage

setEmailVerificationSubject

getEmailVerificationSubject

withEmailVerificationSubject

setVerificationMessageTemplate

getVerificationMessageTemplate

withVerificationMessageTemplate

setSmsAuthenticationMessage

getSmsAuthenticationMessage

withSmsAuthenticationMessage

setMfaConfiguration

getMfaConfiguration

withMfaConfiguration

setMfaConfiguration

withMfaConfiguration

setDeviceConfiguration

getDeviceConfiguration

withDeviceConfiguration

setEmailConfiguration

getEmailConfiguration

withEmailConfiguration

setSmsConfiguration

getSmsConfiguration

withSmsConfiguration

getUserPoolTags

setUserPoolTags

withUserPoolTags

addUserPoolTagsEntry

clearUserPoolTagsEntries

setAdminCreateUserConfig

getAdminCreateUserConfig

withAdminCreateUserConfig

getSchema

setSchema

withSchema

withSchema

setUserPoolAddOns

getUserPoolAddOns

withUserPoolAddOns

setUsernameConfiguration