interface DatabaseProxyEndpointProps

Language	Type name
.NET	Amazon.CDK.AWS.RDS.DatabaseProxyEndpointProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsrds#DatabaseProxyEndpointProps
Java	software.amazon.awscdk.services.rds.DatabaseProxyEndpointProps
Python	aws_cdk.aws_rds.DatabaseProxyEndpointProps
TypeScript (source)	aws-cdk-lib » aws_rds » DatabaseProxyEndpointProps

Construction properties for a DatabaseProxyEndpoint.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_rds as rds } from 'aws-cdk-lib';

declare const databaseProxy: rds.DatabaseProxy;
declare const securityGroup: ec2.SecurityGroup;
declare const subnet: ec2.Subnet;
declare const subnetFilter: ec2.SubnetFilter;
declare const vpc: ec2.Vpc;
const databaseProxyEndpointProps: rds.DatabaseProxyEndpointProps = {
  dbProxy: databaseProxy,
  vpc: vpc,

  // the properties below are optional
  dbProxyEndpointName: 'dbProxyEndpointName',
  securityGroups: [securityGroup],
  targetRole: rds.ProxyEndpointTargetRole.READ_WRITE,
  vpcSubnets: {
    availabilityZones: ['availabilityZones'],
    onePerAz: false,
    subnetFilters: [subnetFilter],
    subnetGroupName: 'subnetGroupName',
    subnets: [subnet],
    subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
  },
};

Properties

Name	Type	Description
dbProxy	IDatabaseProxy	The DB proxy associated with the DB proxy endpoint.
vpc	IVpc	The VPC of the DB proxy endpoint.
dbProxyEndpointName?	string	The name of the DB proxy endpoint.
securityGroups?	ISecurityGroup[]	The VPC security groups to associate with the new proxy endpoint.
targetRole?	ProxyEndpointTargetRole	A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
vpcSubnets?	SubnetSelection	The subnets of DB proxy endpoint.

---

dbProxy

Type: IDatabaseProxy

The DB proxy associated with the DB proxy endpoint.

---

vpc

Type: IVpc

The VPC of the DB proxy endpoint.

---

dbProxyEndpointName?

Type: string (optional, default: a CDK generated name)

The name of the DB proxy endpoint.

---

securityGroups?

Type: ISecurityGroup[] (optional, default: Default security group for the VPC)

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

---

targetRole?

Type: ProxyEndpointTargetRole (optional, default: ProxyEndpointTargetRole.READ_WRITE)

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

---

vpcSubnets?

Type: SubnetSelection (optional, default: the VPC default strategy if not specified.)

The subnets of DB proxy endpoint.