/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::WAFV2::FieldToMatch

NAME

Paws::WAFV2::FieldToMatch

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::WAFV2::FieldToMatch object:

$service_obj->Method(Att1 => { AllQueryArguments => $value, ..., UriPath => $value  });

Results returned from an API call

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

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

DESCRIPTION

The part of a web request that you want WAF to inspect. 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 a web request, create a separate rule statement for each component.

ATTRIBUTES

AllQueryArguments => Paws::WAFV2::AllQueryArguments

Inspect all query arguments.

Body => Paws::WAFV2::Body

Inspect the request body as plain text. 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.

Note that only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

JsonBody => Paws::WAFV2::JsonBody

Inspect the request body as JSON. 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.

Note that only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

Method => Paws::WAFV2::Method

Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

QueryString => Paws::WAFV2::QueryString

Inspect the query string. This is the part of a URL that appears after a ? character, if any.

SingleHeader => Paws::WAFV2::SingleHeader

Inspect a single header. 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" }

SingleQueryArgument => Paws::WAFV2::SingleQueryArgument

Inspect a single query argument. 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.

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

UriPath => Paws::WAFV2::UriPath

Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::WAFV2

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