db_proxy

Gets an individual db_proxy resource

Overview

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

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

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
auth,
db_proxy_arn,
db_proxy_name,
debug_logging,
endpoint,
engine_family,
idle_client_timeout,
require_tls,
role_arn,
tags,
vpc_id,
vpc_security_group_ids,
vpc_subnet_ids
FROM awscc.rds.db_proxy
WHERE data__Identifier = '<DBProxyName>';

Permissions

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

Read

rds:DescribeDBProxies

Update

rds:ModifyDBProxy,
rds:AddTagsToResource,
rds:RemoveTagsFromResource,
iam:PassRole

Delete

rds:DescribeDBProxies,
rds:DeleteDBProxy