Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface UpdateUserPoolRequest.Builder

    • Method Detail

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

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

        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.

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

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

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

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

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

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

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

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

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

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

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