Interface IMfaSecondFactor

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

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

public interface IMfaSecondFactor

Examples

new UserPool(this, "myuserpool", new UserPoolProps {
                 // ...
                 Mfa = Mfa.REQUIRED,
                 MfaSecondFactor = new MfaSecondFactor {
                     Sms = true,
                     Otp = true
                 }
             });

Remarks

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

ExampleMetadata: infused

Properties

Otp

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

bool Otp { get; }

Property Value

bool

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.

bool Sms { get; }

Property Value

bool

Remarks

Default: true

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