« blib/lib/Paws/RDS/DBEngineVersionMessage.pm
↑ Summary
blib/lib/Paws/RDS/DBInstanceAutomatedBackupsReplication.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::RDS::DBInstance; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has ActivityStreamEngineNativeAuditFieldsIncluded => (is => 'ro', isa => 'Bool'); | |
| 5 | 1 | has ActivityStreamKinesisStreamName => (is => 'ro', isa => 'Str'); | |
| 6 | 1 | has ActivityStreamKmsKeyId => (is => 'ro', isa => 'Str'); | |
| 7 | 1 | has ActivityStreamMode => (is => 'ro', isa => 'Str'); | |
| 8 | 1 | has ActivityStreamStatus => (is => 'ro', isa => 'Str'); | |
| 9 | 1 | has AllocatedStorage => (is => 'ro', isa => 'Int'); | |
| 10 | 1 | has AssociatedRoles => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DBInstanceRole]', request_name => 'DBInstanceRole', traits => ['NameInRequest']); | |
| 11 | 1 | has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool'); | |
| 12 | 1 | has AvailabilityZone => (is => 'ro', isa => 'Str'); | |
| 13 | 1 | has AwsBackupRecoveryPointArn => (is => 'ro', isa => 'Str'); | |
| 14 | 1 | has BackupRetentionPeriod => (is => 'ro', isa => 'Int'); | |
| 15 | 1 | has CACertificateIdentifier => (is => 'ro', isa => 'Str'); | |
| 16 | 1 | has CharacterSetName => (is => 'ro', isa => 'Str'); | |
| 17 | 1 | has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool'); | |
| 18 | 1 | has CustomerOwnedIpEnabled => (is => 'ro', isa => 'Bool'); | |
| 19 | 1 | has DBClusterIdentifier => (is => 'ro', isa => 'Str'); | |
| 20 | 1 | has DBInstanceArn => (is => 'ro', isa => 'Str'); | |
| 21 | 1 | has DBInstanceAutomatedBackupsReplications => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DBInstanceAutomatedBackupsReplication]', request_name => 'DBInstanceAutomatedBackupsReplication', traits => ['NameInRequest']); | |
| 22 | 1 | has DBInstanceClass => (is => 'ro', isa => 'Str'); | |
| 23 | 1 | has DBInstanceIdentifier => (is => 'ro', isa => 'Str'); | |
| 24 | 1 | has DbInstancePort => (is => 'ro', isa => 'Int'); | |
| 25 | 1 | has DBInstanceStatus => (is => 'ro', isa => 'Str'); | |
| 26 | 1 | has DbiResourceId => (is => 'ro', isa => 'Str'); | |
| 27 | 1 | has DBName => (is => 'ro', isa => 'Str'); | |
| 28 | 1 | has DBParameterGroups => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DBParameterGroupStatus]', request_name => 'DBParameterGroup', traits => ['NameInRequest']); | |
| 29 | 1 | has DBSecurityGroups => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DBSecurityGroupMembership]', request_name => 'DBSecurityGroup', traits => ['NameInRequest']); | |
| 30 | 1 | has DBSubnetGroup => (is => 'ro', isa => 'Paws::RDS::DBSubnetGroup'); | |
| 31 | 1 | has DeletionProtection => (is => 'ro', isa => 'Bool'); | |
| 32 | 1 | has DomainMemberships => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DomainMembership]', request_name => 'DomainMembership', traits => ['NameInRequest']); | |
| 33 | 1 | has EnabledCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | |
| 34 | 1 | has Endpoint => (is => 'ro', isa => 'Paws::RDS::Endpoint'); | |
| 35 | 1 | has Engine => (is => 'ro', isa => 'Str'); | |
| 36 | 1 | has EngineVersion => (is => 'ro', isa => 'Str'); | |
| 37 | 1 | has EnhancedMonitoringResourceArn => (is => 'ro', isa => 'Str'); | |
| 38 | 1 | has IAMDatabaseAuthenticationEnabled => (is => 'ro', isa => 'Bool'); | |
| 39 | 1 | has InstanceCreateTime => (is => 'ro', isa => 'Str'); | |
| 40 | 1 | has Iops => (is => 'ro', isa => 'Int'); | |
| 41 | 1 | has KmsKeyId => (is => 'ro', isa => 'Str'); | |
| 42 | 1 | has LatestRestorableTime => (is => 'ro', isa => 'Str'); | |
| 43 | 1 | has LicenseModel => (is => 'ro', isa => 'Str'); | |
| 44 | 1 | has ListenerEndpoint => (is => 'ro', isa => 'Paws::RDS::Endpoint'); | |
| 45 | 1 | has MasterUsername => (is => 'ro', isa => 'Str'); | |
| 46 | 1 | has MaxAllocatedStorage => (is => 'ro', isa => 'Int'); | |
| 47 | 1 | has MonitoringInterval => (is => 'ro', isa => 'Int'); | |
| 48 | 1 | has MonitoringRoleArn => (is => 'ro', isa => 'Str'); | |
| 49 | 1 | has MultiAZ => (is => 'ro', isa => 'Bool'); | |
| 50 | 1 | has NcharCharacterSetName => (is => 'ro', isa => 'Str'); | |
| 51 | 1 | has OptionGroupMemberships => (is => 'ro', isa => 'ArrayRef[Paws::RDS::OptionGroupMembership]', request_name => 'OptionGroupMembership', traits => ['NameInRequest']); | |
| 52 | 1 | has PendingModifiedValues => (is => 'ro', isa => 'Paws::RDS::PendingModifiedValues'); | |
| 53 | 1 | has PerformanceInsightsEnabled => (is => 'ro', isa => 'Bool'); | |
| 54 | 1 | has PerformanceInsightsKMSKeyId => (is => 'ro', isa => 'Str'); | |
| 55 | 1 | has PerformanceInsightsRetentionPeriod => (is => 'ro', isa => 'Int'); | |
| 56 | 1 | has PreferredBackupWindow => (is => 'ro', isa => 'Str'); | |
| 57 | 1 | has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str'); | |
| 58 | 1 | has ProcessorFeatures => (is => 'ro', isa => 'ArrayRef[Paws::RDS::ProcessorFeature]', request_name => 'ProcessorFeature', traits => ['NameInRequest']); | |
| 59 | 1 | has PromotionTier => (is => 'ro', isa => 'Int'); | |
| 60 | 1 | has PubliclyAccessible => (is => 'ro', isa => 'Bool'); | |
| 61 | 1 | has ReadReplicaDBClusterIdentifiers => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'ReadReplicaDBClusterIdentifier', traits => ['NameInRequest']); | |
| 62 | 1 | has ReadReplicaDBInstanceIdentifiers => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'ReadReplicaDBInstanceIdentifier', traits => ['NameInRequest']); | |
| 63 | 1 | has ReadReplicaSourceDBInstanceIdentifier => (is => 'ro', isa => 'Str'); | |
| 64 | 1 | has ReplicaMode => (is => 'ro', isa => 'Str'); | |
| 65 | 1 | has SecondaryAvailabilityZone => (is => 'ro', isa => 'Str'); | |
| 66 | 1 | has StatusInfos => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DBInstanceStatusInfo]', request_name => 'DBInstanceStatusInfo', traits => ['NameInRequest']); | |
| 67 | 1 | has StorageEncrypted => (is => 'ro', isa => 'Bool'); | |
| 68 | 1 | has StorageType => (is => 'ro', isa => 'Str'); | |
| 69 | 1 | has TagList => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]', request_name => 'Tag', traits => ['NameInRequest']); | |
| 70 | 1 | has TdeCredentialArn => (is => 'ro', isa => 'Str'); | |
| 71 | 1 | has Timezone => (is => 'ro', isa => 'Str'); | |
| 72 | 1 | has VpcSecurityGroups => (is => 'ro', isa => 'ArrayRef[Paws::RDS::VpcSecurityGroupMembership]', request_name => 'VpcSecurityGroupMembership', traits => ['NameInRequest']); | |
| 73 | |||
| 74 | 1 | 1; | |
| 75 | |||
| 76 | ### main pod documentation begin ### | ||
| 77 | |||
| 78 | =head1 NAME | ||
| 79 | |||
| 80 | Paws::RDS::DBInstance | ||
| 81 | |||
| 82 | =head1 USAGE | ||
| 83 | |||
| 84 | This class represents one of two things: | ||
| 85 | |||
| 86 | =head3 Arguments in a call to a service | ||
| 87 | |||
| 88 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 89 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 90 | |||
| 91 | As an example, if Att1 is expected to be a Paws::RDS::DBInstance object: | ||
| 92 | |||
| 93 | $service_obj->Method(Att1 => { ActivityStreamEngineNativeAuditFieldsIncluded => $value, ..., VpcSecurityGroups => $value }); | ||
| 94 | |||
| 95 | =head3 Results returned from an API call | ||
| 96 | |||
| 97 | Use accessors for each attribute. If Att1 is expected to be an Paws::RDS::DBInstance object: | ||
| 98 | |||
| 99 | $result = $service_obj->Method(...); | ||
| 100 | $result->Att1->ActivityStreamEngineNativeAuditFieldsIncluded | ||
| 101 | |||
| 102 | =head1 DESCRIPTION | ||
| 103 | |||
| 104 | Contains the details of an Amazon RDS DB instance. | ||
| 105 | |||
| 106 | This data type is used as a response element in the | ||
| 107 | C<DescribeDBInstances> action. | ||
| 108 | |||
| 109 | =head1 ATTRIBUTES | ||
| 110 | |||
| 111 | |||
| 112 | =head2 ActivityStreamEngineNativeAuditFieldsIncluded => Bool | ||
| 113 | |||
| 114 | Indicates whether engine-native audit fields are included in the | ||
| 115 | database activity stream. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 ActivityStreamKinesisStreamName => Str | ||
| 119 | |||
| 120 | The name of the Amazon Kinesis data stream used for the database | ||
| 121 | activity stream. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 ActivityStreamKmsKeyId => Str | ||
| 125 | |||
| 126 | The Amazon Web Services KMS key identifier used for encrypting messages | ||
| 127 | in the database activity stream. The Amazon Web Services KMS key | ||
| 128 | identifier is the key ARN, key ID, alias ARN, or alias name for the | ||
| 129 | Amazon Web Services KMS customer master key (CMK). | ||
| 130 | |||
| 131 | |||
| 132 | =head2 ActivityStreamMode => Str | ||
| 133 | |||
| 134 | The mode of the database activity stream. Database events such as a | ||
| 135 | change or access generate an activity stream event. RDS for Oracle | ||
| 136 | always handles these events asynchronously. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 ActivityStreamStatus => Str | ||
| 140 | |||
| 141 | The status of the database activity stream. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 AllocatedStorage => Int | ||
| 145 | |||
| 146 | Specifies the allocated storage size specified in gibibytes. | ||
| 147 | |||
| 148 | |||
| 149 | =head2 AssociatedRoles => ArrayRef[L<Paws::RDS::DBInstanceRole>] | ||
| 150 | |||
| 151 | The Amazon Web Services Identity and Access Management (IAM) roles | ||
| 152 | associated with the DB instance. | ||
| 153 | |||
| 154 | |||
| 155 | =head2 AutoMinorVersionUpgrade => Bool | ||
| 156 | |||
| 157 | A value that indicates that minor version patches are applied | ||
| 158 | automatically. | ||
| 159 | |||
| 160 | |||
| 161 | =head2 AvailabilityZone => Str | ||
| 162 | |||
| 163 | Specifies the name of the Availability Zone the DB instance is located | ||
| 164 | in. | ||
| 165 | |||
| 166 | |||
| 167 | =head2 AwsBackupRecoveryPointArn => Str | ||
| 168 | |||
| 169 | The Amazon Resource Name (ARN) of the recovery point in Amazon Web | ||
| 170 | Services Backup. | ||
| 171 | |||
| 172 | |||
| 173 | =head2 BackupRetentionPeriod => Int | ||
| 174 | |||
| 175 | Specifies the number of days for which automatic DB snapshots are | ||
| 176 | retained. | ||
| 177 | |||
| 178 | |||
| 179 | =head2 CACertificateIdentifier => Str | ||
| 180 | |||
| 181 | The identifier of the CA certificate for this DB instance. | ||
| 182 | |||
| 183 | |||
| 184 | =head2 CharacterSetName => Str | ||
| 185 | |||
| 186 | If present, specifies the name of the character set that this instance | ||
| 187 | is associated with. | ||
| 188 | |||
| 189 | |||
| 190 | =head2 CopyTagsToSnapshot => Bool | ||
| 191 | |||
| 192 | Specifies whether tags are copied from the DB instance to snapshots of | ||
| 193 | the DB instance. | ||
| 194 | |||
| 195 | B<Amazon Aurora> | ||
| 196 | |||
| 197 | Not applicable. Copying tags to snapshots is managed by the DB cluster. | ||
| 198 | Setting this value for an Aurora DB instance has no effect on the DB | ||
| 199 | cluster setting. For more information, see C<DBCluster>. | ||
| 200 | |||
| 201 | |||
| 202 | =head2 CustomerOwnedIpEnabled => Bool | ||
| 203 | |||
| 204 | Specifies whether a customer-owned IP address (CoIP) is enabled for an | ||
| 205 | RDS on Outposts DB instance. | ||
| 206 | |||
| 207 | A I<CoIP >provides local or external connectivity to resources in your | ||
| 208 | Outpost subnets through your on-premises network. For some use cases, a | ||
| 209 | CoIP can provide lower latency for connections to the DB instance from | ||
| 210 | outside of its virtual private cloud (VPC) on your local network. | ||
| 211 | |||
| 212 | For more information about RDS on Outposts, see Working with Amazon RDS | ||
| 213 | on Amazon Web Services Outposts | ||
| 214 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) | ||
| 215 | in the I<Amazon RDS User Guide>. | ||
| 216 | |||
| 217 | For more information about CoIPs, see Customer-owned IP addresses | ||
| 218 | (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing) | ||
| 219 | in the I<Amazon Web Services Outposts User Guide>. | ||
| 220 | |||
| 221 | |||
| 222 | =head2 DBClusterIdentifier => Str | ||
| 223 | |||
| 224 | If the DB instance is a member of a DB cluster, contains the name of | ||
| 225 | the DB cluster that the DB instance is a member of. | ||
| 226 | |||
| 227 | |||
| 228 | =head2 DBInstanceArn => Str | ||
| 229 | |||
| 230 | The Amazon Resource Name (ARN) for the DB instance. | ||
| 231 | |||
| 232 | |||
| 233 | =head2 DBInstanceAutomatedBackupsReplications => ArrayRef[L<Paws::RDS::DBInstanceAutomatedBackupsReplication>] | ||
| 234 | |||
| 235 | The list of replicated automated backups associated with the DB | ||
| 236 | instance. | ||
| 237 | |||
| 238 | |||
| 239 | =head2 DBInstanceClass => Str | ||
| 240 | |||
| 241 | Contains the name of the compute and memory capacity class of the DB | ||
| 242 | instance. | ||
| 243 | |||
| 244 | |||
| 245 | =head2 DBInstanceIdentifier => Str | ||
| 246 | |||
| 247 | Contains a user-supplied database identifier. This identifier is the | ||
| 248 | unique key that identifies a DB instance. | ||
| 249 | |||
| 250 | |||
| 251 | =head2 DbInstancePort => Int | ||
| 252 | |||
| 253 | Specifies the port that the DB instance listens on. If the DB instance | ||
| 254 | is part of a DB cluster, this can be a different port than the DB | ||
| 255 | cluster port. | ||
| 256 | |||
| 257 | |||
| 258 | =head2 DBInstanceStatus => Str | ||
| 259 | |||
| 260 | Specifies the current state of this database. | ||
| 261 | |||
| 262 | For information about DB instance statuses, see Viewing DB instance | ||
| 263 | status | ||
| 264 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status) | ||
| 265 | in the I<Amazon RDS User Guide.> | ||
| 266 | |||
| 267 | |||
| 268 | =head2 DbiResourceId => Str | ||
| 269 | |||
| 270 | The Amazon Web Services Region-unique, immutable identifier for the DB | ||
| 271 | instance. This identifier is found in Amazon Web Services CloudTrail | ||
| 272 | log entries whenever the Amazon Web Services KMS customer master key | ||
| 273 | (CMK) for the DB instance is accessed. | ||
| 274 | |||
| 275 | |||
| 276 | =head2 DBName => Str | ||
| 277 | |||
| 278 | The meaning of this parameter differs according to the database engine | ||
| 279 | you use. | ||
| 280 | |||
| 281 | B<MySQL, MariaDB, SQL Server, PostgreSQL> | ||
| 282 | |||
| 283 | Contains the name of the initial database of this instance that was | ||
| 284 | provided at create time, if one was specified when the DB instance was | ||
| 285 | created. This same name is returned for the life of the DB instance. | ||
| 286 | |||
| 287 | Type: String | ||
| 288 | |||
| 289 | B<Oracle> | ||
| 290 | |||
| 291 | Contains the Oracle System ID (SID) of the created DB instance. Not | ||
| 292 | shown when the returned parameters do not apply to an Oracle DB | ||
| 293 | instance. | ||
| 294 | |||
| 295 | |||
| 296 | =head2 DBParameterGroups => ArrayRef[L<Paws::RDS::DBParameterGroupStatus>] | ||
| 297 | |||
| 298 | Provides the list of DB parameter groups applied to this DB instance. | ||
| 299 | |||
| 300 | |||
| 301 | =head2 DBSecurityGroups => ArrayRef[L<Paws::RDS::DBSecurityGroupMembership>] | ||
| 302 | |||
| 303 | A list of DB security group elements containing C<DBSecurityGroup.Name> | ||
| 304 | and C<DBSecurityGroup.Status> subelements. | ||
| 305 | |||
| 306 | |||
| 307 | =head2 DBSubnetGroup => L<Paws::RDS::DBSubnetGroup> | ||
| 308 | |||
| 309 | Specifies information on the subnet group associated with the DB | ||
| 310 | instance, including the name, description, and subnets in the subnet | ||
| 311 | group. | ||
| 312 | |||
| 313 | |||
| 314 | =head2 DeletionProtection => Bool | ||
| 315 | |||
| 316 | Indicates if the DB instance has deletion protection enabled. The | ||
| 317 | database can't be deleted when deletion protection is enabled. For more | ||
| 318 | information, see Deleting a DB Instance | ||
| 319 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). | ||
| 320 | |||
| 321 | |||
| 322 | =head2 DomainMemberships => ArrayRef[L<Paws::RDS::DomainMembership>] | ||
| 323 | |||
| 324 | The Active Directory Domain membership records associated with the DB | ||
| 325 | instance. | ||
| 326 | |||
| 327 | |||
| 328 | =head2 EnabledCloudwatchLogsExports => ArrayRef[Str|Undef] | ||
| 329 | |||
| 330 | A list of log types that this DB instance is configured to export to | ||
| 331 | CloudWatch Logs. | ||
| 332 | |||
| 333 | Log types vary by DB engine. For information about the log types for | ||
| 334 | each DB engine, see Amazon RDS Database Log Files | ||
| 335 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html) | ||
| 336 | in the I<Amazon RDS User Guide.> | ||
| 337 | |||
| 338 | |||
| 339 | =head2 Endpoint => L<Paws::RDS::Endpoint> | ||
| 340 | |||
| 341 | Specifies the connection endpoint. | ||
| 342 | |||
| 343 | |||
| 344 | =head2 Engine => Str | ||
| 345 | |||
| 346 | The name of the database engine to be used for this DB instance. | ||
| 347 | |||
| 348 | |||
| 349 | =head2 EngineVersion => Str | ||
| 350 | |||
| 351 | Indicates the database engine version. | ||
| 352 | |||
| 353 | |||
| 354 | =head2 EnhancedMonitoringResourceArn => Str | ||
| 355 | |||
| 356 | The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream | ||
| 357 | that receives the Enhanced Monitoring metrics data for the DB instance. | ||
| 358 | |||
| 359 | |||
| 360 | =head2 IAMDatabaseAuthenticationEnabled => Bool | ||
| 361 | |||
| 362 | True if mapping of Amazon Web Services Identity and Access Management | ||
| 363 | (IAM) accounts to database accounts is enabled, and otherwise false. | ||
| 364 | |||
| 365 | IAM database authentication can be enabled for the following database | ||
| 366 | engines | ||
| 367 | |||
| 368 | =over | ||
| 369 | |||
| 370 | =item * | ||
| 371 | |||
| 372 | For MySQL 5.6, minor version 5.6.34 or higher | ||
| 373 | |||
| 374 | =item * | ||
| 375 | |||
| 376 | For MySQL 5.7, minor version 5.7.16 or higher | ||
| 377 | |||
| 378 | =item * | ||
| 379 | |||
| 380 | Aurora 5.6 or higher. To enable IAM database authentication for Aurora, | ||
| 381 | see DBCluster Type. | ||
| 382 | |||
| 383 | =back | ||
| 384 | |||
| 385 | |||
| 386 | |||
| 387 | =head2 InstanceCreateTime => Str | ||
| 388 | |||
| 389 | Provides the date and time the DB instance was created. | ||
| 390 | |||
| 391 | |||
| 392 | =head2 Iops => Int | ||
| 393 | |||
| 394 | Specifies the Provisioned IOPS (I/O operations per second) value. | ||
| 395 | |||
| 396 | |||
| 397 | =head2 KmsKeyId => Str | ||
| 398 | |||
| 399 | If C<StorageEncrypted> is true, the Amazon Web Services KMS key | ||
| 400 | identifier for the encrypted DB instance. | ||
| 401 | |||
| 402 | The Amazon Web Services KMS key identifier is the key ARN, key ID, | ||
| 403 | alias ARN, or alias name for the Amazon Web Services KMS customer | ||
| 404 | master key (CMK). | ||
| 405 | |||
| 406 | |||
| 407 | =head2 LatestRestorableTime => Str | ||
| 408 | |||
| 409 | Specifies the latest time to which a database can be restored with | ||
| 410 | point-in-time restore. | ||
| 411 | |||
| 412 | |||
| 413 | =head2 LicenseModel => Str | ||
| 414 | |||
| 415 | License model information for this DB instance. | ||
| 416 | |||
| 417 | |||
| 418 | =head2 ListenerEndpoint => L<Paws::RDS::Endpoint> | ||
| 419 | |||
| 420 | Specifies the listener connection endpoint for SQL Server Always On. | ||
| 421 | |||
| 422 | |||
| 423 | =head2 MasterUsername => Str | ||
| 424 | |||
| 425 | Contains the master username for the DB instance. | ||
| 426 | |||
| 427 | |||
| 428 | =head2 MaxAllocatedStorage => Int | ||
| 429 | |||
| 430 | The upper limit to which Amazon RDS can automatically scale the storage | ||
| 431 | of the DB instance. | ||
| 432 | |||
| 433 | |||
| 434 | =head2 MonitoringInterval => Int | ||
| 435 | |||
| 436 | The interval, in seconds, between points when Enhanced Monitoring | ||
| 437 | metrics are collected for the DB instance. | ||
| 438 | |||
| 439 | |||
| 440 | =head2 MonitoringRoleArn => Str | ||
| 441 | |||
| 442 | The ARN for the IAM role that permits RDS to send Enhanced Monitoring | ||
| 443 | metrics to Amazon CloudWatch Logs. | ||
| 444 | |||
| 445 | |||
| 446 | =head2 MultiAZ => Bool | ||
| 447 | |||
| 448 | Specifies if the DB instance is a Multi-AZ deployment. | ||
| 449 | |||
| 450 | |||
| 451 | =head2 NcharCharacterSetName => Str | ||
| 452 | |||
| 453 | The name of the NCHAR character set for the Oracle DB instance. This | ||
| 454 | character set specifies the Unicode encoding for data stored in table | ||
| 455 | columns of type NCHAR, NCLOB, or NVARCHAR2. | ||
| 456 | |||
| 457 | |||
| 458 | =head2 OptionGroupMemberships => ArrayRef[L<Paws::RDS::OptionGroupMembership>] | ||
| 459 | |||
| 460 | Provides the list of option group memberships for this DB instance. | ||
| 461 | |||
| 462 | |||
| 463 | =head2 PendingModifiedValues => L<Paws::RDS::PendingModifiedValues> | ||
| 464 | |||
| 465 | A value that specifies that changes to the DB instance are pending. | ||
| 466 | This element is only included when changes are pending. Specific | ||
| 467 | changes are identified by subelements. | ||
| 468 | |||
| 469 | |||
| 470 | =head2 PerformanceInsightsEnabled => Bool | ||
| 471 | |||
| 472 | True if Performance Insights is enabled for the DB instance, and | ||
| 473 | otherwise false. | ||
| 474 | |||
| 475 | |||
| 476 | =head2 PerformanceInsightsKMSKeyId => Str | ||
| 477 | |||
| 478 | The Amazon Web Services KMS key identifier for encryption of | ||
| 479 | Performance Insights data. | ||
| 480 | |||
| 481 | The Amazon Web Services KMS key identifier is the key ARN, key ID, | ||
| 482 | alias ARN, or alias name for the Amazon Web Services KMS customer | ||
| 483 | master key (CMK). | ||
| 484 | |||
| 485 | |||
| 486 | =head2 PerformanceInsightsRetentionPeriod => Int | ||
| 487 | |||
| 488 | The amount of time, in days, to retain Performance Insights data. Valid | ||
| 489 | values are 7 or 731 (2 years). | ||
| 490 | |||
| 491 | |||
| 492 | =head2 PreferredBackupWindow => Str | ||
| 493 | |||
| 494 | Specifies the daily time range during which automated backups are | ||
| 495 | created if automated backups are enabled, as determined by the | ||
| 496 | C<BackupRetentionPeriod>. | ||
| 497 | |||
| 498 | |||
| 499 | =head2 PreferredMaintenanceWindow => Str | ||
| 500 | |||
| 501 | Specifies the weekly time range during which system maintenance can | ||
| 502 | occur, in Universal Coordinated Time (UTC). | ||
| 503 | |||
| 504 | |||
| 505 | =head2 ProcessorFeatures => ArrayRef[L<Paws::RDS::ProcessorFeature>] | ||
| 506 | |||
| 507 | The number of CPU cores and the number of threads per core for the DB | ||
| 508 | instance class of the DB instance. | ||
| 509 | |||
| 510 | |||
| 511 | =head2 PromotionTier => Int | ||
| 512 | |||
| 513 | A value that specifies the order in which an Aurora Replica is promoted | ||
| 514 | to the primary instance after a failure of the existing primary | ||
| 515 | instance. For more information, see Fault Tolerance for an Aurora DB | ||
| 516 | Cluster | ||
| 517 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) | ||
| 518 | in the I<Amazon Aurora User Guide>. | ||
| 519 | |||
| 520 | |||
| 521 | =head2 PubliclyAccessible => Bool | ||
| 522 | |||
| 523 | Specifies the accessibility options for the DB instance. | ||
| 524 | |||
| 525 | When the DB instance is publicly accessible, its DNS endpoint resolves | ||
| 526 | to the private IP address from within the DB instance's VPC, and to the | ||
| 527 | public IP address from outside of the DB instance's VPC. Access to the | ||
| 528 | DB instance is ultimately controlled by the security group it uses, and | ||
| 529 | that public access is not permitted if the security group assigned to | ||
| 530 | the DB instance doesn't permit it. | ||
| 531 | |||
| 532 | When the DB instance isn't publicly accessible, it is an internal DB | ||
| 533 | instance with a DNS name that resolves to a private IP address. | ||
| 534 | |||
| 535 | For more information, see CreateDBInstance. | ||
| 536 | |||
| 537 | |||
| 538 | =head2 ReadReplicaDBClusterIdentifiers => ArrayRef[Str|Undef] | ||
| 539 | |||
| 540 | Contains one or more identifiers of Aurora DB clusters to which the RDS | ||
| 541 | DB instance is replicated as a read replica. For example, when you | ||
| 542 | create an Aurora read replica of an RDS MySQL DB instance, the Aurora | ||
| 543 | MySQL DB cluster for the Aurora read replica is shown. This output does | ||
| 544 | not contain information about cross region Aurora read replicas. | ||
| 545 | |||
| 546 | Currently, each RDS DB instance can have only one Aurora read replica. | ||
| 547 | |||
| 548 | |||
| 549 | =head2 ReadReplicaDBInstanceIdentifiers => ArrayRef[Str|Undef] | ||
| 550 | |||
| 551 | Contains one or more identifiers of the read replicas associated with | ||
| 552 | this DB instance. | ||
| 553 | |||
| 554 | |||
| 555 | =head2 ReadReplicaSourceDBInstanceIdentifier => Str | ||
| 556 | |||
| 557 | Contains the identifier of the source DB instance if this DB instance | ||
| 558 | is a read replica. | ||
| 559 | |||
| 560 | |||
| 561 | =head2 ReplicaMode => Str | ||
| 562 | |||
| 563 | The open mode of an Oracle read replica. The default is | ||
| 564 | C<open-read-only>. For more information, see Working with Oracle Read | ||
| 565 | Replicas for Amazon RDS | ||
| 566 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) | ||
| 567 | in the I<Amazon RDS User Guide>. | ||
| 568 | |||
| 569 | This attribute is only supported in RDS for Oracle. | ||
| 570 | |||
| 571 | |||
| 572 | =head2 SecondaryAvailabilityZone => Str | ||
| 573 | |||
| 574 | If present, specifies the name of the secondary Availability Zone for a | ||
| 575 | DB instance with multi-AZ support. | ||
| 576 | |||
| 577 | |||
| 578 | =head2 StatusInfos => ArrayRef[L<Paws::RDS::DBInstanceStatusInfo>] | ||
| 579 | |||
| 580 | The status of a read replica. If the instance isn't a read replica, | ||
| 581 | this is blank. | ||
| 582 | |||
| 583 | |||
| 584 | =head2 StorageEncrypted => Bool | ||
| 585 | |||
| 586 | Specifies whether the DB instance is encrypted. | ||
| 587 | |||
| 588 | |||
| 589 | =head2 StorageType => Str | ||
| 590 | |||
| 591 | Specifies the storage type associated with DB instance. | ||
| 592 | |||
| 593 | |||
| 594 | =head2 TagList => ArrayRef[L<Paws::RDS::Tag>] | ||
| 595 | |||
| 596 | |||
| 597 | |||
| 598 | |||
| 599 | =head2 TdeCredentialArn => Str | ||
| 600 | |||
| 601 | The ARN from the key store with which the instance is associated for | ||
| 602 | TDE encryption. | ||
| 603 | |||
| 604 | |||
| 605 | =head2 Timezone => Str | ||
| 606 | |||
| 607 | The time zone of the DB instance. In most cases, the C<Timezone> | ||
| 608 | element is empty. C<Timezone> content appears only for Microsoft SQL | ||
| 609 | Server DB instances that were created with a time zone specified. | ||
| 610 | |||
| 611 | |||
| 612 | =head2 VpcSecurityGroups => ArrayRef[L<Paws::RDS::VpcSecurityGroupMembership>] | ||
| 613 | |||
| 614 | Provides a list of VPC security group elements that the DB instance | ||
| 615 | belongs to. | ||
| 616 | |||
| 617 | |||
| 618 | |||
| 619 | =head1 SEE ALSO | ||
| 620 | |||
| 621 | This class forms part of L<Paws>, describing an object used in L<Paws::RDS> | ||
| 622 | |||
| 623 | =head1 BUGS and CONTRIBUTIONS | ||
| 624 | |||
| 625 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 626 | |||
| 627 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 628 | |||
| 629 | =cut | ||
| 630 | |||