software.amazon.awscdk.services.rds

Class DatabaseProxy

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.rds.DatabaseProxy

All Implemented Interfaces:

IConstruct, IDependable, IResource, IConnectable, IDatabaseProxy, ISecretAttachmentTarget

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:51.241Z")
public class DatabaseProxy
extends Resource
implements IConnectable, ISecretAttachmentTarget, IDatabaseProxy

RDS Database Proxy.

Example:

 Vpc vpc;
 DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
         .engine(DatabaseClusterEngine.AURORA)
         .instanceProps(InstanceProps.builder().vpc(vpc).build())
         .build();
 DatabaseProxy proxy = DatabaseProxy.Builder.create(this, "Proxy")
         .proxyTarget(ProxyTarget.fromCluster(cluster))
         .secrets(List.of(cluster.getSecret()))
         .vpc(vpc)
         .build();
 Role role = Role.Builder.create(this, "DBProxyRole").assumedBy(new AccountPrincipal(this.account)).build();
 proxy.grantConnect(role, "admin");
 

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IConnectable

IConnectable.Jsii$Default, IConnectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.secretsmanager.ISecretAttachmentTarget

ISecretAttachmentTarget.Jsii$Default, ISecretAttachmentTarget.Jsii$Proxy

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

IDatabaseProxy.Jsii$Default, IDatabaseProxy.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DatabaseProxy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DatabaseProxy(software.amazon.jsii.JsiiObjectRef objRef)
	DatabaseProxy(software.constructs.Construct scope, java.lang.String id, DatabaseProxyProps props)

Method Summary

Modifier and Type	Method and Description
SecretAttachmentTargetProps	asSecretAttachmentTarget() Renders the secret attachment target specifications.
static IDatabaseProxy	fromDatabaseProxyAttributes(software.constructs.Construct scope, java.lang.String id, DatabaseProxyAttributes attrs) Import an existing database proxy.
Connections	getConnections() Access to network connections.
java.lang.String	getDbProxyArn() DB Proxy ARN.
java.lang.String	getDbProxyName() DB Proxy Name.
java.lang.String	getEndpoint() Endpoint.
Grant	grantConnect(IGrantable grantee) Grant the given identity connection access to the proxy.
Grant	grantConnect(IGrantable grantee, java.lang.String dbUser) Grant the given identity connection access to the proxy.

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

DatabaseProxy

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

DatabaseProxy

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

DatabaseProxy

public DatabaseProxy(software.constructs.Construct scope,
                     java.lang.String id,
                     DatabaseProxyProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromDatabaseProxyAttributes

public static IDatabaseProxy fromDatabaseProxyAttributes(software.constructs.Construct scope,
                                                         java.lang.String id,
                                                         DatabaseProxyAttributes attrs)

Import an existing database proxy.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

asSecretAttachmentTarget

public SecretAttachmentTargetProps asSecretAttachmentTarget()

Renders the secret attachment target specifications.

Specified by:

asSecretAttachmentTarget in interface ISecretAttachmentTarget

grantConnect

public Grant grantConnect(IGrantable grantee,
                          java.lang.String dbUser)

Grant the given identity connection access to the proxy.

Specified by:

grantConnect in interface IDatabaseProxy

Parameters:

grantee - This parameter is required.

dbUser -

grantConnect

public Grant grantConnect(IGrantable grantee)

Grant the given identity connection access to the proxy.

Specified by:

grantConnect in interface IDatabaseProxy

Parameters:

grantee - This parameter is required.

getConnections

public Connections getConnections()

Access to network connections.

Specified by:

getConnections in interface IConnectable

getDbProxyArn

public java.lang.String getDbProxyArn()

DB Proxy ARN.

Specified by:

getDbProxyArn in interface IDatabaseProxy

getDbProxyName

public java.lang.String getDbProxyName()

DB Proxy Name.

Specified by:

getDbProxyName in interface IDatabaseProxy

getEndpoint

public java.lang.String getEndpoint()

Endpoint.

Specified by:

getEndpoint in interface IDatabaseProxy