File Coverage

blib/lib/Paws/WAFRegional/IPSet.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::IPSet;
2 1     1   426 use Moose;
  1         3  
  1         8  
3             has IPSetDescriptors => (is => 'ro', isa => 'ArrayRef[Paws::WAFRegional::IPSetDescriptor]', required => 1);
4             has IPSetId => (is => 'ro', isa => 'Str', required => 1);
5             has Name => (is => 'ro', isa => 'Str');
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::WAFRegional::IPSet
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::IPSet object:
24              
25             $service_obj->Method(Att1 => { IPSetDescriptors => $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::WAFRegional::IPSet object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->IPSetDescriptors
33              
34             =head1 DESCRIPTION
35              
36             Contains one or more IP addresses or blocks of IP addresses specified
37             in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports /8,
38             /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56,
39             /64 and /128 for IPv6.
40              
41             To specify an individual IP address, you specify the four-part IP
42             address followed by a C</32>, for example, 192.0.2.0/31. To block a
43             range of IP addresses, you can specify a C</128>, C</64>, C</56>,
44             C</48>, C</32>, C</24>, C</16>, or C</8> CIDR. For more information
45             about CIDR notation, see the Wikipedia entry Classless Inter-Domain
46             Routing.
47              
48             =head1 ATTRIBUTES
49              
50              
51             =head2 B<REQUIRED> IPSetDescriptors => ArrayRef[L<Paws::WAFRegional::IPSetDescriptor>]
52              
53             The IP address type (C<IPV4> or C<IPV6>) and the IP address range (in
54             CIDR notation) that web requests originate from. If the C<WebACL> is
55             associated with a CloudFront distribution and the viewer did not use an
56             HTTP proxy or a load balancer to send the request, this is the value of
57             the c-ip field in the CloudFront access logs.
58              
59              
60             =head2 B<REQUIRED> IPSetId => Str
61              
62             The C<IPSetId> for an C<IPSet>. You use C<IPSetId> to get information
63             about an C<IPSet> (see GetIPSet), update an C<IPSet> (see UpdateIPSet),
64             insert an C<IPSet> into a C<Rule> or delete one from a C<Rule> (see
65             UpdateRule), and delete an C<IPSet> from AWS WAF (see DeleteIPSet).
66              
67             C<IPSetId> is returned by CreateIPSet and by ListIPSets.
68              
69              
70             =head2 Name => Str
71              
72             A friendly name or description of the IPSet. You can't change the name
73             of an C<IPSet> after you create it.
74              
75              
76              
77             =head1 SEE ALSO
78              
79             This class forms part of L<Paws>, describing an object used in L<Paws::WAFRegional>
80              
81             =head1 BUGS and CONTRIBUTIONS
82              
83             The source code is located here: https://github.com/pplu/aws-sdk-perl
84              
85             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
86              
87             =cut
88