Skip to content
AWS for Query.Farm

aws.rds.describe_db_proxies

Example SQL Queries

SELECT * FROM
aws.rds.describe_db_proxies;

Description

Returns information about DB proxies.

Table Definition

Column NameColumn Data Type
db_proxy_name Input Column

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

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[]
_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
auth

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

STRUCT(
    "description" VARCHAR,
    "user_name" VARCHAR,
    "auth_scheme" VARCHAR,
    "secret_arn" VARCHAR,
    "iam_auth" VARCHAR,
    "client_password_auth_type" VARCHAR
)[]
Show child fields
auth[]
Show child fields
auth[].auth_scheme

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

auth[].client_password_auth_type

The type of authentication the proxy uses for connections from clients.

auth[].description

A user-specified description about the authentication used by a proxy to log in as a specific database user.

auth[].iam_auth

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

auth[].secret_arn

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

auth[].user_name

The name of the database user to which the proxy connects.

created_date

The date and time when the proxy was first created.

TIMESTAMP_S
db_proxy_arn

The Amazon Resource Name (ARN) for the proxy.

VARCHAR
debug_logging

Indicates whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

BOOLEAN
endpoint

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

VARCHAR
engine_family

The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.

VARCHAR
idle_client_timeout

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.

Default: 1800 (30 minutes)

Constraints: 1 to 28,800

BIGINT
require_tls

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

BOOLEAN
role_arn

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

VARCHAR
status

The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

VARCHAR
updated_date

The date and time when the proxy was last updated.

TIMESTAMP_S
vpc_id

Provides the VPC ID of the DB proxy.

VARCHAR
vpc_security_group_ids

Provides a list of VPC security groups that the proxy belongs to.

VARCHAR[]
Show child fields
vpc_security_group_ids[]
vpc_subnet_ids

The EC2 subnet IDs for the proxy.

VARCHAR[]
Show child fields
vpc_subnet_ids[]