{"id":19722826,"url":"https://github.com/cloudposse/terraform-aws-ec2-client-vpn","last_synced_at":"2025-02-27T18:31:30.359Z","repository":{"id":37794995,"uuid":"402945828","full_name":"cloudposse/terraform-aws-ec2-client-vpn","owner":"cloudposse","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-01T03:14:29.000Z","size":3952,"stargazers_count":46,"open_issues_count":19,"forks_count":31,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-01-10T16:27:29.761Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://cloudposse.com/accelerate","language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudposse.png","metadata":{"funding":{"github":"cloudposse"},"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"security_group_inputs.tf","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-04T02:33:01.000Z","updated_at":"2025-01-01T03:14:32.000Z","dependencies_parsed_at":"2023-11-15T04:23:09.121Z","dependency_job_id":"8aa6b365-fc7c-42c4-9d98-7844e26edda4","html_url":"https://github.com/cloudposse/terraform-aws-ec2-client-vpn","commit_stats":null,"previous_names":[],"tags_count":43,"template":false,"template_full_name":"cloudposse/terraform-example-module","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-ec2-client-vpn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-ec2-client-vpn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-ec2-client-vpn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-ec2-client-vpn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudposse","download_url":"https://codeload.github.com/cloudposse/terraform-aws-ec2-client-vpn/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241044532,"owners_count":19899524,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T23:18:37.920Z","updated_at":"2025-02-27T18:31:30.303Z","avatar_url":"https://github.com/cloudposse.png","language":"HCL","funding_links":["https://github.com/sponsors/cloudposse"],"categories":[],"sub_categories":[],"readme":"\n\n\u003c!-- markdownlint-disable --\u003e\n\u003ca href=\"https://cpco.io/homepage\"\u003e\u003cimg src=\"https://github.com/cloudposse/terraform-aws-ec2-client-vpn/blob/main/.github/banner.png?raw=true\" alt=\"Project Banner\"/\u003e\u003c/a\u003e\u003cbr/\u003e\n    \u003cp align=\"right\"\u003e\n\u003ca href=\"https://github.com/cloudposse/terraform-aws-ec2-client-vpn/releases/latest\"\u003e\u003cimg src=\"https://img.shields.io/github/release/cloudposse/terraform-aws-ec2-client-vpn.svg?style=for-the-badge\" alt=\"Latest Release\"/\u003e\u003c/a\u003e\u003ca href=\"https://github.com/cloudposse/terraform-aws-ec2-client-vpn/commits\"\u003e\u003cimg src=\"https://img.shields.io/github/last-commit/cloudposse/terraform-aws-ec2-client-vpn.svg?style=for-the-badge\" alt=\"Last Updated\"/\u003e\u003c/a\u003e\u003ca href=\"https://slack.cloudposse.com\"\u003e\u003cimg src=\"https://slack.cloudposse.com/for-the-badge.svg\" alt=\"Slack Community\"/\u003e\u003c/a\u003e\u003c/p\u003e\n\u003c!-- markdownlint-restore --\u003e\n\n\u003c!--\n\n\n\n\n  ** DO NOT EDIT THIS FILE\n  **\n  ** This file was automatically generated by the `cloudposse/build-harness`.\n  ** 1) Make all changes to `README.yaml`\n  ** 2) Run `make init` (you only need to do this once)\n  ** 3) Run`make readme` to rebuild this file.\n  **\n  ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.)\n  **\n\n\n\n\n\n--\u003e\n\nThe `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](https://docs.aws.amazon.com/vpn/latest/clientvpn-user/connect-aws-client-vpn-connect.html).\n\n\n\u003e [!TIP]\n\u003e #### 👽 Use Atmos with Terraform\n\u003e Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform. \u003cbr/\u003e\n\u003e Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift).\n\u003e\n\u003e \u003cdetails\u003e\n\u003e \u003csummary\u003e\u003cstrong\u003eWatch demo of using Atmos with Terraform\u003c/strong\u003e\u003c/summary\u003e\n\u003e \u003cimg src=\"https://github.com/cloudposse/atmos/blob/main/docs/demo.gif?raw=true\"/\u003e\u003cbr/\u003e\n\u003e \u003ci\u003eExample of running \u003ca href=\"https://atmos.tools\"\u003e\u003ccode\u003eatmos\u003c/code\u003e\u003c/a\u003e to manage infrastructure from our \u003ca href=\"https://atmos.tools/quick-start/\"\u003eQuick Start\u003c/a\u003e tutorial.\u003c/i\u003e\n\u003e \u003c/detalis\u003e\n\n\n\n\n\n## Usage\n\nFor a complete example, see [examples/complete](examples/complete).\n\nFor automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest)\n(which tests and deploys the example on AWS), see [test](test).\n\n```hcl\nmodule \"vpc_target\" {\n  source  = \"cloudposse/vpc/aws\"\n  # Cloud Posse recommends pinning every module to a specific version\n  # version = \"x.x.x\"\n\n  cidr_block = \"172.16.0.0/16\"\n\n  context = module.this.context\n}\n\nmodule \"vpc_client\" {\n  source  = \"cloudposse/vpc/aws\"\n  # Cloud Posse recommends pinning every module to a specific version\n  # version = \"x.x.x\"\n\n  cidr_block = \"172.31.0.0/16\"\n\n  context = module.this.context\n}\n\nmodule \"subnets\" {\n  source  = \"cloudposse/dynamic-subnets/aws\"\n  # Cloud Posse recommends pinning every module to a specific version\n  # version = \"x.x.x\"\n\n  availability_zones   = var.availability_zones\n  vpc_id               = module.vpc_target.vpc_id\n  igw_id               = module.vpc_target.igw_id\n  cidr_block           = module.vpc_target.vpc_cidr_block\n  nat_gateway_enabled  = true\n  nat_instance_enabled = false\n\n  context = module.this.context\n}\n\nmodule \"ec2_client_vpn\" {\n  source  = \"cloudposse/ec2-client-vpn/aws\"\n  # Cloud Posse recommends pinning every module to a specific version\n  # version = \"x.x.x\"\n\n  client_cidr             = module.vpc_client.vpc_cidr_block\n  organization_name       = var.organization_name\n  logging_enabled         = var.logging_enabled\n  retention_in_days       = var.retention_in_days\n  associated_subnets      = module.subnets.private_subnet_ids\n  authorization_rules     = var.authorization_rules\n\n  additional_routes = [\n    {\n      destination_cidr_block = \"0.0.0.0/0\"\n      description            = \"Internet Route\"\n      target_vpc_subnet_id   = element(module.subnets.private_subnet_ids, 0)\n    }\n  ]\n}\n```\n\n\u003e [!IMPORTANT]\n\u003e In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation\n\u003e and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version\n\u003e you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic\n\u003e approach for updating versions to avoid unexpected changes.\n\n\n\n\n\n## Examples\n\nHere is an example of using this module:\n- [`examples/complete`](https://github.com/cloudposse/terraform-aws-ec2-client-vpn/examples/complete/) - complete example of using this module\n\n\n\n\n\u003c!-- markdownlint-disable --\u003e\n## Makefile Targets\n```text\nAvailable targets:\n\n  help                                Help screen\n  help/all                            Display help for all targets\n  help/short                          This help short screen\n  lint                                Lint terraform code\n\n```\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- markdownlint-disable --\u003e\n## Requirements\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"requirement_terraform\"\u003e\u003c/a\u003e [terraform](#requirement\\_terraform) | \u003e= 1.0 |\n| \u003ca name=\"requirement_aws\"\u003e\u003c/a\u003e [aws](#requirement\\_aws) | \u003e= 4.0 |\n| \u003ca name=\"requirement_awsutils\"\u003e\u003c/a\u003e [awsutils](#requirement\\_awsutils) | \u003e= 0.16.0 |\n\n## Providers\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"provider_aws\"\u003e\u003c/a\u003e [aws](#provider\\_aws) | \u003e= 4.0 |\n| \u003ca name=\"provider_awsutils\"\u003e\u003c/a\u003e [awsutils](#provider\\_awsutils) | \u003e= 0.16.0 |\n\n## Modules\n\n| Name | Source | Version |\n|------|--------|---------|\n| \u003ca name=\"module_cloudwatch_log\"\u003e\u003c/a\u003e [cloudwatch\\_log](#module\\_cloudwatch\\_log) | cloudposse/cloudwatch-logs/aws | 0.6.8 |\n| \u003ca name=\"module_self_signed_cert_ca\"\u003e\u003c/a\u003e [self\\_signed\\_cert\\_ca](#module\\_self\\_signed\\_cert\\_ca) | cloudposse/ssm-tls-self-signed-cert/aws | 1.3.0 |\n| \u003ca name=\"module_self_signed_cert_root\"\u003e\u003c/a\u003e [self\\_signed\\_cert\\_root](#module\\_self\\_signed\\_cert\\_root) | cloudposse/ssm-tls-self-signed-cert/aws | 1.3.0 |\n| \u003ca name=\"module_self_signed_cert_server\"\u003e\u003c/a\u003e [self\\_signed\\_cert\\_server](#module\\_self\\_signed\\_cert\\_server) | cloudposse/ssm-tls-self-signed-cert/aws | 1.3.0 |\n| \u003ca name=\"module_this\"\u003e\u003c/a\u003e [this](#module\\_this) | cloudposse/label/null | 0.25.0 |\n| \u003ca name=\"module_vpn_security_group\"\u003e\u003c/a\u003e [vpn\\_security\\_group](#module\\_vpn\\_security\\_group) | cloudposse/security-group/aws | 2.2.0 |\n\n## Resources\n\n| Name | Type |\n|------|------|\n| [aws_ec2_client_vpn_authorization_rule.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ec2_client_vpn_authorization_rule) | resource |\n| [aws_ec2_client_vpn_endpoint.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ec2_client_vpn_endpoint) | resource |\n| [aws_ec2_client_vpn_network_association.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ec2_client_vpn_network_association) | resource |\n| [aws_ec2_client_vpn_route.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ec2_client_vpn_route) | resource |\n| [aws_iam_saml_provider.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_saml_provider) | resource |\n| [aws_ssm_parameter.ca_key](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ssm_parameter) | data source |\n| [aws_ssm_parameter.root_key](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ssm_parameter) | data source |\n| [awsutils_ec2_client_vpn_export_client_config.default](https://registry.terraform.io/providers/cloudposse/awsutils/latest/docs/data-sources/ec2_client_vpn_export_client_config) | data source |\n\n## Inputs\n\n| Name | Description | Type | Default | Required |\n|------|-------------|------|---------|:--------:|\n| \u003ca name=\"input_additional_routes\"\u003e\u003c/a\u003e [additional\\_routes](#input\\_additional\\_routes) | A list of additional routes that should be attached to the Client VPN endpoint | \u003cpre\u003elist(object({\u003cbr/\u003e    destination_cidr_block = string\u003cbr/\u003e    description            = string\u003cbr/\u003e    target_vpc_subnet_id   = string\u003cbr/\u003e  }))\u003c/pre\u003e | `[]` | no |\n| \u003ca name=\"input_additional_security_group_rules\"\u003e\u003c/a\u003e [additional\\_security\\_group\\_rules](#input\\_additional\\_security\\_group\\_rules) | A list of Security Group rule objects to add to the created security group, in addition to the ones\u003cbr/\u003ethis module normally creates. (To suppress the module's rules, set `create_security_group` to false\u003cbr/\u003eand supply your own security group via `associated_security_group_ids`.)\u003cbr/\u003eThe keys and values of the objects are fully compatible with the `aws_security_group_rule` resource, except\u003cbr/\u003efor `security_group_id` which will be ignored, and the optional \"key\" which, if provided, must be unique and known at \"plan\" time.\u003cbr/\u003eTo get more info see https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule . | `list(any)` | `[]` | no |\n| \u003ca name=\"input_additional_security_groups\"\u003e\u003c/a\u003e [additional\\_security\\_groups](#input\\_additional\\_security\\_groups) | DEPRECATED: Use `associated_security_group_ids` instead.\u003cbr/\u003eList of security groups to attach to the client vpn network associations | `list(string)` | `[]` | no |\n| \u003ca name=\"input_additional_tag_map\"\u003e\u003c/a\u003e [additional\\_tag\\_map](#input\\_additional\\_tag\\_map) | Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.\u003cbr/\u003eThis is for some rare cases where resources want additional configuration of tags\u003cbr/\u003eand therefore take a list of maps with tag key, value, and additional configuration. | `map(string)` | `{}` | no |\n| \u003ca name=\"input_allow_self_security_group\"\u003e\u003c/a\u003e [allow\\_self\\_security\\_group](#input\\_allow\\_self\\_security\\_group) | Whether the security group itself will be added as a source to this ingress rule. | `bool` | `true` | no |\n| \u003ca name=\"input_allowed_cidr_blocks\"\u003e\u003c/a\u003e [allowed\\_cidr\\_blocks](#input\\_allowed\\_cidr\\_blocks) | A list of IPv4 CIDRs to allow access to the security group created by this module.\u003cbr/\u003eThe length of this list must be known at \"plan\" time. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_allowed_ipv6_cidr_blocks\"\u003e\u003c/a\u003e [allowed\\_ipv6\\_cidr\\_blocks](#input\\_allowed\\_ipv6\\_cidr\\_blocks) | A list of IPv6 CIDRs to allow access to the security group created by this module.\u003cbr/\u003eThe length of this list must be known at \"plan\" time. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_allowed_ipv6_prefix_list_ids\"\u003e\u003c/a\u003e [allowed\\_ipv6\\_prefix\\_list\\_ids](#input\\_allowed\\_ipv6\\_prefix\\_list\\_ids) | A list of IPv6 Prefix Lists IDs to allow access to the security group created by this module.\u003cbr/\u003eThe length of this list must be known at \"plan\" time. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_allowed_security_group_ids\"\u003e\u003c/a\u003e [allowed\\_security\\_group\\_ids](#input\\_allowed\\_security\\_group\\_ids) | A list of IDs of Security Groups to allow access to the security group created by this module.\u003cbr/\u003eThe length of this list must be known at \"plan\" time. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_associated_security_group_ids\"\u003e\u003c/a\u003e [associated\\_security\\_group\\_ids](#input\\_associated\\_security\\_group\\_ids) | A list of IDs of Security Groups to associate the VPN endpoints with, in addition to the created security group.\u003cbr/\u003eThese security groups will not be modified and, if `create_security_group` is `false`, must have rules providing the desired access. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_associated_subnets\"\u003e\u003c/a\u003e [associated\\_subnets](#input\\_associated\\_subnets) | List of subnets to associate with the VPN endpoint | `list(string)` | n/a | yes |\n| \u003ca name=\"input_attributes\"\u003e\u003c/a\u003e [attributes](#input\\_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,\u003cbr/\u003ein the order they appear in the list. New attributes are appended to the\u003cbr/\u003eend of the list. The elements of the list are joined by the `delimiter`\u003cbr/\u003eand treated as a single ID element. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_authentication_type\"\u003e\u003c/a\u003e [authentication\\_type](#input\\_authentication\\_type) | One of `certificate-authentication` or `federated-authentication` | `string` | `\"certificate-authentication\"` | no |\n| \u003ca name=\"input_authorization_rules\"\u003e\u003c/a\u003e [authorization\\_rules](#input\\_authorization\\_rules) | List of objects describing the authorization rules for the client vpn | `list(map(any))` | `[]` | no |\n| \u003ca name=\"input_ca_common_name\"\u003e\u003c/a\u003e [ca\\_common\\_name](#input\\_ca\\_common\\_name) | Unique Common Name for CA self-signed certificate | `string` | `null` | no |\n| \u003ca name=\"input_client_cidr\"\u003e\u003c/a\u003e [client\\_cidr](#input\\_client\\_cidr) | Network CIDR to use for clients | `string` | n/a | yes |\n| \u003ca name=\"input_client_conf_tmpl_path\"\u003e\u003c/a\u003e [client\\_conf\\_tmpl\\_path](#input\\_client\\_conf\\_tmpl\\_path) | Path to template file of vpn client exported configuration. Path is relative to ${path.module} | `string` | `null` | no |\n| \u003ca name=\"input_context\"\u003e\u003c/a\u003e [context](#input\\_context) | Single object for setting entire context at once.\u003cbr/\u003eSee description of individual variables for details.\u003cbr/\u003eLeave string and numeric variables as `null` to use default value.\u003cbr/\u003eIndividual variable settings (non-null) override settings in context object,\u003cbr/\u003eexcept for attributes, tags, and additional\\_tag\\_map, which are merged. | `any` | \u003cpre\u003e{\u003cbr/\u003e  \"additional_tag_map\": {},\u003cbr/\u003e  \"attributes\": [],\u003cbr/\u003e  \"delimiter\": null,\u003cbr/\u003e  \"descriptor_formats\": {},\u003cbr/\u003e  \"enabled\": true,\u003cbr/\u003e  \"environment\": null,\u003cbr/\u003e  \"id_length_limit\": null,\u003cbr/\u003e  \"label_key_case\": null,\u003cbr/\u003e  \"label_order\": [],\u003cbr/\u003e  \"label_value_case\": null,\u003cbr/\u003e  \"labels_as_tags\": [\u003cbr/\u003e    \"unset\"\u003cbr/\u003e  ],\u003cbr/\u003e  \"name\": null,\u003cbr/\u003e  \"namespace\": null,\u003cbr/\u003e  \"regex_replace_chars\": null,\u003cbr/\u003e  \"stage\": null,\u003cbr/\u003e  \"tags\": {},\u003cbr/\u003e  \"tenant\": null\u003cbr/\u003e}\u003c/pre\u003e | no |\n| \u003ca name=\"input_create_security_group\"\u003e\u003c/a\u003e [create\\_security\\_group](#input\\_create\\_security\\_group) | Set `true` to create and configure a new security group. If false, `associated_security_group_ids` must be provided. | `bool` | `true` | no |\n| \u003ca name=\"input_delimiter\"\u003e\u003c/a\u003e [delimiter](#input\\_delimiter) | Delimiter to be used between ID elements.\u003cbr/\u003eDefaults to `-` (hyphen). Set to `\"\"` to use no delimiter at all. | `string` | `null` | no |\n| \u003ca name=\"input_descriptor_formats\"\u003e\u003c/a\u003e [descriptor\\_formats](#input\\_descriptor\\_formats) | Describe additional descriptors to be output in the `descriptors` output map.\u003cbr/\u003eMap of maps. Keys are names of descriptors. Values are maps of the form\u003cbr/\u003e`{\u003cbr/\u003e   format = string\u003cbr/\u003e   labels = list(string)\u003cbr/\u003e}`\u003cbr/\u003e(Type is `any` so the map values can later be enhanced to provide additional options.)\u003cbr/\u003e`format` is a Terraform format string to be passed to the `format()` function.\u003cbr/\u003e`labels` is a list of labels, in order, to pass to `format()` function.\u003cbr/\u003eLabel values will be normalized before being passed to `format()` so they will be\u003cbr/\u003eidentical to how they appear in `id`.\u003cbr/\u003eDefault is `{}` (`descriptors` output will be empty). | `any` | `{}` | no |\n| \u003ca name=\"input_dns_servers\"\u003e\u003c/a\u003e [dns\\_servers](#input\\_dns\\_servers) | 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. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_enabled\"\u003e\u003c/a\u003e [enabled](#input\\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |\n| \u003ca name=\"input_environment\"\u003e\u003c/a\u003e [environment](#input\\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no |\n| \u003ca name=\"input_export_client_certificate\"\u003e\u003c/a\u003e [export\\_client\\_certificate](#input\\_export\\_client\\_certificate) | Flag to determine whether to export the client certificate with the VPN configuration | `bool` | `false` | no |\n| \u003ca name=\"input_id_length_limit\"\u003e\u003c/a\u003e [id\\_length\\_limit](#input\\_id\\_length\\_limit) | Limit `id` to this many characters (minimum 6).\u003cbr/\u003eSet to `0` for unlimited length.\u003cbr/\u003eSet to `null` for keep the existing setting, which defaults to `0`.\u003cbr/\u003eDoes not affect `id_full`. | `number` | `null` | no |\n| \u003ca name=\"input_label_key_case\"\u003e\u003c/a\u003e [label\\_key\\_case](#input\\_label\\_key\\_case) | Controls the letter case of the `tags` keys (label names) for tags generated by this module.\u003cbr/\u003eDoes not affect keys of tags passed in via the `tags` input.\u003cbr/\u003ePossible values: `lower`, `title`, `upper`.\u003cbr/\u003eDefault value: `title`. | `string` | `null` | no |\n| \u003ca name=\"input_label_order\"\u003e\u003c/a\u003e [label\\_order](#input\\_label\\_order) | The order in which the labels (ID elements) appear in the `id`.\u003cbr/\u003eDefaults to [\"namespace\", \"environment\", \"stage\", \"name\", \"attributes\"].\u003cbr/\u003eYou can omit any of the 6 labels (\"tenant\" is the 6th), but at least one must be present. | `list(string)` | `null` | no |\n| \u003ca name=\"input_label_value_case\"\u003e\u003c/a\u003e [label\\_value\\_case](#input\\_label\\_value\\_case) | Controls the letter case of ID elements (labels) as included in `id`,\u003cbr/\u003eset as tag values, and output by this module individually.\u003cbr/\u003eDoes not affect values of tags passed in via the `tags` input.\u003cbr/\u003ePossible values: `lower`, `title`, `upper` and `none` (no transformation).\u003cbr/\u003eSet this to `title` and set `delimiter` to `\"\"` to yield Pascal Case IDs.\u003cbr/\u003eDefault value: `lower`. | `string` | `null` | no |\n| \u003ca name=\"input_labels_as_tags\"\u003e\u003c/a\u003e [labels\\_as\\_tags](#input\\_labels\\_as\\_tags) | Set of labels (ID elements) to include as tags in the `tags` output.\u003cbr/\u003eDefault is to include all labels.\u003cbr/\u003eTags with empty values will not be included in the `tags` output.\u003cbr/\u003eSet to `[]` to suppress all generated tags.\u003cbr/\u003e**Notes:**\u003cbr/\u003e  The value of the `name` tag, if included, will be the `id`, not the `name`.\u003cbr/\u003e  Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be\u003cbr/\u003e  changed in later chained modules. Attempts to change it will be silently ignored. | `set(string)` | \u003cpre\u003e[\u003cbr/\u003e  \"default\"\u003cbr/\u003e]\u003c/pre\u003e | no |\n| \u003ca name=\"input_logging_enabled\"\u003e\u003c/a\u003e [logging\\_enabled](#input\\_logging\\_enabled) | Enables or disables Client VPN Cloudwatch logging. | `bool` | `false` | no |\n| \u003ca name=\"input_logging_stream_name\"\u003e\u003c/a\u003e [logging\\_stream\\_name](#input\\_logging\\_stream\\_name) | Names of stream used for logging | `string` | n/a | yes |\n| \u003ca name=\"input_name\"\u003e\u003c/a\u003e [name](#input\\_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.\u003cbr/\u003eThis is the only ID element not also included as a `tag`.\u003cbr/\u003eThe \"name\" tag is set to the full `id` string. There is no tag with the value of the `name` input. | `string` | `null` | no |\n| \u003ca name=\"input_namespace\"\u003e\u003c/a\u003e [namespace](#input\\_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 |\n| \u003ca name=\"input_organization_name\"\u003e\u003c/a\u003e [organization\\_name](#input\\_organization\\_name) | Name of organization to use in private certificate | `string` | n/a | yes |\n| \u003ca name=\"input_regex_replace_chars\"\u003e\u003c/a\u003e [regex\\_replace\\_chars](#input\\_regex\\_replace\\_chars) | Terraform regular expression (regex) string.\u003cbr/\u003eCharacters matching the regex will be removed from the ID elements.\u003cbr/\u003eIf not set, `\"/[^a-zA-Z0-9-]/\"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no |\n| \u003ca name=\"input_retention_in_days\"\u003e\u003c/a\u003e [retention\\_in\\_days](#input\\_retention\\_in\\_days) | Number of days you want to retain log events in the log group | `number` | `\"30\"` | no |\n| \u003ca name=\"input_root_common_name\"\u003e\u003c/a\u003e [root\\_common\\_name](#input\\_root\\_common\\_name) | Unique Common Name for Root self-signed certificate | `string` | `null` | no |\n| \u003ca name=\"input_saml_metadata_document\"\u003e\u003c/a\u003e [saml\\_metadata\\_document](#input\\_saml\\_metadata\\_document) | Optional SAML metadata document. Must include this or `saml_provider_arn` | `string` | `null` | no |\n| \u003ca name=\"input_saml_provider_arn\"\u003e\u003c/a\u003e [saml\\_provider\\_arn](#input\\_saml\\_provider\\_arn) | Optional SAML provider ARN. Must include this or `saml_metadata_document` | `string` | `null` | no |\n| \u003ca name=\"input_secret_path_format\"\u003e\u003c/a\u003e [secret\\_path\\_format](#input\\_secret\\_path\\_format) | The path format to use when writing secrets to the certificate backend.\u003cbr/\u003eThe certificate secret path will be computed as `format(var.secret_path_format, var.name, var.secret_extensions.certificate)`\u003cbr/\u003eand the private key path as `format(var.secret_path_format, var.name, var.secret_extensions.private_key)`.\u003cbr/\u003eThus by default, if `var.name`=`example-self-signed-cert`, then the resulting secret paths for the self-signed certificate's\u003cbr/\u003ePEM file and private key will be `/example-self-signed-cert.pem` and `/example-self-signed-cert.key`, respectively.\u003cbr/\u003eThis variable can be overridden in order to create more specific certificate backend paths. | `string` | `\"/%s.%s\"` | no |\n| \u003ca name=\"input_security_group_create_before_destroy\"\u003e\u003c/a\u003e [security\\_group\\_create\\_before\\_destroy](#input\\_security\\_group\\_create\\_before\\_destroy) | Set `true` to enable Terraform `create_before_destroy` behavior on the created security group.\u003cbr/\u003eNote that changing this value will always cause the security group to be replaced. | `bool` | `true` | no |\n| \u003ca name=\"input_security_group_create_timeout\"\u003e\u003c/a\u003e [security\\_group\\_create\\_timeout](#input\\_security\\_group\\_create\\_timeout) | How long to wait for the security group to be created. | `string` | `\"10m\"` | no |\n| \u003ca name=\"input_security_group_delete_timeout\"\u003e\u003c/a\u003e [security\\_group\\_delete\\_timeout](#input\\_security\\_group\\_delete\\_timeout) | How long to retry on `DependencyViolation` errors during security group deletion from\u003cbr/\u003elingering ENIs left by certain AWS services such as Elastic Load Balancing. | `string` | `\"15m\"` | no |\n| \u003ca name=\"input_security_group_description\"\u003e\u003c/a\u003e [security\\_group\\_description](#input\\_security\\_group\\_description) | The description to assign to the created Security Group.\u003cbr/\u003eWarning: Changing the description causes the security group to be replaced. | `string` | `null` | no |\n| \u003ca name=\"input_security_group_name\"\u003e\u003c/a\u003e [security\\_group\\_name](#input\\_security\\_group\\_name) | The name to assign to the created security group. Must be unique within the VPC.\u003cbr/\u003eIf not provided, will be derived from the `null-label.context` passed in.\u003cbr/\u003eIf `create_before_destroy` is true, will be used as a name prefix. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_self_service_portal_enabled\"\u003e\u003c/a\u003e [self\\_service\\_portal\\_enabled](#input\\_self\\_service\\_portal\\_enabled) | Specify whether to enable the self-service portal for the Client VPN endpoint | `bool` | `false` | no |\n| \u003ca name=\"input_self_service_saml_provider_arn\"\u003e\u003c/a\u003e [self\\_service\\_saml\\_provider\\_arn](#input\\_self\\_service\\_saml\\_provider\\_arn) | The ARN of the IAM SAML identity provider for the self service portal if type is federated-authentication. | `string` | `null` | no |\n| \u003ca name=\"input_server_common_name\"\u003e\u003c/a\u003e [server\\_common\\_name](#input\\_server\\_common\\_name) | Unique Common Name for Server self-signed certificate | `string` | `null` | no |\n| \u003ca name=\"input_session_timeout_hours\"\u003e\u003c/a\u003e [session\\_timeout\\_hours](#input\\_session\\_timeout\\_hours) | 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 | `string` | `\"24\"` | no |\n| \u003ca name=\"input_split_tunnel\"\u003e\u003c/a\u003e [split\\_tunnel](#input\\_split\\_tunnel) | Indicates whether split-tunnel is enabled on VPN endpoint. Default value is false. | `bool` | `false` | no |\n| \u003ca name=\"input_stage\"\u003e\u003c/a\u003e [stage](#input\\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |\n| \u003ca name=\"input_tags\"\u003e\u003c/a\u003e [tags](#input\\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).\u003cbr/\u003eNeither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no |\n| \u003ca name=\"input_tenant\"\u003e\u003c/a\u003e [tenant](#input\\_tenant) | ID element \\_(Rarely used, not included by default)\\_. A customer identifier, indicating who this instance of a resource is for | `string` | `null` | no |\n| \u003ca name=\"input_transport_protocol\"\u003e\u003c/a\u003e [transport\\_protocol](#input\\_transport\\_protocol) | Transport protocol used by the TLS sessions. | `string` | `\"udp\"` | no |\n| \u003ca name=\"input_vpc_id\"\u003e\u003c/a\u003e [vpc\\_id](#input\\_vpc\\_id) | ID of VPC to attach VPN to | `string` | n/a | yes |\n\n## Outputs\n\n| Name | Description |\n|------|-------------|\n| \u003ca name=\"output_client_configuration\"\u003e\u003c/a\u003e [client\\_configuration](#output\\_client\\_configuration) | VPN Client Configuration data. |\n| \u003ca name=\"output_full_client_configuration\"\u003e\u003c/a\u003e [full\\_client\\_configuration](#output\\_full\\_client\\_configuration) | Client configuration including client certificate and private key |\n| \u003ca name=\"output_vpn_endpoint_arn\"\u003e\u003c/a\u003e [vpn\\_endpoint\\_arn](#output\\_vpn\\_endpoint\\_arn) | The ARN of the Client VPN Endpoint Connection. |\n| \u003ca name=\"output_vpn_endpoint_dns_name\"\u003e\u003c/a\u003e [vpn\\_endpoint\\_dns\\_name](#output\\_vpn\\_endpoint\\_dns\\_name) | The DNS Name of the Client VPN Endpoint Connection. |\n| \u003ca name=\"output_vpn_endpoint_id\"\u003e\u003c/a\u003e [vpn\\_endpoint\\_id](#output\\_vpn\\_endpoint\\_id) | The ID of the Client VPN Endpoint Connection. |\n\u003c!-- markdownlint-restore --\u003e\n\n\n## Related Projects\n\nCheck out these related projects.\n\n- [terraform-aws-components](https://github.com/cloudposse/terraform-aws-components) - Repository collection of aws components.\n- [terraform-aws-ssm-tls-self-signed-cert](https://github.com/cloudposse/terraform-aws-ssm-tls-self-signed-cert) - This module creates a self-signed certificate and writes it alongside with its key to SSM Parameter Store (or alternatively AWS Secrets Manager). Used to store VPN certificates in ACM.\n- [terraform-provider-awsutils](https://github.com/cloudposse/terraform-provider-awsutils) - Terraform provider for performing various tasks that cannot be performed with the official AWS Terraform Provider from Hashicorp. Used to export vpn client configuration.\n\n\n## References\n\nFor additional context, refer to some of these links.\n\n- [OpenVPN Clients](https://docs.aws.amazon.com/vpn/latest/clientvpn-user/connect-aws-client-vpn-connect.html) - Any OpenVPN client should be compatible with the AWS Client VPN.\n\n\n\n\u003e [!TIP]\n\u003e #### Use Terraform Reference Architectures for AWS\n\u003e\n\u003e Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.\n\u003e\n\u003e ✅ We build it together with your team.\u003cbr/\u003e\n\u003e ✅ Your team owns everything.\u003cbr/\u003e\n\u003e ✅ 100% Open Source and backed by fanatical support.\u003cbr/\u003e\n\u003e\n\u003e \u003ca href=\"https://cpco.io/commercial-support?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-ec2-client-vpn\u0026utm_content=commercial_support\"\u003e\u003cimg alt=\"Request Quote\" src=\"https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge\"/\u003e\u003c/a\u003e\n\u003e \u003cdetails\u003e\u003csummary\u003e📚 \u003cstrong\u003eLearn More\u003c/strong\u003e\u003c/summary\u003e\n\u003e\n\u003e \u003cbr/\u003e\n\u003e\n\u003e Cloud Posse is the leading [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-ec2-client-vpn\u0026utm_content=commercial_support) for funded startups and enterprises.\n\u003e\n\u003e *Your team can operate like a pro today.*\n\u003e\n\u003e Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.\n\u003e #### Day-0:  Your Foundation for Success\n\u003e - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.\n\u003e - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.\n\u003e - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.\n\u003e - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.\n\u003e - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.\n\u003e\n\u003e \u003ca href=\"https://cpco.io/commercial-support?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-ec2-client-vpn\u0026utm_content=commercial_support\"\u003e\u003cimg alt=\"Request Quote\" src=\"https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge\"/\u003e\u003c/a\u003e\n\u003e\n\u003e #### Day-2: Your Operational Mastery\n\u003e - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.\n\u003e - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.\n\u003e - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.\n\u003e - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.\n\u003e - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.\n\u003e - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.\n\u003e - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.\n\u003e\n\u003e \u003ca href=\"https://cpco.io/commercial-support?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-ec2-client-vpn\u0026utm_content=commercial_support\"\u003e\u003cimg alt=\"Request Quote\" src=\"https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge\"/\u003e\u003c/a\u003e\n\u003e \u003c/details\u003e\n\n## ✨ Contributing\n\nThis project is under active development, and we encourage contributions from our community.\n\n\n\nMany thanks to our outstanding contributors:\n\n\u003ca href=\"https://github.com/cloudposse/terraform-aws-ec2-client-vpn/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=cloudposse/terraform-aws-ec2-client-vpn\u0026max=24\" /\u003e\n\u003c/a\u003e\n\nFor 🐛 bug reports \u0026 feature requests, please use the [issue tracker](https://github.com/cloudposse/terraform-aws-ec2-client-vpn/issues).\n\nIn general, PRs are welcome. We follow the typical \"fork-and-pull\" Git workflow.\n 1. Review our [Code of Conduct](https://github.com/cloudposse/terraform-aws-ec2-client-vpn/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).\n 2. **Fork** the repo on GitHub\n 3. **Clone** the project to your own machine\n 4. **Commit** changes to your own branch\n 5. **Push** your work back up to your fork\n 6. Submit a **Pull Request** so that we can review your changes\n\n**NOTE:** Be sure to merge the latest changes from \"upstream\" before making a pull request!\n\n### 🌎 Slack Community\n\nJoin our [Open Source Community](https://cpco.io/slack?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-ec2-client-vpn\u0026utm_content=slack) on Slack. It's **FREE** for everyone! Our \"SweetOps\" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.\n\n### 📰 Newsletter\n\nSign up for [our newsletter](https://cpco.io/newsletter?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-ec2-client-vpn\u0026utm_content=newsletter) and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know.\nDropped straight into your Inbox every week — and usually a 5-minute read.\n\n### 📆 Office Hours \u003ca href=\"https://cloudposse.com/office-hours?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-ec2-client-vpn\u0026utm_content=office_hours\"\u003e\u003cimg src=\"https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png\" align=\"right\" /\u003e\u003c/a\u003e\n\n[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-ec2-client-vpn\u0026utm_content=office_hours) for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a _live Q\u0026A_ that you can’t find anywhere else.\nIt's **FREE** for everyone!\n## License\n\n\u003ca href=\"https://opensource.org/licenses/Apache-2.0\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge\" alt=\"License\"\u003e\u003c/a\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003ePreamble to the Apache License, Version 2.0\u003c/summary\u003e\n\u003cbr/\u003e\n\u003cbr/\u003e\n\nComplete license is available in the [`LICENSE`](LICENSE) file.\n\n```text\nLicensed to the Apache Software Foundation (ASF) under one\nor more contributor license agreements.  See the NOTICE file\ndistributed with this work for additional information\nregarding copyright ownership.  The ASF licenses this file\nto you under the Apache License, Version 2.0 (the\n\"License\"); you may not use this file except in compliance\nwith the License.  You may obtain a copy of the License at\n\n  https://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing,\nsoftware distributed under the License is distributed on an\n\"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\nKIND, either express or implied.  See the License for the\nspecific language governing permissions and limitations\nunder the License.\n```\n\u003c/details\u003e\n\n## Trademarks\n\nAll other trademarks referenced herein are the property of their respective owners.\n\n\n## Copyrights\n\nCopyright © 2020-2025 [Cloud Posse, LLC](https://cloudposse.com)\n\n\n\n\u003ca href=\"https://cloudposse.com/readme/footer/link?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-ec2-client-vpn\u0026utm_content=readme_footer_link\"\u003e\u003cimg alt=\"README footer\" src=\"https://cloudposse.com/readme/footer/img\"/\u003e\u003c/a\u003e\n\n\u003cimg alt=\"Beacon\" width=\"0\" src=\"https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terraform-aws-ec2-client-vpn?pixel\u0026cs=github\u0026cm=readme\u0026an=terraform-aws-ec2-client-vpn\"/\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudposse%2Fterraform-aws-ec2-client-vpn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudposse%2Fterraform-aws-ec2-client-vpn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudposse%2Fterraform-aws-ec2-client-vpn/lists"}