Home

Awesome

<!-- markdownlint-disable -->

<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse-terraform-components/aws-mwaa/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/> <p align="right"> <a href="https://github.com/cloudposse-terraform-components/aws-mwaa/releases/latest"><img src="https://img.shields.io/github/release/cloudposse-terraform-components/aws-mwaa.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>

<!-- markdownlint-restore --> <!-- ** DO NOT EDIT THIS FILE ** ** This file was automatically generated by the `cloudposse/build-harness`. ** 1) Make all changes to `README.yaml` ** 2) Run `make init` (you only need to do this once) ** 3) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->

This component provisions Amazon managed workflows for Apache Airflow.

The s3 bucket dag_bucket stores DAGs to be executed by MWAA.

Access Modes

Public

Allows the Airflow UI to be access over the public internet to users granted access by an IAM policy.

Private

Limits access to users within the VPC to users granted access by an IAM policy.

Managing access to VPC endpoings on MWAA

MWAA creates a VPC endpoint in each of the private subnets.

Usage

Stack Level: Regional

Here's an example snippet for how to use this component.

components:
  terraform:
    mwaa:
      vars:
        enabled: true
        name: app
        dag_processing_logs_enabled: true
        dag_processing_logs_level: INFO
        environment_class: mw1.small
        airflow_version: 2.0.2
<!-- prettier-ignore-start --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

Requirements

NameVersion
<a name="requirement_terraform"></a> terraform>= 1.0.0
<a name="requirement_aws"></a> aws>= 4.0

Providers

NameVersion
<a name="provider_aws"></a> aws>= 4.0

Modules

NameSourceVersion
<a name="module_iam_policy"></a> iam_policycloudposse/iam-policy/aws0.4.0
<a name="module_iam_roles"></a> iam_roles../account-map/modules/iam-rolesn/a
<a name="module_mwaa_environment"></a> mwaa_environmentcloudposse/mwaa/aws0.4.8
<a name="module_this"></a> thiscloudposse/label/null0.25.0
<a name="module_vpc"></a> vpccloudposse/stack-config/yaml//modules/remote-state1.5.0
<a name="module_vpc_ingress"></a> vpc_ingresscloudposse/stack-config/yaml//modules/remote-state1.5.0

Resources

NameType
aws_iam_policy.mwaa_web_server_accessresource
aws_iam_role_policy_attachment.mwaa_web_server_accessresource
aws_iam_role_policy_attachment.secrets_manager_read_writeresource

Inputs

NameDescriptionTypeDefaultRequired
<a name="input_additional_tag_map"></a> additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.<br/>This is for some rare cases where resources want additional configuration of tags<br/>and therefore take a list of maps with tag key, value, and additional configuration.map(string){}no
<a name="input_airflow_configuration_options"></a> airflow_configuration_optionsThe Airflow override optionsmap(string){}no
<a name="input_airflow_version"></a> airflow_versionAirflow version of the MWAA environment, will be set by default to the latest version that MWAA supports.string""no
<a name="input_allow_ingress_from_vpc_stages"></a> allow_ingress_from_vpc_stagesList of stages to pull VPC ingress cidr and add to security grouplist(string)<pre>[<br/> "auto",<br/> "corp"<br/>]</pre>no
<a name="input_allowed_cidr_blocks"></a> allowed_cidr_blocksList of CIDR blocks to be allowed to connect to the MWAA clusterlist(string)[]no
<a name="input_allowed_security_groups"></a> allowed_security_groupsA list of IDs of Security Groups to allow access to the security group created by this module.list(string)[]no
<a name="input_allowed_web_access_role_arns"></a> allowed_web_access_role_arnsList of role ARNs to allow airflow web accesslist(string)[]no
<a name="input_allowed_web_access_role_names"></a> allowed_web_access_role_namesList of role names to allow airflow web accesslist(string)[]no
<a name="input_attributes"></a> attributesID element. Additional attributes (e.g. workers or cluster) to add to id,<br/>in the order they appear in the list. New attributes are appended to the<br/>end of the list. The elements of the list are joined by the delimiter<br/>and treated as a single ID element.list(string)[]no
<a name="input_context"></a> contextSingle object for setting entire context at once.<br/>See description of individual variables for details.<br/>Leave string and numeric variables as null to use default value.<br/>Individual variable settings (non-null) override settings in context object,<br/>except for attributes, tags, and additional_tag_map, which are merged.any<pre>{<br/> "additional_tag_map": {},<br/> "attributes": [],<br/> "delimiter": null,<br/> "descriptor_formats": {},<br/> "enabled": true,<br/> "environment": null,<br/> "id_length_limit": null,<br/> "label_key_case": null,<br/> "label_order": [],<br/> "label_value_case": null,<br/> "labels_as_tags": [<br/> "unset"<br/> ],<br/> "name": null,<br/> "namespace": null,<br/> "regex_replace_chars": null,<br/> "stage": null,<br/> "tags": {},<br/> "tenant": null<br/>}</pre>no
<a name="input_create_iam_role"></a> create_iam_roleEnabling or disabling the creation of a default IAM Role for AWS MWAAbooltrueno
<a name="input_create_s3_bucket"></a> create_s3_bucketEnabling or disabling the creation of an S3 bucket for AWS MWAAbooltrueno
<a name="input_dag_processing_logs_enabled"></a> dag_processing_logs_enabledEnabling or disabling the collection of logs for processing DAGsboolfalseno
<a name="input_dag_processing_logs_level"></a> dag_processing_logs_levelDAG processing logging level. Valid values: CRITICAL, ERROR, WARNING, INFO, DEBUGstring"INFO"no
<a name="input_dag_s3_path"></a> dag_s3_pathPath to dags in s3string"dags"no
<a name="input_delimiter"></a> delimiterDelimiter to be used between ID elements.<br/>Defaults to - (hyphen). Set to "" to use no delimiter at all.stringnullno
<a name="input_descriptor_formats"></a> descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.<br/>Map of maps. Keys are names of descriptors. Values are maps of the form<br/>{<br/> format = string<br/> labels = list(string)<br/>}<br/>(Type is any so the map values can later be enhanced to provide additional options.)<br/>format is a Terraform format string to be passed to the format() function.<br/>labels is a list of labels, in order, to pass to format() function.<br/>Label values will be normalized before being passed to format() so they will be<br/>identical to how they appear in id.<br/>Default is {} (descriptors output will be empty).any{}no
<a name="input_enabled"></a> enabledSet to false to prevent the module from creating any resourcesboolnullno
<a name="input_environment"></a> environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
<a name="input_environment_class"></a> environment_classEnvironment class for the cluster. Possible options are mw1.small, mw1.medium, mw1.large.string"mw1.small"no
<a name="input_execution_role_arn"></a> execution_role_arnIf create_iam_role is false then set this to the target MWAA execution rolestring""no
<a name="input_id_length_limit"></a> id_length_limitLimit id to this many characters (minimum 6).<br/>Set to 0 for unlimited length.<br/>Set to null for keep the existing setting, which defaults to 0.<br/>Does not affect id_full.numbernullno
<a name="input_label_key_case"></a> label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the tags input.<br/>Possible values: lower, title, upper.<br/>Default value: title.stringnullno
<a name="input_label_order"></a> label_orderThe order in which the labels (ID elements) appear in the id.<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.list(string)nullno
<a name="input_label_value_case"></a> label_value_caseControls the letter case of ID elements (labels) as included in id,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the tags input.<br/>Possible values: lower, title, upper and none (no transformation).<br/>Set this to title and set delimiter to "" to yield Pascal Case IDs.<br/>Default value: lower.stringnullno
<a name="input_labels_as_tags"></a> labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the tags output.<br/>Set to [] to suppress all generated tags.<br/>Notes:<br/> The value of the name tag, if included, will be the id, not the name.<br/> Unlike other null-label inputs, the initial setting of labels_as_tags cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored.set(string)<pre>[<br/> "default"<br/>]</pre>no
<a name="input_max_workers"></a> max_workersThe maximum number of workers that can be automatically scaled up. Value need to be between 1 and 25.number10no
<a name="input_min_workers"></a> min_workersThe minimum number of workers that you want to run in your environment.number1no
<a name="input_name"></a> nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a tag.<br/>The "name" tag is set to the full id string. There is no tag with the value of the name input.stringnullno
<a name="input_namespace"></a> namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
<a name="input_plugins_s3_object_version"></a> plugins_s3_object_versionThe plugins.zip file version you want to use.stringnullno
<a name="input_plugins_s3_path"></a> plugins_s3_pathThe 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 requiredstringnullno
<a name="input_regex_replace_chars"></a> regex_replace_charsTerraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.stringnullno
<a name="input_region"></a> regionAWS Regionstringn/ayes
<a name="input_requirements_s3_object_version"></a> requirements_s3_object_versionThe requirements.txt file version youstringnullno
<a name="input_requirements_s3_path"></a> requirements_s3_pathThe 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 requiredstringnullno
<a name="input_scheduler_logs_enabled"></a> scheduler_logs_enabledEnabling or disabling the collection of logs for the schedulersboolfalseno
<a name="input_scheduler_logs_level"></a> scheduler_logs_levelSchedulers logging level. Valid values: CRITICAL, ERROR, WARNING, INFO, DEBUGstring"INFO"no
<a name="input_source_bucket_arn"></a> source_bucket_arnSet this to the Amazon Resource Name (ARN) of your Amazon S3 storage bucket.stringnullno
<a name="input_stage"></a> stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
<a name="input_tags"></a> tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).<br/>Neither the tag keys nor the tag values will be modified by this module.map(string){}no
<a name="input_task_logs_enabled"></a> task_logs_enabledEnabling or disabling the collection of logs for DAG tasksboolfalseno
<a name="input_task_logs_level"></a> task_logs_levelDAG tasks logging level. Valid values: CRITICAL, ERROR, WARNING, INFO, DEBUGstring"INFO"no
<a name="input_tenant"></a> tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
<a name="input_webserver_access_mode"></a> webserver_access_modeSpecifies whether the webserver is accessible over the internet, PUBLIC_ONLY or PRIVATE_ONLYstring"PRIVATE_ONLY"no
<a name="input_webserver_logs_enabled"></a> webserver_logs_enabledEnabling or disabling the collection of logs for the webserversboolfalseno
<a name="input_webserver_logs_level"></a> webserver_logs_levelWebserver logging level. Valid values: CRITICAL, ERROR, WARNING, INFO, DEBUGstring"INFO"no
<a name="input_weekly_maintenance_window_start"></a> weekly_maintenance_window_startSpecifies the start date for the weekly maintenance window.stringnullno
<a name="input_worker_logs_enabled"></a> worker_logs_enabledEnabling or disabling the collection of logs for the workersboolfalseno
<a name="input_worker_logs_level"></a> worker_logs_levelWorkers logging level. Valid values: CRITICAL, ERROR, WARNING, INFO, DEBUGstring"INFO"no

Outputs

NameDescription
<a name="output_arn"></a> arnARN of MWAA environment.
<a name="output_created_at"></a> created_atThe Created At date of the Amazon MWAA Environment
<a name="output_execution_role_arn"></a> execution_role_arnIAM Role ARN for Amazon MWAA Execution Role
<a name="output_logging_configuration"></a> logging_configurationThe Logging Configuration of the MWAA Environment
<a name="output_s3_bucket_arn"></a> s3_bucket_arnID of S3 bucket.
<a name="output_security_group_id"></a> security_group_idID of the MWAA Security Group(s)
<a name="output_service_role_arn"></a> service_role_arnThe Service Role ARN of the Amazon MWAA Environment
<a name="output_status"></a> statusThe status of the Amazon MWAA Environment
<a name="output_tags_all"></a> tags_allA map of tags assigned to the resource, including those inherited from the provider for the Amazon MWAA Environment
<a name="output_webserver_url"></a> webserver_urlThe webserver URL of the Amazon MWAA Environment
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- prettier-ignore-end -->

References

[!TIP]

πŸ‘½ Use Atmos with Terraform

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

<details> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary> <img src="https://github.com/cloudposse/atmos/blob/main/docs/demo.gif?raw=true"/><br/> <i>Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial.</i> </detalis>

Related Projects

Check out these related projects.

[!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.<br/> βœ… Your team owns everything.<br/> βœ… 100% Open Source and backed by fanatical support.<br/>

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-mwaa&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

<details><summary>πŸ“š <strong>Learn More</strong></summary> <br/>

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

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-mwaa&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

Day-2: Your Operational Mastery

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-mwaa&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

</details>

✨ Contributing

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

Many thanks to our outstanding contributors:

<a href="https://github.com/cloudposse-terraform-components/aws-mwaa/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cloudposse-terraform-components/aws-mwaa&max=24" /> </a>

For πŸ› bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. 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 <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-mwaa&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

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

<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>

<details> <summary>Preamble to the Apache License, Version 2.0</summary> <br/> <br/>
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.
</details>

Trademarks

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


Copyright Β© 2017-2024 Cloud Posse, LLC

<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-mwaa&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>

<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse-terraform-components/aws-mwaa?pixel&cs=github&cm=readme&an=aws-mwaa"/>