| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::RDS::DBSnapshot; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has AllocatedStorage => (is => 'ro', isa => 'Int'); | |
| 5 | 1 | has AvailabilityZone => (is => 'ro', isa => 'Str'); | |
| 6 | 1 | has DBInstanceIdentifier => (is => 'ro', isa => 'Str'); | |
| 7 | 1 | has DbiResourceId => (is => 'ro', isa => 'Str'); | |
| 8 | 1 | has DBSnapshotArn => (is => 'ro', isa => 'Str'); | |
| 9 | 1 | has DBSnapshotIdentifier => (is => 'ro', isa => 'Str'); | |
| 10 | 1 | has Encrypted => (is => 'ro', isa => 'Bool'); | |
| 11 | 1 | has Engine => (is => 'ro', isa => 'Str'); | |
| 12 | 1 | has EngineVersion => (is => 'ro', isa => 'Str'); | |
| 13 | 1 | has IAMDatabaseAuthenticationEnabled => (is => 'ro', isa => 'Bool'); | |
| 14 | 1 | has InstanceCreateTime => (is => 'ro', isa => 'Str'); | |
| 15 | 1 | has Iops => (is => 'ro', isa => 'Int'); | |
| 16 | 1 | has KmsKeyId => (is => 'ro', isa => 'Str'); | |
| 17 | 1 | has LicenseModel => (is => 'ro', isa => 'Str'); | |
| 18 | 1 | has MasterUsername => (is => 'ro', isa => 'Str'); | |
| 19 | 1 | has OptionGroupName => (is => 'ro', isa => 'Str'); | |
| 20 | 1 | has PercentProgress => (is => 'ro', isa => 'Int'); | |
| 21 | 1 | has Port => (is => 'ro', isa => 'Int'); | |
| 22 | 1 | has ProcessorFeatures => (is => 'ro', isa => 'ArrayRef[Paws::RDS::ProcessorFeature]', request_name => 'ProcessorFeature', traits => ['NameInRequest']); | |
| 23 | 1 | has SnapshotCreateTime => (is => 'ro', isa => 'Str'); | |
| 24 | 1 | has SnapshotType => (is => 'ro', isa => 'Str'); | |
| 25 | 1 | has SourceDBSnapshotIdentifier => (is => 'ro', isa => 'Str'); | |
| 26 | 1 | has SourceRegion => (is => 'ro', isa => 'Str'); | |
| 27 | 1 | has Status => (is => 'ro', isa => 'Str'); | |
| 28 | 1 | has StorageType => (is => 'ro', isa => 'Str'); | |
| 29 | 1 | has TagList => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]', request_name => 'Tag', traits => ['NameInRequest']); | |
| 30 | 1 | has TdeCredentialArn => (is => 'ro', isa => 'Str'); | |
| 31 | 1 | has Timezone => (is => 'ro', isa => 'Str'); | |
| 32 | 1 | has VpcId => (is => 'ro', isa => 'Str'); | |
| 33 | |||
| 34 | 1 | 1; | |
| 35 | |||
| 36 | ### main pod documentation begin ### | ||
| 37 | |||
| 38 | =head1 NAME | ||
| 39 | |||
| 40 | Paws::RDS::DBSnapshot | ||
| 41 | |||
| 42 | =head1 USAGE | ||
| 43 | |||
| 44 | This class represents one of two things: | ||
| 45 | |||
| 46 | =head3 Arguments in a call to a service | ||
| 47 | |||
| 48 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 49 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 50 | |||
| 51 | As an example, if Att1 is expected to be a Paws::RDS::DBSnapshot object: | ||
| 52 | |||
| 53 | $service_obj->Method(Att1 => { AllocatedStorage => $value, ..., VpcId => $value }); | ||
| 54 | |||
| 55 | =head3 Results returned from an API call | ||
| 56 | |||
| 57 | Use accessors for each attribute. If Att1 is expected to be an Paws::RDS::DBSnapshot object: | ||
| 58 | |||
| 59 | $result = $service_obj->Method(...); | ||
| 60 | $result->Att1->AllocatedStorage | ||
| 61 | |||
| 62 | =head1 DESCRIPTION | ||
| 63 | |||
| 64 | Contains the details of an Amazon RDS DB snapshot. | ||
| 65 | |||
| 66 | This data type is used as a response element in the | ||
| 67 | C<DescribeDBSnapshots> action. | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 AllocatedStorage => Int | ||
| 73 | |||
| 74 | Specifies the allocated storage size in gibibytes (GiB). | ||
| 75 | |||
| 76 | |||
| 77 | =head2 AvailabilityZone => Str | ||
| 78 | |||
| 79 | Specifies the name of the Availability Zone the DB instance was located | ||
| 80 | in at the time of the DB snapshot. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 DBInstanceIdentifier => Str | ||
| 84 | |||
| 85 | Specifies the DB instance identifier of the DB instance this DB | ||
| 86 | snapshot was created from. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 DbiResourceId => Str | ||
| 90 | |||
| 91 | The identifier for the source DB instance, which can't be changed and | ||
| 92 | which is unique to an Amazon Web Services Region. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 DBSnapshotArn => Str | ||
| 96 | |||
| 97 | The Amazon Resource Name (ARN) for the DB snapshot. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 DBSnapshotIdentifier => Str | ||
| 101 | |||
| 102 | Specifies the identifier for the DB snapshot. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 Encrypted => Bool | ||
| 106 | |||
| 107 | Specifies whether the DB snapshot is encrypted. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 Engine => Str | ||
| 111 | |||
| 112 | Specifies the name of the database engine. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 EngineVersion => Str | ||
| 116 | |||
| 117 | Specifies the version of the database engine. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 IAMDatabaseAuthenticationEnabled => Bool | ||
| 121 | |||
| 122 | True if mapping of Amazon Web Services Identity and Access Management | ||
| 123 | (IAM) accounts to database accounts is enabled, and otherwise false. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 InstanceCreateTime => Str | ||
| 127 | |||
| 128 | Specifies the time in Coordinated Universal Time (UTC) when the DB | ||
| 129 | instance, from which the snapshot was taken, was created. | ||
| 130 | |||
| 131 | |||
| 132 | =head2 Iops => Int | ||
| 133 | |||
| 134 | Specifies the Provisioned IOPS (I/O operations per second) value of the | ||
| 135 | DB instance at the time of the snapshot. | ||
| 136 | |||
| 137 | |||
| 138 | =head2 KmsKeyId => Str | ||
| 139 | |||
| 140 | If C<Encrypted> is true, the Amazon Web Services KMS key identifier for | ||
| 141 | the encrypted DB snapshot. | ||
| 142 | |||
| 143 | The Amazon Web Services KMS key identifier is the key ARN, key ID, | ||
| 144 | alias ARN, or alias name for the Amazon Web Services KMS customer | ||
| 145 | master key (CMK). | ||
| 146 | |||
| 147 | |||
| 148 | =head2 LicenseModel => Str | ||
| 149 | |||
| 150 | License model information for the restored DB instance. | ||
| 151 | |||
| 152 | |||
| 153 | =head2 MasterUsername => Str | ||
| 154 | |||
| 155 | Provides the master username for the DB snapshot. | ||
| 156 | |||
| 157 | |||
| 158 | =head2 OptionGroupName => Str | ||
| 159 | |||
| 160 | Provides the option group name for the DB snapshot. | ||
| 161 | |||
| 162 | |||
| 163 | =head2 PercentProgress => Int | ||
| 164 | |||
| 165 | The percentage of the estimated data that has been transferred. | ||
| 166 | |||
| 167 | |||
| 168 | =head2 Port => Int | ||
| 169 | |||
| 170 | Specifies the port that the database engine was listening on at the | ||
| 171 | time of the snapshot. | ||
| 172 | |||
| 173 | |||
| 174 | =head2 ProcessorFeatures => ArrayRef[L<Paws::RDS::ProcessorFeature>] | ||
| 175 | |||
| 176 | The number of CPU cores and the number of threads per core for the DB | ||
| 177 | instance class of the DB instance when the DB snapshot was created. | ||
| 178 | |||
| 179 | |||
| 180 | =head2 SnapshotCreateTime => Str | ||
| 181 | |||
| 182 | Specifies when the snapshot was taken in Coordinated Universal Time | ||
| 183 | (UTC). | ||
| 184 | |||
| 185 | |||
| 186 | =head2 SnapshotType => Str | ||
| 187 | |||
| 188 | Provides the type of the DB snapshot. | ||
| 189 | |||
| 190 | |||
| 191 | =head2 SourceDBSnapshotIdentifier => Str | ||
| 192 | |||
| 193 | The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was | ||
| 194 | copied from. It only has value in case of cross-customer or | ||
| 195 | cross-region copy. | ||
| 196 | |||
| 197 | |||
| 198 | =head2 SourceRegion => Str | ||
| 199 | |||
| 200 | The Amazon Web Services Region that the DB snapshot was created in or | ||
| 201 | copied from. | ||
| 202 | |||
| 203 | |||
| 204 | =head2 Status => Str | ||
| 205 | |||
| 206 | Specifies the status of this DB snapshot. | ||
| 207 | |||
| 208 | |||
| 209 | =head2 StorageType => Str | ||
| 210 | |||
| 211 | Specifies the storage type associated with DB snapshot. | ||
| 212 | |||
| 213 | |||
| 214 | =head2 TagList => ArrayRef[L<Paws::RDS::Tag>] | ||
| 215 | |||
| 216 | |||
| 217 | |||
| 218 | |||
| 219 | =head2 TdeCredentialArn => Str | ||
| 220 | |||
| 221 | The ARN from the key store with which to associate the instance for TDE | ||
| 222 | encryption. | ||
| 223 | |||
| 224 | |||
| 225 | =head2 Timezone => Str | ||
| 226 | |||
| 227 | The time zone of the DB snapshot. In most cases, the C<Timezone> | ||
| 228 | element is empty. C<Timezone> content appears only for snapshots taken | ||
| 229 | from Microsoft SQL Server DB instances that were created with a time | ||
| 230 | zone specified. | ||
| 231 | |||
| 232 | |||
| 233 | =head2 VpcId => Str | ||
| 234 | |||
| 235 | Provides the VPC ID associated with the DB snapshot. | ||
| 236 | |||
| 237 | |||
| 238 | |||
| 239 | =head1 SEE ALSO | ||
| 240 | |||
| 241 | This class forms part of L<Paws>, describing an object used in L<Paws::RDS> | ||
| 242 | |||
| 243 | =head1 BUGS and CONTRIBUTIONS | ||
| 244 | |||
| 245 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 246 | |||
| 247 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 248 | |||
| 249 | =cut | ||
| 250 | |||