db_proxy_endpoints_list_only
Lists db_proxy_endpoints
in a region or regions, for all properties use db_proxy_endpoints
Overview
Name | db_proxy_endpoints_list_only |
Type | Resource |
Description | Resource schema for AWS::RDS::DBProxyEndpoint. |
Id | aws.rds.db_proxy_endpoints_list_only |
Fields
Name | Datatype | Description |
---|---|---|
db_proxy_endpoint_name | string | The 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_arn | string | The Amazon Resource Name (ARN) for the DB proxy endpoint. |
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. |
vpc_id | string | VPC ID to associate with the new DB proxy endpoint. |
vpc_security_group_ids | array | VPC security group IDs to associate with the new DB proxy endpoint. |
vpc_subnet_ids | array | VPC subnet IDs to associate with the new DB proxy endpoint. |
endpoint | string | 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. |
target_role | string | A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. |
is_default | boolean | A 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. |
tags | array | An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
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