DatabaseProxyEndpointProps

class aws_cdk.aws_rds.DatabaseProxyEndpointProps(*, vpc, db_proxy_endpoint_name=None, security_groups=None, target_role=None, vpc_subnets=None, db_proxy)

Bases: DatabaseProxyEndpointOptions

Construction properties for a DatabaseProxyEndpoint.

Parameters:

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

  • db_proxy (IDatabaseProxy) – The DB proxy associated with the DB proxy endpoint.

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_props = rds.DatabaseProxyEndpointProps(
    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
    )
)

Attributes

db_proxy

The DB proxy associated with the DB proxy endpoint.

db_proxy_endpoint_name

The name of the DB proxy endpoint.

Default:

  • a CDK generated name

security_groups

The VPC security groups to associate with the new proxy endpoint.

Default:

  • Default security group for the VPC

target_role

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

Default:

  • ProxyEndpointTargetRole.READ_WRITE

vpc

The VPC of the DB proxy endpoint.

vpc_subnets

The subnets of DB proxy endpoint.

Default:

  • the VPC default strategy if not specified.