db_proxy_endpoint

Gets an individual db_proxy_endpoint resource

Overview

Name	db_proxy_endpoint
Type	Resource
Description	db_proxy_endpoint
Id	awscc.rds.db_proxy_endpoint

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

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
db_proxy_endpoint_name,
db_proxy_endpoint_arn,
db_proxy_name,
vpc_id,
vpc_security_group_ids,
vpc_subnet_ids,
endpoint,
target_role,
is_default,
tags
FROM awscc.rds.db_proxy_endpoint
WHERE data__Identifier = '<DBProxyEndpointName>';

Permissions

To operate on the db_proxy_endpoint resource, the following permissions are required:

Read

rds:DescribeDBProxyEndpoints,
rds:ListTagsForResource

Update

rds:ModifyDBProxyEndpoint,
rds:AddTagsToResource,
rds:RemoveTagsFromResource

Delete

rds:DescribeDBProxyEndpoints,
rds:DeleteDBProxyEndpoint