interface IDatabaseProxy

Language	Type name
.NET	Amazon.CDK.AWS.RDS.IDatabaseProxy
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsrds#IDatabaseProxy
Java	software.amazon.awscdk.services.rds.IDatabaseProxy
Python	aws_cdk.aws_rds.IDatabaseProxy
TypeScript (source)	aws-cdk-lib » aws_rds » IDatabaseProxy

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IDBProxyRef

Implemented by DatabaseProxy

Obtainable from DatabaseProxy.fromDatabaseProxyAttributes()

DB Proxy.

Properties

Name	Type	Description
dbProxyArn	string	DB Proxy ARN.
dbProxyName	string	DB Proxy Name.
dbProxyRef🔹	DBProxyReference	A reference to a DBProxy resource.
endpoint	string	Endpoint.
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

dbProxyArn

Type: string

DB Proxy ARN.

---

dbProxyName

Type: string

DB Proxy Name.

---

dbProxyRef🔹

Type: DBProxyReference

A reference to a DBProxy resource.

---

endpoint

Type: string

Endpoint.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
grantConnect(grantee, dbUser?)	Grant the given identity connection access to the proxy.
with(...mixins)	Applies one or more mixins to this construct.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

grantConnect(grantee, dbUser?)

public grantConnect(grantee: IGrantable, dbUser?: string): Grant

Parameters

• grantee IGrantable — the Principal to grant the permissions to.
• dbUser string — the name of the database user to allow connecting as to the proxy.

Returns

• Grant

Grant the given identity connection access to the proxy.

---

with(...mixins)

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin — The mixins to apply.

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.