Skip to content
AWS for Query.Farm

aws.rds.describe_db_proxy_targets

Example SQL Queries

SELECT * FROM
aws.rds.describe_db_proxy_targets
WHERE
"db_proxy_name" = 'VALUE';

Description

Returns information about DBProxyTarget objects. This API supports pagination.

Table Definition

Column NameColumn Data Type
db_proxy_name Required Input Column

The identifier of the DBProxyTarget to describe.

VARCHAR
filters Input Column

This parameter is not currently supported.

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[]
target_group_name Input Column

The identifier of the DBProxyTargetGroup to describe.

VARCHAR
_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
endpoint

The writer endpoint for the RDS DB instance or Aurora DB cluster.

VARCHAR
port

The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

BIGINT
rds_resource_id

The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.

VARCHAR
role

A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

VARCHAR
target_arn

The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

VARCHAR
target_health

Information about the connection health of the RDS Proxy target.

STRUCT(
    "state" VARCHAR,
    "reason" VARCHAR,
    "description" VARCHAR
)
Show child fields
target_health.description

A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.

target_health.reason

The reason for the current health State of the RDS Proxy target.

target_health.state

The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:

registering > unavailable > available > unavailable > available

tracked_cluster_id

The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

VARCHAR
type

Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

VARCHAR