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