DatabaseProxyEndpointOptions Struct
Options for a new DatabaseProxyEndpoint.
Example
ts
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
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.