interface CfnVpcLinkProps

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.CfnVpcLinkProps
Java	software.amazon.awscdk.services.apigateway.CfnVpcLinkProps
Python	aws_cdk.aws_apigateway.CfnVpcLinkProps
TypeScript	@aws-cdk/aws-apigateway » CfnVpcLinkProps

Properties for defining a CfnVpcLink.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigateway from '@aws-cdk/aws-apigateway';
const cfnVpcLinkProps: apigateway.CfnVpcLinkProps = {
  name: 'name',
  targetArns: ['targetArns'],

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

Properties

Name	Type	Description
name	string	The name used to label and identify the VPC link.
targetArns	string[]	The ARN of the network load balancer of the VPC targeted by the VPC link.
description?	string	The description of the VPC link.
tags?	CfnTag[]	An array of arbitrary tags (key-value pairs) to associate with the VPC link.

---

name

Type: string

The name used to label and identify the VPC link.

---

targetArns

Type: string[]

The ARN of the network load balancer of the VPC targeted by the VPC link.

The network load balancer must be owned by the same AWS account of the API owner.

---

description?

Type: string (optional)

The description of the VPC link.

---

tags?

Type: CfnTag[] (optional)

An array of arbitrary tags (key-value pairs) to associate with the VPC link.