« blib/lib/Paws/DocDB/DBClusterRole.pm
↑ Summary
blib/lib/Paws/DocDB/DBClusterSnapshotAttribute.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DocDB::DBClusterSnapshot; | ||
| 3 | use Moose; | ||
| 4 | has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'AvailabilityZone', traits => ['NameInRequest']); | ||
| 5 | has ClusterCreateTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has DBClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 7 | has DBClusterSnapshotArn => (is => 'ro', isa => 'Str'); | ||
| 8 | has DBClusterSnapshotIdentifier => (is => 'ro', isa => 'Str'); | ||
| 9 | has Engine => (is => 'ro', isa => 'Str'); | ||
| 10 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 11 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 12 | has MasterUsername => (is => 'ro', isa => 'Str'); | ||
| 13 | has PercentProgress => (is => 'ro', isa => 'Int'); | ||
| 14 | has Port => (is => 'ro', isa => 'Int'); | ||
| 15 | has SnapshotCreateTime => (is => 'ro', isa => 'Str'); | ||
| 16 | has SnapshotType => (is => 'ro', isa => 'Str'); | ||
| 17 | has SourceDBClusterSnapshotArn => (is => 'ro', isa => 'Str'); | ||
| 18 | has Status => (is => 'ro', isa => 'Str'); | ||
| 19 | has StorageEncrypted => (is => 'ro', isa => 'Bool'); | ||
| 20 | has VpcId => (is => 'ro', isa => 'Str'); | ||
| 21 | |||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::DocDB::DBClusterSnapshot | ||
| 29 | |||
| 30 | =head1 USAGE | ||
| 31 | |||
| 32 | This class represents one of two things: | ||
| 33 | |||
| 34 | =head3 Arguments in a call to a service | ||
| 35 | |||
| 36 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 37 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 38 | |||
| 39 | As an example, if Att1 is expected to be a Paws::DocDB::DBClusterSnapshot object: | ||
| 40 | |||
| 41 | $service_obj->Method(Att1 => { AvailabilityZones => $value, ..., VpcId => $value }); | ||
| 42 | |||
| 43 | =head3 Results returned from an API call | ||
| 44 | |||
| 45 | Use accessors for each attribute. If Att1 is expected to be an Paws::DocDB::DBClusterSnapshot object: | ||
| 46 | |||
| 47 | $result = $service_obj->Method(...); | ||
| 48 | $result->Att1->AvailabilityZones | ||
| 49 | |||
| 50 | =head1 DESCRIPTION | ||
| 51 | |||
| 52 | Detailed information about a cluster snapshot. | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 AvailabilityZones => ArrayRef[Str|Undef] | ||
| 58 | |||
| 59 | Provides the list of Amazon EC2 Availability Zones that instances in | ||
| 60 | the cluster snapshot can be restored in. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 ClusterCreateTime => Str | ||
| 64 | |||
| 65 | Specifies the time when the cluster was created, in Universal | ||
| 66 | Coordinated Time (UTC). | ||
| 67 | |||
| 68 | |||
| 69 | =head2 DBClusterIdentifier => Str | ||
| 70 | |||
| 71 | Specifies the cluster identifier of the cluster that this cluster | ||
| 72 | snapshot was created from. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 DBClusterSnapshotArn => Str | ||
| 76 | |||
| 77 | The Amazon Resource Name (ARN) for the cluster snapshot. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 DBClusterSnapshotIdentifier => Str | ||
| 81 | |||
| 82 | Specifies the identifier for the cluster snapshot. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 Engine => Str | ||
| 86 | |||
| 87 | Specifies the name of the database engine. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 EngineVersion => Str | ||
| 91 | |||
| 92 | Provides the version of the database engine for this cluster snapshot. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 KmsKeyId => Str | ||
| 96 | |||
| 97 | If C<StorageEncrypted> is C<true>, the KMS key identifier for the | ||
| 98 | encrypted cluster snapshot. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 MasterUsername => Str | ||
| 102 | |||
| 103 | Provides the master user name for the cluster snapshot. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 PercentProgress => Int | ||
| 107 | |||
| 108 | Specifies the percentage of the estimated data that has been | ||
| 109 | transferred. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 Port => Int | ||
| 113 | |||
| 114 | Specifies the port that the cluster was listening on at the time of the | ||
| 115 | snapshot. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 SnapshotCreateTime => Str | ||
| 119 | |||
| 120 | Provides the time when the snapshot was taken, in UTC. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 SnapshotType => Str | ||
| 124 | |||
| 125 | Provides the type of the cluster snapshot. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 SourceDBClusterSnapshotArn => Str | ||
| 129 | |||
| 130 | If the cluster snapshot was copied from a source cluster snapshot, the | ||
| 131 | ARN for the source cluster snapshot; otherwise, a null value. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 Status => Str | ||
| 135 | |||
| 136 | Specifies the status of this cluster snapshot. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 StorageEncrypted => Bool | ||
| 140 | |||
| 141 | Specifies whether the cluster snapshot is encrypted. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 VpcId => Str | ||
| 145 | |||
| 146 | Provides the virtual private cloud (VPC) ID that is associated with the | ||
| 147 | cluster snapshot. | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | =head1 SEE ALSO | ||
| 152 | |||
| 153 | This class forms part of L<Paws>, describing an object used in L<Paws::DocDB> | ||
| 154 | |||
| 155 | =head1 BUGS and CONTRIBUTIONS | ||
| 156 | |||
| 157 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 158 | |||
| 159 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 160 | |||
| 161 | =cut | ||
| 162 |