interface CfnDBProxyEndpointProps

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

Properties for defining a CfnDBProxyEndpoint.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

Example

// 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

Name	Type	Description
dbProxyEndpointName	string	The name of the DB proxy endpoint to create.
dbProxyName	string	The name of the DB proxy associated with the DB proxy endpoint that you create.
vpcSubnetIds	string[]	The VPC subnet IDs for the DB proxy endpoint that you create.
endpointNetworkType?	string	The network type of the DB proxy endpoint.
tags?	TagFormatProperty[]	An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
targetRole?	string	A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
vpcSecurityGroupIds?	string[]	The VPC security group IDs for the DB proxy endpoint that you create.

---

dbProxyEndpointName

Type: string

The name of the DB proxy endpoint to create.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-dbproxyendpointname

---

dbProxyName

Type: string

The name of the DB proxy associated with the DB proxy endpoint that you create.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-dbproxyname

---

vpcSubnetIds

Type: string[]

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-vpcsubnetids

---

endpointNetworkType?

Type: string (optional)

The network type of the DB proxy endpoint.

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-endpointnetworktype

---

tags?

Type: TagFormatProperty[] (optional)

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-tags

---

targetRole?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-targetrole

---

vpcSecurityGroupIds?

Type: string[] (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-vpcsecuritygroupids