Interface SetUserPoolMfaConfigRequest.Builder

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

  • Method Details

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

    • smsMfaConfiguration

      default SetUserPoolMfaConfigRequest.Builder smsMfaConfiguration(Consumer<SmsMfaConfigType.Builder> smsMfaConfiguration)

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

      This is a convenience method that creates an instance of the SmsMfaConfigType.Builder avoiding the need to create one manually via SmsMfaConfigType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to smsMfaConfiguration(SmsMfaConfigType).

      Parameters:
      smsMfaConfiguration - a consumer that will call methods on SmsMfaConfigType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • softwareTokenMfaConfiguration

      default SetUserPoolMfaConfigRequest.Builder softwareTokenMfaConfiguration(Consumer<SoftwareTokenMfaConfigType.Builder> softwareTokenMfaConfiguration)

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

      This is a convenience method that creates an instance of the SoftwareTokenMfaConfigType.Builder avoiding the need to create one manually via SoftwareTokenMfaConfigType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to softwareTokenMfaConfiguration(SoftwareTokenMfaConfigType).

      Parameters:
      softwareTokenMfaConfiguration - a consumer that will call methods on SoftwareTokenMfaConfigType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • emailMfaConfiguration

      default SetUserPoolMfaConfigRequest.Builder emailMfaConfiguration(Consumer<EmailMfaConfigType.Builder> 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.

      This is a convenience method that creates an instance of the EmailMfaConfigType.Builder avoiding the need to create one manually via EmailMfaConfigType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to emailMfaConfiguration(EmailMfaConfigType).

      Parameters:
      emailMfaConfiguration - a consumer that will call methods on EmailMfaConfigType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

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

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

    • webAuthnConfiguration

      default SetUserPoolMfaConfigRequest.Builder webAuthnConfiguration(Consumer<WebAuthnConfigurationType.Builder> 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.

      This is a convenience method that creates an instance of the WebAuthnConfigurationType.Builder avoiding the need to create one manually via WebAuthnConfigurationType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to webAuthnConfiguration(WebAuthnConfigurationType).

      Parameters:
      webAuthnConfiguration - a consumer that will call methods on WebAuthnConfigurationType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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