Package software.amazon.awscdk.mixins.preview.services.rds.mixins

Class CfnDBProxyPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.mixins.preview.services.rds.mixins.CfnDBProxyPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDBProxyPropsMixin>

Enclosing class:

CfnDBProxyPropsMixin

@Stability(Stable)
public static final class CfnDBProxyPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDBProxyPropsMixin>

A fluent builder for CfnDBProxyPropsMixin.

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnDBProxyPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnDBProxyPropsMixin.Builder.

create

@Stability(Stable)
public static CfnDBProxyPropsMixin.Builder create()

Returns:

a new instance of CfnDBProxyPropsMixin.Builder.

auth

@Stability(Stable)
public CfnDBProxyPropsMixin.Builder auth(IResolvable auth)

The authorization mechanism that the proxy uses.

Parameters:

auth - The authorization mechanism that the proxy uses. This parameter is required.

Returns:

this

See Also:

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

auth

@Stability(Stable)
public CfnDBProxyPropsMixin.Builder auth(List<? extends Object> auth)

The authorization mechanism that the proxy uses.

Parameters:

auth - The authorization mechanism that the proxy uses. This parameter is required.

Returns:

this

See Also:

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

dbProxyName

@Stability(Stable)
public CfnDBProxyPropsMixin.Builder dbProxyName(String dbProxyName)

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.

Parameters:

dbProxyName - The identifier for the proxy. This parameter is required.

Returns:

this

See Also:

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

debugLogging

@Stability(Stable)
public CfnDBProxyPropsMixin.Builder debugLogging(Boolean debugLogging)

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.

Parameters:

debugLogging - Specifies whether the proxy logs detailed connection and query information. This parameter is required.

Returns:

this

See Also:

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

debugLogging

@Stability(Stable)
public CfnDBProxyPropsMixin.Builder debugLogging(IResolvable debugLogging)

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.

Parameters:

debugLogging - Specifies whether the proxy logs detailed connection and query information. This parameter is required.

Returns:

this

See Also:

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

defaultAuthScheme

@Stability(Stable)
public CfnDBProxyPropsMixin.Builder defaultAuthScheme(String defaultAuthScheme)

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.

Parameters:

defaultAuthScheme - The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. This parameter is required.

Returns:

this

See Also:

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

endpointNetworkType

@Stability(Stable)
public CfnDBProxyPropsMixin.Builder endpointNetworkType(String endpointNetworkType)

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.

Parameters:

endpointNetworkType - The network type of the DB proxy endpoint. This parameter is required.

Returns:

this

See Also:

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

engineFamily

@Stability(Stable)
public CfnDBProxyPropsMixin.Builder engineFamily(String engineFamily)

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 .

Parameters:

engineFamily - The kinds of databases that the proxy can connect to. This parameter is required.

Returns:

this

See Also:

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

idleClientTimeout

@Stability(Stable)
public CfnDBProxyPropsMixin.Builder idleClientTimeout(Number idleClientTimeout)

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.

Parameters:

idleClientTimeout - The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. This parameter is required.

Returns:

this

See Also:

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

requireTls

@Stability(Stable)
public CfnDBProxyPropsMixin.Builder requireTls(Boolean requireTls)

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.

Parameters:

requireTls - Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. This parameter is required.

Returns:

this

See Also:

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

requireTls

@Stability(Stable)
public CfnDBProxyPropsMixin.Builder requireTls(IResolvable requireTls)

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.

Parameters:

requireTls - Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. This parameter is required.

Returns:

this

See Also:

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

roleArn

@Stability(Stable)
public CfnDBProxyPropsMixin.Builder roleArn(String roleArn)

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

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnDBProxyPropsMixin.Builder tags(List<? extends CfnDBProxyPropsMixin.TagFormatProperty> tags)

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

Parameters:

tags - An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy. This parameter is required.

Returns:

this

See Also:

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

targetConnectionNetworkType

@Stability(Stable)
public CfnDBProxyPropsMixin.Builder targetConnectionNetworkType(String targetConnectionNetworkType)

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.

Parameters:

targetConnectionNetworkType - The network type that the proxy uses to connect to the target database. This parameter is required.

Returns:

this

See Also:

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

vpcSecurityGroupIds

@Stability(Stable)
public CfnDBProxyPropsMixin.Builder vpcSecurityGroupIds(List<String> vpcSecurityGroupIds)

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.

Parameters:

vpcSecurityGroupIds - One or more VPC security group IDs to associate with the new proxy. This parameter is required.

Returns:

this

See Also:

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

vpcSubnetIds

@Stability(Stable)
public CfnDBProxyPropsMixin.Builder vpcSubnetIds(List<String> vpcSubnetIds)

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

Parameters:

vpcSubnetIds - One or more VPC subnet IDs to associate with the new proxy. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnDBProxyPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnDBProxyPropsMixin>

Returns:

a newly built instance of CfnDBProxyPropsMixin.