blib/lib/Paws/WAFV2/UpdateRuleGroup.pm untested

filter: Statementstmt 0.0% 0 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::WAFV2::UpdateRuleGroup;
3 use Moose;
4 has CustomResponseBodies => (is => 'ro', isa => 'Paws::WAFV2::CustomResponseBodies');
5 has Description => (is => 'ro', isa => 'Str');
6 has Id => (is => 'ro', isa => 'Str', required => 1);
7 has LockToken => (is => 'ro', isa => 'Str', required => 1);
8 has Name => (is => 'ro', isa => 'Str', required => 1);
9 has Rules => (is => 'ro', isa => 'ArrayRef[Paws::WAFV2::Rule]');
10 has Scope => (is => 'ro', isa => 'Str', required => 1);
11 has VisibilityConfig => (is => 'ro', isa => 'Paws::WAFV2::VisibilityConfig', required => 1);
12  
13 use MooseX::ClassAttribute;
14  
15 class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateRuleGroup');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WAFV2::UpdateRuleGroupResponse');
17 class_has _result_key => (isa => 'Str', is => 'ro');
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::WAFV2::UpdateRuleGroup - Arguments for method UpdateRuleGroup on L<Paws::WAFV2>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method UpdateRuleGroup on the
29 L<AWS WAFV2|Paws::WAFV2> service. Use the attributes of this class
30 as arguments to method UpdateRuleGroup.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateRuleGroup.
33  
34 =head1 SYNOPSIS
35  
36 my $wafv2 = Paws->service('WAFV2');
37 my $UpdateRuleGroupResponse = $wafv2->UpdateRuleGroup(
38 Id => 'MyEntityId',
39 LockToken => 'MyLockToken',
40 Name => 'MyEntityName',
41 Scope => 'CLOUDFRONT',
42 VisibilityConfig => {
43 CloudWatchMetricsEnabled => 1,
44 MetricName => 'MyMetricName', # min: 1, max: 255
45 SampledRequestsEnabled => 1,
46  
47 },
48 CustomResponseBodies => {
49 'MyEntityName' => {
50 Content => 'MyResponseContent', # min: 1, max: 10240
51 ContentType =>
52 'TEXT_PLAIN', # values: TEXT_PLAIN, TEXT_HTML, APPLICATION_JSON
53  
54 }, # key: min: 1, max: 128
55 }, # OPTIONAL
56 Description => 'MyEntityDescription', # OPTIONAL
57 Rules => [
58 {
59 Name => 'MyEntityName', # min: 1, max: 128
60 Priority => 1,
61 Statement => {
62 AndStatement => {
63 Statements => [ <Statement>, ... ],
64  
65 }, # OPTIONAL
66 ByteMatchStatement => {
67 FieldToMatch => {
68 AllQueryArguments => {
69  
70 }, # OPTIONAL
71 Body => {
72  
73 }, # OPTIONAL
74 JsonBody => {
75 MatchPattern => {
76 All => {
77  
78 }, # OPTIONAL
79 IncludedPaths => [
80 'MyJsonPointerPath', ... # min: 1, max: 512
81 ], # min: 1; OPTIONAL
82 },
83 MatchScope => 'ALL', # values: ALL, KEY, VALUE
84 InvalidFallbackBehavior => 'MATCH'
85 , # values: MATCH, NO_MATCH, EVALUATE_AS_STRING; OPTIONAL
86 }, # OPTIONAL
87 Method => {
88  
89 }, # OPTIONAL
90 QueryString => {
91  
92 }, # OPTIONAL
93 SingleHeader => {
94 Name => 'MyFieldToMatchData', # min: 1, max: 64
95  
96 }, # OPTIONAL
97 SingleQueryArgument => {
98 Name => 'MyFieldToMatchData', # min: 1, max: 64
99  
100 }, # OPTIONAL
101 UriPath => {
102  
103 }, # OPTIONAL
104 },
105 PositionalConstraint => 'EXACTLY'
106 , # values: EXACTLY, STARTS_WITH, ENDS_WITH, CONTAINS, CONTAINS_WORD
107 SearchString => 'BlobSearchString',
108 TextTransformations => [
109 {
110 Priority => 1,
111 Type => 'NONE'
112 , # values: NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE, BASE64_DECODE, HEX_DECODE, MD5, REPLACE_COMMENTS, ESCAPE_SEQ_DECODE, SQL_HEX_DECODE, CSS_DECODE, JS_DECODE, NORMALIZE_PATH, NORMALIZE_PATH_WIN, REMOVE_NULLS, REPLACE_NULLS, BASE64_DECODE_EXT, URL_DECODE_UNI, UTF8_TO_UNICODE
113  
114 },
115 ...
116 ], # min: 1
117  
118 }, # OPTIONAL
119 GeoMatchStatement => {
120 CountryCodes => [
121 'AF',
122 ... # values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
123 ], # min: 1; OPTIONAL
124 ForwardedIPConfig => {
125 FallbackBehavior => 'MATCH', # values: MATCH, NO_MATCH
126 HeaderName => 'MyForwardedIPHeaderName', # min: 1, max: 255
127  
128 }, # OPTIONAL
129 }, # OPTIONAL
130 IPSetReferenceStatement => {
131 ARN => 'MyResourceArn', # min: 20, max: 2048
132 IPSetForwardedIPConfig => {
133 FallbackBehavior => 'MATCH', # values: MATCH, NO_MATCH
134 HeaderName => 'MyForwardedIPHeaderName', # min: 1, max: 255
135 Position => 'FIRST', # values: FIRST, LAST, ANY
136  
137 }, # OPTIONAL
138 }, # OPTIONAL
139 LabelMatchStatement => {
140 Key => 'MyLabelMatchKey', # min: 1, max: 1024
141 Scope => 'LABEL', # values: LABEL, NAMESPACE
142  
143 }, # OPTIONAL
144 ManagedRuleGroupStatement => {
145 Name => 'MyEntityName', # min: 1, max: 128
146 VendorName => 'MyVendorName', # min: 1, max: 128
147 ExcludedRules => [
148 {
149 Name => 'MyEntityName', # min: 1, max: 128
150  
151 },
152 ...
153 ], # OPTIONAL
154 ScopeDownStatement => <Statement>,
155 }, # OPTIONAL
156 NotStatement => {
157 Statement => <Statement>,
158  
159 }, # OPTIONAL
160 OrStatement => {
161 Statements => [ <Statement>, ... ],
162  
163 }, # OPTIONAL
164 RateBasedStatement => {
165 AggregateKeyType => 'IP', # values: IP, FORWARDED_IP
166 Limit => 1, # min: 100, max: 2000000000
167 ForwardedIPConfig => {
168 FallbackBehavior => 'MATCH', # values: MATCH, NO_MATCH
169 HeaderName => 'MyForwardedIPHeaderName', # min: 1, max: 255
170  
171 }, # OPTIONAL
172 ScopeDownStatement => <Statement>,
173 }, # OPTIONAL
174 RegexPatternSetReferenceStatement => {
175 ARN => 'MyResourceArn', # min: 20, max: 2048
176 FieldToMatch => {
177 AllQueryArguments => {
178  
179 }, # OPTIONAL
180 Body => {
181  
182 }, # OPTIONAL
183 JsonBody => {
184 MatchPattern => {
185 All => {
186  
187 }, # OPTIONAL
188 IncludedPaths => [
189 'MyJsonPointerPath', ... # min: 1, max: 512
190 ], # min: 1; OPTIONAL
191 },
192 MatchScope => 'ALL', # values: ALL, KEY, VALUE
193 InvalidFallbackBehavior => 'MATCH'
194 , # values: MATCH, NO_MATCH, EVALUATE_AS_STRING; OPTIONAL
195 }, # OPTIONAL
196 Method => {
197  
198 }, # OPTIONAL
199 QueryString => {
200  
201 }, # OPTIONAL
202 SingleHeader => {
203 Name => 'MyFieldToMatchData', # min: 1, max: 64
204  
205 }, # OPTIONAL
206 SingleQueryArgument => {
207 Name => 'MyFieldToMatchData', # min: 1, max: 64
208  
209 }, # OPTIONAL
210 UriPath => {
211  
212 }, # OPTIONAL
213 },
214 TextTransformations => [
215 {
216 Priority => 1,
217 Type => 'NONE'
218 , # values: NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE, BASE64_DECODE, HEX_DECODE, MD5, REPLACE_COMMENTS, ESCAPE_SEQ_DECODE, SQL_HEX_DECODE, CSS_DECODE, JS_DECODE, NORMALIZE_PATH, NORMALIZE_PATH_WIN, REMOVE_NULLS, REPLACE_NULLS, BASE64_DECODE_EXT, URL_DECODE_UNI, UTF8_TO_UNICODE
219  
220 },
221 ...
222 ], # min: 1
223  
224 }, # OPTIONAL
225 RuleGroupReferenceStatement => {
226 ARN => 'MyResourceArn', # min: 20, max: 2048
227 ExcludedRules => [
228 {
229 Name => 'MyEntityName', # min: 1, max: 128
230  
231 },
232 ...
233 ], # OPTIONAL
234 }, # OPTIONAL
235 SizeConstraintStatement => {
236 ComparisonOperator => 'EQ', # values: EQ, NE, LE, LT, GE, GT
237 FieldToMatch => {
238 AllQueryArguments => {
239  
240 }, # OPTIONAL
241 Body => {
242  
243 }, # OPTIONAL
244 JsonBody => {
245 MatchPattern => {
246 All => {
247  
248 }, # OPTIONAL
249 IncludedPaths => [
250 'MyJsonPointerPath', ... # min: 1, max: 512
251 ], # min: 1; OPTIONAL
252 },
253 MatchScope => 'ALL', # values: ALL, KEY, VALUE
254 InvalidFallbackBehavior => 'MATCH'
255 , # values: MATCH, NO_MATCH, EVALUATE_AS_STRING; OPTIONAL
256 }, # OPTIONAL
257 Method => {
258  
259 }, # OPTIONAL
260 QueryString => {
261  
262 }, # OPTIONAL
263 SingleHeader => {
264 Name => 'MyFieldToMatchData', # min: 1, max: 64
265  
266 }, # OPTIONAL
267 SingleQueryArgument => {
268 Name => 'MyFieldToMatchData', # min: 1, max: 64
269  
270 }, # OPTIONAL
271 UriPath => {
272  
273 }, # OPTIONAL
274 },
275 Size => 1, # max: 21474836480
276 TextTransformations => [
277 {
278 Priority => 1,
279 Type => 'NONE'
280 , # values: NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE, BASE64_DECODE, HEX_DECODE, MD5, REPLACE_COMMENTS, ESCAPE_SEQ_DECODE, SQL_HEX_DECODE, CSS_DECODE, JS_DECODE, NORMALIZE_PATH, NORMALIZE_PATH_WIN, REMOVE_NULLS, REPLACE_NULLS, BASE64_DECODE_EXT, URL_DECODE_UNI, UTF8_TO_UNICODE
281  
282 },
283 ...
284 ], # min: 1
285  
286 }, # OPTIONAL
287 SqliMatchStatement => {
288 FieldToMatch => {
289 AllQueryArguments => {
290  
291 }, # OPTIONAL
292 Body => {
293  
294 }, # OPTIONAL
295 JsonBody => {
296 MatchPattern => {
297 All => {
298  
299 }, # OPTIONAL
300 IncludedPaths => [
301 'MyJsonPointerPath', ... # min: 1, max: 512
302 ], # min: 1; OPTIONAL
303 },
304 MatchScope => 'ALL', # values: ALL, KEY, VALUE
305 InvalidFallbackBehavior => 'MATCH'
306 , # values: MATCH, NO_MATCH, EVALUATE_AS_STRING; OPTIONAL
307 }, # OPTIONAL
308 Method => {
309  
310 }, # OPTIONAL
311 QueryString => {
312  
313 }, # OPTIONAL
314 SingleHeader => {
315 Name => 'MyFieldToMatchData', # min: 1, max: 64
316  
317 }, # OPTIONAL
318 SingleQueryArgument => {
319 Name => 'MyFieldToMatchData', # min: 1, max: 64
320  
321 }, # OPTIONAL
322 UriPath => {
323  
324 }, # OPTIONAL
325 },
326 TextTransformations => [
327 {
328 Priority => 1,
329 Type => 'NONE'
330 , # values: NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE, BASE64_DECODE, HEX_DECODE, MD5, REPLACE_COMMENTS, ESCAPE_SEQ_DECODE, SQL_HEX_DECODE, CSS_DECODE, JS_DECODE, NORMALIZE_PATH, NORMALIZE_PATH_WIN, REMOVE_NULLS, REPLACE_NULLS, BASE64_DECODE_EXT, URL_DECODE_UNI, UTF8_TO_UNICODE
331  
332 },
333 ...
334 ], # min: 1
335  
336 }, # OPTIONAL
337 XssMatchStatement => {
338 FieldToMatch => {
339 AllQueryArguments => {
340  
341 }, # OPTIONAL
342 Body => {
343  
344 }, # OPTIONAL
345 JsonBody => {
346 MatchPattern => {
347 All => {
348  
349 }, # OPTIONAL
350 IncludedPaths => [
351 'MyJsonPointerPath', ... # min: 1, max: 512
352 ], # min: 1; OPTIONAL
353 },
354 MatchScope => 'ALL', # values: ALL, KEY, VALUE
355 InvalidFallbackBehavior => 'MATCH'
356 , # values: MATCH, NO_MATCH, EVALUATE_AS_STRING; OPTIONAL
357 }, # OPTIONAL
358 Method => {
359  
360 }, # OPTIONAL
361 QueryString => {
362  
363 }, # OPTIONAL
364 SingleHeader => {
365 Name => 'MyFieldToMatchData', # min: 1, max: 64
366  
367 }, # OPTIONAL
368 SingleQueryArgument => {
369 Name => 'MyFieldToMatchData', # min: 1, max: 64
370  
371 }, # OPTIONAL
372 UriPath => {
373  
374 }, # OPTIONAL
375 },
376 TextTransformations => [
377 {
378 Priority => 1,
379 Type => 'NONE'
380 , # values: NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE, BASE64_DECODE, HEX_DECODE, MD5, REPLACE_COMMENTS, ESCAPE_SEQ_DECODE, SQL_HEX_DECODE, CSS_DECODE, JS_DECODE, NORMALIZE_PATH, NORMALIZE_PATH_WIN, REMOVE_NULLS, REPLACE_NULLS, BASE64_DECODE_EXT, URL_DECODE_UNI, UTF8_TO_UNICODE
381  
382 },
383 ...
384 ], # min: 1
385  
386 }, # OPTIONAL
387 },
388 VisibilityConfig => {
389 CloudWatchMetricsEnabled => 1,
390 MetricName => 'MyMetricName', # min: 1, max: 255
391 SampledRequestsEnabled => 1,
392  
393 },
394 Action => {
395 Allow => {
396 CustomRequestHandling => {
397 InsertHeaders => [
398 {
399 Name => 'MyCustomHTTPHeaderName', # min: 1, max: 64
400 Value => 'MyCustomHTTPHeaderValue', # min: 1, max: 255
401  
402 },
403 ...
404 ], # min: 1
405  
406 }, # OPTIONAL
407 }, # OPTIONAL
408 Block => {
409 CustomResponse => {
410 ResponseCode => 1, # min: 200, max: 600
411 CustomResponseBodyKey => 'MyEntityName', # min: 1, max: 128
412 ResponseHeaders => [
413 {
414 Name => 'MyCustomHTTPHeaderName', # min: 1, max: 64
415 Value => 'MyCustomHTTPHeaderValue', # min: 1, max: 255
416  
417 },
418 ...
419 ], # min: 1
420 }, # OPTIONAL
421 }, # OPTIONAL
422 Count => {
423 CustomRequestHandling => {
424 InsertHeaders => [
425 {
426 Name => 'MyCustomHTTPHeaderName', # min: 1, max: 64
427 Value => 'MyCustomHTTPHeaderValue', # min: 1, max: 255
428  
429 },
430 ...
431 ], # min: 1
432  
433 }, # OPTIONAL
434 }, # OPTIONAL
435 }, # OPTIONAL
436 OverrideAction => {
437 Count => {
438 CustomRequestHandling => {
439 InsertHeaders => [
440 {
441 Name => 'MyCustomHTTPHeaderName', # min: 1, max: 64
442 Value => 'MyCustomHTTPHeaderValue', # min: 1, max: 255
443  
444 },
445 ...
446 ], # min: 1
447  
448 }, # OPTIONAL
449 }, # OPTIONAL
450 None => {
451  
452 }, # OPTIONAL
453 }, # OPTIONAL
454 RuleLabels => [
455 {
456 Name => 'MyLabelName', # min: 1, max: 1024
457  
458 },
459 ...
460 ], # OPTIONAL
461 },
462 ...
463 ], # OPTIONAL
464 );
465  
466 # Results:
467 my $NextLockToken = $UpdateRuleGroupResponse->NextLockToken;
468  
469 # Returns a L<Paws::WAFV2::UpdateRuleGroupResponse> object.
470  
471 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
472 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/wafv2/UpdateRuleGroup>
473  
474 =head1 ATTRIBUTES
475  
476  
477 =head2 CustomResponseBodies => L<Paws::WAFV2::CustomResponseBodies>
478  
479 A map of custom response keys and content bodies. When you create a
480 rule with a block action, you can send a custom response to the web
481 request. You define these for the rule group, and then use them in the
482 rules that you define in the rule group.
483  
484 For information about customizing web requests and responses, see
485 Customizing web requests and responses in WAF
486 (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
487 in the WAF Developer Guide
488 (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
489  
490 For information about the limits on count and size for custom request
491 and response settings, see WAF quotas
492 (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in
493 the WAF Developer Guide
494 (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
495  
496  
497  
498 =head2 Description => Str
499  
500 A description of the rule group that helps with identification.
501  
502  
503  
504 =head2 B<REQUIRED> Id => Str
505  
506 A unique identifier for the rule group. This ID is returned in the
507 responses to create and list commands. You provide it to operations
508 like update and delete.
509  
510  
511  
512 =head2 B<REQUIRED> LockToken => Str
513  
514 A token used for optimistic locking. WAF returns a token to your get
515 and list requests, to mark the state of the entity at the time of the
516 request. To make changes to the entity associated with the token, you
517 provide the token to operations like update and delete. WAF uses the
518 token to ensure that no changes have been made to the entity since you
519 last retrieved it. If a change has been made, the update fails with a
520 C<WAFOptimisticLockException>. If this happens, perform another get,
521 and use the new token returned by that operation.
522  
523  
524  
525 =head2 B<REQUIRED> Name => Str
526  
527 The name of the rule group. You cannot change the name of a rule group
528 after you create it.
529  
530  
531  
532 =head2 Rules => ArrayRef[L<Paws::WAFV2::Rule>]
533  
534 The Rule statements used to identify the web requests that you want to
535 allow, block, or count. Each rule includes one top-level statement that
536 WAF uses to identify matching web requests, and parameters that govern
537 how WAF handles them.
538  
539  
540  
541 =head2 B<REQUIRED> Scope => Str
542  
543 Specifies whether this is for an Amazon CloudFront distribution or for
544 a regional application. A regional application can be an Application
545 Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync
546 GraphQL API.
547  
548 To work with CloudFront, you must also specify the Region US East (N.
549 Virginia) as follows:
550  
551 =over
552  
553 =item *
554  
555 CLI - Specify the Region when you use the CloudFront scope:
556 C<--scope=CLOUDFRONT --region=us-east-1>.
557  
558 =item *
559  
560 API and SDKs - For all calls, use the Region endpoint us-east-1.
561  
562 =back
563  
564  
565 Valid values are: C<"CLOUDFRONT">, C<"REGIONAL">
566  
567 =head2 B<REQUIRED> VisibilityConfig => L<Paws::WAFV2::VisibilityConfig>
568  
569 Defines and enables Amazon CloudWatch metrics and web request sample
570 collection.
571  
572  
573  
574  
575 =head1 SEE ALSO
576  
577 This class forms part of L<Paws>, documenting arguments for method UpdateRuleGroup in L<Paws::WAFV2>
578  
579 =head1 BUGS and CONTRIBUTIONS
580  
581 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
582  
583 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
584  
585 =cut
586