java.lang.Object
java.lang.Enum<Mfa>
software.amazon.awscdk.services.cognito.Mfa
All Implemented Interfaces:
Serializable, Comparable<Mfa>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.019Z") @Stability(Stable) public enum Mfa extends Enum<Mfa>
The different ways in which a user pool's MFA enforcement can be configured.

Example:

 UserPool.Builder.create(this, "myuserpool")
         // ...
         .mfa(Mfa.REQUIRED)
         .mfaSecondFactor(MfaSecondFactor.builder()
                 .sms(true)
                 .otp(true)
                 .build())
         .build();
 

See Also:
  • Enum Constant Details

    • OFF

      @Stability(Stable) public static final Mfa OFF
      Users are not required to use MFA for sign in, and cannot configure one.
    • OPTIONAL

      @Stability(Stable) public static final Mfa OPTIONAL
      Users are not required to use MFA for sign in, but can configure one if they so choose to.
    • REQUIRED

      @Stability(Stable) public static final Mfa REQUIRED
      Users are required to configure an MFA, and have to use it to sign in.
  • Method Details

    • values

      public static Mfa[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static Mfa valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null