Class: Aws::WAFV2::Types::Headers

Inherits:

Struct

• Object
• Struct
• Aws::WAFV2::Types::Headers

Includes:

Structure

Defined in:

lib/aws-sdk-wafv2/types.rb

Overview

Note:

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

{
  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
}

Inspect the headers in the web request. You can specify the parts of the headers to inspect and you can narrow the set of headers to inspect by including or excluding specific keys.

This is used to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

Alternately, you can use the `SingleHeader` `FieldToMatch` setting to inspect the value of a single header, identified by its key.

Example JSON: `“Headers”: { “MatchPattern”: { “All”: {} }, “MatchScope”: “KEY”, “OversizeHandling”: “MATCH” }`

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #match_pattern ⇒ Types::HeaderMatchPattern

  The filter to use to identify the subset of headers to inspect in a web request.

• #match_scope ⇒ String

  The parts of the headers to match with the rule inspection criteria.

• #oversize_handling ⇒ String

  What WAF should do if the headers of the request are larger than WAF can inspect.

Instance Attribute Details

#match_pattern ⇒ Types::HeaderMatchPattern

The filter to use to identify the subset of headers to inspect in a web request.

You must specify exactly one setting: either `All`, `IncludedHeaders`, or `ExcludedHeaders`.

Example JSON: `“HeaderMatchPattern”: { “ExcludedHeaders”: “KeyToExclude2” }`

Returns:

• (Types::HeaderMatchPattern)

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

class Headers < Struct.new(
  :match_pattern,
  :match_scope,
  :oversize_handling)
  SENSITIVE = []
  include Aws::Structure
end

#match_scope ⇒ String

The parts of the headers to match with the rule inspection criteria. If you specify `All`, WAF inspects both keys and values.

Returns:

• (String)

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

class Headers < Struct.new(
  :match_pattern,
  :match_scope,
  :oversize_handling)
  SENSITIVE = []
  include Aws::Structure
end

#oversize_handling ⇒ String

What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

The options for oversize handling are the following:

• `CONTINUE` - Inspect the headers normally, according to the rule inspection criteria.

• `MATCH` - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• `NO_MATCH` - Treat the web request as not matching the rule statement.

Returns:

• (String)

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

class Headers < Struct.new(
  :match_pattern,
  :match_scope,
  :oversize_handling)
  SENSITIVE = []
  include Aws::Structure
end