UpdateUserPoolRequest (AWS SDK for Java

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateUserPoolRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Represents the request to update the 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

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)` Add a single UserPoolTags entry
`UpdateUserPoolRequest`	`clearUserPoolTagsEntries()` Removes all the entries added into UserPoolTags.
`UpdateUserPoolRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`AccountRecoverySettingType`	`getAccountRecoverySetting()` The available verified method a user can use to recover their password when they call `ForgotPassword` .
`AdminCreateUserConfigType`	`getAdminCreateUserConfig()` The configuration for `AdminCreateUser` requests.
`List<String>`	`getAutoVerifiedAttributes()` The attributes that are automatically verified when Amazon Cognito requests to update user pools.
`DeviceConfigurationType`	`getDeviceConfiguration()` Device configuration.
`EmailConfigurationType`	`getEmailConfiguration()` The email configuration of your user pool.
`String`	`getEmailVerificationMessage()` The contents of the email verification message.
`String`	`getEmailVerificationSubject()` The subject of the email verification message.
`LambdaConfigType`	`getLambdaConfig()` The 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 want to update in a user pool.
`String`	`getSmsAuthenticationMessage()` The contents of the SMS authentication message.
`SmsConfigurationType`	`getSmsConfiguration()` The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service.
`String`	`getSmsVerificationMessage()` A container with information about the SMS verification message.
`UserPoolAddOnsType`	`getUserPoolAddOns()` Enables 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)` The available verified method a user can use to recover their password when they call `ForgotPassword` .
`void`	`setAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)` The configuration for `AdminCreateUser` requests.
`void`	`setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)` The attributes that are automatically verified when Amazon Cognito requests to update user pools.
`void`	`setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)` Device configuration.
`void`	`setEmailConfiguration(EmailConfigurationType emailConfiguration)` The email configuration of your user pool.
`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 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 want to update in a user pool.
`void`	`setSmsAuthenticationMessage(String smsAuthenticationMessage)` The contents of the SMS authentication message.
`void`	`setSmsConfiguration(SmsConfigurationType smsConfiguration)` The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service.
`void`	`setSmsVerificationMessage(String smsVerificationMessage)` A container with information about the SMS verification message.
`void`	`setUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)` Enables 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.
`UpdateUserPoolRequest`	`withAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)` The available verified 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 Amazon Cognito requests to update user pools.
`UpdateUserPoolRequest`	`withAutoVerifiedAttributes(String... autoVerifiedAttributes)` The attributes that are automatically verified when Amazon Cognito requests to update user pools.
`UpdateUserPoolRequest`	`withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)` The attributes that are automatically verified when Amazon Cognito requests to update user pools.
`UpdateUserPoolRequest`	`withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)` Device configuration.
`UpdateUserPoolRequest`	`withEmailConfiguration(EmailConfigurationType emailConfiguration)` The email configuration of your user pool.
`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 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 want to update in a user pool.
`UpdateUserPoolRequest`	`withSmsAuthenticationMessage(String smsAuthenticationMessage)` The contents of the SMS authentication message.
`UpdateUserPoolRequest`	`withSmsConfiguration(SmsConfigurationType smsConfiguration)` The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service.
`UpdateUserPoolRequest`	`withSmsVerificationMessage(String smsVerificationMessage)` A container with information about the SMS verification message.
`UpdateUserPoolRequest`	`withUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)` Enables 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 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UpdateUserPoolRequest
```
public UpdateUserPoolRequest()
```
- Method Detail
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The user pool ID for the user pool you want to update.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool you want to update.
  - getUserPoolId
```
public String getUserPoolId()
```
    The user pool ID for the user pool you want to update.
    
    Returns:
    
    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.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool you want to update.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicies
```
public void setPolicies(UserPoolPolicyType policies)
```
    A container with the policies you want to update in a user pool.
    
    Parameters:
    
    policies - A container with the policies you want to update in a user pool.
  - getPolicies
```
public UserPoolPolicyType getPolicies()
```
    A container with the policies you want to update in a user pool.
    
    Returns:
    
    A container with the policies you want to update in a user pool.
  - withPolicies
```
public UpdateUserPoolRequest withPolicies(UserPoolPolicyType policies)
```
    A container with the policies you want to update in a user pool.
    
    Parameters:
    
    policies - A container with the policies you want to update in a 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 configuration information from the request to update the user pool.
    
    Parameters:
    
    lambdaConfig - The Lambda configuration information from the request to update the user pool.
  - getLambdaConfig
```
public LambdaConfigType getLambdaConfig()
```
    The Lambda configuration information from the request to update the user pool.
    
    Returns:
    
    The Lambda configuration information from the request to update the user pool.
  - withLambdaConfig
```
public UpdateUserPoolRequest withLambdaConfig(LambdaConfigType lambdaConfig)
```
    The Lambda configuration information from the request to update the user pool.
    
    Parameters:
    
    lambdaConfig - The Lambda configuration information from the request to update the user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAutoVerifiedAttributes
```
public List<String> getAutoVerifiedAttributes()
```
    The attributes that are automatically verified when Amazon Cognito requests to update user pools.
    
    Returns:
    
    The attributes that are automatically verified when Amazon Cognito requests to update user pools.
    
    See Also:
    
    VerifiedAttributeType
  - setAutoVerifiedAttributes
```
public void setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
```
    The attributes that are automatically verified when Amazon Cognito requests to update user pools.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes that are automatically verified when Amazon Cognito requests to update user pools.
    
    See Also:
    
    VerifiedAttributeType
  - withAutoVerifiedAttributes
```
public UpdateUserPoolRequest withAutoVerifiedAttributes(String... autoVerifiedAttributes)
```
    The attributes that are automatically verified when Amazon Cognito requests to update user pools.
    
    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 that are automatically verified when Amazon Cognito requests to update user pools.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerifiedAttributeType
  - withAutoVerifiedAttributes
```
public UpdateUserPoolRequest withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
```
    The attributes that are automatically verified when Amazon Cognito requests to update user pools.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes that are automatically verified when Amazon Cognito requests to update user pools.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerifiedAttributeType
  - withAutoVerifiedAttributes
```
public UpdateUserPoolRequest withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
```
    The attributes that are automatically verified when Amazon Cognito requests to update user pools.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes that are automatically verified when Amazon Cognito requests to update user pools.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerifiedAttributeType
  - setSmsVerificationMessage
```
public void setSmsVerificationMessage(String smsVerificationMessage)
```
    A container with information about the SMS verification message.
    
    Parameters:
    
    smsVerificationMessage - A container with information about the SMS verification message.
  - getSmsVerificationMessage
```
public String getSmsVerificationMessage()
```
    A container with information about the SMS verification message.
    
    Returns:
    
    A container with information about the SMS verification message.
  - withSmsVerificationMessage
```
public UpdateUserPoolRequest withSmsVerificationMessage(String smsVerificationMessage)
```
    A container with information about the SMS verification message.
    
    Parameters:
    
    smsVerificationMessage - A container with information about 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 UpdateUserPoolRequest 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 UpdateUserPoolRequest 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 UpdateUserPoolRequest 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 UpdateUserPoolRequest 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 aren't required and can't be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
    - OPTIONAL - Users have the option when registering to create an MFA token.
    Parameters:
    mfaConfiguration - Can be one of the following values:
    
    OFF - MFA tokens aren't required and can't be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
    
    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 aren't required and can't be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
    - OPTIONAL - Users have the option when registering to create an MFA token.
    Returns:
    Can be one of the following values:
    
    OFF - MFA tokens aren't required and can't be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
    
    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 aren't required and can't be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
    - OPTIONAL - Users have the option when registering to create an MFA token.
    Parameters:
    mfaConfiguration - Can be one of the following values:
    
    OFF - MFA tokens aren't required and can't be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
    
    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 aren't required and can't be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
    - OPTIONAL - Users have the option when registering to create an MFA token.
    Parameters:
    mfaConfiguration - Can be one of the following values:
    
    OFF - MFA tokens aren't required and can't be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
    
    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 aren't required and can't be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
    - OPTIONAL - Users have the option when registering to create an MFA token.
    Parameters:
    mfaConfiguration - Can be one of the following values:
    
    OFF - MFA tokens aren't required and can't be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
    
    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)
```
    Device configuration.
    
    Parameters:
    
    deviceConfiguration - Device configuration.
  - getDeviceConfiguration
```
public DeviceConfigurationType getDeviceConfiguration()
```
    Device configuration.
    
    Returns:
    
    Device configuration.
  - withDeviceConfiguration
```
public UpdateUserPoolRequest withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
```
    Device configuration.
    
    Parameters:
    
    deviceConfiguration - 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 of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.
    
    Parameters:
    
    emailConfiguration - The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.
  - getEmailConfiguration
```
public EmailConfigurationType getEmailConfiguration()
```
    The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.
    
    Returns:
    
    The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.
  - withEmailConfiguration
```
public UpdateUserPoolRequest withEmailConfiguration(EmailConfigurationType emailConfiguration)
```
    The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.
    
    Parameters:
    
    emailConfiguration - The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSmsConfiguration
```
public void setSmsConfiguration(SmsConfigurationType smsConfiguration)
```
    The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
    
    Parameters:
    
    smsConfiguration - The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
  - getSmsConfiguration
```
public SmsConfigurationType getSmsConfiguration()
```
    The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
    
    Returns:
    
    The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
  - withSmsConfiguration
```
public UpdateUserPoolRequest withSmsConfiguration(SmsConfigurationType smsConfiguration)
```
    The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
    
    Parameters:
    
    smsConfiguration - The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
    
    Returns:
    
    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 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.
    
    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 UpdateUserPoolRequest addUserPoolTagsEntry(String key,
                                                  String value)
```
    Add a single UserPoolTags entry
    
    See Also:
    
    withUserPoolTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearUserPoolTagsEntries
```
public UpdateUserPoolRequest 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 UpdateUserPoolRequest 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.
  - setUserPoolAddOns
```
public void setUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
```
    Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
    
    Parameters:
    
    userPoolAddOns - Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
  - getUserPoolAddOns
```
public UserPoolAddOnsType getUserPoolAddOns()
```
    Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
    
    Returns:
    
    Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
  - withUserPoolAddOns
```
public UpdateUserPoolRequest withUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
```
    Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
    
    Parameters:
    
    userPoolAddOns - Enables 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.
  - setAccountRecoverySetting
```
public void setAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
```
    The available verified method a user can use to recover their password when they call ForgotPassword . You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
    
    Parameters:
    
    accountRecoverySetting - The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
  - getAccountRecoverySetting
```
public AccountRecoverySettingType getAccountRecoverySetting()
```
    The available verified method a user can use to recover their password when they call ForgotPassword . You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
    
    Returns:
    
    The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
  - withAccountRecoverySetting
```
public UpdateUserPoolRequest withAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
```
    The available verified method a user can use to recover their password when they call ForgotPassword . You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
    
    Parameters:
    
    accountRecoverySetting - The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
    
    Returns:
    
    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 UpdateUserPoolRequest 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 UpdateUserPoolRequest

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

UpdateUserPoolRequest

Method Detail

setUserPoolId

getUserPoolId

withUserPoolId

setPolicies

getPolicies

withPolicies

setLambdaConfig

getLambdaConfig

withLambdaConfig

getAutoVerifiedAttributes

setAutoVerifiedAttributes

withAutoVerifiedAttributes

withAutoVerifiedAttributes

withAutoVerifiedAttributes

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

setUserPoolAddOns

getUserPoolAddOns

withUserPoolAddOns

setAccountRecoverySetting

getAccountRecoverySetting

withAccountRecoverySetting

toString

equals

hashCode

clone