CfnDBProxyEndpointProps Struct
Properties for defining a CfnDBProxyEndpoint.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_rds as rds } from 'aws-cdk-lib';
const cfnDBProxyEndpointProps: rds.CfnDBProxyEndpointProps = {
dbProxyEndpointName: 'dbProxyEndpointName',
dbProxyName: 'dbProxyName',
vpcSubnetIds: ['vpcSubnetIds'],
// the properties below are optional
endpointNetworkType: 'endpointNetworkType',
tags: [{
key: 'key',
value: 'value',
}],
targetRole: 'targetRole',
vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
};
Properties
dbProxyEndpointNamestringdb_proxy_endpoint_namestrdbProxyEndpointNameStringDbProxyEndpointNamestringDbProxyEndpointName*stringrequired#The name of the DB proxy endpoint to create.
The name of the DB proxy associated with the DB proxy endpoint that you create.
endpointNetworkTypestringendpoint_network_typestrendpointNetworkTypeStringEndpointNetworkTypestringEndpointNetworkType*string#The network type of the DB proxy endpoint.
notes
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.
tagsCfnDBProxyEndpoint.TagFormatProperty[]tagstyping.List[TagFormatProperty]tagsList<TagFormatProperty>TagsTagFormatProperty[]Tags*[]TagFormatProperty#An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
vpcSecurityGroupIdsstring | ISecurityGroupRef[]vpc_security_group_idstyping.List[typing.Union[str, ISecurityGroupRef]]vpcSecurityGroupIdsList<String>VpcSecurityGroupIdsstring[]VpcSecurityGroupIds*[]interface{}#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.
vpcSubnetIdsstring | ISubnetRef[]vpc_subnet_idstyping.List[typing.Union[str, ISubnetRef]]vpcSubnetIdsList<String>VpcSubnetIdsstring[]VpcSubnetIds*[]interface{}required#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.