AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::RDS::DBProxy

CfnDBProxy

The `AWS::RDS::DBProxy` resource creates or updates a DB proxy. For information about RDS Proxy for Amazon RDS, see [Managing Connections with Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html) in the *Amazon RDS User Guide* . For information about RDS Proxy for Amazon Aurora, see [Managing Connections with Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy.html) in the *Amazon Aurora User Guide* . > Limitations apply to RDS Proxy, including DB engine version limitations and AWS Region limitations. > > For information about limitations that apply to RDS Proxy for Amazon RDS, see [Limitations for RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html#rds-proxy.limitations) in the *Amazon RDS User Guide* . > > For information about that apply to RDS Proxy for Amazon Aurora, see [Limitations for RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy.html#rds-proxy.limitations) in the *Amazon Aurora User Guide* .

Import

import { CfnDBProxy } from 'aws-cdk-lib/aws-rds';

Or use the module namespace:

import * as rds from 'aws-cdk-lib/aws-rds';
// rds.CfnDBProxy

Properties

Configuration passed to the constructor as CfnDBProxyProps.

dbProxyNameRequired
string

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS 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.

engineFamilyRequired
string

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

roleArnRequired
string | IRoleRef

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

vpcSubnetIdsRequired
string | ISubnetRef[]

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

authOptional
IResolvable | IResolvable | AuthFormatProperty[]

The authorization mechanism that the proxy uses.

debugLoggingOptional
boolean | IResolvable

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.

defaultAuthSchemeOptional
string

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.

endpointNetworkTypeOptional
string

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.

idleClientTimeoutOptional
number

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.

requireTlsOptional
boolean | IResolvable

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.

tagsOptional
TagFormatProperty[]

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

targetConnectionNetworkTypeOptional
string

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.

vpcSecurityGroupIdsOptional
string | ISecurityGroupRef[]

One or more VPC security group IDs to associate with the new proxy. If you plan to update the resource, don't specify VPC security groups in a shared VPC.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Get the Amazon RDS Cheat Sheet

Everything you need to know about Amazon RDS on one page. HD quality, print-friendly.

Download Free Infographic