Struct SetUserPoolMfaConfigOutput 

#[non_exhaustive]
pub struct SetUserPoolMfaConfigOutput {
    pub sms_mfa_configuration: Option<SmsMfaConfigType>,
    pub software_token_mfa_configuration: Option<SoftwareTokenMfaConfigType>,
    pub email_mfa_configuration: Option<EmailMfaConfigType>,
    pub mfa_configuration: Option<UserPoolMfaType>,
    pub web_authn_configuration: Option<WebAuthnConfigurationType>,
    /* private fields */
}

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.

sms_mfa_configuration: Option<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.

software_token_mfa_configuration: Option<SoftwareTokenMfaConfigType>

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

email_mfa_configuration: Option<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.

mfa_configuration: Option<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.

When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.

web_authn_configuration: Option<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.

Implementations

impl SetUserPoolMfaConfigOutput

pub fn sms_mfa_configuration(&self) -> Option<&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.

pub fn software_token_mfa_configuration( &self, ) -> Option<&SoftwareTokenMfaConfigType>

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

pub fn email_mfa_configuration(&self) -> Option<&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.

pub fn mfa_configuration(&self) -> Option<&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.

When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.

pub fn web_authn_configuration(&self) -> Option<&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.

impl SetUserPoolMfaConfigOutput

pub fn builder() -> SetUserPoolMfaConfigOutputBuilder

Creates a new builder-style object to manufacture SetUserPoolMfaConfigOutput.

Trait Implementations

impl Clone for SetUserPoolMfaConfigOutput

fn clone(&self) -> SetUserPoolMfaConfigOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SetUserPoolMfaConfigOutput

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

Formats the value using the given formatter.

impl PartialEq for SetUserPoolMfaConfigOutput

fn eq(&self, other: &SetUserPoolMfaConfigOutput) -> 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 RequestId for SetUserPoolMfaConfigOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for SetUserPoolMfaConfigOutput