Class: Aws::CognitoIdentityProvider::Types::SoftwareTokenMfaConfigType

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

Overview

Settings for time-based one-time password (TOTP) multi-factor authentication (MFA) in a user pool. Enables and disables availability of this feature.

This data type is a request parameter of [SetUserPoolMfaConfig] and a response parameter of [GetUserPoolMfaConfig].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enabled ⇒ Boolean

The activation state of TOTP MFA.

Returns:

  • (Boolean) 


10333
10334
10335
10336
10337
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10333

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