Skip to content

Commit 9bd94bd

Browse files
committed
chore: update pre-commit hook version and update docs via terraform_docs
1 parent 947bc1f commit 9bd94bd

File tree

6 files changed

+140
-6
lines changed

6 files changed

+140
-6
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
repos:
22
- repo: git://github.com/antonbabenko/pre-commit-terraform
3-
rev: v1.45.0
3+
rev: v1.47.0
44
hooks:
55
- id: terraform_fmt
66
- id: terraform_docs

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,23 @@ Examples codified under the [`examples`](./examples) are intended to give users
6767
|------|---------|
6868
| aws | >= 3.9 |
6969

70+
## Modules
71+
72+
No Modules.
73+
74+
## Resources
75+
76+
| Name |
77+
|------|
78+
| [aws_cloudwatch_log_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) |
79+
| [aws_db_proxy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_proxy) |
80+
| [aws_db_proxy_default_target_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_proxy_default_target_group) |
81+
| [aws_db_proxy_target](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_proxy_target) |
82+
| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) |
83+
| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) |
84+
| [aws_iam_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) |
85+
| [aws_region](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) |
86+
7087
## Inputs
7188

7289
| Name | Description | Type | Default | Required |
@@ -133,7 +150,6 @@ Examples codified under the [`examples`](./examples) are intended to give users
133150
| proxy\_target\_target\_arn | Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API |
134151
| 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 |
135152
| proxy\_target\_type | Type of target. e.g. `RDS_INSTANCE` or `TRACKED_CLUSTER` |
136-
137153
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
138154

139155
## License

examples/mysql_iam_cluster/README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,37 @@ An EC2 instance configuration has been provided for use in validating the exampl
4040
| aws | >= 3.9 |
4141
| random | n/a |
4242

43+
## Modules
44+
45+
| Name | Source | Version |
46+
|------|--------|---------|
47+
| ec2_instance | terraform-aws-modules/ec2-instance/aws | 2.16.0 |
48+
| ec2_sg | terraform-aws-modules/security-group/aws | 3.17.0 |
49+
| rds | terraform-aws-modules/rds-aurora/aws | 3.0.0 |
50+
| rds_proxy | ../../ | |
51+
| rds_proxy_sg | terraform-aws-modules/security-group/aws | 3.17.0 |
52+
| vpc | terraform-aws-modules/vpc/aws | 2.64.0 |
53+
54+
## Resources
55+
56+
| Name |
57+
|------|
58+
| [aws_ami](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) |
59+
| [aws_caller_identity](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) |
60+
| [aws_db_parameter_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_parameter_group) |
61+
| [aws_iam_instance_profile](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) |
62+
| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) |
63+
| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) |
64+
| [aws_iam_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) |
65+
| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) |
66+
| [aws_kms_alias](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/kms_alias) |
67+
| [aws_rds_cluster_parameter_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/rds_cluster_parameter_group) |
68+
| [aws_region](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) |
69+
| [aws_secretsmanager_secret](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret) |
70+
| [aws_secretsmanager_secret_version](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret_version) |
71+
| [random_password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) |
72+
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
73+
4374
## Inputs
4475

4576
No input.
@@ -65,7 +96,6 @@ No input.
6596
| superuser\_db\_password\_connect | Connect to database using superuser with username/password directly to database |
6697
| superuser\_proxy\_iam\_connect | Connect to RDS Proxy using IAM auth via token generated |
6798
| superuser\_proxy\_iam\_token | Gerate connection token for connecting to RDS Proxy with IAM auth |
68-
6999
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
70100

71101
Apache-2.0 Licensed. See [LICENSE](../../LICENSE).

examples/mysql_iam_instance/README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,36 @@ An EC2 instance configuration has been provided for use in validating the exampl
4040
| aws | >= 3.9 |
4141
| random | n/a |
4242

43+
## Modules
44+
45+
| Name | Source | Version |
46+
|------|--------|---------|
47+
| ec2_instance | terraform-aws-modules/ec2-instance/aws | 2.16.0 |
48+
| ec2_sg | terraform-aws-modules/security-group/aws | 3.17.0 |
49+
| rds | terraform-aws-modules/rds/aws | 2.20.0 |
50+
| rds_proxy | ../../ | |
51+
| rds_proxy_sg | terraform-aws-modules/security-group/aws | 3.17.0 |
52+
| rds_sg | terraform-aws-modules/security-group/aws | 3.17.0 |
53+
| vpc | terraform-aws-modules/vpc/aws | 2.64.0 |
54+
55+
## Resources
56+
57+
| Name |
58+
|------|
59+
| [aws_ami](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) |
60+
| [aws_caller_identity](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) |
61+
| [aws_iam_instance_profile](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) |
62+
| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) |
63+
| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) |
64+
| [aws_iam_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) |
65+
| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) |
66+
| [aws_kms_alias](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/kms_alias) |
67+
| [aws_region](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) |
68+
| [aws_secretsmanager_secret](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret) |
69+
| [aws_secretsmanager_secret_version](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret_version) |
70+
| [random_password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) |
71+
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
72+
4373
## Inputs
4474

4575
No input.
@@ -65,7 +95,6 @@ No input.
6595
| superuser\_db\_password\_connect | Connect to database using superuser with username/password directly to database |
6696
| superuser\_proxy\_iam\_connect | Connect to RDS Proxy using IAM auth via token generated |
6797
| superuser\_proxy\_iam\_token | Gerate connection token for connecting to RDS Proxy with IAM auth |
68-
6998
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
7099

71100
Apache-2.0 Licensed. See [LICENSE](../../LICENSE).

examples/postgresql_iam_cluster/README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,37 @@ An EC2 instance configuration has been provided for use in validating the exampl
4040
| aws | >= 3.9 |
4141
| random | n/a |
4242

43+
## Modules
44+
45+
| Name | Source | Version |
46+
|------|--------|---------|
47+
| ec2_instance | terraform-aws-modules/ec2-instance/aws | 2.16.0 |
48+
| ec2_sg | terraform-aws-modules/security-group/aws | 3.17.0 |
49+
| rds | terraform-aws-modules/rds-aurora/aws | 3.0.0 |
50+
| rds_proxy | ../../ | |
51+
| rds_proxy_sg | terraform-aws-modules/security-group/aws | 3.17.0 |
52+
| vpc | terraform-aws-modules/vpc/aws | 2.64.0 |
53+
54+
## Resources
55+
56+
| Name |
57+
|------|
58+
| [aws_ami](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) |
59+
| [aws_caller_identity](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) |
60+
| [aws_db_parameter_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_parameter_group) |
61+
| [aws_iam_instance_profile](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) |
62+
| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) |
63+
| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) |
64+
| [aws_iam_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) |
65+
| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) |
66+
| [aws_kms_alias](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/kms_alias) |
67+
| [aws_rds_cluster_parameter_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/rds_cluster_parameter_group) |
68+
| [aws_region](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) |
69+
| [aws_secretsmanager_secret](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret) |
70+
| [aws_secretsmanager_secret_version](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret_version) |
71+
| [random_password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) |
72+
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
73+
4374
## Inputs
4475

4576
No input.
@@ -65,7 +96,6 @@ No input.
6596
| superuser\_db\_password\_connect | Connect to database using superuser with username/password directly to database |
6697
| superuser\_proxy\_iam\_connect | Connect to RDS Proxy using IAM auth via token generated |
6798
| superuser\_proxy\_iam\_token | Gerate connection token for connecting to RDS Proxy with IAM auth |
68-
6999
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
70100

71101
Apache-2.0 Licensed. See [LICENSE](../../LICENSE).

examples/postgresql_iam_instance/README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,36 @@ An EC2 instance configuration has been provided for use in validating the exampl
4040
| aws | >= 3.9 |
4141
| random | n/a |
4242

43+
## Modules
44+
45+
| Name | Source | Version |
46+
|------|--------|---------|
47+
| ec2_instance | terraform-aws-modules/ec2-instance/aws | 2.16.0 |
48+
| ec2_sg | terraform-aws-modules/security-group/aws | 3.17.0 |
49+
| rds | terraform-aws-modules/rds/aws | 2.20.0 |
50+
| rds_proxy | ../../ | |
51+
| rds_proxy_sg | terraform-aws-modules/security-group/aws | 3.17.0 |
52+
| rds_sg | terraform-aws-modules/security-group/aws | 3.17.0 |
53+
| vpc | terraform-aws-modules/vpc/aws | 2.64.0 |
54+
55+
## Resources
56+
57+
| Name |
58+
|------|
59+
| [aws_ami](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) |
60+
| [aws_caller_identity](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) |
61+
| [aws_iam_instance_profile](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) |
62+
| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) |
63+
| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) |
64+
| [aws_iam_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) |
65+
| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) |
66+
| [aws_kms_alias](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/kms_alias) |
67+
| [aws_region](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) |
68+
| [aws_secretsmanager_secret](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret) |
69+
| [aws_secretsmanager_secret_version](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret_version) |
70+
| [random_password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) |
71+
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
72+
4373
## Inputs
4474

4575
No input.
@@ -65,7 +95,6 @@ No input.
6595
| superuser\_db\_password\_connect | Connect to database using superuser with username/password directly to database |
6696
| superuser\_proxy\_iam\_connect | Connect to RDS Proxy using IAM auth via token generated |
6797
| superuser\_proxy\_iam\_token | Gerate connection token for connecting to RDS Proxy with IAM auth |
68-
6998
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
7099

71100
Apache-2.0 Licensed. See [LICENSE](../../LICENSE).

0 commit comments

Comments
 (0)