DbProxy

class DbProxy

The data structure representing a proxy managed by the RDS Proxy.

This data type is used as a response element in the DescribeDBProxies action.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

Link copied to clipboard

The date and time when the proxy was first created.

Link copied to clipboard

The Amazon Resource Name (ARN) for the proxy.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.

Link copied to clipboard

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.

Link copied to clipboard

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

Link copied to clipboard

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

Link copied to clipboard

The current status of this proxy. A status of available 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.

Link copied to clipboard

The date and time when the proxy was last updated.

Link copied to clipboard

Provides the VPC ID of the DB proxy.

Link copied to clipboard

Provides a list of VPC security groups that the proxy belongs to.

Link copied to clipboard

The EC2 subnet IDs for the proxy.

Functions

Link copied to clipboard
inline fun copy(block: DbProxy.Builder.() -> Unit = {}): DbProxy
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String