Interface UpdateUserPoolRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>, SdkBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateUserPoolRequest
public static interface UpdateUserPoolRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>

  • Method Details

    • userPoolId

      UpdateUserPoolRequest.Builder userPoolId(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.

    • policies

      UpdateUserPoolRequest.Builder policies(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.

    • policies

      default UpdateUserPoolRequest.Builder policies(Consumer<UserPoolPolicyType.Builder> policies)

      A container with the policies you want to update in a user pool.

      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:

    • 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:

    • 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:

    • lambdaConfig

      UpdateUserPoolRequest.Builder lambdaConfig(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.

    • lambdaConfig

      default UpdateUserPoolRequest.Builder lambdaConfig(Consumer<LambdaConfigType.Builder> lambdaConfig)

      The Lambda configuration information from the request to update the user pool.

      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:

    • autoVerifiedAttributesWithStrings

      UpdateUserPoolRequest.Builder autoVerifiedAttributesWithStrings(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.

    • autoVerifiedAttributesWithStrings

      UpdateUserPoolRequest.Builder autoVerifiedAttributesWithStrings(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.

    • autoVerifiedAttributes

      UpdateUserPoolRequest.Builder autoVerifiedAttributes(Collection<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.

    • autoVerifiedAttributes

      UpdateUserPoolRequest.Builder autoVerifiedAttributes(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.

    • smsVerificationMessage

      UpdateUserPoolRequest.Builder smsVerificationMessage(String smsVerificationMessage)

      This parameter is no longer used. See VerificationMessageTemplateType.

      Parameters:
      smsVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.
      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. See VerificationMessageTemplateType.

      Parameters:
      emailVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.
      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. See VerificationMessageTemplateType.

      Parameters:
      emailVerificationSubject - This parameter is no longer used. See VerificationMessageTemplateType.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • verificationMessageTemplate

      UpdateUserPoolRequest.Builder verificationMessageTemplate(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.

    • verificationMessageTemplate

      default UpdateUserPoolRequest.Builder verificationMessageTemplate(Consumer<VerificationMessageTemplateType.Builder> verificationMessageTemplate)

      The template for verification messages.

      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:

    • smsAuthenticationMessage

      UpdateUserPoolRequest.Builder smsAuthenticationMessage(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.

    • 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:

    • mfaConfiguration

      UpdateUserPoolRequest.Builder mfaConfiguration(String mfaConfiguration)

      Possible values include:

      • 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 - Possible values include:

      • 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:

    • mfaConfiguration

      UpdateUserPoolRequest.Builder mfaConfiguration(UserPoolMfaType mfaConfiguration)

      Possible values include:

      • 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 - Possible values include:

      • 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:

    • deviceConfiguration

      UpdateUserPoolRequest.Builder deviceConfiguration(DeviceConfigurationType deviceConfiguration)

      The device-remembering configuration for a 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.

      Parameters:
      deviceConfiguration - The device-remembering configuration for a 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.

      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. 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.

      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:

    • 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:

    • smsConfiguration

      UpdateUserPoolRequest.Builder smsConfiguration(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.

    • smsConfiguration

      default UpdateUserPoolRequest.Builder smsConfiguration(Consumer<SmsConfigurationType.Builder> 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.

      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:

    • 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 AdminCreateUser requests.

      Parameters:
      adminCreateUserConfig - The configuration for AdminCreateUser requests.
      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 AdminCreateUser requests.

      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:

    • userPoolAddOns

      UpdateUserPoolRequest.Builder userPoolAddOns(UserPoolAddOnsType userPoolAddOns)

      User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

      For more information, see Adding advanced security to a user pool.

      Parameters:
      userPoolAddOns - User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

      For more information, see Adding advanced security to a user pool.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userPoolAddOns

      default UpdateUserPoolRequest.Builder userPoolAddOns(Consumer<UserPoolAddOnsType.Builder> userPoolAddOns)

      User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

      For more information, see Adding advanced security to a user pool.

      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:

    • 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:

    • overrideConfiguration

      UpdateUserPoolRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateUserPoolRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.