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

Interface SetUserPoolMfaConfigRequest.Builder

    • Method Detail

      • userPoolId

        SetUserPoolMfaConfigRequest.Builder userPoolId​(String userPoolId)

        The user pool ID.

        Parameters:
        userPoolId - The user pool ID.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • smsMfaConfiguration

        SetUserPoolMfaConfigRequest.Builder smsMfaConfiguration​(SmsMfaConfigType smsMfaConfiguration)

        Configures user pool SMS messages for MFA. Sets the message template and the SMS message sending configuration for Amazon SNS.

        Parameters:
        smsMfaConfiguration - Configures user pool SMS messages for MFA. Sets the message template and the SMS message sending configuration for Amazon SNS.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • softwareTokenMfaConfiguration

        SetUserPoolMfaConfigRequest.Builder softwareTokenMfaConfiguration​(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration)

        Configures a user pool for time-based one-time password (TOTP) MFA. Enables or disables TOTP.

        Parameters:
        softwareTokenMfaConfiguration - Configures a user pool for time-based one-time password (TOTP) MFA. Enables or disables TOTP.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • emailMfaConfiguration

        SetUserPoolMfaConfigRequest.Builder emailMfaConfiguration​(EmailMfaConfigType emailMfaConfiguration)

        Sets configuration for user pool email message MFA and sign-in with one-time passwords (OTPs). Includes the subject and body of the email message template for sign-in and MFA messages. To activate this setting, your user pool must be in the Essentials tier or higher.

        Parameters:
        emailMfaConfiguration - Sets configuration for user pool email message MFA and sign-in with one-time passwords (OTPs). Includes the subject and body of the email message template for sign-in and MFA messages. To activate this setting, your user pool must be in the Essentials tier or higher.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mfaConfiguration

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

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

      • webAuthnConfiguration

        SetUserPoolMfaConfigRequest.Builder webAuthnConfiguration​(WebAuthnConfigurationType webAuthnConfiguration)

        The configuration of your user pool for passkey, or WebAuthn, authentication and registration. You can set this configuration independent of the MFA configuration options in this operation.

        Parameters:
        webAuthnConfiguration - The configuration of your user pool for passkey, or WebAuthn, authentication and registration. You can set this configuration independent of the MFA configuration options in this operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.