-
-
Notifications
You must be signed in to change notification settings - Fork 58
/
README.yaml
101 lines (96 loc) · 4.32 KB
/
README.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name: terraform-aws-vpn-connection
# Tags of this project
tags:
- aws
- terraform
- terraform-modules
- vpc
- subnet
- route
- route-table
- vpn
- vpn-connection
- site-to-site-vpn-connection
- virtual-private-gateway
- customer-gateway
- ip
- ip-address
# 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-vpn-connection
# Badges to display
badges:
- name: Latest Release
image: https://img.shields.io/github/release/cloudposse/terraform-aws-vpn-connection.svg?style=for-the-badge
url: https://github.com/cloudposse/terraform-aws-vpn-connection/releases/latest
- name: Last Updated
image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-vpn-connection.svg?style=for-the-badge
url: https://github.com/cloudposse/terraform-aws-vpn-connection/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-vpc-peering"
description: "Terraform module to create a peering connection between two VPCs"
url: "https://github.com/cloudposse/terraform-aws-vpc-peering"
- name: "terraform-aws-kops-vpc-peering"
description: "Terraform module to create a peering connection between a backing services VPC and a VPC created by Kops"
url: "https://github.com/cloudposse/terraform-aws-kops-vpc-peering"
- name: "terraform-aws-dynamic-subnets"
description: "Terraform module for public and private subnets provisioning in existing VPC"
url: "https://github.com/cloudposse/terraform-aws-dynamic-subnets"
- name: "terraform-aws-multi-az-subnets"
description: "Terraform module for multi-AZ public and private subnets provisioning"
url: "https://github.com/cloudposse/terraform-aws-multi-az-subnets"
- name: "terraform-aws-named-subnets"
description: "Terraform module for named subnets provisioning"
url: "https://github.com/cloudposse/terraform-aws-named-subnets"
# Short description of this project
description: |-
Terraform module to provision a [site-to-site](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) [VPN connection](https://docs.aws.amazon.com/vpc/latest/userguide/vpn-connections.html)
between a VPC and an on-premises network.
The module does the following:
- Creates a Virtual Private Gateway (VPG) and attaches it to the VPC
- Creates a Customer Gateway (CGW) pointing to the provided IP address of the Internet-routable external interface on the on-premises network
- Creates a Site-to-Site Virtual Private Network (VPN) connection and assigns it to the VPG and CGW
- Requests automatic route propagation between the VPG and the provided route tables in the VPC
- If the VPN connection is configured to use static routes, provisions a static route between the VPN connection and the CGW
# How to use this project
usage: |-
```hcl
module "vpn_connection" {
source = "cloudposse/vpn-connection/aws"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
namespace = "eg"
stage = "dev"
name = "test"
vpc_id = "vpc-xxxxxxxx"
vpn_gateway_amazon_side_asn = 64512
customer_gateway_bgp_asn = 65000
customer_gateway_ip_address = "172.0.0.1"
route_table_ids = ["rtb-xxxxxxxx", "rtb-yyyyyyyy", "rtb-zzzzzzzz"]
vpn_connection_static_routes_only = "true"
vpn_connection_static_routes_destinations = ["10.80.1.0/24"]
}
```
include:
- "docs/targets.md"
- "docs/terraform.md"
# Contributors to this project
contributors: []