Skip to content

Commit 89337b2

Browse files
bryantbiggsbryantbiggs
authored
chore: update documentation based on latest terraform-docs which includes module and resource sections (terraform-aws-modules#108)
1 parent 2f89c5d commit 89337b2

File tree

15 files changed

+248
-19
lines changed

15 files changed

+248
-19
lines changed

‎.gitignore

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,34 @@
1-
.terraform
2-
*.tfstate.backup
1+
# Local .terraform directories
2+
**/.terraform/*
3+
4+
# Terraform lockfile
5+
.terraform.lock.hcl
6+
7+
# .tfstate files
38
*.tfstate
4-
*.tfvars
9+
*.tfstate.*
510
*.tfplan
6-
.terraform.lock.hcl
711

8-
builds/
12+
# Crash log files
13+
crash.log
914

15+
# Exclude all .tfvars files, which are likely to contain sentitive data, such as
16+
# password, private keys, and other secrets. These should not be part of version
17+
# control as they are data points which are potentially sensitive and subject
18+
# to change depending on the environment.
19+
*.tfvars
20+
21+
# Ignore override files as they are usually used to override resources locally and so
22+
# are not checked in
23+
override.tf
24+
override.tf.json
25+
*_override.tf
26+
*_override.tf.json
27+
28+
# Ignore CLI configuration files
29+
.terraformrc
30+
terraform.rc
31+
32+
# Lambda directories
33+
builds/
1034
__pycache__/

‎.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,6 @@ repos:
2121
- '--args=--only=terraform_standard_module_structure'
2222
- '--args=--only=terraform_workspace_remote'
2323
- repo: git://github.com/pre-commit/pre-commit-hooks
24-
rev: v3.3.0
24+
rev: v3.4.0
2525
hooks:
2626
- id: check-merge-conflict

‎README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -587,6 +587,34 @@ Q4: What does this error mean - `"We currently do not support adding policies fo
587587
| local | >= 1 |
588588
| null | >= 2 |
589589

590+
## Modules
591+
592+
No Modules.
593+
594+
## Resources
595+
596+
| Name |
597+
|------|
598+
| [aws_arn](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/data-sources/arn) |
599+
| [aws_cloudwatch_log_group](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/data-sources/cloudwatch_log_group) |
600+
| [aws_cloudwatch_log_group](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/resources/cloudwatch_log_group) |
601+
| [aws_iam_policy](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/resources/iam_policy) |
602+
| [aws_iam_policy](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/data-sources/iam_policy) |
603+
| [aws_iam_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/resources/iam_policy_attachment) |
604+
| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/data-sources/iam_policy_document) |
605+
| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/resources/iam_role) |
606+
| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/resources/iam_role_policy_attachment) |
607+
| [aws_lambda_event_source_mapping](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/resources/lambda_event_source_mapping) |
608+
| [aws_lambda_function](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/resources/lambda_function) |
609+
| [aws_lambda_function_event_invoke_config](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/resources/lambda_function_event_invoke_config) |
610+
| [aws_lambda_layer_version](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/resources/lambda_layer_version) |
611+
| [aws_lambda_permission](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/resources/lambda_permission) |
612+
| [aws_lambda_provisioned_concurrency_config](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/resources/lambda_provisioned_concurrency_config) |
613+
| [aws_s3_bucket_object](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/resources/s3_bucket_object) |
614+
| [external_external](https://registry.terraform.io/providers/hashicorp/external/1/docs/data-sources/external) |
615+
| [local_file](https://registry.terraform.io/providers/hashicorp/local/1/docs/resources/file) |
616+
| [null_resource](https://registry.terraform.io/providers/hashicorp/null/2/docs/resources/resource) |
617+
590618
## Inputs
591619

592620
| Name | Description | Type | Default | Required |
@@ -707,7 +735,6 @@ Q4: What does this error mean - `"We currently do not support adding policies fo
707735
| this\_lambda\_layer\_layer\_arn | The ARN of the Lambda Layer without version |
708736
| this\_lambda\_layer\_source\_code\_size | The size in bytes of the Lambda Layer .zip file |
709737
| this\_lambda\_layer\_version | The Lambda Layer version |
710-
711738
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
712739

713740
## Authors

‎examples/alias/README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,21 @@ Note that this example may create resources which cost money. Run `terraform des
2929
|------|---------|
3030
| random | >= 2 |
3131

32+
## Modules
33+
34+
| Name | Source | Version |
35+
|------|--------|---------|
36+
| alias_existing | ../../modules/alias | |
37+
| alias_no_refresh | ../../modules/alias | |
38+
| alias_refresh | ../../modules/alias | |
39+
| lambda_function | ../../ | |
40+
41+
## Resources
42+
43+
| Name |
44+
|------|
45+
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/2/docs/resources/pet) |
46+
3247
## Inputs
3348

3449
No input.
@@ -60,5 +75,4 @@ No input.
6075
| this\_lambda\_layer\_layer\_arn | The ARN of the Lambda Layer without version |
6176
| this\_lambda\_layer\_source\_code\_size | The size in bytes of the Lambda Layer .zip file |
6277
| this\_lambda\_layer\_version | The Lambda Layer version |
63-
6478
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/async/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,20 @@ Note that this example may create resources which cost money. Run `terraform des
3030
| aws | >= 3.19 |
3131
| random | >= 2 |
3232

33+
## Modules
34+
35+
| Name | Source | Version |
36+
|------|--------|---------|
37+
| lambda_function | ../../ | |
38+
39+
## Resources
40+
41+
| Name |
42+
|------|
43+
| [aws_sns_topic](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/resources/sns_topic) |
44+
| [aws_sqs_queue](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/resources/sqs_queue) |
45+
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/2/docs/resources/pet) |
46+
3347
## Inputs
3448

3549
No input.
@@ -57,5 +71,4 @@ No input.
5771
| this\_lambda\_layer\_layer\_arn | The ARN of the Lambda Layer without version |
5872
| this\_lambda\_layer\_source\_code\_size | The size in bytes of the Lambda Layer .zip file |
5973
| this\_lambda\_layer\_version | The Lambda Layer version |
60-
6174
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/build-package/README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,32 @@ Note that this example may create resources which cost money. Run `terraform des
2929
|------|---------|
3030
| random | >= 2 |
3131

32+
## Modules
33+
34+
| Name | Source | Version |
35+
|------|--------|---------|
36+
| lambda_function_from_package | ../../ | |
37+
| lambda_layer | ../../ | |
38+
| package_dir | ../../ | |
39+
| package_dir_without_pip_install | ../../ | |
40+
| package_file | ../../ | |
41+
| package_file_with_pip_requirements | ../../ | |
42+
| package_with_commands_and_patterns | ../../ | |
43+
| package_with_docker | ../../ | |
44+
| package_with_patterns | ../../ | |
45+
| package_with_pip_requirements_in_docker | ../../ | |
46+
47+
## Resources
48+
49+
| Name |
50+
|------|
51+
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/2/docs/resources/pet) |
52+
3253
## Inputs
3354

3455
No input.
3556

3657
## Outputs
3758

3859
No output.
39-
4060
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/complete/README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,26 @@ Note that this example may create resources which cost money. Run `terraform des
3131
| aws | >= 2.67 |
3232
| random | >= 2 |
3333

34+
## Modules
35+
36+
| Name | Source | Version |
37+
|------|--------|---------|
38+
| disabled_lambda | ../../ | |
39+
| lambda_at_edge | ../../ | |
40+
| lambda_function | ../../ | |
41+
| lambda_function_existing_package_local | ../../ | |
42+
| lambda_layer_local | ../../ | |
43+
| lambda_layer_s3 | ../../ | |
44+
| lambda_with_provisioned_concurrency | ../../ | |
45+
| s3_bucket | terraform-aws-modules/s3-bucket/aws | |
46+
47+
## Resources
48+
49+
| Name |
50+
|------|
51+
| [aws_sqs_queue](https://registry.terraform.io/providers/hashicorp/aws/2.67/docs/resources/sqs_queue) |
52+
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/2/docs/resources/pet) |
53+
3454
## Inputs
3555

3656
No input.
@@ -58,5 +78,4 @@ No input.
5878
| this\_lambda\_layer\_layer\_arn | The ARN of the Lambda Layer without version |
5979
| this\_lambda\_layer\_source\_code\_size | The size in bytes of the Lambda Layer .zip file |
6080
| this\_lambda\_layer\_version | The Lambda Layer version |
61-
6281
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/container-image/README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,23 @@ Note that this example may create resources which cost money. Run `terraform des
3232
| docker | >= 2.8.0 |
3333
| random | >= 2 |
3434

35+
## Modules
36+
37+
| Name | Source | Version |
38+
|------|--------|---------|
39+
| lambda_function_from_container_image | ../../ | |
40+
41+
## Resources
42+
43+
| Name |
44+
|------|
45+
| [aws_caller_identity](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/data-sources/caller_identity) |
46+
| [aws_ecr_authorization_token](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/data-sources/ecr_authorization_token) |
47+
| [aws_ecr_repository](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/resources/ecr_repository) |
48+
| [aws_region](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/data-sources/region) |
49+
| [docker_registry_image](https://registry.terraform.io/providers/kreuzwerker/docker/2.8.0/docs/resources/registry_image) |
50+
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/2/docs/resources/pet) |
51+
3552
## Inputs
3653

3754
No input.
@@ -57,5 +74,4 @@ No input.
5774
| this\_lambda\_layer\_layer\_arn | The ARN of the Lambda Layer without version |
5875
| this\_lambda\_layer\_source\_code\_size | The size in bytes of the Lambda Layer .zip file |
5976
| this\_lambda\_layer\_version | The Lambda Layer version |
60-
6177
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/deploy/README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,21 @@ Note that this example may create resources which cost money. Run `terraform des
3030
| aws | >= 3.19 |
3131
| random | >= 2 |
3232

33+
## Modules
34+
35+
| Name | Source | Version |
36+
|------|--------|---------|
37+
| alias_refresh | ../../modules/alias | |
38+
| deploy | ../../modules/deploy | |
39+
| lambda_function | ../../ | |
40+
41+
## Resources
42+
43+
| Name |
44+
|------|
45+
| [aws_sns_topic](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/resources/sns_topic) |
46+
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/2/docs/resources/pet) |
47+
3348
## Inputs
3449

3550
No input.
@@ -47,5 +62,4 @@ No input.
4762
| codedeploy\_iam\_role\_name | Name of IAM role used by CodeDeploy |
4863
| deploy\_script | Path to a deployment script |
4964
| script | Deployment script |
50-
5165
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/multiple-regions/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,20 @@ Note that this example may create resources which cost money. Run `terraform des
3232
| aws.us-east-1 | >= 3.19 |
3333
| random | >= 2 |
3434

35+
## Modules
36+
37+
| Name | Source | Version |
38+
|------|--------|---------|
39+
| lambda_function | ../../ | |
40+
| lambda_function_another_region | ../../ | |
41+
42+
## Resources
43+
44+
| Name |
45+
|------|
46+
| [aws_sqs_queue](https://registry.terraform.io/providers/hashicorp/aws/3.19/docs/resources/sqs_queue) |
47+
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/2/docs/resources/pet) |
48+
3549
## Inputs
3650

3751
No input.
@@ -59,5 +73,4 @@ No input.
5973
| this\_lambda\_layer\_layer\_arn | The ARN of the Lambda Layer without version |
6074
| this\_lambda\_layer\_source\_code\_size | The size in bytes of the Lambda Layer .zip file |
6175
| this\_lambda\_layer\_version | The Lambda Layer version |
62-
6376
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

0 commit comments

Comments
 (0)