API Gateway VPC Link

This table represents the API Gateway VPC Link resource from Amazon Web Services.

aws.apigateway_vpclink

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
descriptioncorestringThe description of the VPC link.
idcorestringThe identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
namecorestringThe name used to label and identify the VPC link.
statuscorestringThe status of the VPC link. The valid values are <code>AVAILABLE</code>, <code>PENDING</code>, <code>DELETING</code>, or <code>FAILED</code>. Deploying an API will wait if the status is <code>PENDING</code> and will fail if the status is <code>DELETING</code>.
status_messagecorestringA description about the VPC link status.
tagscorehstore
target_arnscorearray<string>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 Amazon Web Services account of the API owner.