Skip to content

Commit af58a2a

Browse files
committed
feat: add complete example
1 parent b5f53ae commit af58a2a

File tree

3 files changed

+59
-0
lines changed

3 files changed

+59
-0
lines changed

examples/complete/.header.md

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

examples/complete/main.tf

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
module "athena" {
2+
source = "../.."
3+
workgroup_name = var.workgroup_name
4+
query_results_bucket = var.query_results_bucket
5+
database_name = var.database_name
6+
s3_bucket_name = var.s3_bucket_name
7+
alb_access_logs_table_name = var.alb_access_logs_table_name
8+
alb_connection_logs_table_name = var.alb_connection_logs_table_name
9+
}

examples/complete/variables.tf

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
variable "workgroup_name" {
2+
description = "(Required) Name of the workgroup"
3+
type = string
4+
}
5+
6+
variable "query_results_bucket" {
7+
description = "The S3 bucket where Athena query results will be stored."
8+
type = string
9+
}
10+
11+
variable "database_name" {
12+
description = "The name of the Athena database."
13+
type = string
14+
}
15+
16+
variable "s3_bucket_name" {
17+
description = "The name of the S3 bucket where ALB logs are stored."
18+
type = string
19+
}
20+
21+
variable "alb_access_logs_table_name" {
22+
description = "The table name for the alb access logs"
23+
type = string
24+
}
25+
26+
variable "alb_connection_logs_table_name" {
27+
description = "The table name for the alb connection logs"
28+
type = string
29+
}

0 commit comments

Comments
 (0)