Class: Aws::WAFV2::Types::RequestInspection

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

Overview

The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

This is part of the ‘AWSManagedRulesATPRuleSet` configuration in `ManagedRuleGroupConfig`.

In these settings, you specify how your application accepts login attempts by providing the request payload type and the names of the fields within the request body where the username and password are provided.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#password_field ⇒ Types::PasswordField

The name of the field in the request payload that contains your customer’s password.

How you specify this depends on the request inspection payload type.

  • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation [JavaScript Object Notation (JSON) Pointer].

    For example, for the JSON payload ‘{ “form”: { “password”: “THE_PASSWORD” } }`, the password field specification is `/form/password`.

  • For form encoded payload types, use the HTML form names.

    For example, for an HTML form with the input element named ‘password1`, the password field specification is `password1`.

[1]: tools.ietf.org/html/rfc6901

Returns:



7128
7129
7130
7131
7132
7133
7134
 
# File 'lib/aws-sdk-wafv2/types.rb', line 7128

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

#payload_type ⇒ String

The payload type for your login endpoint, either JSON or form encoded.

Returns:

  • (String) 


7128
7129
7130
7131
7132
7133
7134
 
# File 'lib/aws-sdk-wafv2/types.rb', line 7128

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

#username_field ⇒ Types::UsernameField

The name of the field in the request payload that contains your customer’s username.

How you specify this depends on the request inspection payload type.

  • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation [JavaScript Object Notation (JSON) Pointer].

    For example, for the JSON payload ‘{ “form”: { “username”: “THE_USERNAME” } }`, the username field specification is `/form/username`.

  • For form encoded payload types, use the HTML form names.

    For example, for an HTML form with the input element named ‘username1`, the username field specification is `username1`

[1]: tools.ietf.org/html/rfc6901

Returns:



7128
7129
7130
7131
7132
7133
7134
 
# File 'lib/aws-sdk-wafv2/types.rb', line 7128

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