UserPoolType (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UserPoolType
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A container for information about the user pool type.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UserPoolType()

Constructors
Constructor and Description
`UserPoolType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserPoolType`	`addUserPoolTagsEntry(String key, String value)`
`UserPoolType`	`clearUserPoolTagsEntries()` Removes all the entries added into UserPoolTags.
`UserPoolType`	`clone()`
`boolean`	`equals(Object obj)`
`AdminCreateUserConfigType`	`getAdminCreateUserConfig()` The configuration for `AdminCreateUser` requests.
`List<String>`	`getAliasAttributes()` Specifies the attributes that are aliased in a user pool.
`List<String>`	`getAutoVerifiedAttributes()` Specifies the attributes that are auto-verified in a user pool.
`Date`	`getCreationDate()` The date the user pool was created.
`DeviceConfigurationType`	`getDeviceConfiguration()` The device configuration.
`EmailConfigurationType`	`getEmailConfiguration()` The email configuration.
`String`	`getEmailConfigurationFailure()` The reason why the email configuration cannot send the messages to your users.
`String`	`getEmailVerificationMessage()` The contents of the email verification message.
`String`	`getEmailVerificationSubject()` The subject of the email verification message.
`Integer`	`getEstimatedNumberOfUsers()` A number estimating the size of the user pool.
`String`	`getId()` The ID of the user pool.
`LambdaConfigType`	`getLambdaConfig()` A container for the AWS Lambda triggers associated with a user pool.
`Date`	`getLastModifiedDate()` The date the user pool was last modified.
`String`	`getMfaConfiguration()` Can be one of the following values:
`String`	`getName()` The name of the user pool.
`UserPoolPolicyType`	`getPolicies()` A container for the policies associated with a user pool.
`List<SchemaAttributeType>`	`getSchemaAttributes()` A container with the schema attributes of a user pool.
`String`	`getSmsAuthenticationMessage()` The contents of the SMS authentication message.
`SmsConfigurationType`	`getSmsConfiguration()` The SMS configuration.
`String`	`getSmsConfigurationFailure()` The reason why the SMS configuration cannot send the messages to your users.
`String`	`getSmsVerificationMessage()` The contents of the SMS verification message.
`String`	`getStatus()` The status of a user pool.
`List<String>`	`getUsernameAttributes()` Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
`Map<String,String>`	`getUserPoolTags()` The cost allocation tags for the user pool.
`VerificationMessageTemplateType`	`getVerificationMessageTemplate()` The template for verification messages.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)` The configuration for `AdminCreateUser` requests.
`void`	`setAliasAttributes(Collection<String> aliasAttributes)` Specifies the attributes that are aliased in a user pool.
`void`	`setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)` Specifies the attributes that are auto-verified in a user pool.
`void`	`setCreationDate(Date creationDate)` The date the user pool was created.
`void`	`setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)` The device configuration.
`void`	`setEmailConfiguration(EmailConfigurationType emailConfiguration)` The email configuration.
`void`	`setEmailConfigurationFailure(String emailConfigurationFailure)` The reason why the email configuration cannot send the messages to your users.
`void`	`setEmailVerificationMessage(String emailVerificationMessage)` The contents of the email verification message.
`void`	`setEmailVerificationSubject(String emailVerificationSubject)` The subject of the email verification message.
`void`	`setEstimatedNumberOfUsers(Integer estimatedNumberOfUsers)` A number estimating the size of the user pool.
`void`	`setId(String id)` The ID of the user pool.
`void`	`setLambdaConfig(LambdaConfigType lambdaConfig)` A container for the AWS Lambda triggers associated with a user pool.
`void`	`setLastModifiedDate(Date lastModifiedDate)` The date the user pool was last modified.
`void`	`setMfaConfiguration(String mfaConfiguration)` Can be one of the following values:
`void`	`setMfaConfiguration(UserPoolMfaType mfaConfiguration)` Can be one of the following values:
`void`	`setName(String name)` The name of the user pool.
`void`	`setPolicies(UserPoolPolicyType policies)` A container for the policies associated with a user pool.
`void`	`setSchemaAttributes(Collection<SchemaAttributeType> schemaAttributes)` A container with the schema attributes of a user pool.
`void`	`setSmsAuthenticationMessage(String smsAuthenticationMessage)` The contents of the SMS authentication message.
`void`	`setSmsConfiguration(SmsConfigurationType smsConfiguration)` The SMS configuration.
`void`	`setSmsConfigurationFailure(String smsConfigurationFailure)` The reason why the SMS configuration cannot send the messages to your users.
`void`	`setSmsVerificationMessage(String smsVerificationMessage)` The contents of the SMS verification message.
`void`	`setStatus(StatusType status)` The status of a user pool.
`void`	`setStatus(String status)` The status of a user pool.
`void`	`setUsernameAttributes(Collection<String> usernameAttributes)` Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
`void`	`setUserPoolTags(Map<String,String> userPoolTags)` The cost allocation tags for the user pool.
`void`	`setVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)` The template for verification messages.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UserPoolType`	`withAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)` The configuration for `AdminCreateUser` requests.
`UserPoolType`	`withAliasAttributes(AliasAttributeType... aliasAttributes)` Specifies the attributes that are aliased in a user pool.
`UserPoolType`	`withAliasAttributes(Collection<String> aliasAttributes)` Specifies the attributes that are aliased in a user pool.
`UserPoolType`	`withAliasAttributes(String... aliasAttributes)` Specifies the attributes that are aliased in a user pool.
`UserPoolType`	`withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)` Specifies the attributes that are auto-verified in a user pool.
`UserPoolType`	`withAutoVerifiedAttributes(String... autoVerifiedAttributes)` Specifies the attributes that are auto-verified in a user pool.
`UserPoolType`	`withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)` Specifies the attributes that are auto-verified in a user pool.
`UserPoolType`	`withCreationDate(Date creationDate)` The date the user pool was created.
`UserPoolType`	`withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)` The device configuration.
`UserPoolType`	`withEmailConfiguration(EmailConfigurationType emailConfiguration)` The email configuration.
`UserPoolType`	`withEmailConfigurationFailure(String emailConfigurationFailure)` The reason why the email configuration cannot send the messages to your users.
`UserPoolType`	`withEmailVerificationMessage(String emailVerificationMessage)` The contents of the email verification message.
`UserPoolType`	`withEmailVerificationSubject(String emailVerificationSubject)` The subject of the email verification message.
`UserPoolType`	`withEstimatedNumberOfUsers(Integer estimatedNumberOfUsers)` A number estimating the size of the user pool.
`UserPoolType`	`withId(String id)` The ID of the user pool.
`UserPoolType`	`withLambdaConfig(LambdaConfigType lambdaConfig)` A container for the AWS Lambda triggers associated with a user pool.
`UserPoolType`	`withLastModifiedDate(Date lastModifiedDate)` The date the user pool was last modified.
`UserPoolType`	`withMfaConfiguration(String mfaConfiguration)` Can be one of the following values:
`UserPoolType`	`withMfaConfiguration(UserPoolMfaType mfaConfiguration)` Can be one of the following values:
`UserPoolType`	`withName(String name)` The name of the user pool.
`UserPoolType`	`withPolicies(UserPoolPolicyType policies)` A container for the policies associated with a user pool.
`UserPoolType`	`withSchemaAttributes(Collection<SchemaAttributeType> schemaAttributes)` A container with the schema attributes of a user pool.
`UserPoolType`	`withSchemaAttributes(SchemaAttributeType... schemaAttributes)` A container with the schema attributes of a user pool.
`UserPoolType`	`withSmsAuthenticationMessage(String smsAuthenticationMessage)` The contents of the SMS authentication message.
`UserPoolType`	`withSmsConfiguration(SmsConfigurationType smsConfiguration)` The SMS configuration.
`UserPoolType`	`withSmsConfigurationFailure(String smsConfigurationFailure)` The reason why the SMS configuration cannot send the messages to your users.
`UserPoolType`	`withSmsVerificationMessage(String smsVerificationMessage)` The contents of the SMS verification message.
`UserPoolType`	`withStatus(StatusType status)` The status of a user pool.
`UserPoolType`	`withStatus(String status)` The status of a user pool.
`UserPoolType`	`withUsernameAttributes(Collection<String> usernameAttributes)` Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
`UserPoolType`	`withUsernameAttributes(String... usernameAttributes)` Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
`UserPoolType`	`withUsernameAttributes(UsernameAttributeType... usernameAttributes)` Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
`UserPoolType`	`withUserPoolTags(Map<String,String> userPoolTags)` The cost allocation tags for the user pool.
`UserPoolType`	`withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)` The template for verification messages.

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

- Constructor Detail
  - UserPoolType
```
public UserPoolType()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The ID of the user pool.
    
    Parameters:
    
    id - The ID of the user pool.
  - getId
```
public String getId()
```
    The ID of the user pool.
    
    Returns:
    
    The ID of the user pool.
  - withId
```
public UserPoolType withId(String id)
```
    The ID of the user pool.
    
    Parameters:
    
    id - The ID of the user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the user pool.
    
    Parameters:
    
    name - The name of the user pool.
  - getName
```
public String getName()
```
    The name of the user pool.
    
    Returns:
    
    The name of the user pool.
  - withName
```
public UserPoolType withName(String name)
```
    The name of the user pool.
    
    Parameters:
    
    name - The name of the user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicies
```
public void setPolicies(UserPoolPolicyType policies)
```
    A container for the policies associated with a user pool.
    
    Parameters:
    
    policies - A container for the policies associated with a user pool.
  - getPolicies
```
public UserPoolPolicyType getPolicies()
```
    A container for the policies associated with a user pool.
    
    Returns:
    
    A container for the policies associated with a user pool.
  - withPolicies
```
public UserPoolType withPolicies(UserPoolPolicyType policies)
```
    A container for the policies associated with a user pool.
    
    Parameters:
    
    policies - A container for the policies associated with a user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLambdaConfig
```
public void setLambdaConfig(LambdaConfigType lambdaConfig)
```
    A container for the AWS Lambda triggers associated with a user pool.
    
    Parameters:
    
    lambdaConfig - A container for the AWS Lambda triggers associated with a user pool.
  - getLambdaConfig
```
public LambdaConfigType getLambdaConfig()
```
    A container for the AWS Lambda triggers associated with a user pool.
    
    Returns:
    
    A container for the AWS Lambda triggers associated with a user pool.
  - withLambdaConfig
```
public UserPoolType withLambdaConfig(LambdaConfigType lambdaConfig)
```
    A container for the AWS Lambda triggers associated with a user pool.
    
    Parameters:
    
    lambdaConfig - A container for the AWS Lambda triggers associated with a user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of a user pool.
    
    Parameters:
    
    status - The status of a user pool.
    
    See Also:
    
    StatusType
  - getStatus
```
public String getStatus()
```
    The status of a user pool.
    
    Returns:
    
    The status of a user pool.
    
    See Also:
    
    StatusType
  - withStatus
```
public UserPoolType withStatus(String status)
```
    The status of a user pool.
    
    Parameters:
    
    status - The status of a user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StatusType
  - setStatus
```
public void setStatus(StatusType status)
```
    The status of a user pool.
    
    Parameters:
    
    status - The status of a user pool.
    
    See Also:
    
    StatusType
  - withStatus
```
public UserPoolType withStatus(StatusType status)
```
    The status of a user pool.
    
    Parameters:
    
    status - The status of a user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StatusType
  - setLastModifiedDate
```
public void setLastModifiedDate(Date lastModifiedDate)
```
    The date the user pool was last modified.
    
    Parameters:
    
    lastModifiedDate - The date the user pool was last modified.
  - getLastModifiedDate
```
public Date getLastModifiedDate()
```
    The date the user pool was last modified.
    
    Returns:
    
    The date the user pool was last modified.
  - withLastModifiedDate
```
public UserPoolType withLastModifiedDate(Date lastModifiedDate)
```
    The date the user pool was last modified.
    
    Parameters:
    
    lastModifiedDate - The date the user pool was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The date the user pool was created.
    
    Parameters:
    
    creationDate - The date the user pool was created.
  - getCreationDate
```
public Date getCreationDate()
```
    The date the user pool was created.
    
    Returns:
    
    The date the user pool was created.
  - withCreationDate
```
public UserPoolType withCreationDate(Date creationDate)
```
    The date the user pool was created.
    
    Parameters:
    
    creationDate - The date the user pool was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSchemaAttributes
```
public List<SchemaAttributeType> getSchemaAttributes()
```
    A container with the schema attributes of a user pool.
    
    Returns:
    
    A container with the schema attributes of a user pool.
  - setSchemaAttributes
```
public void setSchemaAttributes(Collection<SchemaAttributeType> schemaAttributes)
```
    A container with the schema attributes of a user pool.
    
    Parameters:
    
    schemaAttributes - A container with the schema attributes of a user pool.
  - withSchemaAttributes
```
public UserPoolType withSchemaAttributes(SchemaAttributeType... schemaAttributes)
```
    A container with the schema attributes of a user pool.
    
    NOTE: This method appends the values to the existing list (if any). Use setSchemaAttributes(java.util.Collection) or withSchemaAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    schemaAttributes - A container with the schema attributes of a user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSchemaAttributes
```
public UserPoolType withSchemaAttributes(Collection<SchemaAttributeType> schemaAttributes)
```
    A container with the schema attributes of a user pool.
    
    Parameters:
    
    schemaAttributes - A container with the schema attributes of a user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAutoVerifiedAttributes
```
public List<String> getAutoVerifiedAttributes()
```
    Specifies the attributes that are auto-verified in a user pool.
    
    Returns:
    
    Specifies the attributes that are auto-verified in a user pool.
    
    See Also:
    
    VerifiedAttributeType
  - setAutoVerifiedAttributes
```
public void setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
```
    Specifies the attributes that are auto-verified in a user pool.
    
    Parameters:
    
    autoVerifiedAttributes - Specifies the attributes that are auto-verified in a user pool.
    
    See Also:
    
    VerifiedAttributeType
  - withAutoVerifiedAttributes
```
public UserPoolType withAutoVerifiedAttributes(String... autoVerifiedAttributes)
```
    Specifies the attributes that are auto-verified in a user pool.
    
    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 - Specifies the attributes that are auto-verified in a user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerifiedAttributeType
  - withAutoVerifiedAttributes
```
public UserPoolType withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
```
    Specifies the attributes that are auto-verified in a user pool.
    
    Parameters:
    
    autoVerifiedAttributes - Specifies the attributes that are auto-verified in a user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerifiedAttributeType
  - withAutoVerifiedAttributes
```
public UserPoolType withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
```
    Specifies the attributes that are auto-verified in a user pool.
    
    Parameters:
    
    autoVerifiedAttributes - Specifies the attributes that are auto-verified in a user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerifiedAttributeType
  - getAliasAttributes
```
public List<String> getAliasAttributes()
```
    Specifies the attributes that are aliased in a user pool.
    
    Returns:
    
    Specifies the attributes that are aliased in a user pool.
    
    See Also:
    
    AliasAttributeType
  - setAliasAttributes
```
public void setAliasAttributes(Collection<String> aliasAttributes)
```
    Specifies the attributes that are aliased in a user pool.
    
    Parameters:
    
    aliasAttributes - Specifies the attributes that are aliased in a user pool.
    
    See Also:
    
    AliasAttributeType
  - withAliasAttributes
```
public UserPoolType withAliasAttributes(String... aliasAttributes)
```
    Specifies the attributes that are aliased in a user pool.
    
    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 - Specifies the attributes that are aliased in a user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AliasAttributeType
  - withAliasAttributes
```
public UserPoolType withAliasAttributes(Collection<String> aliasAttributes)
```
    Specifies the attributes that are aliased in a user pool.
    
    Parameters:
    
    aliasAttributes - Specifies the attributes that are aliased in a user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AliasAttributeType
  - withAliasAttributes
```
public UserPoolType withAliasAttributes(AliasAttributeType... aliasAttributes)
```
    Specifies the attributes that are aliased in a user pool.
    
    Parameters:
    
    aliasAttributes - Specifies the attributes that are aliased in a user pool.
    
    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 UserPoolType 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 UserPoolType 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 UserPoolType 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)
```
    The contents of the SMS verification message.
    
    Parameters:
    
    smsVerificationMessage - The contents of the SMS verification message.
  - getSmsVerificationMessage
```
public String getSmsVerificationMessage()
```
    The contents of the SMS verification message.
    
    Returns:
    
    The contents of the SMS verification message.
  - withSmsVerificationMessage
```
public UserPoolType withSmsVerificationMessage(String smsVerificationMessage)
```
    The contents of the SMS verification message.
    
    Parameters:
    
    smsVerificationMessage - The contents of 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)
```
    The contents of the email verification message.
    
    Parameters:
    
    emailVerificationMessage - The contents of the email verification message.
  - getEmailVerificationMessage
```
public String getEmailVerificationMessage()
```
    The contents of the email verification message.
    
    Returns:
    
    The contents of the email verification message.
  - withEmailVerificationMessage
```
public UserPoolType withEmailVerificationMessage(String emailVerificationMessage)
```
    The contents of the email verification message.
    
    Parameters:
    
    emailVerificationMessage - The contents of 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)
```
    The subject of the email verification message.
    
    Parameters:
    
    emailVerificationSubject - The subject of the email verification message.
  - getEmailVerificationSubject
```
public String getEmailVerificationSubject()
```
    The subject of the email verification message.
    
    Returns:
    
    The subject of the email verification message.
  - withEmailVerificationSubject
```
public UserPoolType withEmailVerificationSubject(String emailVerificationSubject)
```
    The subject of the email verification message.
    
    Parameters:
    
    emailVerificationSubject - The subject of the email verification message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVerificationMessageTemplate
```
public void setVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
```
    The template for verification messages.
    
    Parameters:
    
    verificationMessageTemplate - The template for verification messages.
  - getVerificationMessageTemplate
```
public VerificationMessageTemplateType getVerificationMessageTemplate()
```
    The template for verification messages.
    
    Returns:
    
    The template for verification messages.
  - withVerificationMessageTemplate
```
public UserPoolType withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
```
    The template for verification messages.
    
    Parameters:
    
    verificationMessageTemplate - The template for verification messages.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSmsAuthenticationMessage
```
public void setSmsAuthenticationMessage(String smsAuthenticationMessage)
```
    The contents of the SMS authentication message.
    
    Parameters:
    
    smsAuthenticationMessage - The contents of the SMS authentication message.
  - getSmsAuthenticationMessage
```
public String getSmsAuthenticationMessage()
```
    The contents of the SMS authentication message.
    
    Returns:
    
    The contents of the SMS authentication message.
  - withSmsAuthenticationMessage
```
public UserPoolType withSmsAuthenticationMessage(String smsAuthenticationMessage)
```
    The contents of the SMS authentication message.
    
    Parameters:
    
    smsAuthenticationMessage - The contents of 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)
```
    Can be one of the following values:
    - OFF - MFA tokens are not required and cannot be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    - OPTIONAL - Users have the option when registering to create an MFA token.
    Parameters:
    mfaConfiguration - Can be one of the following values:
    
    OFF - MFA tokens are not required and cannot be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    
    OPTIONAL - Users have the option when registering to create an MFA token.
    See Also:
    
    UserPoolMfaType
  - getMfaConfiguration
```
public String getMfaConfiguration()
```
    Can be one of the following values:
    - OFF - MFA tokens are not required and cannot be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    - OPTIONAL - Users have the option when registering to create an MFA token.
    Returns:
    Can be one of the following values:
    
    OFF - MFA tokens are not required and cannot be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    
    OPTIONAL - Users have the option when registering to create an MFA token.
    See Also:
    
    UserPoolMfaType
  - withMfaConfiguration
```
public UserPoolType withMfaConfiguration(String mfaConfiguration)
```
    Can be one of the following values:
    - OFF - MFA tokens are not required and cannot be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    - OPTIONAL - Users have the option when registering to create an MFA token.
    Parameters:
    mfaConfiguration - Can be one of the following values:
    
    OFF - MFA tokens are not required and cannot be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    
    OPTIONAL - Users have the option when registering to create an MFA token.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType
  - setMfaConfiguration
```
public void setMfaConfiguration(UserPoolMfaType mfaConfiguration)
```
    Can be one of the following values:
    - OFF - MFA tokens are not required and cannot be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    - OPTIONAL - Users have the option when registering to create an MFA token.
    Parameters:
    mfaConfiguration - Can be one of the following values:
    
    OFF - MFA tokens are not required and cannot be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    
    OPTIONAL - Users have the option when registering to create an MFA token.
    See Also:
    
    UserPoolMfaType
  - withMfaConfiguration
```
public UserPoolType withMfaConfiguration(UserPoolMfaType mfaConfiguration)
```
    Can be one of the following values:
    - OFF - MFA tokens are not required and cannot be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    - OPTIONAL - Users have the option when registering to create an MFA token.
    Parameters:
    mfaConfiguration - Can be one of the following values:
    
    OFF - MFA tokens are not required and cannot be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    
    OPTIONAL - Users have the option when registering to create an MFA token.
    Returns:
    
    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 UserPoolType 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.
  - setEstimatedNumberOfUsers
```
public void setEstimatedNumberOfUsers(Integer estimatedNumberOfUsers)
```
    A number estimating the size of the user pool.
    
    Parameters:
    
    estimatedNumberOfUsers - A number estimating the size of the user pool.
  - getEstimatedNumberOfUsers
```
public Integer getEstimatedNumberOfUsers()
```
    A number estimating the size of the user pool.
    
    Returns:
    
    A number estimating the size of the user pool.
  - withEstimatedNumberOfUsers
```
public UserPoolType withEstimatedNumberOfUsers(Integer estimatedNumberOfUsers)
```
    A number estimating the size of the user pool.
    
    Parameters:
    
    estimatedNumberOfUsers - A number estimating the size of the user pool.
    
    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 UserPoolType 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 UserPoolType 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 cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
    
    Returns:
    
    The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
  - setUserPoolTags
```
public void setUserPoolTags(Map<String,String> userPoolTags)
```
    The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
    
    Parameters:
    
    userPoolTags - The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
  - withUserPoolTags
```
public UserPoolType withUserPoolTags(Map<String,String> userPoolTags)
```
    The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
    
    Parameters:
    
    userPoolTags - The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addUserPoolTagsEntry
```
public UserPoolType addUserPoolTagsEntry(String key,
                                         String value)
```
  - clearUserPoolTagsEntries
```
public UserPoolType clearUserPoolTagsEntries()
```
    Removes all the entries added into UserPoolTags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSmsConfigurationFailure
```
public void setSmsConfigurationFailure(String smsConfigurationFailure)
```
    The reason why the SMS configuration cannot send the messages to your users.
    
    Parameters:
    
    smsConfigurationFailure - The reason why the SMS configuration cannot send the messages to your users.
  - getSmsConfigurationFailure
```
public String getSmsConfigurationFailure()
```
    The reason why the SMS configuration cannot send the messages to your users.
    
    Returns:
    
    The reason why the SMS configuration cannot send the messages to your users.
  - withSmsConfigurationFailure
```
public UserPoolType withSmsConfigurationFailure(String smsConfigurationFailure)
```
    The reason why the SMS configuration cannot send the messages to your users.
    
    Parameters:
    
    smsConfigurationFailure - The reason why the SMS configuration cannot send the messages to your users.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmailConfigurationFailure
```
public void setEmailConfigurationFailure(String emailConfigurationFailure)
```
    The reason why the email configuration cannot send the messages to your users.
    
    Parameters:
    
    emailConfigurationFailure - The reason why the email configuration cannot send the messages to your users.
  - getEmailConfigurationFailure
```
public String getEmailConfigurationFailure()
```
    The reason why the email configuration cannot send the messages to your users.
    
    Returns:
    
    The reason why the email configuration cannot send the messages to your users.
  - withEmailConfigurationFailure
```
public UserPoolType withEmailConfigurationFailure(String emailConfigurationFailure)
```
    The reason why the email configuration cannot send the messages to your users.
    
    Parameters:
    
    emailConfigurationFailure - The reason why the email configuration cannot send the messages to your users.
    
    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 UserPoolType 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.
  - 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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UserPoolType clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class UserPoolType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserPoolType

Method Detail

setId

getId

withId

setName

getName

withName

setPolicies

getPolicies

withPolicies

setLambdaConfig

getLambdaConfig

withLambdaConfig

setStatus

getStatus

withStatus

setStatus

withStatus

setLastModifiedDate

getLastModifiedDate

withLastModifiedDate

setCreationDate

getCreationDate

withCreationDate

getSchemaAttributes

setSchemaAttributes

withSchemaAttributes

withSchemaAttributes

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

setEstimatedNumberOfUsers

getEstimatedNumberOfUsers

withEstimatedNumberOfUsers

setEmailConfiguration

getEmailConfiguration

withEmailConfiguration

setSmsConfiguration