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

SmsMfaSettingsType

A user's preference for using SMS message multi-factor authentication (MFA). Turns SMS MFA on and off, and can set SMS as preferred when other MFA options are available. You can't turn off SMS MFA for any of your users when MFA is required in your user pool; you can only set the type that your user prefers.

Types

Builder

class Builder

Companion

object Companion

Properties

enabled

val enabled: Boolean

Specifies whether SMS 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. If true, your user pool prompts the specified user for a code delivered by SMS message after username-password sign-in succeeds.

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