Class: Aws::CognitoIdentityProvider::Types::SetUserPoolMfaConfigResponse

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::SetUserPoolMfaConfigResponse

Defined in:

(unknown)

Overview

Returned by:

• Client#set_user_pool_mfa_config

See Also:

• AWS API Documentation

Instance Attribute Summary

• #mfa_configuration ⇒ String

  The MFA configuration.

• #sms_mfa_configuration ⇒ Types::SmsMfaConfigType

  The SMS text message MFA configuration.

• #software_token_mfa_configuration ⇒ Types::SoftwareTokenMfaConfigType

  The software token MFA configuration.

Instance Attribute Details

#mfa_configuration ⇒ String

The MFA configuration. Valid values include:

• OFF MFA will not be used for any users.

• ON MFA is required for all users to sign in.

• OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.

  Possible values:

  • OFF
  • ON
  • OPTIONAL

Returns:

• (String) —

  The MFA configuration.

#sms_mfa_configuration ⇒ Types::SmsMfaConfigType

The SMS text message MFA configuration.

Returns:

• (Types::SmsMfaConfigType) —

  The SMS text message MFA configuration.

#software_token_mfa_configuration ⇒ Types::SoftwareTokenMfaConfigType

The software token MFA configuration.

Returns:

• (Types::SoftwareTokenMfaConfigType) —

  The software token MFA configuration.