AWS::ApiGateway::VpcLink

ApiGateway VpcLink

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.

Properties

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

Filter:

Property	Type	Flags
`Name`	`string`	Required
`TargetArns`	`Array<string>`	RequiredCreate-only
`Description`	`string`
`Tags`	`Array<Tag>`

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::ApiGateway::VpcLink

Resources:
  MyResource:
    Type: AWS::ApiGateway::VpcLink
    Properties:
      Name: "my-name"
      TargetArns: "arn:aws:service:region:account:resource"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

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

create

apigateway:POSTapigateway:PUTapigateway:GETec2:CreateVpcEndpointServiceConfigurationec2:DeleteVpcEndpointServiceConfigurationsec2:DescribeVpcEndpointServiceConfigurationsec2:ModifyVpcEndpointServicePermissions

update

apigateway:PATCHapigateway:GETapigateway:PUTec2:CreateVpcEndpointServiceConfigurationec2:DeleteVpcEndpointServiceConfigurationsec2:DescribeVpcEndpointServiceConfigurationsec2:ModifyVpcEndpointServicePermissions

read

apigateway:GETec2:CreateVpcEndpointServiceConfigurationec2:DeleteVpcEndpointServiceConfigurationsec2:DescribeVpcEndpointServiceConfigurationsec2:ModifyVpcEndpointServicePermissions

list

apigateway:GETec2:CreateVpcEndpointServiceConfigurationec2:DeleteVpcEndpointServiceConfigurationsec2:DescribeVpcEndpointServiceConfigurationsec2:ModifyVpcEndpointServicePermissions

delete

apigateway:GETapigateway:DELETEapigateway:PUTec2:CreateVpcEndpointServiceConfigurationec2:DeleteVpcEndpointServiceConfigurationsec2:DescribeVpcEndpointServiceConfigurationsec2:ModifyVpcEndpointServicePermissions

Get the ApiGateway Cheat Sheet

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

Download Free Infographic

Quick Facts

ServiceApiGateway

Properties5

Required2

TaggingSupported

Primary IDVpcLinkId

Supported Operations

CreateUpdateReadListDelete

Immutable After Creation

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

TargetArns

Related Resources

External Links

AWS Documentation