Top / Amazon Web Service / AWS API Gateway / VPC Link

AWS API Gateway VPC Link

This page shows how to write Terraform and CloudFormation for API Gateway VPC Link and write them securely.

terraform-logo

Review your .tf file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

aws_api_gateway_vpc_link (Terraform)

The VPC Link in API Gateway can be configured in Terraform with the resource name aws_api_gateway_vpc_link. The following sections describe 3 examples of how to use the resource and its parameters.

Example Usage from GitHub

aws_api_gateway_vpc_link.tf#L1
resource "aws_api_gateway_vpc_link" "vpc_link" {
  count = local.create_api_link
  name = local.vpc_link_name
  target_arns = [var.vpc_link_target_arn]
main.tf#L1
resource "aws_api_gateway_vpc_link" "default" {
    name = var.vpc_link_name
    description = var.vpc_link_description
    target_arns = var.target_arns
main.tf#L31
resource "aws_api_gateway_vpc_link" "this" {
  name        = var.name
  target_arns = [aws_lb.this.arn]

  tags = var.tags
}

Review your Terraform file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

>> from Terraform Registry

Explanation in Terraform Registry

Provides an API Gateway VPC Link. -> Note: Amazon API Gateway Version 1 VPC Links enable private integrations that connect REST APIs to private resources in a VPC. To enable private integration for HTTP APIs, use the Amazon API Gateway Version 2 VPC Link resource.

>> from Terraform Registry

Tips: Best Practices for The Other AWS API Gateway Resources

In addition to the aws_api_gateway_method_settings, AWS API Gateway has the other resources that should be configured for security reasons. Please check some examples of those resources and precautions.

risk-label

aws_api_gateway_method_settings

Ensure that API Gateway stage-level cache is encrypted

It is better to enable the stage-level cache encryption which reduces the risk of data leakage.

risk-label

aws_api_gateway_domain_name

Ensure to use modern TLS protocols

It is better to adopt TLS v1.2+.

risk-label

aws_api_gateway_stage

Ensure to enable access logging of your API Gateway stage (v1)

It is better to enable the access logging of your API Gateway stage (v1).

risk-label

aws_api_gateway_method

Ensure that your API Gateway method blocks unwanted access

It is better that the API Gateway method does not allow public access.

Review your AWS API Gateway settings

In addition to the above, there are other security points you should be aware of making sure that your .tf files are protected in Shisho Cloud.

AWS::ApiGateway::VpcLink (CloudFormation)

The VpcLink in ApiGateway can be configured in CloudFormation with the resource name AWS::ApiGateway::VpcLink. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

>> from AWS CloudFormation Documentation

Explanation in CloudFormation Registry

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 in the Amazon API Gateway REST API Reference.

>> from AWS CloudFormation Documentation

The Other Related AWS API Gateway Resources

Frequently asked questions

AWS API Gateway VPC Link is a resource for API Gateway of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.

For Terraform, the osodevops/aws-terraform-module-apigateway, chuleh/tf-aws-vpc-link-module and babbel/terraform-aws-nlb-for-apigateway-vpc-link source code examples are useful. See the Terraform Example section for further details.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents