VPC Modules 0.28.1Last updated in version 0.26.21

VPC-App Lookup Module

View Source Release Notes

This folder contains a Terraform module which can use data sources to fetch all the data about a VPC created by the vpc-app module, including the VPC ID, subnet IDs, route table IDs, NAT Gateway IDs, and so on. Normally, you can look up this data using either a dependency block in Terragrunt or a terraform_remote_state data source in Terraform, but in some cases, the team that needs the VPC data does not have access to the code or Terraform state for the VPC module, perhaps because networking is managed by a separate team, maybe in a separate repo. Therefore, this vpc-app-lookup module allows you to fetch all the info you need without having to have access to the code or Terraform state.

This module attempts to match the output variables API of vpc-app exactly.

Sample Usage

Terraform

main.tf

# ------------------------------------------------------------------------------------------------------
# DEPLOY GRUNTWORK'S VPC-APP-LOOKUP MODULE
# ------------------------------------------------------------------------------------------------------

module "vpc_app_lookup" {

  source = "git::git@github.com:gruntwork-io/terraform-aws-vpc.git//modules/vpc-app-lookup?ref=v0.28.1"

  # ----------------------------------------------------------------------------------------------------
  # OPTIONAL VARIABLES
  # ----------------------------------------------------------------------------------------------------

  # The CIDR block of the VPC you're looking for
  cidr_block = null

  # Whether the VPC you're looking for is the Default VPC or not
  default = null

  # The DHCP Options ID fo the VPC you're looking for
  dhcp_options_id = null

  # Additional filters to use to find the VPC. The key is a unique name for the
  # filter (for use with for_each). The value is an object where the names and
  # values are those of supported filters from the underlying API:
  # https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html.
  filters = null

  # The ID of the VPC you're looking for
  id = null

  # If you enabled the default route table and wish to look it up, set this to
  # true.
  lookup_default_route_table = false

  # If you enabled the default security group and wish to look it up, set this
  # to true.
  lookup_default_security_group = false

  # If you enabled the Internet Gateway and wish to look it up, set this to
  # true.
  lookup_internet_gateway = false

  # If you enabled the VPC endpoints and wish to look them up, set this to true.
  lookup_vpc_endpoints = false

  # The name of the private persistence subnet tier. This is used to identify
  # the subnet and its resources.
  private_persistence_subnet_name = "private-persistence"

  # The name of the private subnet tier. This is used to identify the subnet and
  # its resources.
  private_subnet_name = "private-app"

  # The name of the public subnet tier. This is used to identify the subnet and
  # its resources.
  public_subnet_name = "public"

  # The state of the VPC you're looking for. Can either be 'pending' or
  # 'available'.
  state = null

  # The tags of the VPC you're looking for. Only VPCs that have the exact
  # key/value pairs you specify will be matched.
  tags = null

  # The name of the transit subnet tier. This is used to identify the subnet and
  # its resources.
  transit_subnet_name = "transit"

}

Terragrunt

terragrunt.hcl

# ------------------------------------------------------------------------------------------------------
# DEPLOY GRUNTWORK'S VPC-APP-LOOKUP MODULE
# ------------------------------------------------------------------------------------------------------

terraform {
  source = "git::git@github.com:gruntwork-io/terraform-aws-vpc.git//modules/vpc-app-lookup?ref=v0.28.1"
}

inputs = {

  # ----------------------------------------------------------------------------------------------------
  # OPTIONAL VARIABLES
  # ----------------------------------------------------------------------------------------------------

  # The CIDR block of the VPC you're looking for
  cidr_block = null

  # Whether the VPC you're looking for is the Default VPC or not
  default = null

  # The DHCP Options ID fo the VPC you're looking for
  dhcp_options_id = null

  # Additional filters to use to find the VPC. The key is a unique name for the
  # filter (for use with for_each). The value is an object where the names and
  # values are those of supported filters from the underlying API:
  # https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html.
  filters = null

  # The ID of the VPC you're looking for
  id = null

  # If you enabled the default route table and wish to look it up, set this to
  # true.
  lookup_default_route_table = false

  # If you enabled the default security group and wish to look it up, set this
  # to true.
  lookup_default_security_group = false

  # If you enabled the Internet Gateway and wish to look it up, set this to
  # true.
  lookup_internet_gateway = false

  # If you enabled the VPC endpoints and wish to look them up, set this to true.
  lookup_vpc_endpoints = false

  # The name of the private persistence subnet tier. This is used to identify
  # the subnet and its resources.
  private_persistence_subnet_name = "private-persistence"

  # The name of the private subnet tier. This is used to identify the subnet and
  # its resources.
  private_subnet_name = "private-app"

  # The name of the public subnet tier. This is used to identify the subnet and
  # its resources.
  public_subnet_name = "public"

  # The state of the VPC you're looking for. Can either be 'pending' or
  # 'available'.
  state = null

  # The tags of the VPC you're looking for. Only VPCs that have the exact
  # key/value pairs you specify will be matched.
  tags = null

  # The name of the transit subnet tier. This is used to identify the subnet and
  # its resources.
  transit_subnet_name = "transit"

}

Reference

Inputs

Optional

cidr_blockstringoptional

The CIDR block of the VPC you're looking for

Default:null

defaultbooloptional

Whether the VPC you're looking for is the Default VPC or not

Default:null

dhcp_options_idstringoptional

The DHCP Options ID fo the VPC you're looking for

Default:null

filtersmap(object(…))optional

Additional filters to use to find the VPC. The key is a unique name for the filter (for use with for_each). The value is an object where the names and values are those of supported filters from the underlying API: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html.

Type Details

map(object({
    name   = string
    values = list(string)
  }))

Default:null

idstringoptional

The ID of the VPC you're looking for

Default:null

lookup_default_route_tablebooloptional

If you enabled the default route table and wish to look it up, set this to true.

Default:false

lookup_default_security_groupbooloptional

If you enabled the default security group and wish to look it up, set this to true.

Default:false

lookup_internet_gatewaybooloptional

If you enabled the Internet Gateway and wish to look it up, set this to true.

Default:false

lookup_vpc_endpointsbooloptional

If you enabled the VPC endpoints and wish to look them up, set this to true.

Default:false

private_persistence_subnet_namestringoptional

The name of the private persistence subnet tier. This is used to identify the subnet and its resources.

Default:"private-persistence"

private_subnet_namestringoptional

The name of the private subnet tier. This is used to identify the subnet and its resources.

Default:"private-app"

public_subnet_namestringoptional

The name of the public subnet tier. This is used to identify the subnet and its resources.

Default:"public"

statestringoptional

The state of the VPC you're looking for. Can either be 'pending' or 'available'.

Default:null

tagsmap(string)optional

The tags of the VPC you're looking for. Only VPCs that have the exact key/value pairs you specify will be matched.

Default:null

transit_subnet_namestringoptional

The name of the transit subnet tier. This is used to identify the subnet and its resources.

Default:"transit"

Outputs

availability_zones

default_route_table_id

default_security_group_id

The ID of the default security group of this VPC.

dynamodb_vpc_endpoint_id

internet_gateway_id

ipv6_cidr_block

The IPv6 CIDR block associated with the VPC.

nat_gateway_ids

nat_gateway_public_ips

num_availability_zones

private_app_subnet_arns

A list of ARNs of the private app subnets in the VPC

private_app_subnet_cidr_blocks

The private IP address range of the VPC in CIDR notation.

private_app_subnet_ids

A list of IDs of the private app subnets in the VPC

private_app_subnet_route_table_ids

A list of IDs of the private app subnet routing table.

private_app_subnets

A map of all private-app subnets, with the subnet ID as key, and all aws-subnet properties as the value.

private_nat_gateway_ids

private_persistence_route_table_ids

A list of IDs of the private persistence subnet routing table.

private_persistence_subnet_arn

DEPRECATED. Use private_persistence_subnet_arns instead.

private_persistence_subnet_arns

The ARNs of the private persistence tier subnets of the VPC.

private_persistence_subnet_cidr_blocks

The private IP address range of the VPC Persistence tier in CIDR notation.

private_persistence_subnet_ids

The IDs of the private persistence tier subnets of the VPC.

private_persistence_subnet_route_table_ids

A list of IDs of the private persistence subnet routing table.

private_persistence_subnets

A map of all private-persistence subnets, with the subnet ID as key, and all aws-subnet properties as the value.

private_subnet_route_table_ids

A list of IDs of the private app subnet routing table.

public_subnet_arns

A list of ARNs of the public subnets of the VPC.

public_subnet_cidr_blocks

The public IP address range of the VPC in CIDR notation.

public_subnet_ids

A list of IDs of the public subnets of the VPC.

public_subnet_ipv6_cidr_blocks

public_subnet_route_table_id

The ID of the public routing table.

public_subnet_route_table_ids

A list of IDs of the public routing tables.

public_subnets

A map of all public subnets, with the subnet ID as key, and all aws-subnet properties as the value.

s3_vpc_endpoint_id

transit_subnet_arns

The ARNs of the transit tier subnets of the VPC.

transit_subnet_cidr_blocks

The private IP address range of the VPC transit tier in CIDR notation.

transit_subnet_ids

The IDs of the transit tier subnets of the VPC.

transit_subnet_route_table_ids

A list of IDs of the transit subnet routing table.

transit_subnets

A map of all transit subnets, with the subnet ID as key, and all aws-subnet properties as the value.

vpc_cidr_block

The IP address range of the VPC in CIDR notation.

vpc_id

The ID of the VPC.

vpc_name

The name configured for VPC.