Skip to content

Commit c9b6109

Browse files
jasonwalshjasonwalsh
committed
docs: update README
1 parent bce7506 commit c9b6109

File tree

1 file changed

+28
-26
lines changed

1 file changed

+28
-26
lines changed

‎README.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The following example creates a security group and an application load balancer.
2020
provider "aws" {}
2121
2222
module "networking" {
23-
source = "github.com/mongodb-devprod-infrastructure/terraform-aws-networking-data-only"
23+
source = "github.com/mongodb-devprod-infrastructure/terraform-aws-networking-data-only"
2424
2525
vpc_name = "tutorial-vpc"
2626
}
@@ -47,50 +47,52 @@ resource "aws_lb" "this" {
4747
```
4848

4949
<!-- BEGIN_TF_DOCS -->
50+
5051
## Requirements
5152

52-
| Name | Version |
53-
|------|---------|
54-
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
55-
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.64.2 |
53+
| Name | Version |
54+
| ------------------------------------------------------------------------ | --------- |
55+
| <a name="requirement_terraform"></a> [terraform](#requirement_terraform) | >= 1.0 |
56+
| <a name="requirement_aws"></a> [aws](#requirement_aws) | >= 3.64.2 |
5657

5758
## Providers
5859

59-
| Name | Version |
60-
|------|---------|
61-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 3.70.0 |
60+
| Name | Version |
61+
| ------------------------------------------------ | ------- |
62+
| <a name="provider_aws"></a> [aws](#provider_aws) | 3.70.0 |
6263

6364
## Modules
6465

6566
No modules.
6667

6768
## Resources
6869

69-
| Name | Type |
70-
|------|------|
70+
| Name | Type |
71+
| -------------------------------------------------------------------------------------------------------------------------------- | ----------- |
7172
| [aws_availability_zones.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source |
72-
| [aws_subnet.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/subnet) | data source |
73-
| [aws_subnet_ids.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/subnet_ids) | data source |
74-
| [aws_vpc.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | data source |
73+
| [aws_subnet.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/subnet) | data source |
74+
| [aws_subnet_ids.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/subnet_ids) | data source |
75+
| [aws_vpc.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | data source |
7576

7677
## Inputs
7778

78-
| Name | Description | Type | Default | Required |
79-
|------|-------------|------|---------|:--------:|
80-
| <a name="input_availability_zones"></a> [availability\_zones](#input\_availability\_zones) | Select subnets only in the given AZs | `set(string)` | `[]` | no |
81-
| <a name="input_vpc_name"></a> [vpc\_name](#input\_vpc\_name) | The name of the VPC | `string` | n/a | yes |
79+
| Name | Description | Type | Default | Required |
80+
| --------------------------------------------------------------------------------------- | ------------------------------------ | ------------- | ------- | :------: |
81+
| <a name="input_availability_zones"></a> [availability_zones](#input_availability_zones) | Select subnets only in the given AZs | `set(string)` | `[]` | no |
82+
| <a name="input_vpc_name"></a> [vpc_name](#input_vpc_name) | The name of the VPC | `string` | n/a | yes |
8283

8384
## Outputs
8485

85-
| Name | Description |
86-
|------|-------------|
87-
| <a name="output_dns_hostnames_enabled"></a> [dns\_hostnames\_enabled](#output\_dns\_hostnames\_enabled) | Indicates if instances launched in this VPC will have public DNS hostnames |
88-
| <a name="output_dns_support_enabled"></a> [dns\_support\_enabled](#output\_dns\_support\_enabled) | Indicates if DNS support is enabled for this VPC |
89-
| <a name="output_private_subnets"></a> [private\_subnets](#output\_private\_subnets) | List of private subnets in this VPC |
90-
| <a name="output_public_subnets"></a> [public\_subnets](#output\_public\_subnets) | List of public subnets in this VPC |
91-
| <a name="output_vpc_arn"></a> [vpc\_arn](#output\_vpc\_arn) | Arn of this VPC |
92-
| <a name="output_vpc_cidr_block"></a> [vpc\_cidr\_block](#output\_vpc\_cidr\_block) | CIDR range for this VPC |
93-
| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | The ID of the VPC |
86+
| Name | Description |
87+
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
88+
| <a name="output_dns_hostnames_enabled"></a> [dns_hostnames_enabled](#output_dns_hostnames_enabled) | Indicates if instances launched in this VPC will have public DNS hostnames |
89+
| <a name="output_dns_support_enabled"></a> [dns_support_enabled](#output_dns_support_enabled) | Indicates if DNS support is enabled for this VPC |
90+
| <a name="output_private_subnets"></a> [private_subnets](#output_private_subnets) | List of private subnets in this VPC |
91+
| <a name="output_public_subnets"></a> [public_subnets](#output_public_subnets) | List of public subnets in this VPC |
92+
| <a name="output_vpc_arn"></a> [vpc_arn](#output_vpc_arn) | Arn of this VPC |
93+
| <a name="output_vpc_cidr_block"></a> [vpc_cidr_block](#output_vpc_cidr_block) | CIDR range for this VPC |
94+
| <a name="output_vpc_id"></a> [vpc_id](#output_vpc_id) | The ID of the VPC |
95+
9496
<!-- END_TF_DOCS -->
9597

9698
## Contributing

0 commit comments

Comments
 (0)