NAME

Paws::WAF::RegexMatchTuple

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::WAF::RegexMatchTuple object:

  $service_obj->Method(Att1 => { FieldToMatch => $value, ..., TextTransformation => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::WAF::RegexMatchTuple object:

  $result = $service_obj->Method(...);
  $result->Att1->FieldToMatch

DESCRIPTION

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The regular expression pattern 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. Each "RegexMatchTuple" object contains:

The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the "User-Agent" header.
The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

ATTRIBUTES

REQUIRED FieldToMatch => Paws::WAF::FieldToMatch

Specifies where in a web request to look for the "RegexPatternSet".

REQUIRED RegexPatternSetId => Str

The "RegexPatternSetId" for a "RegexPatternSet". You use "RegexPatternSetId" to get information about a "RegexPatternSet" (see GetRegexPatternSet), update a "RegexPatternSet" (see UpdateRegexPatternSet), insert a "RegexPatternSet" into a "RegexMatchSet" or delete one from a "RegexMatchSet" (see UpdateRegexMatchSet), and delete an "RegexPatternSet" from AWS WAF (see DeleteRegexPatternSet).

"RegexPatternSetId" is returned by CreateRegexPatternSet and by ListRegexPatternSets.

REQUIRED TextTransformation => Str

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 "RegexPatternSet" before inspecting a request 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 commandline 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)(hash)xhhhh;", with the corresponding characters
Replaces characters that are represented in decimal format, "(ampersand)(hash)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.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>