README.yaml

#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-aws-vpc-peering
# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - platform
  - vpc
  - peering
  - vpc-peering
  - vpn
# Categories of this project
categories:
  - terraform-modules/networking
# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"
# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-vpc-peering
# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-vpc-peering.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-vpc-peering/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-vpc-peering.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-vpc-peering/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com

# List any related terraform modules that this module may be used with or that this module depends on.
related:
  - name: "terraform-aws-vpc"
    description: "Terraform Module that defines a VPC with public/private subnets across multiple AZs with Internet Gateways"
    url: "https://github.com/cloudposse/terraform-aws-vpc"
  - name: "terraform-aws-kops-vpc-peering"
    description: "Terraform module to create a peering connection between two VPCs"
    url: "https://github.com/cloudposse/terraform-aws-kops-vpc-peering"
# Short description of this project
description: |-
  Terraform module to create a peering connection between two VPCs
# How to use this project
usage: |2-

  For a complete example, see [examples/complete](examples/complete).

  For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest) (which tests and deploys the example on AWS), see [test](test).

  ### Using VPC IDs

  ```hcl
  module "vpc_peering" {
    source = "cloudposse/vpc-peering/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"
    namespace        = "eg"
    stage            = "dev"
    name             = "cluster"
    requestor_vpc_id = "vpc-XXXXXXXX"
    acceptor_vpc_id  = "vpc-YYYYYYYY"
  }
  ```

  ### Using VPC tags

  ```hcl
  module "vpc_peering" {
    source = "cloudposse/vpc-peering/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"
    namespace          = "eg"
    stage              = "dev"
    name               = "cluster"
    requestor_vpc_tags = {
      "kubernetes.io/cluster/my-k8s" = "owned"
    }
    acceptor_vpc_tags  = {
      Name = "legacy-vpc"
    }
  }
  ```
references:
  - name: "terraform-aws-vpc-kops-peering"
    description: "Thanks to [Gladly.com](https://www.gladly.com/) for the inspiration with this wonderful module"
    url: "https://github.com/sagansystems/terraform-aws-vpc-kops-peering"
screenshots:
  - name: "vpc-peering"
    description: "VPC Peering Connection in the AWS Web Console"
    url: "images/vpc-peering.png"
include:
  - "docs/targets.md"
  - "docs/terraform.md"
# Contributors to this project
contributors: []