aws-cdk-lib.aws_cognito.Mfa

Mfa Enum

The different ways in which a user pool's MFA enforcement can be configured.

Source

aws-cognito/lib/user-pool.ts

Example

new cognito.UserPool(this, 'myuserpool', {
  // ...
  mfa: cognito.Mfa.REQUIRED,
  mfaSecondFactor: {
    sms: true,
    otp: true,
    email: false, // email-based MFA
  },
});

Members

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

Referenced by

• UserPoolProps.mfamfamfaMfaMfa