Terraform module to create an NLB and a default NLB target and related security groups.
This project is part of our comprehensive "SweetOps" approach towards DevOps.
It's 100% Open Source and licensed under the APACHE2.
We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!
Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.
| Benchmark | Description |
|---|---|
| Infrastructure Security Compliance | |
| Center for Internet Security, KUBERNETES Compliance | |
| Center for Internet Security, AWS Compliance | |
| Center for Internet Security, AZURE Compliance | |
| Payment Card Industry Data Security Standards Compliance | |
| National Institute of Standards and Technology Compliance | |
| Information Security Management System, ISO/IEC 27001 Compliance | |
| Service Organization Control 2 Compliance | |
| Center for Internet Security, GCP Compliance | |
| Health Insurance Portability and Accountability Compliance |
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.
Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.
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 = "git::https://github.com/cloudposse/terraform-aws-vpc.git?ref=tags/0.8.1"
namespace = var.namespace
stage = var.stage
name = var.name
delimiter = var.delimiter
attributes = var.attributes
cidr_block = var.vpc_cidr_block
tags = var.tags
}
module "subnets" {
source = "git::https://github.com/cloudposse/terraform-aws-dynamic-subnets.git?ref=tags/0.16.1"
availability_zones = var.availability_zones
namespace = var.namespace
stage = var.stage
name = var.name
attributes = var.attributes
delimiter = var.delimiter
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 "nlb" {
source = "cloudposse/nlb/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
subnet_ids = module.subnets.public_subnet_ids
internal = var.internal
tcp_enabled = var.tcp_enabled
access_logs_enabled = var.access_logs_enabled
nlb_access_logs_s3_bucket_force_destroy = var.nlb_access_logs_s3_bucket_force_destroy
access_logs_region = var.access_logs_region
cross_zone_load_balancing_enabled = var.cross_zone_load_balancing_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
target_group_port = var.target_group_port
target_group_target_type = var.target_group_target_type
tags = var.tags
}Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
| Name | Version |
|---|---|
| terraform | >= 0.13.0 |
| aws | >= 2.0 |
| local | >= 1.3 |
| null | >= 2.0 |
| template | >= 2.0 |
| Name | Version |
|---|---|
| aws | >= 2.0 |
| 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_region | The region for the access_logs S3 bucket | string |
"us-east-1" |
no |
| additional_tag_map | Additional tags for appending to tags_as_list_of_maps. Not added to tags. |
map(string) |
{} |
no |
| attributes | Additional attributes (e.g. 1) |
list(string) |
[] |
no |
| certificate_arn | The ARN of the default SSL certificate for HTTPS listener | 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 |
{ |
no |
| cross_zone_load_balancing_enabled | A boolean flag to enable/disable cross zone load balancing | bool |
true |
no |
| deletion_protection_enabled | A boolean flag to enable/disable deletion protection for NLB | bool |
false |
no |
| delimiter | Delimiter to be used between namespace, environment, stage, name and attributes.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 |
| enable_glacier_transition | Enables the transition of lb logs to AWS Glacier | bool |
true |
no |
| enabled | Set to false to prevent the module from creating any resources | bool |
null |
no |
| environment | Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT' | string |
null |
no |
| expiration_days | Number of days after which to expunge s3 logs | number |
90 |
no |
| glacier_transition_days | Number of days after which to move s3 logs to the glacier storage tier | number |
60 |
no |
| health_check_enabled | A boolean flag to enable/disable the NLB health checks | bool |
true |
no |
| health_check_interval | The duration in seconds in between health checks | number |
10 |
no |
| health_check_path | The destination for the health check request | string |
"/" |
no |
| health_check_port | The port to send the health check request to (defaults to traffic-port) |
number |
null |
no |
| health_check_protocol | The protocol to use for the health check request | string |
null |
no |
| health_check_threshold | The number of consecutive health checks successes required before considering an unhealthy target healthy, or failures required before considering a health target unhealthy | number |
2 |
no |
| id_length_limit | Limit id to this many characters (minimum 6).Set to 0 for unlimited length.Set to null for default, which is 0.Does not affect id_full. |
number |
null |
no |
| internal | A boolean flag to determine whether the NLB 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 | The letter case of label keys (tag names) (i.e. name, namespace, environment, stage, attributes) to use in tags.Possible values: lower, title, upper.Default value: title. |
string |
null |
no |
| label_order | The naming order of the id output and Name tag. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 5 elements, but at least one must be present. |
list(string) |
null |
no |
| label_value_case | The letter case of output label values (also used in tags and id).Possible values: lower, title, upper and none (no transformation).Default value: lower. |
string |
null |
no |
| lifecycle_rule_enabled | A boolean that indicates whether the s3 log bucket lifecycle rule should be enabled. | bool |
false |
no |
| name | Solution name, e.g. 'app' or 'jenkins' | string |
null |
no |
| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | string |
null |
no |
| nlb_access_logs_s3_bucket_force_destroy | A boolean that indicates all objects should be deleted from the NLB access logs S3 bucket so that the bucket can be destroyed without error | bool |
false |
no |
| noncurrent_version_expiration_days | Specifies when noncurrent s3 log versions expire | number |
90 |
no |
| noncurrent_version_transition_days | Specifies when noncurrent s3 log versions transition | number |
30 |
no |
| regex_replace_chars | Regex to replace chars with empty string in namespace, environment, stage and name.If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. |
string |
null |
no |
| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | string |
null |
no |
| standard_transition_days | Number of days to persist logs in standard storage tier before moving to the infrequent access tier | number |
30 |
no |
| subnet_ids | A list of subnet IDs to associate with NLB | list(string) |
n/a | yes |
| tags | Additional tags (e.g. map('BusinessUnit','XYZ') |
map(string) |
{} |
no |
| target_group_additional_tags | The additional tags to apply to the default 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_port | The port for the default target group | number |
80 |
no |
| target_group_target_type | The type (instance, ip or lambda) of targets that can be registered with the default target group |
string |
"ip" |
no |
| tcp_enabled | A boolean flag to enable/disable TCP listener | bool |
true |
no |
| tcp_port | The port for the TCP listener | number |
80 |
no |
| tls_enabled | A boolean flag to enable/disable TLS listener | bool |
false |
no |
| tls_port | The port for the TLS listener | number |
443 |
no |
| tls_ssl_policy | The name of the SSL Policy for the listener | string |
"ELBSecurityPolicy-2016-08" |
no |
| udp_enabled | A boolean flag to enable/disable UDP listener | bool |
false |
no |
| udp_port | The port for the UDP listener | number |
53 |
no |
| vpc_id | VPC ID to associate with NLB | string |
n/a | yes |
| Name | Description |
|---|---|
| access_logs_bucket_id | The S3 bucket ID for access logs |
| default_listener_arn | The ARN of the default listener |
| default_target_group_arn | The default target group ARN |
| listener_arns | A list of all the listener ARNs |
| nlb_arn | The ARN of the NLB |
| nlb_arn_suffix | The ARN suffix of the NLB |
| nlb_dns_name | DNS name of NLB |
| nlb_name | The ARN suffix of the NLB |
| nlb_zone_id | The ID of the zone which NLB is provisioned |
| tls_listener_arn | The ARN of the TLS listener |
Got a question? We got answers.
File a GitHub issue, send us an email or join our Slack Community.
We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
- Site Reliability Engineering. You'll have total visibility into your apps and microservices.
- Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
- GitOps. You'll be able to operate your infrastructure via Pull Requests.
- Training. You'll receive hands-on training so your team can operate what we build.
- Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
- Troubleshooting. You'll get help to triage when things aren't working.
- Code Reviews. You'll receive constructive feedback on Pull Requests.
- Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.
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.
Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.
Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!
Please use the issue tracker to report any bugs or file feature requests.
If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- 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!
Copyright © 2017-2021 Cloud Posse, LLC
See LICENSE for full details.
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.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!
We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.
We offer paid support on all of our projects.
Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.
 Erik Osterman |
 Igor Rodionov |
 Andriy Knysh |
 Sarkis Varozian |
|---|