DatabaseProxyEndpoint

class aws_cdk.aws_rds.DatabaseProxyEndpoint(scope, id, *, db_proxy, vpc, db_proxy_endpoint_name=None, security_groups=None, target_role=None, vpc_subnets=None)

Bases: Resource

RDS Database Proxy Endpoint.

Resource:: AWS::RDS::DBProxyEndpoint
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2
from aws_cdk import aws_rds as rds

# database_proxy: rds.DatabaseProxy
# security_group: ec2.SecurityGroup
# subnet: ec2.Subnet
# subnet_filter: ec2.SubnetFilter
# vpc: ec2.Vpc

database_proxy_endpoint = rds.DatabaseProxyEndpoint(self, "MyDatabaseProxyEndpoint",
    db_proxy=database_proxy,
    vpc=vpc,

    # the properties below are optional
    db_proxy_endpoint_name="dbProxyEndpointName",
    security_groups=[security_group],
    target_role=rds.ProxyEndpointTargetRole.READ_WRITE,
    vpc_subnets=ec2.SubnetSelection(
        availability_zones=["availabilityZones"],
        one_per_az=False,
        subnet_filters=[subnet_filter],
        subnet_group_name="subnetGroupName",
        subnets=[subnet],
        subnet_type=ec2.SubnetType.PRIVATE_ISOLATED
    )
)

Parameters:

scope (Construct)
id (str)
db_proxy (IDatabaseProxy) – The DB proxy associated with the DB proxy endpoint.
vpc (IVpc) – The VPC of the DB proxy endpoint.
db_proxy_endpoint_name (Optional[str]) – The name of the DB proxy endpoint. Default: - a CDK generated name
security_groups (Optional[Sequence[ISecurityGroup]]) – The VPC security groups to associate with the new proxy endpoint. Default: - Default security group for the VPC
target_role (Optional[ProxyEndpointTargetRole]) – A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. Default: - ProxyEndpointTargetRole.READ_WRITE
vpc_subnets (Union[SubnetSelection, Dict[str, Any], None]) – The subnets of DB proxy endpoint. Default: - the VPC default strategy if not specified.

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

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

PROPERTY_INJECTION_ID = 'aws-cdk-lib.aws-rds.DatabaseProxyEndpoint'

db_proxy_endpoint_arn

DB Proxy Endpoint ARN.

Attribute:: true

db_proxy_endpoint_name

DB Proxy Endpoint Name.

Attribute:: true

endpoint

The endpoint that you can use to connect to the DB proxy.

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 tree node.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_database_proxy_endpoint_attributes(scope, id, *, db_proxy_endpoint_arn, db_proxy_endpoint_name, endpoint)

Import an existing database proxy endpoint.

Parameters:

scope (Construct)
id (str)
db_proxy_endpoint_arn (str) – DB Proxy Endpoint ARN.
db_proxy_endpoint_name (str) – DB Proxy Endpoint Name.
endpoint (str) – The endpoint that you can use to connect to the DB proxy.

Return type:

IDatabaseProxyEndpoint

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool