File Coverage

blib/lib/Paws/WAFRegional/Predicate.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::WAFRegional::Predicate;
2 1     1   506 use Moose;
  1         2  
  1         8  
3             has DataId => (is => 'ro', isa => 'Str', required => 1);
4             has Negated => (is => 'ro', isa => 'Bool', required => 1);
5             has Type => (is => 'ro', isa => 'Str', required => 1);
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::WAFRegional::Predicate
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::WAFRegional::Predicate object:
24              
25             $service_obj->Method(Att1 => { DataId => $value, ..., Type => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::WAFRegional::Predicate object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->DataId
33              
34             =head1 DESCRIPTION
35              
36             Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet,
37             and SizeConstraintSet objects that you want to add to a C<Rule> and,
38             for each object, indicates whether you want to negate the settings, for
39             example, requests that do NOT originate from the IP address 192.0.2.44.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 B<REQUIRED> DataId => Str
45              
46             A unique identifier for a predicate in a C<Rule>, such as
47             C<ByteMatchSetId> or C<IPSetId>. The ID is returned by the
48             corresponding C<Create> or C<List> command.
49              
50              
51             =head2 B<REQUIRED> Negated => Bool
52              
53             Set C<Negated> to C<False> if you want AWS WAF to allow, block, or
54             count requests based on the settings in the specified ByteMatchSet,
55             IPSet, SqlInjectionMatchSet, XssMatchSet, or SizeConstraintSet. For
56             example, if an C<IPSet> includes the IP address C<192.0.2.44>, AWS WAF
57             will allow or block requests based on that IP address.
58              
59             Set C<Negated> to C<True> if you want AWS WAF to allow or block a
60             request based on the negation of the settings in the ByteMatchSet,
61             IPSet, SqlInjectionMatchSet, XssMatchSet, or SizeConstraintSet. For
62             example, if an C<IPSet> includes the IP address C<192.0.2.44>, AWS WAF
63             will allow, block, or count requests based on all IP addresses
64             I<except> C<192.0.2.44>.
65              
66              
67             =head2 B<REQUIRED> Type => Str
68              
69             The type of predicate in a C<Rule>, such as C<ByteMatchSet> or
70             C<IPSet>.
71              
72              
73              
74             =head1 SEE ALSO
75              
76             This class forms part of L<Paws>, describing an object used in L<Paws::WAFRegional>
77              
78             =head1 BUGS and CONTRIBUTIONS
79              
80             The source code is located here: https://github.com/pplu/aws-sdk-perl
81              
82             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
83              
84             =cut
85