Skip to content

Commit a2bdb34

Browse files
committed
feat: add minimal example
1 parent af58a2a commit a2bdb34

File tree

6 files changed

+71
-0
lines changed

6 files changed

+71
-0
lines changed

examples/minimal/.header.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
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+
```

examples/minimal/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.8.4 |
7+
8+
## Providers
9+
10+
No providers.
11+
12+
## Modules
13+
14+
No modules.
15+
16+
## Resources
17+
18+
No resources.
19+
20+
## Inputs
21+
22+
No inputs.
23+
24+
## Outputs
25+
26+
No outputs.
27+
<!-- END_TF_DOCS -->

examples/minimal/main.tf

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
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+
}

examples/minimal/outputs.tf

Whitespace-only changes.

examples/minimal/variables.tf

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
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+
}

examples/minimal/versions.tf

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
terraform {
2+
required_version = ">= 1.8.4"
3+
}

0 commit comments

Comments
 (0)