Skip to main content

Component: athena

This component is responsible for provisioning an Amazon Athena workgroup, databases, and related resources.


Stack Level: Regional

Here are some example snippets for how to use this component:

stacks/catalog/athena/defaults.yaml file (base component for all Athena deployments with default settings):

type: abstract
workspace_enabled: true
enabled: true
Team: sre
Service: athena
create_s3_bucket: true
create_kms_key: true
athena_kms_key_deletion_window: 7
bytes_scanned_cutoff_per_query: null
enforce_workgroup_configuration: true
publish_cloudwatch_metrics_enabled: true
encryption_option: "SSE_KMS"
s3_output_path: ""
workgroup_state: "ENABLED"
database: []

- catalog/athena/defaults

component: athena
- athena/defaults
enabled: true
name: athena-example
workgroup_description: "My Example Athena Workgroup"
- example_db_1
- example_db_2


terraform>= 1.0.0
aws~> 4.0


No providers.




No resources.


additional_tag_mapAdditional 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.
athena_kms_keyUse an existing KMS key for Athena if create_kms_key is false.stringnullno
athena_kms_key_deletion_windowKMS key deletion window (in days).number7no
athena_s3_bucket_idUse an existing S3 bucket for Athena query results if create_s3_bucket is false.stringnullno
attributesID 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.
bytes_scanned_cutoff_per_queryInteger 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.numbernullno
contextSingle 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.
"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": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
create_kms_keyEnable the creation of a KMS key used by Athena workgroup.booltrueno
create_s3_bucketEnable the creation of an S3 bucket to use for Athena query resultsbooltrueno
data_catalogsMap of Athena data catalogs and parametersmap(any){}no
databasesMap of Athena databases and related
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe 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).
enabledSet to false to prevent the module from creating any resourcesboolnullno
enforce_workgroup_configurationBoolean whether the settings for the workgroup override client-side settings.booltrueno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
id_length_limitLimit 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.
import_profile_nameAWS Profile name to use when importing a resourcestringnullno
import_role_arnIAM Role ARN to use when importing a resourcestringnullno
label_key_caseControls 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.
label_orderThe 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.
label_value_caseControls 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.
labels_as_tagsSet 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.
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.
nameID 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.
named_queriesMap of Athena named queries and parametersmap(map(string)){}no
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
publish_cloudwatch_metrics_enabledBoolean whether Amazon CloudWatch metrics are enabled for the workgroup.booltrueno
regex_replace_charsTerraform 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.
regionAWS Regionstringn/ayes
s3_output_pathThe S3 bucket path used to store query results.string""no
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
workgroup_descriptionDescription of the Athena workgroup.string""no
workgroup_encryption_optionIndicates 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_destroyThe option to delete the workgroup and its contents even if the workgroup contains any named queries.boolfalseno
workgroup_stateState of the workgroup. Valid values are DISABLED or ENABLED.string"ENABLED"no


data_catalogsList of newly created Athena data catalogs.
databasesList of newly created Athena databases.
kms_key_arnARN of KMS key used by Athena.
named_queriesList of newly created Athena named queries.
s3_bucket_idID of S3 bucket used for Athena query results.
workgroup_idID of newly created Athena workgroup.