Skip to content

Commit f1cf116

Browse files
terraform-docs: automated action
1 parent a2bdb34 commit f1cf116

File tree

2 files changed

+58
-4
lines changed

2 files changed

+58
-4
lines changed

examples/complete/README.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,26 @@
11
<!-- BEGIN_TF_DOCS -->
2+
### Example `terraform.tfvars`
3+
4+
```hcl
5+
# Name of the Athena workgroup. This workgroup will manage queries and resource usage.
6+
workgroup_name = "your_athena_workgroup_name"
7+
8+
# The S3 bucket where the results of Athena queries will be stored.
9+
query_results_bucket = "your_query_results_bucket_name"
10+
11+
# The name of the Glue Catalog Database where ALB logs will be stored.
12+
database_name = "your_glue_catalog_database_name"
13+
14+
# The name of the S3 bucket where Application Load Balancer (ALB) logs are stored.
15+
s3_bucket_name = "your_alb_logs_s3_bucket_name"
16+
17+
# The name of the Glue Catalog Table for storing ALB access logs.
18+
alb_access_logs_table_name = "your_alb_access_logs_table_name"
19+
20+
# The name of the Glue Catalog Table for storing ALB connection logs.
21+
alb_connection_logs_table_name = "your_alb_connection_logs_table_name"
22+
```
23+
224
## Requirements
325

426
| Name | Version |
@@ -11,15 +33,24 @@ No providers.
1133

1234
## Modules
1335

14-
No modules.
36+
| Name | Source | Version |
37+
|------|--------|---------|
38+
| <a name="module_athena"></a> [athena](#module\_athena) | ../.. | n/a |
1539

1640
## Resources
1741

1842
No resources.
1943

2044
## Inputs
2145

22-
No inputs.
46+
| Name | Description | Type | Default | Required |
47+
|------|-------------|------|---------|:--------:|
48+
| <a name="input_alb_access_logs_table_name"></a> [alb\_access\_logs\_table\_name](#input\_alb\_access\_logs\_table\_name) | The table name for the alb access logs | `string` | n/a | yes |
49+
| <a name="input_alb_connection_logs_table_name"></a> [alb\_connection\_logs\_table\_name](#input\_alb\_connection\_logs\_table\_name) | The table name for the alb connection logs | `string` | n/a | yes |
50+
| <a name="input_database_name"></a> [database\_name](#input\_database\_name) | The name of the Athena database. | `string` | n/a | yes |
51+
| <a name="input_query_results_bucket"></a> [query\_results\_bucket](#input\_query\_results\_bucket) | The S3 bucket where Athena query results will be stored. | `string` | n/a | yes |
52+
| <a name="input_s3_bucket_name"></a> [s3\_bucket\_name](#input\_s3\_bucket\_name) | The name of the S3 bucket where ALB logs are stored. | `string` | n/a | yes |
53+
| <a name="input_workgroup_name"></a> [workgroup\_name](#input\_workgroup\_name) | (Required) Name of the workgroup | `string` | n/a | yes |
2354

2455
## Outputs
2556

examples/minimal/README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,20 @@
11
<!-- BEGIN_TF_DOCS -->
2+
### Example `terraform.tfvars`
3+
4+
```hcl
5+
# Name of the Athena workgroup. This workgroup will manage queries and resource usage.
6+
workgroup_name = "your_athena_workgroup_name"
7+
8+
# The S3 bucket where the results of Athena queries will be stored.
9+
query_results_bucket = "your_query_results_bucket_name"
10+
11+
# The name of the Glue Catalog Database where ALB logs will be stored.
12+
database_name = "your_glue_catalog_database_name"
13+
14+
# The name of the S3 bucket where Application Load Balancer (ALB) logs are stored.
15+
s3_bucket_name = "your_alb_logs_s3_bucket_name"
16+
```
17+
218
## Requirements
319

420
| Name | Version |
@@ -11,15 +27,22 @@ No providers.
1127

1228
## Modules
1329

14-
No modules.
30+
| Name | Source | Version |
31+
|------|--------|---------|
32+
| <a name="module_athena"></a> [athena](#module\_athena) | ../.. | n/a |
1533

1634
## Resources
1735

1836
No resources.
1937

2038
## Inputs
2139

22-
No inputs.
40+
| Name | Description | Type | Default | Required |
41+
|------|-------------|------|---------|:--------:|
42+
| <a name="input_database_name"></a> [database\_name](#input\_database\_name) | The name of the Athena database. | `string` | n/a | yes |
43+
| <a name="input_query_results_bucket"></a> [query\_results\_bucket](#input\_query\_results\_bucket) | The S3 bucket where Athena query results will be stored. | `string` | n/a | yes |
44+
| <a name="input_s3_bucket_name"></a> [s3\_bucket\_name](#input\_s3\_bucket\_name) | The name of the S3 bucket where ALB logs are stored. | `string` | n/a | yes |
45+
| <a name="input_workgroup_name"></a> [workgroup\_name](#input\_workgroup\_name) | (Required) Name of the workgroup | `string` | n/a | yes |
2346

2447
## Outputs
2548

0 commit comments

Comments
 (0)