1.204.0

interface CfnDBProxyEndpointProps

LanguageType name
.NETAmazon.CDK.AWS.RDS.CfnDBProxyEndpointProps
Javasoftware.amazon.awscdk.services.rds.CfnDBProxyEndpointProps
Pythonaws_cdk.aws_rds.CfnDBProxyEndpointProps
TypeScript @aws-cdk/aws-rds » CfnDBProxyEndpointProps

Properties for defining a CfnDBProxyEndpoint.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as rds from '@aws-cdk/aws-rds';
const cfnDBProxyEndpointProps: rds.CfnDBProxyEndpointProps = {
  dbProxyEndpointName: 'dbProxyEndpointName',
  dbProxyName: 'dbProxyName',
  vpcSubnetIds: ['vpcSubnetIds'],

  // the properties below are optional
  tags: [{
    key: 'key',
    value: 'value',
  }],
  targetRole: 'targetRole',
  vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
};

Properties

NameTypeDescription
dbProxyEndpointNamestringThe name of the DB proxy endpoint to create.
dbProxyNamestringThe name of the DB proxy associated with the DB proxy endpoint that you create.
vpcSubnetIdsstring[]The VPC subnet IDs for the DB proxy endpoint that you create.
tags?TagFormatProperty[]An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
targetRole?stringA 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.

dbProxyName

Type: string

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

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.

tags?

Type: TagFormatProperty[] (optional)

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

targetRole?

Type: string (optional)

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

Valid Values: READ_WRITE | READ_ONLY

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.

← PreviousNext →