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.97.0 (build 729de35)",
           date="2024-04-18T17:54:23.333Z")
@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()
         .auth(List.of(AuthFormatProperty.builder()
                 .authScheme("authScheme")
                 .clientPasswordAuthType("clientPasswordAuthType")
                 .description("description")
                 .iamAuth("iamAuth")
                 .secretArn("secretArn")
                 .build()))
         .dbProxyName("dbProxyName")
         .engineFamily("engineFamily")
         .roleArn("roleArn")
         .vpcSubnetIds(List.of("vpcSubnetIds"))
         // the properties below are optional
         .debugLogging(false)
         .idleClientTimeout(123)
         .requireTls(false)
         .tags(List.of(TagFormatProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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()
Object	getAuth()	The authorization mechanism that the proxy uses.
String	getDbProxyName()	The identifier for the proxy.
default Object	getDebugLogging()	Specifies whether the proxy includes detailed information about SQL statements in its logs.
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.
String	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 List<String>	getVpcSecurityGroupIds()	One or more VPC security group IDs to associate with the new proxy.
List<String>	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

getAuth

@Stability(Stable)
@NotNull
Object getAuth()

The authorization mechanism that the proxy uses.

See Also:

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

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 .

Valid Values : MYSQL | POSTGRESQL | SQLSERVER

See Also:

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

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

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

See Also:

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

getVpcSubnetIds

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

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

See Also:

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

getDebugLogging

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

Specifies whether the proxy includes detailed information about SQL statements in its logs.

This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

See Also:

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

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.

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

getVpcSecurityGroupIds

@Stability(Stable)
@Nullable
default List<String> 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.

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