Environment - Amazon Managed Workflows for Apache Airflow

Environment

Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Contents

AirflowConfigurationOptions

A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. To learn more, see Apache Airflow configuration options.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Key Pattern: ^[a-z]+([a-z0-9._]*[a-z0-9_]+)?$

Value Length Constraints: Minimum length of 1. Maximum length of 65536.

Value Pattern: ^[ -~]+$

Required: No

AirflowVersion

The Apache Airflow version on your environment. For example, v1.10.12.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^[0-9a-z.]+$

Required: No

Arn

The Amazon Resource Name (ARN) of the Amazon MWAA environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1224.

Pattern: ^arn:aws(-[a-z]+)?:airflow:[a-z0-9\-]+:\d{12}:environment/\w+

Required: No

CreatedAt

The day and time the environment was created.

Type: Timestamp

Required: No

DagS3Path

The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*

Required: No

EnvironmentClass

The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1224.

Pattern: ^arn:aws(-[a-z]+)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Required: No

KmsKey

The AWS Key Management Service (KMS) encryption key used to encrypt the data in your environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1224.

Pattern: ^(((arn:aws(-[a-z]+)?:kms:[a-z]{2}-[a-z]+-\d:\d+:)?key\/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|(arn:aws(-[a-z]+)?:kms:[a-z]{2}-[a-z]+-\d:\d+:)?alias/.+)$

Required: No

LastUpdate

The status of the last update on the environment.

Type: LastUpdate object

Required: No

LoggingConfiguration

The Apache Airflow logs published to CloudWatch Logs.

Type: LoggingConfiguration object

Required: No

MaxWorkers

The maximum number of workers that run in your environment. For example, 20.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

MinWorkers

The minimum number of workers that run in your environment. For example, 2.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

Name

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 80.

Pattern: ^[a-zA-Z][0-9a-zA-Z-_]*$

Required: No

NetworkConfiguration

Describes 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.

Type: NetworkConfiguration object

Required: No

PluginsS3ObjectVersion

The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*

Required: No

RequirementsS3ObjectVersion

The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*

Required: No

Schedulers

The number of Apache Airflow schedulers that run in your Amazon MWAA environment.

Type: Integer

Valid Range: Maximum value of 5.

Required: No

ServiceRoleArn

The Amazon Resource Name (ARN) for the service-linked role of the environment. To learn more, see Amazon MWAA Service-linked role.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1224.

Pattern: ^arn:aws(-[a-z]+)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1224.

Pattern: ^arn:aws(-[a-z]+)?:s3:::[a-z0-9.\-]+$

Required: No

Status

The status of the Amazon MWAA environment. Valid values:

  • CREATING - Indicates the request to create the environment is in progress.

  • CREATE_FAILED - Indicates the request to create the environment failed, and the environment could not be created.

  • AVAILABLE - Indicates the request was successful and the environment is ready to use.

  • UPDATING - Indicates the request to update the environment is in progress.

  • DELETING - Indicates the request to delete the environment is in progress.

  • DELETED - Indicates the request to delete the environment is complete, and the environment has been deleted.

  • UNAVAILABLE - Indicates the request failed, but the environment was unable to rollback and is not in a stable state.

  • UPDATE_FAILED - Indicates the request to update the environment failed, and the environment has rolled back successfully and is ready to use.

We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. To learn more, see Amazon MWAA troubleshooting.

Type: String

Valid Values: CREATING | CREATE_FAILED | AVAILABLE | UPDATING | DELETING | DELETED | UNAVAILABLE | UPDATE_FAILED

Required: No

Tags

The key-value tag pairs associated to your environment. For example, "Environment": "Staging". To learn more, see Tagging AWS resources.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Value Length Constraints: Minimum length of 1. Maximum length of 256.

Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: No

WebserverAccessMode

The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

Type: String

Valid Values: PRIVATE_ONLY | PUBLIC_ONLY

Required: No

WebserverUrl

The Apache Airflow Web server host name for the Amazon MWAA environment. To learn more, see Accessing the Apache Airflow UI.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^https://.+$

Required: No

WeeklyMaintenanceWindowStart

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 9.

Pattern: (MON|TUE|WED|THU|FRI|SAT|SUN):([01]\d|2[0-3]):(00|30)

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: