vpc_links_list_only
Lists vpc_links
in a region or regions, for all properties use vpc_links
Overview
Name | vpc_links_list_only |
Type | Resource |
Description | 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 . |
Id | aws.apigateway.vpc_links_list_only |
Fields
Name | Datatype | Description |
---|---|---|
name | string | The name used to label and identify the VPC link. |
description | string | The description of the VPC link. |
tags | array | An array of arbitrary tags (key-value pairs) to associate with the VPC link. |
target_arns | array | The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS-account of the API owner. |
vpc_link_id | string | |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
SELECT
examples
Lists all vpc_links
in a region.
SELECT
region,
vpc_link_id
FROM aws.apigateway.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