Struct SoftwareTokenMfaSettingsType 

#[non_exhaustive]
pub struct SoftwareTokenMfaSettingsType {
    pub enabled: bool,
    pub preferred_mfa: bool,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

enabled: bool

Specifies whether software token 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.

preferred_mfa: bool

Specifies whether software token MFA is the preferred MFA method.

Implementations

impl SoftwareTokenMfaSettingsType

pub fn enabled(&self) -> bool

Specifies whether software token 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.

pub fn preferred_mfa(&self) -> bool

Specifies whether software token MFA is the preferred MFA method.

impl SoftwareTokenMfaSettingsType

pub fn builder() -> SoftwareTokenMfaSettingsTypeBuilder

Creates a new builder-style object to manufacture SoftwareTokenMfaSettingsType.

Trait Implementations

impl Clone for SoftwareTokenMfaSettingsType

fn clone(&self) -> SoftwareTokenMfaSettingsType

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SoftwareTokenMfaSettingsType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SoftwareTokenMfaSettingsType

fn eq(&self, other: &SoftwareTokenMfaSettingsType) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SoftwareTokenMfaSettingsType