Awesome

This component is responsible for provisioning a generic Application Load Balancer. It depends on the vpc and dns-delegated components.

Usage

Stack Level: Regional

Here's an example snippet for how to use this component.

components:
  terraform:
    alb:
      vars:
        https_ssl_policy: ELBSecurityPolicy-FS-1-2-Res-2020-10
        health_check_path: /api/healthz

Requirements

Name	Version
<a name="requirement_terraform"></a> terraform	>= 1.0.0
<a name="requirement_aws"></a> aws	>= 4.0
<a name="requirement_local"></a> local	>= 2.1

Providers

No providers.

Modules

Name	Source	Version
<a name="module_acm"></a> acm	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
<a name="module_alb"></a> alb	cloudposse/alb/aws	1.11.1
<a name="module_dns_delegated"></a> dns_delegated	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
<a name="module_iam_roles"></a> iam_roles	../account-map/modules/iam-roles	n/a
<a name="module_this"></a> this	cloudposse/label/null	0.25.0
<a name="module_vpc"></a> vpc	cloudposse/stack-config/yaml//modules/remote-state	1.5.0

Resources

No resources.

Inputs

Name	Description	Type	Default	Required
<a name="input_access_logs_enabled"></a> access_logs_enabled	A boolean flag to enable/disable access_logs	`bool`	`true`	no
<a name="input_access_logs_prefix"></a> access_logs_prefix	The S3 log bucket prefix	`string`	`""`	no
<a name="input_access_logs_s3_bucket_id"></a> access_logs_s3_bucket_id	An external S3 Bucket name to store access logs in. If specified, no logging bucket will be created.	`string`	`null`	no
<a name="input_acm_component_name"></a> acm_component_name	Atmos `acm` component name	`string`	`"acm"`	no
<a name="input_additional_tag_map"></a> additional_tag_map	Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br/>This is for some rare cases where resources want additional configuration of tags<br/>and therefore take a list of maps with tag key, value, and additional configuration.	`map(string)`	`{}`	no
<a name="input_alb_access_logs_s3_bucket_force_destroy"></a> alb_access_logs_s3_bucket_force_destroy	A boolean that indicates all objects should be deleted from the ALB access logs S3 bucket so that the bucket can be destroyed without error	`bool`	`false`	no
<a name="input_attributes"></a> attributes	ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br/>in the order they appear in the list. New attributes are appended to the<br/>end of the list. The elements of the list are joined by the `delimiter`<br/>and treated as a single ID element.	`list(string)`	`[]`	no
<a name="input_context"></a> context	Single object for setting entire context at once.<br/>See description of individual variables for details.<br/>Leave string and numeric variables as `null` to use default value.<br/>Individual variable settings (non-null) override settings in context object,<br/>except for attributes, tags, and additional_tag_map, which are merged.	`any`	<pre>{<br/> "additional_tag_map": {},<br/> "attributes": [],<br/> "delimiter": null,<br/> "descriptor_formats": {},<br/> "enabled": true,<br/> "environment": null,<br/> "id_length_limit": null,<br/> "label_key_case": null,<br/> "label_order": [],<br/> "label_value_case": null,<br/> "labels_as_tags": [<br/> "unset"<br/> ],<br/> "name": null,<br/> "namespace": null,<br/> "regex_replace_chars": null,<br/> "stage": null,<br/> "tags": {},<br/> "tenant": null<br/>}</pre>	no
<a name="input_cross_zone_load_balancing_enabled"></a> cross_zone_load_balancing_enabled	A boolean flag to enable/disable cross zone load balancing	`bool`	`true`	no
<a name="input_deletion_protection_enabled"></a> deletion_protection_enabled	A boolean flag to enable/disable deletion protection for ALB	`bool`	`false`	no
<a name="input_delimiter"></a> delimiter	Delimiter to be used between ID elements.<br/>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
<a name="input_deregistration_delay"></a> deregistration_delay	The amount of time to wait in seconds before changing the state of a deregistering target to unused	`number`	`15`	no
<a name="input_descriptor_formats"></a> descriptor_formats	Describe additional descriptors to be output in the `descriptors` output map.<br/>Map of maps. Keys are names of descriptors. Values are maps of the form<br/>`{<br/> format = string<br/> labels = list(string)<br/>}`<br/>(Type is `any` so the map values can later be enhanced to provide additional options.)<br/>`format` is a Terraform format string to be passed to the `format()` function.<br/>`labels` is a list of labels, in order, to pass to `format()` function.<br/>Label values will be normalized before being passed to `format()` so they will be<br/>identical to how they appear in `id`.<br/>Default is `{}` (`descriptors` output will be empty).	`any`	`{}`	no
<a name="input_dns_acm_enabled"></a> dns_acm_enabled	If `true`, use the ACM ARN created by the given `dns-delegated` component. Otherwise, use the ACM ARN created by the given `acm` component.	`bool`	`false`	no
<a name="input_dns_delegated_component_name"></a> dns_delegated_component_name	Atmos `dns-delegated` component name	`string`	`"dns-delegated"`	no
<a name="input_dns_delegated_environment_name"></a> dns_delegated_environment_name	`dns-delegated` component environment name	`string`	`null`	no
<a name="input_enabled"></a> enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
<a name="input_environment"></a> environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
<a name="input_health_check_healthy_threshold"></a> health_check_healthy_threshold	The number of consecutive health checks successes required before considering an unhealthy target healthy	`number`	`2`	no
<a name="input_health_check_interval"></a> health_check_interval	The duration in seconds in between health checks	`number`	`15`	no
<a name="input_health_check_matcher"></a> health_check_matcher	The HTTP response codes to indicate a healthy check	`string`	`"200-399"`	no
<a name="input_health_check_path"></a> health_check_path	The destination for the health check request	`string`	`"/"`	no
<a name="input_health_check_port"></a> health_check_port	The port to use for the healthcheck	`string`	`"traffic-port"`	no
<a name="input_health_check_timeout"></a> health_check_timeout	The amount of time to wait in seconds before failing a health check request	`number`	`10`	no
<a name="input_health_check_unhealthy_threshold"></a> health_check_unhealthy_threshold	The number of consecutive health check failures required before considering the target unhealthy	`number`	`2`	no
<a name="input_http2_enabled"></a> http2_enabled	A boolean flag to enable/disable HTTP/2	`bool`	`true`	no
<a name="input_http_enabled"></a> http_enabled	A boolean flag to enable/disable HTTP listener	`bool`	`true`	no
<a name="input_http_ingress_cidr_blocks"></a> http_ingress_cidr_blocks	List of CIDR blocks to allow in HTTP security group	`list(string)`	<pre>[<br/> "0.0.0.0/0"<br/>]</pre>	no
<a name="input_http_ingress_prefix_list_ids"></a> http_ingress_prefix_list_ids	List of prefix list IDs for allowing access to HTTP ingress security group	`list(string)`	`[]`	no
<a name="input_http_port"></a> http_port	The port for the HTTP listener	`number`	`80`	no
<a name="input_http_redirect"></a> http_redirect	A boolean flag to enable/disable HTTP redirect to HTTPS	`bool`	`true`	no
<a name="input_https_enabled"></a> https_enabled	A boolean flag to enable/disable HTTPS listener	`bool`	`true`	no
<a name="input_https_ingress_cidr_blocks"></a> https_ingress_cidr_blocks	List of CIDR blocks to allow in HTTPS security group	`list(string)`	<pre>[<br/> "0.0.0.0/0"<br/>]</pre>	no
<a name="input_https_ingress_prefix_list_ids"></a> https_ingress_prefix_list_ids	List of prefix list IDs for allowing access to HTTPS ingress security group	`list(string)`	`[]`	no
<a name="input_https_port"></a> https_port	The port for the HTTPS listener	`number`	`443`	no
<a name="input_https_ssl_policy"></a> https_ssl_policy	The name of the SSL Policy for the listener	`string`	`"ELBSecurityPolicy-TLS13-1-2-2021-06"`	no
<a name="input_id_length_limit"></a> id_length_limit	Limit `id` to this many characters (minimum 6).<br/>Set to `0` for unlimited length.<br/>Set to `null` for keep the existing setting, which defaults to `0`.<br/>Does not affect `id_full`.	`number`	`null`	no
<a name="input_idle_timeout"></a> idle_timeout	The time in seconds that the connection is allowed to be idle	`number`	`60`	no
<a name="input_internal"></a> internal	A boolean flag to determine whether the ALB should be internal	`bool`	`false`	no
<a name="input_ip_address_type"></a> ip_address_type	The type of IP addresses used by the subnets for your load balancer. The possible values are `ipv4` and `dualstack`.	`string`	`"ipv4"`	no
<a name="input_label_key_case"></a> label_key_case	Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper`.<br/>Default value: `title`.	`string`	`null`	no
<a name="input_label_order"></a> label_order	The order in which the labels (ID elements) appear in the `id`.<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	`list(string)`	`null`	no
<a name="input_label_value_case"></a> label_value_case	Controls the letter case of ID elements (labels) as included in `id`,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br/>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br/>Default value: `lower`.	`string`	`null`	no
<a name="input_labels_as_tags"></a> labels_as_tags	Set of labels (ID elements) to include as tags in the `tags` output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the `tags` output.<br/>Set to `[]` to suppress all generated tags.<br/>Notes:<br/> The value of the `name` tag, if included, will be the `id`, not the `name`.<br/> Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored.	`set(string)`	<pre>[<br/> "default"<br/>]</pre>	no
<a name="input_lifecycle_rule_enabled"></a> lifecycle_rule_enabled	A boolean that indicates whether the s3 log bucket lifecycle rule should be enabled.	`bool`	`true`	no
<a name="input_name"></a> name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a `tag`.<br/>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.	`string`	`null`	no
<a name="input_namespace"></a> 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
<a name="input_regex_replace_chars"></a> regex_replace_chars	Terraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.	`string`	`null`	no
<a name="input_region"></a> region	AWS Region	`string`	n/a	yes
<a name="input_stage"></a> stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
<a name="input_stickiness"></a> stickiness	Target group sticky configuration	<pre>object({<br/> cookie_duration = number<br/> enabled = bool<br/> })</pre>	`null`	no
<a name="input_tags"></a> tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br/>Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
<a name="input_target_group_name"></a> target_group_name	The name for the default target group, uses a module label name if left empty	`string`	`""`	no
<a name="input_target_group_port"></a> target_group_port	The port for the default target group	`number`	`80`	no
<a name="input_target_group_protocol"></a> target_group_protocol	The protocol for the default target group HTTP or HTTPS	`string`	`"HTTP"`	no
<a name="input_target_group_target_type"></a> target_group_target_type	The type (`instance`, `ip` or `lambda`) of targets that can be registered with the target group	`string`	`"ip"`	no
<a name="input_tenant"></a> tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no
<a name="input_vpc_component_name"></a> vpc_component_name	Atmos `vpc` component name	`string`	`"vpc"`	no

Outputs

Name	Description
<a name="output_access_logs_bucket_id"></a> access_logs_bucket_id	The S3 bucket ID for access logs
<a name="output_alb_arn"></a> alb_arn	The ARN of the ALB
<a name="output_alb_arn_suffix"></a> alb_arn_suffix	The ARN suffix of the ALB
<a name="output_alb_dns_name"></a> alb_dns_name	DNS name of ALB
<a name="output_alb_name"></a> alb_name	The ARN suffix of the ALB
<a name="output_alb_zone_id"></a> alb_zone_id	The ID of the zone which ALB is provisioned
<a name="output_default_target_group_arn"></a> default_target_group_arn	The default target group ARN
<a name="output_http_listener_arn"></a> http_listener_arn	The ARN of the HTTP forwarding listener
<a name="output_http_redirect_listener_arn"></a> http_redirect_listener_arn	The ARN of the HTTP to HTTPS redirect listener
<a name="output_https_listener_arn"></a> https_listener_arn	The ARN of the HTTPS listener
<a name="output_listener_arns"></a> listener_arns	A list of all the listener ARNs
<a name="output_security_group_id"></a> security_group_id	The security group ID of the ALB

References

cloudposse/terraform-aws-components - Cloud Posse's upstream component

[!TIP]

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. Works with Github Actions, Atlantis, or Spacelift.
<details> <summary>Watch demo of using Atmos with Terraform</summary> <img src="https://github.com/cloudposse/atmos/blob/main/docs/demo.gif?raw=true"/> Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial. </detalis>

Related Projects

Check out these related projects.

Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
Atmos - Atmos is like docker-compose but for your infrastructure

[!TIP]

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team. ✅ Your team owns everything. ✅ 100% Open Source and backed by fanatical support. 

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-alb&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
<details><summary>📚 Learn More</summary> 
Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.

Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.

Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.

Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.

GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-alb&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

Day-2: Your Operational Mastery

Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.

Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.

Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.

Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.

Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.

Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.

Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-alb&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
</details>

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community 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.

📰 Newsletter

Sign up for our 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. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-alb&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

<details> <summary>Preamble to the Apache License, Version 2.0</summary>

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

</details>

Trademarks

All other trademarks referenced herein are the property of their respective owners.