Skip to content

Data Source: awsApiGatewayVpcLink

Use this data source to get the id of a VPC Link in API Gateway. To fetch the VPC Link you must provide a name to match against. As there is no unique name constraint on API Gateway VPC Links this data source will error if there is more than one match.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.dataAwsApiGatewayVpcLink.DataAwsApiGatewayVpcLink(
  this,
  "my_api_gateway_vpc_link",
  {
    name: "my-vpc-link",
  }
);

Argument Reference

  • name - (Required) Name of the API Gateway VPC Link to look up. If no API Gateway VPC Link is found with this name, an error will be returned. If multiple API Gateway VPC Links are found with this name, an error will be returned.

Attributes Reference

  • id - Set to the ID of the found API Gateway VPC Link.
  • description - Description of the VPC link.
  • status - Status of the VPC link.
  • statusMessage - Status message of the VPC link.
  • targetArns - List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
  • tags - Key-value map of resource tags