Skip to main content

vpc_links_list_only

Lists vpc_links in a region or regions, for all properties use vpc_links

Overview

Namevpc_links_list_only
TypeResource
DescriptionThe 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*.
Idaws.apigatewayv2.vpc_links_list_only

Fields

NameDatatypeDescription
vpc_link_idstring
subnet_idsarrayA list of subnet IDs to include in the VPC link.
security_group_idsarrayA list of security group IDs for the VPC link.
tagsobjectThe collection of tags. Each tag element is associated with a given resource.
namestringThe name of the VPC link.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all vpc_links in a region.

SELECT
region,
vpc_link_id
FROM aws.apigatewayv2.vpc_links_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the vpc_links_list_only resource, see vpc_links