Skip to main content

Component: alb

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


Stack Level: Regional

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

https_ssl_policy: ELBSecurityPolicy-FS-1-2-Res-2020-10
health_check_path: /api/healthz


terraform>= 1.0.0
aws>= 4.0
local>= 2.1


No providers.




No resources.


access_logs_enabledA boolean flag to enable/disable access_logsbooltrueno
access_logs_prefixThe S3 log bucket prefixstring""no
access_logs_s3_bucket_idAn external S3 Bucket name to store access logs in. If specified, no logging bucket will be created.stringnullno
acm_component_nameAtmos acm component namestring"acm"no
additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
alb_access_logs_s3_bucket_force_destroyA boolean that indicates all objects should be deleted from the ALB access logs S3 bucket so that the bucket can be destroyed without errorboolfalseno
attributesID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
contextSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
cross_zone_load_balancing_enabledA boolean flag to enable/disable cross zone load balancingbooltrueno
deletion_protection_enabledA boolean flag to enable/disable deletion protection for ALBboolfalseno
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
deregistration_delayThe amount of time to wait in seconds before changing the state of a deregistering target to unusednumber15no
descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br/> format = string<br/> labels = list(string)<br/>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
dns_acm_enabledIf true, use the ACM ARN created by the given dns-delegated component. Otherwise, use the ACM ARN created by the given acm component.boolfalseno
dns_delegated_component_nameAtmos dns-delegated component namestring"dns-delegated"no
dns_delegated_environment_namedns-delegated component environment namestringnullno
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
health_check_healthy_thresholdThe number of consecutive health checks successes required before considering an unhealthy target healthynumber2no
health_check_intervalThe duration in seconds in between health checksnumber15no
health_check_matcherThe HTTP response codes to indicate a healthy checkstring"200-399"no
health_check_pathThe destination for the health check requeststring"/"no
health_check_portThe port to use for the healthcheckstring"traffic-port"no
health_check_timeoutThe amount of time to wait in seconds before failing a health check requestnumber10no
health_check_unhealthy_thresholdThe number of consecutive health check failures required before considering the target unhealthynumber2no
http2_enabledA boolean flag to enable/disable HTTP/2booltrueno
http_enabledA boolean flag to enable/disable HTTP listenerbooltrueno
http_ingress_cidr_blocksList of CIDR blocks to allow in HTTP security grouplist(string)
http_ingress_prefix_list_idsList of prefix list IDs for allowing access to HTTP ingress security grouplist(string)[]no
http_portThe port for the HTTP listenernumber80no
http_redirectA boolean flag to enable/disable HTTP redirect to HTTPSbooltrueno
https_enabledA boolean flag to enable/disable HTTPS listenerbooltrueno
https_ingress_cidr_blocksList of CIDR blocks to allow in HTTPS security grouplist(string)
https_ingress_prefix_list_idsList of prefix list IDs for allowing access to HTTPS ingress security grouplist(string)[]no
https_portThe port for the HTTPS listenernumber443no
https_ssl_policyThe name of the SSL Policy for the listenerstring"ELBSecurityPolicy-TLS13-1-2-2021-06"no
id_length_limitLimit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
idle_timeoutThe time in seconds that the connection is allowed to be idlenumber60no
internalA boolean flag to determine whether the ALB should be internalboolfalseno
ip_address_typeThe type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 and dualstack.string"ipv4"no
label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
label_orderThe order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
label_value_caseControls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
lifecycle_rule_enabledA boolean that indicates whether the s3 log bucket lifecycle rule should be enabled.booltrueno
nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
regex_replace_charsTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
regionAWS Regionstringn/ayes
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
stickinessTarget group sticky configuration
cookie_duration = number
enabled = bool
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
target_group_nameThe name for the default target group, uses a module label name if left emptystring""no
target_group_portThe port for the default target groupnumber80no
target_group_protocolThe protocol for the default target group HTTP or HTTPSstring"HTTP"no
target_group_target_typeThe type (instance, ip or lambda) of targets that can be registered with the target groupstring"ip"no
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
vpc_component_nameAtmos vpc component namestring"vpc"no


access_logs_bucket_idThe S3 bucket ID for access logs
alb_arnThe ARN of the ALB
alb_arn_suffixThe ARN suffix of the ALB
alb_dns_nameDNS name of ALB
alb_nameThe ARN suffix of the ALB
alb_zone_idThe ID of the zone which ALB is provisioned
default_target_group_arnThe default target group ARN
http_listener_arnThe ARN of the HTTP forwarding listener
http_redirect_listener_arnThe ARN of the HTTP to HTTPS redirect listener
https_listener_arnThe ARN of the HTTPS listener
listener_arnsA list of all the listener ARNs
security_group_idThe security group ID of the ALB