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

filter: Statementstmt 0.0% 0 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 18 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::Statement;
3 use Moose;
4 has AndStatement => (is => 'ro', isa => 'Paws::WAFV2::AndStatement');
5 has ByteMatchStatement => (is => 'ro', isa => 'Paws::WAFV2::ByteMatchStatement');
6 has GeoMatchStatement => (is => 'ro', isa => 'Paws::WAFV2::GeoMatchStatement');
7 has IPSetReferenceStatement => (is => 'ro', isa => 'Paws::WAFV2::IPSetReferenceStatement');
8 has LabelMatchStatement => (is => 'ro', isa => 'Paws::WAFV2::LabelMatchStatement');
9 has ManagedRuleGroupStatement => (is => 'ro', isa => 'Paws::WAFV2::ManagedRuleGroupStatement');
10 has NotStatement => (is => 'ro', isa => 'Paws::WAFV2::NotStatement');
11 has OrStatement => (is => 'ro', isa => 'Paws::WAFV2::OrStatement');
12 has RateBasedStatement => (is => 'ro', isa => 'Paws::WAFV2::RateBasedStatement');
13 has RegexPatternSetReferenceStatement => (is => 'ro', isa => 'Paws::WAFV2::RegexPatternSetReferenceStatement');
14 has RuleGroupReferenceStatement => (is => 'ro', isa => 'Paws::WAFV2::RuleGroupReferenceStatement');
15 has SizeConstraintStatement => (is => 'ro', isa => 'Paws::WAFV2::SizeConstraintStatement');
16 has SqliMatchStatement => (is => 'ro', isa => 'Paws::WAFV2::SqliMatchStatement');
17 has XssMatchStatement => (is => 'ro', isa => 'Paws::WAFV2::XssMatchStatement');
18  
19 1;
20  
21 ### main pod documentation begin ###
22  
23 =head1 NAME
24  
25 Paws::WAFV2::Statement
26  
27 =head1 USAGE
28  
29 This class represents one of two things:
30  
31 =head3 Arguments in a call to a service
32  
33 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
34 Each attribute should be used as a named argument in the calls that expect this type of object.
35  
36 As an example, if Att1 is expected to be a Paws::WAFV2::Statement object:
37  
38 $service_obj->Method(Att1 => { AndStatement => $value, ..., XssMatchStatement => $value });
39  
40 =head3 Results returned from an API call
41  
42 Use accessors for each attribute. If Att1 is expected to be an Paws::WAFV2::Statement object:
43  
44 $result = $service_obj->Method(...);
45 $result->Att1->AndStatement
46  
47 =head1 DESCRIPTION
48  
49 The processing guidance for a Rule, used by WAF to determine whether a
50 web request matches the rule.
51  
52 =head1 ATTRIBUTES
53  
54  
55 =head2 AndStatement => L<Paws::WAFV2::AndStatement>
56  
57 A logical rule statement used to combine other rule statements with AND
58 logic. You provide more than one Statement within the C<AndStatement>.
59  
60  
61 =head2 ByteMatchStatement => L<Paws::WAFV2::ByteMatchStatement>
62  
63 A rule statement that defines a string match search for WAF to apply to
64 web requests. The byte match statement provides the bytes to search
65 for, the location in requests that you want WAF to search, and other
66 settings. The bytes to search for are typically a string that
67 corresponds with ASCII characters. In the WAF console and the developer
68 guide, this is refered to as a string match statement.
69  
70  
71 =head2 GeoMatchStatement => L<Paws::WAFV2::GeoMatchStatement>
72  
73 A rule statement used to identify web requests based on country of
74 origin.
75  
76  
77 =head2 IPSetReferenceStatement => L<Paws::WAFV2::IPSetReferenceStatement>
78  
79 A rule statement used to detect web requests coming from particular IP
80 addresses or address ranges. To use this, create an IPSet that
81 specifies the addresses you want to detect, then use the ARN of that
82 set in this statement. To create an IP set, see CreateIPSet.
83  
84 Each IP set rule statement references an IP set. You create and
85 maintain the set independent of your rules. This allows you to use the
86 single set in multiple rules. When you update the referenced set, WAF
87 automatically updates all rules that reference it.
88  
89  
90 =head2 LabelMatchStatement => L<Paws::WAFV2::LabelMatchStatement>
91  
92 A rule statement that defines a string match search against labels that
93 have been added to the web request by rules that have already run in
94 the web ACL.
95  
96 The label match statement provides the label or namespace string to
97 search for. The label string can represent a part or all of the fully
98 qualified label name that had been added to the web request. Fully
99 qualified labels have a prefix, optional namespaces, and label name.
100 The prefix identifies the rule group or web ACL context of the rule
101 that added the label. If you do not provide the fully qualified name in
102 your label match string, WAF performs the search for labels that were
103 added in the same context as the label match statement.
104  
105  
106 =head2 ManagedRuleGroupStatement => L<Paws::WAFV2::ManagedRuleGroupStatement>
107  
108 A rule statement used to run the rules that are defined in a managed
109 rule group. To use this, provide the vendor name and the name of the
110 rule group in this statement. You can retrieve the required names by
111 calling ListAvailableManagedRuleGroups.
112  
113 You cannot nest a C<ManagedRuleGroupStatement>, for example for use
114 inside a C<NotStatement> or C<OrStatement>. It can only be referenced
115 as a top-level statement within a rule.
116  
117  
118 =head2 NotStatement => L<Paws::WAFV2::NotStatement>
119  
120 A logical rule statement used to negate the results of another rule
121 statement. You provide one Statement within the C<NotStatement>.
122  
123  
124 =head2 OrStatement => L<Paws::WAFV2::OrStatement>
125  
126 A logical rule statement used to combine other rule statements with OR
127 logic. You provide more than one Statement within the C<OrStatement>.
128  
129  
130 =head2 RateBasedStatement => L<Paws::WAFV2::RateBasedStatement>
131  
132 A rate-based rule tracks the rate of requests for each originating IP
133 address, and triggers the rule action when the rate exceeds a limit
134 that you specify on the number of requests in any 5-minute time span.
135 You can use this to put a temporary block on requests from an IP
136 address that is sending excessive requests.
137  
138 When the rule action triggers, WAF blocks additional requests from the
139 IP address until the request rate falls below the limit.
140  
141 You can optionally nest another statement inside the rate-based
142 statement, to narrow the scope of the rule so that it only counts
143 requests that match the nested statement. For example, based on recent
144 requests that you have seen from an attacker, you might create a
145 rate-based rule with a nested AND rule statement that contains the
146 following nested statements:
147  
148 =over
149  
150 =item *
151  
152 An IP match statement with an IP set that specified the address
153 192.0.2.44.
154  
155 =item *
156  
157 A string match statement that searches in the User-Agent header for the
158 string BadBot.
159  
160 =back
161  
162 In this rate-based rule, you also define a rate limit. For this
163 example, the rate limit is 1,000. Requests that meet both of the
164 conditions in the statements are counted. If the count exceeds 1,000
165 requests per five minutes, the rule action triggers. Requests that do
166 not meet both conditions are not counted towards the rate limit and are
167 not affected by this rule.
168  
169 You cannot nest a C<RateBasedStatement>, for example for use inside a
170 C<NotStatement> or C<OrStatement>. It can only be referenced as a
171 top-level statement within a rule.
172  
173  
174 =head2 RegexPatternSetReferenceStatement => L<Paws::WAFV2::RegexPatternSetReferenceStatement>
175  
176 A rule statement used to search web request components for matches with
177 regular expressions. To use this, create a RegexPatternSet that
178 specifies the expressions that you want to detect, then use the ARN of
179 that set in this statement. A web request matches the pattern set rule
180 statement if the request component matches any of the patterns in the
181 set. To create a regex pattern set, see CreateRegexPatternSet.
182  
183 Each regex pattern set rule statement references a regex pattern set.
184 You create and maintain the set independent of your rules. This allows
185 you to use the single set in multiple rules. When you update the
186 referenced set, WAF automatically updates all rules that reference it.
187  
188  
189 =head2 RuleGroupReferenceStatement => L<Paws::WAFV2::RuleGroupReferenceStatement>
190  
191 A rule statement used to run the rules that are defined in a RuleGroup.
192 To use this, create a rule group with your rules, then provide the ARN
193 of the rule group in this statement.
194  
195 You cannot nest a C<RuleGroupReferenceStatement>, for example for use
196 inside a C<NotStatement> or C<OrStatement>. It can only be referenced
197 as a top-level statement within a rule.
198  
199  
200 =head2 SizeConstraintStatement => L<Paws::WAFV2::SizeConstraintStatement>
201  
202 A rule statement that compares a number of bytes against the size of a
203 request component, using a comparison operator, such as greater than
204 (E<gt>) or less than (E<lt>). For example, you can use a size
205 constraint statement to look for query strings that are longer than 100
206 bytes.
207  
208 If you configure WAF to inspect the request body, WAF inspects only the
209 first 8192 bytes (8 KB). If the request body for your web requests
210 never exceeds 8192 bytes, you can create a size constraint condition
211 and block requests that have a request body greater than 8192 bytes.
212  
213 If you choose URI for the value of Part of the request to filter on,
214 the slash (/) in the URI counts as one character. For example, the URI
215 C</logo.jpg> is nine characters long.
216  
217  
218 =head2 SqliMatchStatement => L<Paws::WAFV2::SqliMatchStatement>
219  
220 Attackers sometimes insert malicious SQL code into web requests in an
221 effort to extract data from your database. To allow or block web
222 requests that appear to contain malicious SQL code, create one or more
223 SQL injection match conditions. An SQL injection match condition
224 identifies the part of web requests, such as the URI or the query
225 string, that you want WAF to inspect. Later in the process, when you
226 create a web ACL, you specify whether to allow or block requests that
227 appear to contain malicious SQL code.
228  
229  
230 =head2 XssMatchStatement => L<Paws::WAFV2::XssMatchStatement>
231  
232 A rule statement that defines a cross-site scripting (XSS) match search
233 for WAF to apply to web requests. XSS attacks are those where the
234 attacker uses vulnerabilities in a benign website as a vehicle to
235 inject malicious client-site scripts into other legitimate web
236 browsers. The XSS match statement provides the location in requests
237 that you want WAF to search and text transformations to use on the
238 search area before WAF searches for character sequences that are likely
239 to be malicious strings.
240  
241  
242  
243 =head1 SEE ALSO
244  
245 This class forms part of L<Paws>, describing an object used in L<Paws::WAFV2>
246  
247 =head1 BUGS and CONTRIBUTIONS
248  
249 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
250  
251 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
252  
253 =cut
254