# Generated by default/object.tt package Paws::WAFV2::ByteMatchStatement; use Moose; has FieldToMatch => (is => 'ro', isa => 'Paws::WAFV2::FieldToMatch', required => 1); has PositionalConstraint => (is => 'ro', isa => 'Str', required => 1); has SearchString => (is => 'ro', isa => 'Str', required => 1); has TextTransformations => (is => 'ro', isa => 'ArrayRef[Paws::WAFV2::TextTransformation]', required => 1); 1; ### main pod documentation begin ### =head1 NAME Paws::WAFV2::ByteMatchStatement =head1 USAGE This class represents one of two things: =head3 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::ByteMatchStatement object: $service_obj->Method(Att1 => { FieldToMatch => $value, ..., TextTransformations => $value }); =head3 Results returned from an API call Use accessors for each attribute. If Att1 is expected to be an Paws::WAFV2::ByteMatchStatement object: $result = $service_obj->Method(...); $result->Att1->FieldToMatch =head1 DESCRIPTION A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is refered to as a string match statement. =head1 ATTRIBUTES =head2 B FieldToMatch => L The part of a web request that you want WAF to inspect. For more information, see FieldToMatch. =head2 B PositionalConstraint => Str The area within the portion of a web request that you want WAF to search for C. Valid values include the following: B The specified part of the web request must include the value of C, but the location doesn't matter. B The specified part of the web request must include the value of C, and C must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, C must be a word, which means that both of the following are true: =over =item * C is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and C<;BadBot>. =item * C is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, C and C<-BadBot;>. =back B The value of the specified part of the web request must exactly match the value of C. B The value of C must appear at the beginning of the specified part of the web request. B The value of C must appear at the end of the specified part of the web request. =head2 B SearchString => Str A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 50 bytes. Valid values depend on the component that you specify for inspection in C: =over =item * C: The HTTP method that you want WAF to search for. This indicates the type of operation specified in the request. =item * C: The value that you want WAF to search for in the URI path, for example, C. =back If C includes alphabetic characters A-Z and a-z, note that the value is case sensitive. B Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes. For example, suppose the value of C is C

and the value of C is C. If you want to search the C header for the value C, you base64-encode C using MIME base64-encoding and include the resulting value, C, in the value of C. B The value that you want WAF to search for. The SDK automatically base64 encodes the value. =head2 B TextTransformations => ArrayRef[L] Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by C, starting from the lowest priority setting, before inspecting the content for a match. =head1 SEE ALSO This class forms part of L, describing an object used in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut