Package software.amazon.awscdk.services.rds

Class DatabaseProxyEndpoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.rds.DatabaseProxyEndpoint

All Implemented Interfaces:

IResource, IDatabaseProxyEndpoint, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-15T14:52:05.531Z")
@Stability(Stable)
public class DatabaseProxyEndpoint
extends Resource
implements IDatabaseProxyEndpoint

RDS Database Proxy Endpoint.

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.ec2.*;
 import software.amazon.awscdk.services.rds.*;
 DatabaseProxy databaseProxy;
 SecurityGroup securityGroup;
 Subnet subnet;
 SubnetFilter subnetFilter;
 Vpc vpc;
 DatabaseProxyEndpoint databaseProxyEndpoint = DatabaseProxyEndpoint.Builder.create(this, "MyDatabaseProxyEndpoint")
         .dbProxy(databaseProxy)
         .vpc(vpc)
         // the properties below are optional
         .dbProxyEndpointName("dbProxyEndpointName")
         .securityGroups(List.of(securityGroup))
         .targetRole(ProxyEndpointTargetRole.READ_WRITE)
         .vpcSubnets(SubnetSelection.builder()
                 .availabilityZones(List.of("availabilityZones"))
                 .onePerAz(false)
                 .subnetFilters(List.of(subnetFilter))
                 .subnetGroupName("subnetGroupName")
                 .subnets(List.of(subnet))
                 .subnetType(SubnetType.PRIVATE_ISOLATED)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DatabaseProxyEndpoint.Builder	A fluent builder for DatabaseProxyEndpoint.

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.services.rds.IDatabaseProxyEndpoint

IDatabaseProxyEndpoint.Jsii$Default, IDatabaseProxyEndpoint.Jsii$Proxy

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

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static IDatabaseProxyEndpoint	fromDatabaseProxyEndpointAttributes(software.constructs.Construct scope, String id, DatabaseProxyEndpointAttributes attrs)	Import an existing database proxy endpoint.
String	getDbProxyEndpointArn()	DB Proxy Endpoint ARN.
String	getDbProxyEndpointName()	DB Proxy Endpoint Name.
String	getEndpoint()	The endpoint that you can use to connect to the DB proxy.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

DatabaseProxyEndpoint

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

DatabaseProxyEndpoint

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

DatabaseProxyEndpoint

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromDatabaseProxyEndpointAttributes

@Stability(Stable)
@NotNull
public static IDatabaseProxyEndpoint fromDatabaseProxyEndpointAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 DatabaseProxyEndpointAttributes attrs)

Import an existing database proxy endpoint.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

getDbProxyEndpointArn

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

DB Proxy Endpoint ARN.

Specified by:

getDbProxyEndpointArn in interface IDatabaseProxyEndpoint

getDbProxyEndpointName

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

DB Proxy Endpoint Name.

Specified by:

getDbProxyEndpointName in interface IDatabaseProxyEndpoint

getEndpoint

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

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

Specified by:

getEndpoint in interface IDatabaseProxyEndpoint