aws-cdk-lib.aws_mwaa.CfnEnvironmentProps

CfnEnvironmentProps Struct

Properties for defining a CfnEnvironment.

CfnEnvironmentProps

used as props by

• CfnEnvironment

Source

Generated code

Type last changed

v2.227.0 · 21 Nov 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mwaa as mwaa } from 'aws-cdk-lib';

declare const airflowConfigurationOptions: any;
declare const tags: any;
const cfnEnvironmentProps: mwaa.CfnEnvironmentProps = {
  name: 'name',

  // the properties below are optional
  airflowConfigurationOptions: airflowConfigurationOptions,
  airflowVersion: 'airflowVersion',
  dagS3Path: 'dagS3Path',
  endpointManagement: 'endpointManagement',
  environmentClass: 'environmentClass',
  executionRoleArn: 'executionRoleArn',
  kmsKey: 'kmsKey',
  loggingConfiguration: {
    dagProcessingLogs: {
      cloudWatchLogGroupArn: 'cloudWatchLogGroupArn',
      enabled: false,
      logLevel: 'logLevel',
    },
    schedulerLogs: {
      cloudWatchLogGroupArn: 'cloudWatchLogGroupArn',
      enabled: false,
      logLevel: 'logLevel',
    },
    taskLogs: {
      cloudWatchLogGroupArn: 'cloudWatchLogGroupArn',
      enabled: false,
      logLevel: 'logLevel',
    },
    webserverLogs: {
      cloudWatchLogGroupArn: 'cloudWatchLogGroupArn',
      enabled: false,
      logLevel: 'logLevel',
    },
    workerLogs: {
      cloudWatchLogGroupArn: 'cloudWatchLogGroupArn',
      enabled: false,
      logLevel: 'logLevel',
    },
  },
  maxWebservers: 123,
  maxWorkers: 123,
  minWebservers: 123,
  minWorkers: 123,
  networkConfiguration: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
  },
  pluginsS3ObjectVersion: 'pluginsS3ObjectVersion',
  pluginsS3Path: 'pluginsS3Path',
  requirementsS3ObjectVersion: 'requirementsS3ObjectVersion',
  requirementsS3Path: 'requirementsS3Path',
  schedulers: 123,
  sourceBucketArn: 'sourceBucketArn',
  startupScriptS3ObjectVersion: 'startupScriptS3ObjectVersion',
  startupScriptS3Path: 'startupScriptS3Path',
  tags: tags,
  webserverAccessMode: 'webserverAccessMode',
  weeklyMaintenanceWindowStart: 'weeklyMaintenanceWindowStart',
  workerReplacementStrategy: 'workerReplacementStrategy',
};

Properties

airflowConfigurationOptions?optionalanyairflow_configuration_options?optionalAnyairflowConfigurationOptions?optionalObjectAirflowConfigurationOptions?optionalobjectAirflowConfigurationOptions?optionalinterface{}#

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 .

airflowVersion?optionalstringairflow_version?optionalstrairflowVersion?optionalStringAirflowVersion?optionalstringAirflowVersion?optional*string#

The version of Apache Airflow to use for the environment.

notes

If no value is specified, defaults to the latest version.

If you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect.

Allowed Values : 2.7.2 | 2.8.1 | 2.9.2 | 2.10.1 | 2.10.3 | 3.0.6 (latest)

dagS3Path?optionalstringdag_s3_path?optionalstrdagS3Path?optionalStringDagS3Path?optionalstringDagS3Path?optional*string#

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

For example, dags . To learn more, see Adding or updating DAGs .

endpointManagement?optionalstringendpoint_management?optionalstrendpointManagement?optionalStringEndpointManagement?optionalstringEndpointManagement?optional*string#

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.

environmentClass?optionalstringenvironment_class?optionalstrenvironmentClass?optionalStringEnvironmentClass?optionalstringEnvironmentClass?optional*string#

The environment class type.

Valid values: mw1.micro , mw1.small , mw1.medium , mw1.large , mw1.1large , and mw1.2large . To learn more, see Amazon MWAA environment class .

executionRoleArn?optionalstring | IRoleRefexecution_role_arn?optionaltyping.Union[str, IRoleRef]executionRoleArn?optionalStringExecutionRoleArn?optionalstringExecutionRoleArn?optionalinterface{}#

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 .

kmsKey?optionalstring | IKeyRefkms_key?optionaltyping.Union[str, IKeyRef]kmsKey?optionalStringKmsKey?optionalstringKmsKey?optionalinterface{}#

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

loggingConfiguration?optionalIResolvable | CfnEnvironment.LoggingConfigurationPropertylogging_configuration?optionaltyping.Union[IResolvable, LoggingConfigurationProperty]loggingConfiguration?optionalIResolvableLoggingConfiguration?optionalIResolvableLoggingConfiguration?optionalinterface{}#

The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .

maxWebservers?optionalnumbermax_webservers?optionalint | floatmaxWebservers?optionalNumberMaxWebservers?optionaldoubleMaxWebservers?optional*float64#

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

notes

Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set in MaxWebserers . As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers .

Valid values: For environments larger than mw1.micro, accepts values from 2 to 5 . Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1 .

maxWorkers?optionalnumbermax_workers?optionalint | floatmaxWorkers?optionalNumberMaxWorkers?optionaldoubleMaxWorkers?optional*float64#

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

notes

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 .

minWebservers?optionalnumbermin_webservers?optionalint | floatminWebservers?optionalNumberMinWebservers?optionaldoubleMinWebservers?optional*float64#

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

notes

Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers .

Valid values: For environments larger than mw1.micro, accepts values from 2 to 5 . Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1 .

minWorkers?optionalnumbermin_workers?optionalint | floatminWorkers?optionalNumberMinWorkers?optionaldoubleMinWorkers?optional*float64#

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

notes

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 .

namestringnamestrnameStringNamestringName*stringrequired#

The name of your Amazon MWAA environment.

networkConfiguration?optionalIResolvable | CfnEnvironment.NetworkConfigurationPropertynetwork_configuration?optionaltyping.Union[IResolvable, NetworkConfigurationProperty]networkConfiguration?optionalIResolvableNetworkConfiguration?optionalIResolvableNetworkConfiguration?optionalinterface{}#

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 .

pluginsS3ObjectVersion?optionalstringplugins_s3_object_version?optionalstrpluginsS3ObjectVersion?optionalStringPluginsS3ObjectVersion?optionalstringPluginsS3ObjectVersion?optional*string#

The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .

pluginsS3Path?optionalstringplugins_s3_path?optionalstrpluginsS3Path?optionalStringPluginsS3Path?optionalstringPluginsS3Path?optional*string#

The relative path to the `plugins.zip` file on your Amazon S3 bucket. For example, `plugins.zip` . To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .

requirementsS3ObjectVersion?optionalstringrequirements_s3_object_version?optionalstrrequirementsS3ObjectVersion?optionalStringRequirementsS3ObjectVersion?optionalstringRequirementsS3ObjectVersion?optional*string#

The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .

requirementsS3Path?optionalstringrequirements_s3_path?optionalstrrequirementsS3Path?optionalStringRequirementsS3Path?optionalstringRequirementsS3Path?optional*string#

The relative path to the `requirements.txt` file on your Amazon S3 bucket. For example, `requirements.txt` . To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .

schedulers?optionalnumberschedulers?optionalint | floatschedulers?optionalNumberSchedulers?optionaldoubleSchedulers?optional*float64#

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

• v2 - For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
• v1 - Accepts 1.

sourceBucketArn?optionalstring | IBucketRefsource_bucket_arn?optionaltyping.Union[str, IBucketRef]sourceBucketArn?optionalStringSourceBucketArn?optionalstringSourceBucketArn?optionalinterface{}#

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 .

startupScriptS3ObjectVersion?optionalstringstartup_script_s3_object_version?optionalstrstartupScriptS3ObjectVersion?optionalStringStartupScriptS3ObjectVersion?optionalstringStartupScriptS3ObjectVersion?optional*string#

The version of the startup shell script in your Amazon S3 bucket.

notes

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 .

startupScriptS3Path?optionalstringstartup_script_s3_path?optionalstrstartupScriptS3Path?optionalStringStartupScriptS3Path?optionalstringStartupScriptS3Path?optional*string#

The relative path to the startup shell script in your Amazon S3 bucket. For example, `s3://mwaa-environment/startup.sh` .

notes

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 .

tags?optionalanytags?optionalAnytags?optionalObjectTags?optionalobjectTags?optionalinterface{}#

The key-value tag pairs associated to your environment. For example, `"Environment": "Staging"` . To learn more, see [Tagging](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) .

If you specify new tags for an existing environment, the update requires service interruption before taking effect.

webserverAccessMode?optionalstringwebserver_access_mode?optionalstrwebserverAccessMode?optionalStringWebserverAccessMode?optionalstringWebserverAccessMode?optional*string#

The Apache Airflow *Web server* access mode.

To learn more, see Apache Airflow access modes . Valid values: PRIVATE_ONLY or PUBLIC_ONLY .

weeklyMaintenanceWindowStart?optionalstringweekly_maintenance_window_start?optionalstrweeklyMaintenanceWindowStart?optionalStringWeeklyMaintenanceWindowStart?optionalstringWeeklyMaintenanceWindowStart?optional*string#

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)

workerReplacementStrategy?optionalstringworker_replacement_strategy?optionalstrworkerReplacementStrategy?optionalStringWorkerReplacementStrategy?optionalstringWorkerReplacementStrategy?optional*string#

The worker replacement strategy to use when updating the environment.

notes

Valid values: FORCED, GRACEFUL. FORCED means Apache Airflow workers will be stopped and replaced without waiting for tasks to complete before an update. GRACEFUL means Apache Airflow workers will be able to complete running tasks for up to 12 hours during an update before being stopped and replaced.