All Superinterfaces:

AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>, SdkBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateUserPoolRequest
```
@Mutable
@NotThreadSafe
public static interface UpdateUserPoolRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default UpdateUserPoolRequest.Builder`	`accountRecoverySetting(Consumer<AccountRecoverySettingType.Builder> accountRecoverySetting)`	The available verified method a user can use to recover their password when they call `ForgotPassword`.
`UpdateUserPoolRequest.Builder`	`accountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)`	The available verified method a user can use to recover their password when they call `ForgotPassword`.
`default UpdateUserPoolRequest.Builder`	`adminCreateUserConfig(Consumer<AdminCreateUserConfigType.Builder> adminCreateUserConfig)`	The configuration for administrative creation of users.
`UpdateUserPoolRequest.Builder`	`adminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)`	The configuration for administrative creation of users.
`UpdateUserPoolRequest.Builder`	`autoVerifiedAttributes(Collection<VerifiedAttributeType> autoVerifiedAttributes)`	The attributes that you want your user pool to automatically verify.
`UpdateUserPoolRequest.Builder`	`autoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)`	The attributes that you want your user pool to automatically verify.
`UpdateUserPoolRequest.Builder`	`autoVerifiedAttributesWithStrings(String... autoVerifiedAttributes)`	The attributes that you want your user pool to automatically verify.
`UpdateUserPoolRequest.Builder`	`autoVerifiedAttributesWithStrings(Collection<String> autoVerifiedAttributes)`	The attributes that you want your user pool to automatically verify.
`UpdateUserPoolRequest.Builder`	`deletionProtection(String deletionProtection)`	When active, `DeletionProtection` prevents accidental deletion of your user pool.
`UpdateUserPoolRequest.Builder`	`deletionProtection(DeletionProtectionType deletionProtection)`	When active, `DeletionProtection` prevents accidental deletion of your user pool.
`default UpdateUserPoolRequest.Builder`	`deviceConfiguration(Consumer<DeviceConfigurationType.Builder> deviceConfiguration)`	The device-remembering configuration for a user pool.
`UpdateUserPoolRequest.Builder`	`deviceConfiguration(DeviceConfigurationType deviceConfiguration)`	The device-remembering configuration for a user pool.
`default UpdateUserPoolRequest.Builder`	`emailConfiguration(Consumer<EmailConfigurationType.Builder> emailConfiguration)`	The email configuration of your user pool.
`UpdateUserPoolRequest.Builder`	`emailConfiguration(EmailConfigurationType emailConfiguration)`	The email configuration of your user pool.
`UpdateUserPoolRequest.Builder`	`emailVerificationMessage(String emailVerificationMessage)`	This parameter is no longer used.
`UpdateUserPoolRequest.Builder`	`emailVerificationSubject(String emailVerificationSubject)`	This parameter is no longer used.
`default UpdateUserPoolRequest.Builder`	`lambdaConfig(Consumer<LambdaConfigType.Builder> lambdaConfig)`	A collection of user pool Lambda triggers.
`UpdateUserPoolRequest.Builder`	`lambdaConfig(LambdaConfigType lambdaConfig)`	A collection of user pool Lambda triggers.
`UpdateUserPoolRequest.Builder`	`mfaConfiguration(String mfaConfiguration)`	Sets multi-factor authentication (MFA) to be on, off, or optional.
`UpdateUserPoolRequest.Builder`	`mfaConfiguration(UserPoolMfaType mfaConfiguration)`	Sets multi-factor authentication (MFA) to be on, off, or optional.
`UpdateUserPoolRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`UpdateUserPoolRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`default UpdateUserPoolRequest.Builder`	`policies(Consumer<UserPoolPolicyType.Builder> policies)`	The password policy and sign-in policy in the user pool.
`UpdateUserPoolRequest.Builder`	`policies(UserPoolPolicyType policies)`	The password policy and sign-in policy in the user pool.
`UpdateUserPoolRequest.Builder`	`poolName(String poolName)`	The updated name of your user pool.
`UpdateUserPoolRequest.Builder`	`smsAuthenticationMessage(String smsAuthenticationMessage)`	The contents of the SMS message that your user pool sends to users in SMS authentication.
`default UpdateUserPoolRequest.Builder`	`smsConfiguration(Consumer<SmsConfigurationType.Builder> smsConfiguration)`	The SMS configuration with the settings for your Amazon Cognito user pool to send SMS message with Amazon Simple Notification Service.
`UpdateUserPoolRequest.Builder`	`smsConfiguration(SmsConfigurationType smsConfiguration)`	The SMS configuration with the settings for your Amazon Cognito user pool to send SMS message with Amazon Simple Notification Service.
`UpdateUserPoolRequest.Builder`	`smsVerificationMessage(String smsVerificationMessage)`	This parameter is no longer used.
`default UpdateUserPoolRequest.Builder`	`userAttributeUpdateSettings(Consumer<UserAttributeUpdateSettingsType.Builder> userAttributeUpdateSettings)`	The settings for updates to user attributes.
`UpdateUserPoolRequest.Builder`	`userAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)`	The settings for updates to user attributes.
`default UpdateUserPoolRequest.Builder`	`userPoolAddOns(Consumer<UserPoolAddOnsType.Builder> userPoolAddOns)`	Contains settings for activation of threat protection, including the operating mode and additional authentication types.
`UpdateUserPoolRequest.Builder`	`userPoolAddOns(UserPoolAddOnsType userPoolAddOns)`	Contains settings for activation of threat protection, including the operating mode and additional authentication types.
`UpdateUserPoolRequest.Builder`	`userPoolId(String userPoolId)`	The ID of the user pool you want to update.
`UpdateUserPoolRequest.Builder`	`userPoolTags(Map<String,String> userPoolTags)`	The tag keys and values to assign to the user pool.
`UpdateUserPoolRequest.Builder`	`userPoolTier(String userPoolTier)`	The user pool feature plan, or tier.
`UpdateUserPoolRequest.Builder`	`userPoolTier(UserPoolTierType userPoolTier)`	The user pool feature plan, or tier.
`default UpdateUserPoolRequest.Builder`	`verificationMessageTemplate(Consumer<VerificationMessageTemplateType.Builder> verificationMessageTemplate)`	The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
`UpdateUserPoolRequest.Builder`	`verificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)`	The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields

- Method Detail
  - userPoolId
```
UpdateUserPoolRequest.Builder userPoolId(String userPoolId)
```
    The ID of the user pool you want to update.
    
    Parameters:
    
    userPoolId - The ID of the user pool you want to update.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - policies
```
UpdateUserPoolRequest.Builder policies(UserPoolPolicyType policies)
```
    The password policy and sign-in policy in the user pool. The password policy sets options like password complexity requirements and password history. The sign-in policy sets the options available to applications in choice-based authentication.
    
    Parameters:
    
    policies - The password policy and sign-in policy in the user pool. The password policy sets options like password complexity requirements and password history. The sign-in policy sets the options available to applications in choice-based authentication.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - policies
```
default UpdateUserPoolRequest.Builder policies(Consumer<UserPoolPolicyType.Builder> policies)
```
    The password policy and sign-in policy in the user pool. The password policy sets options like password complexity requirements and password history. The sign-in policy sets the options available to applications in choice-based authentication.
    This is a convenience method that creates an instance of the UserPoolPolicyType.Builder avoiding the need to create one manually via UserPoolPolicyType.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to policies(UserPoolPolicyType).
    
    Parameters:
    
    policies - a consumer that will call methods on UserPoolPolicyType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    policies(UserPoolPolicyType)
  - deletionProtection
```
UpdateUserPoolRequest.Builder deletionProtection(String deletionProtection)
```
    When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    Parameters:
    
    deletionProtection - When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeletionProtectionType, DeletionProtectionType
  - deletionProtection
```
UpdateUserPoolRequest.Builder deletionProtection(DeletionProtectionType deletionProtection)
```
    When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    Parameters:
    
    deletionProtection - When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeletionProtectionType, DeletionProtectionType
  - lambdaConfig
```
UpdateUserPoolRequest.Builder lambdaConfig(LambdaConfigType lambdaConfig)
```
    A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.
    
    Parameters:
    
    lambdaConfig - A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - lambdaConfig
```
default UpdateUserPoolRequest.Builder lambdaConfig(Consumer<LambdaConfigType.Builder> lambdaConfig)
```
    A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.
    This is a convenience method that creates an instance of the LambdaConfigType.Builder avoiding the need to create one manually via LambdaConfigType.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lambdaConfig(LambdaConfigType).
    
    Parameters:
    
    lambdaConfig - a consumer that will call methods on LambdaConfigType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    lambdaConfig(LambdaConfigType)
  - autoVerifiedAttributesWithStrings
```
UpdateUserPoolRequest.Builder autoVerifiedAttributesWithStrings(Collection<String> autoVerifiedAttributes)
```
    The attributes that you want your user pool to automatically verify. Possible values: email, phone_number. For more information see Verifying contact information at sign-up.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes that you want your user pool to automatically verify. Possible values: email, phone_number. For more information see Verifying contact information at sign-up.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - autoVerifiedAttributesWithStrings
```
UpdateUserPoolRequest.Builder autoVerifiedAttributesWithStrings(String... autoVerifiedAttributes)
```
    The attributes that you want your user pool to automatically verify. Possible values: email, phone_number. For more information see Verifying contact information at sign-up.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes that you want your user pool to automatically verify. Possible values: email, phone_number. For more information see Verifying contact information at sign-up.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - autoVerifiedAttributes
```
UpdateUserPoolRequest.Builder autoVerifiedAttributes(Collection<VerifiedAttributeType> autoVerifiedAttributes)
```
    The attributes that you want your user pool to automatically verify. Possible values: email, phone_number. For more information see Verifying contact information at sign-up.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes that you want your user pool to automatically verify. Possible values: email, phone_number. For more information see Verifying contact information at sign-up.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - autoVerifiedAttributes
```
UpdateUserPoolRequest.Builder autoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
```
    The attributes that you want your user pool to automatically verify. Possible values: email, phone_number. For more information see Verifying contact information at sign-up.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes that you want your user pool to automatically verify. Possible values: email, phone_number. For more information see Verifying contact information at sign-up.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - smsVerificationMessage
```
UpdateUserPoolRequest.Builder smsVerificationMessage(String smsVerificationMessage)
```
    This parameter is no longer used.
    
    Parameters:
    
    smsVerificationMessage - This parameter is no longer used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - emailVerificationMessage
```
UpdateUserPoolRequest.Builder emailVerificationMessage(String emailVerificationMessage)
```
    This parameter is no longer used.
    
    Parameters:
    
    emailVerificationMessage - This parameter is no longer used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - emailVerificationSubject
```
UpdateUserPoolRequest.Builder emailVerificationSubject(String emailVerificationSubject)
```
    This parameter is no longer used.
    
    Parameters:
    
    emailVerificationSubject - This parameter is no longer used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - verificationMessageTemplate
```
UpdateUserPoolRequest.Builder verificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
```
    The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
    
    Set the email message type that corresponds to your DefaultEmailOption selection. For CONFIRM_WITH_LINK, specify an EmailMessageByLink and leave EmailMessage blank. For CONFIRM_WITH_CODE, specify an EmailMessage and leave EmailMessageByLink blank. When you supply both parameters with either choice, Amazon Cognito returns an error.
    
    Parameters:
    
    verificationMessageTemplate - The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
    
    Set the email message type that corresponds to your DefaultEmailOption selection. For CONFIRM_WITH_LINK, specify an EmailMessageByLink and leave EmailMessage blank. For CONFIRM_WITH_CODE, specify an EmailMessage and leave EmailMessageByLink blank. When you supply both parameters with either choice, Amazon Cognito returns an error.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - verificationMessageTemplate
```
default UpdateUserPoolRequest.Builder verificationMessageTemplate(Consumer<VerificationMessageTemplateType.Builder> verificationMessageTemplate)
```
    The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
    
    Set the email message type that corresponds to your DefaultEmailOption selection. For CONFIRM_WITH_LINK, specify an EmailMessageByLink and leave EmailMessage blank. For CONFIRM_WITH_CODE, specify an EmailMessage and leave EmailMessageByLink blank. When you supply both parameters with either choice, Amazon Cognito returns an error.
    This is a convenience method that creates an instance of the VerificationMessageTemplateType.Builder avoiding the need to create one manually via VerificationMessageTemplateType.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to verificationMessageTemplate(VerificationMessageTemplateType).
    
    Parameters:
    
    verificationMessageTemplate - a consumer that will call methods on VerificationMessageTemplateType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    verificationMessageTemplate(VerificationMessageTemplateType)
  - smsAuthenticationMessage
```
UpdateUserPoolRequest.Builder smsAuthenticationMessage(String smsAuthenticationMessage)
```
    The contents of the SMS message that your user pool sends to users in SMS authentication.
    
    Parameters:
    
    smsAuthenticationMessage - The contents of the SMS message that your user pool sends to users in SMS authentication.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - userAttributeUpdateSettings
```
UpdateUserPoolRequest.Builder userAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)
```
    The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
    
    Parameters:
    
    userAttributeUpdateSettings - The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - userAttributeUpdateSettings
```
default UpdateUserPoolRequest.Builder userAttributeUpdateSettings(Consumer<UserAttributeUpdateSettingsType.Builder> userAttributeUpdateSettings)
```
    The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
    This is a convenience method that creates an instance of the UserAttributeUpdateSettingsType.Builder avoiding the need to create one manually via UserAttributeUpdateSettingsType.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userAttributeUpdateSettings(UserAttributeUpdateSettingsType).
    
    Parameters:
    
    userAttributeUpdateSettings - a consumer that will call methods on UserAttributeUpdateSettingsType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    userAttributeUpdateSettings(UserAttributeUpdateSettingsType)
  - mfaConfiguration
```
UpdateUserPoolRequest.Builder mfaConfiguration(String mfaConfiguration)
```
    Sets multi-factor authentication (MFA) to be on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL.
    
    When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
    
    Parameters:
    
    mfaConfiguration - Sets multi-factor authentication (MFA) to be on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL.
    
    When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType, UserPoolMfaType
  - mfaConfiguration
```
UpdateUserPoolRequest.Builder mfaConfiguration(UserPoolMfaType mfaConfiguration)
```
    Sets multi-factor authentication (MFA) to be on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL.
    
    When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
    
    Parameters:
    
    mfaConfiguration - Sets multi-factor authentication (MFA) to be on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL.
    
    When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType, UserPoolMfaType
  - deviceConfiguration
```
UpdateUserPoolRequest.Builder deviceConfiguration(DeviceConfigurationType deviceConfiguration)
```
    The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool. A null value indicates that you have deactivated device remembering in your user pool.
    
    When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature. For more information, see Working with devices.
    
    Parameters:
    
    deviceConfiguration - The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool. A null value indicates that you have deactivated device remembering in your user pool.
    
    When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature. For more information, see Working with devices.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - deviceConfiguration
```
default UpdateUserPoolRequest.Builder deviceConfiguration(Consumer<DeviceConfigurationType.Builder> deviceConfiguration)
```
    The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool. A null value indicates that you have deactivated device remembering in your user pool.
    
    When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature. For more information, see Working with devices.
    This is a convenience method that creates an instance of the DeviceConfigurationType.Builder avoiding the need to create one manually via DeviceConfigurationType.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deviceConfiguration(DeviceConfigurationType).
    
    Parameters:
    
    deviceConfiguration - a consumer that will call methods on DeviceConfigurationType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    deviceConfiguration(DeviceConfigurationType)
  - emailConfiguration
```
UpdateUserPoolRequest.Builder emailConfiguration(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.
  - emailConfiguration
```
default UpdateUserPoolRequest.Builder emailConfiguration(Consumer<EmailConfigurationType.Builder> 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.
    This is a convenience method that creates an instance of the EmailConfigurationType.Builder avoiding the need to create one manually via EmailConfigurationType.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to emailConfiguration(EmailConfigurationType).
    
    Parameters:
    
    emailConfiguration - a consumer that will call methods on EmailConfigurationType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    emailConfiguration(EmailConfigurationType)
  - smsConfiguration
```
UpdateUserPoolRequest.Builder smsConfiguration(SmsConfigurationType smsConfiguration)
```
    The SMS configuration with the settings for your Amazon Cognito user pool to send SMS message with 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. For more information see SMS message settings.
    
    Parameters:
    
    smsConfiguration - The SMS configuration with the settings for your Amazon Cognito user pool to send SMS message with 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. For more information see SMS message settings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - smsConfiguration
```
default UpdateUserPoolRequest.Builder smsConfiguration(Consumer<SmsConfigurationType.Builder> smsConfiguration)
```
    The SMS configuration with the settings for your Amazon Cognito user pool to send SMS message with 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. For more information see SMS message settings.
    This is a convenience method that creates an instance of the SmsConfigurationType.Builder avoiding the need to create one manually via SmsConfigurationType.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to smsConfiguration(SmsConfigurationType).
    
    Parameters:
    
    smsConfiguration - a consumer that will call methods on SmsConfigurationType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    smsConfiguration(SmsConfigurationType)
  - userPoolTags
```
UpdateUserPoolRequest.Builder userPoolTags(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.
  - adminCreateUserConfig
```
UpdateUserPoolRequest.Builder adminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
```
    The configuration for administrative creation of users. Includes the template for the invitation message for new users, the duration of temporary passwords, and permitting self-service sign-up.
    
    Parameters:
    
    adminCreateUserConfig - The configuration for administrative creation of users. Includes the template for the invitation message for new users, the duration of temporary passwords, and permitting self-service sign-up.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - adminCreateUserConfig
```
default UpdateUserPoolRequest.Builder adminCreateUserConfig(Consumer<AdminCreateUserConfigType.Builder> adminCreateUserConfig)
```
    The configuration for administrative creation of users. Includes the template for the invitation message for new users, the duration of temporary passwords, and permitting self-service sign-up.
    This is a convenience method that creates an instance of the AdminCreateUserConfigType.Builder avoiding the need to create one manually via AdminCreateUserConfigType.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to adminCreateUserConfig(AdminCreateUserConfigType).
    
    Parameters:
    
    adminCreateUserConfig - a consumer that will call methods on AdminCreateUserConfigType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    adminCreateUserConfig(AdminCreateUserConfigType)
  - userPoolAddOns
```
UpdateUserPoolRequest.Builder userPoolAddOns(UserPoolAddOnsType userPoolAddOns)
```
    Contains settings for activation of threat protection, including the operating mode and additional authentication types. To log user security information but take no action, set to AUDIT. To configure automatic security responses to potentially unwanted traffic to your user pool, set to ENFORCED.
    
    For more information, see Adding advanced security to a user pool. To activate this setting, your user pool must be on the Plus tier.
    
    Parameters:
    
    userPoolAddOns - Contains settings for activation of threat protection, including the operating mode and additional authentication types. To log user security information but take no action, set to AUDIT. To configure automatic security responses to potentially unwanted traffic to your user pool, set to ENFORCED.
    
    For more information, see Adding advanced security to a user pool. To activate this setting, your user pool must be on the Plus tier.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - userPoolAddOns
```
default UpdateUserPoolRequest.Builder userPoolAddOns(Consumer<UserPoolAddOnsType.Builder> userPoolAddOns)
```
    Contains settings for activation of threat protection, including the operating mode and additional authentication types. To log user security information but take no action, set to AUDIT. To configure automatic security responses to potentially unwanted traffic to your user pool, set to ENFORCED.
    
    For more information, see Adding advanced security to a user pool. To activate this setting, your user pool must be on the Plus tier.
    This is a convenience method that creates an instance of the UserPoolAddOnsType.Builder avoiding the need to create one manually via UserPoolAddOnsType.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userPoolAddOns(UserPoolAddOnsType).
    
    Parameters:
    
    userPoolAddOns - a consumer that will call methods on UserPoolAddOnsType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    userPoolAddOns(UserPoolAddOnsType)
  - accountRecoverySetting
```
UpdateUserPoolRequest.Builder accountRecoverySetting(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.
  - accountRecoverySetting
```
default UpdateUserPoolRequest.Builder accountRecoverySetting(Consumer<AccountRecoverySettingType.Builder> 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.
    This is a convenience method that creates an instance of the AccountRecoverySettingType.Builder avoiding the need to create one manually via AccountRecoverySettingType.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accountRecoverySetting(AccountRecoverySettingType).
    
    Parameters:
    
    accountRecoverySetting - a consumer that will call methods on AccountRecoverySettingType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    accountRecoverySetting(AccountRecoverySettingType)
  - poolName
```
UpdateUserPoolRequest.Builder poolName(String poolName)
```
    The updated name of your user pool.
    
    Parameters:
    
    poolName - The updated name of your user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - userPoolTier
```
UpdateUserPoolRequest.Builder userPoolTier(String userPoolTier)
```
    The user pool feature plan, or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ESSENTIALS.
    
    Parameters:
    
    userPoolTier - The user pool feature plan, or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ESSENTIALS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserPoolTierType, UserPoolTierType
  - userPoolTier
```
UpdateUserPoolRequest.Builder userPoolTier(UserPoolTierType userPoolTier)
```
    The user pool feature plan, or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ESSENTIALS.
    
    Parameters:
    
    userPoolTier - The user pool feature plan, or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ESSENTIALS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserPoolTierType, UserPoolTierType
  - overrideConfiguration
```
UpdateUserPoolRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
UpdateUserPoolRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface UpdateUserPoolRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Method Detail

userPoolId

policies

policies

deletionProtection

deletionProtection

lambdaConfig

lambdaConfig

autoVerifiedAttributesWithStrings

autoVerifiedAttributesWithStrings

autoVerifiedAttributes

autoVerifiedAttributes

smsVerificationMessage

emailVerificationMessage

emailVerificationSubject

verificationMessageTemplate

verificationMessageTemplate

smsAuthenticationMessage

userAttributeUpdateSettings

userAttributeUpdateSettings

mfaConfiguration

mfaConfiguration

deviceConfiguration

deviceConfiguration

emailConfiguration

emailConfiguration

smsConfiguration

smsConfiguration

userPoolTags

adminCreateUserConfig

adminCreateUserConfig

userPoolAddOns

userPoolAddOns

accountRecoverySetting

accountRecoverySetting

poolName

userPoolTier

userPoolTier

overrideConfiguration

overrideConfiguration