blib/lib/Paws/WAF/RegexMatchTuple.pm untested

filter: Statementstmt 0.0% 0 / 6 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 7 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::WAF::RegexMatchTuple;
3 use Moose;
4 has FieldToMatch => (is => 'ro', isa => 'Paws::WAF::FieldToMatch', required => 1);
5 has RegexPatternSetId => (is => 'ro', isa => 'Str', required => 1);
6 has TextTransformation => (is => 'ro', isa => 'Str', required => 1);
7  
8 1;
9  
10 ### main pod documentation begin ###
11  
12 =head1 NAME
13  
14 Paws::WAF::RegexMatchTuple
15  
16 =head1 USAGE
17  
18 This class represents one of two things:
19  
20 =head3 Arguments in a call to a service
21  
22 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23 Each attribute should be used as a named argument in the calls that expect this type of object.
24  
25 As an example, if Att1 is expected to be a Paws::WAF::RegexMatchTuple object:
26  
27 $service_obj->Method(Att1 => { FieldToMatch => $value, ..., TextTransformation => $value });
28  
29 =head3 Results returned from an API call
30  
31 Use accessors for each attribute. If Att1 is expected to be an Paws::WAF::RegexMatchTuple object:
32  
33 $result = $service_obj->Method(...);
34 $result->Att1->FieldToMatch
35  
36 =head1 DESCRIPTION
37  
38 This is B<AWS WAF Classic> documentation. For more information, see AWS
39 WAF Classic
40 (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
41 in the developer guide.
42  
43 B<For the latest version of AWS WAF>, use the AWS WAFV2 API and see the
44 AWS WAF Developer Guide
45 (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
46 With the latest version, AWS WAF has a single set of endpoints for
47 regional and global use.
48  
49 The regular expression pattern that you want AWS WAF to search for in
50 web requests, the location in requests that you want AWS WAF to search,
51 and other settings. Each C<RegexMatchTuple> object contains:
52  
53 =over
54  
55 =item *
56  
57 The part of a web request that you want AWS WAF to inspect, such as a
58 query string or the value of the C<User-Agent> header.
59  
60 =item *
61  
62 The identifier of the pattern (a regular expression) that you want AWS
63 WAF to look for. For more information, see RegexPatternSet.
64  
65 =item *
66  
67 Whether to perform any conversions on the request, such as converting
68 it to lowercase, before inspecting it for the specified string.
69  
70 =back
71  
72  
73 =head1 ATTRIBUTES
74  
75  
76 =head2 B<REQUIRED> FieldToMatch => L<Paws::WAF::FieldToMatch>
77  
78 Specifies where in a web request to look for the C<RegexPatternSet>.
79  
80  
81 =head2 B<REQUIRED> RegexPatternSetId => Str
82  
83 The C<RegexPatternSetId> for a C<RegexPatternSet>. You use
84 C<RegexPatternSetId> to get information about a C<RegexPatternSet> (see
85 GetRegexPatternSet), update a C<RegexPatternSet> (see
86 UpdateRegexPatternSet), insert a C<RegexPatternSet> into a
87 C<RegexMatchSet> or delete one from a C<RegexMatchSet> (see
88 UpdateRegexMatchSet), and delete an C<RegexPatternSet> from AWS WAF
89 (see DeleteRegexPatternSet).
90  
91 C<RegexPatternSetId> is returned by CreateRegexPatternSet and by
92 ListRegexPatternSets.
93  
94  
95 =head2 B<REQUIRED> TextTransformation => Str
96  
97 Text transformations eliminate some of the unusual formatting that
98 attackers use in web requests in an effort to bypass AWS WAF. If you
99 specify a transformation, AWS WAF performs the transformation on
100 C<RegexPatternSet> before inspecting a request for a match.
101  
102 You can only specify a single type of TextTransformation.
103  
104 B<CMD_LINE>
105  
106 When you're concerned that attackers are injecting an operating system
107 commandline command and using unusual formatting to disguise some or
108 all of the command, use this option to perform the following
109 transformations:
110  
111 =over
112  
113 =item *
114  
115 Delete the following characters: \ " ' ^
116  
117 =item *
118  
119 Delete spaces before the following characters: / (
120  
121 =item *
122  
123 Replace the following characters with a space: , ;
124  
125 =item *
126  
127 Replace multiple spaces with one space
128  
129 =item *
130  
131 Convert uppercase letters (A-Z) to lowercase (a-z)
132  
133 =back
134  
135 B<COMPRESS_WHITE_SPACE>
136  
137 Use this option to replace the following characters with a space
138 character (decimal 32):
139  
140 =over
141  
142 =item *
143  
144 \f, formfeed, decimal 12
145  
146 =item *
147  
148 \t, tab, decimal 9
149  
150 =item *
151  
152 \n, newline, decimal 10
153  
154 =item *
155  
156 \r, carriage return, decimal 13
157  
158 =item *
159  
160 \v, vertical tab, decimal 11
161  
162 =item *
163  
164 non-breaking space, decimal 160
165  
166 =back
167  
168 C<COMPRESS_WHITE_SPACE> also replaces multiple spaces with one space.
169  
170 B<HTML_ENTITY_DECODE>
171  
172 Use this option to replace HTML-encoded characters with unencoded
173 characters. C<HTML_ENTITY_DECODE> performs the following operations:
174  
175 =over
176  
177 =item *
178  
179 Replaces C<(ampersand)quot;> with C<">
180  
181 =item *
182  
183 Replaces C<(ampersand)nbsp;> with a non-breaking space, decimal 160
184  
185 =item *
186  
187 Replaces C<(ampersand)lt;> with a "less than" symbol
188  
189 =item *
190  
191 Replaces C<(ampersand)gt;> with C<E<gt>>
192  
193 =item *
194  
195 Replaces characters that are represented in hexadecimal format,
196 C<(ampersand)(hash)xhhhh;>, with the corresponding characters
197  
198 =item *
199  
200 Replaces characters that are represented in decimal format,
201 C<(ampersand)(hash)nnnn;>, with the corresponding characters
202  
203 =back
204  
205 B<LOWERCASE>
206  
207 Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
208  
209 B<URL_DECODE>
210  
211 Use this option to decode a URL-encoded value.
212  
213 B<NONE>
214  
215 Specify C<NONE> if you don't want to perform any text transformations.
216  
217  
218  
219 =head1 SEE ALSO
220  
221 This class forms part of L<Paws>, describing an object used in L<Paws::WAF>
222  
223 =head1 BUGS and CONTRIBUTIONS
224  
225 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
226  
227 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
228  
229 =cut
230