AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::RDS::DBProxyEndpoint

CfnDBProxyEndpoint

The `AWS::RDS::DBProxyEndpoint` resource creates or updates a DB proxy endpoint. You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC. For more information about RDS Proxy, see [AWS::RDS::DBProxy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html) .

Import

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

Or use the module namespace:

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

Properties

Configuration passed to the constructor as CfnDBProxyEndpointProps.

dbProxyEndpointNameRequired
string

The name of the DB proxy endpoint to create.

dbProxyNameRequired
string

The name of the DB proxy associated with the DB proxy endpoint that you create.

vpcSubnetIdsRequired
string | ISubnetRef[]

The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.

endpointNetworkTypeOptional
string

The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports. Valid values: - `IPV4` - The proxy endpoint supports IPv4 only. - `IPV6` - The proxy endpoint supports IPv6 only. - `DUAL` - The proxy endpoint supports both IPv4 and IPv6.

tagsOptional
TagFormatProperty[]

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

targetRoleOptional
string

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

vpcSecurityGroupIdsOptional
string | ISecurityGroupRef[]

The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::RDS::DBProxyEndpointView in CloudFormation Explorer

Get the Amazon RDS Cheat Sheet

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

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-rds
CFN TypeAWS::RDS::DBProxyEndpoint
Properties7

Related Constructs

Explore This Service

External Links