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 Multi Account Peering

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-multi-account-peering

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove//terraform-aws-multi-account-peering.svg"
    url: "https://github.com/clouddrove//terraform-aws-multi-account-peering/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-multi-account-peering/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-multi-account-peering/actions/workflows/tfsec.yml"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-blue.svg"
    url: "LICENSE.md"
  - name: "Changelog"
    image: "https://img.shields.io/badge/Changelog-blue"
    url: "CHANGELOG.md"

prerequesties:
  - name: Terraform
    url: https://learn.hashicorp.com/terraform/getting-started/install.html
    version: ">= 1.6.5"

providers:
  - name: aws
    url: https://aws.amazon.com/
    version: ">= 5.31.0"

module_dependencies:
  - name: Labels Module
    url: https://github.com/clouddrove/terraform-aws-labels
    description: Provides resource tagging.

#  description of this project
description: |-
  Terraform module to connect two VPC’s from different AWS account.

# How to use this project
usage : |-
  ### Simple Example
  Here are an example of how you can use this module in your inventory structure:
  ```hcl
    module "vpc-peering" {
          source            = "clouddrove/multi-account-peering/aws"
          version           = "1.0.1"
          name              = "vpc-peering"
          environment       = "test"
          label_order       = ["environment", "name"]
          enable_peering    = true
          accepter_role_arn = "arn:aws:iam::XXXXXXXXXXXX:role/assume-role"
          accepter_region   = "eu-west-1"
          requestor_vpc_id  = "vpc-XXXXXXXXXXXXXX"
          acceptor_vpc_id   = "vpc-XXXXXXXXXXXXXX"
         }
  ```