diff --git a/examples/basic_usage/README.md b/examples/basic_usage/README.md index e3b8522..9289356 100644 --- a/examples/basic_usage/README.md +++ b/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. |