AWS::ApiGatewayV2::VpcLink

ApiGatewayV2 VpcLink

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*.

Properties

4 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`Name`	`string`	Required
`SubnetIds`	`Array<string>`	RequiredCreate-only
`SecurityGroupIds`	`Array<string>`	Create-only
`Tags`	`object`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`VpcLinkId`	`string`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ApiGatewayV2::VpcLink

Resources:
  MyResource:
    Type: AWS::ApiGatewayV2::VpcLink
    Properties:
      SubnetIds: "my-subnetids"
      Name: "my-name"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

apigateway:POSTapigateway:GETapigateway:TagResourceiam:CreateServiceLinkedRoleiam:DeleteServiceLinkedRoleiam:GetServiceLinkedRoleDeletionStatus

update

apigateway:PATCHapigateway:GETapigateway:TagResourceapigateway:unTagResourceiam:CreateServiceLinkedRoleiam:DeleteServiceLinkedRoleiam:GetServiceLinkedRoleDeletionStatus

read

apigateway:GETiam:CreateServiceLinkedRoleiam:DeleteServiceLinkedRoleiam:GetServiceLinkedRoleDeletionStatus

delete

apigateway:GETapigateway:DELETEiam:CreateServiceLinkedRoleiam:DeleteServiceLinkedRoleiam:GetServiceLinkedRoleDeletionStatus

list

apigateway:GETiam:CreateServiceLinkedRoleiam:DeleteServiceLinkedRoleiam:GetServiceLinkedRoleDeletionStatus

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

ServiceApiGatewayV2

Properties5

Required2

TaggingSupported

Primary IDVpcLinkId

Supported Operations

CreateUpdateReadDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

SecurityGroupIdsSubnetIds

Related Resources

External Links

AWS Documentation