blib/lib/Paws/CloudHSMv2.pm untested

filter: Statementstmt 0.0% 0 / 120 Branchbran 0.0% 0 / 12 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 25 Podpod 0.0% 0 / 24 totaltotal 0.0% 0 / 181 CC 7 SCAR 15.9
CC
7
Cov
0%
DescribeAllBackups
12.0
DescribeAllClusters
12.0
ListAllTags
12.0
CRAP 4.9
1 package Paws::CloudHSMv2;
2 use Moose;
3 sub service { 'cloudhsmv2' }
4 sub signing_name { 'cloudhsm' }
5 sub version { '2017-04-28' }
6 sub target_prefix { 'BaldrApiService' }
7 sub json_version { "1.1" }
8 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
9 has retry => (is => 'ro', isa => 'HashRef', default => sub {
10 { base => 'rand', type => 'exponential', growth_factor => 2 }
11 });
12 has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
13 ] });
14  
15 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller';
16  
17
18 sub CopyBackupToRegion {
19 my $self = shift;
20 my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::CopyBackupToRegion', @_);
21 return $self->caller->do_call($self, $call_object);
22 }
23 sub CreateCluster {
24 my $self = shift;
25 my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::CreateCluster', @_);
26 return $self->caller->do_call($self, $call_object);
27 }
28 sub CreateHsm {
29 my $self = shift;
30 my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::CreateHsm', @_);
31 return $self->caller->do_call($self, $call_object);
32 }
33 sub DeleteBackup {
34 my $self = shift;
35 my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::DeleteBackup', @_);
36 return $self->caller->do_call($self, $call_object);
37 }
38 sub DeleteCluster {
39 my $self = shift;
40 my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::DeleteCluster', @_);
41 return $self->caller->do_call($self, $call_object);
42 }
43 sub DeleteHsm {
44 my $self = shift;
45 my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::DeleteHsm', @_);
46 return $self->caller->do_call($self, $call_object);
47 }
48 sub DescribeBackups {
49 my $self = shift;
50 my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::DescribeBackups', @_);
51 return $self->caller->do_call($self, $call_object);
52 }
53 sub DescribeClusters {
54 my $self = shift;
55 my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::DescribeClusters', @_);
56 return $self->caller->do_call($self, $call_object);
57 }
58 sub InitializeCluster {
59 my $self = shift;
60 my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::InitializeCluster', @_);
61 return $self->caller->do_call($self, $call_object);
62 }
63 sub ListTags {
64 my $self = shift;
65 my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::ListTags', @_);
66 return $self->caller->do_call($self, $call_object);
67 }
68 sub ModifyBackupAttributes {
69 my $self = shift;
70 my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::ModifyBackupAttributes', @_);
71 return $self->caller->do_call($self, $call_object);
72 }
73 sub ModifyCluster {
74 my $self = shift;
75 my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::ModifyCluster', @_);
76 return $self->caller->do_call($self, $call_object);
77 }
78 sub RestoreBackup {
79 my $self = shift;
80 my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::RestoreBackup', @_);
81 return $self->caller->do_call($self, $call_object);
82 }
83 sub TagResource {
84 my $self = shift;
85 my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::TagResource', @_);
86 return $self->caller->do_call($self, $call_object);
87 }
88 sub UntagResource {
89 my $self = shift;
90 my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::UntagResource', @_);
91 return $self->caller->do_call($self, $call_object);
92 }
93
94 sub DescribeAllBackups {
95 my $self = shift;
96  
97 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
98 my $result = $self->DescribeBackups(@_);
99 my $next_result = $result;
100  
101 if (not defined $callback) {
102 while ($next_result->NextToken) {
103 $next_result = $self->DescribeBackups(@_, NextToken => $next_result->NextToken);
104 push @{ $result->Backups }, @{ $next_result->Backups };
105 }
106 return $result;
107 } else {
108 while ($result->NextToken) {
109 $callback->($_ => 'Backups') foreach (@{ $result->Backups });
110 $result = $self->DescribeBackups(@_, NextToken => $result->NextToken);
111 }
112 $callback->($_ => 'Backups') foreach (@{ $result->Backups });
113 }
114  
115 return undef
116 }
117 sub DescribeAllClusters {
118 my $self = shift;
119  
120 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
121 my $result = $self->DescribeClusters(@_);
122 my $next_result = $result;
123  
124 if (not defined $callback) {
125 while ($next_result->NextToken) {
126 $next_result = $self->DescribeClusters(@_, NextToken => $next_result->NextToken);
127 push @{ $result->Clusters }, @{ $next_result->Clusters };
128 }
129 return $result;
130 } else {
131 while ($result->NextToken) {
132 $callback->($_ => 'Clusters') foreach (@{ $result->Clusters });
133 $result = $self->DescribeClusters(@_, NextToken => $result->NextToken);
134 }
135 $callback->($_ => 'Clusters') foreach (@{ $result->Clusters });
136 }
137  
138 return undef
139 }
140 sub ListAllTags {
141 my $self = shift;
142  
143 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
144 my $result = $self->ListTags(@_);
145 my $next_result = $result;
146  
147 if (not defined $callback) {
148 while ($next_result->NextToken) {
149 $next_result = $self->ListTags(@_, NextToken => $next_result->NextToken);
150 push @{ $result->TagList }, @{ $next_result->TagList };
151 }
152 return $result;
153 } else {
154 while ($result->NextToken) {
155 $callback->($_ => 'TagList') foreach (@{ $result->TagList });
156 $result = $self->ListTags(@_, NextToken => $result->NextToken);
157 }
158 $callback->($_ => 'TagList') foreach (@{ $result->TagList });
159 }
160  
161 return undef
162 }
163  
164  
165 sub operations { qw/CopyBackupToRegion CreateCluster CreateHsm DeleteBackup DeleteCluster DeleteHsm DescribeBackups DescribeClusters InitializeCluster ListTags ModifyBackupAttributes ModifyCluster RestoreBackup TagResource UntagResource / }
166  
167 1;
168  
169 ### main pod documentation begin ###
170  
171 =head1 NAME
172  
173 Paws::CloudHSMv2 - Perl Interface to AWS AWS CloudHSM V2
174  
175 =head1 SYNOPSIS
176  
177 use Paws;
178  
179 my $obj = Paws->service('CloudHSMv2');
180 my $res = $obj->Method(
181 Arg1 => $val1,
182 Arg2 => [ 'V1', 'V2' ],
183 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
184 # of the arguments type
185 Arg3 => { Att1 => 'Val1' },
186 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
187 # the constructor of the arguments type
188 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
189 );
190  
191 =head1 DESCRIPTION
192  
193 For more information about AWS CloudHSM, see AWS CloudHSM
194 (http://aws.amazon.com/cloudhsm/) and the AWS CloudHSM User Guide
195 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/).
196  
197 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28>
198  
199  
200 =head1 METHODS
201  
202 =head2 CopyBackupToRegion
203  
204 =over
205  
206 =item BackupId => Str
207  
208 =item DestinationRegion => Str
209  
210 =item [TagList => ArrayRef[L<Paws::CloudHSMv2::Tag>]]
211  
212  
213 =back
214  
215 Each argument is described in detail in: L<Paws::CloudHSMv2::CopyBackupToRegion>
216  
217 Returns: a L<Paws::CloudHSMv2::CopyBackupToRegionResponse> instance
218  
219 Copy an AWS CloudHSM cluster backup to a different region.
220  
221  
222 =head2 CreateCluster
223  
224 =over
225  
226 =item HsmType => Str
227  
228 =item SubnetIds => ArrayRef[Str|Undef]
229  
230 =item [BackupRetentionPolicy => L<Paws::CloudHSMv2::BackupRetentionPolicy>]
231  
232 =item [SourceBackupId => Str]
233  
234 =item [TagList => ArrayRef[L<Paws::CloudHSMv2::Tag>]]
235  
236  
237 =back
238  
239 Each argument is described in detail in: L<Paws::CloudHSMv2::CreateCluster>
240  
241 Returns: a L<Paws::CloudHSMv2::CreateClusterResponse> instance
242  
243 Creates a new AWS CloudHSM cluster.
244  
245  
246 =head2 CreateHsm
247  
248 =over
249  
250 =item AvailabilityZone => Str
251  
252 =item ClusterId => Str
253  
254 =item [IpAddress => Str]
255  
256  
257 =back
258  
259 Each argument is described in detail in: L<Paws::CloudHSMv2::CreateHsm>
260  
261 Returns: a L<Paws::CloudHSMv2::CreateHsmResponse> instance
262  
263 Creates a new hardware security module (HSM) in the specified AWS
264 CloudHSM cluster.
265  
266  
267 =head2 DeleteBackup
268  
269 =over
270  
271 =item BackupId => Str
272  
273  
274 =back
275  
276 Each argument is described in detail in: L<Paws::CloudHSMv2::DeleteBackup>
277  
278 Returns: a L<Paws::CloudHSMv2::DeleteBackupResponse> instance
279  
280 Deletes a specified AWS CloudHSM backup. A backup can be restored up to
281 7 days after the DeleteBackup request is made. For more information on
282 restoring a backup, see RestoreBackup.
283  
284  
285 =head2 DeleteCluster
286  
287 =over
288  
289 =item ClusterId => Str
290  
291  
292 =back
293  
294 Each argument is described in detail in: L<Paws::CloudHSMv2::DeleteCluster>
295  
296 Returns: a L<Paws::CloudHSMv2::DeleteClusterResponse> instance
297  
298 Deletes the specified AWS CloudHSM cluster. Before you can delete a
299 cluster, you must delete all HSMs in the cluster. To see if the cluster
300 contains any HSMs, use DescribeClusters. To delete an HSM, use
301 DeleteHsm.
302  
303  
304 =head2 DeleteHsm
305  
306 =over
307  
308 =item ClusterId => Str
309  
310 =item [EniId => Str]
311  
312 =item [EniIp => Str]
313  
314 =item [HsmId => Str]
315  
316  
317 =back
318  
319 Each argument is described in detail in: L<Paws::CloudHSMv2::DeleteHsm>
320  
321 Returns: a L<Paws::CloudHSMv2::DeleteHsmResponse> instance
322  
323 Deletes the specified HSM. To specify an HSM, you can use its
324 identifier (ID), the IP address of the HSM's elastic network interface
325 (ENI), or the ID of the HSM's ENI. You need to specify only one of
326 these values. To find these values, use DescribeClusters.
327  
328  
329 =head2 DescribeBackups
330  
331 =over
332  
333 =item [Filters => L<Paws::CloudHSMv2::Filters>]
334  
335 =item [MaxResults => Int]
336  
337 =item [NextToken => Str]
338  
339 =item [SortAscending => Bool]
340  
341  
342 =back
343  
344 Each argument is described in detail in: L<Paws::CloudHSMv2::DescribeBackups>
345  
346 Returns: a L<Paws::CloudHSMv2::DescribeBackupsResponse> instance
347  
348 Gets information about backups of AWS CloudHSM clusters.
349  
350 This is a paginated operation, which means that each response might
351 contain only a subset of all the backups. When the response contains
352 only a subset of backups, it includes a C<NextToken> value. Use this
353 value in a subsequent C<DescribeBackups> request to get more backups.
354 When you receive a response with no C<NextToken> (or an empty or null
355 value), that means there are no more backups to get.
356  
357  
358 =head2 DescribeClusters
359  
360 =over
361  
362 =item [Filters => L<Paws::CloudHSMv2::Filters>]
363  
364 =item [MaxResults => Int]
365  
366 =item [NextToken => Str]
367  
368  
369 =back
370  
371 Each argument is described in detail in: L<Paws::CloudHSMv2::DescribeClusters>
372  
373 Returns: a L<Paws::CloudHSMv2::DescribeClustersResponse> instance
374  
375 Gets information about AWS CloudHSM clusters.
376  
377 This is a paginated operation, which means that each response might
378 contain only a subset of all the clusters. When the response contains
379 only a subset of clusters, it includes a C<NextToken> value. Use this
380 value in a subsequent C<DescribeClusters> request to get more clusters.
381 When you receive a response with no C<NextToken> (or an empty or null
382 value), that means there are no more clusters to get.
383  
384  
385 =head2 InitializeCluster
386  
387 =over
388  
389 =item ClusterId => Str
390  
391 =item SignedCert => Str
392  
393 =item TrustAnchor => Str
394  
395  
396 =back
397  
398 Each argument is described in detail in: L<Paws::CloudHSMv2::InitializeCluster>
399  
400 Returns: a L<Paws::CloudHSMv2::InitializeClusterResponse> instance
401  
402 Claims an AWS CloudHSM cluster by submitting the cluster certificate
403 issued by your issuing certificate authority (CA) and the CA's root
404 certificate. Before you can claim a cluster, you must sign the
405 cluster's certificate signing request (CSR) with your issuing CA. To
406 get the cluster's CSR, use DescribeClusters.
407  
408  
409 =head2 ListTags
410  
411 =over
412  
413 =item ResourceId => Str
414  
415 =item [MaxResults => Int]
416  
417 =item [NextToken => Str]
418  
419  
420 =back
421  
422 Each argument is described in detail in: L<Paws::CloudHSMv2::ListTags>
423  
424 Returns: a L<Paws::CloudHSMv2::ListTagsResponse> instance
425  
426 Gets a list of tags for the specified AWS CloudHSM cluster.
427  
428 This is a paginated operation, which means that each response might
429 contain only a subset of all the tags. When the response contains only
430 a subset of tags, it includes a C<NextToken> value. Use this value in a
431 subsequent C<ListTags> request to get more tags. When you receive a
432 response with no C<NextToken> (or an empty or null value), that means
433 there are no more tags to get.
434  
435  
436 =head2 ModifyBackupAttributes
437  
438 =over
439  
440 =item BackupId => Str
441  
442 =item NeverExpires => Bool
443  
444  
445 =back
446  
447 Each argument is described in detail in: L<Paws::CloudHSMv2::ModifyBackupAttributes>
448  
449 Returns: a L<Paws::CloudHSMv2::ModifyBackupAttributesResponse> instance
450  
451 Modifies attributes for AWS CloudHSM backup.
452  
453  
454 =head2 ModifyCluster
455  
456 =over
457  
458 =item BackupRetentionPolicy => L<Paws::CloudHSMv2::BackupRetentionPolicy>
459  
460 =item ClusterId => Str
461  
462  
463 =back
464  
465 Each argument is described in detail in: L<Paws::CloudHSMv2::ModifyCluster>
466  
467 Returns: a L<Paws::CloudHSMv2::ModifyClusterResponse> instance
468  
469 Modifies AWS CloudHSM cluster.
470  
471  
472 =head2 RestoreBackup
473  
474 =over
475  
476 =item BackupId => Str
477  
478  
479 =back
480  
481 Each argument is described in detail in: L<Paws::CloudHSMv2::RestoreBackup>
482  
483 Returns: a L<Paws::CloudHSMv2::RestoreBackupResponse> instance
484  
485 Restores a specified AWS CloudHSM backup that is in the
486 C<PENDING_DELETION> state. For mor information on deleting a backup,
487 see DeleteBackup.
488  
489  
490 =head2 TagResource
491  
492 =over
493  
494 =item ResourceId => Str
495  
496 =item TagList => ArrayRef[L<Paws::CloudHSMv2::Tag>]
497  
498  
499 =back
500  
501 Each argument is described in detail in: L<Paws::CloudHSMv2::TagResource>
502  
503 Returns: a L<Paws::CloudHSMv2::TagResourceResponse> instance
504  
505 Adds or overwrites one or more tags for the specified AWS CloudHSM
506 cluster.
507  
508  
509 =head2 UntagResource
510  
511 =over
512  
513 =item ResourceId => Str
514  
515 =item TagKeyList => ArrayRef[Str|Undef]
516  
517  
518 =back
519  
520 Each argument is described in detail in: L<Paws::CloudHSMv2::UntagResource>
521  
522 Returns: a L<Paws::CloudHSMv2::UntagResourceResponse> instance
523  
524 Removes the specified tag or tags from the specified AWS CloudHSM
525 cluster.
526  
527  
528  
529  
530 =head1 PAGINATORS
531  
532 Paginator methods are helpers that repetively call methods that return partial results
533  
534 =head2 DescribeAllBackups(sub { },[Filters => L<Paws::CloudHSMv2::Filters>, MaxResults => Int, NextToken => Str, SortAscending => Bool])
535  
536 =head2 DescribeAllBackups([Filters => L<Paws::CloudHSMv2::Filters>, MaxResults => Int, NextToken => Str, SortAscending => Bool])
537  
538  
539 If passed a sub as first parameter, it will call the sub for each element found in :
540  
541 - Backups, passing the object as the first parameter, and the string 'Backups' as the second parameter
542  
543 If not, it will return a a L<Paws::CloudHSMv2::DescribeBackupsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
544  
545  
546 =head2 DescribeAllClusters(sub { },[Filters => L<Paws::CloudHSMv2::Filters>, MaxResults => Int, NextToken => Str])
547  
548 =head2 DescribeAllClusters([Filters => L<Paws::CloudHSMv2::Filters>, MaxResults => Int, NextToken => Str])
549  
550  
551 If passed a sub as first parameter, it will call the sub for each element found in :
552  
553 - Clusters, passing the object as the first parameter, and the string 'Clusters' as the second parameter
554  
555 If not, it will return a a L<Paws::CloudHSMv2::DescribeClustersResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
556  
557  
558 =head2 ListAllTags(sub { },ResourceId => Str, [MaxResults => Int, NextToken => Str])
559  
560 =head2 ListAllTags(ResourceId => Str, [MaxResults => Int, NextToken => Str])
561  
562  
563 If passed a sub as first parameter, it will call the sub for each element found in :
564  
565 - TagList, passing the object as the first parameter, and the string 'TagList' as the second parameter
566  
567 If not, it will return a a L<Paws::CloudHSMv2::ListTagsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
568  
569  
570  
571  
572  
573 =head1 SEE ALSO
574  
575 This service class forms part of L<Paws>
576  
577 =head1 BUGS and CONTRIBUTIONS
578  
579 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
580  
581 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
582  
583 =cut
584