AWS::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
in the API Gateway Developer Guide.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::ApiGatewayV2::VpcLink", "Properties" : { "Name" :
String
, "SecurityGroupIds" :[ String, ... ]
, "SubnetIds" :[ String, ... ]
, "Tags" :{
} }Key
:Value
, ...}
YAML
Type: AWS::ApiGatewayV2::VpcLink Properties: Name:
String
SecurityGroupIds:- String
SubnetIds:- String
Tags:
Key
:Value
Properties
Name
-
The name of the VPC link.
Required: Yes
Type: String
Update requires: No interruption
SecurityGroupIds
-
A list of security group IDs for the VPC link.
Required: No
Type: List of String
Update requires: Replacement
SubnetIds
-
A list of subnet IDs to include in the VPC link.
Required: Yes
Type: List of String
Update requires: Replacement
Tags
-
The collection of tags. Each tag element is associated with a given resource.
Required: No
Type: Map of String
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the VPC link's ID, such as
abcde1
.
For more information about using the Ref
function, see Ref.