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"

Variables

Required Variables

region (string) required: AWS Region
subnet_type_tag_key (string) required: Key for subnet type tag to provide information about the type of subnets, e.g. cpco/subnet/type=private or cpcp/subnet/type=public

Optional Variables

assign_generated_ipv6_cidr_block (bool) optional

When true, assign AWS generated IPv6 CIDR block to the VPC. Conflicts with ipv6_ipam_pool_id.

Default value: false

availability_zone_ids (list(string)) optional

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.

Default value: [ ]

availability_zones (list(string)) optional

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.

Default value: [ ]

gateway_vpc_endpoints (set(string)) optional

A list of Gateway VPC Endpoints to provision into the VPC. Only valid values are "dynamodb" and "s3".

Default value: [ ]

interface_vpc_endpoints (set(string)) optional

A list of Interface VPC Endpoints to provision into the VPC.

Default value: [ ]

ipv4_additional_cidr_block_associations optional

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.

Type:

map(object({
ipv4_cidr_block     = string
ipv4_ipam_pool_id   = string
ipv4_netmask_length = number
}))

Default value: { }

ipv4_cidr_block_association_timeouts optional

Timeouts (in go duration format) for creating and destroying IPv4 CIDR block associations

Type:

object({
create = string
delete = string
})

Default value: null

ipv4_cidrs optional

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.

Type:

list(object({
private = list(string)
public  = list(string)
}))

Default value: [ ]

ipv4_primary_cidr_block (string) optional

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.

Default value: null

ipv4_primary_cidr_block_association optional

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.

Type:

object({
ipv4_ipam_pool_id   = string
ipv4_netmask_length = number
})

Default value: null

map_public_ip_on_launch (bool) optional

Instances launched into a public subnet should be assigned a public IP address

Default value: true

max_nats (number) optional

Upper limit on number of NAT Gateways/Instances to create.
Set to 1 or 2 for cost savings at the expense of availability.
Default creates a NAT Gateway in each public subnet.

Default value: null

max_subnet_count (number) optional

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

Default value: 0

nat_eip_aws_shield_protection_enabled (bool) optional

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.

Default value: false

nat_gateway_enabled (bool) optional

Flag to enable/disable NAT gateways

Default value: true

nat_instance_ami_id (list(string)) optional

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.

Default value: [ ]

nat_instance_enabled (bool) optional

Flag to enable/disable NAT instances

Default value: false

nat_instance_type (string) optional

NAT Instance type

Default value: "t3.micro"

public_subnets_enabled (bool) optional

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.

Default value: true

subnets_per_az_count (number) optional

The number of subnet of each type (public or private) to provision per Availability Zone.

Default value: 1

subnets_per_az_names (list(string)) optional

The subnet names of each type (public or private) to provision per Availability Zone.
This variable is optional.
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,
named_private_route_table_ids_map and named_public_route_table_ids_map

Default value:

[
  "common"
]

vpc_flow_logs_bucket_component_name (string) optional

The name of the VPC flow logs bucket component

Default value: "vpc-flow-logs-bucket"

vpc_flow_logs_bucket_environment_name (string) optional

The name of the environment where the VPC Flow Logs bucket is provisioned

Default value: ""

vpc_flow_logs_bucket_stage_name (string) optional

The stage (account) name where the VPC Flow Logs bucket is provisioned

Default value: ""

vpc_flow_logs_bucket_tenant_name (string) optional

The name of the tenant where the VPC Flow Logs bucket is provisioned.

If the tenant label is not used, leave this as null.

Default value: null

vpc_flow_logs_destination_options_file_format (string) optional

VPC Flow Logs file format

Default value: "parquet"

vpc_flow_logs_destination_options_hive_compatible_partitions (bool) optional

Flag to enable/disable VPC Flow Logs hive compatible partitions

Default value: false

vpc_flow_logs_destination_options_per_hour_partition (bool) optional

Flag to enable/disable VPC Flow Logs per hour partition

Default value: false

vpc_flow_logs_enabled (bool) optional

Enable or disable the VPC Flow Logs

Default value: true

vpc_flow_logs_log_destination_type (string) optional

The type of the logging destination. Valid values: cloud-watch-logs, s3

Default value: "s3"

vpc_flow_logs_traffic_type (string) optional

The type of traffic to capture. Valid values: ACCEPT, REJECT, ALL

Default value: "ALL"

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "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
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

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
flow_log_destination: Destination bucket for VPC flow logs
flow_log_id: ID of the VPC flow log
gateway_vpc_endpoints: Map of Gateway VPC Endpoints in this VPC, keyed by service (e.g. "s3").
igw_id: The ID of the Internet Gateway
interface_vpc_endpoints: Map of Interface VPC Endpoints in this VPC.
max_subnet_count: Maximum allowed number of subnets before all subnet CIDRs need to be recomputed
named_route_tables: Map of route table IDs, keyed by subnets_per_az_names.
If subnets_per_az_names is not set, items are grouped by key 'common'
named_subnets: Map of subnets IDs, keyed by subnets_per_az_names.
If subnets_per_az_names is not set, items are grouped by key 'common'
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_endpoint_dynamodb_id: ID of the DynamoDB gateway endpoint
vpc_endpoint_dynamodb_prefix_list_id: Prefix list ID for DynamoDB gateway endpoint
vpc_endpoint_interface_security_group_id: Security group ID for interface VPC endpoints
vpc_endpoint_s3_id: ID of the S3 gateway endpoint
vpc_endpoint_s3_prefix_list_id: Prefix list ID for S3 gateway endpoint
vpc_id: VPC ID

Dependencies

Requirements

terraform, version: >= 1.0.0
aws, version: >= 4.9.0, < 6.0.0

Providers

aws, version: >= 4.9.0, < 6.0.0

Modules

Name	Version	Source	Description
`endpoint_security_groups`	2.2.0	`cloudposse/security-group/aws`	We could create a security group per endpoint, but until we are ready to customize them by service, it is just a waste of resources. We use a single security group for all endpoints. Security groups can be updated without recreating the endpoint or interrupting service, so this is an easy change to make later.
`iam_roles`	latest	`../account-map/modules/iam-roles`	n/a
`subnets`	2.4.2	`cloudposse/dynamic-subnets/aws`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a
`utils`	1.4.0	`cloudposse/utils/aws`	n/a
`vpc`	3.0.0	`cloudposse/vpc/aws`	n/a
`vpc_endpoints`	3.0.0	`cloudposse/vpc/aws//modules/vpc-endpoints`	n/a
`vpc_flow_logs_bucket`	1.8.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a

Resources

The following resources are used by this module:

aws_flow_log.default (resource)
aws_shield_protection.nat_eip_shield_protection (resource)

Data Sources

The following data sources are used by this module:

aws_caller_identity.current (data source)
aws_eip.eip (data source)

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources