| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::WAF::FieldToMatch; | ||
| 3 | use Moose; | ||
| 4 | has Data => (is => 'ro', isa => 'Str'); | ||
| 5 | has Type => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::WAF::FieldToMatch | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::WAF::FieldToMatch object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Data => $value, ..., Type => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::WAF::FieldToMatch object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Data | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | This is B<AWS WAF Classic> documentation. For more information, see AWS | ||
| 38 | WAF Classic | ||
| 39 | (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) | ||
| 40 | in the developer guide. | ||
| 41 | |||
| 42 | B<For the latest version of AWS WAF>, use the AWS WAFV2 API and see the | ||
| 43 | AWS WAF Developer Guide | ||
| 44 | (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). | ||
| 45 | With the latest version, AWS WAF has a single set of endpoints for | ||
| 46 | regional and global use. | ||
| 47 | |||
| 48 | Specifies where in a web request to look for C<TargetString>. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Data => Str | ||
| 54 | |||
| 55 | When the value of C<Type> is C<HEADER>, enter the name of the header | ||
| 56 | that you want AWS WAF to search, for example, C<User-Agent> or | ||
| 57 | C<Referer>. The name of the header is not case sensitive. | ||
| 58 | |||
| 59 | When the value of C<Type> is C<SINGLE_QUERY_ARG>, enter the name of the | ||
| 60 | parameter that you want AWS WAF to search, for example, C<UserName> or | ||
| 61 | C<SalesRegion>. The parameter name is not case sensitive. | ||
| 62 | |||
| 63 | If the value of C<Type> is any other value, omit C<Data>. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> Type => Str | ||
| 67 | |||
| 68 | The part of the web request that you want AWS WAF to search for a | ||
| 69 | specified string. Parts of a request that you can search include the | ||
| 70 | following: | ||
| 71 | |||
| 72 | =over | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<HEADER>: A specified request header, for example, the value of the | ||
| 77 | C<User-Agent> or C<Referer> header. If you choose C<HEADER> for the | ||
| 78 | type, specify the name of the header in C<Data>. | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | C<METHOD>: The HTTP method, which indicated the type of operation that | ||
| 83 | the request is asking the origin to perform. Amazon CloudFront supports | ||
| 84 | the following methods: C<DELETE>, C<GET>, C<HEAD>, C<OPTIONS>, | ||
| 85 | C<PATCH>, C<POST>, and C<PUT>. | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<QUERY_STRING>: A query string, which is the part of a URL that | ||
| 90 | appears after a C<?> character, if any. | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | C<URI>: The part of a web request that identifies a resource, for | ||
| 95 | example, C</images/daily-ad.jpg>. | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | C<BODY>: The part of a request that contains any additional data that | ||
| 100 | you want to send to your web server as the HTTP request body, such as | ||
| 101 | data from a form. The request body immediately follows the request | ||
| 102 | headers. Note that only the first C<8192> bytes of the request body are | ||
| 103 | forwarded to AWS WAF for inspection. To allow or block requests based | ||
| 104 | on the length of the body, you can create a size constraint set. For | ||
| 105 | more information, see CreateSizeConstraintSet. | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | C<SINGLE_QUERY_ARG>: The parameter in the query string that you will | ||
| 110 | inspect, such as I<UserName> or I<SalesRegion>. The maximum length for | ||
| 111 | C<SINGLE_QUERY_ARG> is 30 characters. | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | C<ALL_QUERY_ARGS>: Similar to C<SINGLE_QUERY_ARG>, but rather than | ||
| 116 | inspecting a single parameter, AWS WAF will inspect all parameters | ||
| 117 | within the query for the value or regex pattern that you specify in | ||
| 118 | C<TargetString>. | ||
| 119 | |||
| 120 | =back | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head1 SEE ALSO | ||
| 126 | |||
| 127 | This class forms part of L<Paws>, describing an object used in L<Paws::WAF> | ||
| 128 | |||
| 129 | =head1 BUGS and CONTRIBUTIONS | ||
| 130 | |||
| 131 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 132 | |||
| 133 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 134 | |||
| 135 | =cut | ||
| 136 |