AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ApiGateway::VpcLink

CfnVpcLink

The `AWS::ApiGateway::VpcLink` resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see [vpclink:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateVpcLink.html) in the `Amazon API Gateway REST API Reference` .

Import

import { CfnVpcLink } from 'aws-cdk-lib/aws-apigateway';

Or use the module namespace:

import * as apigateway from 'aws-cdk-lib/aws-apigateway';
// apigateway.CfnVpcLink

Properties

Configuration passed to the constructor as CfnVpcLinkProps.

nameRequired
string

The name used to label and identify the VPC link.

targetArnsRequired
string | ILoadBalancerRef[]

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.

descriptionOptional
string

The description of the VPC link.

tagsOptional
CfnTag[]

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::ApiGateway::VpcLinkView in CloudFormation Explorer

Get the Amazon API Gateway Cheat Sheet

Everything you need to know about Amazon API Gateway on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-apigateway
CFN TypeAWS::ApiGateway::VpcLink
Properties4

Related Constructs

Explore This Service

External Links