This component is responsible for creating a peering connection between two VPCs existing in different AWS accounts.

Usage

Stack Level: Regional

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

Default VPC peering settings for all accounts:

# stacks/catalog/vpc-peering/defaults.yaml
components:
  terraform:
    vpc-peering/defaults:
      settings:
        spacelift:
          workspace_enabled: true
      metadata:
        component: vpc-peering
        type: abstract
      vars:
        enabled: true
        requester_allow_remote_vpc_dns_resolution: true
        accepter_allow_remote_vpc_dns_resolution: true

Use case: Peering v1 accounts to v2

# stacks/catalogs/vpc-peering/ue1-prod.yaml
import:
  - catalog/vpc-peering/defaults

components:
  terraform:
    vpc-peering-use1:
      metadata:
        component: vpc-peering
        inherits:
          - vpc-peering/defaults
      vars:
        accepter_region: us-east-1
        accepter_vpc_id: vpc-xyz
        accepter_aws_assume_role_arn: arn:aws:iam::<LEGACY ACCOUNT ID>:role/acme-vpc-peering

Use case: Peering v2 accounts to v2

vpc-peering/<stage>-vpc0:
  metadata:
    component: vpc-peering
    inherits:
      - vpc-peering/defaults
  vars:
    requester_vpc_component_name: vpc
    accepter_region: us-east-1
    accepter_stage_name: <fill-in-with-accepter-stage-name>
    accepter_vpc:
      tags:
        # Fill in with your own information
        Name: acme-<tenant>-<environment>-<stage>-<name>

Legacy Account Configuration

The vpc-peering component peers the dev, prod, sandbox and staging VPCs to a VPC in the legacy account.

The dev, prod, sandbox and staging VPCs are the requesters of the VPC peering connection, while the legacy VPC is the accepter of the peering connection.

To provision VPC peering and all related resources with Terraform, we need the following information from the legacy account:

• Legacy account ID
• Legacy VPC ID
• Legacy AWS region
• Legacy IAM role (the role must be created in the legacy account with permissions to create VPC peering and routes). The name of the role could be acme-vpc-peering and the ARN of the role should look like arn:aws:iam::<LEGACY ACCOUNT ID>:role/acme-vpc-peering

Legacy Account IAM Role

In the legacy account, create IAM role acme-vpc-peering with the following policy:

NOTE: Replace <LEGACY ACCOUNT ID> with the ID of the legacy account.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": ["ec2:CreateRoute", "ec2:DeleteRoute"],
      "Resource": "arn:aws:ec2:*:<LEGACY ACCOUNT ID>:route-table/*"
    },
    {
      "Effect": "Allow",
      "Action": [
        "ec2:DescribeVpcPeeringConnections",
        "ec2:DescribeVpcs",
        "ec2:ModifyVpcPeeringConnectionOptions",
        "ec2:DescribeSubnets",
        "ec2:DescribeVpcAttribute",
        "ec2:DescribeRouteTables"
      ],
      "Resource": "*"
    },
    {
      "Effect": "Allow",
      "Action": [
        "ec2:AcceptVpcPeeringConnection",
        "ec2:DeleteVpcPeeringConnection",
        "ec2:CreateVpcPeeringConnection",
        "ec2:RejectVpcPeeringConnection"
      ],
      "Resource": [
        "arn:aws:ec2:*:<LEGACY ACCOUNT ID>:vpc-peering-connection/*",
        "arn:aws:ec2:*:<LEGACY ACCOUNT ID>:vpc/*"
      ]
    },
    {
      "Effect": "Allow",
      "Action": ["ec2:DeleteTags", "ec2:CreateTags"],
      "Resource": "arn:aws:ec2:*:<LEGACY ACCOUNT ID>:vpc-peering-connection/*"
    }
  ]
}

Add the following trust policy to the IAM role:

NOTE: Replace <IDENTITY ACCOUNT ID> with the ID of the identity account in the new infrastructure.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "AWS": ["arn:aws:iam::<IDENTITY ACCOUNT ID>:root"]
      },
      "Action": ["sts:AssumeRole", "sts:TagSession"],
      "Condition": {}
    }
  ]
}

The trust policy allows the identity account to assume the role (and provision all the resources in the legacy account).

Provisioning

Provision the VPC peering connections in the dev, prod, sandbox and staging accounts by executing the following commands:

atmos terraform plan vpc-peering -s ue1-sandbox
atmos terraform apply vpc-peering -s ue1-sandbox

atmos terraform plan vpc-peering -s ue1-dev
atmos terraform apply vpc-peering -s ue1-dev

atmos terraform plan vpc-peering -s ue1-staging
atmos terraform apply vpc-peering -s ue1-staging

atmos terraform plan vpc-peering -s ue1-prod
atmos terraform apply vpc-peering -s ue1-prod

Requirements

Name	Version
terraform	>= 1.0.0
aws	>= 3.0

Providers

Name	Version
aws.accepter	>= 3.0

Modules

Name	Source	Version
iam_roles	../account-map/modules/iam-roles	n/a
requester_vpc	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
this	cloudposse/label/null	0.25.0
vpc_peering	cloudposse/vpc-peering-multi-account/aws	0.19.1

Resources

Name	Type
aws_vpc.accepter	data source

Inputs

Name	Description	Type	Default	Required
accepter_allow_remote_vpc_dns_resolution	Allow accepter VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the requester VPC	bool	true	no
accepter_aws_assume_role_arn	Accepter AWS assume role ARN	string	null	no
accepter_region	Accepter AWS region	string	n/a	yes
accepter_stage_name	Accepter stage name if in v1	string	null	no
accepter_vpc	Accepter VPC map of id, cidr_block, or default arguments for the data source	any	n/a	yes
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
auto_accept	Automatically accept peering request	bool	true	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
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
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
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
requester_allow_remote_vpc_dns_resolution	Allow requester VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the accepter VPC	bool	true	no
requester_role_arn	Requester AWS assume role ARN, if not provided it will be assumed to be the current terraform role.	string	null	no
requester_vpc_component_name	Requester vpc component name	string	"vpc"	no
requester_vpc_id	Requester VPC ID, if not provided, it will be looked up by component using variable requester_vpc_component_name	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
vpc_peering	VPC peering outputs

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

---

Note

This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.

Learn More

It's 100% Open Source and licensed under the APACHE2.

Related Projects

Check out these related projects.

• Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
• Atmos - Atmos is like docker-compose but for your infrastructure

✨ Contributing

This project is under active development, and we encourage contributions from our community. Many thanks to our outstanding contributors:

🐛 Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

💻 Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you! Hit us up in Slack, in the #cloudposse channel.

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

1. Review our Code of Conduct and Contributor Guidelines.
2. Fork the repo on GitHub
3. Clone the project to your own machine
4. Commit changes to your own branch
5. Push your work back up to your fork
6. 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

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!

About

This project is maintained by Cloud Posse, LLC.

We are a DevOps Accelerator for funded startups and enterprises. Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly. We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.

Your team can operate like a pro today.

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

📚 See What's Included

• Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
• Deployment Strategy. You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
• Site Reliability Engineering. You'll have total visibility into your apps and microservices.
• Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
• GitOps. You'll be able to operate your infrastructure via Pull Requests.
• Training. You'll receive hands-on training so your team can operate what we build.
• Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
• Troubleshooting. You'll get help to triage when things aren't working.
• Code Reviews. You'll receive constructive feedback on Pull Requests.
• Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

License

Preamble to the Apache License, Version 2.0

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.

Trademarks

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

Copyright © 2017-2024 Cloud Posse, LLC