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, IEnvironmentAware, IDBProxyRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:43.736Z") @Stability(Stable) public class CfnDBProxy extends CfnResource implements IInspectable, IDBProxyRef, 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")
         .dbProxyName("dbProxyName")
         .engineFamily("engineFamily")
         .roleArn("roleArn")
         .vpcSubnetIds(List.of("vpcSubnetIds"))
         // the properties below are optional
         .auth(List.of(AuthFormatProperty.builder()
                 .authScheme("authScheme")
                 .clientPasswordAuthType("clientPasswordAuthType")
                 .description("description")
                 .iamAuth("iamAuth")
                 .secretArn("secretArn")
                 .build()))
         .debugLogging(false)
         .defaultAuthScheme("defaultAuthScheme")
         .endpointNetworkType("endpointNetworkType")
         .idleClientTimeout(123)
         .requireTls(false)
         .tags(List.of(TagFormatProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetConnectionNetworkType("targetConnectionNetworkType")
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .build();

See Also:

  • 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)
      Create a new AWS::RDS::DBProxy.

      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

    • arnForDBProxy

      @Stability(Stable) @NotNull public static String arnForDBProxy(@NotNull IDBProxyRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnDBProxy

      @Stability(Stable) @NotNull public static Boolean isCfnDBProxy(@NotNull Object x)
      Checks whether the given object is a CfnDBProxy.

      Parameters:
      x - This parameter is required.

    • 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

    • getDbProxyRef

      @Stability(Stable) @NotNull public DBProxyReference getDbProxyRef()
      A reference to a DBProxy resource.
      Specified by:
      getDbProxyRef in interface IDBProxyRef

    • 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.

    • getAuth

      @Stability(Stable) @Nullable public Object getAuth()
      The authorization mechanism that the proxy uses.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDBProxy.AuthFormatProperty>

    • setAuth

      @Stability(Stable) public void setAuth(@Nullable IResolvable value)
      The authorization mechanism that the proxy uses.

    • setAuth

      @Stability(Stable) public void setAuth(@Nullable List<Object> value)
      The authorization mechanism that the proxy uses.

    • getDebugLogging

      @Stability(Stable) @Nullable public Object getDebugLogging()
      Specifies whether the proxy logs detailed connection and query information.

      Returns union: either Boolean or IResolvable

    • setDebugLogging

      @Stability(Stable) public void setDebugLogging(@Nullable Boolean value)
      Specifies whether the proxy logs detailed connection and query information.

    • setDebugLogging

      @Stability(Stable) public void setDebugLogging(@Nullable IResolvable value)
      Specifies whether the proxy logs detailed connection and query information.

    • getDefaultAuthScheme

      @Stability(Stable) @Nullable public String getDefaultAuthScheme()
      The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.

    • setDefaultAuthScheme

      @Stability(Stable) public void setDefaultAuthScheme(@Nullable String value)
      The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.

    • getEndpointNetworkType

      @Stability(Stable) @Nullable public String getEndpointNetworkType()
      The network type of the DB proxy endpoint.

    • setEndpointNetworkType

      @Stability(Stable) public void setEndpointNetworkType(@Nullable String value)
      The network type of the DB proxy endpoint.

    • 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.

      Returns union: either Boolean or IResolvable

    • 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.

    • getTargetConnectionNetworkType

      @Stability(Stable) @Nullable public String getTargetConnectionNetworkType()
      The network type that the proxy uses to connect to the target database.

    • setTargetConnectionNetworkType

      @Stability(Stable) public void setTargetConnectionNetworkType(@Nullable String value)
      The network type that the proxy uses to connect to the target database.

    • 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.