Skip to content

Commit dd52d39

Browse files
Emily BurakEmily Burak
authored andcommitted
Add README information generated from terraform-docs for modules
1 parent c863fd7 commit dd52d39

File tree

2 files changed

+82
-0
lines changed

2 files changed

+82
-0
lines changed
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,47 @@
11
# AWS HTTP Lambda
22

33
This module provisions a Lambda function meant to use `requests` in Python to query a given endpoint whiel passing a specific user-agent string for identifying the call in logs. This function is set up behind a public function URL with CORS configuration. A basic IAM role is created with a policy to allow Lambda to assume and execute using the role. Finally, deployment is handled via. checking the `/build/python` directory for an updated `server-call-lambda.py`, zipping it and uploading it to Lambda.
4+
5+
<!-- BEGIN_TF_DOCS -->
6+
## Requirements
7+
8+
| Name | Version |
9+
|------|---------|
10+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.2.0 |
11+
| <a name="requirement_klayers"></a> [klayers](#requirement\_klayers) | ~> 1.0.0 |
12+
13+
## Providers
14+
15+
| Name | Version |
16+
|------|---------|
17+
| <a name="provider_archive"></a> [archive](#provider\_archive) | n/a |
18+
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
19+
| <a name="provider_klayers"></a> [klayers](#provider\_klayers) | ~> 1.0.0 |
20+
21+
## Modules
22+
23+
No modules.
24+
25+
## Resources
26+
27+
| Name | Type |
28+
|------|------|
29+
| [aws_iam_role.http_lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
30+
| [aws_iam_role_policy_attachment.lambda_basic_role_attach](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
31+
| [aws_lambda_function.http-function](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function) | resource |
32+
| [aws_lambda_function_url.http-function-url](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function_url) | resource |
33+
| [archive_file.http_lambda_zip](https://registry.terraform.io/providers/hashicorp/archive/latest/docs/data-sources/file) | data source |
34+
| [aws_iam_policy_document.assume_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
35+
| [klayers_package_latest_version.requests](https://registry.terraform.io/providers/ldcorentin/klayer/latest/docs/data-sources/package_latest_version) | data source |
36+
37+
## Inputs
38+
39+
No inputs.
40+
41+
## Outputs
42+
43+
| Name | Description |
44+
|------|-------------|
45+
| <a name="output_http_lambda_arn"></a> [http\_lambda\_arn](#output\_http\_lambda\_arn) | value of the lambda function arn |
46+
| <a name="output_http_lambda_function_url"></a> [http\_lambda\_function\_url](#output\_http\_lambda\_function\_url) | value of the lambda function url |
47+
<!-- END_TF_DOCS -->
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,41 @@
11
# AWS S3 Logs Bucket
22

33
This module provisions an S3 bucket for storing the logs, with versioning and server-side encryption enabled and public access blocked.
4+
5+
<!-- BEGIN_TF_DOCS -->
6+
## Requirements
7+
8+
No requirements.
9+
10+
## Providers
11+
12+
| Name | Version |
13+
|------|---------|
14+
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
15+
16+
## Modules
17+
18+
No modules.
19+
20+
## Resources
21+
22+
| Name | Type |
23+
|------|------|
24+
| [aws_s3_bucket.nginx-http-logs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket) | resource |
25+
| [aws_s3_bucket_public_access_block.block-logs-public-access](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_public_access_block) | resource |
26+
| [aws_s3_bucket_server_side_encryption_configuration.logs-default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_server_side_encryption_configuration) | resource |
27+
| [aws_s3_bucket_versioning.enabled-logs-versioning](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_versioning) | resource |
28+
29+
## Inputs
30+
31+
| Name | Description | Type | Default | Required |
32+
|------|-------------|------|---------|:--------:|
33+
| <a name="input_logs_bucket_name"></a> [logs\_bucket\_name](#input\_logs\_bucket\_name) | The name of the S3 bucket to store the Lambda logs | `string` | n/a | yes |
34+
35+
## Outputs
36+
37+
| Name | Description |
38+
|------|-------------|
39+
| <a name="output_logs_bucket_arn"></a> [logs\_bucket\_arn](#output\_logs\_bucket\_arn) | value of the s3 bucket arn |
40+
| <a name="output_logs_bucket_name"></a> [logs\_bucket\_name](#output\_logs\_bucket\_name) | value of the logs bucket name |
41+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)