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