Skip to main content

alb

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

Variables​

Required Variables​

region (string) required​

AWS Region

Optional Variables​

access_logs_enabled (bool) optional​

A boolean flag to enable/disable access_logs


Default value: true

access_logs_prefix (string) optional​

The S3 log bucket prefix


Default value: ""

access_logs_s3_bucket_id (string) optional​

An external S3 Bucket name to store access logs in. If specified, no logging bucket will be created.


Default value: null

acm_component_name (string) optional​

Atmos acm component name


Default value: "acm"

alb_access_logs_s3_bucket_force_destroy (bool) optional​

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


Default value: false

cross_zone_load_balancing_enabled (bool) optional​

A boolean flag to enable/disable cross zone load balancing


Default value: true

deletion_protection_enabled (bool) optional​

A boolean flag to enable/disable deletion protection for ALB


Default value: false

deregistration_delay (number) optional​

The amount of time to wait in seconds before changing the state of a deregistering target to unused


Default value: 15

dns_acm_enabled (bool) optional​

If true, use the ACM ARN created by the given dns-delegated component. Otherwise, use the ACM ARN created by the given acm component.


Default value: false

dns_delegated_component_name (string) optional​

Atmos dns-delegated component name


Default value: "dns-delegated"

dns_delegated_environment_name (string) optional​

dns-delegated component environment name


Default value: null

drop_invalid_header_fields (bool) optional​

Indicates whether HTTP headers with header fields that are not valid are removed by the load balancer (true) or routed to targets (false).


Default value: false

health_check_healthy_threshold (number) optional​

The number of consecutive health checks successes required before considering an unhealthy target healthy


Default value: 2

health_check_interval (number) optional​

The duration in seconds in between health checks


Default value: 15

health_check_matcher (string) optional​

The HTTP response codes to indicate a healthy check


Default value: "200-399"

health_check_path (string) optional​

The destination for the health check request


Default value: "/"

health_check_port (string) optional​

The port to use for the healthcheck


Default value: "traffic-port"

health_check_timeout (number) optional​

The amount of time to wait in seconds before failing a health check request


Default value: 10

health_check_unhealthy_threshold (number) optional​

The number of consecutive health check failures required before considering the target unhealthy


Default value: 2

http2_enabled (bool) optional​

A boolean flag to enable/disable HTTP/2


Default value: true

http_enabled (bool) optional​

A boolean flag to enable/disable HTTP listener


Default value: true

http_ingress_cidr_blocks (list(string)) optional​

List of CIDR blocks to allow in HTTP security group


Default value:

[
  "0.0.0.0/0"
]
http_ingress_prefix_list_ids (list(string)) optional​

List of prefix list IDs for allowing access to HTTP ingress security group


Default value: [ ]

http_port (number) optional​

The port for the HTTP listener


Default value: 80

http_redirect (bool) optional​

A boolean flag to enable/disable HTTP redirect to HTTPS


Default value: true

https_enabled (bool) optional​

A boolean flag to enable/disable HTTPS listener


Default value: true

https_ingress_cidr_blocks (list(string)) optional​

List of CIDR blocks to allow in HTTPS security group


Default value:

[
  "0.0.0.0/0"
]
https_ingress_prefix_list_ids (list(string)) optional​

List of prefix list IDs for allowing access to HTTPS ingress security group


Default value: [ ]

https_port (number) optional​

The port for the HTTPS listener


Default value: 443

https_ssl_policy (string) optional​

The name of the SSL Policy for the listener


Default value: "ELBSecurityPolicy-TLS13-1-2-2021-06"

idle_timeout (number) optional​

The time in seconds that the connection is allowed to be idle


Default value: 60

internal (bool) optional​

A boolean flag to determine whether the ALB should be internal


Default value: false

ip_address_type (string) optional​

The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 and dualstack.


Default value: "ipv4"

lifecycle_rule_enabled (bool) optional​

A boolean that indicates whether the s3 log bucket lifecycle rule should be enabled.


Default value: true

stickiness optional​

Target group sticky configuration


Type:

object({
cookie_duration = number
enabled         = bool
})

Default value: null

target_group_name (string) optional​

The name for the default target group, uses a module label name if left empty


Default value: ""

target_group_port (number) optional​

The port for the default target group


Default value: 80

target_group_protocol (string) optional​

The protocol for the default target group HTTP or HTTPS


Default value: "HTTP"

target_group_target_type (string) optional​

The type (instance, ip or lambda) of targets that can be registered with the target group


Default value: "ip"

vpc_component_name (string) optional​

Atmos vpc component name


Default value: "vpc"

Context Variables​

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional​

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.


Required: No

Default value: { }

attributes (list(string)) optional​

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.


Required: No

Default value: [ ]

context (any) optional​

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.


Required: No

Default value:

{
  "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
}
delimiter (string) optional​

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.


Required: No

Default value: null

descriptor_formats (any) optional​

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


Required: No

Default value: { }

enabled (bool) optional​

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional​

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional​

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.


Required: No

Default value: null

label_key_case (string) optional​

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.


Required: No

Default value: null

label_order (list(string)) optional​

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.


Required: No

Default value: null

label_value_case (string) optional​

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.


Required: No

Default value: null

labels_as_tags (set(string)) optional​

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.


Required: No

Default value:

[
  "default"
]
name (string) optional​

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.


Required: No

Default value: null

namespace (string) optional​

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional​

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.


Required: No

Default value: null

stage (string) optional​

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional​

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.


Required: No

Default value: { }

tenant (string) optional​

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs​

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

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

Dependencies​

Requirements​

  • terraform, version: >= 1.0.0
  • aws, version: >= 4.0
  • local, version: >= 2.1

Modules​

NameVersionSourceDescription
acm1.8.0cloudposse/stack-config/yaml//modules/remote-staten/a
alb1.11.1cloudposse/alb/awsn/a
dns_delegated1.8.0cloudposse/stack-config/yaml//modules/remote-staten/a
iam_roleslatest../account-map/modules/iam-rolesn/a
this0.25.0cloudposse/label/nulln/a
vpc1.8.0cloudposse/stack-config/yaml//modules/remote-staten/a

References​