Module: vpn-connection

Terraform module to provision a site-to-site VPN connection 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

Usage

  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"]
  }

Requirements

Name	Version
terraform	>= 1.3.0
aws	>= 2.0

Providers

Name	Version
aws	>= 2.0

Modules

Name	Source	Version
logs	cloudposse/cloudwatch-logs/aws	0.6.8
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_customer_gateway.default	resource
aws_ec2_tag.default	resource
aws_ec2_transit_gateway_route.default	resource
aws_ec2_transit_gateway_route_table_association.default	resource
aws_ec2_transit_gateway_route_table_propagation.default	resource
aws_vpn_connection.default	resource
aws_vpn_connection_route.default	resource
aws_vpn_gateway.default	resource
aws_vpn_gateway_route_propagation.default	resource

Inputs

Name	Description	Type	Default	Required
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
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
customer_gateway_bgp_asn	The gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN)	number	65000	no
customer_gateway_ip_address	The IP address of the gateway's Internet-routable external interface	string	n/a	yes
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
existing_transit_gateway_id	Existing Transit Gateway ID. If provided, the module will not create a Virtual Private Gateway but instead will use the transit_gateway. For setting up transit gateway we can use the cloudposse/transit-gateway/aws module and pass the output transit_gateway_id to this variable.	string	""	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
route_table_ids	The IDs of the route tables for which routes from the Virtual Private Gateway will be propagated	list(string)	[]	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
transit_gateway_enabled	Set to true to enable VPN connection to transit gateway and then pass in the existing_transit_gateway_id	bool	false	no
transit_gateway_route_table_id	The ID of the route table for the transit gateway that you want to associate + propogate the VPN connection's TGW attachment	string	null	no
transit_gateway_routes	A map of transit gateway routes to create on the given TGW route table (via transit_gateway_route_table_id) for the created VPN Attachment. Use the key in the map to describe the route.	map(object({ blackhole = optional(bool, false) destination_cidr_block = string }))	{}	no
vpc_id	The ID of the VPC to which the Virtual Private Gateway will be attached	string	null	no
vpn_connection_local_ipv4_network_cidr	The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.	string	"0.0.0.0/0"	no
vpn_connection_log_retention_in_days	Specifies the number of days you want to retain log events.	number	30	no
vpn_connection_remote_ipv4_network_cidr	The IPv4 CIDR on the AWS side of the VPN connection.	string	"0.0.0.0/0"	no
vpn_connection_static_routes_destinations	List of CIDR blocks to be used as destination for static routes. Routes to destinations will be propagated to the route tables defined in route_table_ids	list(string)	[]	no
vpn_connection_static_routes_only	If set to true, the VPN connection will use static routes exclusively. Static routes must be used for devices that don't support BGP	bool	false	no
vpn_connection_tunnel1_cloudwatch_log_enabled	Enable or disable VPN tunnel logging feature for the tunnel	bool	false	no
vpn_connection_tunnel1_cloudwatch_log_output_format	Set log format for the tunnel. Default format is json. Possible values are: json and text	string	"json"	no
vpn_connection_tunnel1_dpd_timeout_action	The action to take after DPD timeout occurs for the first VPN tunnel. Specify restart to restart the IKE initiation. Specify clear to end the IKE session. Valid values are clear | none | restart.	string	"clear"	no
vpn_connection_tunnel1_ike_versions	The IKE versions that are permitted for the first VPN tunnel. Valid values are ikev1 | ikev2.	list(string)	[]	no
vpn_connection_tunnel1_inside_cidr	The CIDR block of the inside IP addresses for the first VPN tunnel	string	null	no
vpn_connection_tunnel1_phase1_dh_group_numbers	List of one or more Diffie-Hellman group numbers that are permitted for the first VPN tunnel for phase 1 IKE negotiations. Valid values are 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24.	list(string)	[]	no
vpn_connection_tunnel1_phase1_encryption_algorithms	List of one or more encryption algorithms that are permitted for the first VPN tunnel for phase 1 IKE negotiations. Valid values are AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16.	list(string)	[]	no
vpn_connection_tunnel1_phase1_integrity_algorithms	One or more integrity algorithms that are permitted for the first VPN tunnel for phase 1 IKE negotiations. Valid values are SHA1 | SHA2-256 | SHA2-384 | SHA2-512.	list(string)	[]	no
vpn_connection_tunnel1_phase2_dh_group_numbers	List of one or more Diffie-Hellman group numbers that are permitted for the first VPN tunnel for phase 2 IKE negotiations. Valid values are 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24.	list(string)	[]	no
vpn_connection_tunnel1_phase2_encryption_algorithms	List of one or more encryption algorithms that are permitted for the first VPN tunnel for phase 2 IKE negotiations. Valid values are AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16.	list(string)	[]	no
vpn_connection_tunnel1_phase2_integrity_algorithms	One or more integrity algorithms that are permitted for the first VPN tunnel for phase 2 IKE negotiations. Valid values are SHA1 | SHA2-256 | SHA2-384 | SHA2-512.	list(string)	[]	no
vpn_connection_tunnel1_preshared_key	The preshared key of the first VPN tunnel. The preshared key must be between 8 and 64 characters in length and cannot start with zero. Allowed characters are alphanumeric characters, periods(.) and underscores(_)	string	null	no
vpn_connection_tunnel1_startup_action	The action to take when the establishing the tunnel for the first VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for AWS to initiate the IKE negotiation. Valid values are add | start.	string	"add"	no
vpn_connection_tunnel2_cloudwatch_log_enabled	Enable or disable VPN tunnel logging feature for the tunnel	bool	false	no
vpn_connection_tunnel2_cloudwatch_log_output_format	Set log format for the tunnel. Default format is json. Possible values are: json and text	string	"json"	no
vpn_connection_tunnel2_dpd_timeout_action	The action to take after DPD timeout occurs for the second VPN tunnel. Specify restart to restart the IKE initiation. Specify clear to end the IKE session. Valid values are clear | none | restart.	string	"clear"	no
vpn_connection_tunnel2_ike_versions	The IKE versions that are permitted for the second VPN tunnel. Valid values are ikev1 | ikev2.	list(string)	[]	no
vpn_connection_tunnel2_inside_cidr	The CIDR block of the inside IP addresses for the second VPN tunnel	string	null	no
vpn_connection_tunnel2_phase1_dh_group_numbers	List of one or more Diffie-Hellman group numbers that are permitted for the second VPN tunnel for phase 1 IKE negotiations. Valid values are 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24.	list(string)	[]	no
vpn_connection_tunnel2_phase1_encryption_algorithms	List of one or more encryption algorithms that are permitted for the second VPN tunnel for phase 1 IKE negotiations. Valid values are AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16.	list(string)	[]	no
vpn_connection_tunnel2_phase1_integrity_algorithms	One or more integrity algorithms that are permitted for the second VPN tunnel for phase 1 IKE negotiations. Valid values are SHA1 | SHA2-256 | SHA2-384 | SHA2-512.	list(string)	[]	no
vpn_connection_tunnel2_phase2_dh_group_numbers	List of one or more Diffie-Hellman group numbers that are permitted for the second VPN tunnel for phase 2 IKE negotiations. Valid values are 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24.	list(string)	[]	no
vpn_connection_tunnel2_phase2_encryption_algorithms	List of one or more encryption algorithms that are permitted for the second VPN tunnel for phase 2 IKE negotiations. Valid values are AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16.	list(string)	[]	no
vpn_connection_tunnel2_phase2_integrity_algorithms	One or more integrity algorithms that are permitted for the second VPN tunnel for phase 2 IKE negotiations. Valid values are SHA1 | SHA2-256 | SHA2-384 | SHA2-512.	list(string)	[]	no
vpn_connection_tunnel2_preshared_key	The preshared key of the second VPN tunnel. The preshared key must be between 8 and 64 characters in length and cannot start with zero. Allowed characters are alphanumeric characters, periods(.) and underscores(_)	string	null	no
vpn_connection_tunnel2_startup_action	The action to take when the establishing the tunnel for the second VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for AWS to initiate the IKE negotiation. Valid values are add | start.	string	"add"	no
vpn_gateway_amazon_side_asn	The Autonomous System Number (ASN) for the Amazon side of the VPN gateway. If you don't specify an ASN, the Virtual Private Gateway is created with the default ASN	number	64512	no

Outputs

Name	Description
customer_gateway_id	Customer Gateway ID
transit_gateway_attachment_id	The ID of the transit gateway attachment for the VPN connection (if a TGW connection)
vpn_connection_customer_gateway_configuration	The configuration information for the VPN connection's Customer Gateway (in the native XML format)
vpn_connection_id	VPN Connection ID
vpn_connection_tunnel1_address	The public IP address of the first VPN tunnel
vpn_connection_tunnel1_cgw_inside_address	The RFC 6890 link-local address of the first VPN tunnel (Customer Gateway side)
vpn_connection_tunnel1_vgw_inside_address	The RFC 6890 link-local address of the first VPN tunnel (Virtual Private Gateway side)
vpn_connection_tunnel2_address	The public IP address of the second VPN tunnel
vpn_connection_tunnel2_cgw_inside_address	The RFC 6890 link-local address of the second VPN tunnel (Customer Gateway side)
vpn_connection_tunnel2_vgw_inside_address	The RFC 6890 link-local address of the second VPN tunnel (Virtual Private Gateway side)
vpn_gateway_id	Virtual Private Gateway ID