Skip to main content

vpc_link

Gets an individual vpc_link resource

Overview

Namevpc_link
TypeResource
Descriptionvpc_link
Idawscc.apigateway.vpc_link

Fields

NameDatatypeDescription
namestringA name for the VPC link.
descriptionstringA description of the VPC link.
tagsarrayAn array of arbitrary tags (key-value pairs) to associate with the stage.
target_arnsarrayThe ARN of 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_idstringThe ID of the instance that backs VPC link.
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
name,
description,
tags,
target_arns,
vpc_link_id
FROM awscc.apigateway.vpc_link
WHERE data__Identifier = '<VpcLinkId>';

Permissions

To operate on the vpc_link resource, the following permissions are required:

Update

apigateway:PATCH,
apigateway:GET,
apigateway:PUT,
ec2:CreateVpcEndpointServiceConfiguration,
ec2:DeleteVpcEndpointServiceConfigurations,
ec2:DescribeVpcEndpointServiceConfigurations,
ec2:ModifyVpcEndpointServicePermissions

Read

apigateway:GET,
ec2:CreateVpcEndpointServiceConfiguration,
ec2:DeleteVpcEndpointServiceConfigurations,
ec2:DescribeVpcEndpointServiceConfigurations,
ec2:ModifyVpcEndpointServicePermissions

Delete

apigateway:GET,
apigateway:DELETE,
apigateway:PUT,
ec2:CreateVpcEndpointServiceConfiguration,
ec2:DeleteVpcEndpointServiceConfigurations,
ec2:DescribeVpcEndpointServiceConfigurations,
ec2:ModifyVpcEndpointServicePermissions