Skip to main content
Sponsor @cloudposse

Module: ec2-client-vpn

The terraform-aws-ec2-client-vpn project provides for ec2 client vpn infrastructure. AWS Client VPN is a managed client-based VPN service based on OpenVPN that enables you to securely access your AWS resources and resources in your on-premises network. With Client VPN, you can access your resources from any location using any OpenVPN-based VPN client.

Usage​

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

module "vpc_target" {
  source  = "cloudposse/vpc/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  cidr_block = "172.16.0.0/16"

  context = module.this.context
}

module "vpc_client" {
  source  = "cloudposse/vpc/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  cidr_block = "172.31.0.0/16"

  context = module.this.context
}

module "subnets" {
  source  = "cloudposse/dynamic-subnets/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  availability_zones   = var.availability_zones
  vpc_id               = module.vpc_target.vpc_id
  igw_id               = module.vpc_target.igw_id
  cidr_block           = module.vpc_target.vpc_cidr_block
  nat_gateway_enabled  = true
  nat_instance_enabled = false

  context = module.this.context
}

module "ec2_client_vpn" {
  source  = "cloudposse/ec2-client-vpn/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  client_cidr             = module.vpc_client.vpc_cidr_block
  organization_name       = var.organization_name
  logging_enabled         = var.logging_enabled
  retention_in_days       = var.retention_in_days
  associated_subnets      = module.subnets.private_subnet_ids
  authorization_rules     = var.authorization_rules

  additional_routes = [
    {
      destination_cidr_block = "0.0.0.0/0"
      description            = "Internet Route"
      target_vpc_subnet_id   = element(module.subnets.private_subnet_ids, 0)
    }
  ]
}

Examples​

Here is an example of using this module:

Variables​

Required Variables​

associated_subnets (list(string)) required

List of subnets to associate with the VPN endpoint

client_cidr (string) required

Network CIDR to use for clients

logging_stream_name (string) required

Names of stream used for logging

organization_name (string) required

Name of organization to use in private certificate

vpc_id (string) required

ID of VPC to attach VPN to

Optional Variables​

additional_routes optional

A list of additional routes that should be attached to the Client VPN endpoint


Type:

list(object({
destination_cidr_block = string
description            = string
target_vpc_subnet_id   = string
}))

Default value: [ ]

additional_security_group_rules (list(any)) optional

A list of Security Group rule objects to add to the created security group, in addition to the ones
this module normally creates. (To suppress the module's rules, set create_security_group to false
and supply your own security group via associated_security_group_ids.)
The keys and values of the objects are fully compatible with the aws_security_group_rule resource, except
for security_group_id which will be ignored, and the optional "key" which, if provided, must be unique and known at "plan" time.
To get more info see https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule .



Default value: [ ]

additional_security_groups (list(string)) optional

DEPRECATED: Use associated_security_group_ids instead.
List of security groups to attach to the client vpn network associations



Default value: [ ]

allow_self_security_group (bool) optional

Whether the security group itself will be added as a source to this ingress rule.


Default value: true

allowed_cidr_blocks (list(string)) optional

A list of IPv4 CIDRs to allow access to the security group created by this module.
The length of this list must be known at "plan" time.



Default value: [ ]

allowed_ipv6_cidr_blocks (list(string)) optional

A list of IPv6 CIDRs to allow access to the security group created by this module.
The length of this list must be known at "plan" time.



Default value: [ ]

allowed_ipv6_prefix_list_ids (list(string)) optional

A list of IPv6 Prefix Lists IDs to allow access to the security group created by this module.
The length of this list must be known at "plan" time.



Default value: [ ]

allowed_security_group_ids (list(string)) optional

A list of IDs of Security Groups to allow access to the security group created by this module.
The length of this list must be known at "plan" time.



Default value: [ ]

associated_security_group_ids (list(string)) optional

A list of IDs of Security Groups to associate the VPN endpoints with, in addition to the created security group.
These security groups will not be modified and, if create_security_group is false, must have rules providing the desired access.



Default value: [ ]

authentication_type (string) optional

One of certificate-authentication or federated-authentication



Default value: "certificate-authentication"

authorization_rules (list(map(any))) optional

List of objects describing the authorization rules for the client vpn


Default value: [ ]

ca_common_name (string) optional

Unique Common Name for CA self-signed certificate


Default value: null

client_conf_tmpl_path (string) optional

Path to template file of vpn client exported configuration. Path is relative to ${path.module}


Default value: null

create_security_group (bool) optional

Set true to create and configure a new security group. If false, associated_security_group_ids must be provided.


Default value: true

dns_servers (list(string)) optional

Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the connecting device is used.


Default value: [ ]

export_client_certificate (bool) optional

Flag to determine whether to export the client certificate with the VPN configuration


Default value: false

logging_enabled (bool) optional

Enables or disables Client VPN Cloudwatch logging.


Default value: false

retention_in_days (number) optional

Number of days you want to retain log events in the log group


Default value: "30"

root_common_name (string) optional

Unique Common Name for Root self-signed certificate


Default value: null

saml_metadata_document (string) optional

Optional SAML metadata document. Must include this or saml_provider_arn


Default value: null

saml_provider_arn (string) optional

Optional SAML provider ARN. Must include this or saml_metadata_document


Default value: null

secret_path_format (string) optional

The path format to use when writing secrets to the certificate backend.
The certificate secret path will be computed as format(var.secret_path_format, var.name, var.secret_extensions.certificate)
and the private key path as format(var.secret_path_format, var.name, var.secret_extensions.private_key).
Thus by default, if var.name=example-self-signed-cert, then the resulting secret paths for the self-signed certificate's
PEM file and private key will be /example-self-signed-cert.pem and /example-self-signed-cert.key, respectively.
This variable can be overridden in order to create more specific certificate backend paths.



Default value: "/%s.%s"

security_group_create_before_destroy (bool) optional

Set true to enable Terraform create_before_destroy behavior on the created security group.
Note that changing this value will always cause the security group to be replaced.



Default value: true

security_group_create_timeout (string) optional

How long to wait for the security group to be created.


Default value: "10m"

security_group_delete_timeout (string) optional

How long to retry on DependencyViolation errors during security group deletion from
lingering ENIs left by certain AWS services such as Elastic Load Balancing.



Default value: "15m"

security_group_description (string) optional

The description to assign to the created Security Group.
Warning: Changing the description causes the security group to be replaced.



Default value: null

security_group_name (list(string)) optional

The name to assign to the created security group. Must be unique within the VPC.
If not provided, will be derived from the null-label.context passed in.
If create_before_destroy is true, will be used as a name prefix.



Default value: [ ]

self_service_portal_enabled (bool) optional

Specify whether to enable the self-service portal for the Client VPN endpoint


Default value: false

self_service_saml_provider_arn (string) optional

The ARN of the IAM SAML identity provider for the self service portal if type is federated-authentication.


Default value: null

server_common_name (string) optional

Unique Common Name for Server self-signed certificate


Default value: null

session_timeout_hours (string) optional

The maximum session duration is a trigger by which end-users are required to re-authenticate prior to establishing a VPN session. Default value is 24. Valid values: 8 | 10 | 12 | 24


Default value: "24"

split_tunnel (bool) optional

Indicates whether split-tunnel is enabled on VPN endpoint. Default value is false.


Default value: false

transport_protocol (string) optional

Transport protocol used by the TLS sessions.


Default value: "udp"

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​

client_configuration

VPN Client Configuration data.

full_client_configuration

Client configuration including client certificate and private key

vpn_endpoint_arn

The ARN of the Client VPN Endpoint Connection.

vpn_endpoint_dns_name

The DNS Name of the Client VPN Endpoint Connection.

vpn_endpoint_id

The ID of the Client VPN Endpoint Connection.

Dependencies​

Requirements​

  • terraform, version: >= 1.0
  • aws, version: >= 4.0
  • awsutils, version: >= 0.16.0

Providers​

  • aws, version: >= 4.0
  • awsutils, version: >= 0.16.0

Modules​

NameVersionSourceDescription
cloudwatch_log0.6.8cloudposse/cloudwatch-logs/awsn/a
self_signed_cert_ca1.3.0cloudposse/ssm-tls-self-signed-cert/awsn/a
self_signed_cert_root1.3.0cloudposse/ssm-tls-self-signed-cert/awsn/a
self_signed_cert_server1.3.0cloudposse/ssm-tls-self-signed-cert/awsn/a
this0.25.0cloudposse/label/nulln/a
vpn_security_group2.2.0cloudposse/security-group/awsn/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: