nlb

This component provisions an AWS Network Load Balancer (NLB) using the upstream Cloud Posse Terraform module. It supports internet-facing or internal NLBs, TCP/TLS/UDP listeners, optional default target group, cross-zone load balancing, access logs, subnet EIP mappings, and deletion protection.

It integrates with other Atmos components via remote state:

vpc: to automatically source the VPC ID and appropriate subnets (public or private) when not provided explicitly.
acm or dns-delegated: to automatically discover an ACM certificate ARN for TLS listeners when certificate_arn is not provided. Behavior is controlled by dns_acm_enabled.

You can also override any of these via input variables, including providing a specific certificate_arn directly.

Usage

Stack Level: Regional

Example

Here's an example snippet showing how to use this component in an Atmos stack.

components:
  terraform:
    vpc:
      vars:
        availability_zones: ["a", "b", "c"]
        ipv4_primary_cidr_block: "10.100.0.0/18"

    nlb:
      vars:
        # Core settings
        internal: false
        tcp_enabled: true
        tcp_port: 80
        tls_enabled: true
        tls_port: 443

        # Optional: discover cert from other components via remote state
        # Toggle behavior with `dns_acm_enabled` or provide `certificate_arn`
        dns_acm_enabled: true
        acm_component_name: acm
        dns_delegated_component_name: dns-delegated
        # certificate_arn: "arn:aws:acm:..."

        # Optional: map EIPs to subnets
        subnet_mapping_enabled: false
        eip_allocation_ids: []

        # Other common options
        cross_zone_load_balancing_enabled: true
        deletion_protection_enabled: false
        access_logs_enabled: false

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: false

acm_component_name (string) optional

Atmos acm component name

Default value: "acm"

certificate_arn (string) optional

ARN of the certificate for the TLS listener

Default value: null

cross_zone_load_balancing_enabled (bool) optional

Enable cross zone load balancing

Default value: true

deletion_protection_enabled (bool) optional

Enable deletion protection for the NLB

Default value: false

deregistration_delay (number) optional

Time to wait before deregistering targets

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. Overridden by certificate_arn

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

eip_allocation_ids (list(string)) optional

Allocation IDs for EIPs when subnet mapping is enabled

Default value: [ ]

health_check_enabled (bool) optional

Enable health checks

Default value: true

health_check_port (number) optional

Port for health checks

Default value: null

internal (bool) optional

Whether the NLB is internal

Default value: false

load_balancer_name (string) optional

Name for the load balancer

Default value: ""

load_balancer_name_max_length (number) optional

Max length for the load balancer name

Default value: 32

security_group_ids (list(string)) optional

Additional security group IDs to allow access to the NLB

Default value: [ ]

stickiness_enabled (bool) optional

Enable stickiness on the default target group

Default value: false

subnet_ids (list(string)) optional

List of subnet IDs to associate with NLB

Default value: null

subnet_mapping_enabled (bool) optional

Create EIPs for the provided subnet IDs

Default value: false

target_group_enabled (bool) optional

Whether to create the default target group and listener

Default value: true

target_group_ip_address_type (string) optional

IP address type for the target group

Default value: "ipv4"

target_group_name (string) optional

Name of the default target group

Default value: ""

target_group_name_max_length (number) optional

Max length for the target group name

Default value: 32

target_group_port (number) optional

Port for the default target group

Default value: 80

target_group_target_type (string) optional

Target type for the default target group

Default value: "ip"

tcp_enabled (bool) optional

Enable the TCP listener

Default value: true

tcp_port (number) optional

Port for the TCP listener

Default value: 80

tls_enabled (bool) optional

Enable the TLS listener

Default value: false

tls_port (number) optional

Port for the TLS listener

Default value: 443

udp_enabled (bool) optional

Enable the UDP listener

Default value: false

udp_port (number) optional

Port for the UDP listener

Default value: 53

vpc_component_name (string) optional

Name of the VPC component

Default value: "vpc"

vpc_id (string) optional

VPC ID to associate with NLB

Default value: null

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

nlb: The NLB of the Component

Dependencies

Requirements

terraform, version: >= 1.0.0
aws, version: >= 4.0

Modules

Name	Version	Source	Description
`acm`	1.8.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`dns_delegated`	1.8.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`iam_roles`	latest	`../account-map/modules/iam-roles`	n/a
`nlb`	0.18.2	`cloudposse/nlb/aws`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a
`vpc`	1.8.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a

Usage​

Example​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Modules​

Usage

Example

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Modules