Class: Aws::Lightsail::Types::WafAtpConfig

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

Overview

Describes the configuration of the account takeover prevention Web Application Firewall (WAF) rule group. The rule group inspects login requests to the login path of your application.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#login_path ⇒ String

The path of the login endpoint of your application (for example, /login). Login paths that start with the path that you specify are a match.

Constraints:

  • Must start with a forward slash (/).

  • Must contain from 1 to 256 characters.

Returns:

  • (String) 


15975
15976
15977
15978
15979
15980
15981
15982
15983
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15975

class WafAtpConfig < Struct.new(
  :login_path,
  :payload_type,
  :username_field,
  :password_field,
  :response_inspection)
  SENSITIVE = []
  include Aws::Structure
end

#password_field ⇒ String

The name of the field in the request body that contains the password (for example, /password for JSON or password for FORM_ENCODED).

Constraints:

  • For a JSON payload, must be a JSON pointer that starts with a forward slash (/).

  • Must contain from 1 to 512 characters.

Returns:

  • (String) 


15975
15976
15977
15978
15979
15980
15981
15982
15983
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15975

class WafAtpConfig < Struct.new(
  :login_path,
  :payload_type,
  :username_field,
  :password_field,
  :response_inspection)
  SENSITIVE = []
  include Aws::Structure
end

#payload_type ⇒ String

The content type of the request body of login requests.

The following content types are possible:

  • JSON – The request body is in JSON format.

  • FORM_ENCODED – The request body is form encoded.

Returns:

  • (String) 


15975
15976
15977
15978
15979
15980
15981
15982
15983
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15975

class WafAtpConfig < Struct.new(
  :login_path,
  :payload_type,
  :username_field,
  :password_field,
  :response_inspection)
  SENSITIVE = []
  include Aws::Structure
end

#response_inspection ⇒ Types::WafResponseInspection

An object that describes the HTTP status codes that your application returns for successful and failed login attempts.

Returns:



15975
15976
15977
15978
15979
15980
15981
15982
15983
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15975

class WafAtpConfig < Struct.new(
  :login_path,
  :payload_type,
  :username_field,
  :password_field,
  :response_inspection)
  SENSITIVE = []
  include Aws::Structure
end

#username_field ⇒ String

The name of the field in the request body that contains the username (for example, /username for JSON or username for FORM_ENCODED).

Constraints:

  • For a JSON payload, must be a JSON pointer that starts with a forward slash (/).

  • Must contain from 1 to 512 characters.

Returns:

  • (String) 


15975
15976
15977
15978
15979
15980
15981
15982
15983
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15975

class WafAtpConfig < Struct.new(
  :login_path,
  :payload_type,
  :username_field,
  :password_field,
  :response_inspection)
  SENSITIVE = []
  include Aws::Structure
end