Package software.amazon.awscdk.services.rds

Interface CfnDBProxyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBProxyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:43.742Z")
@Stability(Stable)
public interface CfnDBProxyProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.rds.*;
 CfnDBProxyProps cfnDBProxyProps = CfnDBProxyProps.builder()
         .dbProxyName("dbProxyName")
         .engineFamily("engineFamily")
         .roleArn("roleArn")
         .vpcSubnetIds(List.of("vpcSubnetIds"))
         // the properties below are optional
         .auth(List.of(AuthFormatProperty.builder()
                 .authScheme("authScheme")
                 .clientPasswordAuthType("clientPasswordAuthType")
                 .description("description")
                 .iamAuth("iamAuth")
                 .secretArn("secretArn")
                 .build()))
         .debugLogging(false)
         .defaultAuthScheme("defaultAuthScheme")
         .endpointNetworkType("endpointNetworkType")
         .idleClientTimeout(123)
         .requireTls(false)
         .tags(List.of(TagFormatProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetConnectionNetworkType("targetConnectionNetworkType")
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDBProxyProps.Builder	A builder for CfnDBProxyProps
static final class	CfnDBProxyProps.Jsii$Proxy	An implementation for CfnDBProxyProps

Method Summary

Modifier and Type	Method	Description
static CfnDBProxyProps.Builder	builder()
default Object	getAuth()	The authorization mechanism that the proxy uses.
String	getDbProxyName()	The identifier for the proxy.
default Object	getDebugLogging()	Specifies whether the proxy logs detailed connection and query information.
default String	getDefaultAuthScheme()	The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
default String	getEndpointNetworkType()	The network type of the DB proxy endpoint.
String	getEngineFamily()	The kinds of databases that the proxy can connect to.
default Number	getIdleClientTimeout()	The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
default Object	getRequireTls()	Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
Object	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
default List<CfnDBProxy.TagFormatProperty>	getTags()	An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
default String	getTargetConnectionNetworkType()	The network type that the proxy uses to connect to the target database.
default List<Object>	getVpcSecurityGroupIds()	One or more VPC security group IDs to associate with the new proxy.
List<Object>	getVpcSubnetIds()	One or more VPC subnet IDs to associate with the new proxy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDbProxyName

@Stability(Stable)
@NotNull
String getDbProxyName()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-dbproxyname

getEngineFamily

@Stability(Stable)
@NotNull
String getEngineFamily()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-enginefamily

getRoleArn

@Stability(Stable)
@NotNull
Object getRoleArn()

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

Returns union: either String or IRoleRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-rolearn

getVpcSubnetIds

@Stability(Stable)
@NotNull
List<Object> getVpcSubnetIds()

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

Returns union: Listinvalid input: '<'either String or ISubnetRef>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-vpcsubnetids

getAuth

@Stability(Stable)
@Nullable
default Object getAuth()

The authorization mechanism that the proxy uses.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDBProxy.AuthFormatProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-auth

getDebugLogging

@Stability(Stable)
@Nullable
default Object getDebugLogging()

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.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-debuglogging

getDefaultAuthScheme

@Stability(Stable)
@Nullable
default String getDefaultAuthScheme()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-defaultauthscheme

getEndpointNetworkType

@Stability(Stable)
@Nullable
default String getEndpointNetworkType()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-endpointnetworktype

getIdleClientTimeout

@Stability(Stable)
@Nullable
default Number getIdleClientTimeout()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-idleclienttimeout

getRequireTls

@Stability(Stable)
@Nullable
default Object getRequireTls()

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.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-requiretls

getTags

@Stability(Stable)
@Nullable
default List<CfnDBProxy.TagFormatProperty> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-tags

getTargetConnectionNetworkType

@Stability(Stable)
@Nullable
default String getTargetConnectionNetworkType()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-targetconnectionnetworktype

getVpcSecurityGroupIds

@Stability(Stable)
@Nullable
default List<Object> getVpcSecurityGroupIds()

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.

Returns union: Listinvalid input: '<'either String or ISecurityGroupRef>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-vpcsecuritygroupids

builder

@Stability(Stable)
static CfnDBProxyProps.Builder builder()

Returns:

a CfnDBProxyProps.Builder of CfnDBProxyProps