String name
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
Map<K,V> airflowConfigurationOptions
A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, see Apache Airflow configuration options.
String airflowVersion
The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).
Valid values: 1.10.12, 2.0.2, 2.2.2, 2.4.3,
2.5.1, 2.6.3, 2.7.2
String dagS3Path
The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. For more
information, see Adding
or updating DAGs.
String endpointManagement
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by
Amazon MWAA. If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in
your VPC. If set to CUSTOMER, you must create, and manage, the VPC endpoints for your VPC. If you
choose to create an environment in a shared VPC, you must set this value to CUSTOMER. In a shared
VPC deployment, the environment will remain in PENDING status until you create the VPC endpoints. If
you do not take action to create the endpoints within 72 hours, the status will change to
CREATE_FAILED. You can delete the failed environment and create a new one.
String environmentClass
The environment class type. Valid values: mw1.small, mw1.medium, mw1.large
. For more information, see Amazon MWAA environment
class.
String executionRoleArn
The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an Amazon Web
Services Identity and Access Management (IAM) role that grants MWAA permission to access Amazon Web Services
services and resources used by your environment. For example,
arn:aws:iam::123456789:role/my-execution-role. For more information, see Amazon MWAA Execution role.
String kmsKey
The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed CMK (advanced). For more information, see Create an Amazon MWAA environment.
LoggingConfigurationInput loggingConfiguration
Defines the Apache Airflow logs to send to CloudWatch Logs.
Integer 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 in MinWorkers.
Integer 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 the
MinWorkers field. For example, 2.
String name
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
NetworkConfiguration networkConfiguration
The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see About networking on Amazon MWAA.
String pluginsS3ObjectVersion
The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a plugins.zip file is updated. For more information, see How S3 Versioning works.
String pluginsS3Path
The relative path to the plugins.zip file on your Amazon S3 bucket. For example,
plugins.zip. If specified, then the plugins.zip version is required. For more
information, see Installing custom
plugins.
String requirementsS3ObjectVersion
The version of the requirements.txt file on your Amazon S3 bucket. You must specify a version each
time a requirements.txt file is updated. For more information, see How S3 Versioning
works.
String requirementsS3Path
The relative path to the requirements.txt file on your Amazon S3 bucket. For example,
requirements.txt. If specified, then a version is required. For more information, see Installing Python
dependencies.
Integer schedulers
The number of Apache Airflow schedulers to run in your environment. Valid values:
v2 - Accepts between 2 to 5. Defaults to 2.
v1 - Accepts 1.
String 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. For more information, see Create an Amazon S3 bucket for
Amazon MWAA.
String startupScriptS3ObjectVersion
The version of the startup shell script in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file every time you update the script.
Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
For more information, see Using a startup script.
String startupScriptS3Path
The relative path to the startup shell script in your Amazon S3 bucket. For example,
s3://mwaa-environment/startup.sh.
Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see Using a startup script.
Map<K,V> tags
The key-value tag pairs you want to associate to your environment. For example,
"Environment": "Staging". For more information, see Tagging Amazon Web Services resources.
String webserverAccessMode
Defines the access mode for the Apache Airflow web server. For more information, see Apache Airflow access modes.
String weeklyMaintenanceWindowStart
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time 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.
String arn
The Amazon Resource Name (ARN) returned in the response for the environment.
String name
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
String name
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
Map<K,V> airflowConfigurationOptions
A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. For more information, see Apache Airflow configuration options.
String airflowVersion
The Apache Airflow version on your environment.
Valid values: 1.10.12, 2.0.2, 2.2.2, 2.4.3,
2.5.1, 2.6.3, 2.7.2.
String arn
The Amazon Resource Name (ARN) of the Amazon MWAA environment.
String celeryExecutorQueue
The queue ARN for the environment's Celery Executor. Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers. When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.
Date createdAt
The day and time the environment was created.
String dagS3Path
The relative path to the DAGs folder in your Amazon S3 bucket. For example,
s3://mwaa-environment/dags. For more information, see Adding or updating DAGs.
String databaseVpcEndpointService
The VPC endpoint for the environment's Amazon RDS database.
String endpointManagement
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by
Amazon MWAA. If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in
your VPC. If set to CUSTOMER, you must create, and manage, the VPC endpoints in your VPC.
String environmentClass
The environment class type. Valid values: mw1.small, mw1.medium, mw1.large
. For more information, see Amazon MWAA environment
class.
String executionRoleArn
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services
resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. For more
information, see Amazon MWAA
Execution role.
String kmsKey
The Amazon Web Services Key Management Service (KMS) encryption key used to encrypt the data in your environment.
LastUpdate lastUpdate
The status of the last update on the environment.
LoggingConfiguration loggingConfiguration
The Apache Airflow logs published to CloudWatch Logs.
Integer maxWorkers
The maximum number of workers that run in your environment. For example, 20.
Integer minWorkers
The minimum number of workers that run in your environment. For example, 2.
String name
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
NetworkConfiguration networkConfiguration
Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see About networking on Amazon MWAA.
String pluginsS3ObjectVersion
The version of the plugins.zip file in your Amazon S3 bucket. You must specify the version ID that Amazon
S3 assigns to the file.
Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
For more information, see Installing custom plugins.
String pluginsS3Path
The relative path to the file in your Amazon S3 bucket. For example,
s3://mwaa-environment/plugins.zip. For more information, see Installing custom
plugins.
String requirementsS3ObjectVersion
The version of the requirements.txt file on your Amazon S3 bucket. You must specify the version ID that Amazon
S3 assigns to the file.
Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
For more information, see Installing Python dependencies.
String requirementsS3Path
The relative path to the requirements.txt file in your Amazon S3 bucket. For example,
s3://mwaa-environment/requirements.txt. For more information, see Installing Python
dependencies.
Integer schedulers
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
String serviceRoleArn
The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, see Amazon MWAA Service-linked role.
String 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. For more information, see Create an Amazon S3 bucket for
Amazon MWAA.
String startupScriptS3ObjectVersion
The version of the startup shell script in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.
Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
For more information, see Using a startup script.
String startupScriptS3Path
The relative path to the startup shell script in your Amazon S3 bucket. For example,
s3://mwaa-environment/startup.sh.
Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see Using a startup script.
String status
The status of the Amazon MWAA environment.
Valid values:
CREATING - Indicates the request to create the environment is in progress.
CREATING_SNAPSHOT - Indicates the request to update environment details, or upgrade the environment
version, is in progress and Amazon MWAA is creating a storage volume snapshot of the Amazon RDS database cluster
associated with the environment. A database snapshot is a backup created at a specific point in time. Amazon MWAA
uses snapshots to recover environment metadata if the process to update or upgrade an environment fails.
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.
PENDING - Indicates the request was successful, but the process to create the environment is paused
until you create the required VPC endpoints in your VPC. After you create the VPC endpoints, the process resumes.
UPDATING - Indicates the request to update the environment is in progress.
ROLLING_BACK - Indicates the request to update environment details, or upgrade the environment
version, failed and Amazon MWAA is restoring the environment using the latest storage volume snapshot.
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. For more information, see Amazon MWAA troubleshooting.
Map<K,V> tags
The key-value tag pairs associated to your environment. For example, "Environment": "Staging". For
more information, see Tagging Amazon Web
Services resources.
String webserverAccessMode
The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.
String webserverUrl
The Apache Airflow Web server host name for the Amazon MWAA environment. For more information, see Accessing the Apache Airflow UI.
String webserverVpcEndpointService
The VPC endpoint for the environment's web server.
String 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.
String name
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
Environment environment
An object containing all available details about the environment.
Date createdAt
The day and time of the last update on the environment.
UpdateError error
The error that was encountered during the last update of the environment.
String source
The source of the last update to the environment. Includes internal processes by Amazon MWAA, such as an environment maintenance update.
String status
The status of the last update on the environment.
String resourceArn
The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example,
arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
Map<K,V> tags
The key-value tag pairs associated to your environment. For more information, see Tagging Amazon Web Services resources.
ModuleLoggingConfiguration dagProcessingLogs
The Airflow DAG processing logs published to CloudWatch Logs and the log level.
ModuleLoggingConfiguration schedulerLogs
The Airflow scheduler logs published to CloudWatch Logs and the log level.
ModuleLoggingConfiguration taskLogs
The Airflow task logs published to CloudWatch Logs and the log level.
ModuleLoggingConfiguration webserverLogs
The Airflow web server logs published to CloudWatch Logs and the log level.
ModuleLoggingConfiguration workerLogs
The Airflow worker logs published to CloudWatch Logs and the log level.
ModuleLoggingConfigurationInput dagProcessingLogs
Publishes Airflow DAG processing logs to CloudWatch Logs.
ModuleLoggingConfigurationInput schedulerLogs
Publishes Airflow scheduler logs to CloudWatch Logs.
ModuleLoggingConfigurationInput taskLogs
Publishes Airflow task logs to CloudWatch Logs.
ModuleLoggingConfigurationInput webserverLogs
Publishes Airflow web server logs to CloudWatch Logs.
ModuleLoggingConfigurationInput workerLogs
Publishes Airflow worker logs to CloudWatch Logs.
List<E> dimensions
Internal only. The dimensions associated with the metric.
String metricName
Internal only. The name of the metric.
StatisticSet statisticValues
Internal only. The statistical values for the metric.
Date timestamp
Internal only. The time the metric data was received.
String unit
Internal only. The unit used to store the metric.
Double value
Internal only. The value for the metric.
String cloudWatchLogGroupArn
The Amazon Resource Name (ARN) for the CloudWatch Logs group where the Apache Airflow log type (e.g.
DagProcessingLogs) is published. For example,
arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*
.
Boolean enabled
Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs) is enabled.
String logLevel
The Apache Airflow log level for the log type (e.g. DagProcessingLogs).
List<E> securityGroupIds
A list of security group IDs. For more information, see Security in your VPC on Amazon MWAA.
List<E> subnetIds
A list of subnet IDs. For more information, see About networking on Amazon MWAA.
String environmentName
Internal only. The name of the environment.
List<E> metricData
Internal only. Publishes metrics to Amazon CloudWatch. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.
Double maximum
Internal only. The maximum value of the sample set.
Double minimum
Internal only. The minimum value of the sample set.
Integer sampleCount
Internal only. The number of samples used for the statistic set.
Double sum
Internal only. The sum of values for the sample set.
String resourceArn
The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example,
arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
Map<K,V> tags
The key-value tag pairs you want to associate to your environment. For example,
"Environment": "Staging". For more information, see Tagging Amazon Web Services resources.
Map<K,V> airflowConfigurationOptions
A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, see Apache Airflow configuration options.
String airflowVersion
The Apache Airflow version for your environment. To upgrade your environment, specify a newer version of Apache Airflow supported by Amazon MWAA.
Before you upgrade an environment, make sure your requirements, DAGs, plugins, and other resources used in your workflows are compatible with the new Apache Airflow version. For more information about updating your resources, see Upgrading an Amazon MWAA environment.
Valid values: 1.10.12, 2.0.2, 2.2.2, 2.4.3,
2.5.1, 2.6.3, 2.7.2.
String dagS3Path
The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. For more
information, see Adding
or updating DAGs.
String environmentClass
The environment class type. Valid values: mw1.small, mw1.medium, mw1.large
. For more information, see Amazon MWAA environment
class.
String executionRoleArn
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services
resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. For more
information, see Amazon MWAA
Execution role.
LoggingConfigurationInput loggingConfiguration
The Apache Airflow log types to send to CloudWatch Logs.
Integer 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 in MinWorkers.
Integer 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 the
MinWorkers field. For example, 2.
String name
The name of your Amazon MWAA environment. For example, MyMWAAEnvironment.
UpdateNetworkConfigurationInput networkConfiguration
The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see About networking on Amazon MWAA.
String pluginsS3ObjectVersion
The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a
plugins.zip file is updated. For more information, see How S3 Versioning
works.
String pluginsS3Path
The relative path to the plugins.zip file on your Amazon S3 bucket. For example,
plugins.zip. If specified, then the plugins.zip version is required. For more information, see Installing custom
plugins.
String requirementsS3ObjectVersion
The version of the requirements.txt file on your Amazon S3 bucket. You must specify a version each time a
requirements.txt file is updated. For more information, see How S3 Versioning
works.
String requirementsS3Path
The relative path to the requirements.txt file on your Amazon S3 bucket. For example,
requirements.txt. If specified, then a file version is required. For more information, see Installing Python
dependencies.
Integer schedulers
The number of Apache Airflow schedulers to run in your Amazon MWAA environment.
String 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. For more information, see Create an Amazon S3 bucket for
Amazon MWAA.
String startupScriptS3ObjectVersion
The version of the startup shell script in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file every time you update the script.
Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
For more information, see Using a startup script.
String startupScriptS3Path
The relative path to the startup shell script in your Amazon S3 bucket. For example,
s3://mwaa-environment/startup.sh.
Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see Using a startup script.
String webserverAccessMode
The Apache Airflow Web server access mode. For more information, see Apache Airflow access modes.
String weeklyMaintenanceWindowStart
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time 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.
String arn
The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example,
arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
List<E> securityGroupIds
A list of security group IDs. A security group must be attached to the same VPC as the subnets. For more information, see Security in your VPC on Amazon MWAA.
Copyright © 2023. All rights reserved.