Class Mfa
The different ways in which a user pool's MFA enforcement can be configured.
Inheritance
System.Object
Mfa
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public sealed class Mfa : Enum
Syntax (vb)
Public NotInheritable Class Mfa
Inherits
Enum
Remarks
See: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html
ExampleMetadata: infused
Examples
new UserPool(this, "myuserpool", new UserPoolProps {
// ...
Mfa = Mfa.REQUIRED,
MfaSecondFactor = new MfaSecondFactor {
Sms = true,
Otp = true
}
});
Synopsis
Fields
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. |
value__ |
Fields
OFF
Users are not required to use MFA for sign in, and cannot configure one.
public const Mfa OFF
Field Value
Type | Description |
---|---|
Mfa |
OPTIONAL
Users are not required to use MFA for sign in, but can configure one if they so choose to.
public const Mfa OPTIONAL
Field Value
Type | Description |
---|---|
Mfa |
REQUIRED
Users are required to configure an MFA, and have to use it to sign in.
public const Mfa REQUIRED
Field Value
Type | Description |
---|---|
Mfa |
value__
public int value__
Field Value
Type | Description |
---|---|
System.Int32 |