From a2bdb345d1730946fe15cf2c684beadcdabdc37a Mon Sep 17 00:00:00 2001
From: Rahul-4480 <rahul.int24@infraspec.dev>
Date: Thu, 22 Aug 2024 11:41:18 +0530
Subject: [PATCH] feat: add minimal example

---
 examples/minimal/.header.md   | 15 +++++++++++++++
 examples/minimal/README.md    | 27 +++++++++++++++++++++++++++
 examples/minimal/main.tf      |  7 +++++++
 examples/minimal/outputs.tf   |  0
 examples/minimal/variables.tf | 19 +++++++++++++++++++
 examples/minimal/versions.tf  |  3 +++
 6 files changed, 71 insertions(+)
 create mode 100644 examples/minimal/.header.md
 create mode 100644 examples/minimal/README.md
 create mode 100644 examples/minimal/main.tf
 create mode 100644 examples/minimal/outputs.tf
 create mode 100644 examples/minimal/variables.tf
 create mode 100644 examples/minimal/versions.tf

diff --git a/examples/minimal/.header.md b/examples/minimal/.header.md
new file mode 100644
index 0000000..d824cc1
--- /dev/null
+++ b/examples/minimal/.header.md
@@ -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"
+```
diff --git a/examples/minimal/README.md b/examples/minimal/README.md
new file mode 100644
index 0000000..9927b90
--- /dev/null
+++ b/examples/minimal/README.md
@@ -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 -->
diff --git a/examples/minimal/main.tf b/examples/minimal/main.tf
new file mode 100644
index 0000000..2c5703a
--- /dev/null
+++ b/examples/minimal/main.tf
@@ -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
+}
diff --git a/examples/minimal/outputs.tf b/examples/minimal/outputs.tf
new file mode 100644
index 0000000..e69de29
diff --git a/examples/minimal/variables.tf b/examples/minimal/variables.tf
new file mode 100644
index 0000000..c5bbd4b
--- /dev/null
+++ b/examples/minimal/variables.tf
@@ -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
+}
diff --git a/examples/minimal/versions.tf b/examples/minimal/versions.tf
new file mode 100644
index 0000000..99a08fb
--- /dev/null
+++ b/examples/minimal/versions.tf
@@ -0,0 +1,3 @@
+terraform {
+  required_version = ">= 1.8.4"
+}