File Coverage

blib/lib/Paws/CloudHSMv2.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::CloudHSMv2;
2 1     1   2905 use Moose;
  1         4  
  1         8  
3             sub service { 'cloudhsmv2' }
4             sub version { '2017-04-28' }
5             sub target_prefix { 'BaldrApiService' }
6             sub json_version { "1.1" }
7             has max_attempts => (is => 'ro', isa => 'Int', default => 5);
8             has retry => (is => 'ro', isa => 'HashRef', default => sub {
9             { base => 'rand', type => 'exponential', growth_factor => 2 }
10             });
11             has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
12             ] });
13              
14             with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller', 'Paws::Net::JsonResponse';
15              
16            
17             sub CreateCluster {
18             my $self = shift;
19             my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::CreateCluster', @_);
20             return $self->caller->do_call($self, $call_object);
21             }
22             sub CreateHsm {
23             my $self = shift;
24             my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::CreateHsm', @_);
25             return $self->caller->do_call($self, $call_object);
26             }
27             sub DeleteCluster {
28             my $self = shift;
29             my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::DeleteCluster', @_);
30             return $self->caller->do_call($self, $call_object);
31             }
32             sub DeleteHsm {
33             my $self = shift;
34             my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::DeleteHsm', @_);
35             return $self->caller->do_call($self, $call_object);
36             }
37             sub DescribeBackups {
38             my $self = shift;
39             my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::DescribeBackups', @_);
40             return $self->caller->do_call($self, $call_object);
41             }
42             sub DescribeClusters {
43             my $self = shift;
44             my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::DescribeClusters', @_);
45             return $self->caller->do_call($self, $call_object);
46             }
47             sub InitializeCluster {
48             my $self = shift;
49             my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::InitializeCluster', @_);
50             return $self->caller->do_call($self, $call_object);
51             }
52             sub ListTags {
53             my $self = shift;
54             my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::ListTags', @_);
55             return $self->caller->do_call($self, $call_object);
56             }
57             sub TagResource {
58             my $self = shift;
59             my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::TagResource', @_);
60             return $self->caller->do_call($self, $call_object);
61             }
62             sub UntagResource {
63             my $self = shift;
64             my $call_object = $self->new_with_coercions('Paws::CloudHSMv2::UntagResource', @_);
65             return $self->caller->do_call($self, $call_object);
66             }
67            
68              
69              
70             sub operations { qw/CreateCluster CreateHsm DeleteCluster DeleteHsm DescribeBackups DescribeClusters InitializeCluster ListTags TagResource UntagResource / }
71              
72             1;
73              
74             ### main pod documentation begin ###
75              
76             =head1 NAME
77              
78             Paws::CloudHSMv2 - Perl Interface to AWS AWS CloudHSM V2
79              
80             =head1 SYNOPSIS
81              
82             use Paws;
83              
84             my $obj = Paws->service('CloudHSMv2');
85             my $res = $obj->Method(
86             Arg1 => $val1,
87             Arg2 => [ 'V1', 'V2' ],
88             # if Arg3 is an object, the HashRef will be used as arguments to the constructor
89             # of the arguments type
90             Arg3 => { Att1 => 'Val1' },
91             # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
92             # the constructor of the arguments type
93             Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
94             );
95              
96             =head1 DESCRIPTION
97              
98             For more information about AWS CloudHSM, see AWS CloudHSM and the AWS
99             CloudHSM User Guide.
100              
101             =head1 METHODS
102              
103             =head2 CreateCluster(HsmType => Str, SubnetIds => ArrayRef[Str|Undef], [SourceBackupId => Str])
104              
105             Each argument is described in detail in: L<Paws::CloudHSMv2::CreateCluster>
106              
107             Returns: a L<Paws::CloudHSMv2::CreateClusterResponse> instance
108              
109             Creates a new AWS CloudHSM cluster.
110              
111              
112             =head2 CreateHsm(AvailabilityZone => Str, ClusterId => Str, [IpAddress => Str])
113              
114             Each argument is described in detail in: L<Paws::CloudHSMv2::CreateHsm>
115              
116             Returns: a L<Paws::CloudHSMv2::CreateHsmResponse> instance
117              
118             Creates a new hardware security module (HSM) in the specified AWS
119             CloudHSM cluster.
120              
121              
122             =head2 DeleteCluster(ClusterId => Str)
123              
124             Each argument is described in detail in: L<Paws::CloudHSMv2::DeleteCluster>
125              
126             Returns: a L<Paws::CloudHSMv2::DeleteClusterResponse> instance
127              
128             Deletes the specified AWS CloudHSM cluster. Before you can delete a
129             cluster, you must delete all HSMs in the cluster. To see if the cluster
130             contains any HSMs, use DescribeClusters. To delete an HSM, use
131             DeleteHsm.
132              
133              
134             =head2 DeleteHsm(ClusterId => Str, [EniId => Str, EniIp => Str, HsmId => Str])
135              
136             Each argument is described in detail in: L<Paws::CloudHSMv2::DeleteHsm>
137              
138             Returns: a L<Paws::CloudHSMv2::DeleteHsmResponse> instance
139              
140             Deletes the specified HSM. To specify an HSM, you can use its
141             identifier (ID), the IP address of the HSM's elastic network interface
142             (ENI), or the ID of the HSM's ENI. You need to specify only one of
143             these values. To find these values, use DescribeClusters.
144              
145              
146             =head2 DescribeBackups([Filters => L<Paws::CloudHSMv2::Filters>, MaxResults => Int, NextToken => Str])
147              
148             Each argument is described in detail in: L<Paws::CloudHSMv2::DescribeBackups>
149              
150             Returns: a L<Paws::CloudHSMv2::DescribeBackupsResponse> instance
151              
152             Gets information about backups of AWS CloudHSM clusters.
153              
154             This is a paginated operation, which means that each response might
155             contain only a subset of all the backups. When the response contains
156             only a subset of backups, it includes a C<NextToken> value. Use this
157             value in a subsequent C<DescribeBackups> request to get more backups.
158             When you receive a response with no C<NextToken> (or an empty or null
159             value), that means there are no more backups to get.
160              
161              
162             =head2 DescribeClusters([Filters => L<Paws::CloudHSMv2::Filters>, MaxResults => Int, NextToken => Str])
163              
164             Each argument is described in detail in: L<Paws::CloudHSMv2::DescribeClusters>
165              
166             Returns: a L<Paws::CloudHSMv2::DescribeClustersResponse> instance
167              
168             Gets information about AWS CloudHSM clusters.
169              
170             This is a paginated operation, which means that each response might
171             contain only a subset of all the clusters. When the response contains
172             only a subset of clusters, it includes a C<NextToken> value. Use this
173             value in a subsequent C<DescribeClusters> request to get more clusters.
174             When you receive a response with no C<NextToken> (or an empty or null
175             value), that means there are no more clusters to get.
176              
177              
178             =head2 InitializeCluster(ClusterId => Str, SignedCert => Str, TrustAnchor => Str)
179              
180             Each argument is described in detail in: L<Paws::CloudHSMv2::InitializeCluster>
181              
182             Returns: a L<Paws::CloudHSMv2::InitializeClusterResponse> instance
183              
184             Claims an AWS CloudHSM cluster by submitting the cluster certificate
185             issued by your issuing certificate authority (CA) and the CA's root
186             certificate. Before you can claim a cluster, you must sign the
187             cluster's certificate signing request (CSR) with your issuing CA. To
188             get the cluster's CSR, use DescribeClusters.
189              
190              
191             =head2 ListTags(ResourceId => Str, [MaxResults => Int, NextToken => Str])
192              
193             Each argument is described in detail in: L<Paws::CloudHSMv2::ListTags>
194              
195             Returns: a L<Paws::CloudHSMv2::ListTagsResponse> instance
196              
197             Gets a list of tags for the specified AWS CloudHSM cluster.
198              
199             This is a paginated operation, which means that each response might
200             contain only a subset of all the tags. When the response contains only
201             a subset of tags, it includes a C<NextToken> value. Use this value in a
202             subsequent C<ListTags> request to get more tags. When you receive a
203             response with no C<NextToken> (or an empty or null value), that means
204             there are no more tags to get.
205              
206              
207             =head2 TagResource(ResourceId => Str, TagList => ArrayRef[L<Paws::CloudHSMv2::Tag>])
208              
209             Each argument is described in detail in: L<Paws::CloudHSMv2::TagResource>
210              
211             Returns: a L<Paws::CloudHSMv2::TagResourceResponse> instance
212              
213             Adds or overwrites one or more tags for the specified AWS CloudHSM
214             cluster.
215              
216              
217             =head2 UntagResource(ResourceId => Str, TagKeyList => ArrayRef[Str|Undef])
218              
219             Each argument is described in detail in: L<Paws::CloudHSMv2::UntagResource>
220              
221             Returns: a L<Paws::CloudHSMv2::UntagResourceResponse> instance
222              
223             Removes the specified tag or tags from the specified AWS CloudHSM
224             cluster.
225              
226              
227              
228              
229             =head1 PAGINATORS
230              
231             Paginator methods are helpers that repetively call methods that return partial results
232              
233              
234              
235              
236             =head1 SEE ALSO
237              
238             This service class forms part of L<Paws>
239              
240             =head1 BUGS and CONTRIBUTIONS
241              
242             The source code is located here: https://github.com/pplu/aws-sdk-perl
243              
244             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
245              
246             =cut
247