DatabaseProxyEndpointProps Struct
Construction properties for a DatabaseProxyEndpoint.
Example
ts
// 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';
import { aws_rds as interfaces_rds } from 'aws-cdk-lib/interfaces';
declare const dBProxyRef: interfaces_rds.IDBProxyRef;
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: dBProxyRef,
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
dbProxyIDBProxyRefdb_proxyIDBProxyRefdbProxyIDBProxyRefDbProxyIDBProxyRefDbProxyIDBProxyRefrequired#The DB proxy associated with the DB proxy endpoint.
dbProxyEndpointNameoptionalstringdb_proxy_endpoint_nameoptionalstrdbProxyEndpointNameoptionalStringDbProxyEndpointNameoptionalstringDbProxyEndpointNameoptional*string#The name of the DB proxy endpoint.
Default: a CDK generated name
securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroup#The VPC security groups to associate with the new proxy endpoint.
Default: Default security group for the VPC
targetRoleoptionalProxyEndpointTargetRoletarget_roleoptionalProxyEndpointTargetRoletargetRoleoptionalProxyEndpointTargetRoleTargetRoleoptionalProxyEndpointTargetRoleTargetRoleoptionalProxyEndpointTargetRole#A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
Default: ProxyEndpointTargetRole.READ_WRITE
vpcSubnetsoptionalSubnetSelectionvpc_subnetsoptionalSubnetSelectionvpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelection#The subnets of DB proxy endpoint.
Default: the VPC default strategy if not specified.