db_proxies_list_only
Lists db_proxies
in a region or regions, for all properties use db_proxies
Overview
Name | db_proxies_list_only |
Type | Resource |
Description | Resource schema for AWS::RDS::DBProxy |
Id | aws.rds.db_proxies_list_only |
Fields
Name | Datatype | Description |
---|---|---|
auth | array | The authorization mechanism that the proxy uses. |
db_proxy_arn | string | The Amazon Resource Name (ARN) for the proxy. |
db_proxy_name | string | The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. |
debug_logging | boolean | Whether the proxy includes detailed information about SQL statements in its logs. |
endpoint | string | The 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_family | string | The kinds of databases that the proxy can connect to. |
idle_client_timeout | integer | The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. |
require_tls | boolean | A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. |
role_arn | string | The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager. |
tags | array | An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy. |
vpc_id | string | VPC ID to associate with the new DB proxy. |
vpc_security_group_ids | array | VPC security group IDs to associate with the new proxy. |
vpc_subnet_ids | array | VPC subnet IDs to associate with the new proxy. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
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