software.amazon.awscdk.services.cognito

Enum Mfa

java.lang.Object

java.lang.Enum<Mfa>

software.amazon.awscdk.services.cognito.Mfa

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Mfa>

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:57.367Z")
public enum Mfa
extends java.lang.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:

https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html

Enum Constant Summary

Enum Constants

Enum Constant and Description
OFF Users are not required to use MFA for sign in, and cannot configure one.
OPTIONAL Users are not required to use MFA for sign in, but can configure one if they so choose to.
REQUIRED Users are required to configure an MFA, and have to use it to sign in.

Method Summary

Modifier and Type	Method and Description
static Mfa	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Mfa[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OFF

public static final Mfa OFF

Users are not required to use MFA for sign in, and cannot configure one.

OPTIONAL

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

public static final Mfa REQUIRED

Users are required to configure an MFA, and have to use it to sign in.

Method Detail

values

public static Mfa[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Mfa c : Mfa.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Mfa valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null