Interface CfnWebACL.ICookiesProperty
Inspect the cookies in the web request.
Namespace: Amazon.CDK.AWS.WAFv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnWebACL.ICookiesPropertySyntax (vb)
Public Interface CfnWebACL.ICookiesPropertyRemarks
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
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. |
Properties
MatchPattern
The filter to use to identify the subset of cookies to inspect in a web request.
object MatchPattern { get; }Property Value
Remarks
You must specify exactly one setting: either All , IncludedCookies , or ExcludedCookies .
Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }
Type union: either IResolvable or CfnWebACL.ICookieMatchPatternProperty
MatchScope
The parts of the cookies to inspect with the rule inspection criteria.
string MatchScope { get; }Property Value
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 cookies of the request are more numerous or larger than AWS WAF can inspect.
string OversizeHandling { get; }Property Value
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: