Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142826341.7 MB

Creates a new DB proxy.

get/#Action=CreateDBProxy

Query parameters

DBProxyNamestring required

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. 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.

EngineFamily'MYSQL' | 'POSTGRESQL' | 'SQLSERVER' required

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. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify <code>MYSQL</code>. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify <code>POSTGRESQL</code>. For RDS for Microsoft SQL Server, specify <code>SQLSERVER</code>.

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 authorization mechanism that the proxy uses.

RoleArnstring required

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

VpcSubnetIdsString[] required

One or more VPC subnet IDs to associate with the new proxy.

VpcSecurityGroupIdsString[]

One or more VPC security group IDs to associate with the new proxy.

RequireTLSboolean

A Boolean parameter that specifies 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.

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.

Keystring

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with <code>aws:</code> or <code>rds:</code>. The string can only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}.:/=+\-@]*)$").

Valuestring

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with <code>aws:</code> or <code>rds:</code>. The string can only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}.:/=+\-@]*)$").

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

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

Response

Success