Interface CfnWebACL.IByteMatchStatementProperty
A rule statement that defines a string match search for AWS WAF to apply to web requests.
Namespace: Amazon.CDK.AWS.WAFv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IByteMatchStatementPropertySyntax (vb)
Public Interface IByteMatchStatementPropertyRemarks
The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is called a string match statement.
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 byteMatchStatementProperty = new ByteMatchStatementProperty {
FieldToMatch = 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"
},
Ja3Fingerprint = new JA3FingerprintProperty {
FallbackBehavior = "fallbackBehavior"
},
Ja4Fingerprint = new JA4FingerprintProperty {
FallbackBehavior = "fallbackBehavior"
},
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
},
PositionalConstraint = "positionalConstraint",
TextTransformations = new [] { new TextTransformationProperty {
Priority = 123,
Type = "type"
} },
// the properties below are optional
SearchString = "searchString",
SearchStringBase64 = "searchStringBase64"
};Synopsis
Properties
| Field |
The part of the web request that you want AWS WAF to inspect. |
| Positional |
The area within the portion of the web request that you want AWS WAF to search for |
| Search |
A string value that you want AWS WAF to search for. |
| Search |
String to search for in a web request component, base64-encoded. |
| Text |
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. |
Properties
FieldToMatch
The part of the web request that you want AWS WAF to inspect.
object FieldToMatch { get; }Property Value
System.
Remarks
PositionalConstraint
The area within the portion of the web request that you want AWS WAF to search for SearchString .
string PositionalConstraint { get; }Property Value
System.
Remarks
Valid values include the following:
CONTAINS
The specified part of the web request must include the value of SearchString , but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of SearchString , and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:
EXACTLY
The value of the specified part of the web request must exactly match the value of SearchString .
STARTS_WITH
The value of SearchString must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of SearchString must appear at the end of the specified part of the web request.
SearchString
A string value that you want AWS WAF to search for.
virtual string SearchString { get; }Property Value
System.
Remarks
AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch . The maximum length of the value is 200 bytes. For alphabetic characters A-Z and a-z, the value is case sensitive.
Don't encode this string. Provide the value that you want AWS WAF to search for. AWS CloudFormation automatically base64 encodes the value for you.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent . If you want to search the User-Agent header for the value BadBot , you provide the string BadBot in the value of SearchString .
You must specify either SearchString or SearchStringBase64 in a ByteMatchStatement .
SearchStringBase64
String to search for in a web request component, base64-encoded.
virtual string SearchStringBase64 { get; }Property Value
System.
Remarks
If you don't want to encode the string, specify the unencoded value in SearchString instead.
You must specify either SearchString or SearchStringBase64 in a ByteMatchStatement .
TextTransformations
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
object TextTransformations { get; }Property Value
System.
Remarks
If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.