interface DatabaseProxyEndpointOptions

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

Options for a new DatabaseProxyEndpoint.

Example

declare const vpc: ec2.Vpc;
declare const secrets: secretsmanager.Secret[];
declare const dbInstance: rds.DatabaseInstance;

const proxy = dbInstance.addProxy('Proxy', {
  secrets,
  vpc,
});

// Add a reader endpoint
proxy.addEndpoint('ProxyEndpoint', {
  vpc,
  targetRole: rds.ProxyEndpointTargetRole.READ_ONLY,
});

Properties

Name	Type	Description
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.

---

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.