UpdateUserPoolRequest (AWS SDK for Android - Amazon Cognito Identity Provider 2.16.13 API)

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class UpdateUserPoolRequest
extends AmazonWebServiceRequest
implements Serializable
```
Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings with .

If you don't provide a value for an attribute, it will be set to the default value.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

UpdateUserPoolRequest()

Constructors
Constructor and Description
`UpdateUserPoolRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateUserPoolRequest`	`addUserPoolTagsEntry(String key, String value)` The tag keys and values to assign to the user pool.
`UpdateUserPoolRequest`	`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>`	`getAutoVerifiedAttributes()` The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
`DeviceConfigurationType`	`getDeviceConfiguration()` Device configuration.
`EmailConfigurationType`	`getEmailConfiguration()` Email configuration.
`String`	`getEmailVerificationMessage()` The contents of the email verification message.
`String`	`getEmailVerificationSubject()` The subject of the email verification message.
`LambdaConfigType`	`getLambdaConfig()` The AWS Lambda configuration information from the request to update the user pool.
`String`	`getMfaConfiguration()` Can be one of the following values:
`UserPoolPolicyType`	`getPolicies()` A container with the policies you wish to update in a user pool.
`String`	`getSmsAuthenticationMessage()` The contents of the SMS authentication message.
`SmsConfigurationType`	`getSmsConfiguration()` SMS configuration.
`String`	`getSmsVerificationMessage()` A container with information about the SMS verification message.
`UserPoolAddOnsType`	`getUserPoolAddOns()` Used to enable advanced security risk detection.
`String`	`getUserPoolId()` The user pool ID for the user pool you want to update.
`Map<String,String>`	`getUserPoolTags()` The tag keys and values to assign to the user pool.
`VerificationMessageTemplateType`	`getVerificationMessageTemplate()` The template for verification messages.
`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`	`setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)` The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
`void`	`setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)` Device configuration.
`void`	`setEmailConfiguration(EmailConfigurationType emailConfiguration)` Email configuration.
`void`	`setEmailVerificationMessage(String emailVerificationMessage)` The contents of the email verification message.
`void`	`setEmailVerificationSubject(String emailVerificationSubject)` The subject of the email verification message.
`void`	`setLambdaConfig(LambdaConfigType lambdaConfig)` The AWS Lambda configuration information from the request to update the user pool.
`void`	`setMfaConfiguration(String mfaConfiguration)` Can be one of the following values:
`void`	`setMfaConfiguration(UserPoolMfaType mfaConfiguration)` Can be one of the following values:
`void`	`setPolicies(UserPoolPolicyType policies)` A container with the policies you wish to update in a user pool.
`void`	`setSmsAuthenticationMessage(String smsAuthenticationMessage)` The contents of the SMS authentication message.
`void`	`setSmsConfiguration(SmsConfigurationType smsConfiguration)` SMS configuration.
`void`	`setSmsVerificationMessage(String smsVerificationMessage)` A container with information about the SMS verification message.
`void`	`setUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)` Used to enable advanced security risk detection.
`void`	`setUserPoolId(String userPoolId)` The user pool ID for the user pool you want to update.
`void`	`setUserPoolTags(Map<String,String> userPoolTags)` The tag keys and values to assign to 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.
`UpdateUserPoolRequest`	`withAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)` Use this setting to define which verified available method a user can use to recover their password when they call `ForgotPassword`.
`UpdateUserPoolRequest`	`withAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)` The configuration for `AdminCreateUser` requests.
`UpdateUserPoolRequest`	`withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)` The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
`UpdateUserPoolRequest`	`withAutoVerifiedAttributes(String... autoVerifiedAttributes)` The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
`UpdateUserPoolRequest`	`withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)` Device configuration.
`UpdateUserPoolRequest`	`withEmailConfiguration(EmailConfigurationType emailConfiguration)` Email configuration.
`UpdateUserPoolRequest`	`withEmailVerificationMessage(String emailVerificationMessage)` The contents of the email verification message.
`UpdateUserPoolRequest`	`withEmailVerificationSubject(String emailVerificationSubject)` The subject of the email verification message.
`UpdateUserPoolRequest`	`withLambdaConfig(LambdaConfigType lambdaConfig)` The AWS Lambda configuration information from the request to update the user pool.
`UpdateUserPoolRequest`	`withMfaConfiguration(String mfaConfiguration)` Can be one of the following values:
`UpdateUserPoolRequest`	`withMfaConfiguration(UserPoolMfaType mfaConfiguration)` Can be one of the following values:
`UpdateUserPoolRequest`	`withPolicies(UserPoolPolicyType policies)` A container with the policies you wish to update in a user pool.
`UpdateUserPoolRequest`	`withSmsAuthenticationMessage(String smsAuthenticationMessage)` The contents of the SMS authentication message.
`UpdateUserPoolRequest`	`withSmsConfiguration(SmsConfigurationType smsConfiguration)` SMS configuration.
`UpdateUserPoolRequest`	`withSmsVerificationMessage(String smsVerificationMessage)` A container with information about the SMS verification message.
`UpdateUserPoolRequest`	`withUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)` Used to enable advanced security risk detection.
`UpdateUserPoolRequest`	`withUserPoolId(String userPoolId)` The user pool ID for the user pool you want to update.
`UpdateUserPoolRequest`	`withUserPoolTags(Map<String,String> userPoolTags)` The tag keys and values to assign to the user pool.
`UpdateUserPoolRequest`	`withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)` The template for verification messages.

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
  - UpdateUserPoolRequest
```
public UpdateUserPoolRequest()
```
- Method Detail
  - getUserPoolId
```
public String getUserPoolId()
```
    The user pool ID for the user pool you want to update.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Returns:
    
    The user pool ID for the user pool you want to update.
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The user pool ID for the user pool you want to update.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID for the user pool you want to update.
  - withUserPoolId
```
public UpdateUserPoolRequest withUserPoolId(String userPoolId)
```
    The user pool ID for the user pool you want to update.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID for the user pool you want to update.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPolicies
```
public UserPoolPolicyType getPolicies()
```
    A container with the policies you wish to update in a user pool.
    
    Returns:
    
    A container with the policies you wish to update in a user pool.
  - setPolicies
```
public void setPolicies(UserPoolPolicyType policies)
```
    A container with the policies you wish to update in a user pool.
    
    Parameters:
    
    policies -
    A container with the policies you wish to update in a user pool.
  - withPolicies
```
public UpdateUserPoolRequest withPolicies(UserPoolPolicyType policies)
```
    A container with the policies you wish to update in a user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    policies -
    A container with the policies you wish to update in a user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLambdaConfig
```
public LambdaConfigType getLambdaConfig()
```
    The AWS Lambda configuration information from the request to update the user pool.
    
    Returns:
    
    The AWS Lambda configuration information from the request to update the user pool.
  - setLambdaConfig
```
public void setLambdaConfig(LambdaConfigType lambdaConfig)
```
    The AWS Lambda configuration information from the request to update the user pool.
    
    Parameters:
    
    lambdaConfig -
    The AWS Lambda configuration information from the request to update the user pool.
  - withLambdaConfig
```
public UpdateUserPoolRequest withLambdaConfig(LambdaConfigType lambdaConfig)
```
    The AWS Lambda configuration information from the request to update the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    lambdaConfig -
    The AWS Lambda configuration information from the request to update the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAutoVerifiedAttributes
```
public List<String> getAutoVerifiedAttributes()
```
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    Returns:
    
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
  - setAutoVerifiedAttributes
```
public void setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
```
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    Parameters:
    
    autoVerifiedAttributes -
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
  - withAutoVerifiedAttributes
```
public UpdateUserPoolRequest withAutoVerifiedAttributes(String... autoVerifiedAttributes)
```
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    autoVerifiedAttributes -
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withAutoVerifiedAttributes
```
public UpdateUserPoolRequest withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
```
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    autoVerifiedAttributes -
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSmsVerificationMessage
```
public String getSmsVerificationMessage()
```
    A container with information about the SMS verification message.
    
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Returns:
    
    A container with information about the SMS verification message.
  - setSmsVerificationMessage
```
public void setSmsVerificationMessage(String smsVerificationMessage)
```
    A container with information about the SMS verification message.
    
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Parameters:
    
    smsVerificationMessage -
    A container with information about the SMS verification message.
  - withSmsVerificationMessage
```
public UpdateUserPoolRequest withSmsVerificationMessage(String smsVerificationMessage)
```
    A container with information about 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 container with information about the SMS verification message.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEmailVerificationMessage
```
public String getEmailVerificationMessage()
```
    The contents of 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:
    
    The contents of the email verification message.
  - setEmailVerificationMessage
```
public void setEmailVerificationMessage(String emailVerificationMessage)
```
    The contents of 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 -
    The contents of the email verification message.
  - withEmailVerificationMessage
```
public UpdateUserPoolRequest withEmailVerificationMessage(String emailVerificationMessage)
```
    The contents of 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 -
    The contents of the email verification message.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEmailVerificationSubject
```
public String getEmailVerificationSubject()
```
    The subject of the email verification message.
    
    Constraints:
    Length: 1 - 140
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
    
    Returns:
    
    The subject of the email verification message.
  - setEmailVerificationSubject
```
public void setEmailVerificationSubject(String emailVerificationSubject)
```
    The subject of the email verification message.
    
    Constraints:
    Length: 1 - 140
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
    
    Parameters:
    
    emailVerificationSubject -
    The subject of the email verification message.
  - withEmailVerificationSubject
```
public UpdateUserPoolRequest withEmailVerificationSubject(String emailVerificationSubject)
```
    The subject of the email verification message.
    
    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 -
    The subject of the email verification message.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getVerificationMessageTemplate
```
public VerificationMessageTemplateType getVerificationMessageTemplate()
```
    The template for verification messages.
    
    Returns:
    
    The template for verification messages.
  - setVerificationMessageTemplate
```
public void setVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
```
    The template for verification messages.
    
    Parameters:
    
    verificationMessageTemplate -
    The template for verification messages.
  - withVerificationMessageTemplate
```
public UpdateUserPoolRequest withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
```
    The template for verification messages.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    verificationMessageTemplate -
    The template for verification messages.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSmsAuthenticationMessage
```
public String getSmsAuthenticationMessage()
```
    The contents of the SMS authentication message.
    
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Returns:
    
    The contents of the SMS authentication message.
  - setSmsAuthenticationMessage
```
public void setSmsAuthenticationMessage(String smsAuthenticationMessage)
```
    The contents of the SMS authentication message.
    
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Parameters:
    
    smsAuthenticationMessage -
    The contents of the SMS authentication message.
  - withSmsAuthenticationMessage
```
public UpdateUserPoolRequest withSmsAuthenticationMessage(String smsAuthenticationMessage)
```
    The contents of 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 -
    The contents of the SMS authentication message.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    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
  - 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.
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    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 UpdateUserPoolRequest 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    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:
    
    A reference to this updated 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.
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    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 UpdateUserPoolRequest 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType
  - getDeviceConfiguration
```
public DeviceConfigurationType getDeviceConfiguration()
```
    Device configuration.
    
    Returns:
    
    Device configuration.
  - setDeviceConfiguration
```
public void setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
```
    Device configuration.
    
    Parameters:
    
    deviceConfiguration -
    Device configuration.
  - withDeviceConfiguration
```
public UpdateUserPoolRequest withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
```
    Device configuration.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    deviceConfiguration -
    Device configuration.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEmailConfiguration
```
public EmailConfigurationType getEmailConfiguration()
```
    Email configuration.
    
    Returns:
    
    Email configuration.
  - setEmailConfiguration
```
public void setEmailConfiguration(EmailConfigurationType emailConfiguration)
```
    Email configuration.
    
    Parameters:
    
    emailConfiguration -
    Email configuration.
  - withEmailConfiguration
```
public UpdateUserPoolRequest withEmailConfiguration(EmailConfigurationType emailConfiguration)
```
    Email configuration.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    emailConfiguration -
    Email configuration.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSmsConfiguration
```
public SmsConfigurationType getSmsConfiguration()
```
    SMS configuration.
    
    Returns:
    
    SMS configuration.
  - setSmsConfiguration
```
public void setSmsConfiguration(SmsConfigurationType smsConfiguration)
```
    SMS configuration.
    
    Parameters:
    
    smsConfiguration -
    SMS configuration.
  - withSmsConfiguration
```
public UpdateUserPoolRequest withSmsConfiguration(SmsConfigurationType smsConfiguration)
```
    SMS configuration.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    smsConfiguration -
    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 UpdateUserPoolRequest 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 UpdateUserPoolRequest 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 UpdateUserPoolRequest 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 UpdateUserPoolRequest 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.
  - 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 UpdateUserPoolRequest 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.
  - 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.
  - 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.
  - withAccountRecoverySetting
```
public UpdateUserPoolRequest 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.
    
    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.
    
    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 UpdateUserPoolRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateUserPoolRequest

Method Detail

getUserPoolId

setUserPoolId

withUserPoolId

getPolicies

setPolicies

withPolicies

getLambdaConfig

setLambdaConfig

withLambdaConfig

getAutoVerifiedAttributes

setAutoVerifiedAttributes

withAutoVerifiedAttributes

withAutoVerifiedAttributes

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

getUserPoolAddOns

setUserPoolAddOns

withUserPoolAddOns

getAccountRecoverySetting

setAccountRecoverySetting

withAccountRecoverySetting

toString

hashCode

equals