loganbest / terraform-aws-vpc

terraform-aws-vpc

I created this module to have an all-in-one VPC module that supports IPAM and AWS Network Firewall out of the box using best practices.

"enter example code here from terragrunt"

Requirements

Name	Version
terraform	>= 1.8
aws	~> 5.50
external	~> 2.0

Providers

Name	Version
aws	~> 5.50
external	~> 2.0

Modules

Name	Source	Version
this	cloudposse/label/null	0.25.0
vpc	terraform-aws-modules/vpc/aws	~> 5.8.0

Resources

Name	Type
aws_eip.this	resource
aws_internet_gateway.this	resource
aws_nat_gateway.this	resource
aws_route.default	resource
aws_route.vpc_peering	resource
aws_route_table.firewall	resource
aws_route_table.private	resource
aws_route_table.public	resource
aws_route_table_association.firewall	resource
aws_route_table_association.private	resource
aws_route_table_association.public	resource
aws_subnet.firewall	resource
aws_subnet.private	resource
aws_subnet.public	resource
aws_vpc_peering_connection.this	resource
aws_vpc_peering_connection_accepter.this	resource
aws_vpc_peering_connection_options.accepter	resource
aws_vpc_peering_connection_options.requester	resource
aws_region.current	data source
aws_vpc_ipam_pool.this	data source
aws_vpc_ipam_preview_next_cidr.this	data source
external_external.subnet_calculator	data source

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
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
cidr_mask_length	Mask length to yank from IPAM pool	number	21	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_security_group_egress	Egress rules for the VPC Default Security Group. By default set for allow nothing	list(map(string))	[]	no
default_security_group_ingress	Ingress rules for the VPC Default Security Group. By default set for allow nothing	list(map(string))	[]	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
enable_anf	Whether to enable the components needed for using AWS Network Firewall (Default: false)	bool	false	no
enable_ipam	Whether to enable the AWS VPC IPAM or not in CIDR selection (Default: false)	bool	false	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
firewall_subnets_cidrs	list of strings: declare cidrs for the firewall subnets	list(string)	[]	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
ipam_pool	AWS IPAM Pool Name	string	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
private_subnets_cidrs	list of strings: declare cidrs for the private subnets	list(string)	[]	no
public_subnets_cidrs	list of strings: declare cidrs for the public subnets	list(string)	[]	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
region_config	full region config	object({ enabled = bool short = string az_ids = list(string) })	n/a	yes
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
vpc_cidr	string: cidr for the vpc	string	n/a	yes
vpc_peers	List of maps defining the VPCs to peer with	list(map(object({ vpc_id = string account_id = string region = string cidr = string route_tables = list(string) })))	[]	no

Outputs

Name	Description
aws_eip	natgw.tf
aws_firewall_route_table_ids	n/a
aws_internet_gateway	n/a
aws_nat_gateway	n/a
aws_route_table_association_firewall	n/a
aws_route_table_association_private	n/a
aws_route_table_association_public	n/a
aws_route_table_firewall	n/a
aws_route_table_ids	n/a
aws_route_table_private	n/a
aws_route_table_public	n/a
aws_subnet_firewall	n/a
aws_subnet_firewall_ids	firewall.tf
aws_subnet_private	n/a
aws_subnet_private_ids	private.tf
aws_subnet_public	n/a
aws_subnet_public_ids	public.tf
vpc	Full VPC submodule output