Class: Aws::CognitoIdentityProvider::Types::SoftwareTokenMfaSettingsType

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

Overview

Note:

When making an API call, you may pass SoftwareTokenMfaSettingsType data as a hash:

{
  enabled: false,
  preferred_mfa: false,
}

The type used for enabling software token MFA at the user level. If an MFA type is enabled 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, disable MFA for users and turn on Adaptive Authentication for the user pool.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

Specifies whether software token MFA is enabled. If an MFA type is enabled 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.

Returns:

  • (Boolean)


8499
8500
8501
8502
8503
8504
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8499

class SoftwareTokenMfaSettingsType < Struct.new(
  :enabled,
  :preferred_mfa)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_mfaBoolean

Specifies whether software token MFA is the preferred MFA method.

Returns:

  • (Boolean)


8499
8500
8501
8502
8503
8504
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8499

class SoftwareTokenMfaSettingsType < Struct.new(
  :enabled,
  :preferred_mfa)
  SENSITIVE = []
  include Aws::Structure
end