Skip to content
AWS for Query.Farm

aws.rds.describe_db_proxy_endpoints

Example SQL Queries

SELECT * FROM
aws.rds.describe_db_proxy_endpoints;

Description

Returns information about DB proxy endpoints.

Table Definition

Column NameColumn Data Type
db_proxy_endpoint_name Input Column

The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

VARCHAR
db_proxy_name Input Column

The identifier for the DB proxy that is associated with this DB proxy endpoint.

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
created_date

The date and time when the DB proxy endpoint was first created.

TIMESTAMP_S
db_proxy_endpoint_arn

The Amazon Resource Name (ARN) for the DB proxy endpoint.

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

Indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.

BOOLEAN
status

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

VARCHAR
target_role

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

VARCHAR
vpc_id

Provides the VPC ID of the DB proxy endpoint.

VARCHAR
vpc_security_group_ids

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

VARCHAR[]
Show child fields
vpc_security_group_ids[]
vpc_subnet_ids

The EC2 subnet IDs for the DB proxy endpoint.

VARCHAR[]
Show child fields
vpc_subnet_ids[]