DBProxy¶
Structure Class¶
DBProxy
dataclass
¶
Bases: _SerdeShape
The data structure representing a proxy managed by the RDS Proxy.
This data type is used as a response element in the DescribeDBProxies
action.
Attributes¶
auth
class-attribute
instance-attribute
¶
auth: list[UserAuthConfigInfo] | None = ...
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
created_date
class-attribute
instance-attribute
¶
created_date: datetime | None = ...
The date and time when the proxy was first created.
db_proxy_arn
class-attribute
instance-attribute
¶
db_proxy_arn: str | None = ...
The Amazon Resource Name (ARN) for the proxy.
db_proxy_name
class-attribute
instance-attribute
¶
db_proxy_name: str | None = ...
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
class-attribute
instance-attribute
¶
debug_logging: bool | None = ...
Specifies whether the proxy logs detailed connection and query
information. When you enable DebugLogging, the proxy captures
connection details and connection pool behavior from your queries. Debug
logging increases CloudWatch costs and can impact proxy performance.
Enable this option only when you need to troubleshoot connection or
performance issues.
default_auth_scheme
class-attribute
instance-attribute
¶
default_auth_scheme: str | None = ...
The default authentication scheme that the proxy uses for client
connections to the proxy and connections from the proxy to the
underlying database. Valid values are NONE and IAM_AUTH. When set to
IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to
the database.
endpoint
class-attribute
instance-attribute
¶
endpoint: str | None = ...
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.
endpoint_network_type
class-attribute
instance-attribute
¶
endpoint_network_type: str | None = ...
The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.
Valid values:
-
IPV4- The proxy endpoint supports IPv4 only. -
IPV6- The proxy endpoint supports IPv6 only. -
DUAL- The proxy endpoint supports both IPv4 and IPv6.
engine_family
class-attribute
instance-attribute
¶
engine_family: str | None = ...
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.
idle_client_timeout
class-attribute
instance-attribute
¶
idle_client_timeout: int | None = ...
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
class-attribute
instance-attribute
¶
require_tls: bool | None = ...
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
role_arn
class-attribute
instance-attribute
¶
role_arn: str | None = ...
The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
status
class-attribute
instance-attribute
¶
status: str | None = ...
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.
target_connection_network_type
class-attribute
instance-attribute
¶
target_connection_network_type: str | None = ...
The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.
Valid values:
-
IPV4- The proxy connects to the database using IPv4 only. -
IPV6- The proxy connects to the database using IPv6 only.
updated_date
class-attribute
instance-attribute
¶
updated_date: datetime | None = ...
The date and time when the proxy was last updated.
vpc_id
class-attribute
instance-attribute
¶
vpc_id: str | None = ...
Provides the VPC ID of the DB proxy.
vpc_security_group_ids
class-attribute
instance-attribute
¶
Provides a list of VPC security groups that the proxy belongs to.