From 1055920c20347c5d0c540742e92c8eaeb68f9794 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 26 Mar 2024 20:04:57 +0000 Subject: [PATCH] docs: Generate documentation in README.md Signed-off-by: github-actions[bot] --- README.md | 98 +++++++++++++++++++++++++++---------------------------- 1 file changed, 49 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 2c7909d..b7a76ba 100644 --- a/README.md +++ b/README.md @@ -48,10 +48,10 @@ resource "aws_lambda_function" "test_lambda" { ## Requirements -| Name | Provider | Version | -|-------------|------------------------------------------------------------------------------------|----------| -| `terraform` | | `~> 1.6` | -| `aws` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | `~> 5.0` | +| Name | Provider | Version | +|------|----------|---------| +| `terraform` | | `~> 1.6` | +| `aws` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | `~> 5.42` | ## Inputs @@ -60,54 +60,54 @@ resource "aws_lambda_function" "test_lambda" { ## Outputs -| Name | Description | -|------------------------|----------------------------------------------------------------------------| -| `internet_gateway` | An object containing all data for this internet gateway. | -| `internet_gateway_arn` | The ARN of this internet gateway. | -| `internet_gateway_id` | The ID of this internet gateway. | -| `nacl` | An object containing all data for this Network Access Control List (NACL). | -| `nacl_ids` | List of all Network Access Control List (NACL) IDs in the VPC. | -| `route_table` | An object containing all data for this route table. | -| `route_table_arn` | The ARN of this route table. | -| `route_table_id` | The ID of this route table. | -| `subnet_ids` | List of all Subnet IDs in the VPC. | -| `subnet_int_a` | An object containing all data for subnet A. | -| `subnet_int_a_arn` | The ARN of subnet A. | -| `subnet_int_a_cidr` | The Availability Zone CIDR block of subnet A. | -| `subnet_int_a_id` | The ID of subnet A. | -| `subnet_int_a_zone` | The Availability Zone of subnet A. | -| `subnet_int_a_zone_id` | The Availability Zone ID of subnet A. | -| `subnet_int_b` | An object containing all data for subnet B. | -| `subnet_int_b_arn` | The ARN of subnet B. | -| `subnet_int_b_cidr` | The Availability Zone CIDR block of subnet B. | -| `subnet_int_b_id` | The ID of subnet B. | -| `subnet_int_b_zone` | The Availability Zone of subnet B. | -| `subnet_int_b_zone_id` | The Availability Zone ID of subnet B. | -| `subnet_int_c` | An object containing all data for subnet C. | -| `subnet_int_c_arn` | The ARN of subnet C. | -| `subnet_int_c_cidr` | The Availability Zone CIDR block of subnet C. | -| `subnet_int_c_id` | The ID of subnet C. | -| `subnet_int_c_zone` | The Availability Zone of subnet C. | -| `subnet_int_c_zone_id` | The Availability Zone ID of subnet C. | -| `vpc` | An object containing all VPC data. | -| `vpc_arn` | The ARN of the VPC in this account. | -| `vpc_cidr` | The CIDR of the VPC in this account. | -| `vpc_id` | The ID of the VPC in this account. | +| Name | Description | +|------|-------------| +| `internet_gateway` | An object containing all data for this internet gateway. | +| `internet_gateway_arn` | The ARN of this internet gateway. | +| `internet_gateway_id` | The ID of this internet gateway. | +| `nacl` | An object containing all data for this Network Access Control List (NACL). | +| `nacl_ids` | List of all Network Access Control List (NACL) IDs in the VPC. | +| `route_table` | An object containing all data for this route table. | +| `route_table_arn` | The ARN of this route table. | +| `route_table_id` | The ID of this route table. | +| `subnet_ids` | List of all Subnet IDs in the VPC. | +| `subnet_int_a` | An object containing all data for subnet A. | +| `subnet_int_a_arn` | The ARN of subnet A. | +| `subnet_int_a_cidr` | The Availability Zone CIDR block of subnet A. | +| `subnet_int_a_id` | The ID of subnet A. | +| `subnet_int_a_zone` | The Availability Zone of subnet A. | +| `subnet_int_a_zone_id` | The Availability Zone ID of subnet A. | +| `subnet_int_b` | An object containing all data for subnet B. | +| `subnet_int_b_arn` | The ARN of subnet B. | +| `subnet_int_b_cidr` | The Availability Zone CIDR block of subnet B. | +| `subnet_int_b_id` | The ID of subnet B. | +| `subnet_int_b_zone` | The Availability Zone of subnet B. | +| `subnet_int_b_zone_id` | The Availability Zone ID of subnet B. | +| `subnet_int_c` | An object containing all data for subnet C. | +| `subnet_int_c_arn` | The ARN of subnet C. | +| `subnet_int_c_cidr` | The Availability Zone CIDR block of subnet C. | +| `subnet_int_c_id` | The ID of subnet C. | +| `subnet_int_c_zone` | The Availability Zone of subnet C. | +| `subnet_int_c_zone_id` | The Availability Zone ID of subnet C. | +| `vpc` | An object containing all VPC data. | +| `vpc_arn` | The ARN of the VPC in this account. | +| `vpc_cidr` | The CIDR of the VPC in this account. | +| `vpc_id` | The ID of the VPC in this account. | ## Resources -| Kind | Source | Name | Provider | -|-------------|--------------------------------------------------------------------------------------------------------------------------------|----------------|------------------------------------------------------------------------------------| -| data source | [`data.aws_caller_identity`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | `current` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | -| data source | [`data.aws_internet_gateway`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/internet_gateway) | `default` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | -| data source | [`data.aws_network_acls`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/network_acls) | `default` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | -| data source | [`data.aws_region`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | `current` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | -| data source | [`data.aws_route_table`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/route_table) | `route_table` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | -| data source | [`data.aws_subnet`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/subnet) | `subnet_int_a` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | -| data source | [`data.aws_subnet`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/subnet) | `subnet_int_b` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | -| data source | [`data.aws_subnet`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/subnet) | `subnet_int_c` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | -| data source | [`data.aws_subnets`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/subnets) | `subnets` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | -| data source | [`data.aws_vpc`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | `default` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | +| Kind | Source | Name | Provider | +|------|--------|------|----------| +| data source | [`data.aws_caller_identity`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | `current` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | +| data source | [`data.aws_internet_gateway`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/internet_gateway) | `default` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | +| data source | [`data.aws_network_acls`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/network_acls) | `default` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | +| data source | [`data.aws_region`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | `current` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | +| data source | [`data.aws_route_table`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/route_table) | `route_table` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | +| data source | [`data.aws_subnet`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/subnet) | `subnet_int_a` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | +| data source | [`data.aws_subnet`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/subnet) | `subnet_int_b` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | +| data source | [`data.aws_subnet`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/subnet) | `subnet_int_c` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | +| data source | [`data.aws_subnets`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/subnets) | `subnets` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | +| data source | [`data.aws_vpc`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | `default` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | ## Testing