Skip to content
AWS for Query.Farm

aws.neptune.describe_db_instances

Example SQL Queries

SELECT * FROM
aws.neptune.describe_db_instances;

Description

Returns information about provisioned instances, and supports pagination.

This operation can also return information for Amazon RDS instances and Amazon DocDB instances.

Table Definition

Column NameColumn Data Type
db_instance_identifier Input Column

Contains a 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 will only include information about the DB instances associated with the DB clusters identified by these ARNs.

  • engine - Accepts an engine name (such as neptune), and restricts the results list to DB instances created by that engine.

For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB instances are returned, you could use the following command:

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

This parameter is not currently supported.

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
allocated_storage

Not supported by Neptune.

BIGINT
auto_minor_version_upgrade

Indicates that minor version patches are applied automatically.

BOOLEAN
availability_zone

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

VARCHAR
backup_retention_period

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

BIGINT
ca_certificate_identifier

The identifier of the CA certificate for this DB instance.

VARCHAR
character_set_name

(Not supported by Neptune) 

VARCHAR
copy_tags_to_snapshot

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

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

VARCHAR
db_instance_arn

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

VARCHAR
db_instance_class

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

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

BIGINT
db_instance_status

Specifies the current state of this database.

VARCHAR
db_name

The database name.

VARCHAR
db_parameter_groups

Provides 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 DP parameter group.

db_parameter_groups[].parameter_apply_status

The status of parameter updates.

db_security_groups

Provides List of DB security group elements containing only 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

Specifies information on 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_status" VARCHAR
    )[],
    "db_subnet_group_arn" 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

Specifies the EC2 Availability Zone that the subnet is in.

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

The name of the availability zone.

db_subnet_group.subnets[].subnet_identifier

Specifies the identifier of the subnet.

db_subnet_group.subnets[].subnet_status

Specifies the status of the subnet.

db_subnet_group.vpc_id

Provides the VpcId of the DB subnet group.

dbi_resource_id

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

VARCHAR
deletion_protection

Indicates whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See Deleting a DB Instance.

BOOLEAN
domain_memberships

Not supported

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

The identifier of the Active Directory Domain.

domain_memberships[].fqdn

The fully qualified domain name of the Active Directory Domain.

domain_memberships[].iam_role_name

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

domain_memberships[].status

The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

enabled_cloudwatch_logs_exports

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

VARCHAR[]
Show child fields
enabled_cloudwatch_logs_exports[]
endpoint

Specifies the connection endpoint.

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

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

VARCHAR
engine_version

Indicates the database engine version.

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

True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.

BOOLEAN
instance_create_time

Provides the date and time the DB instance was created.

TIMESTAMP_S
iops

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

BIGINT
kms_key_id

Not supported: The encryption for DB instances is managed by the DB cluster.

VARCHAR
latest_restorable_time

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

TIMESTAMP_S
license_model

License model information for this DB instance.

VARCHAR
master_username

Not supported by Neptune.

VARCHAR
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 Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

VARCHAR
multi_az

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

BOOLEAN
option_group_memberships

(Not supported by Neptune) 

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

Not supported by Neptune.

option_group_memberships[].status

Not supported by Neptune.

pending_modified_values

Specifies that changes to the DB instance are pending. This element is only included when changes are pending. 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[]
    )
)
Show child fields
pending_modified_values.allocated_storage

Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

pending_modified_values.backup_retention_period

Specifies the pending number of days for which automated backups are retained.

pending_modified_values.ca_certificate_identifier

Specifies the identifier of the CA certificate for the DB instance.

pending_modified_values.db_instance_class

Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.

pending_modified_values.db_instance_identifier

Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

pending_modified_values.db_subnet_group_name

The new DB subnet group for the DB instance.

pending_modified_values.engine_version

Indicates the database engine version.

pending_modified_values.iops

Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.

pending_modified_values.license_model

Not supported by Neptune.

pending_modified_values.master_user_password

Not supported by Neptune.

pending_modified_values.multi_az

Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

pending_modified_values.pending_cloudwatch_logs_exports

This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

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

Specifies the pending port for the DB instance.

pending_modified_values.storage_type

Specifies the storage type to be associated with the DB instance.

performance_insights_enabled

(Not supported by Neptune) 

BOOLEAN
performance_insights_kms_key_id

(Not supported by Neptune) 

VARCHAR
preferred_backup_window

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

VARCHAR
preferred_maintenance_window

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

VARCHAR
promotion_tier

A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance. 

BIGINT
publicly_accessible

This flag should no longer be used.

BOOLEAN
read_replica_db_cluster_identifiers

Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

VARCHAR[]
Show child fields
read_replica_db_cluster_identifiers[]
read_replica_db_instance_identifiers

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

VARCHAR[]
Show child fields
read_replica_db_instance_identifiers[]
read_replica_source_db_instance_identifier

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

VARCHAR
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 instance is not a Read Replica, this 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 is not in an error state, this value is blank.

status_infos[].normal

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

status_infos[].status

Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

status_infos[].status_type

This value is currently "read replication."

storage_encrypted

Not supported: The encryption for DB instances is managed by the DB cluster.

BOOLEAN
storage_type

Specifies the storage type associated with DB instance.

VARCHAR
tde_credential_arn

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

VARCHAR
timezone

Not supported.

VARCHAR
vpc_security_groups

Provides a list of VPC security group elements 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 status of the VPC security group.

vpc_security_groups[].vpc_security_group_id

The name of the VPC security group.