Struct aws_sdk_cognitoidentityprovider::types::SmsMfaSettingsType

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

The type used for enabling SMS multi-factor authentication (MFA) at the user level. Phone numbers don't need to be verified to be used for SMS MFA. 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. If you would like MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.

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 SMS text 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.

preferred_mfa: bool

Specifies whether SMS is the preferred MFA method.

Implementations

impl SmsMfaSettingsType

pub fn enabled(&self) -> bool

Specifies whether SMS text 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.

pub fn preferred_mfa(&self) -> bool

Specifies whether SMS is the preferred MFA method.

impl SmsMfaSettingsType

pub fn builder() -> SmsMfaSettingsTypeBuilder

Creates a new builder-style object to manufacture SmsMfaSettingsType.

Trait Implementations

impl Clone for SmsMfaSettingsType

fn clone(&self) -> SmsMfaSettingsType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SmsMfaSettingsType

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

Formats the value using the given formatter.

impl PartialEq for SmsMfaSettingsType

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SmsMfaSettingsType