Amazon Relational Database Service
API Reference (API Version 2014-10-31)

DBProxy

Note

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

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

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 AWS account in the specified AWS Region.

Type: String

Required: No

DebugLogging

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 proxy. You include the endpoint value in the connection string for a database client application.

Type: String

Required: No

EngineFamily

Currently, this value is always MYSQL. The engine family applies to both RDS MySQL and Aurora MySQL.

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

Required: No

UpdatedDate

The date and time when the proxy was last updated.

Type: Timestamp

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 AWS SDKs, see the following:

On this page: