Skip to main content
Sponsor @cloudposse

Module: vpn-connection

Terraform module to provision a site-to-site VPN connection between a VPC and an on-premises network.

The module can do the following:

  • Create a Virtual Private Gateway (VPG) and attach it to the VPC
  • Create a Customer Gateway (CGW) pointing to the provided Internet-routable IP address of the external interface on the on-premises network
  • Create a Site-to-Site Virtual Private Network (VPN) connection
  • Request automatic route propagation between the VPG and the provided route tables in the VPC
  • If the VPN connection is configured to use static routes, provision a static route between the VPN connection and the CGW

Exactly what it does depends on the input parameters. The module is designed to be flexible and can be used in a variety of scenarios.

  • If you supply customer_gateway_ip_address and set transit_gateway_enabled to true, the module will create a CGW, then create a VPN connection, and then assign the connection to the Transit Gateway identified by existing_transit_gateway_id and the created CGW
  • If you supply customer_gateway_ip_address and set transit_gateway_enabled to false, the module will create a VPG and CGW, then create a VPN connection, and then assign it to the VPG and CGW
  • If you do not supply customer_gateway_ip_address (set it to null) then the module will only create a VPG

The module also provides some options for adding routes to the VPC or TGW route tables. You need to use the options that correspond to the kind of attachment point (VPC or TGW) you are using.

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

Variables​

Required Variables​

Optional Variables​

customer_gateway_bgp_asn (number) optional

The Customer Gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN)


Default value: 65000

customer_gateway_device_name (string) optional

The Device Name of the Customer Gateway. Set to null to leave unnamed.
WARNING: Changing this value will cause the Customer Gateway to be replaced.



Default value: ""

customer_gateway_ip_address (string) optional

The Internet-routable IP address of the Customer Gateway's external interface.
WARNING: If set to null, the module will not create a Customer Gateway or a VPN connection
and will only create a VPN Gateway.



Default value: null

existing_transit_gateway_id (string) optional

Existing Transit Gateway ID. Required if transit_gateway_enabled is true, ignored otherwise.
To set up a transit gateway, one can use thecloudposse/transit-gateway/aws module and pass
the output transit_gateway_id to this variable.



Default value: ""

route_table_ids (list(string)) optional

The IDs of the route tables for which routes from the Virtual Private Gateway will be propagated


Default value: [ ]

transit_gateway_enabled (bool) optional

If true, the module will not create a Virtual Private Gateway but instead will attach
the VPN connection to the Transit Gateway specified by existing_transit_gateway_id



Default value: false

transit_gateway_route_table_id (string) optional

The ID of the route table for the transit gateway that you want to associate + propagate the VPN connection's TGW attachment


Default value: null

transit_gateway_routes optional

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


Type:

map(object({
blackhole              = optional(bool, false)
destination_cidr_block = string
}))

Default value: { }

vpc_id (string) optional

The ID of the VPC to which the Virtual Private Gateway will be attached.
Not needed if attaching the VPN connection to a Transit Gateway.



Default value: null

vpn_acceleration_enabled (bool) optional

Set to true to enable VPN acceleration for the VPN connection. Can only be set at creation time, cannot be changed later.
Accelerated VPN connections come with several restrictions: consult the AWS documentation for details.



Default value: false

vpn_connection_local_ipv4_network_cidr (string) optional

The IPv4 CIDR on the Customer Gateway (on-premises) side of the VPN connection


Default value: "0.0.0.0/0"

vpn_connection_log_retention_in_days (number) optional

Specifies the number of days you want to retain log events


Default value: 30

vpn_connection_remote_ipv4_network_cidr (string) optional

The IPv4 CIDR on the AWS side of the VPN connection


Default value: "0.0.0.0/0"

vpn_connection_static_routes_destinations (list(string)) optional

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.



Default value: [ ]

vpn_connection_static_routes_only (bool) optional

If set to true, the VPN connection will use static routes exclusively.
Static routes must be used for devices that don't support BGP.



Default value: false

vpn_connection_tunnel1_cloudwatch_log_enabled (bool) optional

Enable or disable VPN tunnel logging feature for the tunnel


Default value: false

vpn_connection_tunnel1_cloudwatch_log_group_arn (list(string)) optional

The ARN of the CloudWatch log group to which the logs will be published.
If the list is empty and vpn_connection_tunnel1_cloudwatch_log_enabled is true,
the module will create a new log group and use it.
If the list is not empty, the module will use the first ARN in the list.



Default value: [ ]

vpn_connection_tunnel1_cloudwatch_log_output_format (string) optional

Set log format for the tunnel. Default format is json. Possible values are json and text


Default value: "json"

vpn_connection_tunnel1_dpd_timeout_action (string) optional

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



Default value: "clear"

vpn_connection_tunnel1_ike_versions (list(string)) optional

The IKE versions that are permitted for the first VPN tunnel. Valid values are ikev1 | ikev2


Default value: [ ]

vpn_connection_tunnel1_inside_cidr (string) optional

The CIDR block of the inside IP addresses for the first VPN tunnel


Default value: null

vpn_connection_tunnel1_phase1_dh_group_numbers (list(string)) optional

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 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24



Default value: [ ]

vpn_connection_tunnel1_phase1_encryption_algorithms (list(string)) optional

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



Default value: [ ]

vpn_connection_tunnel1_phase1_integrity_algorithms (list(string)) optional

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



Default value: [ ]

vpn_connection_tunnel1_phase1_lifetime_seconds (string) optional

The lifetime for phase 1 of the IKE negotiation for the first VPN tunnel, in seconds. Valid value is between 900 and 28800


Default value: "28800"

vpn_connection_tunnel1_phase2_dh_group_numbers (list(string)) optional

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



Default value: [ ]

vpn_connection_tunnel1_phase2_encryption_algorithms (list(string)) optional

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



Default value: [ ]

vpn_connection_tunnel1_phase2_integrity_algorithms (list(string)) optional

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



Default value: [ ]

vpn_connection_tunnel1_phase2_lifetime_seconds (string) optional

The lifetime for phase 2 of the IKE negotiation for the first VPN tunnel, in seconds. Valid value is between 900 and 3600


Default value: "3600"

vpn_connection_tunnel1_preshared_key (string) optional

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(_)


Default value: null

vpn_connection_tunnel1_startup_action (string) optional

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


Default value: "add"

vpn_connection_tunnel2_cloudwatch_log_enabled (bool) optional

Enable or disable VPN tunnel logging feature for the tunnel


Default value: false

vpn_connection_tunnel2_cloudwatch_log_group_arn (list(string)) optional

The ARN of the CloudWatch log group to which the logs will be published.
If the list is empty and vpn_connection_tunnel2_cloudwatch_log_enabled is true,
the module will create a new log group and use it.
If the list is not empty, the module will use the first ARN in the list.



Default value: [ ]

vpn_connection_tunnel2_cloudwatch_log_output_format (string) optional

Set log format for the tunnel. Default format is json. Possible values are json and text


Default value: "json"

vpn_connection_tunnel2_dpd_timeout_action (string) optional

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


Default value: "clear"

vpn_connection_tunnel2_ike_versions (list(string)) optional

The IKE versions that are permitted for the second VPN tunnel. Valid values are ikev1 | ikev2


Default value: [ ]

vpn_connection_tunnel2_inside_cidr (string) optional

The CIDR block of the inside IP addresses for the second VPN tunnel


Default value: null

vpn_connection_tunnel2_phase1_dh_group_numbers (list(string)) optional

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 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24



Default value: [ ]

vpn_connection_tunnel2_phase1_encryption_algorithms (list(string)) optional

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



Default value: [ ]

vpn_connection_tunnel2_phase1_integrity_algorithms (list(string)) optional

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



Default value: [ ]

vpn_connection_tunnel2_phase1_lifetime_seconds (string) optional

The lifetime for phase 1 of the IKE negotiation for the second VPN tunnel, in seconds. Valid value is between 900 and 28800


Default value: "28800"

vpn_connection_tunnel2_phase2_dh_group_numbers (list(string)) optional

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



Default value: [ ]

vpn_connection_tunnel2_phase2_encryption_algorithms (list(string)) optional

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



Default value: [ ]

vpn_connection_tunnel2_phase2_integrity_algorithms (list(string)) optional

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



Default value: [ ]

vpn_connection_tunnel2_phase2_lifetime_seconds (string) optional

The lifetime for phase 2 of the IKE negotiation for the second VPN tunnel, in seconds. Valid value is between 900 and 3600


Default value: "3600"

vpn_connection_tunnel2_preshared_key (string) optional

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(_)


Default value: null

vpn_connection_tunnel2_startup_action (string) optional

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


Default value: "add"

vpn_gateway_amazon_side_asn (number) optional

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.



Default value: 64512

Context Variables​

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.


Required: No

Default value: { }

attributes (list(string)) optional

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.


Required: No

Default value: [ ]

context (any) optional

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.


Required: No

Default value:

{
  "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
}
delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.


Required: No

Default value: null

descriptor_formats (any) optional

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).


Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.


Required: No

Default value: null

label_key_case (string) optional

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.


Required: No

Default value: null

label_order (list(string)) optional

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.


Required: No

Default value: null

label_value_case (string) optional

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.


Required: No

Default value: null

labels_as_tags (set(string)) optional

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.


Required: No

Default value:

[
  "default"
]
name (string) optional

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.


Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.


Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.


Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs​

customer_gateway_device_name

Customer Gateway Device Name

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_acceleration_enabled

Whether the VPN connection is enabled for acceleration

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_log_group_arn

The CloudWatch Log Group ARN for the tunnel 1 logs

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_log_group_arn

The CloudWatch Log Group ARN for the tunnel 2 logs

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

Dependencies​

Requirements​

  • terraform, version: >= 1.3.0
  • aws, version: >= 5.53.0

Providers​

  • aws, version: >= 5.53.0

Modules​

NameVersionSourceDescription
logs0.6.9cloudposse/cloudwatch-logs/awsn/a
this0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: