Module: `mwaa`

Terraform module to provision Amazon Managed Workflows for Apache Airflow

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
}

Examples

Here is an example of using this module:

examples/complete - complete example of using this module

Variables

Required Variables

region (string) required: AWS region
subnet_ids (list(string)) required: The private subnet IDs in which the environment should be created. MWAA requires two subnets
vpc_id (string) required: The ID of the VPC where the Security Group will be created.

Optional Variables

additional_security_group_rules (list(any)) optional

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.

Default value: [ ]

additionals_managed_policy_arns (list(any)) optional

List of managed policies to attach to the MWAA IAM role

Default value: [ ]

additionals_policy_documents (list(any)) optional

List of JSON IAM policy documents to attach to the MWAA IAM role

Default value: [ ]

airflow_configuration_options (any) optional

The Airflow override options

Default value: null

airflow_version (string) optional

Airflow version of the MWAA environment, will be set by default to the latest version that MWAA supports.

Default value: ""

allow_all_egress (bool) optional

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.

Default value: true

allowed_cidr_blocks (list(string)) optional

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.

Default value: [ ]

allowed_security_group_ids (list(string)) optional

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.

Default value: [ ]

associated_security_group_ids (list(string)) optional

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.

Default value: [ ]

create_iam_role (bool) optional

Enabling or disabling the creatation of a default IAM Role for AWS MWAA

Default value: true

create_s3_bucket (bool) optional

Enabling or disabling the creatation of an S3 bucket for AWS MWAA

Default value: true

create_security_group (bool) optional

Set true to create and configure a new security group. If false, associated_security_group_ids must be provided.

Default value: true

dag_processing_logs_enabled (bool) optional

Enabling or disabling the collection of logs for processing DAGs

Default value: false

dag_processing_logs_level (string) optional

DAG processing logging level. Valid values: CRITICAL, ERROR, WARNING, INFO, DEBUG

Default value: "INFO"

dag_s3_path (string) optional

The relative path to the DAG folder on your Amazon S3 storage bucket.

Default value: "dags"

environment_class (string) optional

Environment class for the cluster. Possible options are mw1.small, mw1.medium, mw1.large.

Default value: "mw1.small"

execution_role_arn (string) optional

If create_iam_role is false then set this to the target MWAA execution role

Default value: ""

kms_key (string) optional

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.

Default value: null

max_webservers (number) optional

The maximum number of web servers that you want to run in your environment.

Default value: 2

max_workers (number) optional

The maximum number of workers that can be automatically scaled up. Value need to be between 1 and 25.

Default value: 10

min_webservers (number) optional

The minimum number of web servers that you want to run in your environment.

Default value: 2

min_workers (number) optional

The minimum number of workers that you want to run in your environment.

Default value: 1

plugins_s3_object_version (string) optional

The plugins.zip file version you want to use.

Default value: null

plugins_s3_path (string) optional

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

Default value: null

requirements_s3_object_version (string) optional

The requirements.txt file version you

Default value: null

requirements_s3_path (string) optional

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

Default value: null

scheduler_logs_enabled (bool) optional

Enabling or disabling the collection of logs for the schedulers

Default value: false

scheduler_logs_level (string) optional

Schedulers logging level. Valid values: CRITICAL, ERROR, WARNING, INFO, DEBUG

Default value: "INFO"

schedulers (number) optional

The number of schedulers that you want to run in your environment.

Default value: 2

security_group_create_before_destroy (bool) optional

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.

Default value: true

security_group_create_timeout (string) optional

How long to wait for the security group to be created.

Default value: "10m"

security_group_delete_timeout (string) optional

How long to retry on DependencyViolation errors during security group deletion from
lingering ENIs left by certain AWS services such as Elastic Load Balancing.

Default value: "15m"

security_group_description (string) optional

Security Group for AWS MWAA

Default value: "Managed by Terraform"

security_group_name (list(string)) optional

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.

Default value: [ ]

source_bucket_arn (string) optional

If create_s3_bucket is false then set this to the Amazon Resource Name (ARN) of your Amazon S3 storage bucket.

Default value: null

startup_script_s3_object_version (string) optional

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.

Default value: null

startup_script_s3_path (string) optional

The relative path to the script hosted in your bucket. The script runs as your environment starts before starting the Apache Airflow process.

Default value: null

task_logs_enabled (bool) optional

Enabling or disabling the collection of logs for DAG tasks

Default value: false

task_logs_level (string) optional

DAG tasks logging level. Valid values: CRITICAL, ERROR, WARNING, INFO, DEBUG

Default value: "INFO"

webserver_access_mode (string) optional

Specifies whether the webserver should be accessible over the internet or via your specified VPC. Possible options: PRIVATE_ONLY (default) and PUBLIC_ONLY.

Default value: "PRIVATE_ONLY"

webserver_logs_enabled (bool) optional

Enabling or disabling the collection of logs for the webservers

Default value: false

webserver_logs_level (string) optional

Webserver logging level. Valid values: CRITICAL, ERROR, WARNING, INFO, DEBUG

Default value: "INFO"

weekly_maintenance_window_start (string) optional

Specifies the start date for the weekly maintenance window.

Default value: null

worker_logs_enabled (bool) optional

Enabling or disabling the collection of logs for the workers

Default value: false

worker_logs_level (string) optional

Workers logging level. Valid values: CRITICAL, ERROR, WARNING, INFO, DEBUG

Default value: "INFO"

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

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

Dependencies

Requirements

terraform, version: >= 1.0
aws, version: >= 4.2.0

Providers

aws, version: >= 4.2.0

Modules

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

Resources

The following resources are used by this module:

aws_mwaa_environment.default (resource)

Data Sources

The following data sources are used by this module:

aws_caller_identity.current (data source)
aws_iam_policy_document.this (data source)
aws_partition.current (data source)

Module: mwaa

Usage​

Examples​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Module: `mwaa`

Usage

Examples

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources