Skip to main content

db_proxy_endpoints_list_only

Lists db_proxy_endpoints in a region or regions, for all properties use db_proxy_endpoints

Overview

Namedb_proxy_endpoints_list_only
TypeResource
DescriptionResource schema for AWS::RDS::DBProxyEndpoint.
Idaws.rds.db_proxy_endpoints_list_only

Fields

NameDatatypeDescription
db_proxy_endpoint_namestringThe identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
db_proxy_endpoint_arnstringThe Amazon Resource Name (ARN) for the DB proxy endpoint.
db_proxy_namestringThe identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
vpc_idstringVPC ID to associate with the new DB proxy endpoint.
vpc_security_group_idsarrayVPC security group IDs to associate with the new DB proxy endpoint.
vpc_subnet_idsarrayVPC subnet IDs to associate with the new DB proxy endpoint.
endpointstringThe 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.
target_rolestringA value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
is_defaultbooleanA value that 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.
tagsarrayAn optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all db_proxy_endpoints in a region.

SELECT
region,
db_proxy_endpoint_name
FROM aws.rds.db_proxy_endpoints_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the db_proxy_endpoints_list_only resource, see db_proxy_endpoints