From 3d2ce62a8f350cfe94c93af134984875ceb35f72 Mon Sep 17 00:00:00 2001 From: Ryan Parman Date: Tue, 26 Mar 2024 14:17:41 -0600 Subject: [PATCH] Updated the 'sales pitch' in the README. --- README.md | 102 ++++++++++++++++++++++++++---------------------------- 1 file changed, 50 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 5b2acfa..53fa1c0 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,7 @@ Simplifies the process of discovering AWS networking data for Northwood Labs res * Only looks-up data, but does not persist any data itself, making it completely stateless. -* Purpose-built, meaning that it is designed to solve a single orthogonal problem. - -* You can’t please everyone all the time, so don’t try. Aims to fit 90% of use-cases. The other 10% can be addressed with alternate or custom solutions. +* Purpose-built, meaning that it is designed to solve a single orthogonal problem. Aims to fit 90% of use-cases. ## Examples @@ -54,10 +52,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.42` | +| Name | Provider | Version | +|-------------|------------------------------------------------------------------------------------|-----------| +| `terraform` | | `~> 1.6` | +| `aws` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | `~> 5.42` | ## Inputs @@ -66,54 +64,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) | `igw` | [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) | `nacl` | [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) | `vpc` | [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) | `igw` | [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) | `nacl` | [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) | `vpc` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | ## Testing