Skip to main content

Component: ec2-client-vpn

This component is responsible for provisioning VPN Client Endpoints.


Stack Level: Regional

Here's an example snippet for how to use this component. This component should only be applied once as the resources it creates are regional. This is typically done via the corp stack (e.g. uw2-corp.yaml). This is because a vpc endpoint requires a vpc and the network stack does not have a vpc.

workspace_enabled: true
enabled: true
logging_stream_name: client_vpn
logging_enabled: true
retention_in_days: 7
organization_name: acme
split_tunnel: true
- us-west-2a
- us-west-2b
- us-west-2c
associated_security_group_ids: []
- destination_cidr_block:
description: Internet Route
- name: Internet Rule
authorize_all_groups: true
description: Allows routing to the internet"


NOTE: This module uses the aws_ec2_client_vpn_route resource which throws an error if too many API calls come from a single host. Ignore this error and repeat the terraform command. It usually takes 3 deploys (or destroys) to complete.

Error on create (See issue

ConcurrentMutationLimitExceeded: Cannot initiate another change for this endpoint at this time. Please try again later.

Error on destroy (See issue

timeout while waiting for resource to be gone (last state: 'deleting', timeout: 1m0s)


NOTE: The in this repo is equivalent to the one in the sso component and is used for testing. This component can only specify a single SAML document. The customer SAML xml should be placed in this directory side-by-side the CloudPosse SAML xml.

Prior to testing, the component needs to be deployed and the AWS client app needs to be setup by the IdP admin otherwise the following steps will result in an error similar to app_not_configured_for_user.

  1. Deploy the component in a regional account with a VPC like ue2-corp.
  2. Copy the contents of client_configuration into a file called client_configuration.ovpn
  3. Download AWS client VPN brew install --cask aws-vpn-client
  4. Launch the VPN
  5. File > Manage Profiles to open the Manage Profiles window
  6. Click Add Profile to open the Add Profile window
  7. Set the display name e.g. <tenant>-<environment>-<stage>
  8. Click the folder icon and find the file that was saved in a previous step
  9. Click Add Profile to save the profile
  10. Click Done to close to Manage Profiles window
  11. Under "Ready to connect.", choose the profile, and click Connect

A browser will launch and allow you to connect to the VPN.

  1. Make a note of where this component is deployed

  2. Ensure that the resource to connect to is in a VPC that is connected by the transit gateway

  3. Ensure that the resource to connect to contains a security group with a rule that allows ingress from where the client vpn is deployed (e.g. ue2-corp)

  4. Use nmap to test if the port is open. If the port is filtered then it's not open.

    nmap -p <PORT> <HOST>

Successful tests have been seen with MSK and RDS.


terraform>= 1.0
aws>= 4.0
awsutils>= 0.11.0


No providers.




No resources.


additional_tag_mapAdditional 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.
associated_security_group_idsList of security groups to attach to the client vpn network associationslist(string)[]no
attributesID 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.
authentication_typeOne of certificate-authentication or federated-authenticationstring"certificate-authentication"no
authorization_rulesList of objects describing the authorization rules for the Client VPN. Each Target Network CIDR range given will be used to create an additional route attached to the Client VPN endpoint with the same Description.
name = string
access_group_id = string
authorize_all_groups = bool
description = string
target_network_cidr = string
ca_common_nameUnique Common Name for CA self-signed certificatestringnullno
client_cidrNetwork CIDR to use for clientsstringn/ayes
contextSingle 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.
"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": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe 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).
dns_serversInformation 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 VPC that is to be associated with Client VPN endpoint is used as the DNS server.list(string)[]no
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
export_client_certificateFlag to determine whether to export the client certificate with the VPN configurationbooltrueno
id_length_limitLimit 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.
label_key_caseControls 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.
label_orderThe 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.
label_value_caseControls 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.
labels_as_tagsSet 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.
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.
logging_enabledEnables or disables Client VPN Cloudwatch logging.boolfalseno
logging_stream_nameNames of stream used for loggingstringn/ayes
nameID 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.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
organization_nameName of organization to use in private certificatestringn/ayes
regex_replace_charsTerraform 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.
regionVPN Endpoints are region-specific. This identifies the region. AWS Regionstringn/ayes
retention_in_daysNumber of days you want to retain log events in the log groupnumber30no
root_common_nameUnique Common Name for Root self-signed certificatestringnullno
saml_metadata_documentOptional SAML metadata document. Must include this or saml_provider_arnstringnullno
saml_provider_arnOptional SAML provider ARN. Must include this or saml_metadata_documentstringnullno
server_common_nameUnique Common Name for Server self-signed certificatestringnullno
split_tunnelIndicates whether split-tunnel is enabled on VPN endpoint. Default value is false.boolfalseno
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno


client_configurationVPN Client Configuration file (.ovpn) contents that can be imported into AWS client vpn
full_client_configurationClient configuration including client certificate and private key for mutual authentication
vpn_endpoint_arnThe ARN of the Client VPN Endpoint Connection.
vpn_endpoint_dns_nameThe DNS Name of the Client VPN Endpoint Connection.
vpn_endpoint_idThe ID of the Client VPN Endpoint Connection.