From 35e90b40e68d52c702b9b1619ba5d48c229e1cd0 Mon Sep 17 00:00:00 2001 From: "docs-sourcer[bot]" <99042413+docs-sourcer[bot]@users.noreply.github.com> Date: Fri, 20 Dec 2024 14:11:09 -0800 Subject: [PATCH] Updated with the [latest changes](https://github.com/gruntwork-io/terraform-aws-load-balancer/releases/tag/v0.30.1) from the `terraform-aws-load-balancer@v0.30.1` source branch. (#2276) Co-authored-by: docs-sourcer[bot] <99042413+docs-sourcer[bot]@users.noreply.github.com> --- .../acm-tls-certificate.md | 17 +- .../terraform-aws-load-balancer/alb/alb.md | 183 ++++++++++++++++-- .../lb-listener-rules/lb-listener-rules.md | 17 +- .../terraform-aws-load-balancer/nlb/nlb.md | 13 +- 4 files changed, 188 insertions(+), 42 deletions(-) diff --git a/docs/reference/modules/terraform-aws-load-balancer/acm-tls-certificate/acm-tls-certificate.md b/docs/reference/modules/terraform-aws-load-balancer/acm-tls-certificate/acm-tls-certificate.md index fa7d28548..4d41c020e 100644 --- a/docs/reference/modules/terraform-aws-load-balancer/acm-tls-certificate/acm-tls-certificate.md +++ b/docs/reference/modules/terraform-aws-load-balancer/acm-tls-certificate/acm-tls-certificate.md @@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # ACM TLS Certificate -View Source +View Source Release Notes @@ -232,7 +232,7 @@ In this example, the `acm-tls-certificates` module will "wait" until your `aws_r module "acm_tls_certificate" { - source = "git::git@github.com:gruntwork-io/terraform-aws-load-balancer.git//modules/acm-tls-certificate?ref=v0.29.26" + source = "git::git@github.com:gruntwork-io/terraform-aws-load-balancer.git//modules/acm-tls-certificate?ref=v0.30.1" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -290,7 +290,7 @@ module "acm_tls_certificate" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-load-balancer.git//modules/acm-tls-certificate?ref=v0.29.26" + source = "git::git@github.com:gruntwork-io/terraform-aws-load-balancer.git//modules/acm-tls-certificate?ref=v0.30.1" } inputs = { @@ -540,15 +540,14 @@ Global tags to apply to all ACM certificates issued via this module. These globa - diff --git a/docs/reference/modules/terraform-aws-load-balancer/alb/alb.md b/docs/reference/modules/terraform-aws-load-balancer/alb/alb.md index 2df045f31..5f4ee9c9d 100644 --- a/docs/reference/modules/terraform-aws-load-balancer/alb/alb.md +++ b/docs/reference/modules/terraform-aws-load-balancer/alb/alb.md @@ -9,13 +9,13 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # Application Load Balancer (ALB) Module -View Source +View Source -Release Notes +Release Notes This Terraform Module creates an [Application Load Balancer](http://docs.aws.amazon.com/elasticloadbalancing/latest/application/introduction.html) that you can use as a load balancer for any [ALB Target Group](http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html). @@ -191,7 +191,7 @@ There are two ways for you to override this behavior: module "alb" { - source = "git::git@github.com:gruntwork-io/terraform-aws-load-balancer.git//modules/alb?ref=v0.29.26" + source = "git::git@github.com:gruntwork-io/terraform-aws-load-balancer.git//modules/alb?ref=v0.30.1" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -334,7 +334,7 @@ module "alb" { # Define the default action for HTTP listeners. Use this to override the # default_action variable for HTTP listeners. This is particularly useful if # you for example want to redirect all HTTP traffic to HTTPS. - http_default_action = null + http_default_action = {} # A list of ports for which an HTTP Listener should be created on the ALB. # Tip: When you define Listener Rules for these Listeners, be sure that, for @@ -412,7 +412,7 @@ module "alb" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-load-balancer.git//modules/alb?ref=v0.29.26" + source = "git::git@github.com:gruntwork-io/terraform-aws-load-balancer.git//modules/alb?ref=v0.30.1" } inputs = { @@ -558,7 +558,7 @@ inputs = { # Define the default action for HTTP listeners. Use this to override the # default_action variable for HTTP listeners. This is particularly useful if # you for example want to redirect all HTTP traffic to HTTPS. - http_default_action = null + http_default_action = {} # A list of ports for which an HTTP Listener should be created on the ALB. # Tip: When you define Listener Rules for these Listeners, be sure that, for @@ -798,7 +798,7 @@ A map of custom tags to apply to the ALB and its Security Group. The key is the - + Define the default action if a request to the load balancer does not match any of your listener rules. https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener#default_action @@ -807,7 +807,44 @@ Define the default action if a request to the load balancer does not match any o ```hcl -Any types represent complex values of variable type. For details, please consult `variables.tf` in the source repo. +object({ + forward = optional(object({ + target_groups = list(object({ + arn = string + weight = optional(number) + })) + stickiness = optional(object({ + duration = optional(number) + enabled = optional(bool) + })) + })) + redirect = optional(object({ + host = optional(string) + path = optional(string) + port = optional(string) + protocol = optional(string) + query = optional(string) + status_code = string + })) + fixed-response = optional(object({ + content_type = string + message_body = optional(string) + status_code = number + })) + authenticate-cognito = optional(object({ + user_pool_arn = string + user_pool_client_id = string + user_pool_domain = string + })) + authenticate-oidc = optional(object({ + authorization_endpoint = string + client_id = string + client_secret = string + issuer = string + token_endpoint = string + user_info_endpoint = string + })) + }) ``` @@ -907,7 +944,7 @@ Indicates whether the X-Forwarded-For header should preserve the source port tha - + Define the default action for HTTP listeners. Use this to override the default_action variable for HTTP listeners. This is particularly useful if you for example want to redirect all HTTP traffic to HTTPS. @@ -916,11 +953,48 @@ Define the default action for HTTP listeners. Use this to override the default_a ```hcl -Any types represent complex values of variable type. For details, please consult `variables.tf` in the source repo. +object({ + forward = optional(object({ + target_groups = list(object({ + arn = string + weight = optional(number) + })) + stickiness = optional(object({ + duration = optional(number) + enabled = optional(bool) + })) + })) + redirect = optional(object({ + host = optional(string) + path = optional(string) + port = optional(string) + protocol = optional(string) + query = optional(string) + status_code = string + })) + fixed-response = optional(object({ + content_type = string + message_body = optional(string) + status_code = number + })) + authenticate-cognito = optional(object({ + user_pool_arn = string + user_pool_client_id = string + user_pool_domain = string + })) + authenticate-oidc = optional(object({ + authorization_endpoint = string + client_id = string + client_secret = string + issuer = string + token_endpoint = string + user_info_endpoint = string + })) + }) ``` - +
@@ -963,6 +1037,44 @@ A list of the ports for which an HTTPS Listener should be created on the ALB. Ea list(object({ port = number tls_domain_name = string + default_action = optional(object({ + forward = optional(object({ + target_groups = list(object({ + arn = string + weight = optional(number) + })) + stickiness = optional(object({ + duration = optional(number) + enabled = optional(bool) + })) + })) + redirect = optional(object({ + host = optional(string) + path = optional(string) + port = optional(string) + protocol = optional(string) + query = optional(string) + status_code = string + })) + fixed-response = optional(object({ + content_type = string + message_body = optional(string) + status_code = number + })) + authenticate-cognito = optional(object({ + user_pool_arn = string + user_pool_client_id = string + user_pool_domain = string + })) + authenticate-oidc = optional(object({ + authorization_endpoint = string + client_id = string + client_secret = string + issuer = string + token_endpoint = string + user_info_endpoint = string + })) + })) })) ``` @@ -1008,6 +1120,44 @@ A list of the ports for which an HTTPS Listener should be created on the ALB. Ea list(object({ port = number tls_arn = string + default_action = optional(object({ + forward = optional(object({ + target_groups = list(object({ + arn = string + weight = optional(number) + })) + stickiness = optional(object({ + duration = optional(number) + enabled = optional(bool) + })) + })) + redirect = optional(object({ + host = optional(string) + path = optional(string) + port = optional(string) + protocol = optional(string) + query = optional(string) + status_code = string + })) + fixed-response = optional(object({ + content_type = string + message_body = optional(string) + status_code = number + })) + authenticate-cognito = optional(object({ + user_pool_arn = string + user_pool_client_id = string + user_pool_domain = string + })) + authenticate-oidc = optional(object({ + authorization_endpoint = string + client_id = string + client_secret = string + issuer = string + token_endpoint = string + user_info_endpoint = string + })) + })) })) ``` @@ -1163,15 +1313,14 @@ A map from port to the AWS ARNs of the listeners for the ALB that has been deplo - diff --git a/docs/reference/modules/terraform-aws-load-balancer/lb-listener-rules/lb-listener-rules.md b/docs/reference/modules/terraform-aws-load-balancer/lb-listener-rules/lb-listener-rules.md index 80b52d1e1..b60134ea0 100644 --- a/docs/reference/modules/terraform-aws-load-balancer/lb-listener-rules/lb-listener-rules.md +++ b/docs/reference/modules/terraform-aws-load-balancer/lb-listener-rules/lb-listener-rules.md @@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # Load Balancer Listener Rules -View Source +View Source Release Notes @@ -95,7 +95,7 @@ Note that in most cases, your path definitions should be mutually exclusive and module "lb_listener_rules" { - source = "git::git@github.com:gruntwork-io/terraform-aws-load-balancer.git//modules/lb-listener-rules?ref=v0.29.26" + source = "git::git@github.com:gruntwork-io/terraform-aws-load-balancer.git//modules/lb-listener-rules?ref=v0.30.1" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -151,7 +151,7 @@ module "lb_listener_rules" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-load-balancer.git//modules/lb-listener-rules?ref=v0.29.26" + source = "git::git@github.com:gruntwork-io/terraform-aws-load-balancer.git//modules/lb-listener-rules?ref=v0.30.1" } inputs = { @@ -831,15 +831,14 @@ The ARNs of the rules of type redirect. The key is the same key of the rule from - diff --git a/docs/reference/modules/terraform-aws-load-balancer/nlb/nlb.md b/docs/reference/modules/terraform-aws-load-balancer/nlb/nlb.md index f5b6ea715..56b6c62bf 100644 --- a/docs/reference/modules/terraform-aws-load-balancer/nlb/nlb.md +++ b/docs/reference/modules/terraform-aws-load-balancer/nlb/nlb.md @@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # Network Load Balancer (NLB) Module -View Source +View Source Release Notes @@ -25,15 +25,14 @@ For information on why the module was removed, refer to the discussion in [PR \#62](https://github.com/gruntwork-io/terraform-aws-load-balancer/pull/62) and [PR \#65](https://github.com/gruntwork-io/terraform-aws-load-balancer/pull/65). -