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

filter: Statementstmt 0.0% 0 / 11 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 13 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::WAFV2::CheckCapacity;
3 use Moose;
4 has Rules => (is => 'ro', isa => 'ArrayRef[Paws::WAFV2::Rule]', required => 1);
5 has Scope => (is => 'ro', isa => 'Str', required => 1);
6  
7 use MooseX::ClassAttribute;
8  
9 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CheckCapacity');
10 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WAFV2::CheckCapacityResponse');
11 class_has _result_key => (isa => 'Str', is => 'ro');
12 1;
13  
14 ### main pod documentation begin ###
15  
16 =head1 NAME
17  
18 Paws::WAFV2::CheckCapacity - Arguments for method CheckCapacity on L<Paws::WAFV2>
19  
20 =head1 DESCRIPTION
21  
22 This class represents the parameters used for calling the method CheckCapacity on the
23 L<AWS WAFV2|Paws::WAFV2> service. Use the attributes of this class
24 as arguments to method CheckCapacity.
25  
26 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CheckCapacity.
27  
28 =head1 SYNOPSIS
29  
30 my $wafv2 = Paws->service('WAFV2');
31 my $CheckCapacityResponse = $wafv2->CheckCapacity(
32 Rules => [
33 {
34 Name => 'MyEntityName', # min: 1, max: 128
35 Priority => 1,
36 Statement => {
37 AndStatement => {
38 Statements => [ <Statement>, ... ],
39  
40 }, # OPTIONAL
41 ByteMatchStatement => {
42 FieldToMatch => {
43 AllQueryArguments => {
44  
45 }, # OPTIONAL
46 Body => {
47  
48 }, # OPTIONAL
49 JsonBody => {
50 MatchPattern => {
51 All => {
52  
53 }, # OPTIONAL
54 IncludedPaths => [
55 'MyJsonPointerPath', ... # min: 1, max: 512
56 ], # min: 1; OPTIONAL
57 },
58 MatchScope => 'ALL', # values: ALL, KEY, VALUE
59 InvalidFallbackBehavior => 'MATCH'
60 , # values: MATCH, NO_MATCH, EVALUATE_AS_STRING; OPTIONAL
61 }, # OPTIONAL
62 Method => {
63  
64 }, # OPTIONAL
65 QueryString => {
66  
67 }, # OPTIONAL
68 SingleHeader => {
69 Name => 'MyFieldToMatchData', # min: 1, max: 64
70  
71 }, # OPTIONAL
72 SingleQueryArgument => {
73 Name => 'MyFieldToMatchData', # min: 1, max: 64
74  
75 }, # OPTIONAL
76 UriPath => {
77  
78 }, # OPTIONAL
79 },
80 PositionalConstraint => 'EXACTLY'
81 , # values: EXACTLY, STARTS_WITH, ENDS_WITH, CONTAINS, CONTAINS_WORD
82 SearchString => 'BlobSearchString',
83 TextTransformations => [
84 {
85 Priority => 1,
86 Type => 'NONE'
87 , # 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
88  
89 },
90 ...
91 ], # min: 1
92  
93 }, # OPTIONAL
94 GeoMatchStatement => {
95 CountryCodes => [
96 'AF',
97 ... # 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
98 ], # min: 1; OPTIONAL
99 ForwardedIPConfig => {
100 FallbackBehavior => 'MATCH', # values: MATCH, NO_MATCH
101 HeaderName => 'MyForwardedIPHeaderName', # min: 1, max: 255
102  
103 }, # OPTIONAL
104 }, # OPTIONAL
105 IPSetReferenceStatement => {
106 ARN => 'MyResourceArn', # min: 20, max: 2048
107 IPSetForwardedIPConfig => {
108 FallbackBehavior => 'MATCH', # values: MATCH, NO_MATCH
109 HeaderName => 'MyForwardedIPHeaderName', # min: 1, max: 255
110 Position => 'FIRST', # values: FIRST, LAST, ANY
111  
112 }, # OPTIONAL
113 }, # OPTIONAL
114 LabelMatchStatement => {
115 Key => 'MyLabelMatchKey', # min: 1, max: 1024
116 Scope => 'LABEL', # values: LABEL, NAMESPACE
117  
118 }, # OPTIONAL
119 ManagedRuleGroupStatement => {
120 Name => 'MyEntityName', # min: 1, max: 128
121 VendorName => 'MyVendorName', # min: 1, max: 128
122 ExcludedRules => [
123 {
124 Name => 'MyEntityName', # min: 1, max: 128
125  
126 },
127 ...
128 ], # OPTIONAL
129 ScopeDownStatement => <Statement>,
130 }, # OPTIONAL
131 NotStatement => {
132 Statement => <Statement>,
133  
134 }, # OPTIONAL
135 OrStatement => {
136 Statements => [ <Statement>, ... ],
137  
138 }, # OPTIONAL
139 RateBasedStatement => {
140 AggregateKeyType => 'IP', # values: IP, FORWARDED_IP
141 Limit => 1, # min: 100, max: 2000000000
142 ForwardedIPConfig => {
143 FallbackBehavior => 'MATCH', # values: MATCH, NO_MATCH
144 HeaderName => 'MyForwardedIPHeaderName', # min: 1, max: 255
145  
146 }, # OPTIONAL
147 ScopeDownStatement => <Statement>,
148 }, # OPTIONAL
149 RegexPatternSetReferenceStatement => {
150 ARN => 'MyResourceArn', # min: 20, max: 2048
151 FieldToMatch => {
152 AllQueryArguments => {
153  
154 }, # OPTIONAL
155 Body => {
156  
157 }, # OPTIONAL
158 JsonBody => {
159 MatchPattern => {
160 All => {
161  
162 }, # OPTIONAL
163 IncludedPaths => [
164 'MyJsonPointerPath', ... # min: 1, max: 512
165 ], # min: 1; OPTIONAL
166 },
167 MatchScope => 'ALL', # values: ALL, KEY, VALUE
168 InvalidFallbackBehavior => 'MATCH'
169 , # values: MATCH, NO_MATCH, EVALUATE_AS_STRING; OPTIONAL
170 }, # OPTIONAL
171 Method => {
172  
173 }, # OPTIONAL
174 QueryString => {
175  
176 }, # OPTIONAL
177 SingleHeader => {
178 Name => 'MyFieldToMatchData', # min: 1, max: 64
179  
180 }, # OPTIONAL
181 SingleQueryArgument => {
182 Name => 'MyFieldToMatchData', # min: 1, max: 64
183  
184 }, # OPTIONAL
185 UriPath => {
186  
187 }, # OPTIONAL
188 },
189 TextTransformations => [
190 {
191 Priority => 1,
192 Type => 'NONE'
193 , # 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
194  
195 },
196 ...
197 ], # min: 1
198  
199 }, # OPTIONAL
200 RuleGroupReferenceStatement => {
201 ARN => 'MyResourceArn', # min: 20, max: 2048
202 ExcludedRules => [
203 {
204 Name => 'MyEntityName', # min: 1, max: 128
205  
206 },
207 ...
208 ], # OPTIONAL
209 }, # OPTIONAL
210 SizeConstraintStatement => {
211 ComparisonOperator => 'EQ', # values: EQ, NE, LE, LT, GE, GT
212 FieldToMatch => {
213 AllQueryArguments => {
214  
215 }, # OPTIONAL
216 Body => {
217  
218 }, # OPTIONAL
219 JsonBody => {
220 MatchPattern => {
221 All => {
222  
223 }, # OPTIONAL
224 IncludedPaths => [
225 'MyJsonPointerPath', ... # min: 1, max: 512
226 ], # min: 1; OPTIONAL
227 },
228 MatchScope => 'ALL', # values: ALL, KEY, VALUE
229 InvalidFallbackBehavior => 'MATCH'
230 , # values: MATCH, NO_MATCH, EVALUATE_AS_STRING; OPTIONAL
231 }, # OPTIONAL
232 Method => {
233  
234 }, # OPTIONAL
235 QueryString => {
236  
237 }, # OPTIONAL
238 SingleHeader => {
239 Name => 'MyFieldToMatchData', # min: 1, max: 64
240  
241 }, # OPTIONAL
242 SingleQueryArgument => {
243 Name => 'MyFieldToMatchData', # min: 1, max: 64
244  
245 }, # OPTIONAL
246 UriPath => {
247  
248 }, # OPTIONAL
249 },
250 Size => 1, # max: 21474836480
251 TextTransformations => [
252 {
253 Priority => 1,
254 Type => 'NONE'
255 , # 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
256  
257 },
258 ...
259 ], # min: 1
260  
261 }, # OPTIONAL
262 SqliMatchStatement => {
263 FieldToMatch => {
264 AllQueryArguments => {
265  
266 }, # OPTIONAL
267 Body => {
268  
269 }, # OPTIONAL
270 JsonBody => {
271 MatchPattern => {
272 All => {
273  
274 }, # OPTIONAL
275 IncludedPaths => [
276 'MyJsonPointerPath', ... # min: 1, max: 512
277 ], # min: 1; OPTIONAL
278 },
279 MatchScope => 'ALL', # values: ALL, KEY, VALUE
280 InvalidFallbackBehavior => 'MATCH'
281 , # values: MATCH, NO_MATCH, EVALUATE_AS_STRING; OPTIONAL
282 }, # OPTIONAL
283 Method => {
284  
285 }, # OPTIONAL
286 QueryString => {
287  
288 }, # OPTIONAL
289 SingleHeader => {
290 Name => 'MyFieldToMatchData', # min: 1, max: 64
291  
292 }, # OPTIONAL
293 SingleQueryArgument => {
294 Name => 'MyFieldToMatchData', # min: 1, max: 64
295  
296 }, # OPTIONAL
297 UriPath => {
298  
299 }, # OPTIONAL
300 },
301 TextTransformations => [
302 {
303 Priority => 1,
304 Type => 'NONE'
305 , # 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
306  
307 },
308 ...
309 ], # min: 1
310  
311 }, # OPTIONAL
312 XssMatchStatement => {
313 FieldToMatch => {
314 AllQueryArguments => {
315  
316 }, # OPTIONAL
317 Body => {
318  
319 }, # OPTIONAL
320 JsonBody => {
321 MatchPattern => {
322 All => {
323  
324 }, # OPTIONAL
325 IncludedPaths => [
326 'MyJsonPointerPath', ... # min: 1, max: 512
327 ], # min: 1; OPTIONAL
328 },
329 MatchScope => 'ALL', # values: ALL, KEY, VALUE
330 InvalidFallbackBehavior => 'MATCH'
331 , # values: MATCH, NO_MATCH, EVALUATE_AS_STRING; OPTIONAL
332 }, # OPTIONAL
333 Method => {
334  
335 }, # OPTIONAL
336 QueryString => {
337  
338 }, # OPTIONAL
339 SingleHeader => {
340 Name => 'MyFieldToMatchData', # min: 1, max: 64
341  
342 }, # OPTIONAL
343 SingleQueryArgument => {
344 Name => 'MyFieldToMatchData', # min: 1, max: 64
345  
346 }, # OPTIONAL
347 UriPath => {
348  
349 }, # OPTIONAL
350 },
351 TextTransformations => [
352 {
353 Priority => 1,
354 Type => 'NONE'
355 , # 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
356  
357 },
358 ...
359 ], # min: 1
360  
361 }, # OPTIONAL
362 },
363 VisibilityConfig => {
364 CloudWatchMetricsEnabled => 1,
365 MetricName => 'MyMetricName', # min: 1, max: 255
366 SampledRequestsEnabled => 1,
367  
368 },
369 Action => {
370 Allow => {
371 CustomRequestHandling => {
372 InsertHeaders => [
373 {
374 Name => 'MyCustomHTTPHeaderName', # min: 1, max: 64
375 Value => 'MyCustomHTTPHeaderValue', # min: 1, max: 255
376  
377 },
378 ...
379 ], # min: 1
380  
381 }, # OPTIONAL
382 }, # OPTIONAL
383 Block => {
384 CustomResponse => {
385 ResponseCode => 1, # min: 200, max: 600
386 CustomResponseBodyKey => 'MyEntityName', # min: 1, max: 128
387 ResponseHeaders => [
388 {
389 Name => 'MyCustomHTTPHeaderName', # min: 1, max: 64
390 Value => 'MyCustomHTTPHeaderValue', # min: 1, max: 255
391  
392 },
393 ...
394 ], # min: 1
395 }, # OPTIONAL
396 }, # OPTIONAL
397 Count => {
398 CustomRequestHandling => {
399 InsertHeaders => [
400 {
401 Name => 'MyCustomHTTPHeaderName', # min: 1, max: 64
402 Value => 'MyCustomHTTPHeaderValue', # min: 1, max: 255
403  
404 },
405 ...
406 ], # min: 1
407  
408 }, # OPTIONAL
409 }, # OPTIONAL
410 }, # OPTIONAL
411 OverrideAction => {
412 Count => {
413 CustomRequestHandling => {
414 InsertHeaders => [
415 {
416 Name => 'MyCustomHTTPHeaderName', # min: 1, max: 64
417 Value => 'MyCustomHTTPHeaderValue', # min: 1, max: 255
418  
419 },
420 ...
421 ], # min: 1
422  
423 }, # OPTIONAL
424 }, # OPTIONAL
425 None => {
426  
427 }, # OPTIONAL
428 }, # OPTIONAL
429 RuleLabels => [
430 {
431 Name => 'MyLabelName', # min: 1, max: 1024
432  
433 },
434 ...
435 ], # OPTIONAL
436 },
437 ...
438 ],
439 Scope => 'CLOUDFRONT',
440  
441 );
442  
443 # Results:
444 my $Capacity = $CheckCapacityResponse->Capacity;
445  
446 # Returns a L<Paws::WAFV2::CheckCapacityResponse> object.
447  
448 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.
449 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/wafv2/CheckCapacity>
450  
451 =head1 ATTRIBUTES
452  
453  
454 =head2 B<REQUIRED> Rules => ArrayRef[L<Paws::WAFV2::Rule>]
455  
456 An array of Rule that you're configuring to use in a rule group or web
457 ACL.
458  
459  
460  
461 =head2 B<REQUIRED> Scope => Str
462  
463 Specifies whether this is for an Amazon CloudFront distribution or for
464 a regional application. A regional application can be an Application
465 Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync
466 GraphQL API.
467  
468 To work with CloudFront, you must also specify the Region US East (N.
469 Virginia) as follows:
470  
471 =over
472  
473 =item *
474  
475 CLI - Specify the Region when you use the CloudFront scope:
476 C<--scope=CLOUDFRONT --region=us-east-1>.
477  
478 =item *
479  
480 API and SDKs - For all calls, use the Region endpoint us-east-1.
481  
482 =back
483  
484  
485 Valid values are: C<"CLOUDFRONT">, C<"REGIONAL">
486  
487  
488 =head1 SEE ALSO
489  
490 This class forms part of L<Paws>, documenting arguments for method CheckCapacity in L<Paws::WAFV2>
491  
492 =head1 BUGS and CONTRIBUTIONS
493  
494 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
495  
496 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
497  
498 =cut
499