You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#mfa_configurationString

The multi-factor (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.

Returns:

  • (String)


4986
4987
4988
4989
4990
4991
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4986

class GetUserPoolMfaConfigResponse < Struct.new(
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :mfa_configuration)
  include Aws::Structure
end

#sms_mfa_configurationTypes::SmsMfaConfigType

The SMS text message multi-factor (MFA) configuration.



4986
4987
4988
4989
4990
4991
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4986

class GetUserPoolMfaConfigResponse < Struct.new(
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :mfa_configuration)
  include Aws::Structure
end

#software_token_mfa_configurationTypes::SoftwareTokenMfaConfigType

The software token multi-factor (MFA) configuration.



4986
4987
4988
4989
4990
4991
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4986

class GetUserPoolMfaConfigResponse < Struct.new(
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :mfa_configuration)
  include Aws::Structure
end