interface CfnDBProxyProps

Language	Type name
.NET	`Amazon.CDK.AWS.RDS.CfnDBProxyProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsrds#CfnDBProxyProps`
Java	`software.amazon.awscdk.services.rds.CfnDBProxyProps`
Python	`aws_cdk.aws_rds.CfnDBProxyProps`
TypeScript	`aws-cdk-lib` » `aws_rds` » `CfnDBProxyProps`

Properties for defining a CfnDBProxy.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_rds as rds } from 'aws-cdk-lib';
const cfnDBProxyProps: rds.CfnDBProxyProps = {
  dbProxyName: 'dbProxyName',
  engineFamily: 'engineFamily',
  roleArn: 'roleArn',
  vpcSubnetIds: ['vpcSubnetIds'],

  // the properties below are optional
  auth: [{
    authScheme: 'authScheme',
    clientPasswordAuthType: 'clientPasswordAuthType',
    description: 'description',
    iamAuth: 'iamAuth',
    secretArn: 'secretArn',
  }],
  debugLogging: false,
  defaultAuthScheme: 'defaultAuthScheme',
  endpointNetworkType: 'endpointNetworkType',
  idleClientTimeout: 123,
  requireTls: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  targetConnectionNetworkType: 'targetConnectionNetworkType',
  vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
};

Properties

Name	Type	Description
dbProxyName	`string`	The identifier for the proxy.
engineFamily	`string`	The kinds of databases that the proxy can connect to.
roleArn	`string`	The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
vpcSubnetIds	`string[]`	One or more VPC subnet IDs to associate with the new proxy.
auth?	`IResolvable` `\| (IResolvable` `\|` `AuthFormatProperty)[]`	The authorization mechanism that the proxy uses.
debugLogging?	`boolean \|` `IResolvable`	Specifies whether the proxy logs detailed connection and query information.
defaultAuthScheme?	`string`	The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
endpointNetworkType?	`string`	The network type of the DB proxy endpoint.
idleClientTimeout?	`number`	The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
requireTls?	`boolean \|` `IResolvable`	Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
tags?	`TagFormatProperty[]`	An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
targetConnectionNetworkType?	`string`	The network type that the proxy uses to connect to the target database.
vpcSecurityGroupIds?	`string[]`	One or more VPC security group IDs to associate with the new proxy.

dbProxyName

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

engineFamily

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

roleArn

Type: string

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

vpcSubnetIds

Type: string[]

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

auth?

Type: IResolvable | (IResolvable | AuthFormatProperty)[] (optional)

The authorization mechanism that the proxy uses.

debugLogging?

Type: boolean | IResolvable (optional)

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.

defaultAuthScheme?

Type: string (optional)

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.

endpointNetworkType?

Type: string (optional)

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.

idleClientTimeout?

Type: number (optional)

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.

requireTls?

Type: boolean | IResolvable (optional)

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.

tags?

Type: TagFormatProperty[] (optional)

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

targetConnectionNetworkType?

Type: string (optional)

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.

vpcSecurityGroupIds?

Type: string[] (optional)

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.