{"id":19722812,"url":"https://github.com/cloudposse/terraform-aws-alb-ingress","last_synced_at":"2025-04-06T13:11:21.791Z","repository":{"id":34445199,"uuid":"136582325","full_name":"cloudposse/terraform-aws-alb-ingress","owner":"cloudposse","description":"Terraform module to provision an HTTP style ingress rule based on hostname and path for an ALB using target groups","archived":false,"fork":false,"pushed_at":"2025-01-23T22:25:29.000Z","size":4511,"stargazers_count":31,"open_issues_count":3,"forks_count":53,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-03-30T12:07:33.912Z","etag":null,"topics":["alb","application-load-balancer","aws","ecs","hcl2","ingress","target-group","terraform","terraform-modules"],"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":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-08T07:22:02.000Z","updated_at":"2025-01-23T22:24:27.000Z","dependencies_parsed_at":"2023-11-15T04:23:17.416Z","dependency_job_id":"3f9df17b-1959-490f-bee7-0798b524a2b7","html_url":"https://github.com/cloudposse/terraform-aws-alb-ingress","commit_stats":null,"previous_names":[],"tags_count":50,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-alb-ingress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-alb-ingress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-alb-ingress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-alb-ingress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudposse","download_url":"https://codeload.github.com/cloudposse/terraform-aws-alb-ingress/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247485287,"owners_count":20946398,"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":["alb","application-load-balancer","aws","ecs","hcl2","ingress","target-group","terraform","terraform-modules"],"created_at":"2024-11-11T23:18:35.627Z","updated_at":"2025-04-06T13:11:21.769Z","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-alb-ingress/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-alb-ingress/releases/latest\"\u003e\u003cimg src=\"https://img.shields.io/github/release/cloudposse/terraform-aws-alb-ingress.svg?style=for-the-badge\" alt=\"Latest Release\"/\u003e\u003c/a\u003e\u003ca href=\"https://github.com/cloudposse/terraform-aws-alb-ingress/commits\"\u003e\u003cimg src=\"https://img.shields.io/github/last-commit/cloudposse/terraform-aws-alb-ingress.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\nTerraform module to provision an HTTP style ALB ingress based on hostname and/or path.\n\nALB ingress can be provisioned without authentication, or using Cognito or OIDC authentication.\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 test of the complete example using `bats` and `Terratest`, see [test](test).\n\n```hcl\nprovider \"aws\" {\n  region = var.region\n}\n\nmodule \"vpc\" {\n  source     = \"cloudposse/vpc/aws\"\n  # Cloud Posse recommends pinning every module to a specific version\n  # version     = \"x.x.x\"\n\n  namespace  = var.namespace\n  stage      = var.stage\n  name       = var.name\n  delimiter  = var.delimiter\n  attributes = var.attributes\n  cidr_block = var.vpc_cidr_block\n\n  tags       = var.tags\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  namespace            = var.namespace\n  stage                = var.stage\n  name                 = var.name\n  attributes           = var.attributes\n  delimiter            = var.delimiter\n  vpc_id               = module.vpc.vpc_id\n  igw_id               = module.vpc.igw_id\n  cidr_block           = module.vpc.vpc_cidr_block\n  nat_gateway_enabled  = false\n  nat_instance_enabled = false\n\n  tags = var.tags\n}\n\nmodule \"alb\" {\n  source = \"cloudposse/alb/aws\"\n  # Cloud Posse recommends pinning every module to a specific version\n  # version     = \"x.x.x\"\n\n  namespace                               = var.namespace\n  stage                                   = var.stage\n  name                                    = var.name\n  attributes                              = var.attributes\n  delimiter                               = var.delimiter\n  vpc_id                                  = module.vpc.vpc_id\n  security_group_ids                      = [module.vpc.vpc_default_security_group_id]\n  subnet_ids                              = module.subnets.public_subnet_ids\n  internal                                = var.internal\n  http_enabled                            = var.http_enabled\n  access_logs_enabled                     = var.access_logs_enabled\n  alb_access_logs_s3_bucket_force_destroy = var.alb_access_logs_s3_bucket_force_destroy\n  cross_zone_load_balancing_enabled       = var.cross_zone_load_balancing_enabled\n  http2_enabled                           = var.http2_enabled\n  idle_timeout                            = var.idle_timeout\n  ip_address_type                         = var.ip_address_type\n  deletion_protection_enabled             = var.deletion_protection_enabled\n  deregistration_delay                    = var.deregistration_delay\n  health_check_path                       = var.health_check_path\n  health_check_timeout                    = var.health_check_timeout\n  health_check_healthy_threshold          = var.health_check_healthy_threshold\n  health_check_unhealthy_threshold        = var.health_check_unhealthy_threshold\n  health_check_interval                   = var.health_check_interval\n  health_check_matcher                    = var.health_check_matcher\n  target_group_port                       = var.target_group_port\n  target_group_target_type                = var.target_group_target_type\n\n  tags = var.tags\n}\n\nmodule \"alb_ingress\" {\n  source = \"cloudposse/alb-ingress/aws\"\n  # Cloud Posse recommends pinning every module to a specific version\n  # version     = \"x.x.x\"\n\n  namespace                           = var.namespace\n  stage                               = var.stage\n  name                                = var.name\n  attributes                          = var.attributes\n  delimiter                           = var.delimiter\n  vpc_id                              = module.vpc.vpc_id\n  authentication_type                 = var.authentication_type\n  unauthenticated_priority            = var.unauthenticated_priority\n  unauthenticated_paths               = var.unauthenticated_paths\n  slow_start                          = var.slow_start\n  stickiness_enabled                  = var.stickiness_enabled\n  default_target_group_enabled        = false\n  target_group_arn                    = module.alb.default_target_group_arn\n  unauthenticated_listener_arns       = [module.alb.http_listener_arn]\n\n  tags = var.tags\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\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\n## Providers\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"provider_aws\"\u003e\u003c/a\u003e [aws](#provider\\_aws) | \u003e= 4.0 |\n\n## Modules\n\n| Name | Source | Version |\n|------|--------|---------|\n| \u003ca name=\"module_target_group\"\u003e\u003c/a\u003e [target\\_group](#module\\_target\\_group) | cloudposse/label/null | 0.25.0 |\n| \u003ca name=\"module_this\"\u003e\u003c/a\u003e [this](#module\\_this) | cloudposse/label/null | 0.25.0 |\n\n## Resources\n\n| Name | Type |\n|------|------|\n| [aws_lb_listener_rule.authenticated_hosts_cognito](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_rule) | resource |\n| [aws_lb_listener_rule.authenticated_hosts_oidc](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_rule) | resource |\n| [aws_lb_listener_rule.authenticated_hosts_paths_cognito](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_rule) | resource |\n| [aws_lb_listener_rule.authenticated_hosts_paths_oidc](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_rule) | resource |\n| [aws_lb_listener_rule.authenticated_paths_cognito](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_rule) | resource |\n| [aws_lb_listener_rule.authenticated_paths_oidc](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_rule) | resource |\n| [aws_lb_listener_rule.unauthenticated_hosts](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_rule) | resource |\n| [aws_lb_listener_rule.unauthenticated_hosts_paths](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_rule) | resource |\n| [aws_lb_listener_rule.unauthenticated_paths](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_rule) | resource |\n| [aws_lb_target_group.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_target_group) | resource |\n| [aws_lb_target_group.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/lb_target_group) | data source |\n\n## Inputs\n\n| Name | Description | Type | Default | Required |\n|------|-------------|------|---------|:--------:|\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_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_authenticated_hosts\"\u003e\u003c/a\u003e [authenticated\\_hosts](#input\\_authenticated\\_hosts) | Authenticated hosts to match in Hosts header | `list(string)` | `[]` | no |\n| \u003ca name=\"input_authenticated_listener_arns\"\u003e\u003c/a\u003e [authenticated\\_listener\\_arns](#input\\_authenticated\\_listener\\_arns) | A list of authenticated ALB listener ARNs to attach ALB listener rules to | `list(string)` | `[]` | no |\n| \u003ca name=\"input_authenticated_paths\"\u003e\u003c/a\u003e [authenticated\\_paths](#input\\_authenticated\\_paths) | Authenticated path pattern to match (a maximum of 1 can be defined) | `list(string)` | `[]` | no |\n| \u003ca name=\"input_authenticated_priority\"\u003e\u003c/a\u003e [authenticated\\_priority](#input\\_authenticated\\_priority) | The priority for the rules with authentication, between 1 and 50000 (1 being highest priority). Must be different from `unauthenticated_priority` since a listener can't have multiple rules with the same priority | `number` | `null` | no |\n| \u003ca name=\"input_authentication_cognito_on_unauthenticated_request\"\u003e\u003c/a\u003e [authentication\\_cognito\\_on\\_unauthenticated\\_request](#input\\_authentication\\_cognito\\_on\\_unauthenticated\\_request) | Cognito unauthenticated behavior, deny, allow, or authenticate | `string` | `\"authenticate\"` | no |\n| \u003ca name=\"input_authentication_cognito_request_extra_params\"\u003e\u003c/a\u003e [authentication\\_cognito\\_request\\_extra\\_params](#input\\_authentication\\_cognito\\_request\\_extra\\_params) | Cognito query parameters to include in redirect request | `map(string)` | `null` | no |\n| \u003ca name=\"input_authentication_cognito_scope\"\u003e\u003c/a\u003e [authentication\\_cognito\\_scope](#input\\_authentication\\_cognito\\_scope) | Cognito scope, which should be a space separated string of requested scopes (see https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims) | `string` | `null` | no |\n| \u003ca name=\"input_authentication_cognito_user_pool_arn\"\u003e\u003c/a\u003e [authentication\\_cognito\\_user\\_pool\\_arn](#input\\_authentication\\_cognito\\_user\\_pool\\_arn) | Cognito User Pool ARN | `string` | `\"\"` | no |\n| \u003ca name=\"input_authentication_cognito_user_pool_client_id\"\u003e\u003c/a\u003e [authentication\\_cognito\\_user\\_pool\\_client\\_id](#input\\_authentication\\_cognito\\_user\\_pool\\_client\\_id) | Cognito User Pool Client ID | `string` | `\"\"` | no |\n| \u003ca name=\"input_authentication_cognito_user_pool_domain\"\u003e\u003c/a\u003e [authentication\\_cognito\\_user\\_pool\\_domain](#input\\_authentication\\_cognito\\_user\\_pool\\_domain) | Cognito User Pool Domain. The User Pool Domain should be set to the domain prefix (`xxx`) instead of full domain (https://xxx.auth.us-west-2.amazoncognito.com) | `string` | `\"\"` | no |\n| \u003ca name=\"input_authentication_oidc_authorization_endpoint\"\u003e\u003c/a\u003e [authentication\\_oidc\\_authorization\\_endpoint](#input\\_authentication\\_oidc\\_authorization\\_endpoint) | OIDC Authorization Endpoint | `string` | `\"\"` | no |\n| \u003ca name=\"input_authentication_oidc_client_id\"\u003e\u003c/a\u003e [authentication\\_oidc\\_client\\_id](#input\\_authentication\\_oidc\\_client\\_id) | OIDC Client ID | `string` | `\"\"` | no |\n| \u003ca name=\"input_authentication_oidc_client_secret\"\u003e\u003c/a\u003e [authentication\\_oidc\\_client\\_secret](#input\\_authentication\\_oidc\\_client\\_secret) | OIDC Client Secret | `string` | `\"\"` | no |\n| \u003ca name=\"input_authentication_oidc_issuer\"\u003e\u003c/a\u003e [authentication\\_oidc\\_issuer](#input\\_authentication\\_oidc\\_issuer) | OIDC Issuer | `string` | `\"\"` | no |\n| \u003ca name=\"input_authentication_oidc_on_unauthenticated_request\"\u003e\u003c/a\u003e [authentication\\_oidc\\_on\\_unauthenticated\\_request](#input\\_authentication\\_oidc\\_on\\_unauthenticated\\_request) | OIDC unauthenticated behavior, deny, allow, or authenticate | `string` | `\"authenticate\"` | no |\n| \u003ca name=\"input_authentication_oidc_request_extra_params\"\u003e\u003c/a\u003e [authentication\\_oidc\\_request\\_extra\\_params](#input\\_authentication\\_oidc\\_request\\_extra\\_params) | OIDC query parameters to include in redirect request | `map(string)` | `null` | no |\n| \u003ca name=\"input_authentication_oidc_scope\"\u003e\u003c/a\u003e [authentication\\_oidc\\_scope](#input\\_authentication\\_oidc\\_scope) | OIDC scope, which should be a space separated string of requested scopes (see https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims, and https://developers.google.com/identity/protocols/oauth2/openid-connect#scope-param for an example set of scopes when using Google as the IdP) | `string` | `null` | no |\n| \u003ca name=\"input_authentication_oidc_token_endpoint\"\u003e\u003c/a\u003e [authentication\\_oidc\\_token\\_endpoint](#input\\_authentication\\_oidc\\_token\\_endpoint) | OIDC Token Endpoint | `string` | `\"\"` | no |\n| \u003ca name=\"input_authentication_oidc_user_info_endpoint\"\u003e\u003c/a\u003e [authentication\\_oidc\\_user\\_info\\_endpoint](#input\\_authentication\\_oidc\\_user\\_info\\_endpoint) | OIDC User Info Endpoint | `string` | `\"\"` | no |\n| \u003ca name=\"input_authentication_type\"\u003e\u003c/a\u003e [authentication\\_type](#input\\_authentication\\_type) | Authentication type. Supported values are `COGNITO` and `OIDC` | `string` | `\"\"` | 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_default_target_group_enabled\"\u003e\u003c/a\u003e [default\\_target\\_group\\_enabled](#input\\_default\\_target\\_group\\_enabled) | Enable/disable creation of the default target group | `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_deregistration_delay\"\u003e\u003c/a\u003e [deregistration\\_delay](#input\\_deregistration\\_delay) | The amount of time to wait in seconds while deregistering target | `number` | `15` | 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_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_health_check_enabled\"\u003e\u003c/a\u003e [health\\_check\\_enabled](#input\\_health\\_check\\_enabled) | Indicates whether health checks are enabled. Defaults to `true` | `bool` | `true` | no |\n| \u003ca name=\"input_health_check_healthy_threshold\"\u003e\u003c/a\u003e [health\\_check\\_healthy\\_threshold](#input\\_health\\_check\\_healthy\\_threshold) | The number of consecutive health checks successes required before healthy | `number` | `2` | no |\n| \u003ca name=\"input_health_check_interval\"\u003e\u003c/a\u003e [health\\_check\\_interval](#input\\_health\\_check\\_interval) | The duration in seconds in between health checks | `number` | `15` | no |\n| \u003ca name=\"input_health_check_matcher\"\u003e\u003c/a\u003e [health\\_check\\_matcher](#input\\_health\\_check\\_matcher) | The HTTP response codes to indicate a healthy check | `string` | `\"200-399\"` | no |\n| \u003ca name=\"input_health_check_path\"\u003e\u003c/a\u003e [health\\_check\\_path](#input\\_health\\_check\\_path) | The destination for the health check request | `string` | `\"/\"` | no |\n| \u003ca name=\"input_health_check_port\"\u003e\u003c/a\u003e [health\\_check\\_port](#input\\_health\\_check\\_port) | The port to use to connect with the target. Valid values are either ports 1-65536, or `traffic-port`. Defaults to `traffic-port` | `string` | `\"traffic-port\"` | no |\n| \u003ca name=\"input_health_check_protocol\"\u003e\u003c/a\u003e [health\\_check\\_protocol](#input\\_health\\_check\\_protocol) | The protocol to use to connect with the target. Defaults to `HTTP`. Not applicable when `target_type` is `lambda` | `string` | `\"HTTP\"` | no |\n| \u003ca name=\"input_health_check_timeout\"\u003e\u003c/a\u003e [health\\_check\\_timeout](#input\\_health\\_check\\_timeout) | The amount of time to wait in seconds before failing a health check request | `number` | `10` | no |\n| \u003ca name=\"input_health_check_unhealthy_threshold\"\u003e\u003c/a\u003e [health\\_check\\_unhealthy\\_threshold](#input\\_health\\_check\\_unhealthy\\_threshold) | The number of consecutive health check failures required before unhealthy | `number` | `2` | 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_listener_http_header_conditions\"\u003e\u003c/a\u003e [listener\\_http\\_header\\_conditions](#input\\_listener\\_http\\_header\\_conditions) | A list of http header conditions to apply to the listener. | \u003cpre\u003elist(object({\u003cbr/\u003e    name  = string\u003cbr/\u003e    value = list(string)\u003cbr/\u003e  }))\u003c/pre\u003e | `[]` | no |\n| \u003ca name=\"input_load_balancing_algorithm_type\"\u003e\u003c/a\u003e [load\\_balancing\\_algorithm\\_type](#input\\_load\\_balancing\\_algorithm\\_type) | Determines how the load balancer selects targets when routing requests. Only applicable for Application Load Balancer Target Groups. The value is round\\_robin, least\\_outstanding\\_requests or weighted\\_random. The default is round\\_robin. | `string` | `\"round_robin\"` | no |\n| \u003ca name=\"input_load_balancing_anomaly_mitigation\"\u003e\u003c/a\u003e [load\\_balancing\\_anomaly\\_mitigation](#input\\_load\\_balancing\\_anomaly\\_mitigation) | Determines whether to enable target anomaly mitigation. Only supported by the weighted\\_random load balancing algorithm type. Valid values are 'on' or 'off'. | `string` | `\"off\"` | no |\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_port\"\u003e\u003c/a\u003e [port](#input\\_port) | The port for the created ALB target group (if `target_group_arn` is not set) | `number` | `80` | no |\n| \u003ca name=\"input_protocol\"\u003e\u003c/a\u003e [protocol](#input\\_protocol) | The protocol for the created ALB target group (if `target_group_arn` is not set) | `string` | `\"HTTP\"` | no |\n| \u003ca name=\"input_protocol_version\"\u003e\u003c/a\u003e [protocol\\_version](#input\\_protocol\\_version) | Only applicable when protocol is `HTTP` or `HTTPS`. The protocol version. Specify GRPC to send requests to targets using gRPC. Specify HTTP2 to send requests to targets using HTTP/2. The default is `HTTP1`, which sends requests to targets using HTTP/1.1 | `string` | `\"HTTP1\"` | no |\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_slow_start\"\u003e\u003c/a\u003e [slow\\_start](#input\\_slow\\_start) | The amount of time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is `0` seconds | `number` | `0` | 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_stickiness_cookie_duration\"\u003e\u003c/a\u003e [stickiness\\_cookie\\_duration](#input\\_stickiness\\_cookie\\_duration) | The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds) | `number` | `86400` | no |\n| \u003ca name=\"input_stickiness_cookie_name\"\u003e\u003c/a\u003e [stickiness\\_cookie\\_name](#input\\_stickiness\\_cookie\\_name) | Name of the application based cookie. AWSALB, AWSALBAPP, and AWSALBTG prefixes are reserved and cannot be used. Only needed when `stickiness_type` is app\\_cookie | `string` | `null` | no |\n| \u003ca name=\"input_stickiness_enabled\"\u003e\u003c/a\u003e [stickiness\\_enabled](#input\\_stickiness\\_enabled) | Boolean to enable / disable `stickiness`. Default is `true` | `bool` | `true` | no |\n| \u003ca name=\"input_stickiness_type\"\u003e\u003c/a\u003e [stickiness\\_type](#input\\_stickiness\\_type) | The type of sticky sessions. The possible values are `lb_cookie` or `app_cookie` | `string` | `\"lb_cookie\"` | 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_target_group_arn\"\u003e\u003c/a\u003e [target\\_group\\_arn](#input\\_target\\_group\\_arn) | Existing ALB target group ARN. If provided, set `default_target_group_enabled` to `false` to disable creation of the default target group | `string` | `\"\"` | no |\n| \u003ca name=\"input_target_group_name\"\u003e\u003c/a\u003e [target\\_group\\_name](#input\\_target\\_group\\_name) | Override the target group name | `string` | `\"\"` | no |\n| \u003ca name=\"input_target_type\"\u003e\u003c/a\u003e [target\\_type](#input\\_target\\_type) | The type (`instance`, `ip` or `lambda`) of targets that can be registered with the target group | `string` | `\"ip\"` | 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_unauthenticated_hosts\"\u003e\u003c/a\u003e [unauthenticated\\_hosts](#input\\_unauthenticated\\_hosts) | Unauthenticated hosts to match in Hosts header | `list(string)` | `[]` | no |\n| \u003ca name=\"input_unauthenticated_listener_arns\"\u003e\u003c/a\u003e [unauthenticated\\_listener\\_arns](#input\\_unauthenticated\\_listener\\_arns) | A list of unauthenticated ALB listener ARNs to attach ALB listener rules to | `list(string)` | `[]` | no |\n| \u003ca name=\"input_unauthenticated_paths\"\u003e\u003c/a\u003e [unauthenticated\\_paths](#input\\_unauthenticated\\_paths) | Unauthenticated path pattern to match (a maximum of 1 can be defined) | `list(string)` | `[]` | no |\n| \u003ca name=\"input_unauthenticated_priority\"\u003e\u003c/a\u003e [unauthenticated\\_priority](#input\\_unauthenticated\\_priority) | The priority for the rules without authentication, between 1 and 50000 (1 being highest priority). Must be different from `authenticated_priority` since a listener can't have multiple rules with the same priority | `number` | `null` | no |\n| \u003ca name=\"input_vpc_id\"\u003e\u003c/a\u003e [vpc\\_id](#input\\_vpc\\_id) | The VPC ID where generated ALB target group will be provisioned (if `target_group_arn` is not set) | `string` | n/a | yes |\n\n## Outputs\n\n| Name | Description |\n|------|-------------|\n| \u003ca name=\"output_target_group_arn\"\u003e\u003c/a\u003e [target\\_group\\_arn](#output\\_target\\_group\\_arn) | ALB Target Group ARN |\n| \u003ca name=\"output_target_group_arn_suffix\"\u003e\u003c/a\u003e [target\\_group\\_arn\\_suffix](#output\\_target\\_group\\_arn\\_suffix) | ALB Target Group ARN suffix |\n| \u003ca name=\"output_target_group_name\"\u003e\u003c/a\u003e [target\\_group\\_name](#output\\_target\\_group\\_name) | ALB Target Group name |\n\u003c!-- markdownlint-restore --\u003e\n\n\n## Related Projects\n\nCheck out these related projects.\n\n- [terraform-aws-alb](https://github.com/cloudposse/terraform-aws-alb) - Terraform module to create an ALB, default ALB listener(s), and a default ALB target and related security groups.\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-alb-ingress\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-alb-ingress\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-alb-ingress\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-alb-ingress\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-alb-ingress/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=cloudposse/terraform-aws-alb-ingress\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-alb-ingress/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-alb-ingress/?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-alb-ingress\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-alb-ingress\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-alb-ingress\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-alb-ingress\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---\nCopyright © 2017-2025 [Cloud Posse, LLC](https://cpco.io/copyright)\n\n\n\u003ca href=\"https://cloudposse.com/readme/footer/link?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-alb-ingress\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-alb-ingress?pixel\u0026cs=github\u0026cm=readme\u0026an=terraform-aws-alb-ingress\"/\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudposse%2Fterraform-aws-alb-ingress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudposse%2Fterraform-aws-alb-ingress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudposse%2Fterraform-aws-alb-ingress/lists"}