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

filter: Statementstmt 0.0% 0 / 14 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 15 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::WAFV2::RuleGroup;
3 use Moose;
4 has ARN => (is => 'ro', isa => 'Str', required => 1);
5 has AvailableLabels => (is => 'ro', isa => 'ArrayRef[Paws::WAFV2::LabelSummary]');
6 has Capacity => (is => 'ro', isa => 'Int', required => 1);
7 has ConsumedLabels => (is => 'ro', isa => 'ArrayRef[Paws::WAFV2::LabelSummary]');
8 has CustomResponseBodies => (is => 'ro', isa => 'Paws::WAFV2::CustomResponseBodies');
9 has Description => (is => 'ro', isa => 'Str');
10 has Id => (is => 'ro', isa => 'Str', required => 1);
11 has LabelNamespace => (is => 'ro', isa => 'Str');
12 has Name => (is => 'ro', isa => 'Str', required => 1);
13 has Rules => (is => 'ro', isa => 'ArrayRef[Paws::WAFV2::Rule]');
14 has VisibilityConfig => (is => 'ro', isa => 'Paws::WAFV2::VisibilityConfig', required => 1);
15  
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::WAFV2::RuleGroup
23  
24 =head1 USAGE
25  
26 This class represents one of two things:
27  
28 =head3 Arguments in a call to a service
29  
30 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
31 Each attribute should be used as a named argument in the calls that expect this type of object.
32  
33 As an example, if Att1 is expected to be a Paws::WAFV2::RuleGroup object:
34  
35 $service_obj->Method(Att1 => { ARN => $value, ..., VisibilityConfig => $value });
36  
37 =head3 Results returned from an API call
38  
39 Use accessors for each attribute. If Att1 is expected to be an Paws::WAFV2::RuleGroup object:
40  
41 $result = $service_obj->Method(...);
42 $result->Att1->ARN
43  
44 =head1 DESCRIPTION
45  
46 A rule group defines a collection of rules to inspect and control web
47 requests that you can use in a WebACL. When you create a rule group,
48 you define an immutable capacity limit. If you update a rule group, you
49 must stay within the capacity. This allows others to reuse the rule
50 group with confidence in its capacity requirements.
51  
52 =head1 ATTRIBUTES
53  
54  
55 =head2 B<REQUIRED> ARN => Str
56  
57 The Amazon Resource Name (ARN) of the entity.
58  
59  
60 =head2 AvailableLabels => ArrayRef[L<Paws::WAFV2::LabelSummary>]
61  
62 The labels that one or more rules in this rule group add to matching
63 web requests. These labels are defined in the C<RuleLabels> for a Rule.
64  
65  
66 =head2 B<REQUIRED> Capacity => Int
67  
68 The web ACL capacity units (WCUs) required for this rule group.
69  
70 When you create your own rule group, you define this, and you cannot
71 change it after creation. When you add or modify the rules in a rule
72 group, WAF enforces this limit. You can check the capacity for a set of
73 rules using CheckCapacity.
74  
75 WAF uses WCUs to calculate and control the operating resources that are
76 used to run your rules, rule groups, and web ACLs. WAF calculates
77 capacity differently for each rule type, to reflect the relative cost
78 of each rule. Simple rules that cost little to run use fewer WCUs than
79 more complex rules that use more processing power. Rule group capacity
80 is fixed at creation, which helps users plan their web ACL WCU usage
81 when they use a rule group. The WCU limit for web ACLs is 1,500.
82  
83  
84 =head2 ConsumedLabels => ArrayRef[L<Paws::WAFV2::LabelSummary>]
85  
86 The labels that one or more rules in this rule group match against in
87 label match statements. These labels are defined in a
88 C<LabelMatchStatement> specification, in the Statement definition of a
89 rule.
90  
91  
92 =head2 CustomResponseBodies => L<Paws::WAFV2::CustomResponseBodies>
93  
94 A map of custom response keys and content bodies. When you create a
95 rule with a block action, you can send a custom response to the web
96 request. You define these for the rule group, and then use them in the
97 rules that you define in the rule group.
98  
99 For information about customizing web requests and responses, see
100 Customizing web requests and responses in WAF
101 (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
102 in the WAF Developer Guide
103 (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
104  
105 For information about the limits on count and size for custom request
106 and response settings, see WAF quotas
107 (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in
108 the WAF Developer Guide
109 (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
110  
111  
112 =head2 Description => Str
113  
114 A description of the rule group that helps with identification.
115  
116  
117 =head2 B<REQUIRED> Id => Str
118  
119 A unique identifier for the rule group. This ID is returned in the
120 responses to create and list commands. You provide it to operations
121 like update and delete.
122  
123  
124 =head2 LabelNamespace => Str
125  
126 The label namespace prefix for this rule group. All labels added by
127 rules in this rule group have this prefix.
128  
129 =over
130  
131 =item *
132  
133 The syntax for the label namespace prefix for your rule groups is the
134 following:
135  
136 C<awswaf:E<lt>account IDE<gt>:rulegroup:E<lt>rule group nameE<gt>:>
137  
138 =item *
139  
140 When a rule with a label matches a web request, WAF adds the fully
141 qualified label to the request. A fully qualified label is made up of
142 the label namespace from the rule group or web ACL where the rule is
143 defined and the label from the rule, separated by a colon:
144  
145 C<E<lt>label namespaceE<gt>:E<lt>label from ruleE<gt>>
146  
147 =back
148  
149  
150  
151 =head2 B<REQUIRED> Name => Str
152  
153 The name of the rule group. You cannot change the name of a rule group
154 after you create it.
155  
156  
157 =head2 Rules => ArrayRef[L<Paws::WAFV2::Rule>]
158  
159 The Rule statements used to identify the web requests that you want to
160 allow, block, or count. Each rule includes one top-level statement that
161 WAF uses to identify matching web requests, and parameters that govern
162 how WAF handles them.
163  
164  
165 =head2 B<REQUIRED> VisibilityConfig => L<Paws::WAFV2::VisibilityConfig>
166  
167 Defines and enables Amazon CloudWatch metrics and web request sample
168 collection.
169  
170  
171  
172 =head1 SEE ALSO
173  
174 This class forms part of L<Paws>, describing an object used in L<Paws::WAFV2>
175  
176 =head1 BUGS and CONTRIBUTIONS
177  
178 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
179  
180 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
181  
182 =cut
183