» Resource: aws_api_gateway_vpc_link

Provides an API Gateway VPC Link.

» Example Usage

resource "aws_lb" "example" {
  name               = "example"
  internal           = true
  load_balancer_type = "network"

  subnet_mapping {
    subnet_id = "12345"

resource "aws_api_gateway_vpc_link" "example" {
  name        = "example"
  description = "example description"
  target_arns = ["${aws_lb.example.arn}"]

» Argument Reference

The following arguments are supported:

  • name - (Required) The name used to label and identify the VPC link.
  • description - (Optional) The description of the VPC link.
  • target_arns - (Required, ForceNew) The list of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.

» Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - The identifier of the VpcLink.

» Import

API Gateway VPC Link can be imported using the id, e.g.

$ terraform import aws_api_gateway_vpc_link.example <vpc_link_id>