cloudposse/terraform-aws-mwaa

Terraform module to provision Amazon Managed Workflows for Apache Airflow

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform

Example of running atmos to manage infrastructure from our Quick Start tutorial.

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.

module "mwaa" {
  source = "cloudposse/mwaa/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"
  vpc_id                      = var.vpc_id
  subnet_ids                  = var.subnet_ids
  airflow_version             = "2.0.2"
  dag_s3_path                 = "dags"
  environment_class           = "mw1.small"
  min_workers                 = 1
  max_workers                 = 10
  webserver_access_mode       = "PRIVATE_ONLY"
  dag_processing_logs_enabled = true
  dag_processing_logs_level   = "INFO"
  name                        = "app"
  stage                       = "test"
  namespace                   = "eg"
  enabled                     = true
}

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Examples

Here is an example of using this module:

examples/complete - complete example of using this module

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

Name	Version
terraform	>= 1.0
aws	>= 4.2.0

Providers

Name	Version
aws	>= 4.2.0

Modules

Name	Source	Version
iam_label	cloudposse/label/null	0.25.0
mwaa_iam_role	cloudposse/iam-role/aws	0.16.2
mwaa_s3_bucket	cloudposse/s3-bucket/aws	4.0.0
mwaa_security_group	cloudposse/security-group/aws	1.0.1
s3_label	cloudposse/label/null	0.25.0
sg_label	cloudposse/label/null	0.25.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_mwaa_environment.default	resource
aws_caller_identity.current	data source
aws_iam_policy_document.this	data source
aws_partition.current	data source

Inputs

Name	Description	Type	Default	Required
additional_security_group_rules	A list of Security Group rule objects to add to the created security group, in addition to the ones this module normally creates. (To suppress the module's rules, set `create_security_group` to false and supply your own security group(s) via `associated_security_group_ids`.) The keys and values of the objects are fully compatible with the `aws_security_group_rule` resource, except for `security_group_id` which will be ignored, and the optional "key" which, if provided, must be unique and known at "plan" time. For more info see https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule and https://github.com/cloudposse/terraform-aws-security-group.	`list(any)`	`[]`	no
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
airflow_configuration_options	The Airflow override options	`any`	`null`	no
airflow_version	Airflow version of the MWAA environment, will be set by default to the latest version that MWAA supports.	`string`	`""`	no
allow_all_egress	If `true`, the created security group will allow egress on all ports and protocols to all IP addresses. If this is false and no egress rules are otherwise specified, then no egress will be allowed.	`bool`	`true`	no
allowed_cidr_blocks	A list of IPv4 CIDRs to allow access to the security group created by this module. The length of this list must be known at "plan" time.	`list(string)`	`[]`	no
allowed_security_group_ids	A list of IDs of Security Groups to allow access to the security group created by this module. The length of this list must be known at "plan" time.	`list(string)`	`[]`	no
associated_security_group_ids	A list of IDs of Security Groups to associate the created resource with, in addition to the created security group. These security groups will not be modified and, if `create_security_group` is `false`, must have rules providing the desired access.	`list(string)`	`[]`	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 `delimiter` and treated as a single ID element.	`list(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`	{ "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 }	no
create_iam_role	Enabling or disabling the creatation of a default IAM Role for AWS MWAA	`bool`	`true`	no
create_s3_bucket	Enabling or disabling the creatation of an S3 bucket for AWS MWAA	`bool`	`true`	no
create_security_group	Set `true` to create and configure a new security group. If false, `associated_security_group_ids` must be provided.	`bool`	`true`	no
dag_processing_logs_enabled	Enabling or disabling the collection of logs for processing DAGs	`bool`	`false`	no
dag_processing_logs_level	DAG processing logging level. Valid values: CRITICAL, ERROR, WARNING, INFO, DEBUG	`string`	`"INFO"`	no
dag_s3_path	The relative path to the DAG folder on your Amazon S3 storage bucket.	`string`	`"dags"`	no
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 be identical 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
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
environment_class	Environment class for the cluster. Possible options are mw1.small, mw1.medium, mw1.large.	`string`	`"mw1.small"`	no
execution_role_arn	If `create_iam_role` is `false` then set this to the target MWAA execution role	`string`	`""`	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
kms_key	The Amazon Resource Name (ARN) of your KMS key that you want to use for encryption. Will be set to the ARN of the managed KMS key aws/airflow by default.	`string`	`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 be changed in later chained modules. Attempts to change it will be silently ignored.	`set(string)`	[ "default" ]	no
max_workers	The maximum number of workers that can be automatically scaled up. Value need to be between 1 and 25.	`number`	`10`	no
min_workers	The minimum number of workers that you want to run in your environment.	`number`	`1`	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
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
plugins_s3_object_version	The plugins.zip file version you want to use.	`string`	`null`	no
plugins_s3_path	The relative path to the plugins.zip file on your Amazon S3 storage bucket. For example, plugins.zip. If a relative path is provided in the request, then plugins_s3_object_version is required	`string`	`null`	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
requirements_s3_object_version	The requirements.txt file version you	`string`	`null`	no
requirements_s3_path	The relative path to the requirements.txt file on your Amazon S3 storage bucket. For example, requirements.txt. If a relative path is provided in the request, then requirements_s3_object_version is required	`string`	`null`	no
scheduler_logs_enabled	Enabling or disabling the collection of logs for the schedulers	`bool`	`false`	no
scheduler_logs_level	Schedulers logging level. Valid values: CRITICAL, ERROR, WARNING, INFO, DEBUG	`string`	`"INFO"`	no
security_group_create_before_destroy	Set `true` to enable Terraform `create_before_destroy` behavior on the created security group. We only recommend setting this `false` if you are upgrading this module and need to keep the existing security group from being replaced. Note that changing this value will always cause the security group to be replaced.	`bool`	`true`	no
security_group_create_timeout	How long to wait for the security group to be created.	`string`	`"10m"`	no
security_group_delete_timeout	How long to retry on `DependencyViolation` errors during security group deletion from lingering ENIs left by certain AWS services such as Elastic Load Balancing.	`string`	`"15m"`	no
security_group_description	Security Group for AWS MWAA	`string`	`"Managed by Terraform"`	no
security_group_name	The name to assign to the created security group. Must be unique within the VPC. If not provided, will be derived from the `null-label.context` passed in. If `create_before_destroy` is true, will be used as a name prefix.	`list(string)`	`[]`	no
source_bucket_arn	If `create_s3_bucket` is `false` then set this to the Amazon Resource Name (ARN) of your Amazon S3 storage bucket.	`string`	`null`	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
startup_script_s3_object_version	The version of the startup shell script you want to use. You must specify the version ID that Amazon S3 assigns to the file every time you update the script.	`string`	`null`	no
startup_script_s3_path	The relative path to the script hosted in your bucket. The script runs as your environment starts before starting the Apache Airflow process.	`string`	`null`	no
subnet_ids	The private subnet IDs in which the environment should be created. MWAA requires two subnets	`list(string)`	n/a	yes
tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
task_logs_enabled	Enabling or disabling the collection of logs for DAG tasks	`bool`	`false`	no
task_logs_level	DAG tasks logging level. Valid values: CRITICAL, ERROR, WARNING, INFO, DEBUG	`string`	`"INFO"`	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
vpc_id	The ID of the VPC where the Security Group will be created.	`string`	n/a	yes
webserver_access_mode	Specifies whether the webserver should be accessible over the internet or via your specified VPC. Possible options: PRIVATE_ONLY (default) and PUBLIC_ONLY.	`string`	`"PRIVATE_ONLY"`	no
webserver_logs_enabled	Enabling or disabling the collection of logs for the webservers	`bool`	`false`	no
webserver_logs_level	Webserver logging level. Valid values: CRITICAL, ERROR, WARNING, INFO, DEBUG	`string`	`"INFO"`	no
weekly_maintenance_window_start	Specifies the start date for the weekly maintenance window.	`string`	`null`	no
worker_logs_enabled	Enabling or disabling the collection of logs for the workers	`bool`	`false`	no
worker_logs_level	Workers logging level. Valid values: CRITICAL, ERROR, WARNING, INFO, DEBUG	`string`	`"INFO"`	no

Outputs

Name	Description
arn	The ARN of the Amazon MWAA Environment
created_at	The Created At date of the Amazon MWAA Environment
execution_role_arn	IAM Role ARN for Amazon MWAA Execution Role
logging_configuration	The Logging Configuration of the Amazon MWAA Environment
s3_bucket_arn	ARN of the S3 bucket
security_group_arn	The ARN of the created security group
security_group_id	The ID of the created security group
security_group_name	The name of the created security group
service_role_arn	The Service Role ARN of the Amazon MWAA Environment
status	The status of the Amazon MWAA Environment
tags_all	A map of tags assigned to the resource, including those inherited from the provider for the Amazon MWAA Environment
webserver_url	The webserver URL of the Amazon MWAA Environment

Related Projects

Check out these related projects.

terraform-null-label - Terraform module designed to generate consistent names and tags for resources. Use terraform-null-label to implement a strict naming convention.

References

For additional context, refer to some of these links.

Terraform Standard Module Structure - HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories.
Terraform Module Requirements - HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy.
Terraform random_integer Resource - The resource random_integer generates random values from a given range, described by the min and max attributes of a given resource.
Terraform Version Pinning - The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team.
✅ Your team owns everything.
✅ 100% Open Source and backed by fanatical support.

📚 Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Day-2: Your Operational Mastery

Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

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!

🌎 Slack Community

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.

📰 Newsletter

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.

📆 Office Hours

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!

License

Preamble to the Apache License, Version 2.0

Complete license is available in the LICENSE file.

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.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

cloudposse / terraform-aws-mwaa