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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.415Z")
 @Stability(value=Stable)
public class CfnDBProxy
extends CfnResource
implements IInspectable

A CloudFormation `AWS::RDS::DBProxy`.

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")
                 .description("description")
                 .iamAuth("iamAuth")
                 .secretArn("secretArn")
                 .userName("userName")
                 .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnDBProxy.AuthFormatProperty Specifies the details of authentication used by a proxy to log in as a specific database user.
static class	CfnDBProxy.Builder A fluent builder for CfnDBProxy.
static interface	CfnDBProxy.TagFormatProperty Metadata assigned to a DB proxy 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.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDBProxy(software.constructs.Construct scope, String id, CfnDBProxyProps props) Create a new `AWS::RDS::DBProxy`.
protected	CfnDBProxy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDBProxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrDbProxyArn() The Amazon Resource Name (ARN) representing the target group.
String	getAttrEndpoint() The writer endpoint for the RDS DB instance or Aurora DB cluster.
Object	getAuth() The authorization mechanism that the proxy uses.
protected Map<String,Object>	getCfnProperties()
String	getDbProxyName() The identifier for the proxy.
Object	getDebugLogging() 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() A Boolean parameter that 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(IResolvable value) The authorization mechanism that the proxy uses.
void	setAuth(List<Object> value) The authorization mechanism that the proxy uses.
void	setDbProxyName(String value) The identifier for the proxy.
void	setDebugLogging(Boolean value) Whether the proxy includes detailed information about SQL statements in its logs.
void	setDebugLogging(IResolvable value) 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) A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
void	setRequireTls(IResolvable value) A Boolean parameter that 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, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDBProxy

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

CfnDBProxy

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

CfnDBProxy

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

Create a new `AWS::RDS::DBProxy`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrDbProxyArn()

The Amazon Resource Name (ARN) representing the target group.

getAttrEndpoint

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

The writer endpoint for the RDS DB instance or Aurora DB cluster.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getAuth

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

The authorization mechanism that the proxy uses.

setAuth

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

The authorization mechanism that the proxy uses.

setAuth

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

The authorization mechanism that the proxy uses.

getDbProxyName

@Stability(value=Stable)
 @NotNull
public 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.

setDbProxyName

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

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.

getEngineFamily

@Stability(value=Stable)
 @NotNull
public 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. The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

Valid values : MYSQL | POSTGRESQL

setEngineFamily

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

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. The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

Valid values : MYSQL | POSTGRESQL

getRoleArn

@Stability(value=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(value=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(value=Stable)
 @NotNull
public List<String> getVpcSubnetIds()

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

setVpcSubnetIds

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

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

getDebugLogging

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

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.

setDebugLogging

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

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.

setDebugLogging

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

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.

getIdleClientTimeout

@Stability(value=Stable)
 @Nullable
public 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.

setIdleClientTimeout

@Stability(value=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.

You can set this value higher or lower than the connection timeout limit for the associated database.

getRequireTls

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

A Boolean parameter that 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.

setRequireTls

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

A Boolean parameter that 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.

setRequireTls

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

A Boolean parameter that 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.

getTags

@Stability(value=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(value=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(value=Stable)
 @Nullable
public 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.

setVpcSecurityGroupIds

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

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.