« blib/lib/Paws/Neptune/DBClusterRole.pm
↑ Summary
blib/lib/Paws/Neptune/DBClusterSnapshotAttribute.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Neptune::DBClusterSnapshot; | ||
| 3 | use Moose; | ||
| 4 | has AllocatedStorage => (is => 'ro', isa => 'Int'); | ||
| 5 | has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'AvailabilityZone', traits => ['NameInRequest']); | ||
| 6 | has ClusterCreateTime => (is => 'ro', isa => 'Str'); | ||
| 7 | has DBClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 8 | has DBClusterSnapshotArn => (is => 'ro', isa => 'Str'); | ||
| 9 | has DBClusterSnapshotIdentifier => (is => 'ro', isa => 'Str'); | ||
| 10 | has Engine => (is => 'ro', isa => 'Str'); | ||
| 11 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 12 | has IAMDatabaseAuthenticationEnabled => (is => 'ro', isa => 'Bool'); | ||
| 13 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 14 | has LicenseModel => (is => 'ro', isa => 'Str'); | ||
| 15 | has MasterUsername => (is => 'ro', isa => 'Str'); | ||
| 16 | has PercentProgress => (is => 'ro', isa => 'Int'); | ||
| 17 | has Port => (is => 'ro', isa => 'Int'); | ||
| 18 | has SnapshotCreateTime => (is => 'ro', isa => 'Str'); | ||
| 19 | has SnapshotType => (is => 'ro', isa => 'Str'); | ||
| 20 | has SourceDBClusterSnapshotArn => (is => 'ro', isa => 'Str'); | ||
| 21 | has Status => (is => 'ro', isa => 'Str'); | ||
| 22 | has StorageEncrypted => (is => 'ro', isa => 'Bool'); | ||
| 23 | has VpcId => (is => 'ro', isa => 'Str'); | ||
| 24 | |||
| 25 | 1; | ||
| 26 | |||
| 27 | ### main pod documentation begin ### | ||
| 28 | |||
| 29 | =head1 NAME | ||
| 30 | |||
| 31 | Paws::Neptune::DBClusterSnapshot | ||
| 32 | |||
| 33 | =head1 USAGE | ||
| 34 | |||
| 35 | This class represents one of two things: | ||
| 36 | |||
| 37 | =head3 Arguments in a call to a service | ||
| 38 | |||
| 39 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 40 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 41 | |||
| 42 | As an example, if Att1 is expected to be a Paws::Neptune::DBClusterSnapshot object: | ||
| 43 | |||
| 44 | $service_obj->Method(Att1 => { AllocatedStorage => $value, ..., VpcId => $value }); | ||
| 45 | |||
| 46 | =head3 Results returned from an API call | ||
| 47 | |||
| 48 | Use accessors for each attribute. If Att1 is expected to be an Paws::Neptune::DBClusterSnapshot object: | ||
| 49 | |||
| 50 | $result = $service_obj->Method(...); | ||
| 51 | $result->Att1->AllocatedStorage | ||
| 52 | |||
| 53 | =head1 DESCRIPTION | ||
| 54 | |||
| 55 | Contains the details for an Amazon Neptune DB cluster snapshot | ||
| 56 | |||
| 57 | This data type is used as a response element in the | ||
| 58 | DescribeDBClusterSnapshots action. | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 AllocatedStorage => Int | ||
| 64 | |||
| 65 | Specifies the allocated storage size in gibibytes (GiB). | ||
| 66 | |||
| 67 | |||
| 68 | =head2 AvailabilityZones => ArrayRef[Str|Undef] | ||
| 69 | |||
| 70 | Provides the list of EC2 Availability Zones that instances in the DB | ||
| 71 | cluster snapshot can be restored in. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 ClusterCreateTime => Str | ||
| 75 | |||
| 76 | Specifies the time when the DB cluster was created, in Universal | ||
| 77 | Coordinated Time (UTC). | ||
| 78 | |||
| 79 | |||
| 80 | =head2 DBClusterIdentifier => Str | ||
| 81 | |||
| 82 | Specifies the DB cluster identifier of the DB cluster that this DB | ||
| 83 | cluster snapshot was created from. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 DBClusterSnapshotArn => Str | ||
| 87 | |||
| 88 | The Amazon Resource Name (ARN) for the DB cluster snapshot. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 DBClusterSnapshotIdentifier => Str | ||
| 92 | |||
| 93 | Specifies the identifier for a DB cluster snapshot. Must match the | ||
| 94 | identifier of an existing snapshot. | ||
| 95 | |||
| 96 | After you restore a DB cluster using a C<DBClusterSnapshotIdentifier>, | ||
| 97 | you must specify the same C<DBClusterSnapshotIdentifier> for any future | ||
| 98 | updates to the DB cluster. When you specify this property for an | ||
| 99 | update, the DB cluster is not restored from the snapshot again, and the | ||
| 100 | data in the database is not changed. | ||
| 101 | |||
| 102 | However, if you don't specify the C<DBClusterSnapshotIdentifier>, an | ||
| 103 | empty DB cluster is created, and the original DB cluster is deleted. If | ||
| 104 | you specify a property that is different from the previous snapshot | ||
| 105 | restore property, the DB cluster is restored from the snapshot | ||
| 106 | specified by the C<DBClusterSnapshotIdentifier>, and the original DB | ||
| 107 | cluster is deleted. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 Engine => Str | ||
| 111 | |||
| 112 | Specifies the name of the database engine. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 EngineVersion => Str | ||
| 116 | |||
| 117 | Provides the version of the database engine for this DB cluster | ||
| 118 | snapshot. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 IAMDatabaseAuthenticationEnabled => Bool | ||
| 122 | |||
| 123 | True if mapping of Amazon Identity and Access Management (IAM) accounts | ||
| 124 | to database accounts is enabled, and otherwise false. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 KmsKeyId => Str | ||
| 128 | |||
| 129 | If C<StorageEncrypted> is true, the Amazon KMS key identifier for the | ||
| 130 | encrypted DB cluster snapshot. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 LicenseModel => Str | ||
| 134 | |||
| 135 | Provides the license model information for this DB cluster snapshot. | ||
| 136 | |||
| 137 | |||
| 138 | =head2 MasterUsername => Str | ||
| 139 | |||
| 140 | Not supported by Neptune. | ||
| 141 | |||
| 142 | |||
| 143 | =head2 PercentProgress => Int | ||
| 144 | |||
| 145 | Specifies the percentage of the estimated data that has been | ||
| 146 | transferred. | ||
| 147 | |||
| 148 | |||
| 149 | =head2 Port => Int | ||
| 150 | |||
| 151 | Specifies the port that the DB cluster was listening on at the time of | ||
| 152 | the snapshot. | ||
| 153 | |||
| 154 | |||
| 155 | =head2 SnapshotCreateTime => Str | ||
| 156 | |||
| 157 | Provides the time when the snapshot was taken, in Universal Coordinated | ||
| 158 | Time (UTC). | ||
| 159 | |||
| 160 | |||
| 161 | =head2 SnapshotType => Str | ||
| 162 | |||
| 163 | Provides the type of the DB cluster snapshot. | ||
| 164 | |||
| 165 | |||
| 166 | =head2 SourceDBClusterSnapshotArn => Str | ||
| 167 | |||
| 168 | If the DB cluster snapshot was copied from a source DB cluster | ||
| 169 | snapshot, the Amazon Resource Name (ARN) for the source DB cluster | ||
| 170 | snapshot, otherwise, a null value. | ||
| 171 | |||
| 172 | |||
| 173 | =head2 Status => Str | ||
| 174 | |||
| 175 | Specifies the status of this DB cluster snapshot. | ||
| 176 | |||
| 177 | |||
| 178 | =head2 StorageEncrypted => Bool | ||
| 179 | |||
| 180 | Specifies whether the DB cluster snapshot is encrypted. | ||
| 181 | |||
| 182 | |||
| 183 | =head2 VpcId => Str | ||
| 184 | |||
| 185 | Provides the VPC ID associated with the DB cluster snapshot. | ||
| 186 | |||
| 187 | |||
| 188 | |||
| 189 | =head1 SEE ALSO | ||
| 190 | |||
| 191 | This class forms part of L<Paws>, describing an object used in L<Paws::Neptune> | ||
| 192 | |||
| 193 | =head1 BUGS and CONTRIBUTIONS | ||
| 194 | |||
| 195 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 196 | |||
| 197 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 198 | |||
| 199 | =cut | ||
| 200 |