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

SetUserPoolMfaConfigResponse

class SetUserPoolMfaConfigResponse

Types

Builder

class Builder

Companion

object Companion

Properties

emailMfaConfiguration

val emailMfaConfiguration: EmailMfaConfigType?

Shows 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?

Displays multi-factor authentication (MFA) as 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?

Shows user pool SMS message configuration for MFA and sign-in with SMS-message OTPs. Includes the message template and the SMS message sending configuration for Amazon SNS.

softwareTokenMfaConfiguration

val softwareTokenMfaConfiguration: SoftwareTokenMfaConfigType?

Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes TOTP enabled or disabled state.

webAuthnConfiguration

val webAuthnConfiguration: WebAuthnConfigurationType?

The configuration of your user pool for passkey, or WebAuthn, sign-in with authenticators like biometric and security-key devices. Includes relying-party configuration and settings for user-verification requirements.

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String