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

filter: Statementstmt 0.0% 0 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 17 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::WebACL;
3 use Moose;
4 has ARN => (is => 'ro', isa => 'Str', required => 1);
5 has Capacity => (is => 'ro', isa => 'Int');
6 has CustomResponseBodies => (is => 'ro', isa => 'Paws::WAFV2::CustomResponseBodies');
7 has DefaultAction => (is => 'ro', isa => 'Paws::WAFV2::DefaultAction', required => 1);
8 has Description => (is => 'ro', isa => 'Str');
9 has Id => (is => 'ro', isa => 'Str', required => 1);
10 has LabelNamespace => (is => 'ro', isa => 'Str');
11 has ManagedByFirewallManager => (is => 'ro', isa => 'Bool');
12 has Name => (is => 'ro', isa => 'Str', required => 1);
13 has PostProcessFirewallManagerRuleGroups => (is => 'ro', isa => 'ArrayRef[Paws::WAFV2::FirewallManagerRuleGroup]');
14 has PreProcessFirewallManagerRuleGroups => (is => 'ro', isa => 'ArrayRef[Paws::WAFV2::FirewallManagerRuleGroup]');
15 has Rules => (is => 'ro', isa => 'ArrayRef[Paws::WAFV2::Rule]');
16 has VisibilityConfig => (is => 'ro', isa => 'Paws::WAFV2::VisibilityConfig', required => 1);
17  
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::WAFV2::WebACL
25  
26 =head1 USAGE
27  
28 This class represents one of two things:
29  
30 =head3 Arguments in a call to a service
31  
32 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
33 Each attribute should be used as a named argument in the calls that expect this type of object.
34  
35 As an example, if Att1 is expected to be a Paws::WAFV2::WebACL object:
36  
37 $service_obj->Method(Att1 => { ARN => $value, ..., VisibilityConfig => $value });
38  
39 =head3 Results returned from an API call
40  
41 Use accessors for each attribute. If Att1 is expected to be an Paws::WAFV2::WebACL object:
42  
43 $result = $service_obj->Method(...);
44 $result->Att1->ARN
45  
46 =head1 DESCRIPTION
47  
48 A web ACL defines a collection of rules to use to inspect and control
49 web requests. Each rule has an action defined (allow, block, or count)
50 for requests that match the statement of the rule. In the web ACL, you
51 assign a default action to take (allow, block) for any request that
52 does not match any of the rules. The rules in a web ACL can be a
53 combination of the types Rule, RuleGroup, and managed rule group. You
54 can associate a web ACL with one or more Amazon Web Services resources
55 to protect. The resources can be an Amazon CloudFront distribution, an
56 Amazon API Gateway REST API, an Application Load Balancer, or an
57 AppSync GraphQL API.
58  
59 =head1 ATTRIBUTES
60  
61  
62 =head2 B<REQUIRED> ARN => Str
63  
64 The Amazon Resource Name (ARN) of the web ACL that you want to
65 associate with the resource.
66  
67  
68 =head2 Capacity => Int
69  
70 The web ACL capacity units (WCUs) currently being used by this web ACL.
71  
72 WAF uses WCUs to calculate and control the operating resources that are
73 used to run your rules, rule groups, and web ACLs. WAF calculates
74 capacity differently for each rule type, to reflect the relative cost
75 of each rule. Simple rules that cost little to run use fewer WCUs than
76 more complex rules that use more processing power. Rule group capacity
77 is fixed at creation, which helps users plan their web ACL WCU usage
78 when they use a rule group. The WCU limit for web ACLs is 1,500.
79  
80  
81 =head2 CustomResponseBodies => L<Paws::WAFV2::CustomResponseBodies>
82  
83 A map of custom response keys and content bodies. When you create a
84 rule with a block action, you can send a custom response to the web
85 request. You define these for the web ACL, and then use them in the
86 rules and default actions that you define in the web ACL.
87  
88 For information about customizing web requests and responses, see
89 Customizing web requests and responses in WAF
90 (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
91 in the WAF Developer Guide
92 (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
93  
94 For information about the limits on count and size for custom request
95 and response settings, see WAF quotas
96 (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in
97 the WAF Developer Guide
98 (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
99  
100  
101 =head2 B<REQUIRED> DefaultAction => L<Paws::WAFV2::DefaultAction>
102  
103 The action to perform if none of the C<Rules> contained in the
104 C<WebACL> match.
105  
106  
107 =head2 Description => Str
108  
109 A description of the web ACL that helps with identification.
110  
111  
112 =head2 B<REQUIRED> Id => Str
113  
114 A unique identifier for the C<WebACL>. This ID is returned in the
115 responses to create and list commands. You use this ID to do things
116 like get, update, and delete a C<WebACL>.
117  
118  
119 =head2 LabelNamespace => Str
120  
121 The label namespace prefix for this web ACL. All labels added by rules
122 in this web ACL have this prefix.
123  
124 =over
125  
126 =item *
127  
128 The syntax for the label namespace prefix for a web ACL is the
129 following:
130  
131 C<awswaf:E<lt>account IDE<gt>:webacl:E<lt>web ACL nameE<gt>:>
132  
133 =item *
134  
135 When a rule with a label matches a web request, WAF adds the fully
136 qualified label to the request. A fully qualified label is made up of
137 the label namespace from the rule group or web ACL where the rule is
138 defined and the label from the rule, separated by a colon:
139  
140 C<E<lt>label namespaceE<gt>:E<lt>label from ruleE<gt>>
141  
142 =back
143  
144  
145  
146 =head2 ManagedByFirewallManager => Bool
147  
148 Indicates whether this web ACL is managed by Firewall Manager. If true,
149 then only Firewall Manager can delete the web ACL or any Firewall
150 Manager rule groups in the web ACL.
151  
152  
153 =head2 B<REQUIRED> Name => Str
154  
155 The name of the web ACL. You cannot change the name of a web ACL after
156 you create it.
157  
158  
159 =head2 PostProcessFirewallManagerRuleGroups => ArrayRef[L<Paws::WAFV2::FirewallManagerRuleGroup>]
160  
161 The last set of rules for WAF to process in the web ACL. This is
162 defined in an Firewall Manager WAF policy and contains only rule group
163 references. You can't alter these. Any rules and rule groups that you
164 define for the web ACL are prioritized before these.
165  
166 In the Firewall Manager WAF policy, the Firewall Manager administrator
167 can define a set of rule groups to run first in the web ACL and a set
168 of rule groups to run last. Within each set, the administrator
169 prioritizes the rule groups, to determine their relative processing
170 order.
171  
172  
173 =head2 PreProcessFirewallManagerRuleGroups => ArrayRef[L<Paws::WAFV2::FirewallManagerRuleGroup>]
174  
175 The first set of rules for WAF to process in the web ACL. This is
176 defined in an Firewall Manager WAF policy and contains only rule group
177 references. You can't alter these. Any rules and rule groups that you
178 define for the web ACL are prioritized after these.
179  
180 In the Firewall Manager WAF policy, the Firewall Manager administrator
181 can define a set of rule groups to run first in the web ACL and a set
182 of rule groups to run last. Within each set, the administrator
183 prioritizes the rule groups, to determine their relative processing
184 order.
185  
186  
187 =head2 Rules => ArrayRef[L<Paws::WAFV2::Rule>]
188  
189 The Rule statements used to identify the web requests that you want to
190 allow, block, or count. Each rule includes one top-level statement that
191 WAF uses to identify matching web requests, and parameters that govern
192 how WAF handles them.
193  
194  
195 =head2 B<REQUIRED> VisibilityConfig => L<Paws::WAFV2::VisibilityConfig>
196  
197 Defines and enables Amazon CloudWatch metrics and web request sample
198 collection.
199  
200  
201  
202 =head1 SEE ALSO
203  
204 This class forms part of L<Paws>, describing an object used in L<Paws::WAFV2>
205  
206 =head1 BUGS and CONTRIBUTIONS
207  
208 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
209  
210 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
211  
212 =cut
213