Class: Aws::CognitoIdentityProvider::Types::GetUserPoolMfaConfigResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#email_mfa_configuration ⇒ Types::EmailMfaConfigType

Shows user pool email message configuration for MFA. Includes the subject and body of the email message template for MFA messages. To activate this setting, advanced security features must be active in your user pool.

Returns:



6486
6487
6488
6489
6490
6491
6492
6493
6494
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6486

class GetUserPoolMfaConfigResponse < Struct.new(
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :email_mfa_configuration,
  :mfa_configuration,
  :web_authn_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#mfa_configuration ⇒ String

The multi-factor authentication (MFA) configuration. Valid values include:

  • OFF MFA won't 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 activated.

Returns:

  • (String) 


6486
6487
6488
6489
6490
6491
6492
6493
6494
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6486

class GetUserPoolMfaConfigResponse < Struct.new(
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :email_mfa_configuration,
  :mfa_configuration,
  :web_authn_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#sms_mfa_configuration ⇒ Types::SmsMfaConfigType

Shows user pool SMS message configuration for MFA. Includes the message template and the SMS message sending configuration for Amazon SNS.

Returns:



6486
6487
6488
6489
6490
6491
6492
6493
6494
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6486

class GetUserPoolMfaConfigResponse < Struct.new(
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :email_mfa_configuration,
  :mfa_configuration,
  :web_authn_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#software_token_mfa_configuration ⇒ Types::SoftwareTokenMfaConfigType

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

Returns:



6486
6487
6488
6489
6490
6491
6492
6493
6494
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6486

class GetUserPoolMfaConfigResponse < Struct.new(
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :email_mfa_configuration,
  :mfa_configuration,
  :web_authn_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#web_authn_configuration ⇒ Types::WebAuthnConfigurationType

Shows user pool configuration for MFA with passkeys from biometric devices and security keys.

Returns:



6486
6487
6488
6489
6490
6491
6492
6493
6494
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6486

class GetUserPoolMfaConfigResponse < Struct.new(
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :email_mfa_configuration,
  :mfa_configuration,
  :web_authn_configuration)
  SENSITIVE = []
  include Aws::Structure
end