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

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::WAFV2::UpdateIPSet;
3 use Moose;
4 has Addresses => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
5 has Description => (is => 'ro', isa => 'Str');
6 has Id => (is => 'ro', isa => 'Str', required => 1);
7 has LockToken => (is => 'ro', isa => 'Str', required => 1);
8 has Name => (is => 'ro', isa => 'Str', required => 1);
9 has Scope => (is => 'ro', isa => 'Str', required => 1);
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateIPSet');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WAFV2::UpdateIPSetResponse');
15 class_has _result_key => (isa => 'Str', is => 'ro');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::WAFV2::UpdateIPSet - Arguments for method UpdateIPSet on L<Paws::WAFV2>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method UpdateIPSet on the
27 L<AWS WAFV2|Paws::WAFV2> service. Use the attributes of this class
28 as arguments to method UpdateIPSet.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateIPSet.
31  
32 =head1 SYNOPSIS
33  
34 my $wafv2 = Paws->service('WAFV2');
35 my $UpdateIPSetResponse = $wafv2->UpdateIPSet(
36 Addresses => [
37 'MyIPAddress', ... # min: 1, max: 50
38 ],
39 Id => 'MyEntityId',
40 LockToken => 'MyLockToken',
41 Name => 'MyEntityName',
42 Scope => 'CLOUDFRONT',
43 Description => 'MyEntityDescription', # OPTIONAL
44 );
45  
46 # Results:
47 my $NextLockToken = $UpdateIPSetResponse->NextLockToken;
48  
49 # Returns a L<Paws::WAFV2::UpdateIPSetResponse> object.
50  
51 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
52 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/wafv2/UpdateIPSet>
53  
54 =head1 ATTRIBUTES
55  
56  
57 =head2 B<REQUIRED> Addresses => ArrayRef[Str|Undef]
58  
59 Contains an array of strings that specify one or more IP addresses or
60 blocks of IP addresses in Classless Inter-Domain Routing (CIDR)
61 notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
62  
63 Examples:
64  
65 =over
66  
67 =item *
68  
69 To configure WAF to allow, block, or count requests that originated
70 from the IP address 192.0.2.44, specify C<192.0.2.44/32>.
71  
72 =item *
73  
74 To configure WAF to allow, block, or count requests that originated
75 from IP addresses from 192.0.2.0 to 192.0.2.255, specify
76 C<192.0.2.0/24>.
77  
78 =item *
79  
80 To configure WAF to allow, block, or count requests that originated
81 from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
82 C<1111:0000:0000:0000:0000:0000:0000:0111/128>.
83  
84 =item *
85  
86 To configure WAF to allow, block, or count requests that originated
87 from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to
88 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
89 C<1111:0000:0000:0000:0000:0000:0000:0000/64>.
90  
91 =back
92  
93 For more information about CIDR notation, see the Wikipedia entry
94 Classless Inter-Domain Routing
95 (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).
96  
97  
98  
99 =head2 Description => Str
100  
101 A description of the IP set that helps with identification.
102  
103  
104  
105 =head2 B<REQUIRED> Id => Str
106  
107 A unique identifier for the set. This ID is returned in the responses
108 to create and list commands. You provide it to operations like update
109 and delete.
110  
111  
112  
113 =head2 B<REQUIRED> LockToken => Str
114  
115 A token used for optimistic locking. WAF returns a token to your get
116 and list requests, to mark the state of the entity at the time of the
117 request. To make changes to the entity associated with the token, you
118 provide the token to operations like update and delete. WAF uses the
119 token to ensure that no changes have been made to the entity since you
120 last retrieved it. If a change has been made, the update fails with a
121 C<WAFOptimisticLockException>. If this happens, perform another get,
122 and use the new token returned by that operation.
123  
124  
125  
126 =head2 B<REQUIRED> Name => Str
127  
128 The name of the IP set. You cannot change the name of an C<IPSet> after
129 you create it.
130  
131  
132  
133 =head2 B<REQUIRED> Scope => Str
134  
135 Specifies whether this is for an Amazon CloudFront distribution or for
136 a regional application. A regional application can be an Application
137 Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync
138 GraphQL API.
139  
140 To work with CloudFront, you must also specify the Region US East (N.
141 Virginia) as follows:
142  
143 =over
144  
145 =item *
146  
147 CLI - Specify the Region when you use the CloudFront scope:
148 C<--scope=CLOUDFRONT --region=us-east-1>.
149  
150 =item *
151  
152 API and SDKs - For all calls, use the Region endpoint us-east-1.
153  
154 =back
155  
156  
157 Valid values are: C<"CLOUDFRONT">, C<"REGIONAL">
158  
159  
160 =head1 SEE ALSO
161  
162 This class forms part of L<Paws>, documenting arguments for method UpdateIPSet in L<Paws::WAFV2>
163  
164 =head1 BUGS and CONTRIBUTIONS
165  
166 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
167  
168 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
169  
170 =cut
171