AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

DatabaseProxyEndpoint

RDS Database Proxy Endpoint.

Import

import { DatabaseProxyEndpoint } from 'aws-cdk-lib/aws-rds';

Or use the module namespace:

import * as rds from 'aws-cdk-lib/aws-rds';
// rds.DatabaseProxyEndpoint

Properties

Configuration passed to the constructor as DatabaseProxyEndpointProps.

dbProxyRequired
IDBProxyRef

The DB proxy associated with the DB proxy endpoint.

5 properties inherited from DatabaseProxyEndpointOptions
vpcRequiredinherited from DatabaseProxyEndpointOptions
IVpc

The VPC of the DB proxy endpoint.

dbProxyEndpointNameOptionalinherited from DatabaseProxyEndpointOptions
string

The name of the DB proxy endpoint.

Default: - a CDK generated name

securityGroupsOptionalinherited from DatabaseProxyEndpointOptions
ISecurityGroup[]

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

Default: - Default security group for the VPC

targetRoleOptionalinherited from DatabaseProxyEndpointOptions
ProxyEndpointTargetRole

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

Default: - ProxyEndpointTargetRole.READ_WRITE

vpcSubnetsOptionalinherited from DatabaseProxyEndpointOptions
SubnetSelection

The subnets of DB proxy endpoint.

Default: - the VPC default strategy if not specified.

Get the Amazon RDS Cheat Sheet

Everything you need to know about Amazon RDS on one page. HD quality, print-friendly.

Download Free Infographic