README.yaml

name: "aws-vpc-peering"
# Canonical GitHub repo
github_repo: "cloudposse-terraform-components/aws-vpc-peering"
# Short description of this project
description: |-
  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:

  ```yaml
  # 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

  ```yaml
  # 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

  ```yaml
  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.

  ```json
  {
    "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.

  ```json
  {
    "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:

  ```sh
  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
  ```

  <!-- prettier-ignore-start -->
  <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
  ## Requirements

  | Name | Version |
  |------|---------|
  | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
  | <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.0 |

  ## Providers

  | Name | Version |
  |------|---------|
  | <a name="provider_aws.accepter"></a> [aws.accepter](#provider\_aws.accepter) | >= 3.0 |

  ## Modules

  | Name | Source | Version |
  |------|--------|---------|
  | <a name="module_iam_roles"></a> [iam\_roles](#module\_iam\_roles) | ../account-map/modules/iam-roles | n/a |
  | <a name="module_requester_vpc"></a> [requester\_vpc](#module\_requester\_vpc) | cloudposse/stack-config/yaml//modules/remote-state | 1.5.0 |
  | <a name="module_this"></a> [this](#module\_this) | cloudposse/label/null | 0.25.0 |
  | <a name="module_vpc_peering"></a> [vpc\_peering](#module\_vpc\_peering) | cloudposse/vpc-peering-multi-account/aws | 0.19.1 |

  ## Resources

  | Name | Type |
  |------|------|
  | [aws_vpc.accepter](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | data source |

  ## Inputs

  | Name | Description | Type | Default | Required |
  |------|-------------|------|---------|:--------:|
  | <a name="input_accepter_allow_remote_vpc_dns_resolution"></a> [accepter\_allow\_remote\_vpc\_dns\_resolution](#input\_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 |
  | <a name="input_accepter_aws_assume_role_arn"></a> [accepter\_aws\_assume\_role\_arn](#input\_accepter\_aws\_assume\_role\_arn) | Accepter AWS assume role ARN | `string` | `null` | no |
  | <a name="input_accepter_region"></a> [accepter\_region](#input\_accepter\_region) | Accepter AWS region | `string` | n/a | yes |
  | <a name="input_accepter_stage_name"></a> [accepter\_stage\_name](#input\_accepter\_stage\_name) | Accepter stage name if in v1 | `string` | `null` | no |
  | <a name="input_accepter_vpc"></a> [accepter\_vpc](#input\_accepter\_vpc) | Accepter VPC map of id, cidr\_block, or default arguments for the data source | `any` | n/a | yes |
  | <a name="input_additional_tag_map"></a> [additional\_tag\_map](#input\_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](#input\_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_auto_accept"></a> [auto\_accept](#input\_auto\_accept) | Automatically accept peering request | `bool` | `true` | no |
  | <a name="input_context"></a> [context](#input\_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](#input\_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](#input\_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](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |
  | <a name="input_environment"></a> [environment](#input\_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](#input\_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_label_key_case"></a> [label\_key\_case](#input\_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](#input\_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](#input\_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](#input\_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_name"></a> [name](#input\_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](#input\_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_regex_replace_chars"></a> [regex\_replace\_chars](#input\_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_region"></a> [region](#input\_region) | AWS Region | `string` | n/a | yes |
  | <a name="input_requester_allow_remote_vpc_dns_resolution"></a> [requester\_allow\_remote\_vpc\_dns\_resolution](#input\_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 |
  | <a name="input_requester_role_arn"></a> [requester\_role\_arn](#input\_requester\_role\_arn) | Requester AWS assume role ARN, if not provided it will be assumed to be the current terraform role. | `string` | `null` | no |
  | <a name="input_requester_vpc_component_name"></a> [requester\_vpc\_component\_name](#input\_requester\_vpc\_component\_name) | Requester vpc component name | `string` | `"vpc"` | no |
  | <a name="input_requester_vpc_id"></a> [requester\_vpc\_id](#input\_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 |
  | <a name="input_stage"></a> [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |
  | <a name="input_tags"></a> [tags](#input\_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](#input\_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 |
  |------|-------------|
  | <a name="output_vpc_peering"></a> [vpc\_peering](#output\_vpc\_peering) | VPC peering outputs |
  <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
  <!-- prettier-ignore-end -->

  - [cloudposse/terraform-aws-components](https://github.com/cloudposse/terraform-aws-components/tree/main/modules/vpc-peering) -
    Cloud Posse's upstream component
tags:
  - component/vpc-peering
  - layer/network
  - provider/aws
# Categories of this project
categories:
  - component/vpc-peering
  - layer/network
  - provider/aws
# License of this project
license: "APACHE2"
# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse-terraform-components/aws-vpc-peering.svg?style=for-the-badge
    url: https://github.com/cloudposse-terraform-components/aws-vpc-peering/releases/latest
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com
related:
  - name: "Cloud Posse Terraform Modules"
    description: Our collection of reusable Terraform modules used by our reference architectures.
    url: "https://docs.cloudposse.com/modules/"
  - name: "Atmos"
    description: "Atmos is like docker-compose but for your infrastructure"
    url: "https://atmos.tools"
contributors: [] # If included generates contribs