cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/EmailMfaSettingsType

EmailMfaSettingsType

User preferences for multi-factor authentication with email messages. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, your user pool must be in the Essentials tier or higher.

Types

Builder

class Builder

Companion

object Companion

Properties

enabled

val enabled: Boolean

Specifies whether email message MFA is active for a user. When the value of this parameter is Enabled, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.

preferredMfa

val preferredMfa: Boolean

Specifies whether email message MFA is the user's preferred method.

Functions

copy

inline fun copy(block: EmailMfaSettingsType.Builder.() -> Unit = {}): EmailMfaSettingsType

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String