Skip to main content

Module: athena

Terraform module to deploy an instance of Amazon Athena on AWS.

Usage​

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

# Create a standard label resource. See [null-label](https://github.com/cloudposse/terraform-null-label/#terraform-null-label--)
module "label" {
  source  = "cloudposse/label/null"
  # Cloud Posse recommends pinning every module to a specific version, though usually you want to use the current one
  # version = "x.x.x"

  namespace = "eg"
  name      = "example"
}

module "athena" {
  source  = "cloudposse/athena/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  context = module.label.this
}

Variables​

Required Variables​

data_catalogs (map(any)) required​

Map of Athena data catalogs and related configuration.

databases (map(any)) required​

Map of Athena databases and related configuration.

named_queries (map(map(string))) required​

Map of Athena named queries and related configuration.

Optional Variables​

athena_kms_key (string) optional​

Use an existing KMS key for Athena if create_kms_key is false.


Default value: null

athena_kms_key_deletion_window (number) optional​

KMS key deletion window (in days).


Default value: 7

athena_s3_bucket_id (string) optional​

Use an existing S3 bucket for Athena query results if create_s3_bucket is false.


Default value: null

bytes_scanned_cutoff_per_query (number) optional​

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.


Default value: null

create_kms_key (bool) optional​

Enable the creation of a KMS key used by Athena workgroup.


Default value: true

create_s3_bucket (bool) optional​

Enable the creation of an S3 bucket to use Athena query results


Default value: true

enforce_workgroup_configuration (bool) optional​

Boolean whether the settings for the workgroup override client-side settings.


Default value: true

publish_cloudwatch_metrics_enabled (bool) optional​

Boolean whether Amazon CloudWatch metrics are enabled for the workgroup.


Default value: true

requester_pays_enabled (bool) optional​

Boolean whether to enable Requester Pays option on the Athena workgroup.


Default value: false

s3_output_path (string) optional​

The S3 bucket path used to store query results.


Default value: ""

workgroup_description (string) optional​

A description the of Athena workgroup.


Default value: ""

workgroup_encryption_option (string) optional​

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.


Default value: "SSE_KMS"

workgroup_force_destroy (bool) optional​

The option to delete the workgroup and its contents even if the workgroup contains any named queries.


Default value: false

workgroup_state (string) optional​

State of the workgroup. Valid values are DISABLED or ENABLED.


Default value: "ENABLED"

Context Variables​

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional​

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.


Required: No

Default value: { }

attributes (list(string)) optional​

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.


Required: No

Default value: [ ]

context (any) optional​

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.


Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
delimiter (string) optional​

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.


Required: No

Default value: null

descriptor_formats (any) optional​

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).


Required: No

Default value: { }

enabled (bool) optional​

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional​

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional​

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.


Required: No

Default value: null

label_key_case (string) optional​

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.


Required: No

Default value: null

label_order (list(string)) optional​

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.


Required: No

Default value: null

label_value_case (string) optional​

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.


Required: No

Default value: null

labels_as_tags (set(string)) optional​

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.


Required: No

Default value:

[
  "default"
]
name (string) optional​

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.


Required: No

Default value: null

namespace (string) optional​

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional​

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.


Required: No

Default value: null

stage (string) optional​

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional​

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.


Required: No

Default value: { }

tenant (string) optional​

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs​

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.

s3_bucket_id​

ID of S3 bucket used by Athena.

workgroup_id​

ID of newly created Athena workgroup.

Dependencies​

Requirements​

  • terraform, version: >= 1.0
  • aws, version: >= 4.0

Providers​

  • aws, version: >= 4.0

Modules​

NameVersionSourceDescription
this0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: