Class CfnRuleGroup.CookiesProperty
Inspect the cookies in the web request.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.WAFv2
Assembly: Amazon.CDK.AWS.WAFv2.dll
Syntax (csharp)
public class CookiesProperty : Object, CfnRuleGroup.ICookiesProperty
Syntax (vb)
Public Class CookiesProperty
Inherits Object
Implements CfnRuleGroup.ICookiesProperty
Remarks
You can specify the parts of the cookies to inspect and you can narrow the set of cookies to inspect by including or excluding specific keys.
This is used to indicate the web request component to inspect, in the FieldToMatch
specification.
Example JSON: "Cookies": { "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 cookiesProperty = new CookiesProperty {
MatchPattern = new CookieMatchPatternProperty {
All = all,
ExcludedCookies = new [] { "excludedCookies" },
IncludedCookies = new [] { "includedCookies" }
},
MatchScope = "matchScope",
OversizeHandling = "oversizeHandling"
};
Synopsis
Constructors
CookiesProperty() |
Properties
MatchPattern | The filter to use to identify the subset of cookies to inspect in a web request. |
MatchScope | The parts of the cookies to inspect with the rule inspection criteria. |
OversizeHandling | What AWS WAF should do if the cookies of the request are more numerous or larger than AWS WAF can inspect. |
Constructors
CookiesProperty()
public CookiesProperty()
Properties
MatchPattern
The filter to use to identify the subset of cookies to inspect in a web request.
public object MatchPattern { get; set; }
Property Value
System.Object
Remarks
You must specify exactly one setting: either All
, IncludedCookies
, or ExcludedCookies
.
Example JSON: "MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }
MatchScope
The parts of the cookies to inspect with the rule inspection criteria.
public string MatchScope { get; set; }
Property Value
System.String
Remarks
If you specify All
, AWS WAF inspects both keys and values.
OversizeHandling
What AWS WAF should do if the cookies of the request are more numerous or larger than AWS WAF can inspect.
public string OversizeHandling { get; set; }
Property Value
System.String
Remarks
AWS WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to AWS WAF .
The options for oversize handling are the following: