Skip to content

Latest commit

 

History

History
162 lines (132 loc) · 17.5 KB

README.md

File metadata and controls

162 lines (132 loc) · 17.5 KB
Raw
tags
component/mwaa
layer/unassigned
provider/aws

Component: mwaa

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.

  • MWAA creates a VPC interface endpoint for the Airflow webserver and an interface endpoint for the pgsql metadatabase.
    • the endpoints are created in the AZs mapped to your private subnets
  • MWAA binds an IP address from your private subnet to the interface endpoint

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

Requirements

Name Version
terraform >= 1.0.0
aws >= 4.0

Providers

Name Version
aws >= 4.0

Modules

Name Source Version
iam_policy cloudposse/iam-policy/aws 0.4.0
iam_roles ../account-map/modules/iam-roles n/a
mwaa_environment cloudposse/mwaa/aws 0.4.8
this cloudposse/label/null 0.25.0
vpc cloudposse/stack-config/yaml//modules/remote-state 1.5.0
vpc_ingress cloudposse/stack-config/yaml//modules/remote-state 1.5.0

Resources

Name Type
aws_iam_policy.mwaa_web_server_access resource
aws_iam_role_policy_attachment.mwaa_web_server_access resource
aws_iam_role_policy_attachment.secrets_manager_read_write resource

Inputs

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
airflow_configuration_options The Airflow override options map(string) {} no
airflow_version Airflow version of the MWAA environment, will be set by default to the latest version that MWAA supports. string "" no
allow_ingress_from_vpc_stages List of stages to pull VPC ingress cidr and add to security group list(string) 
[
  "auto",
  "corp"
]
 no
allowed_cidr_blocks List of CIDR blocks to be allowed to connect to the MWAA cluster list(string) [] no
allowed_security_groups A list of IDs of Security Groups to allow access to the security group created by this module. list(string) [] no
allowed_web_access_role_arns List of role ARNs to allow airflow web access list(string) [] no
allowed_web_access_role_names List of role names to allow airflow web 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
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 Path to dags in s3 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
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
source_bucket_arn 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
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
webserver_access_mode Specifies whether the webserver is accessible over the internet, PUBLIC_ONLY or PRIVATE_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 ARN of 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 MWAA Environment
s3_bucket_arn ID of S3 bucket.
security_group_id ID of the MWAA Security Group(s)
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

References