From d88561833f446e8794e1c9fd22b8dca1acfc0359 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sat, 21 Sep 2024 08:09:28 +0000 Subject: [PATCH] terraform-docs: automated action --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7ed2a5c..91958fd 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ module "fck-nat" { | [additional\_security\_group\_ids](#input\_additional\_security\_group\_ids) | A list of identifiers of security groups to be added for the NAT instance | `list(string)` | `[]` | no | | [ami\_id](#input\_ami\_id) | AMI to use for the NAT instance. Uses fck-nat latest AMI in the region if none provided | `string` | `null` | no | | [attach\_ssm\_policy](#input\_attach\_ssm\_policy) | Whether to attach the minimum required IAM permissions to connect to the instance via SSM. | `bool` | `true` | no | -| [cloudwatch\_agent\_configuration](#input\_cloudwatch\_agent\_configuration) | CloudWatch configuration for the NAT instance | 
object({
    namespace           = optional(string, "fck-nat"),
    collection_interval = optional(number, 60),
    endpoint_override   = optional(string, "")
  })
| 
{
  "collection_interval": 60,
  "endpoint_override": "",
  "namespace": "fck-nat"
}
| no | +| [cloudwatch\_agent\_configuration](#input\_cloudwatch\_agent\_configuration) | CloudWatch configuration for the NAT instance | 
object({
    namespace           = optional(string, "fck-nat"),
    collection_interval = optional(number, 60),
    endpoint_override   = optional(string, "")
  })
| 
{
  "collection_interval": 60,
  "endpoint_override": "",
  "namespace": "fck-nat"
}
| no | | [cloudwatch\_agent\_configuration\_param\_arn](#input\_cloudwatch\_agent\_configuration\_param\_arn) | ARN of the SSM parameter containing the CloudWatch agent configuration. If none provided, creates one | `string` | `null` | no | | [ebs\_root\_volume\_size](#input\_ebs\_root\_volume\_size) | Size of the EBS root volume in GB | `number` | `8` | no | | [eip\_allocation\_ids](#input\_eip\_allocation\_ids) | EIP allocation IDs to use for the NAT instance. Automatically assign a public IP if none is provided. Note: Currently only supports at most one EIP allocation. | `list(string)` | `[]` | no | @@ -82,7 +82,7 @@ module "fck-nat" { | [name](#input\_name) | Name used for resources created within the module | `string` | n/a | yes | | [route\_table\_id](#input\_route\_table\_id) | Deprecated. Use route\_tables\_ids instead | `string` | `null` | no | | [route\_tables\_ids](#input\_route\_tables\_ids) | Route tables to update. Only valid if update\_route\_tables is true | `map(string)` | `{}` | no | -| [ssh\_cidr\_blocks](#input\_ssh\_cidr\_blocks) | CIDR blocks to allow SSH access to the NAT instance from | 
object({
    ipv4 = optional(list(string), [])
    ipv6 = optional(list(string), [])
  })
| 
{
  "ipv4": [],
  "ipv6": []
}
| no | +| [ssh\_cidr\_blocks](#input\_ssh\_cidr\_blocks) | CIDR blocks to allow SSH access to the NAT instance from | 
object({
    ipv4 = optional(list(string), [])
    ipv6 = optional(list(string), [])
  })
| 
{
  "ipv4": [],
  "ipv6": []
}
| no | | [ssh\_key\_name](#input\_ssh\_key\_name) | Name of the SSH key to use for the NAT instance. SSH access will be enabled only if a key name is provided | `string` | `null` | no | | [subnet\_id](#input\_subnet\_id) | Subnet ID to deploy the NAT instance into | `string` | n/a | yes | | [tags](#input\_tags) | Tags to apply to resources created within the module | `map(string)` | `{}` | no |