Skip to content

Commit b39ef30

Browse files
bryantbiggsbryantbiggs
committed
chore: update pre-commit versions and documentation using latest terraform_docs 
1 parent d06853f commit b39ef30

File tree

7 files changed

+127
-19
lines changed

7 files changed

+127
-19
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 & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,20 @@ Examples codified under the [`examples`](./examples) are intended to give users
7474
|------|---------|
7575
| aws | >= 3.0 |
7676

77+
## Modules
78+
79+
| Name | Source | Version |
80+
|------|--------|---------|
81+
| log_forwarder | ./modules/log_forwarder | |
82+
| rds_enhanced_monitoring_forwarder | ./modules/rds_enhanced_monitoring_forwarder | |
83+
| vpc_flow_log_forwarder | ./modules/vpc_flow_log_forwarder | |
84+
85+
## Resources
86+
87+
| Name |
88+
|------|
89+
| [aws_vpc_endpoint](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_endpoint) |
90+
7791
## Inputs
7892

7993
| Name | Description | Type | Default | Required |
@@ -234,7 +248,7 @@ Examples codified under the [`examples`](./examples) are intended to give users
234248
| log\_forwarder\_lambda\_arn | The ARN of the log forwarder lambda function |
235249
| log\_forwarder\_lambda\_kms\_key\_arn | (Optional) The ARN for the KMS encryption key for the log forwarder lambda function |
236250
| log\_forwarder\_lambda\_qualified\_arn | The ARN of the log forwarder lambda function (if versioning is enabled via publish = true) |
237-
| log\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the log forwarder zip file, provided either via filename or s3\_\* parameters |
251+
| log\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the log forwarder zip file, provided either via filename or s3\_* parameters |
238252
| log\_forwarder\_lambda\_version | Latest published version of the log forwarder lambda function |
239253
| log\_forwarder\_role\_arn | The log forwarder lambda role arn |
240254
| log\_forwarder\_role\_id | The log forwarder lambda role id |
@@ -266,7 +280,7 @@ Examples codified under the [`examples`](./examples) are intended to give users
266280
| rds\_em\_forwarder\_lambda\_arn | The ARN of the RDS enhanced monitoring forwarder lambda function |
267281
| rds\_em\_forwarder\_lambda\_kms\_key\_arn | (Optional) The ARN for the KMS encryption key for the RDS enhanced monitoring forwarder lambda function |
268282
| rds\_em\_forwarder\_lambda\_qualified\_arn | The ARN of the RDS enhanced monitoring forwarder lambda function (if versioning is enabled via publish = true) |
269-
| rds\_em\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the RDS enhanced monitoring lambda forwarder zip file, provided either via filename or s3\_\* parameters |
283+
| rds\_em\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the RDS enhanced monitoring lambda forwarder zip file, provided either via filename or s3\_* parameters |
270284
| rds\_em\_forwarder\_lambda\_version | Latest published version of the RDS enhanced monitoring forwarder lambda function |
271285
| rds\_em\_forwarder\_role\_arn | The RDS enhanced monitoring forwarder lambda role arn |
272286
| rds\_em\_forwarder\_role\_id | The RDS enhanced monitoring forwarder lambda role id |
@@ -285,7 +299,7 @@ Examples codified under the [`examples`](./examples) are intended to give users
285299
| vpc\_fl\_forwarder\_lambda\_arn | The ARN of the VPC flow log forwarder lambda function |
286300
| vpc\_fl\_forwarder\_lambda\_kms\_key\_arn | (Optional) The ARN for the KMS encryption key for the VPC flow log forwarder lambda function |
287301
| vpc\_fl\_forwarder\_lambda\_qualified\_arn | The ARN of the VPC flow log forwarder lambda function (if versioning is enabled via publish = true) |
288-
| vpc\_fl\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the VPC flow log forwarder lambda zip file, provided either via filename or s3\_\* parameters |
302+
| vpc\_fl\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the VPC flow log forwarder lambda zip file, provided either via filename or s3\_* parameters |
289303
| vpc\_fl\_forwarder\_lambda\_version | Latest published version of the VPC flow log forwarder lambda function |
290304
| vpc\_fl\_forwarder\_role\_arn | The VPC flow log forwarder lambda role arn |
291305
| vpc\_fl\_forwarder\_role\_id | The VPC flow log forwarder lambda role id |
@@ -294,7 +308,6 @@ Examples codified under the [`examples`](./examples) are intended to give users
294308
| vpc\_fl\_forwarder\_role\_policy\_id | The ID of the VPC flow log forwarder lambda role policy |
295309
| vpc\_fl\_forwarder\_role\_policy\_name | The name of the VPC flow log forwarder lambda role policy |
296310
| vpc\_fl\_forwarder\_role\_unique\_id | The stable and unique string identifying the VPC flow log forwarder lambda role. |
297-
298311
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
299312

300313
## License

‎examples/complete/README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,28 @@ Note that this example may create resources which will incur monetary charges on
3333
| aws | >= 3.0 |
3434
| random | n/a |
3535

36+
## Modules
37+
38+
| Name | Source | Version |
39+
|------|--------|---------|
40+
| default | ../../ | |
41+
| log_bucket_1 | terraform-aws-modules/s3-bucket/aws | ~> 1.17 |
42+
| log_bucket_2 | terraform-aws-modules/s3-bucket/aws | ~> 1.17 |
43+
| security_group | terraform-aws-modules/security-group/aws | ~> 3.17 |
44+
| vpc | terraform-aws-modules/vpc/aws | ~> 2.64 |
45+
46+
## Resources
47+
48+
| Name |
49+
|------|
50+
| [aws_caller_identity](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) |
51+
| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) |
52+
| [aws_kms_alias](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kms_alias) |
53+
| [aws_kms_key](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kms_key) |
54+
| [aws_secretsmanager_secret](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/secretsmanager_secret) |
55+
| [aws_secretsmanager_secret_version](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/secretsmanager_secret_version) |
56+
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
57+
3658
## Inputs
3759

3860
No input.
@@ -62,7 +84,7 @@ No input.
6284
| log\_forwarder\_endpoint\_state | The state of the log forwarder VPC endpoint |
6385
| log\_forwarder\_lambda\_arn | The ARN of the log forwarder lambda function |
6486
| log\_forwarder\_lambda\_qualified\_arn | The ARN of the log forwarder lambda function (if versioning is enabled via publish = true) |
65-
| log\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the log forwarder zip file, provided either via filename or s3\_\* parameters |
87+
| log\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the log forwarder zip file, provided either via filename or s3\_* parameters |
6688
| log\_forwarder\_role\_arn | The log forwarder lambda role arn |
6789
| log\_forwarder\_role\_name | The log forwarder lambda role name |
6890
| log\_forwarder\_role\_policy\_arn | The ARN of the log forwarder lambda role policy |
@@ -87,7 +109,7 @@ No input.
87109
| rds\_em\_forwarder\_cloudwatch\_log\_group\_arn | The ARN of the RDS enhanced monitoring forwarder lambda function CloudWatch log group |
88110
| rds\_em\_forwarder\_lambda\_arn | The ARN of the RDS enhanced monitoring forwarder lambda function |
89111
| rds\_em\_forwarder\_lambda\_qualified\_arn | The ARN of the RDS enhanced monitoring forwarder lambda function (if versioning is enabled via publish = true) |
90-
| rds\_em\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the RDS enhanced monitoring lambda forwarder zip file, provided either via filename or s3\_\* parameters |
112+
| rds\_em\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the RDS enhanced monitoring lambda forwarder zip file, provided either via filename or s3\_* parameters |
91113
| rds\_em\_forwarder\_role\_arn | The RDS enhanced monitoring forwarder lambda role arn |
92114
| rds\_em\_forwarder\_role\_name | The RDS enhanced monitoring forwarder lambda role name |
93115
| rds\_em\_forwarder\_role\_policy\_arn | The ARN of the RDS enhanced monitoring forwarder lambda role policy |
@@ -101,12 +123,11 @@ No input.
101123
| vpc\_fl\_forwarder\_cloudwatch\_log\_group\_arn | The ARN of the VPC flow log forwarder lambda function CloudWatch log group |
102124
| vpc\_fl\_forwarder\_lambda\_arn | The ARN of the VPC flow log forwarder lambda function |
103125
| vpc\_fl\_forwarder\_lambda\_qualified\_arn | The ARN of the VPC flow log forwarder lambda function (if versioning is enabled via publish = true) |
104-
| vpc\_fl\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the VPC flow log forwarder lambda zip file, provided either via filename or s3\_\* parameters |
126+
| vpc\_fl\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the VPC flow log forwarder lambda zip file, provided either via filename or s3\_* parameters |
105127
| vpc\_fl\_forwarder\_role\_arn | The VPC flow log forwarder lambda role arn |
106128
| vpc\_fl\_forwarder\_role\_name | The VPC flow log forwarder lambda role name |
107129
| vpc\_fl\_forwarder\_role\_policy\_arn | The ARN of the VPC flow log forwarder lambda role policy |
108130
| vpc\_fl\_forwarder\_role\_policy\_name | The name of the VPC flow log forwarder lambda role policy |
109-
110131
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
111132

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

‎examples/simple/README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,23 @@ Note that this example may create resources which will incur monetary charges on
2929
| aws | >= 3.0 |
3030
| random | n/a |
3131

32+
## Modules
33+
34+
| Name | Source | Version |
35+
|------|--------|---------|
36+
| default | ../../ | |
37+
38+
## Resources
39+
40+
| Name |
41+
|------|
42+
| [aws_caller_identity](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) |
43+
| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) |
44+
| [aws_kms_alias](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kms_alias) |
45+
| [aws_kms_key](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kms_key) |
46+
| [aws_secretsmanager_secret](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/secretsmanager_secret) |
47+
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
48+
3249
## Inputs
3350

3451
No input.
@@ -40,7 +57,7 @@ No input.
4057
| log\_forwarder\_cloudwatch\_log\_group\_arn | The ARN of the log forwarder lambda function CloudWatch log group |
4158
| log\_forwarder\_lambda\_arn | The ARN of the log forwarder lambda function |
4259
| log\_forwarder\_lambda\_qualified\_arn | The ARN of the log forwarder lambda function (if versioning is enabled via publish = true) |
43-
| log\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the log forwarder zip file, provided either via filename or s3\_\* parameters |
60+
| log\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the log forwarder zip file, provided either via filename or s3\_* parameters |
4461
| log\_forwarder\_role\_arn | The log forwarder lambda role arn |
4562
| log\_forwarder\_role\_name | The log forwarder lambda role name |
4663
| log\_forwarder\_role\_policy\_arn | The ARN of the log forwarder lambda role policy |
@@ -53,20 +70,19 @@ No input.
5370
| rds\_em\_forwarder\_cloudwatch\_log\_group\_arn | The ARN of the RDS enhanced monitoring forwarder lambda function CloudWatch log group |
5471
| rds\_em\_forwarder\_lambda\_arn | The ARN of the RDS enhanced monitoring forwarder lambda function |
5572
| rds\_em\_forwarder\_lambda\_qualified\_arn | The ARN of the RDS enhanced monitoring forwarder lambda function (if versioning is enabled via publish = true) |
56-
| rds\_em\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the RDS enhanced monitoring lambda forwarder zip file, provided either via filename or s3\_\* parameters |
73+
| rds\_em\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the RDS enhanced monitoring lambda forwarder zip file, provided either via filename or s3\_* parameters |
5774
| rds\_em\_forwarder\_role\_arn | The RDS enhanced monitoring forwarder lambda role arn |
5875
| rds\_em\_forwarder\_role\_name | The RDS enhanced monitoring forwarder lambda role name |
5976
| rds\_em\_forwarder\_role\_policy\_arn | The ARN of the RDS enhanced monitoring forwarder lambda role policy |
6077
| rds\_em\_forwarder\_role\_policy\_name | The name of the RDS enhanced monitoring forwarder lambda role policy |
6178
| vpc\_fl\_forwarder\_cloudwatch\_log\_group\_arn | The ARN of the VPC flow log forwarder lambda function CloudWatch log group |
6279
| vpc\_fl\_forwarder\_lambda\_arn | The ARN of the VPC flow log forwarder lambda function |
6380
| vpc\_fl\_forwarder\_lambda\_qualified\_arn | The ARN of the VPC flow log forwarder lambda function (if versioning is enabled via publish = true) |
64-
| vpc\_fl\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the VPC flow log forwarder lambda zip file, provided either via filename or s3\_\* parameters |
81+
| vpc\_fl\_forwarder\_lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the VPC flow log forwarder lambda zip file, provided either via filename or s3\_* parameters |
6582
| vpc\_fl\_forwarder\_role\_arn | The VPC flow log forwarder lambda role arn |
6683
| vpc\_fl\_forwarder\_role\_name | The VPC flow log forwarder lambda role name |
6784
| vpc\_fl\_forwarder\_role\_policy\_arn | The ARN of the VPC flow log forwarder lambda role policy |
6885
| vpc\_fl\_forwarder\_role\_policy\_name | The name of the VPC flow log forwarder lambda role policy |
69-
7086
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
7187

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

‎modules/log_forwarder/README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,28 @@ module "datadog_log_forwarder" {
5151
| aws | >= 3.0 |
5252
| null | n/a |
5353

54+
## Modules
55+
56+
| Name | Source | Version |
57+
|------|--------|---------|
58+
| this_s3_bucket | terraform-aws-modules/s3-bucket/aws | v1.17.0 |
59+
60+
## Resources
61+
62+
| Name |
63+
|------|
64+
| [aws_caller_identity](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) |
65+
| [aws_cloudwatch_log_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) |
66+
| [aws_iam_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) |
67+
| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) |
68+
| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) |
69+
| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) |
70+
| [aws_lambda_function](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function) |
71+
| [aws_lambda_permission](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_permission) |
72+
| [aws_region](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) |
73+
| [aws_s3_bucket_object](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_object) |
74+
| [null_resource](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) |
75+
5476
## Inputs
5577

5678
| Name | Description | Type | Default | Required |
@@ -104,7 +126,7 @@ module "datadog_log_forwarder" {
104126
| lambda\_arn | The ARN of the forwarder lambda function |
105127
| lambda\_kms\_key\_arn | (Optional) The ARN for the KMS encryption key for the forwarder lambda function |
106128
| lambda\_qualified\_arn | The ARN of the forwarder lambda function (if versioning is enabled via publish = true) |
107-
| lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the zip file, provided either via filename or s3\_\* parameters |
129+
| lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the zip file, provided either via filename or s3\_* parameters |
108130
| lambda\_version | Latest published version of the forwarder lambda function |
109131
| role\_arn | The forwarder lambda role arn |
110132
| role\_id | The forwarder lambda role id |
@@ -120,7 +142,6 @@ module "datadog_log_forwarder" {
120142
| s3\_object\_etag | The ETag generated for the forwarder lambda zip object (an MD5 sum of the object content) |
121143
| s3\_object\_id | The `key` of the forwarder lambda zip archive |
122144
| s3\_object\_version | A unique version ID value for the forwarder lambda zip object, if bucket versioning is enabled |
123-
124145
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
125146

126147
## License

‎modules/rds_enhanced_monitoring_forwarder/README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,24 @@ module "datadog_rds_enhanced_monitoring_forwarder" {
4444
|------|---------|
4545
| aws | >= 3.0 |
4646

47+
## Modules
48+
49+
No Modules.
50+
51+
## Resources
52+
53+
| Name |
54+
|------|
55+
| [aws_caller_identity](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) |
56+
| [aws_cloudwatch_log_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) |
57+
| [aws_iam_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) |
58+
| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) |
59+
| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) |
60+
| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) |
61+
| [aws_lambda_function](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function) |
62+
| [aws_lambda_permission](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_permission) |
63+
| [aws_region](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) |
64+
4765
## Inputs
4866

4967
| Name | Description | Type | Default | Required |
@@ -87,7 +105,7 @@ module "datadog_rds_enhanced_monitoring_forwarder" {
87105
| lambda\_arn | The ARN of the forwarder lambda function |
88106
| lambda\_kms\_key\_arn | (Optional) The ARN for the KMS encryption key for the forwarder lambda function |
89107
| lambda\_qualified\_arn | The ARN of the forwarder lambda function (if versioning is enabled via publish = true) |
90-
| lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the zip file, provided either via filename or s3\_\* parameters |
108+
| lambda\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the zip file, provided either via filename or s3\_* parameters |
91109
| lambda\_version | Latest published version of the forwarder lambda function |
92110
| role\_arn | The forwarder lambda role arn |
93111
| role\_id | The forwarder lambda role id |
@@ -96,7 +114,6 @@ module "datadog_rds_enhanced_monitoring_forwarder" {
96114
| role\_policy\_id | The ID of the forwarder lambda role policy |
97115
| role\_policy\_name | The name of the forwarder lambda role policy |
98116
| role\_unique\_id | The stable and unique string identifying the forwarder lambda role. |
99-
100117
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
101118

102119
## License

0 commit comments

Comments
 (0)