Skip to content

RDS  >  Operations  >  create_db_proxy

create_db_proxy

Operation

create_db_proxy async 

create_db_proxy(input: CreateDBProxyInput, plugins: list[Plugin] | None = None) -> CreateDBProxyOutput

Creates a new DB proxy.

Parameters:

Name Type Description Default
input CreateDBProxyInput

An instance of CreateDBProxyInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
CreateDBProxyOutput

An instance of CreateDBProxyOutput.

Input

CreateDBProxyInput dataclass

Bases: _SerdeShape

Dataclass for CreateDBProxyInput structure.

Attributes

auth class-attribute instance-attribute 
auth: list[UserAuthConfig] | None = ...

The authorization mechanism that the proxy uses.

db_proxy_name class-attribute instance-attribute 
db_proxy_name: str | None = ...

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.

debug_logging class-attribute instance-attribute 
debug_logging: bool | None = ...

Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.

default_auth_scheme class-attribute instance-attribute 
default_auth_scheme: str | None = ...

The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database. If you don't specify DefaultAuthScheme or specify this parameter as NONE, you must specify the Auth option.

endpoint_network_type class-attribute instance-attribute 
endpoint_network_type: str | None = ...

The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.

Valid values:

  • IPV4 - The proxy endpoint supports IPv4 only.

  • IPV6 - The proxy endpoint supports IPv6 only.

  • DUAL - The proxy endpoint supports both IPv4 and IPv6.

Default: IPV4

Constraints:

  • If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block.

  • If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.

engine_family class-attribute instance-attribute 
engine_family: str | None = ...

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

idle_client_timeout class-attribute instance-attribute 
idle_client_timeout: int | None = ...

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.

require_tls class-attribute instance-attribute 
require_tls: bool | None = ...

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.

role_arn class-attribute instance-attribute 
role_arn: str | None = ...

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

tags class-attribute instance-attribute 
tags: list[Tag] | None = ...

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

target_connection_network_type class-attribute instance-attribute 
target_connection_network_type: str | None = ...

The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.

Valid values:

  • IPV4 - The proxy connects to the database using IPv4 only.

  • IPV6 - The proxy connects to the database using IPv6 only.

Default: IPV4

Constraints:

  • If you specify IPV6, the database must support dual-stack mode. RDS doesn't support IPv6-only databases.

  • All targets registered with the proxy must be compatible with the specified network type.

vpc_security_group_ids class-attribute instance-attribute 
vpc_security_group_ids: list[str] | None = ...

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

vpc_subnet_ids class-attribute instance-attribute 
vpc_subnet_ids: list[str] | None = ...

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

Output

CreateDBProxyOutput dataclass

Bases: _SerdeShape

Dataclass for CreateDBProxyOutput structure.

Attributes

db_proxy class-attribute instance-attribute 
db_proxy: DBProxy | None = ...

The DBProxy structure corresponding to the new proxy.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.