cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/AdminSetUserMfaPreferenceRequest/Builder

Builder

Properties

var emailMfaSettings: EmailMfaSettingsType?

User preferences for email message MFA. 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.

smsMfaSettings

var smsMfaSettings: SmsMfaSettingsType?

User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as the preferred MFA method when multiple methods are available.

softwareTokenMfaSettings

var softwareTokenMfaSettings: SoftwareTokenMfaSettingsType?

User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates TOTP MFA and sets it as the preferred MFA method when multiple methods are available.

username

var username: String?

The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

userPoolId

var userPoolId: String?

The ID of the user pool where you want to set a user's MFA preferences.

webAuthnMfaSettings

var webAuthnMfaSettings: WebAuthnMfaSettingsType?

User preferences for passkey MFA. Activates or deactivates passkey MFA for the user. When activated, passkey authentication requires user verification, and passkey sign-in is available when MFA is required. To activate this setting, the FactorConfiguration of your user pool WebAuthnConfiguration must be MULTI_FACTOR_WITH_USER_VERIFICATION. To activate this setting, your user pool must be in the Essentials tier or higher.

Functions

emailMfaSettings

fun emailMfaSettings(block: EmailMfaSettingsType.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.cognitoidentityprovider.model.EmailMfaSettingsType inside the given block

smsMfaSettings

fun smsMfaSettings(block: SmsMfaSettingsType.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.cognitoidentityprovider.model.SmsMfaSettingsType inside the given block

softwareTokenMfaSettings

fun softwareTokenMfaSettings(block: SoftwareTokenMfaSettingsType.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.cognitoidentityprovider.model.SoftwareTokenMfaSettingsType inside the given block

webAuthnMfaSettings

fun webAuthnMfaSettings(block: WebAuthnMfaSettingsType.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.cognitoidentityprovider.model.WebAuthnMfaSettingsType inside the given block