Awesome

Terraform module to provision public and private subnets in an existing VPC

Note: This module is intended for use with an existing VPC and existing Internet Gateway. To create a new VPC, use terraform-aws-vpc module.

Note: Due to Terraform limitations, many optional inputs to this module are specified as a list(string) that can have zero or one element, rather than as a string that could be empty or null. The designation of an input as a list type does not necessarily mean that you can supply more than one value in the list, so check the input's description before supplying more than one value.

The core function of this module is to create 2 sets of subnets, a "public" set with bidirectional access to the public internet, and a "private" set behind a firewall with egress-only access to the public internet. This includes dividing up a given CIDR range so that a each subnet gets its own distinct CIDR range within that range, and then creating those subnets in the appropriate availability zones. The intention is to keep this module relatively simple and easy to use for the most popular use cases. In its default configuration, this module creates 1 public subnet and 1 private subnet in each of the specified availability zones. The public subnets are configured for bi-directional traffic to the public internet, while the private subnets are configured for egress-only traffic to the public internet. Rather than provide a wealth of configuration options allowing for numerous special cases, this module provides some common options and further provides the ability to suppress the creation of resources, allowing you to create and configure them as you like from outside this module. For example, rather than give you the option to customize the Network ACL, the module gives you the option to create a completely open one (and control access via Security Groups and other means) or not create one at all, allowing you to create and configure one yourself.

Public subnets

This module defines a public subnet as one that has direct access to an internet gateway and can accept incoming connection requests. In the simplest configuration, the module creates a single route table with a default route targeted to the VPC's internet gateway, and associates all the public subnets with that single route table.

Likewise it creates a single Network ACL with associated rules allowing all ingress and all egress, and associates that ACL with all the public subnets.

Private subnets

A private subnet may be able to initiate traffic to the public internet through a NAT gateway, a NAT instance, or an egress-only internet gateway, or it might only have direct access to other private subnets. In the simple configuration, for IPv4 and/or IPv6 with NAT64 enabled via public_dns64_enabled or private_dns64_enabled, the module creates 1 NAT Gateway or NAT Instance for each private subnet (in the public subnet in the same availability zone), creates 1 route table for each private subnet, and adds to that route table a default route from the subnet to its NAT Gateway or Instance. For IPv6, the module adds a route to the Egress-Only Internet Gateway configured via input.

As with the Public subnets, the module creates a single Network ACL with associated rules allowing all ingress and all egress, and associates that ACL with all the private subnets.

Customization for special use cases

Various features are controlled by bool inputs with names ending in _enabled. By changing the default values, you can enable or disable creation of public subnets, private subnets, route tables, NAT gateways, NAT instances, or Network ACLs. So for example, you could use this module to create only private subnets and the open Network ACL, and then add your own route table associations to the subnets and route all non-local traffic to a Transit Gateway or VPN.

CIDR allocation

For IPv4, you provide a CIDR and the module divides the address space into the largest CIDRs possible that are still small enough to accommodate max_subnet_count subnets of each enabled type (public or private). When max_subnet_count is left at the default 0, it is set to the total number of availability zones in the region. Private subnets are allocated out of the first half of the reserved range, and public subnets are allocated out of the second half.

For IPv6, you provide a /56 CIDR and the module assigns /64 subnets of that CIDR in consecutive order starting at zero. (You have the option of specifying a list of CIDRs instead.) As with IPv4, enough CIDRs are allocated to cover max_subnet_count private and public subnets (when both are enabled, which is the default), with the private subnets being allocated out of the lower half of the reservation and the public subnets allocated out of the upper half.

[!TIP]

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. Works with Github Actions, Atlantis, or Spacelift.
<details> <summary>Watch demo of using Atmos with Terraform</summary> <img src="https://github.com/cloudposse/atmos/blob/master/docs/demo.gif?raw=true"/> Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial. </detalis>

Usage

module "subnets" {
  source = "cloudposse/dynamic-subnets/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"
  namespace           = "eg"
  stage               = "prod"
  name                = "app"
  vpc_id              = "vpc-XXXXXXXX"
  igw_id              = ["igw-XXXXXXXX"]
  ipv4_cidr_block     = ["10.0.0.0/16"]
  availability_zones  = ["us-east-1a", "us-east-1b"]
}

Create only private subnets, route to transit gateway:

module "private_tgw_subnets" {
  source = "cloudposse/dynamic-subnets/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"
  namespace           = "eg"
  stage               = "prod"
  name                = "app"
  vpc_id              = "vpc-XXXXXXXX"
  igw_id              = ["igw-XXXXXXXX"]
  ipv4_cidr_block     = ["10.0.0.0/16"]
  availability_zones  = ["us-east-1a", "us-east-1b"]

  nat_gateway_enabled    = false
  public_subnets_enabled = false
}

resource "aws_route" "private" {
  count = length(module.private_tgw_subnets.private_route_table_ids)

  route_table_id         = module.private_tgw_subnets.private_route_table_ids[count.index]
  destination_cidr_block = "0.0.0.0/0"
  transit_gateway_id     = "tgw-XXXXXXXXX"
}

See examples for working examples. In particular, see examples/nacls for an example of how to create custom Network Access Control Lists (NACLs) outside of but in conjunction with this module.

[!IMPORTANT] In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Subnet calculation logic

terraform-aws-dynamic-subnets creates a set of subnets based on various CIDR inputs and the maximum possible number of subnets, which is max_subnet_count when specified or the number of Availability Zones in the region when max_subnet_count is left at its default value of zero.

You can explicitly provide CIDRs for subnets via ipv4_cidrs and ipv6_cidrs inputs if you want, but the usual use case is to provide a single CIDR which this module will subdivide into a set of CIDRs as follows:

Get number of available AZ in the region:

existing_az_count = length(data.aws_availability_zones.available.names)

Determine how many sets of subnets are being created. (Usually it is 2: public and private): subnet_type_count.
Multiply the results of (1) and (2) to determine how many CIDRs to reserve:

cidr_count = existing_az_count * subnet_type_count

Calculate the number of bits needed to enumerate all the CIDRs:

subnet_bits = ceil(log(cidr_count, 2))

Reserve CIDRs for private subnets using cidrsubnet:

private_subnet_cidrs = [ for netnumber in range(0, existing_az_count): cidrsubnet(cidr_block, subnet_bits, netnumber) ]

Reserve CIDRs for public subnets in the second half of the CIDR block:

public_subnet_cidrs = [ for netnumber in range(existing_az_count, existing_az_count * 2): cidrsubnet(cidr_block, subnet_bits, netnumber) ]

Note that this means that, for example, in a region with 4 availability zones, if you specify only 3 availability zones in var.availability_zones, this module will still reserve CIDRs for the 4th zone. This is so that if you later want to expand into that zone, the existing subnet CIDR assignments will not be disturbed. If you do not want to reserve these CIDRs, set max_subnet_count to the number of zones you are actually using.

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

Name	Version
<a name="requirement_terraform"></a> terraform	>= 1.1.0
<a name="requirement_aws"></a> aws	>= 3.71.0

Providers

Name	Version
<a name="provider_aws"></a> aws	>= 3.71.0

Modules

Name	Source	Version
<a name="module_nat_instance_label"></a> nat_instance_label	cloudposse/label/null	0.25.0
<a name="module_nat_label"></a> nat_label	cloudposse/label/null	0.25.0
<a name="module_private_label"></a> private_label	cloudposse/label/null	0.25.0
<a name="module_public_label"></a> public_label	cloudposse/label/null	0.25.0
<a name="module_this"></a> this	cloudposse/label/null	0.25.0
<a name="module_utils"></a> utils	cloudposse/utils/aws	1.4.0

Resources

Name	Type
aws_eip.default	resource
aws_eip_association.nat_instance	resource
aws_instance.nat_instance	resource
aws_nat_gateway.default	resource
aws_network_acl.private	resource
aws_network_acl.public	resource
aws_network_acl_rule.private4_egress	resource
aws_network_acl_rule.private4_ingress	resource
aws_network_acl_rule.private6_egress	resource
aws_network_acl_rule.private6_ingress	resource
aws_network_acl_rule.public4_egress	resource
aws_network_acl_rule.public4_ingress	resource
aws_network_acl_rule.public6_egress	resource
aws_network_acl_rule.public6_ingress	resource
aws_route.nat4	resource
aws_route.nat_instance	resource
aws_route.private6	resource
aws_route.private_nat64	resource
aws_route.public	resource
aws_route.public6	resource
aws_route.public_nat64	resource
aws_route_table.private	resource
aws_route_table.public	resource
aws_route_table_association.private	resource
aws_route_table_association.public	resource
aws_security_group.nat_instance	resource
aws_security_group_rule.nat_instance_egress	resource
aws_security_group_rule.nat_instance_ingress	resource
aws_subnet.private	resource
aws_subnet.public	resource
aws_ami.nat_instance	data source
aws_availability_zones.default	data source
aws_eip.nat	data source
aws_vpc.default	data source

Inputs

Name	Description	Type	Default	Required
<a name="input_additional_tag_map"></a> additional_tag_map	Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br/>This is for some rare cases where resources want additional configuration of tags<br/>and therefore take a list of maps with tag key, value, and additional configuration.	`map(string)`	`{}`	no
<a name="input_attributes"></a> attributes	ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br/>in the order they appear in the list. New attributes are appended to the<br/>end of the list. The elements of the list are joined by the `delimiter`<br/>and treated as a single ID element.	`list(string)`	`[]`	no
<a name="input_availability_zone_attribute_style"></a> availability_zone_attribute_style	The style of Availability Zone code to use in tags and names. One of `full`, `short`, or `fixed`.<br/>When using `availability_zone_ids`, IDs will first be translated into AZ names.	`string`	`"short"`	no
<a name="input_availability_zone_ids"></a> availability_zone_ids	List of Availability Zones IDs where subnets will be created. Overrides `availability_zones`.<br/>Useful in some regions when using only some AZs and you want to use the same ones across multiple accounts.	`list(string)`	`[]`	no
<a name="input_availability_zones"></a> availability_zones	List of Availability Zones (AZs) where subnets will be created. Ignored when `availability_zone_ids` is set.<br/>The order of zones in the list must be stable or else Terraform will continually make changes.<br/>If no AZs are specified, then `max_subnet_count` AZs will be selected in alphabetical order.<br/>If `max_subnet_count > 0` and `length(var.availability_zones) > max_subnet_count`, the list<br/>will be truncated. We recommend setting `availability_zones` and `max_subnet_count` explicitly as constant<br/>(not computed) values for predictability, consistency, and stability.	`list(string)`	`[]`	no
<a name="input_aws_route_create_timeout"></a> aws_route_create_timeout	DEPRECATED: Use `route_create_timeout` instead.<br/>Time to wait for AWS route creation, specified as a Go Duration, e.g. `2m`	`string`	`null`	no
<a name="input_aws_route_delete_timeout"></a> aws_route_delete_timeout	DEPRECATED: Use `route_delete_timeout` instead.<br/>Time to wait for AWS route deletion, specified as a Go Duration, e.g. `2m`	`string`	`null`	no
<a name="input_context"></a> context	Single object for setting entire context at once.<br/>See description of individual variables for details.<br/>Leave string and numeric variables as `null` to use default value.<br/>Individual variable settings (non-null) override settings in context object,<br/>except for attributes, tags, and additional_tag_map, which are merged.	`any`	<pre>{<br/> "additional_tag_map": {},<br/> "attributes": [],<br/> "delimiter": null,<br/> "descriptor_formats": {},<br/> "enabled": true,<br/> "environment": null,<br/> "id_length_limit": null,<br/> "label_key_case": null,<br/> "label_order": [],<br/> "label_value_case": null,<br/> "labels_as_tags": [<br/> "unset"<br/> ],<br/> "name": null,<br/> "namespace": null,<br/> "regex_replace_chars": null,<br/> "stage": null,<br/> "tags": {},<br/> "tenant": null<br/>}</pre>	no
<a name="input_delimiter"></a> delimiter	Delimiter to be used between ID elements.<br/>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
<a name="input_descriptor_formats"></a> descriptor_formats	Describe additional descriptors to be output in the `descriptors` output map.<br/>Map of maps. Keys are names of descriptors. Values are maps of the form<br/>`{<br/> format = string<br/> labels = list(string)<br/>}`<br/>(Type is `any` so the map values can later be enhanced to provide additional options.)<br/>`format` is a Terraform format string to be passed to the `format()` function.<br/>`labels` is a list of labels, in order, to pass to `format()` function.<br/>Label values will be normalized before being passed to `format()` so they will be<br/>identical to how they appear in `id`.<br/>Default is `{}` (`descriptors` output will be empty).	`any`	`{}`	no
<a name="input_enabled"></a> enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
<a name="input_environment"></a> environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
<a name="input_id_length_limit"></a> id_length_limit	Limit `id` to this many characters (minimum 6).<br/>Set to `0` for unlimited length.<br/>Set to `null` for keep the existing setting, which defaults to `0`.<br/>Does not affect `id_full`.	`number`	`null`	no
<a name="input_igw_id"></a> igw_id	The Internet Gateway ID that the public subnets will route traffic to.<br/>Used if `public_route_table_enabled` is `true`, ignored otherwise.	`list(string)`	`[]`	no
<a name="input_ipv4_cidr_block"></a> ipv4_cidr_block	Base IPv4 CIDR block which will be divided into subnet CIDR blocks (e.g. `10.0.0.0/16`). Ignored if `ipv4_cidrs` is set.<br/>If no CIDR block is provided, the VPC's default IPv4 CIDR block will be used.	`list(string)`	`[]`	no
<a name="input_ipv4_cidrs"></a> ipv4_cidrs	Lists of CIDRs to assign to subnets. Order of CIDRs in the lists must not change over time.<br/>Lists may contain more CIDRs than needed.	<pre>list(object({<br/> private = list(string)<br/> public = list(string)<br/> }))</pre>	`[]`	no
<a name="input_ipv4_enabled"></a> ipv4_enabled	Set `true` to enable IPv4 addresses in the subnets	`bool`	`true`	no
<a name="input_ipv4_private_instance_hostname_type"></a> ipv4_private_instance_hostname_type	How to generate the DNS name for the instances in the private subnets.<br/>Either `ip-name` to generate it from the IPv4 address, or<br/>`resource-name` to generate it from the instance ID.	`string`	`"ip-name"`	no
<a name="input_ipv4_private_instance_hostnames_enabled"></a> ipv4_private_instance_hostnames_enabled	If `true`, DNS queries for instance hostnames in the private subnets will be answered with A (IPv4) records.	`bool`	`false`	no
<a name="input_ipv4_public_instance_hostname_type"></a> ipv4_public_instance_hostname_type	How to generate the DNS name for the instances in the public subnets.<br/>Either `ip-name` to generate it from the IPv4 address, or<br/>`resource-name` to generate it from the instance ID.	`string`	`"ip-name"`	no
<a name="input_ipv4_public_instance_hostnames_enabled"></a> ipv4_public_instance_hostnames_enabled	If `true`, DNS queries for instance hostnames in the public subnets will be answered with A (IPv4) records.	`bool`	`false`	no
<a name="input_ipv6_cidr_block"></a> ipv6_cidr_block	Base IPv6 CIDR block from which `/64` subnet CIDRs will be assigned. Must be `/56`. (e.g. `2600:1f16:c52:ab00::/56`).<br/>Ignored if `ipv6_cidrs` is set. If no CIDR block is provided, the VPC's default IPv6 CIDR block will be used.	`list(string)`	`[]`	no
<a name="input_ipv6_cidrs"></a> ipv6_cidrs	Lists of CIDRs to assign to subnets. Order of CIDRs in the lists must not change over time.<br/>Lists may contain more CIDRs than needed.	<pre>list(object({<br/> private = list(string)<br/> public = list(string)<br/> }))</pre>	`[]`	no
<a name="input_ipv6_egress_only_igw_id"></a> ipv6_egress_only_igw_id	The Egress Only Internet Gateway ID the private IPv6 subnets will route traffic to.<br/>Used if `private_route_table_enabled` is `true` and `ipv6_enabled` is `true`, ignored otherwise.	`list(string)`	`[]`	no
<a name="input_ipv6_enabled"></a> ipv6_enabled	Set `true` to enable IPv6 addresses in the subnets	`bool`	`false`	no
<a name="input_ipv6_private_instance_hostnames_enabled"></a> ipv6_private_instance_hostnames_enabled	If `true` (or if `ipv4_enabled` is `false`), DNS queries for instance hostnames in the private subnets will be answered with AAAA (IPv6) records.	`bool`	`false`	no
<a name="input_ipv6_public_instance_hostnames_enabled"></a> ipv6_public_instance_hostnames_enabled	If `true` (or if `ipv4_enabled` is false), DNS queries for instance hostnames in the public subnets will be answered with AAAA (IPv6) records.	`bool`	`false`	no
<a name="input_label_key_case"></a> label_key_case	Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper`.<br/>Default value: `title`.	`string`	`null`	no
<a name="input_label_order"></a> label_order	The order in which the labels (ID elements) appear in the `id`.<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	`list(string)`	`null`	no
<a name="input_label_value_case"></a> label_value_case	Controls the letter case of ID elements (labels) as included in `id`,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br/>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br/>Default value: `lower`.	`string`	`null`	no
<a name="input_labels_as_tags"></a> labels_as_tags	Set of labels (ID elements) to include as tags in the `tags` output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the `tags` output.<br/>Set to `[]` to suppress all generated tags.<br/>Notes:<br/> The value of the `name` tag, if included, will be the `id`, not the `name`.<br/> Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored.	`set(string)`	<pre>[<br/> "default"<br/>]</pre>	no
<a name="input_map_public_ip_on_launch"></a> map_public_ip_on_launch	If `true`, instances launched into a public subnet will be assigned a public IPv4 address	`bool`	`true`	no
<a name="input_max_nats"></a> max_nats	Upper limit on number of NAT Gateways/Instances to create.<br/>Set to 1 or 2 for cost savings at the expense of availability.	`number`	`999`	no
<a name="input_max_subnet_count"></a> max_subnet_count	Sets the maximum number of each type (public or private) of subnet to deploy.<br/>`0` will reserve a CIDR for every Availability Zone (excluding Local Zones) in the region, and<br/>deploy a subnet in each availability zone specified in `availability_zones` or `availability_zone_ids`,<br/>or every zone if none are specified. We recommend setting this equal to the maximum number of AZs you anticipate using,<br/>to avoid causing subnets to be destroyed and recreated with smaller IPv4 CIDRs when AWS adds an availability zone.<br/>Due to Terraform limitations, you can not set `max_subnet_count` from a computed value, you have to set it<br/>from an explicit constant. For most cases, `3` is a good choice.	`number`	`0`	no
<a name="input_metadata_http_endpoint_enabled"></a> metadata_http_endpoint_enabled	Whether the metadata service is available on the created NAT instances	`bool`	`true`	no
<a name="input_metadata_http_put_response_hop_limit"></a> metadata_http_put_response_hop_limit	The desired HTTP PUT response hop limit (between 1 and 64) for instance metadata requests on the created NAT instances	`number`	`1`	no
<a name="input_metadata_http_tokens_required"></a> metadata_http_tokens_required	Whether or not the metadata service requires session tokens, also referred to as Instance Metadata Service Version 2, on the created NAT instances	`bool`	`true`	no
<a name="input_name"></a> name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a `tag`.<br/>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.	`string`	`null`	no
<a name="input_namespace"></a> 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
<a name="input_nat_elastic_ips"></a> nat_elastic_ips	Existing Elastic IPs (not EIP IDs) to attach to the NAT Gateway(s) or Instance(s) instead of creating new ones.	`list(string)`	`[]`	no
<a name="input_nat_gateway_enabled"></a> nat_gateway_enabled	Set `true` to create NAT Gateways to perform IPv4 NAT and NAT64 as needed.<br/>Defaults to `true` unless `nat_instance_enabled` is `true`.	`bool`	`null`	no
<a name="input_nat_instance_ami_id"></a> nat_instance_ami_id	A list optionally containing the ID of the AMI to use for the NAT instance.<br/>If the list is empty (the default), the latest official AWS NAT instance AMI<br/>will be used. NOTE: The Official NAT instance AMI is being phased out and<br/>does not support NAT64. Use of a NAT gateway is recommended instead.	`list(string)`	`[]`	no
<a name="input_nat_instance_cpu_credits_override"></a> nat_instance_cpu_credits_override	NAT Instance credit option for CPU usage. Valid values are "standard" or "unlimited".<br/>T3 and later instances are launched as unlimited by default. T2 instances are launched as standard by default.	`string`	`""`	no
<a name="input_nat_instance_enabled"></a> nat_instance_enabled	Set `true` to create NAT Instances to perform IPv4 NAT.<br/>Defaults to `false`.	`bool`	`null`	no
<a name="input_nat_instance_root_block_device_encrypted"></a> nat_instance_root_block_device_encrypted	Whether to encrypt the root block device on the created NAT instances	`bool`	`true`	no
<a name="input_nat_instance_type"></a> nat_instance_type	NAT Instance type	`string`	`"t3.micro"`	no
<a name="input_open_network_acl_ipv4_rule_number"></a> open_network_acl_ipv4_rule_number	The `rule_no` assigned to the network ACL rules for IPv4 traffic generated by this module	`number`	`100`	no
<a name="input_open_network_acl_ipv6_rule_number"></a> open_network_acl_ipv6_rule_number	The `rule_no` assigned to the network ACL rules for IPv6 traffic generated by this module	`number`	`111`	no
<a name="input_private_assign_ipv6_address_on_creation"></a> private_assign_ipv6_address_on_creation	If `true`, network interfaces created in a private subnet will be assigned an IPv6 address	`bool`	`true`	no
<a name="input_private_dns64_nat64_enabled"></a> private_dns64_nat64_enabled	If `true` and IPv6 is enabled, DNS queries made to the Amazon-provided DNS Resolver in private subnets will return synthetic<br/>IPv6 addresses for IPv4-only destinations, and these addresses will be routed to the NAT Gateway.<br/>Requires `public_subnets_enabled`, `nat_gateway_enabled`, and `private_route_table_enabled` to be `true` to be fully operational.<br/>Defaults to `true` unless there is no public IPv4 subnet for egress, in which case it defaults to `false`.	`bool`	`null`	no
<a name="input_private_label"></a> private_label	The string to use in IDs and elsewhere to identify resources for the private subnets and distinguish them from resources for the public subnets	`string`	`"private"`	no
<a name="input_private_open_network_acl_enabled"></a> private_open_network_acl_enabled	If `true`, a single network ACL be created and it will be associated with every private subnet, and a rule (number 100)<br/>will be created allowing all ingress and all egress. You can add additional rules to this network ACL<br/>using the `aws_network_acl_rule` resource.<br/>If `false`, you will need to manage the network ACL outside of this module.	`bool`	`true`	no
<a name="input_private_route_table_enabled"></a> private_route_table_enabled	If `true`, a network route table and default route to the NAT gateway, NAT instance, or egress-only gateway<br/>will be created for each private subnet (1:1). If false, you will need to create your own route table(s) and route(s).	`bool`	`true`	no
<a name="input_private_subnets_additional_tags"></a> private_subnets_additional_tags	Additional tags to be added to private subnets	`map(string)`	`{}`	no
<a name="input_private_subnets_enabled"></a> private_subnets_enabled	If false, do not create private subnets (or NAT gateways or instances)	`bool`	`true`	no
<a name="input_public_assign_ipv6_address_on_creation"></a> public_assign_ipv6_address_on_creation	If `true`, network interfaces created in a public subnet will be assigned an IPv6 address	`bool`	`true`	no
<a name="input_public_dns64_nat64_enabled"></a> public_dns64_nat64_enabled	If `true` and IPv6 is enabled, DNS queries made to the Amazon-provided DNS Resolver in public subnets will return synthetic<br/>IPv6 addresses for IPv4-only destinations, and these addresses will be routed to the NAT Gateway.<br/>Requires `nat_gateway_enabled` and `public_route_table_enabled` to be `true` to be fully operational.	`bool`	`false`	no
<a name="input_public_label"></a> public_label	The string to use in IDs and elsewhere to identify resources for the public subnets and distinguish them from resources for the private subnets	`string`	`"public"`	no
<a name="input_public_open_network_acl_enabled"></a> public_open_network_acl_enabled	If `true`, a single network ACL be created and it will be associated with every public subnet, and a rule<br/>will be created allowing all ingress and all egress. You can add additional rules to this network ACL<br/>using the `aws_network_acl_rule` resource.<br/>If `false`, you will need to manage the network ACL outside of this module.	`bool`	`true`	no
<a name="input_public_route_table_enabled"></a> public_route_table_enabled	If `true`, network route table(s) will be created as determined by `public_route_table_per_subnet_enabled` and<br/>appropriate routes will be added to destinations this module knows about.<br/>If `false`, you will need to create your own route table(s) and route(s).<br/>Ignored if `public_route_table_ids` is non-empty.	`bool`	`true`	no
<a name="input_public_route_table_ids"></a> public_route_table_ids	List optionally containing the ID of a single route table shared by all public subnets<br/>or exactly one route table ID for each public subnet.<br/>If provided, it overrides `public_route_table_per_subnet_enabled`.<br/>If omitted and `public_route_table_enabled` is `true`,<br/>one or more network route tables will be created for the public subnets,<br/>according to the setting of `public_route_table_per_subnet_enabled`.	`list(string)`	`[]`	no
<a name="input_public_route_table_per_subnet_enabled"></a> public_route_table_per_subnet_enabled	If `true` (and `public_route_table_enabled` is `true`), a separate network route table will be created for and associated with each public subnet.<br/>If `false` (and `public_route_table_enabled` is `true`), a single network route table will be created and it will be associated with every public subnet.<br/>If not set, it will be set to the value of `public_dns64_nat64_enabled`.	`bool`	`null`	no
<a name="input_public_subnets_additional_tags"></a> public_subnets_additional_tags	Additional tags to be added to public subnets	`map(string)`	`{}`	no
<a name="input_public_subnets_enabled"></a> public_subnets_enabled	If false, do not create public subnets.<br/>Since NAT gateways and instances must be created in public subnets, these will also not be created when `false`.	`bool`	`true`	no
<a name="input_regex_replace_chars"></a> regex_replace_chars	Terraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.	`string`	`null`	no
<a name="input_root_block_device_encrypted"></a> root_block_device_encrypted	DEPRECATED: use `nat_instance_root_block_device_encrypted` instead.<br/>Whether to encrypt the root block device on the created NAT instances	`bool`	`null`	no
<a name="input_route_create_timeout"></a> route_create_timeout	Time to wait for a network routing table entry to be created, specified as a Go Duration, e.g. `2m`. Use `null` for proivder default.	`string`	`null`	no
<a name="input_route_delete_timeout"></a> route_delete_timeout	Time to wait for a network routing table entry to be deleted, specified as a Go Duration, e.g. `2m`. Use `null` for proivder default.	`string`	`null`	no
<a name="input_stage"></a> stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
<a name="input_subnet_create_timeout"></a> subnet_create_timeout	Time to wait for a subnet to be created, specified as a Go Duration, e.g. `2m`. Use `null` for proivder default.	`string`	`null`	no
<a name="input_subnet_delete_timeout"></a> subnet_delete_timeout	Time to wait for a subnet to be deleted, specified as a Go Duration, e.g. `5m`. Use `null` for proivder default.	`string`	`null`	no
<a name="input_subnet_type_tag_key"></a> subnet_type_tag_key	DEPRECATED: Use `public_subnets_additional_tags` and `private_subnets_additional_tags` instead<br/>Key for subnet type tag to provide information about the type of subnets, e.g. `cpco.io/subnet/type: private` or `cpco.io/subnet/type: public`	`string`	`null`	no
<a name="input_subnet_type_tag_value_format"></a> subnet_type_tag_value_format	DEPRECATED: Use `public_subnets_additional_tags` and `private_subnets_additional_tags` instead.<br/>The value of the `subnet_type_tag_key` will be set to `format(var.subnet_type_tag_value_format, <type>)`<br/>where `<type>` is either `public` or `private`.	`string`	`"%s"`	no
<a name="input_subnets_per_az_count"></a> subnets_per_az_count	The number of subnet of each type (public or private) to provision per Availability Zone.	`number`	`1`	no
<a name="input_subnets_per_az_names"></a> subnets_per_az_names	The subnet names of each type (public or private) to provision per Availability Zone.<br/>This variable is optional.<br/>If a list of names is provided, the list items will be used as keys in the outputs `named_private_subnets_map`, `named_public_subnets_map`,<br/>`named_private_route_table_ids_map` and `named_public_route_table_ids_map`	`list(string)`	<pre>[<br/> "common"<br/>]</pre>	no
<a name="input_tags"></a> tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br/>Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
<a name="input_tenant"></a> tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no
<a name="input_vpc_id"></a> vpc_id	VPC ID where subnets will be created (e.g. `vpc-aceb2723`)	`string`	n/a	yes

Outputs

Name	Description
<a name="output_availability_zone_ids"></a> availability_zone_ids	List of Availability Zones IDs where subnets were created, when available
<a name="output_availability_zones"></a> availability_zones	List of Availability Zones where subnets were created
<a name="output_az_private_route_table_ids_map"></a> az_private_route_table_ids_map	Map of AZ names to list of private route table IDs in the AZs
<a name="output_az_private_subnets_map"></a> az_private_subnets_map	Map of AZ names to list of private subnet IDs in the AZs
<a name="output_az_public_route_table_ids_map"></a> az_public_route_table_ids_map	Map of AZ names to list of public route table IDs in the AZs
<a name="output_az_public_subnets_map"></a> az_public_subnets_map	Map of AZ names to list of public subnet IDs in the AZs
<a name="output_named_private_route_table_ids_map"></a> named_private_route_table_ids_map	Map of subnet names (specified in `subnets_per_az_names` variable) to lists of private route table IDs
<a name="output_named_private_subnets_map"></a> named_private_subnets_map	Map of subnet names (specified in `subnets_per_az_names` variable) to lists of private subnet IDs
<a name="output_named_private_subnets_stats_map"></a> named_private_subnets_stats_map	Map of subnet names (specified in `subnets_per_az_names` variable) to lists of objects with each object having three items: AZ, private subnet ID, private route table ID
<a name="output_named_public_route_table_ids_map"></a> named_public_route_table_ids_map	Map of subnet names (specified in `subnets_per_az_names` variable) to lists of public route table IDs
<a name="output_named_public_subnets_map"></a> named_public_subnets_map	Map of subnet names (specified in `subnets_per_az_names` variable) to lists of public subnet IDs
<a name="output_named_public_subnets_stats_map"></a> named_public_subnets_stats_map	Map of subnet names (specified in `subnets_per_az_names` variable) to lists of objects with each object having three items: AZ, public subnet ID, public route table ID
<a name="output_nat_eip_allocation_ids"></a> nat_eip_allocation_ids	Elastic IP allocations in use by NAT
<a name="output_nat_gateway_ids"></a> nat_gateway_ids	IDs of the NAT Gateways created
<a name="output_nat_gateway_public_ips"></a> nat_gateway_public_ips	DEPRECATED: use `nat_ips` instead. Public IPv4 IP addresses in use by NAT.
<a name="output_nat_instance_ami_id"></a> nat_instance_ami_id	ID of AMI used by NAT instance
<a name="output_nat_instance_ids"></a> nat_instance_ids	IDs of the NAT Instances created
<a name="output_nat_ips"></a> nat_ips	Elastic IP Addresses in use by NAT
<a name="output_private_network_acl_id"></a> private_network_acl_id	ID of the Network ACL created for private subnets
<a name="output_private_route_table_ids"></a> private_route_table_ids	IDs of the created private route tables
<a name="output_private_subnet_arns"></a> private_subnet_arns	ARNs of the created private subnets
<a name="output_private_subnet_cidrs"></a> private_subnet_cidrs	IPv4 CIDR blocks of the created private subnets
<a name="output_private_subnet_ids"></a> private_subnet_ids	IDs of the created private subnets
<a name="output_private_subnet_ipv6_cidrs"></a> private_subnet_ipv6_cidrs	IPv6 CIDR blocks of the created private subnets
<a name="output_public_network_acl_id"></a> public_network_acl_id	ID of the Network ACL created for public subnets
<a name="output_public_route_table_ids"></a> public_route_table_ids	IDs of the created public route tables
<a name="output_public_subnet_arns"></a> public_subnet_arns	ARNs of the created public subnets
<a name="output_public_subnet_cidrs"></a> public_subnet_cidrs	IPv4 CIDR blocks of the created public subnets
<a name="output_public_subnet_ids"></a> public_subnet_ids	IDs of the created public subnets
<a name="output_public_subnet_ipv6_cidrs"></a> public_subnet_ipv6_cidrs	IPv6 CIDR blocks of the created public subnets

Related Projects

Check out these related projects.

terraform-aws-vpc - Terraform Module that defines a VPC with public/private subnets across multiple AZs with Internet Gateways
terraform-aws-vpc-peering - Terraform module to create a peering connection between two VPCs
terraform-aws-kops-vpc-peering - Terraform module to create a peering connection between a backing services VPC and a VPC created by Kops
terraform-aws-named-subnets - Terraform module for named subnets provisioning.

[!TIP]

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team. ✅ Your team owns everything. ✅ 100% Open Source and backed by fanatical support. 

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamic-subnets&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
<details><summary>📚 Learn More</summary> 
Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.

Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.

Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.

Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.

GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamic-subnets&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

Day-2: Your Operational Mastery

Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.

Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.

Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.

Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.

Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.

Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.

Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamic-subnets&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
</details>

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamic-subnets&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

<details> <summary>Preamble to the Apache License, Version 2.0</summary>

Complete license is available in the LICENSE file.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

</details>

Trademarks

All other trademarks referenced herein are the property of their respective owners.