Commit bcaf08ef authored by Bryant Biggs's avatar Bryant Biggs Committed by GitHub

chore: update documentation based on latest `terraform-docs` which includes...

chore: update documentation based on latest `terraform-docs` which includes module and resource sections (#288)
parent 318b852a
......@@ -146,6 +146,19 @@ module "db" {
No provider.
## Modules
| Name | Source | Version |
|------|--------|---------|
| db_instance | ./modules/db_instance | |
| db_option_group | ./modules/db_option_group | |
| db_parameter_group | ./modules/db_parameter_group | |
| db_subnet_group | ./modules/db_subnet_group | |
## Resources
No resources.
## Inputs
| Name | Description | Type | Default | Required |
......@@ -241,7 +254,6 @@ No provider.
| this\_db\_parameter\_group\_id | The db parameter group id |
| this\_db\_subnet\_group\_arn | The ARN of the db subnet group |
| this\_db\_subnet\_group\_id | The db subnet group name |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Authors
......
......@@ -30,6 +30,24 @@ Note that this example may create resources which cost money. Run `terraform des
|------|---------|
| aws | >= 2.49 |
## Modules
| Name | Source | Version |
|------|--------|---------|
| db | ../../ | |
## Resources
| Name |
|------|
| [aws_directory_service_directory](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/resources/directory_service_directory) |
| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/iam_policy_document) |
| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/resources/iam_role) |
| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/resources/iam_role_policy_attachment) |
| [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/security_group) |
| [aws_subnet_ids](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/subnet_ids) |
| [aws_vpc](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/vpc) |
## Inputs
No input.
......@@ -56,5 +74,4 @@ No input.
| this\_db\_parameter\_group\_id | The db parameter group id |
| this\_db\_subnet\_group\_arn | The ARN of the db subnet group |
| this\_db\_subnet\_group\_id | The db subnet group name |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
......@@ -30,6 +30,20 @@ Note that this example may create resources which cost money. Run `terraform des
|------|---------|
| aws | >= 2.49 |
## Modules
| Name | Source | Version |
|------|--------|---------|
| db | ../../ | |
## Resources
| Name |
|------|
| [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/security_group) |
| [aws_subnet_ids](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/subnet_ids) |
| [aws_vpc](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/vpc) |
## Inputs
No input.
......@@ -54,5 +68,4 @@ No input.
| this\_db\_parameter\_group\_id | The db parameter group id |
| this\_db\_subnet\_group\_arn | The ARN of the db subnet group |
| this\_db\_subnet\_group\_id | The db subnet group name |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
......@@ -30,6 +30,20 @@ Note that this example may create resources which cost money. Run `terraform des
|------|---------|
| aws | >= 2.49 |
## Modules
| Name | Source | Version |
|------|--------|---------|
| db | ../../ | |
## Resources
| Name |
|------|
| [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/security_group) |
| [aws_subnet_ids](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/subnet_ids) |
| [aws_vpc](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/vpc) |
## Inputs
No input.
......@@ -54,5 +68,4 @@ No input.
| this\_db\_parameter\_group\_id | The db parameter group id |
| this\_db\_subnet\_group\_arn | The ARN of the db subnet group |
| this\_db\_subnet\_group\_id | The db subnet group name |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
......@@ -30,6 +30,20 @@ Note that this example may create resources which cost money. Run `terraform des
|------|---------|
| aws | >= 2.49 |
## Modules
| Name | Source | Version |
|------|--------|---------|
| db | ../../ | |
## Resources
| Name |
|------|
| [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/security_group) |
| [aws_subnet_ids](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/subnet_ids) |
| [aws_vpc](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/vpc) |
## Inputs
No input.
......@@ -54,5 +68,4 @@ No input.
| this\_db\_parameter\_group\_id | The db parameter group id |
| this\_db\_subnet\_group\_arn | The ARN of the db subnet group |
| this\_db\_subnet\_group\_id | The db subnet group name |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
......@@ -32,6 +32,23 @@ Note that this example may create resources which cost money. Run `terraform des
|------|---------|
| aws | >= 2.49 |
## Modules
| Name | Source | Version |
|------|--------|---------|
| db | ../../ | |
## Resources
| Name |
|------|
| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/iam_policy_document) |
| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/resources/iam_role) |
| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/resources/iam_role_policy_attachment) |
| [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/security_group) |
| [aws_subnet_ids](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/subnet_ids) |
| [aws_vpc](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/vpc) |
## Inputs
No input.
......@@ -56,5 +73,4 @@ No input.
| this\_db\_parameter\_group\_id | The db parameter group id |
| this\_db\_subnet\_group\_arn | The ARN of the db subnet group |
| this\_db\_subnet\_group\_id | The db subnet group name |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
......@@ -30,6 +30,21 @@ Note that this example may create resources which cost money. Run `terraform des
|------|---------|
| aws | >= 2.49 |
## Modules
| Name | Source | Version |
|------|--------|---------|
| master | ../../ | |
| replica | ../../ | |
## Resources
| Name |
|------|
| [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/security_group) |
| [aws_subnet_ids](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/subnet_ids) |
| [aws_vpc](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/vpc) |
## Inputs
No input.
......@@ -63,5 +78,4 @@ No input.
| replica\_db\_instance\_resource\_id | The RDS Resource ID of this instance |
| replica\_db\_instance\_status | The RDS instance status |
| replica\_db\_instance\_username | The replica username for the database |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
......@@ -30,6 +30,21 @@ Note that this example may create resources which cost money. Run `terraform des
|------|---------|
| aws | >= 2.49 |
## Modules
| Name | Source | Version |
|------|--------|---------|
| master | ../../ | |
| replica | ../../ | |
## Resources
| Name |
|------|
| [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/security_group) |
| [aws_subnet_ids](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/subnet_ids) |
| [aws_vpc](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/vpc) |
## Inputs
No input.
......@@ -63,5 +78,4 @@ No input.
| replica\_db\_instance\_resource\_id | The RDS Resource ID of this instance |
| replica\_db\_instance\_status | The RDS instance status |
| replica\_db\_instance\_username | The replica username for the database |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
......@@ -14,6 +14,19 @@
|------|---------|
| aws | >= 2.49 |
## Modules
No Modules.
## Resources
| Name |
|------|
| [aws_db_instance](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/resources/db_instance) |
| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/data-sources/iam_policy_document) |
| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/resources/iam_role) |
| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/resources/iam_role_policy_attachment) |
## Inputs
| Name | Description | Type | Default | Required |
......@@ -91,5 +104,4 @@
| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance |
| this\_db\_instance\_status | The RDS instance status |
| this\_db\_instance\_username | The master username for the database |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
......@@ -14,6 +14,16 @@
|------|---------|
| aws | >= 2.49 |
## Modules
No Modules.
## Resources
| Name |
|------|
| [aws_db_option_group](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/resources/db_option_group) |
## Inputs
| Name | Description | Type | Default | Required |
......@@ -34,5 +44,4 @@
|------|-------------|
| this\_db\_option\_group\_arn | The ARN of the db option group |
| this\_db\_option\_group\_id | The db option group id |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
......@@ -14,6 +14,16 @@
|------|---------|
| aws | >= 2.49 |
## Modules
No Modules.
## Resources
| Name |
|------|
| [aws_db_parameter_group](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/resources/db_parameter_group) |
## Inputs
| Name | Description | Type | Default | Required |
......@@ -34,5 +44,4 @@
|------|-------------|
| this\_db\_parameter\_group\_arn | The ARN of the db parameter group |
| this\_db\_parameter\_group\_id | The db parameter group id |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
......@@ -14,6 +14,16 @@
|------|---------|
| aws | >= 2.49 |
## Modules
No Modules.
## Resources
| Name |
|------|
| [aws_db_subnet_group](https://registry.terraform.io/providers/hashicorp/aws/2.49/docs/resources/db_subnet_group) |
## Inputs
| Name | Description | Type | Default | Required |
......@@ -30,5 +40,4 @@
|------|-------------|
| this\_db\_subnet\_group\_arn | The ARN of the db subnet group |
| this\_db\_subnet\_group\_id | The db subnet group name |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment