Skip to content

Commit

Permalink
Updated with the [latest changes](https://github.com/gruntwork-io/ter…
Browse files Browse the repository at this point in the history 
…raform-aws-load-balancer/releases/tag/v0.30.1) from the `[email protected]` source branch. (#2276)

Co-authored-by: docs-sourcer[bot] <99042413+docs-sourcer[bot]@users.noreply.github.com>
  • Loading branch information
@docs-sourcer
docs-sourcer[bot] authored Dec 20, 2024
1 parent 9aaa500 commit 35e90b4
Show file tree
Hide file tree
Showing 4 changed files with 188 additions and 42 deletions.
17 changes: 8 additions & 9 deletions .../modules/terraform-aws-load-balancer/acm-tls-certificate/acm-tls-certificate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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";

<VersionBadge repoTitle="Load Balancer Modules" version="0.29.26" lastModifiedVersion="0.29.20"/>
<VersionBadge repoTitle="Load Balancer Modules" version="0.30.1" lastModifiedVersion="0.29.20"/>

# ACM TLS Certificate

<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.26/modules/acm-tls-certificate" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.30.1/modules/acm-tls-certificate" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/releases/tag/v0.29.20" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>

Expand Down Expand Up @@ -232,7 +232,7 @@ In this example, the `acm-tls-certificates` module will "wait" until your `aws_r
module "acm_tls_certificate" {
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/acm-tls-certificate?ref=v0.29.26"
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/acm-tls-certificate?ref=v0.30.1"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
Expand Down Expand Up @@ -290,7 +290,7 @@ module "acm_tls_certificate" {
# ------------------------------------------------------------------------------------------------------
terraform {
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/acm-tls-certificate?ref=v0.29.26"
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/acm-tls-certificate?ref=v0.30.1"
}
inputs = {
Expand Down Expand Up @@ -540,15 +540,14 @@ Global tags to apply to all ACM certificates issued via this module. These globa
</TabItem>
</Tabs>


<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.26/modules/acm-tls-certificate/readme.md",
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.26/modules/acm-tls-certificate/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.26/modules/acm-tls-certificate/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.30.1/modules/acm-tls-certificate/readme.md",
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.30.1/modules/acm-tls-certificate/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.30.1/modules/acm-tls-certificate/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "bdbbd15683e1860f393a1c23e2ff552f"
"hash": "0a763d765bd3b9368e8dae392f9de0eb"
}
##DOCS-SOURCER-END -->
183 changes: 166 additions & 17 deletions docs/reference/modules/terraform-aws-load-balancer/alb/alb.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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";

<VersionBadge repoTitle="Load Balancer Modules" version="0.29.26" lastModifiedVersion="0.29.26"/>
<VersionBadge repoTitle="Load Balancer Modules" version="0.30.1" lastModifiedVersion="0.30.0"/>

# Application Load Balancer (ALB) Module

<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.26/modules/alb" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.30.1/modules/alb" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/releases/tag/v0.29.26" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/releases/tag/v0.30.0" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>

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).
Expand Down Expand Up @@ -191,7 +191,7 @@ There are two ways for you to override this behavior:
module "alb" {
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/alb?ref=v0.29.26"
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/alb?ref=v0.30.1"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -412,7 +412,7 @@ module "alb" {
# ------------------------------------------------------------------------------------------------------
terraform {
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/alb?ref=v0.29.26"
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/alb?ref=v0.30.1"
}
inputs = {
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -798,7 +798,7 @@ A map of custom tags to apply to the ALB and its Security Group. The key is the
<HclListItemDefaultValue defaultValue="{}"/>
</HclListItem>

<HclListItem name="default_action" requirement="optional" type="any">
<HclListItem name="default_action" requirement="optional" type="object(…)">
<HclListItemDescription>

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
Expand All @@ -807,7 +807,44 @@ Define the default action if a request to the load balancer does not match any o
<HclListItemTypeDetails>

```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
}))
})
```

</HclListItemTypeDetails>
Expand Down Expand Up @@ -907,7 +944,7 @@ Indicates whether the X-Forwarded-For header should preserve the source port tha
<HclListItemDefaultValue defaultValue="true"/>
</HclListItem>

<HclListItem name="http_default_action" requirement="optional" type="map(any)">
<HclListItem name="http_default_action" requirement="optional" type="object(…)">
<HclListItemDescription>

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.
Expand All @@ -916,11 +953,48 @@ Define the default action for HTTP listeners. Use this to override the default_a
<HclListItemTypeDetails>

```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
}))
})
```

</HclListItemTypeDetails>
<HclListItemDefaultValue defaultValue="null"/>
<HclListItemDefaultValue defaultValue="{}"/>
<HclGeneralListItem title="More Details">
<details>

Expand Down Expand Up @@ -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
}))
}))
}))
```

Expand Down Expand Up @@ -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
}))
}))
}))
```

Expand Down Expand Up @@ -1163,15 +1313,14 @@ A map from port to the AWS ARNs of the listeners for the ALB that has been deplo
</TabItem>
</Tabs>


<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.26/modules/alb/readme.md",
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.26/modules/alb/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.26/modules/alb/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.30.1/modules/alb/readme.md",
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.30.1/modules/alb/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.30.1/modules/alb/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "d87b9015a947cdf119124cdd26c3bd91"
"hash": "7290a659c1a3f268710c8b53d305ff92"
}
##DOCS-SOURCER-END -->
17 changes: 8 additions & 9 deletions ...ence/modules/terraform-aws-load-balancer/lb-listener-rules/lb-listener-rules.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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";

<VersionBadge repoTitle="Load Balancer Modules" version="0.29.26" lastModifiedVersion="0.29.24"/>
<VersionBadge repoTitle="Load Balancer Modules" version="0.30.1" lastModifiedVersion="0.29.24"/>

# Load Balancer Listener Rules

<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.26/modules/lb-listener-rules" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.30.1/modules/lb-listener-rules" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/releases/tag/v0.29.24" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>

Expand Down Expand Up @@ -95,7 +95,7 @@ Note that in most cases, your path definitions should be mutually exclusive and
module "lb_listener_rules" {
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/lb-listener-rules?ref=v0.29.26"
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/lb-listener-rules?ref=v0.30.1"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
Expand Down Expand Up @@ -151,7 +151,7 @@ module "lb_listener_rules" {
# ------------------------------------------------------------------------------------------------------
terraform {
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/lb-listener-rules?ref=v0.29.26"
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/lb-listener-rules?ref=v0.30.1"
}
inputs = {
Expand Down Expand Up @@ -831,15 +831,14 @@ The ARNs of the rules of type redirect. The key is the same key of the rule from
</TabItem>
</Tabs>


<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.26/modules/lb-listener-rules/readme.md",
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.26/modules/lb-listener-rules/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.26/modules/lb-listener-rules/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.30.1/modules/lb-listener-rules/readme.md",
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.30.1/modules/lb-listener-rules/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.30.1/modules/lb-listener-rules/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "54e2a7c53375d57c3cc3c180a1f06682"
"hash": "fba47d39b00a33db49bd0005e06bec03"
}
##DOCS-SOURCER-END -->
Loading

0 comments on commit 35e90b4

Please sign in to comment.