File Coverage

blib/lib/Paws/CloudHSMv2/Cluster.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::Cluster;
2 1     1   328 use Moose;
  1         3  
  1         6  
3             has BackupPolicy => (is => 'ro', isa => 'Str');
4             has Certificates => (is => 'ro', isa => 'Paws::CloudHSMv2::Certificates');
5             has ClusterId => (is => 'ro', isa => 'Str');
6             has CreateTimestamp => (is => 'ro', isa => 'Str');
7             has Hsms => (is => 'ro', isa => 'ArrayRef[Paws::CloudHSMv2::Hsm]');
8             has HsmType => (is => 'ro', isa => 'Str');
9             has PreCoPassword => (is => 'ro', isa => 'Str');
10             has SecurityGroup => (is => 'ro', isa => 'Str');
11             has SourceBackupId => (is => 'ro', isa => 'Str');
12             has State => (is => 'ro', isa => 'Str');
13             has StateMessage => (is => 'ro', isa => 'Str');
14             has SubnetMapping => (is => 'ro', isa => 'Paws::CloudHSMv2::ExternalSubnetMapping');
15             has VpcId => (is => 'ro', isa => 'Str');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::CloudHSMv2::Cluster
23              
24             =head1 USAGE
25              
26             This class represents one of two things:
27              
28             =head3 Arguments in a call to a service
29              
30             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
31             Each attribute should be used as a named argument in the calls that expect this type of object.
32              
33             As an example, if Att1 is expected to be a Paws::CloudHSMv2::Cluster object:
34              
35             $service_obj->Method(Att1 => { BackupPolicy => $value, ..., VpcId => $value });
36              
37             =head3 Results returned from an API call
38              
39             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudHSMv2::Cluster object:
40              
41             $result = $service_obj->Method(...);
42             $result->Att1->BackupPolicy
43              
44             =head1 DESCRIPTION
45              
46             Contains information about an AWS CloudHSM cluster.
47              
48             =head1 ATTRIBUTES
49              
50              
51             =head2 BackupPolicy => Str
52              
53             The cluster's backup policy.
54              
55              
56             =head2 Certificates => L<Paws::CloudHSMv2::Certificates>
57              
58             Contains one or more certificates or a certificate signing request
59             (CSR).
60              
61              
62             =head2 ClusterId => Str
63              
64             The cluster's identifier (ID).
65              
66              
67             =head2 CreateTimestamp => Str
68              
69             The date and time when the cluster was created.
70              
71              
72             =head2 Hsms => ArrayRef[L<Paws::CloudHSMv2::Hsm>]
73              
74             Contains information about the HSMs in the cluster.
75              
76              
77             =head2 HsmType => Str
78              
79             The type of HSM that the cluster contains.
80              
81              
82             =head2 PreCoPassword => Str
83              
84             The default password for the cluster's Pre-Crypto Officer (PRECO) user.
85              
86              
87             =head2 SecurityGroup => Str
88              
89             The identifier (ID) of the cluster's security group.
90              
91              
92             =head2 SourceBackupId => Str
93              
94             The identifier (ID) of the backup used to create the cluster. This
95             value exists only when the cluster was created from a backup.
96              
97              
98             =head2 State => Str
99              
100             The cluster's state.
101              
102              
103             =head2 StateMessage => Str
104              
105             A description of the cluster's state.
106              
107              
108             =head2 SubnetMapping => L<Paws::CloudHSMv2::ExternalSubnetMapping>
109              
110             A map of the cluster's subnets and their corresponding Availability
111             Zones.
112              
113              
114             =head2 VpcId => Str
115              
116             The identifier (ID) of the virtual private cloud (VPC) that contains
117             the cluster.
118              
119              
120              
121             =head1 SEE ALSO
122              
123             This class forms part of L<Paws>, describing an object used in L<Paws::CloudHSMv2>
124              
125             =head1 BUGS and CONTRIBUTIONS
126              
127             The source code is located here: https://github.com/pplu/aws-sdk-perl
128              
129             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
130              
131             =cut
132