aws-cdk-lib.aws_cognito.Mfa

enum Mfa

LanguageType name
.NETAmazon.CDK.AWS.Cognito.Mfa
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#Mfa
Javasoftware.amazon.awscdk.services.cognito.Mfa
Pythonaws_cdk.aws_cognito.Mfa
TypeScript (source)aws-cdk-lib » aws_cognito » Mfa

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

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

Example

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

Members

NameDescription
OFFUsers are not required to use MFA for sign in, and cannot configure one.
OPTIONALUsers are not required to use MFA for sign in, but can configure one if they so choose to.
REQUIREDUsers are required to configure an MFA, and have to use it to sign in.

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.