Class: Aws::WAFV2::Types::FieldToMatch

Inherits:

Struct

• Object
• Struct
• Aws::WAFV2::Types::FieldToMatch

Defined in:

gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb

Overview

Note:

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

{
  single_header: {
    name: "FieldToMatchData", # required
  },
  single_query_argument: {
    name: "FieldToMatchData", # required
  },
  all_query_arguments: {
  },
  uri_path: {
  },
  query_string: {
  },
  body: {
    oversize_handling: "CONTINUE", # accepts CONTINUE, MATCH, NO_MATCH
  },
  method: {
  },
  json_body: {
    match_pattern: { # required
      all: {
      },
      included_paths: ["JsonPointerPath"],
    },
    match_scope: "ALL", # required, accepts ALL, KEY, VALUE
    invalid_fallback_behavior: "MATCH", # accepts MATCH, NO_MATCH, EVALUATE_AS_STRING
    oversize_handling: "CONTINUE", # accepts CONTINUE, MATCH, NO_MATCH
  },
  headers: {
    match_pattern: { # required
      all: {
      },
      included_headers: ["FieldToMatchData"],
      excluded_headers: ["FieldToMatchData"],
    },
    match_scope: "ALL", # required, accepts ALL, KEY, VALUE
    oversize_handling: "CONTINUE", # required, accepts CONTINUE, MATCH, NO_MATCH
  },
  cookies: {
    match_pattern: { # required
      all: {
      },
      included_cookies: ["SingleCookieName"],
      excluded_cookies: ["SingleCookieName"],
    },
    match_scope: "ALL", # required, accepts ALL, KEY, VALUE
    oversize_handling: "CONTINUE", # required, accepts CONTINUE, MATCH, NO_MATCH
  },
}

The part of the web request that you want WAF to inspect. Include the single FieldToMatch type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in FieldToMatch for each rule statement that requires it. To inspect more than one component of the web request, create a separate rule statement for each component.

Example JSON for a QueryString field to match:

"FieldToMatch": \{ "QueryString": \{\} \}

Example JSON for a Method field to match specification:

"FieldToMatch": \{ "Method": \{ "Name": "DELETE" \} \}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #all_query_arguments ⇒ Types::AllQueryArguments

  Inspect all query arguments.

• #body ⇒ Types::Body

  Inspect the request body as plain text.

• #cookies ⇒ Types::Cookies

  Inspect the request cookies.

• #headers ⇒ Types::Headers

  Inspect the request headers.

• #json_body ⇒ Types::JsonBody

  Inspect the request body as JSON.

• #method ⇒ Types::Method

  Inspect the HTTP method.

• #query_string ⇒ Types::QueryString

  Inspect the query string.

• #single_header ⇒ Types::SingleHeader

  Inspect a single header.

• #single_query_argument ⇒ Types::SingleQueryArgument

  Inspect a single query argument.

• #uri_path ⇒ Types::UriPath

  Inspect the request URI path.

Instance Attribute Details

#all_query_arguments ⇒ Types::AllQueryArguments

Inspect all query arguments.

Returns:

• (Types::AllQueryArguments)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4200

class FieldToMatch < Struct.new(
  :single_header,
  :single_query_argument,
  :all_query_arguments,
  :uri_path,
  :query_string,
  :body,
  :method,
  :json_body,
  :headers,
  :cookies)
  SENSITIVE = []
  include Aws::Structure
end

#body ⇒ Types::Body

Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

Returns:

• (Types::Body)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4200

class FieldToMatch < Struct.new(
  :single_header,
  :single_query_argument,
  :all_query_arguments,
  :uri_path,
  :query_string,
  :body,
  :method,
  :json_body,
  :headers,
  :cookies)
  SENSITIVE = []
  include Aws::Structure
end

#cookies ⇒ Types::Cookies

Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

Returns:

• (Types::Cookies)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4200

class FieldToMatch < Struct.new(
  :single_header,
  :single_query_argument,
  :all_query_arguments,
  :uri_path,
  :query_string,
  :body,
  :method,
  :json_body,
  :headers,
  :cookies)
  SENSITIVE = []
  include Aws::Structure
end

#headers ⇒ Types::Headers

Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

Returns:

• (Types::Headers)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4200

class FieldToMatch < Struct.new(
  :single_header,
  :single_query_argument,
  :all_query_arguments,
  :uri_path,
  :query_string,
  :body,
  :method,
  :json_body,
  :headers,
  :cookies)
  SENSITIVE = []
  include Aws::Structure
end

#json_body ⇒ Types::JsonBody

Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

Returns:

• (Types::JsonBody)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4200

class FieldToMatch < Struct.new(
  :single_header,
  :single_query_argument,
  :all_query_arguments,
  :uri_path,
  :query_string,
  :body,
  :method,
  :json_body,
  :headers,
  :cookies)
  SENSITIVE = []
  include Aws::Structure
end

#method ⇒ Types::Method

Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

Returns:

• (Types::Method)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4200

class FieldToMatch < Struct.new(
  :single_header,
  :single_query_argument,
  :all_query_arguments,
  :uri_path,
  :query_string,
  :body,
  :method,
  :json_body,
  :headers,
  :cookies)
  SENSITIVE = []
  include Aws::Structure
end

#query_string ⇒ Types::QueryString

Inspect the query string. This is the part of a URL that appears after a ? character, if any.

Returns:

• (Types::QueryString)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4200

class FieldToMatch < Struct.new(
  :single_header,
  :single_query_argument,
  :all_query_arguments,
  :uri_path,
  :query_string,
  :body,
  :method,
  :json_body,
  :headers,
  :cookies)
  SENSITIVE = []
  include Aws::Structure
end

#single_header ⇒ Types::SingleHeader

Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

Example JSON: "SingleHeader": \{ "Name": "haystack" \}

Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

Returns:

• (Types::SingleHeader)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4200

class FieldToMatch < Struct.new(
  :single_header,
  :single_query_argument,
  :all_query_arguments,
  :uri_path,
  :query_string,
  :body,
  :method,
  :json_body,
  :headers,
  :cookies)
  SENSITIVE = []
  include Aws::Structure
end

#single_query_argument ⇒ Types::SingleQueryArgument

Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

Example JSON: "SingleQueryArgument": \{ "Name": "myArgument" \}

Returns:

• (Types::SingleQueryArgument)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4200

class FieldToMatch < Struct.new(
  :single_header,
  :single_query_argument,
  :all_query_arguments,
  :uri_path,
  :query_string,
  :body,
  :method,
  :json_body,
  :headers,
  :cookies)
  SENSITIVE = []
  include Aws::Structure
end

#uri_path ⇒ Types::UriPath

Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.

Returns:

• (Types::UriPath)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4200

class FieldToMatch < Struct.new(
  :single_header,
  :single_query_argument,
  :all_query_arguments,
  :uri_path,
  :query_string,
  :body,
  :method,
  :json_body,
  :headers,
  :cookies)
  SENSITIVE = []
  include Aws::Structure
end