CfnDBProxy

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.rds.CfnDBProxy

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:36.980Z")
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")
                 .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();

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 interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnDBProxy(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrDbProxyArn()` The Amazon Resource Name (ARN) representing the target group.
`java.lang.String`	`getAttrEndpoint()` The writer endpoint for the RDS DB instance or Aurora DB cluster.
`java.lang.String`	`getAttrVpcId()` The VPC ID to associate with the DB proxy.
`java.lang.Object`	`getAuth()` The authorization mechanism that the proxy uses.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getDbProxyName()` The identifier for the proxy.
`java.lang.Object`	`getDebugLogging()` Whether the proxy includes detailed information about SQL statements in its logs.
`java.lang.String`	`getEngineFamily()` The kinds of databases that the proxy can connect to.
`java.lang.Number`	`getIdleClientTimeout()` The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
`java.lang.Object`	`getRequireTls()` A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
`java.lang.String`	`getRoleArn()` The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
`java.util.List<CfnDBProxy.TagFormatProperty>`	`getTags()` An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
`java.util.List<java.lang.String>`	`getVpcSecurityGroupIds()` One or more VPC security group IDs to associate with the new proxy.
`java.util.List<java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAuth(IResolvable value)` The authorization mechanism that the proxy uses.
`void`	`setAuth(java.util.List<java.lang.Object> value)` The authorization mechanism that the proxy uses.
`void`	`setDbProxyName(java.lang.String value)` The identifier for the proxy.
`void`	`setDebugLogging(java.lang.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(java.lang.String value)` The kinds of databases that the proxy can connect to.
`void`	`setIdleClientTimeout(java.lang.Number value)` The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
`void`	`setRequireTls(java.lang.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(java.lang.String value)` The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
`void`	`setTags(java.util.List<CfnDBProxy.TagFormatProperty> value)` An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
`void`	`setVpcSecurityGroupIds(java.util.List<java.lang.String> value)` One or more VPC security group IDs to associate with the new proxy.
`void`	`setVpcSubnetIds(java.util.List<java.lang.String> value)` One or more VPC subnet IDs to associate with the new proxy.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnDBProxy(Construct scope,
                  java.lang.String id,
                  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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrDbProxyArn
```
public java.lang.String getAttrDbProxyArn()
```
    The Amazon Resource Name (ARN) representing the target group.
  - getAttrEndpoint
```
public java.lang.String getAttrEndpoint()
```
    The writer endpoint for the RDS DB instance or Aurora DB cluster.
  - getAttrVpcId
```
public java.lang.String getAttrVpcId()
```
    The VPC ID to associate with the DB proxy.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getAuth
```
public java.lang.Object getAuth()
```
    The authorization mechanism that the proxy uses.
  - setAuth
```
public void setAuth(IResolvable value)
```
    The authorization mechanism that the proxy uses.
  - setAuth
```
public void setAuth(java.util.List<java.lang.Object> value)
```
    The authorization mechanism that the proxy uses.
  - getDbProxyName
```
public java.lang.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
```
public void setDbProxyName(java.lang.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
```
public java.lang.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
  - setEngineFamily
```
public void setEngineFamily(java.lang.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. 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
  - getRoleArn
```
public java.lang.String getRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
  - setRoleArn
```
public void setRoleArn(java.lang.String value)
```
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
  - getVpcSubnetIds
```
public java.util.List<java.lang.String> getVpcSubnetIds()
```
    One or more VPC subnet IDs to associate with the new proxy.
  - setVpcSubnetIds
```
public void setVpcSubnetIds(java.util.List<java.lang.String> value)
```
    One or more VPC subnet IDs to associate with the new proxy.
  - getDebugLogging
```
public java.lang.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
```
public void setDebugLogging(java.lang.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
```
public void setDebugLogging(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
```
public java.lang.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
```
public void setIdleClientTimeout(java.lang.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
```
public java.lang.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
```
public void setRequireTls(java.lang.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
```
public void setRequireTls(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
```
public java.util.List<CfnDBProxy.TagFormatProperty> getTags()
```
    An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
  - setTags
```
public void setTags(java.util.List<CfnDBProxy.TagFormatProperty> value)
```
    An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
  - getVpcSecurityGroupIds
```
public java.util.List<java.lang.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
```
public void setVpcSecurityGroupIds(java.util.List<java.lang.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.

Class CfnDBProxy

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnDBProxy

CfnDBProxy

CfnDBProxy

Method Detail

inspect

renderProperties

getAttrDbProxyArn

getAttrEndpoint

getAttrVpcId

getCfnProperties

getAuth

setAuth

setAuth

getDbProxyName

setDbProxyName

getEngineFamily

setEngineFamily

getRoleArn

setRoleArn

getVpcSubnetIds

setVpcSubnetIds

getDebugLogging

setDebugLogging

setDebugLogging

getIdleClientTimeout

setIdleClientTimeout

getRequireTls

setRequireTls

setRequireTls

getTags

setTags

getVpcSecurityGroupIds

setVpcSecurityGroupIds