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

SmsMfaSettingsType

The type used for enabling SMS multi-factor authentication (MFA) at the user level. Phone numbers don't need to be verified to be used for SMS MFA. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you would like MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.

Types

Builder

class Builder

Companion

object Companion

Properties

enabled

val enabled: Boolean

Specifies whether SMS text message MFA is activated. If an MFA type is activated for a user, 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 SMS is the preferred MFA method.

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String