Skip to content

Commit

Permalink
feat: add minimal example
Browse files Browse the repository at this point in the history
  • Loading branch information
Rahul-4480 committed Aug 22, 2024
1 parent af58a2a commit a2bdb34
Show file tree
Hide file tree
Showing 6 changed files with 71 additions and 0 deletions.
15 changes: 15 additions & 0 deletions examples/minimal/.header.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### Example `terraform.tfvars`

```hcl
# Name of the Athena workgroup. This workgroup will manage queries and resource usage.
workgroup_name = "your_athena_workgroup_name"
# The S3 bucket where the results of Athena queries will be stored.
query_results_bucket = "your_query_results_bucket_name"
# The name of the Glue Catalog Database where ALB logs will be stored.
database_name = "your_glue_catalog_database_name"
# The name of the S3 bucket where Application Load Balancer (ALB) logs are stored.
s3_bucket_name = "your_alb_logs_s3_bucket_name"
```
27 changes: 27 additions & 0 deletions examples/minimal/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!-- BEGIN_TF_DOCS -->
## Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.8.4 |

## Providers

No providers.

## Modules

No modules.

## Resources

No resources.

## Inputs

No inputs.

## Outputs

No outputs.
<!-- END_TF_DOCS -->
7 changes: 7 additions & 0 deletions examples/minimal/main.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
module "athena" {
source = "../.."
workgroup_name = var.workgroup_name
query_results_bucket = var.query_results_bucket
database_name = var.database_name
s3_bucket_name = var.s3_bucket_name
}
Empty file added examples/minimal/outputs.tf
Empty file.
19 changes: 19 additions & 0 deletions examples/minimal/variables.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
variable "workgroup_name" {
description = "(Required) Name of the workgroup"
type = string
}

variable "query_results_bucket" {
description = "The S3 bucket where Athena query results will be stored."
type = string
}

variable "database_name" {
description = "The name of the Athena database."
type = string
}

variable "s3_bucket_name" {
description = "The name of the S3 bucket where ALB logs are stored."
type = string
}
3 changes: 3 additions & 0 deletions examples/minimal/versions.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
terraform {
required_version = ">= 1.8.4"
}

0 comments on commit a2bdb34

Please sign in to comment.