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.
Contents
Note
In the following list, the required parameters are described first.
- Auth.member.N
-
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
Type: Array of UserAuthConfigInfo objects
Required: No
- CreatedDate
-
The date and time when the proxy was first created.
Type: Timestamp
Required: No
- DBProxyArn
-
The Amazon Resource Name (ARN) for the proxy.
Type: String
Required: No
- DBProxyName
-
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.
Type: String
Required: No
- DebugLogging
-
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.
Type: Boolean
Required: No
- Endpoint
-
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.
Type: String
Required: No
- EngineFamily
-
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.Type: String
Required: No
- IdleClientTimeout
-
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
Type: Integer
Required: No
- RequireTLS
-
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
Type: Boolean
Required: No
- RoleArn
-
The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
Type: String
Required: No
- Status
-
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.Type: String
Valid Values:
available | modifying | incompatible-network | insufficient-resource-limits | creating | deleting | suspended | suspending | reactivating
Required: No
- UpdatedDate
-
The date and time when the proxy was last updated.
Type: Timestamp
Required: No
- VpcId
-
Provides the VPC ID of the DB proxy.
Type: String
Required: No
- VpcSecurityGroupIds.member.N
-
Provides a list of VPC security groups that the proxy belongs to.
Type: Array of strings
Required: No
- VpcSubnetIds.member.N
-
The EC2 subnet IDs for the proxy.
Type: Array of strings
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: