Package software.amazon.awscdk.services.rds

Interface IDatabaseProxy

All Superinterfaces:

software.constructs.IConstruct, IDBProxyRef, software.constructs.IDependable, IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IDatabaseProxy.Jsii$Default

All Known Implementing Classes:

DatabaseProxy, IDatabaseProxy.Jsii$Proxy

@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)",
           date="2026-06-08T20:22:51.699Z")
@Stability(Stable)
public interface IDatabaseProxy
extends software.amazon.jsii.JsiiSerializable, IResource, IDBProxyRef

DB Proxy.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IDatabaseProxy.Jsii$Default	Internal default implementation for IDatabaseProxy.
static final class	IDatabaseProxy.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
String	getDbProxyArn()	DB Proxy ARN.
String	getDbProxyName()	DB Proxy Name.
String	getEndpoint()	Endpoint.
Grant	grantConnect(IGrantable grantee)	Grant the given identity connection access to the proxy.
Grant	grantConnect(IGrantable grantee, String dbUser)	Grant the given identity connection access to the proxy.

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.rds.IDBProxyRef

getDbProxyRef

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDbProxyArn

@Stability(Stable)
@NotNull
String getDbProxyArn()

DB Proxy ARN.

getDbProxyName

@Stability(Stable)
@NotNull
String getDbProxyName()

DB Proxy Name.

getEndpoint

@Stability(Stable)
@NotNull
String getEndpoint()

Endpoint.

grantConnect

@Stability(Stable)
@NotNull
Grant grantConnect(@NotNull
 IGrantable grantee,
 @Nullable
 String dbUser)

Grant the given identity connection access to the proxy.

Default: - if the Proxy had been provided a single Secret value, the user will be taken from that Secret

Parameters:

grantee - the Principal to grant the permissions to. This parameter is required.

dbUser - the name of the database user to allow connecting as to the proxy.

grantConnect

@Stability(Stable)
@NotNull
Grant grantConnect(@NotNull
 IGrantable grantee)

Grant the given identity connection access to the proxy.

Default: - if the Proxy had been provided a single Secret value, the user will be taken from that Secret

Parameters:

grantee - the Principal to grant the permissions to. This parameter is required.