Module: vpc

Terraform module to provision a VPC with Internet Gateway. Contains a submodule for provisioning Interface and/or Gateway VPC Endpoints. This module also supports provisioning additional CIDR blocks for the VPC, with or without using IPAM.

Examples

module "vpc" {
  source = "cloudposse/vpc/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"
  namespace = "eg"
  stage     = "test"
  name      = "app"

  ipv4_primary_cidr_block = "10.0.0.0/16"

  assign_generated_ipv6_cidr_block = true
}

Full example with terraform-aws-dynamic-subnets:

module "vpc" {
  source = "cloudposse/vpc/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"
  namespace = "eg"
  stage     = "test"
  name      = "app"

  ipv4_primary_cidr_block = "10.0.0.0/16"

  assign_generated_ipv6_cidr_block = false
}

module "dynamic_subnets" {
  source = "cloudposse/dynamic-subnets/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"
  namespace          = "eg"
  stage              = "test"
  name               = "app"
  availability_zones = ["us-west-2a","us-west-2b","us-west-2c"]
  vpc_id             = module.vpc.vpc_id
  igw_id             = [module.vpc.igw_id]
  cidr_block         = "10.0.0.0/16"
}

Submodule for provisioning VPC Endpoints:

module "vpc_endpoints" {
  source = "cloudposse/vpc/aws//modules/vpc-endpoints"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  vpc_id = module.vpc.vpc_id

  gateway_vpc_endpoints = {
    "s3" = {
      name = "s3"
      policy = jsonencode({
        Version = "2012-10-17"
        Statement = [
          {
            Action = [
              "s3:*",
            ]
            Effect    = "Allow"
            Principal = "*"
            Resource  = "*"
          },
        ]
      })
    }
  }
  interface_vpc_endpoints = {
    "ec2" = {
      name                = "ec2"
      security_group_ids  = ["sg-12341234123412345"]
      subnet_ids          = module.dynamic_subnets.private_subnet_ids
      policy              = null
      private_dns_enabled = false
    }
  }
}

Requirements

Name	Version
terraform	>= 1.0.0
aws	>= 4.9.0

Providers

Name	Version
aws	>= 4.9.0

Modules

Name	Source	Version
label	cloudposse/label/null	0.25.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_default_network_acl.default	resource
aws_default_route_table.default	resource
aws_default_security_group.default	resource
aws_egress_only_internet_gateway.default	resource
aws_internet_gateway.default	resource
aws_vpc.default	resource
aws_vpc_ipv4_cidr_block_association.default	resource
aws_vpc_ipv6_cidr_block_association.default	resource

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id. This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration.	map(string)	{}	no
assign_generated_ipv6_cidr_block	When true, assign AWS generated IPv6 CIDR block to the VPC. Conflicts with ipv6_ipam_pool_id.	bool	true	no
attributes	ID element. Additional attributes (e.g. workers or cluster) to add to id, in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element.	list(string)	[]	no
context	Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value. Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged.	any	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "descriptor_formats": {}, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "labels_as_tags": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
default_network_acl_deny_all	When true, manage the default network acl and remove all rules, disabling all ingress and egress. When false, do not mange the default networking acl, allowing it to be managed by another component.	bool	false	no
default_route_table_no_routes	When true, manage the default route table and remove all routes, disabling all ingress and egress. When false, do not mange the default route table, allowing it to be managed by another component. Conflicts with Terraform resource aws_main_route_table_association.	bool	false	no
default_security_group_deny_all	When true, manage the default security group and remove all rules, disabling all ingress and egress. When false, do not manage the default security group, allowing it to be managed by another component.	bool	true	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
descriptor_formats	Describe additional descriptors to be output in the descriptors output map. Map of maps. Keys are names of descriptors. Values are maps of the form {<br/> format = string<br/> labels = list(string)<br/>} (Type is any so the map values can later be enhanced to provide additional options.) format is a Terraform format string to be passed to the format() function. labels is a list of labels, in order, to pass to format() function. Label values will be normalized before being passed to format() so they will be identical to how they appear in id. Default is {} (descriptors output will be empty).	any	{}	no
dns_hostnames_enabled	Set true to enable DNS hostnames in the VPC	bool	true	no
dns_support_enabled	Set true to enable DNS resolution in the VPC through the Amazon provided DNS server	bool	true	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
id_length_limit	Limit id to this many characters (minimum 6). Set to 0 for unlimited length. Set to null for keep the existing setting, which defaults to 0. Does not affect id_full.	number	null	no
instance_tenancy	A tenancy option for instances launched into the VPC	string	"default"	no
internet_gateway_enabled	Set true to create an Internet Gateway for the VPC	bool	true	no
ipv4_additional_cidr_block_associations	IPv4 CIDR blocks to assign to the VPC. ipv4_cidr_block can be set explicitly, or set to null with the CIDR block derived from ipv4_ipam_pool_id using ipv4_netmask_length. Map keys must be known at plan time, and are only used to track changes.	map(object({ ipv4_cidr_block = string ipv4_ipam_pool_id = string ipv4_netmask_length = number }))	{}	no
ipv4_cidr_block_association_timeouts	Timeouts (in go duration format) for creating and destroying IPv4 CIDR block associations	object({ create = string delete = string })	null	no
ipv4_primary_cidr_block	The primary IPv4 CIDR block for the VPC. Either ipv4_primary_cidr_block or ipv4_primary_cidr_block_association must be set, but not both.	string	null	no
ipv4_primary_cidr_block_association	Configuration of the VPC's primary IPv4 CIDR block via IPAM. Conflicts with ipv4_primary_cidr_block. One of ipv4_primary_cidr_block or ipv4_primary_cidr_block_association must be set. Additional CIDR blocks can be set via ipv4_additional_cidr_block_associations.	object({ ipv4_ipam_pool_id = string ipv4_netmask_length = number })	null	no
ipv6_additional_cidr_block_associations	IPv6 CIDR blocks to assign to the VPC (in addition to the autogenerated one). ipv6_cidr_block can be set explicitly, or set to null with the CIDR block derived from ipv6_ipam_pool_id using ipv6_netmask_length. Map keys must be known at plan time and are used solely to prevent unnecessary changes.	map(object({ ipv6_cidr_block = string ipv6_ipam_pool_id = string ipv6_netmask_length = number }))	{}	no
ipv6_cidr_block_association_timeouts	Timeouts (in go duration format) for creating and destroying IPv6 CIDR block associations	object({ create = string delete = string })	null	no
ipv6_cidr_block_network_border_group	Set this to restrict advertisement of public addresses to a specific Network Border Group such as a LocalZone. Requires assign_generated_ipv6_cidr_block to be set to true.	string	null	no
ipv6_egress_only_internet_gateway_enabled	Set true to create an IPv6 Egress-Only Internet Gateway for the VPC	bool	false	no
ipv6_primary_cidr_block_association	Primary IPv6 CIDR block to assign to the VPC. Conflicts with assign_generated_ipv6_cidr_block. ipv6_cidr_block can be set explicitly, or set to null with the CIDR block derived from ipv6_ipam_pool_id using ipv6_netmask_length.	object({ ipv6_cidr_block = string ipv6_ipam_pool_id = string ipv6_netmask_length = number })	null	no
label_key_case	Controls the letter case of the tags keys (label names) for tags generated by this module. Does not affect keys of tags passed in via the tags input. Possible values: lower, title, upper. Default value: title.	string	null	no
label_order	The order in which the labels (ID elements) appear in the id. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	list(string)	null	no
label_value_case	Controls the letter case of ID elements (labels) as included in id, set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input. Possible values: lower, title, upper and none (no transformation). Set this to title and set delimiter to "" to yield Pascal Case IDs. Default value: lower.	string	null	no
labels_as_tags	Set of labels (ID elements) to include as tags in the tags output. Default is to include all labels. Tags with empty values will not be included in the tags output. Set to [] to suppress all generated tags. Notes: The value of the name tag, if included, will be the id, not the name. Unlike other null-label inputs, the initial setting of labels_as_tags cannot be changed in later chained modules. Attempts to change it will be silently ignored.	set(string)	[ "default" ]	no
name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag. The "name" tag is set to the full id string. There is no tag with the value of the name input.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
network_address_usage_metrics_enabled	Set true to enable Network Address Usage Metrics for the VPC	bool	false	no
regex_replace_chars	Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.	string	null	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no

Outputs

Name	Description
additional_cidr_blocks	A list of the additional IPv4 CIDR blocks associated with the VPC
additional_cidr_blocks_to_association_ids	A map of the additional IPv4 CIDR blocks to VPC CIDR association IDs
additional_ipv6_cidr_blocks	A list of the additional IPv6 CIDR blocks associated with the VPC
additional_ipv6_cidr_blocks_to_association_ids	A map of the additional IPv6 CIDR blocks to VPC CIDR association IDs
igw_id	The ID of the Internet Gateway
ipv6_cidr_block_network_border_group	The IPv6 Network Border Group Zone name
ipv6_egress_only_igw_id	The ID of the egress-only Internet Gateway
vpc_arn	The ARN of the VPC
vpc_cidr_block	The primary IPv4 CIDR block of the VPC
vpc_default_network_acl_id	The ID of the network ACL created by default on VPC creation
vpc_default_route_table_id	The ID of the route table created by default on VPC creation
vpc_default_security_group_id	The ID of the security group created by default on VPC creation
vpc_id	The ID of the VPC
vpc_ipv6_association_id	The association ID for the primary IPv6 CIDR block
vpc_ipv6_cidr_block	The primary IPv6 CIDR block
vpc_main_route_table_id	The ID of the main route table associated with this VPC