AWS::MWAA::Environment
The AWS::MWAA::Environment
resource creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::MWAA::Environment", "Properties" : { "AirflowConfigurationOptions" :
Json
, "AirflowVersion" :String
, "DagS3Path" :String
, "EnvironmentClass" :String
, "ExecutionRoleArn" :String
, "KmsKey" :String
, "LoggingConfiguration" :LoggingConfiguration
, "MaxWorkers" :Integer
, "MinWorkers" :Integer
, "Name" :String
, "NetworkConfiguration" :NetworkConfiguration
, "PluginsS3ObjectVersion" :String
, "PluginsS3Path" :String
, "RequirementsS3ObjectVersion" :String
, "RequirementsS3Path" :String
, "Schedulers" :Integer
, "SourceBucketArn" :String
, "Tags" :Json
, "WebserverAccessMode" :String
, "WeeklyMaintenanceWindowStart" :String
} }
YAML
Type: AWS::MWAA::Environment Properties: AirflowConfigurationOptions:
Json
AirflowVersion:String
DagS3Path:String
EnvironmentClass:String
ExecutionRoleArn:String
KmsKey:String
LoggingConfiguration:LoggingConfiguration
MaxWorkers:Integer
MinWorkers:Integer
Name:String
NetworkConfiguration:NetworkConfiguration
PluginsS3ObjectVersion:String
PluginsS3Path:String
RequirementsS3ObjectVersion:String
RequirementsS3Path:String
Schedulers:Integer
SourceBucketArn:String
Tags:Json
WebserverAccessMode:String
WeeklyMaintenanceWindowStart:String
Properties
AirflowConfigurationOptions
-
A list of key-value pairs containing the Airflow configuration options for your environment. For example,
core.default_timezone: utc
. To learn more, see Apache Airflow configuration options.Required: No
Type: Json
Update requires: No interruption
AirflowVersion
-
The version of Apache Airflow to use for the environment. If no value is specified, defaults to the latest version. Valid values:
2.0.2
,1.10.12
,2.2.2
, and2.4.3
.Required: No
Type: String
Update requires: No interruption
DagS3Path
-
The relative path to the DAGs folder on your Amazon S3 bucket. For example,
dags
. To learn more, see Adding or updating DAGs.Required: No
Type: String
Update requires: No interruption
EnvironmentClass
-
The environment class type. Valid values:
mw1.small
,mw1.medium
,mw1.large
. To learn more, see Amazon MWAA environment class.Required: No
Type: String
Update requires: No interruption
ExecutionRoleArn
-
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment. For example,
arn:aws:iam::123456789:role/my-execution-role
. To learn more, see Amazon MWAA Execution role.Required: No
Type: String
Update requires: No interruption
KmsKey
-
The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. You can use an AWS KMS key managed by MWAA, or a customer-managed KMS key (advanced).
Required: No
Type: String
Update requires: Replacement
LoggingConfiguration
-
The Apache Airflow logs being sent to CloudWatch Logs:
DagProcessingLogs
,SchedulerLogs
,TaskLogs
,WebserverLogs
,WorkerLogs
.Required: No
Type: LoggingConfiguration
Update requires: No interruption
MaxWorkers
-
The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the
MaxWorkers
field. For example,20
. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify inMinWorkers
.Required: No
Type: Integer
Update requires: No interruption
MinWorkers
-
The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the
MaxWorkers
field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in theMinWorkers
field. For example,2
.Required: No
Type: Integer
Update requires: No interruption
Name
-
The name of your Amazon MWAA environment.
Required: Yes
Type: String
Update requires: Replacement
NetworkConfiguration
-
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. To learn more, see About networking on Amazon MWAA.
Required: No
Type: NetworkConfiguration
Update requires: No interruption
PluginsS3ObjectVersion
-
The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins.
Required: No
Type: String
Update requires: No interruption
PluginsS3Path
-
The relative path to the
plugins.zip
file on your Amazon S3 bucket. For example,plugins.zip
. To learn more, see Installing custom plugins.Required: No
Type: String
Update requires: No interruption
RequirementsS3ObjectVersion
-
The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies.
Required: No
Type: String
Update requires: No interruption
RequirementsS3Path
-
The relative path to the
requirements.txt
file on your Amazon S3 bucket. For example,requirements.txt
. To learn more, see Installing Python dependencies.Required: No
Type: String
Update requires: No interruption
Schedulers
-
The number of schedulers that you want to run in your environment. Valid values:
-
v2 - Accepts between 2 to 5. Defaults to 2.
-
v1 - Accepts 1.
Required: No
Type: Integer
Update requires: No interruption
-
SourceBucketArn
-
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example,
arn:aws:s3:::my-airflow-bucket-unique-name
. To learn more, see Create an Amazon S3 bucket for Amazon MWAA.Required: No
Type: String
Update requires: No interruption
Tags
-
The key-value tag pairs associated to your environment. For example,
"Environment": "Staging"
. To learn more, see Tagging.Required: No
Type: Json
Update requires: No interruption
WebserverAccessMode
-
The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes. Valid values:
PRIVATE_ONLY
orPUBLIC_ONLY
.Required: No
Type: String
Update requires: No interruption
WeeklyMaintenanceWindowStart
-
The day and time of the week to start weekly maintenance updates of your environment in the following format:
DAY:HH:MM
. For example:TUE:03:30
. You can specify a start time in 30 minute increments only. Supported input includes the following:-
MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)
Required: No
Type: String
Update requires: No interruption
-
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the environment details.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt.
Arn
-
The ARN for the Amazon MWAA environment.
LoggingConfiguration.DagProcessingLogs.CloudWatchLogGroupArn
-
The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published.
LoggingConfiguration.SchedulerLogs.CloudWatchLogGroupArn
-
The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published.
LoggingConfiguration.TaskLogs.CloudWatchLogGroupArn
-
The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published.
LoggingConfiguration.WebserverLogs.CloudWatchLogGroupArn
-
The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published.
LoggingConfiguration.WorkerLogs.CloudWatchLogGroupArn
-
The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published.
WebserverUrl
-
The URL of your Apache Airflow UI.
Examples
Create a MWAA environment - JSON
The following example shows how to create a MWAA environment:
JSON
{ "Environment": { "Type": "AWS::MWAA::Environment", "Properties": { "Name": "my-airflow-environment", "AirflowConfigurationOptions": { "logging.logging_level": "INFO", "core.default_timezone": "utc" }, "Tags": { "Environment": "Staging", "Team": "Analytics" }, "NetworkConfiguration": { "SubnetIds": [ "subnet-123456", "subnet-789011" ], "SecurityGroupIds": [ "sg-0101010" ] }, "LoggingConfiguration": { "DagProcessingLogs": { "Enabled": true, "LogLevel": "INFO" }, "SchedulerLogs": { "Enabled": false, "LogLevel": "INFO" }, "TaskLogs": { "Enabled": true, "LogLevel": "INFO" }, "WebserverLogs": { "Enabled": false, "LogLevel": "INFO" }, "WorkerLogs": { "Enabled": false, "LogLevel": "INFO" } }, "SourceBucketArn": "arn:aws:s3:::my-dags-bucket", "ExecutionRoleArn": "arn:aws:iam::012345678900:role/service-role/my-execution-role", "MaxWorkers": 1, "DagS3Path": "dags", "EnvironmentClass": "mw1.small" } } }
Create a MWAA environment - YAML
The following example shows how to create a MWAA environment:
YAML
Environment: Properties: AirflowConfigurationOptions: core.default_timezone: utc logging.logging_level: INFO DagS3Path: dags EnvironmentClass: mw1.small ExecutionRoleArn: "arn:aws:iam::012345678900:role/service-role/my-execution-role" LoggingConfiguration: DagProcessingLogs: Enabled: true LogLevel: INFO SchedulerLogs: Enabled: false LogLevel: INFO TaskLogs: Enabled: true LogLevel: INFO WebserverLogs: Enabled: false LogLevel: INFO WorkerLogs: Enabled: false LogLevel: INFO MaxWorkers: 1 Name: my-airflow-environment NetworkConfiguration: SecurityGroupIds: - sg-0101010 SubnetIds: - subnet-123456 - subnet-789011 SourceBucketArn: "arn:aws:s3:::my-dags-bucket" Tags: Environment: Staging Team: Analytics Type: "AWS::MWAA::Environment"