Interface CfnByteMatchSet.IByteMatchTupleProperty
AWS WAF Classic support will end on September 30, 2025.
Namespace: Amazon.CDK.AWS.WAF
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnByteMatchSet.IByteMatchTuplePropertySyntax (vb)
Public Interface CfnByteMatchSet.IByteMatchTuplePropertyRemarks
This is <em>AWS WAF Classic</em> documentation. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html">AWS WAF Classic</a> in the developer guide.
For the latest version of AWS WAF , use the AWS WAF V2 API and see the AWS WAF Developer Guide . With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
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.WAF;
var byteMatchTupleProperty = new ByteMatchTupleProperty {
FieldToMatch = new FieldToMatchProperty {
Type = "type",
// the properties below are optional
Data = "data"
},
PositionalConstraint = "positionalConstraint",
TextTransformation = "textTransformation",
// the properties below are optional
TargetString = "targetString",
TargetStringBase64 = "targetStringBase64"
};Synopsis
Properties
| FieldToMatch | The part of a web request that you want to inspect, such as a specified header or a query string. |
| PositionalConstraint | Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. |
| TargetString | The value that you want AWS WAF to search for. |
| TargetStringBase64 | The base64-encoded value that AWS WAF searches for. AWS CloudFormation sends this value to AWS WAF without encoding it. |
| TextTransformation | Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF . |
Properties
FieldToMatch
The part of a web request that you want to inspect, such as a specified header or a query string.
object FieldToMatch { get; }Property Value
Remarks
PositionalConstraint
Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search.
string PositionalConstraint { get; }Property Value
Remarks
Valid values include the following:
CONTAINS
The specified part of the web request must include the value of TargetString , but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of TargetString , and TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, which means one of the following:
EXACTLY
The value of the specified part of the web request must exactly match the value of TargetString .
STARTS_WITH
The value of TargetString must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of TargetString must appear at the end of the specified part of the web request.
TargetString
The value that you want AWS WAF to search for.
string? TargetString { get; }Property Value
Remarks
AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch . The maximum length of the value is 50 bytes.
You must specify this property or the TargetStringBase64 property.
Valid values depend on the values that you specified for FieldToMatch :
If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
TargetStringBase64
The base64-encoded value that AWS WAF searches for. AWS CloudFormation sends this value to AWS WAF without encoding it.
string? TargetStringBase64 { get; }Property Value
Remarks
You must specify this property or the TargetString property.
AWS WAF searches for this value in a specific part of web requests, which you define in the FieldToMatch property.
Valid values depend on the Type value in the FieldToMatch property. For example, for a METHOD type, you must specify HTTP methods such as DELETE, GET, HEAD, OPTIONS, PATCH, POST , and PUT .
TextTransformation
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF .
string TextTransformation { get; }Property Value
Remarks
If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match.
You can only specify a single type of TextTransformation.
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want to perform any text transformations.