Skip to content

Latest commit

 

History

History
46 lines (42 loc) · 3.95 KB

io.md

File metadata and controls

46 lines (42 loc) · 3.95 KB

Inputs

Name Description Type Default Required
athena_kms_key Use an existing KMS key for Athena if create_workgroup_kms_key is false. string null no
athena_s3_bucket_id Use an existing S3 bucket for Athena query results if create_s3_bucket is false. string null no
bucket_acl Canned ACL to apply to the S3 bucket. string null no
bucket_force_destroy A boolean that indicates all objects should be deleted from the bucket so that the bucket can be destroyed without error. These objects are not recoverable. bool false no
bucket_label_order Label order, e.g. name,application for S3 Bucket. list(any)
[
"name"
]
no
bucket_name name of s3 bucket string "athena-bucket" no
bucket_versioning Enable Versioning of S3. bool true no
bytes_scanned_cutoff_per_query Integer for the upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. Must be at least 10485760. number null no
create_database_kms_key Enable the creation of a KMS key used by Athena database. bool true no
create_s3_bucket Conditionally create S3 bucket. bool true no
create_workgroup_kms_key Enable the creation of a KMS key used by Athena workgroup. bool true no
data_catalogs Map of Athena data catalogs and related configuration. map(any) {} no
databases Map of Athena databases and related configuration. map(any) n/a yes
deletion_window_in_days Duration in days after which the key is deleted after destruction of the resource. number 7 no
enabled Set to false to prevent the module from creating AWS Athena related resources. bool false no
enforce_workgroup_configuration Boolean whether the settings for the workgroup override client-side settings. bool true no
environment Environment (e.g. prod, dev, staging). string "" no
kms_key_enabled Specifies whether the kms is enabled or disabled. bool true no
label_order Label order, e.g. name,application. list(any) [] no
managedby ManagedBy, eg 'CloudDrove'. string "hello@clouddrove.com" no
multi_region Indicates whether the KMS key is a multi-Region (true) or regional (false) key. bool true no
name Name (e.g. app or cluster). string "" no
named_queries Map of Athena named queries and related configuration. map(map(string)) {} no
publish_cloudwatch_metrics_enabled Boolean whether Amazon CloudWatch metrics are enabled for the workgroup. bool true no
repository Terraform current module repo string "https://github.com/clouddrove/terraform-aws-athena" no
s3_output_path The S3 bucket path used to store query results. string "" no
tags Additional tags (e.g. map(BusinessUnit,XYZ). map(any) {} no
workgroup_encryption_option Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (CSE_KMS) is used. string "SSE_KMS" no
workgroup_force_destroy The option to delete the workgroup and its contents even if the workgroup contains any named queries. bool false no

Outputs

Name Description
bucket_arn ID of S3 bucket used by Athena.
bucket_id ID of S3 bucket used by Athena.
data_catalogs List of newly created Athena data catalogs.
databases List of newly created Athena databases.
kms_key_arn ARN of KMS key used by Athena.
named_queries List of newly created Athena named queries.
workgroup_id ID of newly created Athena workgroup.