terraform-aws-lb

Terraform module to provision an Application, Network or Gateway Load Balancer.

Examples

IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.

module "alb" {
  source = "nventive/lb/aws"
  # We recommend pinning every module to a specific version
  # version = "x.x.x"

  namespace = "eg"
  stage     = "test"
  name      = "app"

  load_balancer_type = "application"
}

Requirements

Name	Version
terraform	>= 1.2.0
aws	>= 4.9
null	>= 3.0
random	>= 3.0
time	>= 0.7

Providers

Name	Version
aws	>= 4.9
null	>= 3.0

Modules

Name	Source	Version
access_logs	cloudposse/lb-s3-bucket/aws	0.19.0
sg	cloudposse/security-group/aws	2.2.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_lb.default	resource
null_resource.sg_vpc_validation	resource

Inputs

Name	Description	Type	Default	Required
access_logs_enabled	Whether or not ALB access logs should be enabled.	`bool`	`true`	no
access_logs_force_destroy	Set to `true` to force access logs bucket.	`bool`	`false`	no
access_logs_prefix	Prefix for ALB access logs.	`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
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
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
delimiter	Delimiter to be used between ID elements. Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	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
enable_deletion_protection	If true, deletion of the load balancer will be disabled via the AWS API. This will prevent Terraform from deleting the load balancer.	`bool`	`false`	no
enable_http2	Indicates whether HTTP/2 is enabled in `application` load balancers.	`bool`	`false`	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
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. Only valid for Load Balancers of type `application`.	`number`	`60`	no
internal	Set to `true`, to create an internal Load Balancer.	`bool`	`false`	no
ip_address_type	Address type for ALB possible. Specify one of `ipv4`, `dualstack`.	`string`	`null`	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
load_balancer_type	Type of the Load Balancer. Specify one of `application`, `network` or `gateway`.	`string`	`"application"`	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
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	Set to `true` to create a self-referencing security group for all ports.	`bool`	`false`	no
security_group_ids	Security group IDS to associate with the Load Balancer.	`list(string)`	`[]`	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
subnet_ids	List of subnet IDs for the Load Balancer. The Load Balancer will be created in the VPC associated with the subnet IDs.	`list(string)`	`[]`	no
tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	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	ID of the VPC. Required if `security_group_enabled` is `true`.	`string`	`null`	no

Outputs

Name	Description
access_logs_bucket_arn	Access Logs S3 bucket ARN.
access_logs_bucket_domain_name	Access Logs S3 bucket domain name.
access_logs_bucket_id	Access Logs S3 bucket ID.
access_logs_bucket_prefix	Access Logs S3 bucket prefix.
access_logs_enabled	Are Access Logs enabled.
arn	The ARN of the load balancer (matches `id`).
arn_suffix	The ARN suffix for use with CloudWatch Metrics.
dns_name	The DNS name of the load balancer.
enabled	Is the module enabled.
id	The ARN of the load balancer (matches `arn`).
security_group_id	ID for the default security if `security_group_enabled` is `true`.
zone_id	The canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record).

Breaking Changes

Please consult BREAKING_CHANGES.md for more information about version history and compatibility.

Contributing

Please read CONTRIBUTING.md for details on the process for contributing to this project.

Be mindful of our Code of Conduct.

We're hiring

Look for current openings on BambooHR https://nventive.bamboohr.com/careers/

Stay in touch

nventive.com | Linkedin | Instagram | YouTube | Spotify

Name		Name	Last commit message	Last commit date
Latest commit History 5 Commits
.docs		.docs
.githooks		.githooks
.github		.github
.editorconfig		.editorconfig
.gitattributes		.gitattributes
.gitignore		.gitignore
BREAKING_CHANGES.md		BREAKING_CHANGES.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
context.tf		context.tf
main.tf		main.tf
outputs.tf		outputs.tf
variables.tf		variables.tf
versions.tf		versions.tf

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

terraform-aws-lb

Examples

Requirements

Providers

Modules

Resources

Inputs

Outputs

Breaking Changes

Contributing

We're hiring

Stay in touch

About

Releases 4

Packages

Contributors 2

Languages

License

nventive/terraform-aws-lb

Folders and files

Latest commit

History

Repository files navigation

terraform-aws-lb

Examples

Requirements

Providers

Modules

Resources

Inputs

Outputs

Breaking Changes

Contributing

We're hiring

Stay in touch

About

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases 4

Packages 0

Contributors 2

Languages

Packages