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

SetUserPoolMfaConfigRequest

class SetUserPoolMfaConfigRequest

Types

Builder

class Builder

Companion

object Companion

Properties

emailMfaConfiguration

val emailMfaConfiguration: EmailMfaConfigType?

Sets configuration for user pool email message MFA and sign-in with one-time passwords (OTPs). Includes the subject and body of the email message template for sign-in and MFA messages. To activate this setting, your user pool must be in the Essentials tier or higher.

mfaConfiguration

val mfaConfiguration: UserPoolMfaType?

Sets multi-factor authentication (MFA) to be on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL.

smsMfaConfiguration

val smsMfaConfiguration: SmsMfaConfigType?

Configures user pool SMS messages for MFA. Sets the message template and the SMS message sending configuration for Amazon SNS.

softwareTokenMfaConfiguration

val softwareTokenMfaConfiguration: SoftwareTokenMfaConfigType?

Configures a user pool for time-based one-time password (TOTP) MFA. Enables or disables TOTP.

userPoolId

val userPoolId: String?

The user pool ID.

webAuthnConfiguration

val webAuthnConfiguration: WebAuthnConfigurationType?

The configuration of your user pool for passkey, or WebAuthn, authentication and registration. You can set this configuration independent of the MFA configuration options in this operation.

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String