Class: Aws::AmplifyBackend::Types::CreateBackendAuthMFAConfig

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

Overview

Note:

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

{
  mfa_mode: "ON", # required, accepts ON, OFF, OPTIONAL
  settings: {
    mfa_types: ["SMS"], # accepts SMS, TOTP
    sms_message: "__string",
  },
}

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#mfa_modeString

Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.

Returns:

  • (String)


956
957
958
959
960
961
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 956

class CreateBackendAuthMFAConfig < Struct.new(
  :mfa_mode,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#settingsTypes::Settings

Describes the configuration settings and methods for your Amplify app users to use MFA.

Returns:



956
957
958
959
960
961
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 956

class CreateBackendAuthMFAConfig < Struct.new(
  :mfa_mode,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end