AWS RDS

Describe DB instance

Describe a DB instance.

Inputs

Field

Type

Description

dbInstanceIdentifier

string

region [required]

enum

default: us-east-1

Outputs

Expand All

Field

Type

Description

dbInstance [required]

object

DBInstanceIdentifier

string

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

DBInstanceClass

string

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

Engine

string

The database engine used for this DB instance.

DBInstanceStatus

string

The current state of this database. For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

AutomaticRestartTime

date-time

The time when a stopped DB instance is restarted automatically.

MasterUsername

string

The master username for the DB instance.

DBName

string

The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.

Endpoint

object

The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of creating.

Address

string

Specifies the DNS address of the DB instance.

Port

number

Specifies the port that the database engine is listening on.

HostedZoneId

string

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

AllocatedStorage

number

The amount of storage in gibibytes (GiB) allocated for the DB instance.

InstanceCreateTime

date-time

The date and time when the DB instance was created.

PreferredBackupWindow

string

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

BackupRetentionPeriod

number

The number of days for which automatic DB snapshots are retained.

DBSecurityGroups

[object]

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

DBSecurityGroupName

string

The name of the DB security group.

Status

string

The status of the DB security group.

VpcSecurityGroups

[object]

The list of Amazon EC2 VPC security groups that the DB instance belongs to.

VpcSecurityGroupId

string

The name of the VPC security group.

Status

string

The membership status of the VPC security group. Currently, the only valid status is active.

DBParameterGroups

[object]

The list of DB parameter groups applied to this DB instance.

DBParameterGroupName

string

The name of the DB parameter group.

ParameterApplyStatus

string

The status of parameter updates.

AvailabilityZone

string

The name of the Availability Zone where the DB instance is located.

DBSubnetGroup

object

Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

DBSubnetGroupName

string

The name of the DB subnet group.

DBSubnetGroupDescription

string

Provides the description of the DB subnet group.

VpcId

string

Provides the VpcId of the DB subnet group.

SubnetGroupStatus

string

Provides the status of the DB subnet group.

Subnets

[object]

Contains a list of Subnet elements.

SubnetIdentifier

string

The identifier of the subnet.

SubnetAvailabilityZone

object

Name

string

The name of the Availability Zone.

SubnetOutpost

object

If the subnet is associated with an Outpost, this value specifies the Outpost. For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

Arn

string

The Amazon Resource Name (ARN) of the Outpost.

SubnetStatus

string

The status of the subnet.

DBSubnetGroupArn

string

The Amazon Resource Name (ARN) for the DB subnet group.

SupportedNetworkTypes

[string]

The network type of the DB subnet group. Valid values: IPV4 DUAL A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

PreferredMaintenanceWindow

string

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

PendingModifiedValues

object

Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.

DBInstanceClass

string

The name of the compute and memory capacity class for the DB instance.

AllocatedStorage

number

The allocated storage size for the DB instance specified in gibibytes (GiB).

MasterUserPassword

string

The master credentials for the DB instance.

Port

number

The port for the DB instance.

BackupRetentionPeriod

number

The number of days for which automated backups are retained.

MultiAZ

boolean

Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.

EngineVersion

string

The database engine version.

LicenseModel

string

The license model for the DB instance. Valid values: license-included | bring-your-own-license | general-public-license

Iops

number

The Provisioned IOPS value for the DB instance.

DBInstanceIdentifier

string

The database identifier for the DB instance.

StorageType

string

The storage type of the DB instance.

CACertificateIdentifier

string

The identifier of the CA certificate for the DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

DBSubnetGroupName

string

The DB subnet group for the DB instance.

PendingCloudwatchLogsExports

object

LogTypesToEnable

[string]

Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

LogTypesToDisable

[string]

Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

ProcessorFeatures

[object]

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

Name

string

The name of the processor feature. Valid names are coreCount and threadsPerCore.

Value

string

The value of a processor feature name.

IAMDatabaseAuthenticationEnabled

boolean

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

AutomationMode

string

The automation mode of the RDS Custom DB instance: full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

ResumeFullAutomationModeTime

date-time

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

StorageThroughput

number

The storage throughput of the DB instance.

Engine

string

The database engine of the DB instance.

DedicatedLogVolume

boolean

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.>

MultiTenant

boolean

Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

LatestRestorableTime

date-time

The latest time to which a database in this DB instance can be restored with point-in-time restore.

MultiAZ

boolean

Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.

EngineVersion

string

The version of the database engine.

AutoMinorVersionUpgrade

boolean

Indicates whether minor version patches are applied automatically.

ReadReplicaSourceDBInstanceIdentifier

string

The identifier of the source DB instance if this DB instance is a read replica.

ReadReplicaDBInstanceIdentifiers

[string]

The identifiers of the read replicas associated with this DB instance.

ReadReplicaDBClusterIdentifiers

[string]

The 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 for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Currently, each RDS DB instance can have only one Aurora read replica.

ReplicaMode

string

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 in the Amazon RDS User Guide. This attribute is only supported in RDS for Oracle.

LicenseModel

string

The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.

Iops

number

The Provisioned IOPS (I/O operations per second) value for the DB instance.

OptionGroupMemberships

[object]

The list of option group memberships for this DB instance.

OptionGroupName

string

The name of the option group that the instance belongs to.

Status

string

The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

CharacterSetName

string

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

NcharCharacterSetName

string

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.

SecondaryAvailabilityZone

string

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

PubliclyAccessible

boolean

Indicates whether the DB instance is publicly accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster 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.

StatusInfos

[object]

The status of a read replica. If the DB instance isn't a read replica, the value is blank.

StatusType

string

This value is currently "read replication."

Normal

boolean

Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE).

Status

string

The status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.

Message

string

Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.

StorageType

string

The storage type associated with the DB instance.

TdeCredentialArn

string

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

DbInstancePort

number

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.

DBClusterIdentifier

string

If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.

StorageEncrypted

boolean

Indicates whether the DB instance is encrypted.

KmsKeyId

string

If StorageEncrypted is enabled, 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 KMS key.

DbiResourceId

string

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 key for the DB instance is accessed.

CACertificateIdentifier

string

The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

DomainMemberships

[object]

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

Domain

string

The identifier of the Active Directory Domain.

Status

string

The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

FQDN

string

The fully qualified domain name (FQDN) of the Active Directory Domain.

IAMRoleName

string

The name of the IAM role used when making API calls to the Directory Service.

OU

string

The Active Directory organizational unit for the DB instance or cluster.

AuthSecretArn

string

The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.

DnsIps

[string]

The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.

CopyTagsToSnapshot

boolean

Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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.

MonitoringInterval

number

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

EnhancedMonitoringResourceArn

string

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

MonitoringRoleArn

string

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

PromotionTier

number

The order of priority 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.

DBInstanceArn

string

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

Timezone

string

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.

IAMDatabaseAuthenticationEnabled

boolean

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.

PerformanceInsightsEnabled

boolean

Indicates whether Performance Insights is enabled for the DB instance.

PerformanceInsightsKMSKeyId

string

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 KMS key.

PerformanceInsightsRetentionPeriod

number

The number of days to retain Performance Insights data. Valid Values: 7 month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31) 731 Default: 7 days

EnabledCloudwatchLogsExports

[string]

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

ProcessorFeatures

[object]

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

Name

string

The name of the processor feature. Valid names are coreCount and threadsPerCore.

Value

string

The value of a processor feature name.

DeletionProtection

boolean

Indicates whether 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.

AssociatedRoles

[object]

The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

RoleArn

string

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

FeatureName

string

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.

Status

string

Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values: ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf. PENDING - the IAM role ARN is being associated with the DB instance. INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.

ListenerEndpoint

object

The listener connection endpoint for SQL Server Always On.

Address

string

Specifies the DNS address of the DB instance.

Port

number

Specifies the port that the database engine is listening on.

HostedZoneId

string

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

MaxAllocatedStorage

number

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

TagList

[object]

Key

string

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}.:/=+\-@]*)$").

Value

string

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}.:/=+\-@]*)$").

DBInstanceAutomatedBackupsReplications

[object]

The list of replicated automated backups associated with the DB instance.

DBInstanceAutomatedBackupsArn

string

The Amazon Resource Name (ARN) of the replicated automated backups.

CustomerOwnedIpEnabled

boolean

Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A CoIP 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 in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

AwsBackupRecoveryPointArn

string

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

ActivityStreamStatus

string

The status of the database activity stream.

ActivityStreamKmsKeyId

string

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 KMS key.

ActivityStreamKinesisStreamName

string

The name of the Amazon Kinesis data stream used for the database activity stream.

ActivityStreamMode

string

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.

ActivityStreamEngineNativeAuditFieldsIncluded

boolean

Indicates whether engine-native audit fields are included in the database activity stream.

AutomationMode

string

The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

ResumeFullAutomationModeTime

date-time

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

CustomIamInstanceProfile

string

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: The profile must exist in your account. The profile must have an IAM role that Amazon EC2 has permissions to assume. The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

BackupTarget

string

The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

NetworkType

string

The network type of the DB instance. The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide. Valid Values: IPV4 | DUAL

ActivityStreamPolicyStatus

string

The status of the policy state of the activity stream.

StorageThroughput

number

The storage throughput for the DB instance. This setting applies only to the gp3 storage type.

DBSystemId

string

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.

MasterUserSecret

object

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

SecretArn

string

The Amazon Resource Name (ARN) of the secret.

SecretStatus

string

The status of the secret. The possible status values include the following: creating - The secret is being created. active - The secret is available for normal use and rotation. rotating - The secret is being rotated. impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

KmsKeyId

string

The Amazon Web Services KMS key identifier that is used to encrypt the secret.

CertificateDetails

object

The details of the DB instance's server certificate.

CAIdentifier

string

The CA identifier of the CA certificate used for the DB instance's server certificate.

ValidTill

date-time

The expiration date of the DB instance’s server certificate.

ReadReplicaSourceDBClusterIdentifier

string

The identifier of the source DB cluster if this DB instance is a read replica.

PercentProgress

string

The progress of the storage optimization operation as a percentage.

DedicatedLogVolume

boolean

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

IsStorageConfigUpgradeAvailable

boolean

Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.

MultiTenant

boolean

Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

amzRequestId [required]

string