Skip to content

Commit 0520bb8

Browse files
committed
fix: enhance variable descriptions
1 parent f1cf116 commit 0520bb8

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

examples/complete/variables.tf

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
variable "workgroup_name" {
2-
description = "(Required) Name of the workgroup"
2+
description = "(Required) The name of the Athena workgroup that will manage and isolate query execution and resource usage"
33
type = string
44
}
55

66
variable "query_results_bucket" {
7-
description = "The S3 bucket where Athena query results will be stored."
7+
description = "(Required) The name of the S3 bucket where Athena will store the output of executed queries"
88
type = string
99
}
1010

1111
variable "database_name" {
12-
description = "The name of the Athena database."
12+
description = "(Required) The name of the Athena database in the AWS Glue Catalog that will contain the schema definitions for your ALB logs"
1313
type = string
1414
}
1515

1616
variable "s3_bucket_name" {
17-
description = "The name of the S3 bucket where ALB logs are stored."
17+
description = "(Required) The name of the S3 bucket that holds the raw Application Load Balancer (ALB) logs"
1818
type = string
1919
}
2020

2121
variable "alb_access_logs_table_name" {
22-
description = "The table name for the alb access logs"
22+
description = "The name of the Glue Catalog table that will store the parsed ALB access logs"
2323
type = string
2424
}
2525

2626
variable "alb_connection_logs_table_name" {
27-
description = "The table name for the alb connection logs"
27+
description = "The name of the Glue Catalog table that will store the parsed ALB connection logs"
2828
type = string
2929
}

examples/minimal/variables.tf

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
variable "workgroup_name" {
2-
description = "(Required) Name of the workgroup"
2+
description = "(Required) The name of the Athena workgroup that will manage and isolate query execution and resource usage"
33
type = string
44
}
55

66
variable "query_results_bucket" {
7-
description = "The S3 bucket where Athena query results will be stored."
7+
description = "(Required) The name of the S3 bucket where Athena will store the output of executed queries"
88
type = string
99
}
1010

1111
variable "database_name" {
12-
description = "The name of the Athena database."
12+
description = "(Required) The name of the Athena database in the AWS Glue Catalog that will contain the schema definitions for your ALB logs"
1313
type = string
1414
}
1515

1616
variable "s3_bucket_name" {
17-
description = "The name of the S3 bucket where ALB logs are stored."
17+
description = "(Required) The name of the S3 bucket that holds the raw Application Load Balancer (ALB) logs"
1818
type = string
1919
}

variables.tf

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
variable "workgroup_name" {
2-
description = "(Required) Name of the workgroup"
2+
description = "(Required) The name of the Athena workgroup that will manage and isolate query execution and resource usage"
33
type = string
44
}
55

66
variable "query_results_bucket" {
7-
description = "The S3 bucket where Athena query results will be stored."
7+
description = "(Required) The name of the S3 bucket where Athena will store the output of executed queries"
88
type = string
99
}
1010

1111
variable "database_name" {
12-
description = "The name of the Athena database."
12+
description = "(Required) The name of the Athena database in the AWS Glue Catalog that will contain the schema definitions for your ALB logs"
1313
type = string
1414
}
1515

1616
variable "s3_bucket_name" {
17-
description = "The name of the S3 bucket where ALB logs are stored."
17+
description = "(Required) The name of the S3 bucket that holds the raw Application Load Balancer (ALB) logs"
1818
type = string
1919
}
2020

2121
variable "alb_access_logs_table_name" {
22-
description = "The table name for the alb access logs"
22+
description = "(Optional) The name of the Glue Catalog table that will store the parsed ALB access logs"
2323
type = string
2424
default = "alb_access_logs"
2525
}
2626

2727
variable "alb_connection_logs_table_name" {
28-
description = "The table name for the alb connection logs"
28+
description = "(Optional) The name of the Glue Catalog table that will store the parsed ALB connection logs"
2929
type = string
3030
default = "alb_connection_logs"
3131
}

0 commit comments

Comments
 (0)