Component: vpc

This component is responsible for provisioning a VPC and corresponding Subnets. Additionally, VPC Flow Logs can optionally be enabled for auditing purposes. See the existing VPC configuration documentation for the provisioned subnets.

Usage

Stack Level: Regional

Here's an example snippet for how to use this component.

# catalog/vpc/defaults or catalog/vpc
components:
  terraform:
    vpc/defaults:
      metadata:
        type: abstract
        component: vpc
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
        name: vpc
        availability_zones:
          - "a"
          - "b"
          - "c"
        nat_gateway_enabled: true
        nat_instance_enabled: false
        max_subnet_count: 3
        vpc_flow_logs_enabled: true
        vpc_flow_logs_bucket_environment_name: <environment>
        vpc_flow_logs_bucket_stage_name: audit
        vpc_flow_logs_traffic_type: "ALL"
        subnet_type_tag_key: "example.net/subnet/type"
        assign_generated_ipv6_cidr_block: true

import:
  - catalog/vpc

components:
  terraform:
    vpc:
      metadata:
        component: vpc
        inherits:
          - vpc/defaults
      vars:
        ipv4_primary_cidr_block: "10.111.0.0/18"

Requirements

Name	Version
terraform	>= 1.0.0
aws	>= 4.9.0

Providers

Name	Version
aws	>= 4.9.0

Modules

Name	Source	Version
endpoint_security_groups	cloudposse/security-group/aws	2.2.0
iam_roles	../account-map/modules/iam-roles	n/a
subnets	cloudposse/dynamic-subnets/aws	2.3.0
this	cloudposse/label/null	0.25.0
utils	cloudposse/utils/aws	1.3.0
vpc	cloudposse/vpc/aws	2.1.0
vpc_endpoints	cloudposse/vpc/aws//modules/vpc-endpoints	2.1.0
vpc_flow_logs_bucket	cloudposse/stack-config/yaml//modules/remote-state	1.5.0

Resources

Name	Type
aws_flow_log.default	resource
aws_shield_protection.nat_eip_shield_protection	resource
aws_caller_identity.current	data source
aws_eip.eip	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
assign_generated_ipv6_cidr_block	When true, assign AWS generated IPv6 CIDR block to the VPC. Conflicts with ipv6_ipam_pool_id.	bool	false	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
availability_zone_ids	List of Availability Zones IDs where subnets will be created. Overrides availability_zones. Can be the full name, e.g. use1-az1, or just the part after the AZ ID region code, e.g. -az1, to allow reusable values across regions. Consider contention for resources and spot pricing in each AZ when selecting. Useful in some regions when using only some AZs and you want to use the same ones across multiple accounts.	list(string)	[]	no
availability_zones	List of Availability Zones (AZs) where subnets will be created. Ignored when availability_zone_ids is set. Can be the full name, e.g. us-east-1a, or just the part after the region, e.g. a to allow reusable values across regions. The order of zones in the list must be stable or else Terraform will continually make changes. If no AZs are specified, then max_subnet_count AZs will be selected in alphabetical order. If max_subnet_count > 0 and length(var.availability_zones) > max_subnet_count, the list will be truncated. We recommend setting availability_zones and max_subnet_count explicitly as constant (not computed) values for predictability, consistency, and stability.	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
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
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
gateway_vpc_endpoints	A list of Gateway VPC Endpoints to provision into the VPC. Only valid values are "dynamodb" and "s3".	set(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
interface_vpc_endpoints	A list of Interface VPC Endpoints to provision into the VPC.	set(string)	[]	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_cidrs	Lists of CIDRs to assign to subnets. Order of CIDRs in the lists must not change over time. Lists may contain more CIDRs than needed.	list(object({ private = list(string) public = list(string) }))	[]	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
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
map_public_ip_on_launch	Instances launched into a public subnet should be assigned a public IP address	bool	true	no
max_subnet_count	Sets the maximum amount of subnets to deploy. 0 will deploy a subnet for every provided availability zone (in region_availability_zones variable) within the region	number	0	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
nat_eip_aws_shield_protection_enabled	Enable or disable AWS Shield Advanced protection for NAT EIPs. If set to 'true', a subscription to AWS Shield Advanced must exist in this account.	bool	false	no
nat_gateway_enabled	Flag to enable/disable NAT gateways	bool	true	no
nat_instance_ami_id	A list optionally containing the ID of the AMI to use for the NAT instance. If the list is empty (the default), the latest official AWS NAT instance AMI will be used. NOTE: The Official NAT instance AMI is being phased out and does not support NAT64. Use of a NAT gateway is recommended instead.	list(string)	[]	no
nat_instance_enabled	Flag to enable/disable NAT instances	bool	false	no
nat_instance_type	NAT Instance type	string	"t3.micro"	no
public_subnets_enabled	If false, do not create public subnets. Since NAT gateways and instances must be created in public subnets, these will also not be created when false.	bool	true	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	AWS Region	string	n/a	yes
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
subnet_type_tag_key	Key for subnet type tag to provide information about the type of subnets, e.g. cpco/subnet/type=private or cpcp/subnet/type=public	string	n/a	yes
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_flow_logs_bucket_environment_name	The name of the environment where the VPC Flow Logs bucket is provisioned	string	""	no
vpc_flow_logs_bucket_stage_name	The stage (account) name where the VPC Flow Logs bucket is provisioned	string	""	no
vpc_flow_logs_bucket_tenant_name	The name of the tenant where the VPC Flow Logs bucket is provisioned. If the tenant label is not used, leave this as null.	string	null	no
vpc_flow_logs_enabled	Enable or disable the VPC Flow Logs	bool	true	no
vpc_flow_logs_log_destination_type	The type of the logging destination. Valid values: cloud-watch-logs, s3	string	"s3"	no
vpc_flow_logs_traffic_type	The type of traffic to capture. Valid values: ACCEPT, REJECT, ALL	string	"ALL"	no

Outputs

Name	Description
availability_zones	List of Availability Zones where subnets were created
az_private_subnets_map	Map of AZ names to list of private subnet IDs in the AZs
az_public_subnets_map	Map of AZ names to list of public subnet IDs in the AZs
interface_vpc_endpoints	List of Interface VPC Endpoints in this VPC.
max_subnet_count	Maximum allowed number of subnets before all subnet CIDRs need to be recomputed
nat_eip_protections	List of AWS Shield Advanced Protections for NAT Elastic IPs.
nat_gateway_ids	NAT Gateway IDs
nat_gateway_public_ips	NAT Gateway public IPs
nat_instance_ids	NAT Instance IDs
private_route_table_ids	Private subnet route table IDs
private_subnet_cidrs	Private subnet CIDRs
private_subnet_ids	Private subnet IDs
public_route_table_ids	Public subnet route table IDs
public_subnet_cidrs	Public subnet CIDRs
public_subnet_ids	Public subnet IDs
route_tables	Route tables info map
subnets	Subnets info map
vpc	VPC info map
vpc_cidr	VPC CIDR
vpc_default_network_acl_id	The ID of the network ACL 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	VPC ID

References

• cloudposse/terraform-aws-components - Cloud Posse's upstream component