RDS Proxy

Docs > DDSQL Reference > Data Directory > RDS Proxy

This table represents the RDS Proxy resource from Amazon Web Services.

aws.rds_proxy

Fields

ID	Type	Data Type	Description
_key	core	string
account_id	core	string
auth	core	json	One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
created_date	core	timestamp	The date and time when the proxy was first created.
db_proxy_arn	core	string	The Amazon Resource Name (ARN) for the proxy.
db_proxy_name	core	string	The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
debug_logging	core	bool	Indicates whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
endpoint	core	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.
engine_family	core	string	The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. <code>MYSQL</code> supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. <code>POSTGRESQL</code> supports Aurora PostgreSQL and RDS for PostgreSQL databases. <code>SQLSERVER</code> supports RDS for Microsoft SQL Server databases.
idle_client_timeout	core	int64	The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests. Default: 1800 (30 minutes) Constraints: 1 to 28,800
require_tls	core	bool	Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
role_arn	core	string	The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
status	core	string	The current status of this proxy. A status of <code>available</code> means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
tags	core	hstore
updated_date	core	timestamp	The date and time when the proxy was last updated.
vpc_id	core	string	Provides the VPC ID of the DB proxy.
vpc_security_group_ids	core	array<string>	Provides a list of VPC security groups that the proxy belongs to.
vpc_subnet_ids	core	array<string>	The EC2 subnet IDs for the proxy.