IDatabaseProxy

class aws_cdk.aws_rds.IDatabaseProxy(*args, **kwds)

Bases: IResource, Protocol

DB Proxy.

Methods

apply_removal_policy(policy)

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).

Parameters

policy (RemovalPolicy) –

Return type

None

grant_connect(grantee, db_user=None)

Grant the given identity connection access to the proxy.

Parameters
  • grantee (IGrantable) – the Principal to grant the permissions to.

  • db_user (Optional[str]) – the name of the database user to allow connecting as to the proxy.

Default

Return type

Grant

  • if the Proxy had been provided a single Secret value,

the user will be taken from that Secret

Attributes

db_proxy_arn

DB Proxy ARN.

Attribute

true

db_proxy_name

DB Proxy Name.

Attribute

true

endpoint

Endpoint.

Attribute

true

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node

The construct tree node for this construct.

stack

The stack in which this resource is defined.