From 5a6d66a50e82ca408b43e3d2161a53ba293adc2d Mon Sep 17 00:00:00 2001 From: Nicholas McDonnell <50747025+mcdonnnj@users.noreply.github.com> Date: Mon, 24 May 2021 15:12:18 -0400 Subject: [PATCH] Update the README Include the changes made here as well as match all the information we typically include now. --- README.md | 31 +++++++++++++++++++++---------- 1 file changed, 21 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f32856f..0e7d38b 100644 --- a/README.md +++ b/README.md @@ -48,25 +48,36 @@ module "example" { |------|---------| | aws | ~> 3.0 | +## Modules ## + +No modules. + +## Resources ## + +| Name | Type | +|------|------| +| [aws_instance.example](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/instance) | resource | +| [aws_ami.example](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) | data source | + ## Inputs ## | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| -| ami_owner_account_id | The ID of the AWS account that owns the Example AMI, or "self" if the AMI is owned by the same account as the provisioner. | `string` | `self` | no | -| aws_availability_zone | The AWS availability zone to deploy into (e.g. a, b, c, etc.) | `string` | `a` | no | -| aws_region | The AWS region to deploy into (e.g. us-east-1) | `string` | `us-east-1` | no | -| subnet_id | The ID of the AWS subnet to deploy into (e.g. subnet-0123456789abcdef0) | `string` | n/a | yes | -| tags | Tags to apply to all AWS resources created | `map(string)` | `{}` | no | +| ami\_owner\_account\_id | The ID of the AWS account that owns the Example AMI, or "self" if the AMI is owned by the same account as the provisioner. | `string` | `"self"` | no | +| aws\_availability\_zone | The AWS availability zone to deploy into (e.g. a, b, c, etc.). | `string` | `"a"` | no | +| aws\_region | The AWS region to deploy into (e.g. us-east-1). | `string` | `"us-east-1"` | no | +| subnet\_id | The ID of the AWS subnet to deploy into (e.g. subnet-0123456789abcdef0). | `string` | n/a | yes | +| tags | Tags to apply to all AWS resources created. | `map(string)` | `{}` | no | ## Outputs ## | Name | Description | |------|-------------| -| arn | The EC2 instance ARN | -| availability_zone | The AZ where the EC2 instance is deployed | -| id | The EC2 instance ID | -| private_ip | The private IP of the EC2 instance | -| subnet_id | The ID of the subnet where the EC2 instance is deployed | +| arn | The EC2 instance ARN. | +| availability\_zone | The AZ where the EC2 instance is deployed. | +| id | The EC2 instance ID. | +| private\_ip | The private IP of the EC2 instance. | +| subnet\_id | The ID of the subnet where the EC2 instance is deployed. | ## Notes ##