Minor Updates to Reflect Common Changes in Downstream Projects

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 ##
 

examples/basic_usage/README.md

@@ -18,21 +18,34 @@ No requirements.
 |------|---------|
 | aws | n/a |
 
+## Modules ##
+
+| Name | Source | Version |
+|------|--------|---------|
+| example | ../../ |  |
+
+## Resources ##
+
+| Name | Type |
+|------|------|
+| [aws_subnet.example](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/subnet) | resource |
+| [aws_vpc.example](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc) | resource |
+
 ## Inputs ##
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| ami_owner_account_id | The ID of the AWS account that owns the 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 |
-| tf_role_arn | The ARN of the role that can terraform non-specialized resources. | `string` | n/a | yes |
+| ami\_owner\_account\_id | The ID of the AWS account that owns the 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 |
+| tf\_role\_arn | The ARN of the role that can terraform non-specialized resources. | `string` | n/a | yes |
 
 ## 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. |

examples/basic_usage/outputs.tf

@@ -1,24 +1,24 @@
-output "id" {
-  value       = module.example.id
-  description = "The EC2 instance ID"
-}
-
 output "arn" {
   value       = module.example.arn
-  description = "The EC2 instance ARN"
+  description = "The EC2 instance ARN."
 }
 
 output "availability_zone" {
   value       = module.example.availability_zone
-  description = "The AZ where the EC2 instance is deployed"
+  description = "The AZ where the EC2 instance is deployed."
+}
+
+output "id" {
+  value       = module.example.id
+  description = "The EC2 instance ID."
 }
 
 output "private_ip" {
   value       = module.example.private_ip
-  description = "The private IP of the EC2 instance"
+  description = "The private IP of the EC2 instance."
 }
 
 output "subnet_id" {
   value       = module.example.subnet_id
-  description = "The ID of the subnet where the EC2 instance is deployed"
+  description = "The ID of the subnet where the EC2 instance is deployed."
 }

examples/basic_usage/variables.tf

@@ -23,7 +23,7 @@ variable "ami_owner_account_id" {
 
 variable "aws_availability_zone" {
   type        = string
-  description = "The AWS availability zone to deploy into (e.g. a, b, c, etc.)"
+  description = "The AWS availability zone to deploy into (e.g. a, b, c, etc.)."
   default     = "a"
 }
 

outputs.tf

@@ -1,24 +1,24 @@
 output "arn" {
   value       = aws_instance.example.arn
-  description = "The EC2 instance ARN"
+  description = "The EC2 instance ARN."
 }
 
 output "availability_zone" {
   value       = aws_instance.example.availability_zone
-  description = "The AZ where the EC2 instance is deployed"
+  description = "The AZ where the EC2 instance is deployed."
 }
 
 output "id" {
   value       = aws_instance.example.id
-  description = "The EC2 instance ID"
+  description = "The EC2 instance ID."
 }
 
 output "private_ip" {
   value       = aws_instance.example.private_ip
-  description = "The private IP of the EC2 instance"
+  description = "The private IP of the EC2 instance."
 }
 
 output "subnet_id" {
   value       = aws_instance.example.subnet_id
-  description = "The ID of the subnet where the EC2 instance is deployed"
+  description = "The ID of the subnet where the EC2 instance is deployed."
 }

variables.tf

@@ -6,7 +6,7 @@
 
 variable "subnet_id" {
   type        = string
-  description = "The ID of the AWS subnet to deploy into (e.g. subnet-0123456789abcdef0)"
+  description = "The ID of the AWS subnet to deploy into (e.g. subnet-0123456789abcdef0)."
 }
 
 # ------------------------------------------------------------------------------
@@ -22,18 +22,18 @@ variable "ami_owner_account_id" {
 
 variable "aws_availability_zone" {
   type        = string
-  description = "The AWS availability zone to deploy into (e.g. a, b, c, etc.)"
+  description = "The AWS availability zone to deploy into (e.g. a, b, c, etc.)."
   default     = "a"
 }
 
 variable "aws_region" {
   type        = string
-  description = "The AWS region to deploy into (e.g. us-east-1)"
+  description = "The AWS region to deploy into (e.g. us-east-1)."
   default     = "us-east-1"
 }
 
 variable "tags" {
   type        = map(string)
-  description = "Tags to apply to all AWS resources created"
+  description = "Tags to apply to all AWS resources created."
   default     = {}
 }