Interface CfnRuleGroup.IHeadersProperty
Inspect all headers in the web request.
Namespace: Amazon.CDK.AWS.WAFv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IHeadersProperty
Syntax (vb)
Public Interface IHeadersProperty
Remarks
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 to inspect, in the FieldToMatch
specification.
If you want to inspect just the value of a single header, use the SingleHeader
FieldToMatch
setting instead.
Example JSON: "Headers": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WAFv2;
var all;
var headersProperty = new HeadersProperty {
MatchPattern = new HeaderMatchPatternProperty {
All = all,
ExcludedHeaders = new [] { "excludedHeaders" },
IncludedHeaders = new [] { "includedHeaders" }
},
MatchScope = "matchScope",
OversizeHandling = "oversizeHandling"
};
Synopsis
Properties
MatchPattern | The filter to use to identify the subset of headers to inspect in a web request. |
MatchScope | The parts of the headers to match with the rule inspection criteria. |
OversizeHandling | What AWS WAF should do if the headers of the request are more numerous or larger than AWS WAF can inspect. |
Properties
MatchPattern
The filter to use to identify the subset of headers to inspect in a web request.
object MatchPattern { get; }
Property Value
System.Object
Remarks
You must specify exactly one setting: either All
, IncludedHeaders
, or ExcludedHeaders
.
Example JSON: "MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }
MatchScope
The parts of the headers to match with the rule inspection criteria.
string MatchScope { get; }
Property Value
System.String
Remarks
If you specify ALL
, AWS WAF inspects both keys and values.
All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND
statement to combine two match rules, one that inspects the keys and another that inspects the values.
OversizeHandling
What AWS WAF should do if the headers of the request are more numerous or larger than AWS WAF can inspect.
string OversizeHandling { get; }
Property Value
System.String
Remarks
AWS 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 AWS WAF .
The options for oversize handling are the following: