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):
components:
terraform:
athena/defaults:
metadata:
type: abstract
settings:
spacelift:
workspace_enabled: true
vars:
enabled: true
tags:
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: []import:
- catalog/athena/defaults
components:
terraform:
athena/example:
metadata:
component: athena
inherits:
- athena/defaults
vars:
enabled: true
name: athena-example
workgroup_description: "My Example Athena Workgroup"
database:
- example_db_1
- example_db_2Using Athena with CloudTrail logs is a powerful way to enhance your analysis of AWS service activity. This component supports creating a CloudTrail table for each account and setting up queries to read CloudTrail logs from a centralized location.
To set up the CloudTrail Integration, first create the create and alter queries in Athena with this component. When
var.cloudtrail_database is defined, this component will create these queries.
import:
- catalog/athena/defaults
components:
terraform:
athena/audit:
metadata:
component: athena
inherits:
- athena/defaults
vars:
enabled: true
name: athena-audit
workgroup_description: "Athena Workgroup for Auditing"
cloudtrail_database: audit
databases:
audit:
comment: "Auditor database for Athena"
properties: {}
named_queries:
platform_dev:
database: audit
description: "example query against CloudTrail logs"
query: |
SELECT
useridentity.arn,
eventname,
sourceipaddress,
eventtime
FROM %s.platform_dev_cloudtrail_logs
LIMIT 100;Once those are created, run the create and then the alter queries in the AWS Console to create and then fill the
tables in Athena.
:::info
Athena runs queries with the permissions of the user executing the query. In order to be able to query CloudTrail logs,
the audit account must have access to the KMS key used to encrypt CloudTrails logs. Set var.audit_access_enabled to
true in the cloudtrail component
:::
| Name | Version |
|---|---|
| terraform | >= 1.0.0 |
| aws | >= 4.0 |
| Name | Version |
|---|---|
| aws | >= 4.0 |
| Name | Source | Version |
|---|---|---|
| account_map | cloudposse/stack-config/yaml//modules/remote-state | 1.5.0 |
| athena | cloudposse/athena/aws | 0.1.1 |
| cloudtrail_bucket | cloudposse/stack-config/yaml//modules/remote-state | 1.5.0 |
| iam_roles | ../account-map/modules/iam-roles | n/a |
| this | cloudposse/label/null | 0.25.0 |
| Name | Type |
|---|---|
| aws_athena_named_query.cloudtrail_query_alter_tables | resource |
| aws_athena_named_query.cloudtrail_query_create_tables | resource |
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| additional_tag_map | 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. |
map(string) |
{} |
no |
| athena_kms_key | Use an existing KMS key for Athena if create_kms_key is false. |
string |
null |
no |
| athena_kms_key_deletion_window | KMS key deletion window (in days). | number |
7 |
no |
| athena_s3_bucket_id | Use an existing S3 bucket for Athena query results if create_s3_bucket is false. |
string |
null |
no |
| attributes | 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 delimiterand treated as a single ID element. |
list(string) |
[] |
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 |
| cloudtrail_bucket_component_name | The name of the CloudTrail bucket component | string |
"cloudtrail-bucket" |
no |
| cloudtrail_database | The name of the Athena Database to use for CloudTrail logs. If set, an Athena table will be created for the CloudTrail trail. | string |
"" |
no |
| context | 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. |
any |
{ |
no |
| create_kms_key | Enable the creation of a KMS key used by Athena workgroup. | bool |
true |
no |
| create_s3_bucket | Enable the creation of an S3 bucket to use for Athena query results | bool |
true |
no |
| data_catalogs | Map of Athena data catalogs and parameters | map(any) |
{} |
no |
| databases | Map of Athena databases and related configuration. | map(any) |
n/a | yes |
| delimiter | Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all. |
string |
null |
no |
| descriptor_formats | 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 beidentical to how they appear in id.Default is {} (descriptors output will be empty). |
any |
{} |
no |
| enabled | Set to false to prevent the module from creating any resources | bool |
null |
no |
| enforce_workgroup_configuration | Boolean whether the settings for the workgroup override client-side settings. | bool |
true |
no |
| environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string |
null |
no |
| id_length_limit | 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. |
number |
null |
no |
| label_key_case | 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. |
string |
null |
no |
| label_order | 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. |
list(string) |
null |
no |
| label_value_case | 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. |
string |
null |
no |
| labels_as_tags | 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 bechanged in later chained modules. Attempts to change it will be silently ignored. |
set(string) |
[ |
no |
| name | 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. |
string |
null |
no |
| named_queries | Map of Athena named queries and parameters | map(map(string)) |
{} |
no |
| namespace | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | string |
null |
no |
| publish_cloudwatch_metrics_enabled | Boolean whether Amazon CloudWatch metrics are enabled for the workgroup. | bool |
true |
no |
| regex_replace_chars | 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. |
string |
null |
no |
| region | AWS Region | string |
n/a | yes |
| s3_output_path | The S3 bucket path used to store query results. | string |
"" |
no |
| stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string |
null |
no |
| tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'}).Neither the tag keys nor the tag values will be modified by this module. |
map(string) |
{} |
no |
| tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string |
null |
no |
| workgroup_description | Description of the Athena workgroup. | string |
"" |
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 |
| workgroup_state | State of the workgroup. Valid values are DISABLED or ENABLED. |
string |
"ENABLED" |
no |
| Name | Description |
|---|---|
| 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 for Athena query results. |
| workgroup_id | ID of newly created Athena workgroup. |
- cloudposse/terraform-aws-components - Cloud Posse's upstream component
- Querying AWS CloudTrail logs with AWS Athena
Note
This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.
Learn More
It's 100% Open Source and licensed under the APACHE2.
Check out these related projects.
- Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
- Atmos - Atmos is like docker-compose but for your infrastructure
This project is under active development, and we encourage contributions from our community. Many thanks to our outstanding contributors:
Please use the issue tracker to report any bugs or file feature requests.
If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you!
Hit us up in Slack, in the #cloudposse channel.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Review our Code of Conduct and Contributor Guidelines.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull Request so that we can review your changes
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.
Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.
Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!
This project is maintained by Cloud Posse, LLC.
We are a DevOps Accelerator for funded startups and enterprises. Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly. We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
Your team can operate like a pro today.
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
📚 See What's Included
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Deployment Strategy. You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
- Site Reliability Engineering. You'll have total visibility into your apps and microservices.
- Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
- GitOps. You'll be able to operate your infrastructure via Pull Requests.
- Training. You'll receive hands-on training so your team can operate what we build.
- Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
- Troubleshooting. You'll get help to triage when things aren't working.
- Code Reviews. You'll receive constructive feedback on Pull Requests.
- Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.
Preamble to the Apache License, Version 2.0
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
Copyright © 2017-2024 Cloud Posse, LLC