Skip to main content

db_proxies_list_only

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

Overview

Namedb_proxies_list_only
TypeResource
DescriptionResource schema for AWS::RDS::DBProxy
Idaws.rds.db_proxies_list_only

Fields

NameDatatypeDescription
autharrayThe authorization mechanism that the proxy uses.
db_proxy_arnstringThe Amazon Resource Name (ARN) for the proxy.
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.
debug_loggingbooleanWhether the proxy includes detailed information about SQL statements in its logs.
endpointstringThe endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
engine_familystringThe kinds of databases that the proxy can connect to.
idle_client_timeoutintegerThe number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
require_tlsbooleanA Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
role_arnstringThe Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
tagsarrayAn optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
vpc_idstringVPC ID to associate with the new DB proxy.
vpc_security_group_idsarrayVPC security group IDs to associate with the new proxy.
vpc_subnet_idsarrayVPC subnet IDs to associate with the new proxy.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all db_proxies in a region.

SELECT
region,
db_proxy_name
FROM aws.rds.db_proxies_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the db_proxies_list_only resource, see db_proxies