Package software.amazon.awscdk.services.cognito

Interface MfaSecondFactor

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

MfaSecondFactor.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:44.020Z")
@Stability(Stable)
public interface MfaSecondFactor
extends software.amazon.jsii.JsiiSerializable

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

Example:

 UserPool.Builder.create(this, "myuserpool")
         // ...
         .mfa(Mfa.REQUIRED)
         .mfaSecondFactor(MfaSecondFactor.builder()
                 .sms(true)
                 .otp(true)
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	MfaSecondFactor.Builder	A builder for MfaSecondFactor
static final class	MfaSecondFactor.Jsii$Proxy	An implementation for MfaSecondFactor

Method Summary

Modifier and Type	Method	Description
static MfaSecondFactor.Builder	builder()
Boolean	getOtp()	The MFA token is a time-based one time password that is generated by a hardware or software token.
Boolean	getSms()	The MFA token is sent to the user via SMS to their verified phone numbers.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOtp

@Stability(Stable)
@NotNull
Boolean getOtp()

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

Default: false

See Also:

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

getSms

@Stability(Stable)
@NotNull
Boolean getSms()

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

Default: true

See Also:

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

builder

@Stability(Stable)
static MfaSecondFactor.Builder builder()

Returns:

a MfaSecondFactor.Builder of MfaSecondFactor