AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ApiGatewayV2::VpcLink

CfnVpcLink

The `AWS::ApiGatewayV2::VpcLink` resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from `PENDING` to `AVAILABLE` to successfully create a VPC link, which can take up to 10 minutes. To learn more, see [Working with VPC Links for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) in the *API Gateway Developer Guide* .

Import

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

Or use the module namespace:

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

Properties

Configuration passed to the constructor as CfnVpcLinkProps.

nameRequired
string

The name of the VPC link.

subnetIdsRequired
string | ISubnetRef[]

A list of subnet IDs to include in the VPC link.

securityGroupIdsOptional
string | ISecurityGroupRef[]

A list of security group IDs for the VPC link.

tagsOptional
{ [key: string]: string }

The collection of tags. Each tag element is associated with a given resource.

CloudFormation Resource

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

AWS::ApiGatewayV2::VpcLinkView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-apigatewayv2
CFN TypeAWS::ApiGatewayV2::VpcLink
Properties4

Related Constructs

Explore This Service

External Links