Class CfnByteMatchSet.ByteMatchTupleProperty.Jsii$Proxy
- All Implemented Interfaces:
CfnByteMatchSet.ByteMatchTupleProperty
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnByteMatchSet.ByteMatchTupleProperty
CfnByteMatchSet.ByteMatchTupleProperty
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.waf.CfnByteMatchSet.ByteMatchTupleProperty
CfnByteMatchSet.ByteMatchTupleProperty.Builder, CfnByteMatchSet.ByteMatchTupleProperty.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theCfnByteMatchSet.ByteMatchTupleProperty.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Object
The part of a web request that you want to inspect, such as a specified header or a query string.final String
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.final String
The value that you want AWS WAF to search for.final String
The base64-encoded value that AWS WAF searches for.final String
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF .final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnByteMatchSet.ByteMatchTupleProperty.Builder
.
-
-
Method Details
-
getFieldToMatch
Description copied from interface:CfnByteMatchSet.ByteMatchTupleProperty
The part of a web request that you want to inspect, such as a specified header or a query string.- Specified by:
getFieldToMatch
in interfaceCfnByteMatchSet.ByteMatchTupleProperty
-
getPositionalConstraint
Description copied from interface:CfnByteMatchSet.ByteMatchTupleProperty
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.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
, andTargetString
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:TargetString
exactly matches the value of the specified part of the web request, such as the value of a header.TargetString
is at the beginning of the specified part of the web request and is followed by a character other than an alphanumeric character or underscore (_), for example,BadBot;
.TargetString
is at the end of the specified part of the web request and is preceded by a character other than an alphanumeric character or underscore (_), for example,;BadBot
.TargetString
is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example,-BadBot;
.
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.- Specified by:
getPositionalConstraint
in interfaceCfnByteMatchSet.ByteMatchTupleProperty
-
getTextTransformation
Description copied from interface:CfnByteMatchSet.ByteMatchTupleProperty
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF .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:
- Delete the following characters: \ " ' ^
- Delete spaces before the following characters: / (
- Replace the following characters with a space: , ;
- Replace multiple spaces with one space
- Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
- \f, formfeed, decimal 12
- \t, tab, decimal 9
- \n, newline, decimal 10
- \r, carriage return, decimal 13
- \v, vertical tab, decimal 11
- non-breaking space, decimal 160
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:- Replaces
(ampersand)quot;
with"
- Replaces
(ampersand)nbsp;
with a non-breaking space, decimal 160 - Replaces
(ampersand)lt;
with a "less than" symbol - Replaces
(ampersand)gt;
with>
- Replaces characters that are represented in hexadecimal format,
(ampersand)#xhhhh;
, with the corresponding characters - Replaces characters that are represented in decimal format,
(ampersand)#nnnn;
, with the corresponding characters
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.- Specified by:
getTextTransformation
in interfaceCfnByteMatchSet.ByteMatchTupleProperty
-
getTargetString
Description copied from interface:CfnByteMatchSet.ByteMatchTupleProperty
The value that you want AWS WAF to search for.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
:HEADER
: The value that you want AWS WAF to search for in the request header that you specified inFieldToMatch
, for example, the value of theUser-Agent
orReferer
header.METHOD
: The HTTP method, which indicates the type of operation specified in the request. Amazon CloudFront supports the following methods:DELETE
,GET
,HEAD
,OPTIONS
,PATCH
,POST
, andPUT
.QUERY_STRING
: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a?
character.URI
: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example,/images/daily-ad.jpg
.BODY
: 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. The request body immediately follows the request headers. Note that only the first8192
bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set.SINGLE_QUERY_ARG
: The parameter in the query string that you will inspect, such as UserName or SalesRegion . The maximum length forSINGLE_QUERY_ARG
is 30 characters.ALL_QUERY_ARGS
: Similar toSINGLE_QUERY_ARG
, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify inTargetString
.
If
TargetString
includes alphabetic characters A-Z and a-z, note that the value is case sensitive.- Specified by:
getTargetString
in interfaceCfnByteMatchSet.ByteMatchTupleProperty
-
getTargetStringBase64
Description copied from interface:CfnByteMatchSet.ByteMatchTupleProperty
The base64-encoded value that AWS WAF searches for. AWS CloudFormation sends this value to AWS WAF without encoding it.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 aMETHOD
type, you must specify HTTP methods such asDELETE, GET, HEAD, OPTIONS, PATCH, POST
, andPUT
.- Specified by:
getTargetStringBase64
in interfaceCfnByteMatchSet.ByteMatchTupleProperty
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-