Class CfnWebACL.FieldToMatchProperty
The part of the web request that you want AWS WAF to inspect.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.WAFv2
Assembly: Amazon.CDK.AWS.WAFv2.dll
Syntax (csharp)
public class FieldToMatchProperty : Object, CfnWebACL.IFieldToMatchPropertySyntax (vb)
Public Class FieldToMatchProperty
Inherits Object
Implements CfnWebACL.IFieldToMatchPropertyRemarks
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" } }
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 allQueryArguments;
var method;
var queryString;
var singleHeader;
var singleQueryArgument;
var uriPath;
var fieldToMatchProperty = new FieldToMatchProperty {
AllQueryArguments = allQueryArguments,
Body = new BodyProperty {
OversizeHandling = "oversizeHandling"
},
Cookies = new CookiesProperty {
MatchPattern = new CookieMatchPatternProperty {
All = all,
ExcludedCookies = new [] { "excludedCookies" },
IncludedCookies = new [] { "includedCookies" }
},
MatchScope = "matchScope",
OversizeHandling = "oversizeHandling"
},
Headers = new HeadersProperty {
MatchPattern = new HeaderMatchPatternProperty {
All = all,
ExcludedHeaders = new [] { "excludedHeaders" },
IncludedHeaders = new [] { "includedHeaders" }
},
MatchScope = "matchScope",
OversizeHandling = "oversizeHandling"
},
JsonBody = new JsonBodyProperty {
MatchPattern = new JsonMatchPatternProperty {
All = all,
IncludedPaths = new [] { "includedPaths" }
},
MatchScope = "matchScope",
// the properties below are optional
InvalidFallbackBehavior = "invalidFallbackBehavior",
OversizeHandling = "oversizeHandling"
},
Method = method,
QueryString = queryString,
SingleHeader = singleHeader,
SingleQueryArgument = singleQueryArgument,
UriPath = uriPath
};Synopsis
Constructors
| FieldToMatchProperty() |
Properties
| AllQueryArguments | Inspect all query arguments. |
| Body | Inspect the request body as plain text. |
| Cookies | Inspect the request cookies. |
| Headers | Inspect the request headers. |
| JsonBody | Inspect the request body as JSON. |
| Method | Inspect the HTTP method. |
| QueryString | Inspect the query string. |
| SingleHeader | Inspect a single header. |
| SingleQueryArgument | Inspect a single query argument. |
| UriPath | Inspect the request URI path. |
Constructors
FieldToMatchProperty()
public FieldToMatchProperty()Properties
AllQueryArguments
Inspect all query arguments.
public object AllQueryArguments { get; set; }Property Value
System.Object
Remarks
Body
Inspect the request body as plain text.
public object Body { get; set; }Property Value
System.Object
Remarks
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.
A limited amount of the request body is forwarded to AWS WAF for inspection by the underlying host service. For regional resources, the limit is 8 KB (8,192 kilobytes) and for CloudFront distributions, the limit is 16 KB (16,384 kilobytes). For CloudFront distributions, you can increase the limit in the web ACL's AssociationConfig , for additional processing fees.
For information about how to handle oversized request bodies, see the Body object configuration.
Cookies
Inspect the request cookies.
public object Cookies { get; set; }Property Value
System.Object
Remarks
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 AWS WAF inspects.
Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.
Headers
Inspect the request headers.
public object Headers { get; set; }Property Value
System.Object
Remarks
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 AWS WAF inspects.
Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service.
JsonBody
Inspect the request body as JSON.
public object JsonBody { get; set; }Property Value
System.Object
Remarks
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.
A limited amount of the request body is forwarded to AWS WAF for inspection by the underlying host service. For regional resources, the limit is 8 KB (8,192 kilobytes) and for CloudFront distributions, the limit is 16 KB (16,384 kilobytes). For CloudFront distributions, you can increase the limit in the web ACL's AssociationConfig , for additional processing fees.
For information about how to handle oversized request bodies, see the JsonBody object configuration.
Method
Inspect the HTTP method.
public object Method { get; set; }Property Value
System.Object
Remarks
The method indicates the type of operation that the request is asking the origin to perform.
QueryString
Inspect the query string.
public object QueryString { get; set; }Property Value
System.Object
Remarks
This is the part of a URL that appears after a ? character, if any.
SingleHeader
Inspect a single header.
public object SingleHeader { get; set; }Property Value
System.Object
Remarks
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.
SingleQueryArgument
Inspect a single query argument.
public object SingleQueryArgument { get; set; }Property Value
System.Object
Remarks
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" }
UriPath
Inspect the request URI path.
public object UriPath { get; set; }Property Value
System.Object
Remarks
This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .