Package software.amazon.awscdk.services.rds

Class CfnDBProxyEndpoint

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.CfnDBProxyEndpoint
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IDBProxyEndpointRef, 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.740Z") @Stability(Stable) public class CfnDBProxyEndpoint extends CfnResource implements IInspectable, IDBProxyEndpointRef, ITaggableV2
The AWS::RDS::DBProxyEndpoint resource creates or updates a DB proxy endpoint.

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

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.*;
 CfnDBProxyEndpoint cfnDBProxyEndpoint = CfnDBProxyEndpoint.Builder.create(this, "MyCfnDBProxyEndpoint")
         .dbProxyEndpointName("dbProxyEndpointName")
         .dbProxyName("dbProxyName")
         .vpcSubnetIds(List.of("vpcSubnetIds"))
         // the properties below are optional
         .endpointNetworkType("endpointNetworkType")
         .tags(List.of(TagFormatProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetRole("targetRole")
         .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

    • CfnDBProxyEndpoint

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

    • CfnDBProxyEndpoint

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

    • CfnDBProxyEndpoint

      @Stability(Stable) public CfnDBProxyEndpoint(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDBProxyEndpointProps props)
      Create a new AWS::RDS::DBProxyEndpoint.

      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

    • arnForDBProxyEndpoint

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

    • isCfnDBProxyEndpoint

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

      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.

    • getAttrDbProxyEndpointArn

      @Stability(Stable) @NotNull public String getAttrDbProxyEndpointArn()
      The Amazon Resource Name (ARN) for the DB proxy endpoint.

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

    • getAttrIsDefault

      @Stability(Stable) @NotNull public IResolvable getAttrIsDefault()
      Indicates whether this endpoint is the default endpoint for the associated DB proxy.

      Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.

    • getAttrVpcId

      @Stability(Stable) @NotNull public String getAttrVpcId()
      Provides the VPC ID of the DB proxy endpoint.

    • 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

    • getDbProxyEndpointRef

      @Stability(Stable) @NotNull public DBProxyEndpointReference getDbProxyEndpointRef()
      A reference to a DBProxyEndpoint resource.
      Specified by:
      getDbProxyEndpointRef in interface IDBProxyEndpointRef

    • getDbProxyEndpointName

      @Stability(Stable) @NotNull public String getDbProxyEndpointName()
      The name of the DB proxy endpoint to create.

    • setDbProxyEndpointName

      @Stability(Stable) public void setDbProxyEndpointName(@NotNull String value)
      The name of the DB proxy endpoint to create.

    • getDbProxyName

      @Stability(Stable) @NotNull public String getDbProxyName()
      The name of the DB proxy associated with the DB proxy endpoint that you create.

    • setDbProxyName

      @Stability(Stable) public void setDbProxyName(@NotNull String value)
      The name of the DB proxy associated with the DB proxy endpoint that you create.

    • getVpcSubnetIds

      @Stability(Stable) @NotNull public List<String> getVpcSubnetIds()
      The VPC subnet IDs for the DB proxy endpoint that you create.

    • setVpcSubnetIds

      @Stability(Stable) public void setVpcSubnetIds(@NotNull List<String> value)
      The VPC subnet IDs for the DB proxy endpoint that you create.

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

    • getTags

      @Stability(Stable) @Nullable public List<CfnDBProxyEndpoint.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<CfnDBProxyEndpoint.TagFormatProperty> value)
      An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

    • getTargetRole

      @Stability(Stable) @Nullable public String getTargetRole()
      A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

    • setTargetRole

      @Stability(Stable) public void setTargetRole(@Nullable String value)
      A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

    • getVpcSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getVpcSecurityGroupIds()
      The VPC security group IDs for the DB proxy endpoint that you create.

    • setVpcSecurityGroupIds

      @Stability(Stable) public void setVpcSecurityGroupIds(@Nullable List<String> value)
      The VPC security group IDs for the DB proxy endpoint that you create.