diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index d8605ec..5d17d2b 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -18,7 +18,7 @@ jobs: ref: ${{ github.event.pull_request.head.ref }} - name: Render terraform docs and push changes back to PR - uses: terraform-docs/gh-actions@cca78c27ac9e2b6545debf2ecae9df930fd3461c # v1.2.2 + uses: terraform-docs/gh-actions@aeae0038ed47a547e0c0fca5c059d3335f48fb25 # v1.3.0 with: working-dir: . output-file: README.md diff --git a/README.md b/README.md index 573546a..48a3e2b 100644 --- a/README.md +++ b/README.md @@ -269,7 +269,7 @@ If you're looking to raise an issue with this module, please create a new issue | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [access\_logs](#input\_access\_logs) | A boolean that determines whether to have access logs | `bool` | `true` | no | -| [access\_logs\_lifecycle\_rule](#input\_access\_logs\_lifecycle\_rule) | Custom lifecycle rule to override the default one |
list(object({|
id = string
enabled = string
prefix = string
tags = map(string)
transition = list(object({
days = number
storage_class = string
}))
expiration = object({
days = number
})
noncurrent_version_transition = list(object({
days = number
storage_class = string
}))
noncurrent_version_expiration = object({
days = number
})
}))
[| no | +| [access\_logs\_lifecycle\_rule](#input\_access\_logs\_lifecycle\_rule) | Custom lifecycle rule to override the default one |
{
"enabled": "Enabled",
"expiration": {
"days": 730
},
"id": "main",
"noncurrent_version_expiration": {
"days": 730
},
"noncurrent_version_transition": [
{
"days": 90,
"storage_class": "STANDARD_IA"
},
{
"days": 365,
"storage_class": "GLACIER"
}
],
"prefix": "",
"tags": {
"autoclean": "true",
"rule": "log"
},
"transition": [
{
"days": 90,
"storage_class": "STANDARD_IA"
},
{
"days": 365,
"storage_class": "GLACIER"
}
]
}
]
list(object({|
id = string
enabled = string
prefix = string
tags = map(string)
transition = list(object({
days = number
storage_class = string
}))
expiration = object({
days = number
})
noncurrent_version_transition = list(object({
days = number
storage_class = string
}))
noncurrent_version_expiration = object({
days = number
})
}))
[| no | | [account\_number](#input\_account\_number) | Account number of current environment | `string` | n/a | yes | | [application\_name](#input\_application\_name) | Name of application | `string` | n/a | yes | | [dns\_record\_client\_routing\_policy](#input\_dns\_record\_client\_routing\_policy) | (optional) Indicates how traffic is distributed among network load balancer Availability Zones only. Possible values are any\_availability\_zone (client DNS queries are resolved among healthy LB IP addresses across all LB Availability Zones), partial\_availability\_zone\_affinity (85 percent of client DNS queries will favor load balancer IP addresses in their own Availability Zone, while the remaining queries resolve to any healthy zone) and availability\_zone\_affinity (Client DNS queries will favor load balancer IP address in their own Availability Zone). | `string` | `"any_availability_zone"` | no | @@ -279,10 +279,10 @@ If you're looking to raise an issue with this module, please create a new issue | [force\_destroy\_bucket](#input\_force\_destroy\_bucket) | A boolean that indicates all objects (including any locked objects) should be deleted from the bucket so that the bucket can be destroyed without error. These objects are not recoverable. | `bool` | `false` | no | | [idle\_timeout](#input\_idle\_timeout) | The time in seconds that the connection is allowed to be idle. | `string` | `null` | no | | [internal\_lb](#input\_internal\_lb) | A boolean that determines whether the load balancer is internal or internet-facing. | `bool` | `false` | no | -| [lb\_target\_groups](#input\_lb\_target\_groups) | Map of load balancer target groups, where key is the name |
{
"enabled": "Enabled",
"expiration": {
"days": 730
},
"id": "main",
"noncurrent_version_expiration": {
"days": 730
},
"noncurrent_version_transition": [
{
"days": 90,
"storage_class": "STANDARD_IA"
},
{
"days": 365,
"storage_class": "GLACIER"
}
],
"prefix": "",
"tags": {
"autoclean": "true",
"rule": "log"
},
"transition": [
{
"days": 90,
"storage_class": "STANDARD_IA"
},
{
"days": 365,
"storage_class": "GLACIER"
}
]
}
]
map(object({| `{}` | no | +| [lb\_target\_groups](#input\_lb\_target\_groups) | Map of load balancer target groups, where key is the name |
port = optional(number)
attachment_port = optional(number)
deregistration_delay = optional(number)
health_check = optional(object({
enabled = optional(bool)
interval = optional(number)
healthy_threshold = optional(number)
matcher = optional(string)
path = optional(string)
port = optional(number)
timeout = optional(number)
unhealthy_threshold = optional(number)
}))
stickiness = optional(object({
enabled = optional(bool)
type = string
cookie_duration = optional(number)
cookie_name = optional(string)
}))
}))
map(object({| `{}` | no | | [load\_balancer\_type](#input\_load\_balancer\_type) | application or network | `string` | `"application"` | no | -| [loadbalancer\_egress\_rules](#input\_loadbalancer\_egress\_rules) | Create new security group with these egress rules for the loadbalancer. Or use the security\_groups var to attach existing group(s) |
port = optional(number)
attachment_port = optional(number)
deregistration_delay = optional(number)
health_check = optional(object({
enabled = optional(bool)
interval = optional(number)
healthy_threshold = optional(number)
matcher = optional(string)
path = optional(string)
port = optional(number)
timeout = optional(number)
unhealthy_threshold = optional(number)
}))
stickiness = optional(object({
enabled = optional(bool)
type = string
cookie_duration = optional(number)
cookie_name = optional(string)
}))
}))
map(object({| `{}` | no | -| [loadbalancer\_ingress\_rules](#input\_loadbalancer\_ingress\_rules) | Create new security group with these ingress rules for the loadbalancer. Or use the security\_groups var to attach existing group(s) |
description = string
from_port = number
to_port = number
protocol = string
security_groups = list(string)
cidr_blocks = list(string)
}))
map(object({| `{}` | no | +| [loadbalancer\_egress\_rules](#input\_loadbalancer\_egress\_rules) | Create new security group with these egress rules for the loadbalancer. Or use the security\_groups var to attach existing group(s) |
description = string
from_port = number
to_port = number
protocol = string
security_groups = list(string)
cidr_blocks = list(string)
}))
map(object({| `{}` | no | +| [loadbalancer\_ingress\_rules](#input\_loadbalancer\_ingress\_rules) | Create new security group with these ingress rules for the loadbalancer. Or use the security\_groups var to attach existing group(s) |
description = string
from_port = number
to_port = number
protocol = string
security_groups = list(string)
cidr_blocks = list(string)
}))
map(object({| `{}` | no | | [public\_subnets](#input\_public\_subnets) | Badly named variable, use subnets instead. Keeping for backward compatibility | `list(string)` | `[]` | no | | [region](#input\_region) | AWS Region where resources are to be created | `string` | n/a | yes | | [s3\_versioning](#input\_s3\_versioning) | A boolean that determines whether s3 will have versioning | `bool` | `true` | no |
description = string
from_port = number
to_port = number
protocol = string
security_groups = list(string)
cidr_blocks = list(string)
}))