From 9bd94bdf43ec84b98c9b2941f3dbc238f0b5857e Mon Sep 17 00:00:00 2001 From: Bryant Biggs Date: Tue, 2 Mar 2021 18:01:44 -0500 Subject: [PATCH] chore: update pre-commit hook version and update docs via `terraform_docs` --- .pre-commit-config.yaml | 2 +- README.md | 18 +++++++++++- examples/mysql_iam_cluster/README.md | 32 +++++++++++++++++++++- examples/mysql_iam_instance/README.md | 31 ++++++++++++++++++++- examples/postgresql_iam_cluster/README.md | 32 +++++++++++++++++++++- examples/postgresql_iam_instance/README.md | 31 ++++++++++++++++++++- 6 files changed, 140 insertions(+), 6 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 9d4495b..ac3906a 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,6 @@ repos: - repo: git://github.com/antonbabenko/pre-commit-terraform - rev: v1.45.0 + rev: v1.47.0 hooks: - id: terraform_fmt - id: terraform_docs diff --git a/README.md b/README.md index 5f86b0e..cd04725 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,23 @@ Examples codified under the [`examples`](./examples) are intended to give users |------|---------| | aws | >= 3.9 | +## Modules + +No Modules. + +## Resources + +| Name | +|------| +| [aws_cloudwatch_log_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | +| [aws_db_proxy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_proxy) | +| [aws_db_proxy_default_target_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_proxy_default_target_group) | +| [aws_db_proxy_target](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_proxy_target) | +| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | +| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | +| [aws_iam_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | +| [aws_region](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | + ## Inputs | Name | Description | Type | Default | Required | @@ -133,7 +150,6 @@ Examples codified under the [`examples`](./examples) are intended to give users | proxy\_target\_target\_arn | Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API | | proxy\_target\_tracked\_cluster\_id | DB Cluster identifier for the DB Instance target. Not returned unless manually importing an RDS\_INSTANCE target that is part of a DB Cluster | | proxy\_target\_type | Type of target. e.g. `RDS_INSTANCE` or `TRACKED_CLUSTER` | - ## License diff --git a/examples/mysql_iam_cluster/README.md b/examples/mysql_iam_cluster/README.md index 435890b..cc05ef1 100644 --- a/examples/mysql_iam_cluster/README.md +++ b/examples/mysql_iam_cluster/README.md @@ -40,6 +40,37 @@ An EC2 instance configuration has been provided for use in validating the exampl | aws | >= 3.9 | | random | n/a | +## Modules + +| Name | Source | Version | +|------|--------|---------| +| ec2_instance | terraform-aws-modules/ec2-instance/aws | 2.16.0 | +| ec2_sg | terraform-aws-modules/security-group/aws | 3.17.0 | +| rds | terraform-aws-modules/rds-aurora/aws | 3.0.0 | +| rds_proxy | ../../ | | +| rds_proxy_sg | terraform-aws-modules/security-group/aws | 3.17.0 | +| vpc | terraform-aws-modules/vpc/aws | 2.64.0 | + +## Resources + +| Name | +|------| +| [aws_ami](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) | +| [aws_caller_identity](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | +| [aws_db_parameter_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_parameter_group) | +| [aws_iam_instance_profile](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) | +| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | +| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | +| [aws_iam_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | +| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | +| [aws_kms_alias](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/kms_alias) | +| [aws_rds_cluster_parameter_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/rds_cluster_parameter_group) | +| [aws_region](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | +| [aws_secretsmanager_secret](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret) | +| [aws_secretsmanager_secret_version](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret_version) | +| [random_password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | +| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | + ## Inputs No input. @@ -65,7 +96,6 @@ No input. | superuser\_db\_password\_connect | Connect to database using superuser with username/password directly to database | | superuser\_proxy\_iam\_connect | Connect to RDS Proxy using IAM auth via token generated | | superuser\_proxy\_iam\_token | Gerate connection token for connecting to RDS Proxy with IAM auth | - Apache-2.0 Licensed. See [LICENSE](../../LICENSE). diff --git a/examples/mysql_iam_instance/README.md b/examples/mysql_iam_instance/README.md index d05c5c6..d06d440 100644 --- a/examples/mysql_iam_instance/README.md +++ b/examples/mysql_iam_instance/README.md @@ -40,6 +40,36 @@ An EC2 instance configuration has been provided for use in validating the exampl | aws | >= 3.9 | | random | n/a | +## Modules + +| Name | Source | Version | +|------|--------|---------| +| ec2_instance | terraform-aws-modules/ec2-instance/aws | 2.16.0 | +| ec2_sg | terraform-aws-modules/security-group/aws | 3.17.0 | +| rds | terraform-aws-modules/rds/aws | 2.20.0 | +| rds_proxy | ../../ | | +| rds_proxy_sg | terraform-aws-modules/security-group/aws | 3.17.0 | +| rds_sg | terraform-aws-modules/security-group/aws | 3.17.0 | +| vpc | terraform-aws-modules/vpc/aws | 2.64.0 | + +## Resources + +| Name | +|------| +| [aws_ami](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) | +| [aws_caller_identity](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | +| [aws_iam_instance_profile](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) | +| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | +| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | +| [aws_iam_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | +| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | +| [aws_kms_alias](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/kms_alias) | +| [aws_region](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | +| [aws_secretsmanager_secret](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret) | +| [aws_secretsmanager_secret_version](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret_version) | +| [random_password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | +| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | + ## Inputs No input. @@ -65,7 +95,6 @@ No input. | superuser\_db\_password\_connect | Connect to database using superuser with username/password directly to database | | superuser\_proxy\_iam\_connect | Connect to RDS Proxy using IAM auth via token generated | | superuser\_proxy\_iam\_token | Gerate connection token for connecting to RDS Proxy with IAM auth | - Apache-2.0 Licensed. See [LICENSE](../../LICENSE). diff --git a/examples/postgresql_iam_cluster/README.md b/examples/postgresql_iam_cluster/README.md index 59437e8..299777c 100644 --- a/examples/postgresql_iam_cluster/README.md +++ b/examples/postgresql_iam_cluster/README.md @@ -40,6 +40,37 @@ An EC2 instance configuration has been provided for use in validating the exampl | aws | >= 3.9 | | random | n/a | +## Modules + +| Name | Source | Version | +|------|--------|---------| +| ec2_instance | terraform-aws-modules/ec2-instance/aws | 2.16.0 | +| ec2_sg | terraform-aws-modules/security-group/aws | 3.17.0 | +| rds | terraform-aws-modules/rds-aurora/aws | 3.0.0 | +| rds_proxy | ../../ | | +| rds_proxy_sg | terraform-aws-modules/security-group/aws | 3.17.0 | +| vpc | terraform-aws-modules/vpc/aws | 2.64.0 | + +## Resources + +| Name | +|------| +| [aws_ami](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) | +| [aws_caller_identity](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | +| [aws_db_parameter_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_parameter_group) | +| [aws_iam_instance_profile](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) | +| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | +| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | +| [aws_iam_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | +| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | +| [aws_kms_alias](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/kms_alias) | +| [aws_rds_cluster_parameter_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/rds_cluster_parameter_group) | +| [aws_region](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | +| [aws_secretsmanager_secret](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret) | +| [aws_secretsmanager_secret_version](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret_version) | +| [random_password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | +| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | + ## Inputs No input. @@ -65,7 +96,6 @@ No input. | superuser\_db\_password\_connect | Connect to database using superuser with username/password directly to database | | superuser\_proxy\_iam\_connect | Connect to RDS Proxy using IAM auth via token generated | | superuser\_proxy\_iam\_token | Gerate connection token for connecting to RDS Proxy with IAM auth | - Apache-2.0 Licensed. See [LICENSE](../../LICENSE). diff --git a/examples/postgresql_iam_instance/README.md b/examples/postgresql_iam_instance/README.md index 3df47bd..5247401 100644 --- a/examples/postgresql_iam_instance/README.md +++ b/examples/postgresql_iam_instance/README.md @@ -40,6 +40,36 @@ An EC2 instance configuration has been provided for use in validating the exampl | aws | >= 3.9 | | random | n/a | +## Modules + +| Name | Source | Version | +|------|--------|---------| +| ec2_instance | terraform-aws-modules/ec2-instance/aws | 2.16.0 | +| ec2_sg | terraform-aws-modules/security-group/aws | 3.17.0 | +| rds | terraform-aws-modules/rds/aws | 2.20.0 | +| rds_proxy | ../../ | | +| rds_proxy_sg | terraform-aws-modules/security-group/aws | 3.17.0 | +| rds_sg | terraform-aws-modules/security-group/aws | 3.17.0 | +| vpc | terraform-aws-modules/vpc/aws | 2.64.0 | + +## Resources + +| Name | +|------| +| [aws_ami](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) | +| [aws_caller_identity](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | +| [aws_iam_instance_profile](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) | +| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | +| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | +| [aws_iam_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | +| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | +| [aws_kms_alias](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/kms_alias) | +| [aws_region](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | +| [aws_secretsmanager_secret](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret) | +| [aws_secretsmanager_secret_version](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret_version) | +| [random_password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | +| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | + ## Inputs No input. @@ -65,7 +95,6 @@ No input. | superuser\_db\_password\_connect | Connect to database using superuser with username/password directly to database | | superuser\_proxy\_iam\_connect | Connect to RDS Proxy using IAM auth via token generated | | superuser\_proxy\_iam\_token | Gerate connection token for connecting to RDS Proxy with IAM auth | - Apache-2.0 Licensed. See [LICENSE](../../LICENSE).