Amazon Relational Database Service
API Reference (API Version 2014-10-31)

DBInstance

Contains the details of an Amazon RDS DB instance.

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

Contents

AllocatedStorage

Specifies the allocated storage size specified in gibibytes.

Type: Integer

Required: No

AutoMinorVersionUpgrade

Indicates that minor version patches are applied automatically.

Type: Boolean

Required: No

AvailabilityZone

Specifies the name of the Availability Zone the DB instance is located in.

Type: String

Required: No

BackupRetentionPeriod

Specifies the number of days for which automatic DB snapshots are retained.

Type: Integer

Required: No

CACertificateIdentifier

The identifier of the CA certificate for this DB instance.

Type: String

Required: No

CharacterSetName

If present, specifies the name of the character set that this instance is associated with.

Type: String

Required: No

CopyTagsToSnapshot

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

Type: Boolean

Required: No

DBClusterIdentifier

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.

Type: String

Required: No

DBInstanceArn

The Amazon Resource Name (ARN) for the DB instance.

Type: String

Required: No

DBInstanceClass

Contains the name of the compute and memory capacity class of the DB instance.

Type: String

Required: No

DBInstanceIdentifier

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

Type: String

Required: No

DbInstancePort

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.

Type: Integer

Required: No

DBInstanceStatus

Specifies the current state of this database.

Type: String

Required: No

DbiResourceId

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

Type: String

Required: No

DBName

The meaning of this parameter differs according to the database engine you use. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.

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.

Type: String

Required: No

DBParameterGroups.DBParameterGroup.N

Provides the list of DB parameter groups applied to this DB instance.

Type: Array of DBParameterGroupStatus objects

Required: No

DBSecurityGroups.DBSecurityGroup.N

Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Type: Array of DBSecurityGroupMembership objects

Required: No

DBSubnetGroup

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

Type: DBSubnetGroup object

Required: No

DeletionProtection

Indicates if the DB instance has deletion protection enabled. The database can't be deleted when this value is set to true. For more information, see Deleting a DB Instance.

Type: Boolean

Required: No

DomainMemberships.DomainMembership.N

The Active Directory Domain membership records associated with the DB instance.

Type: Array of DomainMembership objects

Required: No

EnabledCloudwatchLogsExports.member.N

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 in the Amazon RDS User Guide.

Type: Array of strings

Required: No

Endpoint

Specifies the connection endpoint.

Type: Endpoint object

Required: No

Engine

Provides the name of the database engine to be used for this DB instance.

Type: String

Required: No

EngineVersion

Indicates the database engine version.

Type: String

Required: No

EnhancedMonitoringResourceArn

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

Type: String

Required: No

IAMDatabaseAuthenticationEnabled

True if mapping of AWS 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.

Type: Boolean

Required: No

InstanceCreateTime

Provides the date and time the DB instance was created.

Type: Timestamp

Required: No

Iops

Specifies the Provisioned IOPS (I/O operations per second) value.

Type: Integer

Required: No

KmsKeyId

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

Type: String

Required: No

LatestRestorableTime

Specifies the latest time to which a database can be restored with point-in-time restore.

Type: Timestamp

Required: No

LicenseModel

License model information for this DB instance.

Type: String

Required: No

ListenerEndpoint

Specifies the listener connection endpoint for SQL Server Always On.

Type: Endpoint object

Required: No

MasterUsername

Contains the master username for the DB instance.

Type: String

Required: No

MonitoringInterval

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

Type: Integer

Required: No

MonitoringRoleArn

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

Type: String

Required: No

MultiAZ

Specifies if the DB instance is a Multi-AZ deployment.

Type: Boolean

Required: No

OptionGroupMemberships.OptionGroupMembership.N

Provides the list of option group memberships for this DB instance.

Type: Array of OptionGroupMembership objects

Required: No

PendingModifiedValues

Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

Type: PendingModifiedValues object

Required: No

PerformanceInsightsEnabled

True if Performance Insights is enabled for the DB instance, and otherwise false.

Type: Boolean

Required: No

PerformanceInsightsKMSKeyId

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

Type: String

Required: No

PerformanceInsightsRetentionPeriod

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

Type: Integer

Required: No

PreferredBackupWindow

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Type: String

Required: No

PreferredMaintenanceWindow

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

Type: String

Required: No

ProcessorFeatures.ProcessorFeature.N

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Type: Array of ProcessorFeature objects

Required: No

PromotionTier

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 in the Amazon Aurora User Guide.

Type: Integer

Required: No

PubliclyAccessible

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Type: Boolean

Required: No

ReadReplicaDBClusterIdentifiers.ReadReplicaDBClusterIdentifier.N

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

Currently, each RDS DB instance can have only one Aurora Read Replica.

Type: Array of strings

Required: No

ReadReplicaDBInstanceIdentifiers.ReadReplicaDBInstanceIdentifier.N

Contains one or more identifiers of the Read Replicas associated with this DB instance.

Type: Array of strings

Required: No

ReadReplicaSourceDBInstanceIdentifier

Contains the identifier of the source DB instance if this DB instance is a Read Replica.

Type: String

Required: No

SecondaryAvailabilityZone

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

Type: String

Required: No

StatusInfos.DBInstanceStatusInfo.N

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

Type: Array of DBInstanceStatusInfo objects

Required: No

StorageEncrypted

Specifies whether the DB instance is encrypted.

Type: Boolean

Required: No

StorageType

Specifies the storage type associated with DB instance.

Type: String

Required: No

TdeCredentialArn

The ARN from the key store with which the instance is associated for TDE encryption.

Type: String

Required: No

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.

Type: String

Required: No

VpcSecurityGroups.VpcSecurityGroupMembership.N

Provides a list of VPC security group elements that the DB instance belongs to.

Type: Array of VpcSecurityGroupMembership objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: