Skip to content
AWS for Query.Farm

aws.rds.describe_db_instances

Example SQL Queries

SELECT * FROM
aws.rds.describe_db_instances;

Description

Describes provisioned RDS instances. This API supports pagination.

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

Table Definition

Column NameColumn Data Type
db_instance_identifier Input Column

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

VARCHAR
filters Input Column

A filter that specifies one or more DB instances to describe.

Supported Filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.

  • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.

  • dbi-resource-id - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.

  • domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.

  • engine - Accepts engine names. The results list only includes information about the DB instances for these engines.

STRUCT(
    "name" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the filter. Filter names are case-sensitive.

filters[].values[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
activity_stream_engine_native_audit_fields_included

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

BOOLEAN
activity_stream_kinesis_stream_name

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

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

VARCHAR
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.

VARCHAR
activity_stream_policy_status

The status of the policy state of the activity stream.

VARCHAR
activity_stream_status

The status of the database activity stream.

VARCHAR
allocated_storage

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

BIGINT
associated_roles

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

STRUCT(
    "role_arn" VARCHAR,
    "feature_name" VARCHAR,
    "status" VARCHAR
)[]
Show child fields
associated_roles[]
Show child fields
associated_roles[].feature_name

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.

associated_roles[].role_arn

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

associated_roles[].status

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.

auto_minor_version_upgrade

Indicates whether minor version patches are applied automatically.

BOOLEAN
automatic_restart_time

The time when a stopped DB instance is restarted automatically.

TIMESTAMP_S
automation_mode

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.

VARCHAR
availability_zone

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

VARCHAR
aws_backup_recovery_point_arn

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

VARCHAR
backup_retention_period

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

BIGINT
backup_target

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

VARCHAR
ca_certificate_identifier

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.

VARCHAR
certificate_details

The details of the DB instance's server certificate.

STRUCT(
    "ca_identifier" VARCHAR,
    "valid_till" TIMESTAMP_S
)
Show child fields
certificate_details.ca_identifier

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

certificate_details.valid_till

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

character_set_name

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

VARCHAR
copy_tags_to_snapshot

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.

BOOLEAN
custom_iam_instance_profile

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.

VARCHAR
customer_owned_ip_enabled

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.

BOOLEAN
db_cluster_identifier

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.

VARCHAR
db_instance_arn

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

VARCHAR
db_instance_automated_backups_replications

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

STRUCT(
    "db_instance_automated_backups_arn" VARCHAR
)[]
Show child fields
db_instance_automated_backups_replications[]
Show child fields
db_instance_automated_backups_replications[].db_instance_automated_backups_arn

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

db_instance_class

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

VARCHAR
db_instance_port

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.

BIGINT
db_instance_status

The current state of this database.

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

VARCHAR
db_name

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.

VARCHAR
db_parameter_groups

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

STRUCT(
    "db_parameter_group_name" VARCHAR,
    "parameter_apply_status" VARCHAR
)[]
Show child fields
db_parameter_groups[]
Show child fields
db_parameter_groups[].db_parameter_group_name

The name of the DB parameter group.

db_parameter_groups[].parameter_apply_status

The status of parameter updates.

db_security_groups

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

STRUCT(
    "db_security_group_name" VARCHAR,
    "status" VARCHAR
)[]
Show child fields
db_security_groups[]
Show child fields
db_security_groups[].db_security_group_name

The name of the DB security group.

db_security_groups[].status

The status of the DB security group.

db_subnet_group

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

STRUCT(
    "db_subnet_group_name" VARCHAR,
    "db_subnet_group_description" VARCHAR,
    "vpc_id" VARCHAR,
    "subnet_group_status" VARCHAR,
    "subnets" STRUCT(
        "subnet_identifier" VARCHAR,
        "subnet_availability_zone" STRUCT(
            "name" VARCHAR
        ),
        "subnet_outpost" STRUCT(
            "arn" VARCHAR
        ),
        "subnet_status" VARCHAR
    )[],
    "db_subnet_group_arn" VARCHAR,
    "supported_network_types" VARCHAR[]
)
Show child fields
db_subnet_group.db_subnet_group_arn

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

db_subnet_group.db_subnet_group_description

Provides the description of the DB subnet group.

db_subnet_group.db_subnet_group_name

The name of the DB subnet group.

db_subnet_group.subnet_group_status

Provides the status of the DB subnet group.

db_subnet_group.subnets[]
Show child fields
db_subnet_group.subnets[].subnet_availability_zone

Contains Availability Zone information.

This data type is used as an element in the OrderableDBInstanceOption data type.

Show child fields
db_subnet_group.subnets[].subnet_availability_zone.name

The name of the Availability Zone.

db_subnet_group.subnets[].subnet_identifier

The identifier of the subnet.

db_subnet_group.subnets[].subnet_outpost

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.

Show child fields
db_subnet_group.subnets[].subnet_outpost.arn

The Amazon Resource Name (ARN) of the Outpost.

db_subnet_group.subnets[].subnet_status

The status of the subnet.

db_subnet_group.supported_network_types[]
db_subnet_group.vpc_id

Provides the VpcId of the DB subnet group.

db_system_id

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.

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

VARCHAR
dedicated_log_volume

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

BOOLEAN
deletion_protection

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.

BOOLEAN
domain_memberships

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

STRUCT(
    "domain" VARCHAR,
    "status" VARCHAR,
    "fqdn" VARCHAR,
    "iam_role_name" VARCHAR,
    "ou" VARCHAR,
    "auth_secret_arn" VARCHAR,
    "dns_ips" VARCHAR[]
)[]
Show child fields
domain_memberships[]
Show child fields
domain_memberships[].auth_secret_arn

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

domain_memberships[].dns_ips[]
domain_memberships[].domain

The identifier of the Active Directory Domain.

domain_memberships[].fqdn

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

domain_memberships[].iam_role_name

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

domain_memberships[].ou

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

domain_memberships[].status

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

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

VARCHAR[]
Show child fields
enabled_cloudwatch_logs_exports[]
endpoint

The connection endpoint for the DB instance.

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

STRUCT(
    "address" VARCHAR,
    "port" BIGINT,
    "hosted_zone_id" VARCHAR
)
Show child fields
endpoint.address

Specifies the DNS address of the DB instance.

endpoint.hosted_zone_id

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

endpoint.port

Specifies the port that the database engine is listening on.

engine

The database engine used for this DB instance.

VARCHAR
engine_lifecycle_support

The life cycle type for the DB instance.

For more information, see CreateDBInstance.

VARCHAR
engine_version

The version of the database engine.

VARCHAR
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.

VARCHAR
iam_database_authentication_enabled

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.

BOOLEAN
instance_create_time

The date and time when the DB instance was created.

TIMESTAMP_S
iops

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

BIGINT
is_storage_config_upgrade_available

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.

BOOLEAN
kms_key_id

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.

VARCHAR
latest_restorable_time

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

TIMESTAMP_S
license_model

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

VARCHAR
listener_endpoint

The listener connection endpoint for SQL Server Always On.

STRUCT(
    "address" VARCHAR,
    "port" BIGINT,
    "hosted_zone_id" VARCHAR
)
Show child fields
listener_endpoint.address

Specifies the DNS address of the DB instance.

listener_endpoint.hosted_zone_id

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

listener_endpoint.port

Specifies the port that the database engine is listening on.

master_user_secret

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. 

STRUCT(
    "secret_arn" VARCHAR,
    "secret_status" VARCHAR,
    "kms_key_id" VARCHAR
)
Show child fields
master_user_secret.kms_key_id

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

master_user_secret.secret_arn

The Amazon Resource Name (ARN) of the secret.

master_user_secret.secret_status

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.

master_username

The master username for the DB instance.

VARCHAR
max_allocated_storage

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

BIGINT
monitoring_interval

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

BIGINT
monitoring_role_arn

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

VARCHAR
multi_az

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

BOOLEAN
multi_tenant

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

BOOLEAN
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.

VARCHAR
network_type

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 

VARCHAR
option_group_memberships

The list of option group memberships for this DB instance.

STRUCT(
    "option_group_name" VARCHAR,
    "status" VARCHAR
)[]
Show child fields
option_group_memberships[]
Show child fields
option_group_memberships[].option_group_name

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

option_group_memberships[].status

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.

pending_modified_values

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

STRUCT(
    "db_instance_class" VARCHAR,
    "allocated_storage" BIGINT,
    "master_user_password" VARCHAR,
    "port" BIGINT,
    "backup_retention_period" BIGINT,
    "multi_az" BOOLEAN,
    "engine_version" VARCHAR,
    "license_model" VARCHAR,
    "iops" BIGINT,
    "db_instance_identifier" VARCHAR,
    "storage_type" VARCHAR,
    "ca_certificate_identifier" VARCHAR,
    "db_subnet_group_name" VARCHAR,
    "pending_cloudwatch_logs_exports" STRUCT(
        "log_types_to_enable" VARCHAR[],
        "log_types_to_disable" VARCHAR[]
    ),
    "processor_features" STRUCT(
        "name" VARCHAR,
        "value" VARCHAR
    )[],
    "iam_database_authentication_enabled" BOOLEAN,
    "automation_mode" VARCHAR,
    "resume_full_automation_mode_time" TIMESTAMP_S,
    "storage_throughput" BIGINT,
    "engine" VARCHAR,
    "dedicated_log_volume" BOOLEAN,
    "multi_tenant" BOOLEAN
)
Show child fields
pending_modified_values.allocated_storage

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

pending_modified_values.automation_mode

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.

pending_modified_values.backup_retention_period

The number of days for which automated backups are retained.

pending_modified_values.ca_certificate_identifier

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.

pending_modified_values.db_instance_class

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

pending_modified_values.db_instance_identifier

The database identifier for the DB instance.

pending_modified_values.db_subnet_group_name

The DB subnet group for the DB instance.

pending_modified_values.dedicated_log_volume

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

pending_modified_values.engine

The database engine of the DB instance.

pending_modified_values.engine_version

The database engine version.

pending_modified_values.iam_database_authentication_enabled

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

pending_modified_values.iops

The Provisioned IOPS value for the DB instance.

pending_modified_values.license_model

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

pending_modified_values.master_user_password

The master credentials for the DB instance.

pending_modified_values.multi_az

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

pending_modified_values.multi_tenant

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

pending_modified_values.pending_cloudwatch_logs_exports

A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

Show child fields
pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[]
pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[]
pending_modified_values.port

The port for the DB instance.

pending_modified_values.processor_features[]
Show child fields
pending_modified_values.processor_features[].name

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

pending_modified_values.processor_features[].value

The value of a processor feature.

pending_modified_values.resume_full_automation_mode_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.

pending_modified_values.storage_throughput

The storage throughput of the DB instance.

pending_modified_values.storage_type

The storage type of the DB instance.

percent_progress

The progress of the storage optimization operation as a percentage.

VARCHAR
performance_insights_enabled

Indicates whether Performance Insights is enabled for the DB instance.

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

VARCHAR
performance_insights_retention_period

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

BIGINT
preferred_backup_window

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

VARCHAR
preferred_maintenance_window

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

VARCHAR
processor_features

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

STRUCT(
    "name" VARCHAR,
    "value" VARCHAR
)[]
Show child fields
processor_features[]
Show child fields
processor_features[].name

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

processor_features[].value

The value of a processor feature.

promotion_tier

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.

BIGINT
publicly_accessible

Indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. 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.

BOOLEAN
read_replica_db_cluster_identifiers

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.

VARCHAR[]
Show child fields
read_replica_db_cluster_identifiers[]
read_replica_db_instance_identifiers

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

VARCHAR[]
Show child fields
read_replica_db_instance_identifiers[]
read_replica_source_db_cluster_identifier

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

VARCHAR
read_replica_source_db_instance_identifier

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

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

This attribute is only supported in RDS for Oracle.

VARCHAR
resume_full_automation_mode_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.

TIMESTAMP_S
secondary_availability_zone

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

VARCHAR
status_infos

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

STRUCT(
    "status_type" VARCHAR,
    "normal" BOOLEAN,
    "status" VARCHAR,
    "message" VARCHAR
)[]
Show child fields
status_infos[]
Show child fields
status_infos[].message

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.

status_infos[].normal

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

status_infos[].status

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.

status_infos[].status_type

This value is currently "read replication."

storage_encrypted

Indicates whether the DB instance is encrypted.

BOOLEAN
storage_throughput

The storage throughput for the DB instance.

This setting applies only to the gp3 storage type.

BIGINT
storage_type

The storage type associated with the DB instance.

VARCHAR
tag_list

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide. 

STRUCT(
    "key" VARCHAR,
    "value" VARCHAR
)[]
Show child fields
tag_list[]
Show child fields
tag_list[].key

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}_.:/=+\\-@]*)$").

tag_list[].value

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}_.:/=+\\-@]*)$").

tde_credential_arn

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

VARCHAR
timezone

The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified.

VARCHAR
vpc_security_groups

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

STRUCT(
    "vpc_security_group_id" VARCHAR,
    "status" VARCHAR
)[]
Show child fields
vpc_security_groups[]
Show child fields
vpc_security_groups[].status

The membership status of the VPC security group.

Currently, the only valid status is active.

vpc_security_groups[].vpc_security_group_id

The name of the VPC security group.