Package software.amazon.awscdk.services.rds

Class CfnDBProxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.rds.CfnDBProxy

All Implemented Interfaces:

IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:25.871Z")
@Stability(Stable)
public class CfnDBProxy
extends CfnResource
implements IInspectable, ITaggableV2

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 in the Amazon RDS User Guide .

For information about RDS Proxy for Amazon Aurora, see Managing Connections with Amazon RDS Proxy 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 in the Amazon RDS User Guide .

For information about that apply to RDS Proxy for Amazon Aurora, see Limitations for RDS Proxy in the Amazon Aurora User Guide .

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.*;
 CfnDBProxy cfnDBProxy = CfnDBProxy.Builder.create(this, "MyCfnDBProxy")
         .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	Class	Description
static interface	CfnDBProxy.AuthFormatProperty	Specifies the details of authentication used by a proxy to log in as a specific database user.
static final class	CfnDBProxy.Builder	A fluent builder for CfnDBProxy.
static interface	CfnDBProxy.TagFormatProperty	Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDBProxy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDBProxy(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDBProxy(software.constructs.Construct scope, String id, CfnDBProxyProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrDbProxyArn()	The Amazon Resource Name (ARN) for the proxy.
String	getAttrEndpoint()	The endpoint that you can use to connect to the DB proxy.
String	getAttrVpcId()	The VPC ID to associate with the DB proxy.
Object	getAuth()	The authorization mechanism that the proxy uses.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getDbProxyName()	The identifier for the proxy.
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.
Number	getIdleClientTimeout()	The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
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.
List<CfnDBProxy.TagFormatProperty>	getTags()	An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
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.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAuth(List<Object> value)	The authorization mechanism that the proxy uses.
void	setAuth(IResolvable value)	The authorization mechanism that the proxy uses.
void	setDbProxyName(String value)	The identifier for the proxy.
void	setDebugLogging(Boolean value)	Specifies whether the proxy includes detailed information about SQL statements in its logs.
void	setDebugLogging(IResolvable value)	Specifies whether the proxy includes detailed information about SQL statements in its logs.
void	setEngineFamily(String value)	The kinds of databases that the proxy can connect to.
void	setIdleClientTimeout(Number value)	The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
void	setRequireTls(Boolean value)	Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
void	setRequireTls(IResolvable value)	Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
void	setRoleArn(String value)	The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
void	setTags(List<CfnDBProxy.TagFormatProperty> value)	An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
void	setVpcSecurityGroupIds(List<String> value)	One or more VPC security group IDs to associate with the new proxy.
void	setVpcSubnetIds(List<String> value)	One or more VPC subnet IDs to associate with the new proxy.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDBProxy

protected CfnDBProxy(software.amazon.jsii.JsiiObjectRef objRef)

CfnDBProxy

protected CfnDBProxy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDBProxy

@Stability(Stable)
public CfnDBProxy(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDBProxyProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDbProxyArn

@Stability(Stable)
@NotNull
public String getAttrDbProxyArn()

The Amazon Resource Name (ARN) for the proxy.

getAttrEndpoint

@Stability(Stable)
@NotNull
public String getAttrEndpoint()

The endpoint that you can use to connect to the DB proxy.

You include the endpoint value in the connection string for a database client application.

getAttrVpcId

@Stability(Stable)
@NotNull
public String getAttrVpcId()

The VPC ID to associate with the DB proxy.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAuth

@Stability(Stable)
@NotNull
public Object getAuth()

The authorization mechanism that the proxy uses.

setAuth

@Stability(Stable)
public void setAuth(@NotNull
 IResolvable value)

The authorization mechanism that the proxy uses.

setAuth

@Stability(Stable)
public void setAuth(@NotNull
 List<Object> value)

The authorization mechanism that the proxy uses.

getDbProxyName

@Stability(Stable)
@NotNull
public String getDbProxyName()

The identifier for the proxy.

setDbProxyName

@Stability(Stable)
public void setDbProxyName(@NotNull
 String value)

The identifier for the proxy.

getEngineFamily

@Stability(Stable)
@NotNull
public String getEngineFamily()

The kinds of databases that the proxy can connect to.

setEngineFamily

@Stability(Stable)
public void setEngineFamily(@NotNull
 String value)

The kinds of databases that the proxy can connect to.

getRoleArn

@Stability(Stable)
@NotNull
public String getRoleArn()

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

setRoleArn

@Stability(Stable)
public void setRoleArn(@NotNull
 String value)

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

getVpcSubnetIds

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

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

setVpcSubnetIds

@Stability(Stable)
public void setVpcSubnetIds(@NotNull
 List<String> value)

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

getDebugLogging

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

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

setDebugLogging

@Stability(Stable)
public void setDebugLogging(@Nullable
 Boolean value)

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

setDebugLogging

@Stability(Stable)
public void setDebugLogging(@Nullable
 IResolvable value)

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

getIdleClientTimeout

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

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.

setIdleClientTimeout

@Stability(Stable)
public void setIdleClientTimeout(@Nullable
 Number value)

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.

getRequireTls

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

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

setRequireTls

@Stability(Stable)
public void setRequireTls(@Nullable
 Boolean value)

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

setRequireTls

@Stability(Stable)
public void setRequireTls(@Nullable
 IResolvable value)

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

getTags

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

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

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnDBProxy.TagFormatProperty> value)

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

getVpcSecurityGroupIds

@Stability(Stable)
@Nullable
public List<String> getVpcSecurityGroupIds()

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

setVpcSecurityGroupIds

@Stability(Stable)
public void setVpcSecurityGroupIds(@Nullable
 List<String> value)

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