« blib/lib/Paws/RDS/DBClusterSnapshotMessage.pm
↑ Summary
blib/lib/Paws/RDS/DBInstanceAutomatedBackupMessage.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::RDS::DBInstanceAutomatedBackup; | ||
| 3 | use Moose; | ||
| 4 | has AllocatedStorage => (is => 'ro', isa => 'Int'); | ||
| 5 | has AvailabilityZone => (is => 'ro', isa => 'Str'); | ||
| 6 | has BackupRetentionPeriod => (is => 'ro', isa => 'Int'); | ||
| 7 | has DBInstanceArn => (is => 'ro', isa => 'Str'); | ||
| 8 | has DBInstanceAutomatedBackupsArn => (is => 'ro', isa => 'Str'); | ||
| 9 | has DBInstanceAutomatedBackupsReplications => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DBInstanceAutomatedBackupsReplication]', request_name => 'DBInstanceAutomatedBackupsReplication', traits => ['NameInRequest']); | ||
| 10 | has DBInstanceIdentifier => (is => 'ro', isa => 'Str'); | ||
| 11 | has DbiResourceId => (is => 'ro', isa => 'Str'); | ||
| 12 | has Encrypted => (is => 'ro', isa => 'Bool'); | ||
| 13 | has Engine => (is => 'ro', isa => 'Str'); | ||
| 14 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 15 | has IAMDatabaseAuthenticationEnabled => (is => 'ro', isa => 'Bool'); | ||
| 16 | has InstanceCreateTime => (is => 'ro', isa => 'Str'); | ||
| 17 | has Iops => (is => 'ro', isa => 'Int'); | ||
| 18 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 19 | has LicenseModel => (is => 'ro', isa => 'Str'); | ||
| 20 | has MasterUsername => (is => 'ro', isa => 'Str'); | ||
| 21 | has OptionGroupName => (is => 'ro', isa => 'Str'); | ||
| 22 | has Port => (is => 'ro', isa => 'Int'); | ||
| 23 | has Region => (is => 'ro', isa => 'Str'); | ||
| 24 | has RestoreWindow => (is => 'ro', isa => 'Paws::RDS::RestoreWindow'); | ||
| 25 | has Status => (is => 'ro', isa => 'Str'); | ||
| 26 | has StorageType => (is => 'ro', isa => 'Str'); | ||
| 27 | has TdeCredentialArn => (is => 'ro', isa => 'Str'); | ||
| 28 | has Timezone => (is => 'ro', isa => 'Str'); | ||
| 29 | has VpcId => (is => 'ro', isa => 'Str'); | ||
| 30 | |||
| 31 | 1; | ||
| 32 | |||
| 33 | ### main pod documentation begin ### | ||
| 34 | |||
| 35 | =head1 NAME | ||
| 36 | |||
| 37 | Paws::RDS::DBInstanceAutomatedBackup | ||
| 38 | |||
| 39 | =head1 USAGE | ||
| 40 | |||
| 41 | This class represents one of two things: | ||
| 42 | |||
| 43 | =head3 Arguments in a call to a service | ||
| 44 | |||
| 45 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 46 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 47 | |||
| 48 | As an example, if Att1 is expected to be a Paws::RDS::DBInstanceAutomatedBackup object: | ||
| 49 | |||
| 50 | $service_obj->Method(Att1 => { AllocatedStorage => $value, ..., VpcId => $value }); | ||
| 51 | |||
| 52 | =head3 Results returned from an API call | ||
| 53 | |||
| 54 | Use accessors for each attribute. If Att1 is expected to be an Paws::RDS::DBInstanceAutomatedBackup object: | ||
| 55 | |||
| 56 | $result = $service_obj->Method(...); | ||
| 57 | $result->Att1->AllocatedStorage | ||
| 58 | |||
| 59 | =head1 DESCRIPTION | ||
| 60 | |||
| 61 | An automated backup of a DB instance. It consists of system backups, | ||
| 62 | transaction logs, and the database instance properties that existed at | ||
| 63 | the time you deleted the source instance. | ||
| 64 | |||
| 65 | =head1 ATTRIBUTES | ||
| 66 | |||
| 67 | |||
| 68 | =head2 AllocatedStorage => Int | ||
| 69 | |||
| 70 | Specifies the allocated storage size in gibibytes (GiB). | ||
| 71 | |||
| 72 | |||
| 73 | =head2 AvailabilityZone => Str | ||
| 74 | |||
| 75 | The Availability Zone that the automated backup was created in. For | ||
| 76 | information on Amazon Web Services Regions and Availability Zones, see | ||
| 77 | Regions and Availability Zones | ||
| 78 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). | ||
| 79 | |||
| 80 | |||
| 81 | =head2 BackupRetentionPeriod => Int | ||
| 82 | |||
| 83 | The retention period for the automated backups. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 DBInstanceArn => Str | ||
| 87 | |||
| 88 | The Amazon Resource Name (ARN) for the automated backups. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 DBInstanceAutomatedBackupsArn => Str | ||
| 92 | |||
| 93 | The Amazon Resource Name (ARN) for the replicated automated backups. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 DBInstanceAutomatedBackupsReplications => ArrayRef[L<Paws::RDS::DBInstanceAutomatedBackupsReplication>] | ||
| 97 | |||
| 98 | The list of replications to different Amazon Web Services Regions | ||
| 99 | associated with the automated backup. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 DBInstanceIdentifier => Str | ||
| 103 | |||
| 104 | The customer id of the instance that is/was associated with the | ||
| 105 | automated backup. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 DbiResourceId => Str | ||
| 109 | |||
| 110 | The identifier for the source DB instance, which can't be changed and | ||
| 111 | which is unique to an Amazon Web Services Region. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 Encrypted => Bool | ||
| 115 | |||
| 116 | Specifies whether the automated backup is encrypted. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 Engine => Str | ||
| 120 | |||
| 121 | The name of the database engine for this automated backup. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 EngineVersion => Str | ||
| 125 | |||
| 126 | The version of the database engine for the automated backup. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 IAMDatabaseAuthenticationEnabled => Bool | ||
| 130 | |||
| 131 | True if mapping of Amazon Web Services Identity and Access Management | ||
| 132 | (IAM) accounts to database accounts is enabled, and otherwise false. | ||
| 133 | |||
| 134 | |||
| 135 | =head2 InstanceCreateTime => Str | ||
| 136 | |||
| 137 | Provides the date and time that the DB instance was created. | ||
| 138 | |||
| 139 | |||
| 140 | =head2 Iops => Int | ||
| 141 | |||
| 142 | The IOPS (I/O operations per second) value for the automated backup. | ||
| 143 | |||
| 144 | |||
| 145 | =head2 KmsKeyId => Str | ||
| 146 | |||
| 147 | The Amazon Web Services KMS key ID for an automated backup. | ||
| 148 | |||
| 149 | The Amazon Web Services KMS key identifier is the key ARN, key ID, | ||
| 150 | alias ARN, or alias name for the Amazon Web Services KMS customer | ||
| 151 | master key (CMK). | ||
| 152 | |||
| 153 | |||
| 154 | =head2 LicenseModel => Str | ||
| 155 | |||
| 156 | License model information for the automated backup. | ||
| 157 | |||
| 158 | |||
| 159 | =head2 MasterUsername => Str | ||
| 160 | |||
| 161 | The license model of an automated backup. | ||
| 162 | |||
| 163 | |||
| 164 | =head2 OptionGroupName => Str | ||
| 165 | |||
| 166 | The option group the automated backup is associated with. If omitted, | ||
| 167 | the default option group for the engine specified is used. | ||
| 168 | |||
| 169 | |||
| 170 | =head2 Port => Int | ||
| 171 | |||
| 172 | The port number that the automated backup used for connections. | ||
| 173 | |||
| 174 | Default: Inherits from the source DB instance | ||
| 175 | |||
| 176 | Valid Values: C<1150-65535> | ||
| 177 | |||
| 178 | |||
| 179 | =head2 Region => Str | ||
| 180 | |||
| 181 | The Amazon Web Services Region associated with the automated backup. | ||
| 182 | |||
| 183 | |||
| 184 | =head2 RestoreWindow => L<Paws::RDS::RestoreWindow> | ||
| 185 | |||
| 186 | Earliest and latest time an instance can be restored to. | ||
| 187 | |||
| 188 | |||
| 189 | =head2 Status => Str | ||
| 190 | |||
| 191 | Provides a list of status information for an automated backup: | ||
| 192 | |||
| 193 | =over | ||
| 194 | |||
| 195 | =item * | ||
| 196 | |||
| 197 | C<active> - automated backups for current instances | ||
| 198 | |||
| 199 | =item * | ||
| 200 | |||
| 201 | C<retained> - automated backups for deleted instances | ||
| 202 | |||
| 203 | =item * | ||
| 204 | |||
| 205 | C<creating> - automated backups that are waiting for the first | ||
| 206 | automated snapshot to be available. | ||
| 207 | |||
| 208 | =back | ||
| 209 | |||
| 210 | |||
| 211 | |||
| 212 | =head2 StorageType => Str | ||
| 213 | |||
| 214 | Specifies the storage type associated with the automated backup. | ||
| 215 | |||
| 216 | |||
| 217 | =head2 TdeCredentialArn => Str | ||
| 218 | |||
| 219 | The ARN from the key store with which the automated backup is | ||
| 220 | associated for TDE encryption. | ||
| 221 | |||
| 222 | |||
| 223 | =head2 Timezone => Str | ||
| 224 | |||
| 225 | The time zone of the automated backup. In most cases, the C<Timezone> | ||
| 226 | element is empty. C<Timezone> content appears only for Microsoft SQL | ||
| 227 | Server DB instances that were created with a time zone specified. | ||
| 228 | |||
| 229 | |||
| 230 | =head2 VpcId => Str | ||
| 231 | |||
| 232 | Provides the VPC ID associated with the DB instance | ||
| 233 | |||
| 234 | |||
| 235 | |||
| 236 | =head1 SEE ALSO | ||
| 237 | |||
| 238 | This class forms part of L<Paws>, describing an object used in L<Paws::RDS> | ||
| 239 | |||
| 240 | =head1 BUGS and CONTRIBUTIONS | ||
| 241 | |||
| 242 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 243 | |||
| 244 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 245 | |||
| 246 | =cut | ||
| 247 |