Class MfaSecondFactor

The different ways in which a user pool can obtain their MFA token for sign in.

Inheritance
System.Object
MfaSecondFactor
Implements
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class MfaSecondFactor : Object, IMfaSecondFactor
Syntax (vb)
Public Class MfaSecondFactor
    Inherits Object
    Implements IMfaSecondFactor
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,
        Email = false
    }
});

Synopsis

Constructors

MfaSecondFactor()

Properties

Email

The MFA token is sent to the user via EMAIL.
Otp

The MFA token is a time-based one time password that is generated by a hardware or software token.
Sms

The MFA token is sent to the user via SMS to their verified phone numbers.

Constructors

MfaSecondFactor()

public MfaSecondFactor()

Properties

Email

The MFA token is sent to the user via EMAIL.

public Nullable<bool> Email { get; set; }
Property Value

System.Nullable<System.Boolean>

Remarks

To enable email-based MFA, set email property to the Amazon SES email-sending configuration and set feturePlan to FeaturePlan.ESSENTIALS or FeaturePlan.PLUS

Default: false

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

Otp

The MFA token is a time-based one time password that is generated by a hardware or software token.

public bool Otp { get; set; }
Property Value

System.Boolean

Remarks

Default: false

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

Sms

The MFA token is sent to the user via SMS to their verified phone numbers.

public bool Sms { get; set; }
Property Value

System.Boolean

Remarks

Default: true

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

Implements