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

ModifyDBProxy

Note

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

Changes the settings for an existing DB proxy.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Auth.member.N

The new authentication settings for the DBProxy.

Type: Array of UserAuthConfig objects

Required: No

DBProxyName

The identifier for the DBProxy to modify.

Type: String

Required: Yes

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

IdleClientTimeout

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.

Type: Integer

Required: No

NewDBProxyName

The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

Type: String

Required: No

RequireTLS

Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't use TLS.

Type: Boolean

Required: No

RoleArn

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.

Type: String

Required: No

SecurityGroups.member.N

The new list of security groups for the DBProxy.

Type: Array of strings

Required: No

Response Elements

The following element is returned by the service.

DBProxy

The DBProxy object representing the new settings for the proxy.

Type: DBProxy object

Errors

For information about the errors that are common to all actions, see Common Errors.

DBProxyAlreadyExistsFault

The specified proxy name must be unique for all proxies owned by your AWS account in the specified AWS Region.

HTTP Status Code: 400

DBProxyNotFoundFault

The specified proxy name doesn't correspond to a proxy owned by your AWS accoutn in the specified AWS Region.

HTTP Status Code: 404

InvalidDBProxyStateFault

The requested operation can't be performed while the proxy is in this state.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: