Terraform module to create an ALB, default ALB listener(s), and a default ALB target and related security groups.

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform

Example of running atmos to manage infrastructure from our Quick Start tutorial.

Usage

For a complete example, see examples/complete.

For automated test of the complete example using bats and Terratest, see test.

provider "aws" {
  region = var.region
}

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

  namespace  = var.namespace
  stage      = var.stage
  name       = var.name
  delimiter  = var.delimiter
  attributes = var.attributes

  ipv4_primary_cidr_block = "10.0.0.0/16"
  assign_generated_ipv6_cidr_block = true

  tags = var.tags
}

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

  namespace  = var.namespace
  stage      = var.stage
  name       = var.name
  attributes = var.attributes
  delimiter  = var.delimiter

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

  tags = var.tags
}

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

  namespace  = var.namespace
  stage      = var.stage
  name       = var.name
  attributes = var.attributes
  delimiter  = var.delimiter

  vpc_id                                  = module.vpc.vpc_id
  security_group_ids                      = [module.vpc.vpc_default_security_group_id]
  subnet_ids                              = module.subnets.public_subnet_ids
  internal                                = var.internal
  http_enabled                            = var.http_enabled
  http_redirect                           = var.http_redirect
  access_logs_enabled                     = var.access_logs_enabled
  cross_zone_load_balancing_enabled       = var.cross_zone_load_balancing_enabled
  http2_enabled                           = var.http2_enabled
  idle_timeout                            = var.idle_timeout
  ip_address_type                         = var.ip_address_type
  deletion_protection_enabled             = var.deletion_protection_enabled
  deregistration_delay                    = var.deregistration_delay
  health_check_path                       = var.health_check_path
  health_check_timeout                    = var.health_check_timeout
  health_check_healthy_threshold          = var.health_check_healthy_threshold
  health_check_unhealthy_threshold        = var.health_check_unhealthy_threshold
  health_check_interval                   = var.health_check_interval
  health_check_matcher                    = var.health_check_matcher
  target_group_port                       = var.target_group_port
  target_group_target_type                = var.target_group_target_type
  stickiness                              = var.stickiness

  alb_access_logs_s3_bucket_force_destroy         = var.alb_access_logs_s3_bucket_force_destroy
  alb_access_logs_s3_bucket_force_destroy_enabled = var.alb_access_logs_s3_bucket_force_destroy_enabled

  tags = var.tags
}

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

Name	Version
terraform	>= 1.3
aws	>= 5.46

Providers

Name	Version
aws	>= 5.46

Modules

Name	Source	Version
access_logs	cloudposse/lb-s3-bucket/aws	0.19.0
default_load_balancer_label	cloudposse/label/null	0.25.0
default_target_group_label	cloudposse/label/null	0.25.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_lb.default	resource
aws_lb_listener.http_forward	resource
aws_lb_listener.http_redirect	resource
aws_lb_listener.https	resource
aws_lb_listener_certificate.https_sni	resource
aws_lb_target_group.default	resource
aws_security_group.default	resource
aws_security_group_rule.egress	resource
aws_security_group_rule.http_ingress	resource
aws_security_group_rule.https_ingress	resource

Inputs

Name	Description	Type	Default	Required
access_logs_enabled	A boolean flag to enable/disable access_logs	bool	true	no
access_logs_prefix	The S3 log bucket prefix	string	""	no
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
additional_certs	A list of additonal certs to add to the https listerner	list(string)	[]	no
additional_tag_map	Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id. This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration.	map(string)	{}	no
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
allow_ssl_requests_only	Set to true to require requests to use Secure Socket Layer (HTTPS/SSL) on the access logs S3 bucket. This will explicitly deny access to HTTP requests	bool	false	no
attributes	ID element. Additional attributes (e.g. workers or cluster) to add to id, in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element.	list(string)	[]	no
certificate_arn	The ARN of the default SSL certificate for HTTPS listener	string	""	no
client_keep_alive	Client keep alive value in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds.	number	3600	no
context	Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value. Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged.	any	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "descriptor_formats": {}, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "labels_as_tags": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
cross_zone_load_balancing_enabled	A boolean flag to enable/disable cross zone load balancing	bool	true	no
default_target_group_enabled	Whether the default target group should be created or not.	bool	true	no
deletion_protection_enabled	A boolean flag to enable/disable deletion protection for ALB	bool	false	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
deregistration_delay	The amount of time to wait in seconds before changing the state of a deregistering target to unused	number	15	no
descriptor_formats	Describe additional descriptors to be output in the descriptors output map. Map of maps. Keys are names of descriptors. Values are maps of the form {<br/> format = string<br/> labels = list(string)<br/>} (Type is any so the map values can later be enhanced to provide additional options.) format is a Terraform format string to be passed to the format() function. labels is a list of labels, in order, to pass to format() function. Label values will be normalized before being passed to format() so they will be identical to how they appear in id. Default is {} (descriptors output will be empty).	any	{}	no
drop_invalid_header_fields	Indicates whether HTTP headers with header fields that are not valid are removed by the load balancer (true) or routed to targets (false).	bool	false	no
enable_glacier_transition	(Deprecated, use lifecycle_configuration_rules instead) Enables the transition to AWS Glacier which can cause unnecessary costs for huge amount of small files	bool	true	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
expiration_days	(Deprecated, use lifecycle_configuration_rules instead) Number of days after which to expunge the objects	number	90	no
glacier_transition_days	(Deprecated, use lifecycle_configuration_rules instead) Number of days after which to move the data to the Glacier Flexible Retrieval storage tier	number	60	no
health_check_healthy_threshold	The number of consecutive health checks successes required before considering an unhealthy target healthy	number	2	no
health_check_interval	The duration in seconds in between health checks	number	15	no
health_check_matcher	The HTTP response codes to indicate a healthy check	string	"200-399"	no
health_check_path	The destination for the health check request	string	"/"	no
health_check_port	The port to use for the healthcheck	string	"traffic-port"	no
health_check_protocol	The protocol to use for the healthcheck. If not specified, same as the traffic protocol	string	null	no
health_check_timeout	The amount of time to wait in seconds before failing a health check request	number	10	no
health_check_unhealthy_threshold	The number of consecutive health check failures required before considering the target unhealthy	number	2	no
http2_enabled	A boolean flag to enable/disable HTTP/2	bool	true	no
http_enabled	A boolean flag to enable/disable HTTP listener	bool	true	no
http_ingress_cidr_blocks	List of CIDR blocks to allow in HTTP security group	list(string)	[ "0.0.0.0/0", "::/0" ]	no
http_ingress_prefix_list_ids	List of prefix list IDs for allowing access to HTTP ingress security group	list(string)	[]	no
http_port	The port for the HTTP listener	number	80	no
http_redirect	A boolean flag to enable/disable HTTP redirect to HTTPS	bool	false	no
https_enabled	A boolean flag to enable/disable HTTPS listener	bool	false	no
https_ingress_cidr_blocks	List of CIDR blocks to allow in HTTPS security group	list(string)	[ "0.0.0.0/0", "::/0" ]	no
https_ingress_prefix_list_ids	List of prefix list IDs for allowing access to HTTPS ingress security group	list(string)	[]	no
https_port	The port for the HTTPS listener	number	443	no
https_ssl_policy	The name of the SSL Policy for the listener	string	"ELBSecurityPolicy-TLS13-1-2-2021-06"	no
id_length_limit	Limit id to this many characters (minimum 6). Set to 0 for unlimited length. Set to null for keep the existing setting, which defaults to 0. Does not affect id_full.	number	null	no
idle_timeout	The time in seconds that the connection is allowed to be idle	number	60	no
internal	A boolean flag to determine whether the ALB should be internal	bool	false	no
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
label_key_case	Controls the letter case of the tags keys (label names) for tags generated by this module. Does not affect keys of tags passed in via the tags input. Possible values: lower, title, upper. Default value: title.	string	null	no
label_order	The order in which the labels (ID elements) appear in the id. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	list(string)	null	no
label_value_case	Controls the letter case of ID elements (labels) as included in id, set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input. Possible values: lower, title, upper and none (no transformation). Set this to title and set delimiter to "" to yield Pascal Case IDs. Default value: lower.	string	null	no
labels_as_tags	Set of labels (ID elements) to include as tags in the tags output. Default is to include all labels. Tags with empty values will not be included in the tags output. Set to [] to suppress all generated tags. Notes: The value of the name tag, if included, will be the id, not the name. Unlike other null-label inputs, the initial setting of labels_as_tags cannot be changed in later chained modules. Attempts to change it will be silently ignored.	set(string)	[ "default" ]	no
lifecycle_configuration_rules	A list of S3 bucket v2 lifecycle rules, as specified in terraform-aws-s3-bucket" These rules are not affected by the deprecated lifecycle_rule_enabled flag. NOTE: Unless you also set lifecycle_rule_enabled = false you will also get the default deprecated rules set on your bucket.	list(object({ enabled = bool id = string abort_incomplete_multipart_upload_days = number # filter_and is the and configuration block inside the filter configuration. # This is the only place you should specify a prefix. filter_and = any expiration = any transition = list(any) noncurrent_version_expiration = any noncurrent_version_transition = list(any) }))	[]	no
lifecycle_rule_enabled	DEPRECATED: Defaults to false, use lifecycle_configuration_rules instead. When true, configures lifecycle events on this bucket using individual (now deprecated) variables."	bool	false	no
listener_additional_tags	The additional tags to apply to all listeners	map(string)	{}	no
listener_http_fixed_response	Have the HTTP listener return a fixed response for the default action.	object({ content_type = string message_body = string status_code = string })	null	no
listener_https_fixed_response	Have the HTTPS listener return a fixed response for the default action.	object({ content_type = string message_body = string status_code = string })	null	no
listener_https_redirect	Have the HTTPS listener return a redirect response for the default action.	object({ host = optional(string) path = optional(string) port = optional(string) protocol = optional(string) query = optional(string) status_code = string })	null	no
load_balancer_name	The name for the default load balancer, uses a module label name if left empty	string	""	no
load_balancer_name_max_length	The max length of characters for the load balancer.	number	32	no
load_balancing_algorithm_type	Determines how the load balancer selects targets when routing requests. Only applicable for Application Load Balancer Target Groups	string	"round_robin"	no
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
name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag. The "name" tag is set to the full id string. There is no tag with the value of the name input.	string	null	no
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
noncurrent_version_expiration_days	(Deprecated, use lifecycle_configuration_rules instead) Specifies when non-current object versions expire (in days)	number	90	no
noncurrent_version_transition_days	(Deprecated, use lifecycle_configuration_rules instead) Specifies (in days) when noncurrent object versions transition to Glacier Flexible Retrieval	number	30	no
preserve_host_header	Indicates whether the Application Load Balancer should preserve the Host header in the HTTP request and send it to the target without any change.	bool	false	no
regex_replace_chars	Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.	string	null	no
security_group_enabled	Enables the security group	bool	true	no
security_group_ids	A list of additional security group IDs to allow access to ALB	list(string)	[]	no
slow_start	The amount of time (30-900 seconds) until a healthy target receives its full share of requests from the load balancer. 0 to disable.	number	null	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
standard_transition_days	(Deprecated, use lifecycle_configuration_rules instead) Number of days to persist in the standard storage tier before moving to the infrequent access tier	number	30	no
stickiness	Target group sticky configuration	object({ cookie_duration = number enabled = bool })	null	no
subnet_ids	A list of subnet IDs to associate with ALB	list(string)	n/a	yes
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
target_group_additional_tags	The additional tags to apply to the target group	map(string)	{}	no
target_group_name	The name for the default target group, uses a module label name if left empty	string	""	no
target_group_name_max_length	The max length of characters for the target group.	number	32	no
target_group_port	The port for the default target group	number	80	no
target_group_protocol	The protocol for the default target group HTTP or HTTPS	string	"HTTP"	no
target_group_protocol_version	The protocol version for the default target group HTTP1 or HTTP2 or GRPC	string	"HTTP1"	no
target_group_target_type	The type (instance, ip or lambda) of targets that can be registered with the target group	string	"ip"	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no
vpc_id	VPC ID to associate with ALB	string	n/a	yes
xff_header_processing_mode	Determines how the load balancer modifies the X-Forwarded-For header in the HTTP request before sending the request to the target. The possible values are append, preserve, and remove. Only valid for Load Balancers of type application. The default is append	string	"append"	no

Outputs

Name	Description
access_logs_bucket_id	The S3 bucket ID for access logs
alb_arn	The ARN of the ALB
alb_arn_suffix	The ARN suffix of the ALB
alb_dns_name	DNS name of ALB
alb_name	The ARN suffix of the ALB
alb_zone_id	The ID of the zone which ALB is provisioned
default_target_group_arn	The default target group ARN
default_target_group_arn_suffix	The default target group ARN suffix
http_listener_arn	The ARN of the HTTP forwarding listener
http_redirect_listener_arn	The ARN of the HTTP to HTTPS redirect listener
https_listener_arn	The ARN of the HTTPS listener
listener_arns	A list of all the listener ARNs
security_group_id	The security group ID of the ALB

Related Projects

Check out these related projects.

• terraform-aws-alb-ingress - Terraform module to provision an HTTP style ingress rule based on hostname and path for an ALB

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.

📚 Learn More

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.

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.

✨ 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.

1. Review our Code of Conduct and Contributor Guidelines.
2. Fork the repo on GitHub
3. Clone the project to your own machine
4. Commit changes to your own branch
5. Push your work back up to your fork
6. 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

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

Preamble to the Apache License, Version 2.0

Complete license is available in the LICENSE file.

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.

Trademarks

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

---

Copyright © 2017-2024 Cloud Posse, LLC