File Coverage

blib/lib/Paws/WAF/ByteMatchSet.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::WAF::ByteMatchSet;
2 1     1   419 use Moose;
  1         2  
  1         7  
3             has ByteMatchSetId => (is => 'ro', isa => 'Str', required => 1);
4             has ByteMatchTuples => (is => 'ro', isa => 'ArrayRef[Paws::WAF::ByteMatchTuple]', required => 1);
5             has Name => (is => 'ro', isa => 'Str');
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::WAF::ByteMatchSet
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::WAF::ByteMatchSet object:
24              
25             $service_obj->Method(Att1 => { ByteMatchSetId => $value, ..., Name => $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::WAF::ByteMatchSet object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->ByteMatchSetId
33              
34             =head1 DESCRIPTION
35              
36             In a GetByteMatchSet request, C<ByteMatchSet> is a complex type that
37             contains the C<ByteMatchSetId> and C<Name> of a C<ByteMatchSet>, and
38             the values that you specified when you updated the C<ByteMatchSet>.
39              
40             A complex type that contains C<ByteMatchTuple> objects, which specify
41             the parts of web requests that you want AWS WAF to inspect and the
42             values that you want AWS WAF to search for. If a C<ByteMatchSet>
43             contains more than one C<ByteMatchTuple> object, a request needs to
44             match the settings in only one C<ByteMatchTuple> to be considered a
45             match.
46              
47             =head1 ATTRIBUTES
48              
49              
50             =head2 B<REQUIRED> ByteMatchSetId => Str
51              
52             The C<ByteMatchSetId> for a C<ByteMatchSet>. You use C<ByteMatchSetId>
53             to get information about a C<ByteMatchSet> (see GetByteMatchSet),
54             update a C<ByteMatchSet> (see UpdateByteMatchSet), insert a
55             C<ByteMatchSet> into a C<Rule> or delete one from a C<Rule> (see
56             UpdateRule), and delete a C<ByteMatchSet> from AWS WAF (see
57             DeleteByteMatchSet).
58              
59             C<ByteMatchSetId> is returned by CreateByteMatchSet and by
60             ListByteMatchSets.
61              
62              
63             =head2 B<REQUIRED> ByteMatchTuples => ArrayRef[L<Paws::WAF::ByteMatchTuple>]
64              
65             Specifies the bytes (typically a string that corresponds with ASCII
66             characters) that you want AWS WAF to search for in web requests, the
67             location in requests that you want AWS WAF to search, and other
68             settings.
69              
70              
71             =head2 Name => Str
72              
73             A friendly name or description of the ByteMatchSet. You can't change
74             C<Name> after you create a C<ByteMatchSet>.
75              
76              
77              
78             =head1 SEE ALSO
79              
80             This class forms part of L<Paws>, describing an object used in L<Paws::WAF>
81              
82             =head1 BUGS and CONTRIBUTIONS
83              
84             The source code is located here: https://github.com/pplu/aws-sdk-perl
85              
86             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
87              
88             =cut
89