class Aws::RDS::Types::DBInstance

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the `DescribeDBInstances` action.

@!attribute [rw] db_instance_identifier

Contains a user-supplied database identifier. This identifier is the
unique key that identifies a DB instance.
@return [String]

@!attribute [rw] db_instance_class

Contains the name of the compute and memory capacity class of the DB
instance.
@return [String]

@!attribute [rw] engine

The name of the database engine to be used for this DB instance.
@return [String]

@!attribute [rw] db_instance_status

Specifies the current state of this database.

For information about DB instance statuses, see [Viewing DB instance
status][1] in the *Amazon RDS User Guide.*

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status
@return [String]

@!attribute [rw] automatic_restart_time

The time when a stopped DB instance is restarted automatically.
@return [Time]

@!attribute [rw] master_username

Contains the master username for the DB instance.
@return [String]

@!attribute [rw] db_name

The meaning of this parameter differs according to the database
engine you use.

**MySQL, MariaDB, SQL Server, PostgreSQL**

Contains the name of the initial database of this instance that was
provided at create time, if one was specified when the DB instance
was created. This same name is returned for the life of the DB
instance.

Type: String

**Oracle**

Contains the Oracle System ID (SID) of the created DB instance. Not
shown when the returned parameters do not apply to an Oracle DB
instance.
@return [String]

@!attribute [rw] endpoint

Specifies the connection endpoint.

<note markdown="1"> The endpoint might not be shown for instances whose status is
`creating`.

 </note>
@return [Types::Endpoint]

@!attribute [rw] allocated_storage

Specifies the allocated storage size specified in gibibytes (GiB).
@return [Integer]

@!attribute [rw] instance_create_time

Provides the date and time the DB instance was created.
@return [Time]

@!attribute [rw] preferred_backup_window

Specifies the daily time range during which automated backups are
created if automated backups are enabled, as determined by the
`BackupRetentionPeriod`.
@return [String]

@!attribute [rw] backup_retention_period

Specifies the number of days for which automatic DB snapshots are
retained.
@return [Integer]

@!attribute [rw] db_security_groups

A list of DB security group elements containing
`DBSecurityGroup.Name` and `DBSecurityGroup.Status` subelements.
@return [Array<Types::DBSecurityGroupMembership>]

@!attribute [rw] vpc_security_groups

Provides a list of VPC security group elements that the DB instance
belongs to.
@return [Array<Types::VpcSecurityGroupMembership>]

@!attribute [rw] db_parameter_groups

Provides the list of DB parameter groups applied to this DB
instance.
@return [Array<Types::DBParameterGroupStatus>]

@!attribute [rw] availability_zone

Specifies the name of the Availability Zone the DB instance is
located in.
@return [String]

@!attribute [rw] db_subnet_group

Specifies information on the subnet group associated with the DB
instance, including the name, description, and subnets in the subnet
group.
@return [Types::DBSubnetGroup]

@!attribute [rw] preferred_maintenance_window

Specifies the weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC).
@return [String]

@!attribute [rw] pending_modified_values

A value that specifies that changes to the DB instance are pending.
This element is only included when changes are pending. Specific
changes are identified by subelements.
@return [Types::PendingModifiedValues]

@!attribute [rw] latest_restorable_time

Specifies the latest time to which a database can be restored with
point-in-time restore.
@return [Time]

@!attribute [rw] multi_az

Specifies if the DB instance is a Multi-AZ deployment.
@return [Boolean]

@!attribute [rw] engine_version

Indicates the database engine version.
@return [String]

@!attribute [rw] auto_minor_version_upgrade

A value that indicates that minor version patches are applied
automatically.
@return [Boolean]

@!attribute [rw] read_replica_source_db_instance_identifier

Contains the identifier of the source DB instance if this DB
instance is a read replica.
@return [String]

@!attribute [rw] read_replica_db_instance_identifiers

Contains one or more identifiers of the read replicas associated
with this DB instance.
@return [Array<String>]

@!attribute [rw] read_replica_db_cluster_identifiers

Contains one or more identifiers of Aurora DB clusters to which the
RDS DB instance is replicated as a read replica. For example, when
you create an Aurora read replica of an RDS MySQL DB instance, the
Aurora MySQL DB cluster for the Aurora read replica is shown. This
output does not contain information about cross region Aurora read
replicas.

<note markdown="1"> Currently, each RDS DB instance can have only one Aurora read
replica.

 </note>
@return [Array<String>]

@!attribute [rw] replica_mode

The open mode of an Oracle read replica. The default is
`open-read-only`. For more information, see [Working with Oracle
Read Replicas for Amazon RDS][1] in the *Amazon RDS User Guide*.

<note markdown="1"> This attribute is only supported in RDS for Oracle.

 </note>

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
@return [String]

@!attribute [rw] license_model

License model information for this DB instance.
@return [String]

@!attribute [rw] iops

Specifies the Provisioned IOPS (I/O operations per second) value.
@return [Integer]

@!attribute [rw] option_group_memberships

Provides the list of option group memberships for this DB instance.
@return [Array<Types::OptionGroupMembership>]

@!attribute [rw] character_set_name

If present, specifies the name of the character set that this
instance is associated with.
@return [String]

@!attribute [rw] nchar_character_set_name

The name of the NCHAR character set for the Oracle DB instance. This
character set specifies the Unicode encoding for data stored in
table columns of type NCHAR, NCLOB, or NVARCHAR2.
@return [String]

@!attribute [rw] secondary_availability_zone

If present, specifies the name of the secondary Availability Zone
for a DB instance with multi-AZ support.
@return [String]

@!attribute [rw] publicly_accessible

Specifies the accessibility options for the DB instance.

When the DB instance is publicly accessible, its DNS endpoint
resolves to the private IP address from within the DB instance's
VPC, and to the public IP address from outside of the DB instance's
VPC. Access to the DB instance is ultimately controlled by the
security group it uses, and that public access is not permitted if
the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal
DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.
@return [Boolean]

@!attribute [rw] status_infos

The status of a read replica. If the instance isn't a read replica,
this is blank.
@return [Array<Types::DBInstanceStatusInfo>]

@!attribute [rw] storage_type

Specifies the storage type associated with DB instance.
@return [String]

@!attribute [rw] tde_credential_arn

The ARN from the key store with which the instance is associated for
TDE encryption.
@return [String]

@!attribute [rw] db_instance_port

Specifies the port that the DB instance listens on. If the DB
instance is part of a DB cluster, this can be a different port than
the DB cluster port.
@return [Integer]

@!attribute [rw] db_cluster_identifier

If the DB instance is a member of a DB cluster, contains the name of
the DB cluster that the DB instance is a member of.
@return [String]

@!attribute [rw] storage_encrypted

Specifies whether the DB instance is encrypted.
@return [Boolean]

@!attribute [rw] kms_key_id

If `StorageEncrypted` is true, the Amazon Web Services KMS key
identifier for the encrypted DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID,
alias ARN, or alias name for the Amazon Web Services KMS customer
master key (CMK).
@return [String]

@!attribute [rw] dbi_resource_id

The Amazon Web Services Region-unique, immutable identifier for the
DB instance. This identifier is found in Amazon Web Services
CloudTrail log entries whenever the Amazon Web Services KMS customer
master key (CMK) for the DB instance is accessed.
@return [String]

@!attribute [rw] ca_certificate_identifier

The identifier of the CA certificate for this DB instance.
@return [String]

@!attribute [rw] domain_memberships

The Active Directory Domain membership records associated with the
DB instance.
@return [Array<Types::DomainMembership>]

@!attribute [rw] copy_tags_to_snapshot

Specifies whether tags are copied from the DB instance to snapshots
of the DB instance.

**Amazon Aurora**

Not applicable. Copying tags to snapshots is managed by the DB
cluster. Setting this value for an Aurora DB instance has no effect
on the DB cluster setting. For more information, see `DBCluster`.
@return [Boolean]

@!attribute [rw] monitoring_interval

The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance.
@return [Integer]

@!attribute [rw] enhanced_monitoring_resource_arn

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log
stream that receives the Enhanced Monitoring metrics data for the DB
instance.
@return [String]

@!attribute [rw] monitoring_role_arn

The ARN for the IAM role that permits RDS to send Enhanced
Monitoring metrics to Amazon CloudWatch Logs.
@return [String]

@!attribute [rw] promotion_tier

A value that specifies the order in which an Aurora Replica is
promoted to the primary instance after a failure of the existing
primary instance. For more information, see [ Fault Tolerance for an
Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
@return [Integer]

@!attribute [rw] db_instance_arn

The Amazon Resource Name (ARN) for the DB instance.
@return [String]

@!attribute [rw] timezone

The time zone of the DB instance. In most cases, the `Timezone`
element is empty. `Timezone` content appears only for Microsoft SQL
Server DB instances that were created with a time zone specified.
@return [String]

@!attribute [rw] iam_database_authentication_enabled

True if mapping of Amazon Web Services Identity and Access
Management (IAM) accounts to database accounts is enabled, and
otherwise false.

IAM database authentication can be enabled for the following
database engines

* For MySQL 5.6, minor version 5.6.34 or higher

* For MySQL 5.7, minor version 5.7.16 or higher

* Aurora 5.6 or higher. To enable IAM database authentication for
  Aurora, see DBCluster Type.
@return [Boolean]

@!attribute [rw] performance_insights_enabled

True if Performance Insights is enabled for the DB instance, and
otherwise false.
@return [Boolean]

@!attribute [rw] performance_insights_kms_key_id

The Amazon Web Services KMS key identifier for encryption of
Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID,
alias ARN, or alias name for the Amazon Web Services KMS customer
master key (CMK).
@return [String]

@!attribute [rw] performance_insights_retention_period

The amount of time, in days, to retain Performance Insights data.
Valid values are 7 or 731 (2 years).
@return [Integer]

@!attribute [rw] enabled_cloudwatch_logs_exports

A list of log types that this DB instance is configured to export to
CloudWatch Logs.

Log types vary by DB engine. For information about the log types for
each DB engine, see [Amazon RDS Database Log Files][1] in the
*Amazon RDS User Guide.*

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html
@return [Array<String>]

@!attribute [rw] processor_features

The number of CPU cores and the number of threads per core for the
DB instance class of the DB instance.
@return [Array<Types::ProcessorFeature>]

@!attribute [rw] deletion_protection

Indicates if the DB instance has deletion protection enabled. The
database can't be deleted when deletion protection is enabled. For
more information, see [ Deleting a DB Instance][1].

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html
@return [Boolean]

@!attribute [rw] associated_roles

The Amazon Web Services Identity and Access Management (IAM) roles
associated with the DB instance.
@return [Array<Types::DBInstanceRole>]

@!attribute [rw] listener_endpoint

Specifies the listener connection endpoint for SQL Server Always On.
@return [Types::Endpoint]

@!attribute [rw] max_allocated_storage

The upper limit in gibibytes (GiB) to which Amazon RDS can
automatically scale the storage of the DB instance.
@return [Integer]

@!attribute [rw] tag_list

A list of tags. For more information, see [Tagging Amazon RDS
Resources][1] in the *Amazon RDS User Guide.*

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
@return [Array<Types::Tag>]

@!attribute [rw] db_instance_automated_backups_replications

The list of replicated automated backups associated with the DB
instance.
@return [Array<Types::DBInstanceAutomatedBackupsReplication>]

@!attribute [rw] customer_owned_ip_enabled

Specifies whether a customer-owned IP address (CoIP) is enabled for
an RDS on Outposts DB instance.

A <i>CoIP </i>provides local or external connectivity to resources
in your Outpost subnets through your on-premises network. For some
use cases, a CoIP can provide lower latency for connections to the
DB instance from outside of its virtual private cloud (VPC) on your
local network.

For more information about RDS on Outposts, see [Working with Amazon
RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
Guide*.

For more information about CoIPs, see [Customer-owned IP
addresses][2] in the *Amazon Web Services Outposts User Guide*.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
[2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
@return [Boolean]

@!attribute [rw] aws_backup_recovery_point_arn

The Amazon Resource Name (ARN) of the recovery point in Amazon Web
Services Backup.
@return [String]

@!attribute [rw] activity_stream_status

The status of the database activity stream.
@return [String]

@!attribute [rw] activity_stream_kms_key_id

The Amazon Web Services KMS key identifier used for encrypting
messages in the database activity stream. The Amazon Web Services
KMS key identifier is the key ARN, key ID, alias ARN, or alias name
for the Amazon Web Services KMS customer master key (CMK).
@return [String]

@!attribute [rw] activity_stream_kinesis_stream_name

The name of the Amazon Kinesis data stream used for the database
activity stream.
@return [String]

@!attribute [rw] activity_stream_mode

The mode of the database activity stream. Database events such as a
change or access generate an activity stream event. RDS for Oracle
always handles these events asynchronously.
@return [String]

@!attribute [rw] activity_stream_engine_native_audit_fields_included

Indicates whether engine-native audit fields are included in the
database activity stream.
@return [Boolean]

@see docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstance AWS API Documentation

Constants

SENSITIVE