v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142826341.7 MB

Changes the settings for an existing DB proxy.

get/#Action=ModifyDBProxy

Query parameters

DBProxyNamestring required

The identifier for the <code>DBProxy</code> to modify.

NewDBProxyNamestring

The new identifier for the <code>DBProxy</code>. 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.

Descriptionstring

A user-specified description about the authentication used by a proxy to log in as a specific database user.

UserNamestring

The name of the database user to which the proxy connects.

AuthScheme'SECRETS'

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

SecretArnstring

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

IAMAuth'DISABLED' | 'REQUIRED' | 'ENABLED'

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The <code>ENABLED</code> value is valid only for proxies with RDS for Microsoft SQL Server.

ClientPasswordAuthType'MYSQL_NATIVE_PASSWORD' | 'POSTGRES_SCRAM_SHA_256' | 'POSTGRES_MD5' | 'SQL_SERVER_AUTHENTICATION'

The type of authentication the proxy uses for connections from clients.

The new authentication settings for the <code>DBProxy</code>.

RequireTLSboolean

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.

IdleClientTimeoutinteger

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.

DebugLoggingboolean

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.

RoleArnstring

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

SecurityGroupsString[]

The new list of security groups for the <code>DBProxy</code>.

Action'ModifyDBProxy' required
Version'2014-10-31' required

Response

Success