Package software.amazon.awscdk.services.rds

Interface IDatabaseProxy.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, IDatabaseProxy, IDBProxyRef, IDBProxyRef.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IDatabaseProxy.Jsii$Proxy

Enclosing interface:

IDatabaseProxy

@Internal
public static interface IDatabaseProxy.Jsii$Default
extends IDatabaseProxy, IResource.Jsii$Default, IDBProxyRef.Jsii$Default

Internal default implementation for IDatabaseProxy.

Nested Class Summary

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.IDatabaseProxy

IDatabaseProxy.Jsii$Default, IDatabaseProxy.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.rds.IDBProxyRef

IDBProxyRef.Jsii$Default, IDBProxyRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

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

IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$Proxy

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

IResource.Jsii$Default, IResource.Jsii$Proxy

Method Summary

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

Methods inherited from interface software.constructs.IConstruct.Jsii$Default

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.rds.IDBProxyRef.Jsii$Default

getDbProxyRef

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware.Jsii$Default

getEnv

Methods inherited from interface software.amazon.awscdk.IResource.Jsii$Default

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDbProxyArn

@Stability(Stable)
@NotNull
default String getDbProxyArn()

DB Proxy ARN.

Specified by:

getDbProxyArn in interface IDatabaseProxy

getDbProxyName

@Stability(Stable)
@NotNull
default String getDbProxyName()

DB Proxy Name.

Specified by:

getDbProxyName in interface IDatabaseProxy

getEndpoint

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

Endpoint.

Specified by:

getEndpoint in interface IDatabaseProxy

grantConnect

@Stability(Stable)
@NotNull
default 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

Specified by:

grantConnect in interface IDatabaseProxy

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
default 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

Specified by:

grantConnect in interface IDatabaseProxy

Parameters:

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