interface CfnEnvironmentProps

This page is available in another version. Click here for the v2 documentation.

Language	Type name
.NET	`Amazon.CDK.AWS.MWAA.CfnEnvironmentProps`
Java	`software.amazon.awscdk.services.mwaa.CfnEnvironmentProps`
Python	`aws_cdk.aws_mwaa.CfnEnvironmentProps`
TypeScript	`@aws-cdk/aws-mwaa` » `CfnEnvironmentProps`

Properties for defining a CfnEnvironment.

Example

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

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',
  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',
    },
  },
  maxWorkers: 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',
};

Properties

Name	Type	Description
name	`string`	The name of your Amazon MWAA environment.
airflowConfigurationOptions?	`any`	A list of key-value pairs containing the Airflow configuration options for your environment.
airflowVersion?	`string`	The version of Apache Airflow to use for the environment.
dagS3Path?	`string`	The relative path to the DAGs folder on your Amazon S3 bucket.
environmentClass?	`string`	The environment class type.
executionRoleArn?	`string`	The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.
kmsKey?	`string`	The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
loggingConfiguration?	`IResolvable` `\|` `LoggingConfigurationProperty`	The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .
maxWorkers?	`number`	The maximum number of workers that you want to run in your environment.
minWorkers?	`number`	The minimum number of workers that you want to run in your environment.
networkConfiguration?	`IResolvable` `\|` `NetworkConfigurationProperty`	The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
pluginsS3ObjectVersion?	`string`	The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins .
pluginsS3Path?	`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 .
requirementsS3ObjectVersion?	`string`	The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies .
requirementsS3Path?	`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 .
schedulers?	`number`	The number of schedulers that you want to run in your environment. Valid values:.
sourceBucketArn?	`string`	The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
startupScriptS3ObjectVersion?	`string`	The version of the startup shell script in your Amazon S3 bucket.
startupScriptS3Path?	`string`	The relative path to the startup shell script in your Amazon S3 bucket. For example, `s3://mwaa-environment/startup.sh` .
tags?	`any`	The key-value tag pairs associated to your environment.
webserverAccessMode?	`string`	The Apache Airflow Web server access mode.
weeklyMaintenanceWindowStart?	`string`	The day and time of the week to start weekly maintenance updates of your environment in the following format: `DAY:HH:MM` .

name

Type: string

The name of your Amazon MWAA environment.

airflowConfigurationOptions?

Type: any (optional)

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?

Type: string (optional)

The version of Apache Airflow to use for the environment.

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

Allowed Values : 2.0.2 | 1.10.12 | 2.2.2 | 2.4.3 | 2.5.1 (latest)

dagS3Path?

Type: string (optional)

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

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

environmentClass?

Type: string (optional)

The environment class type.

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

executionRoleArn?

Type: string (optional)

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?

Type: string (optional)

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?

Type: IResolvable | LoggingConfigurationProperty (optional)

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

maxWorkers?

Type: number (optional)

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 .

minWorkers?

Type: number (optional)

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 .

networkConfiguration?

Type: IResolvable | NetworkConfigurationProperty (optional)

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?

Type: string (optional)

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

pluginsS3Path?

Type: string (optional)

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip . To learn more, see Installing custom plugins .

requirementsS3ObjectVersion?

Type: string (optional)

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

requirementsS3Path?

Type: string (optional)

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt . To learn more, see Installing Python dependencies .

schedulers?

Type: number (optional)

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.

sourceBucketArn?

Type: string (optional)

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?

Type: string (optional)

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 .

startupScriptS3Path?

Type: string (optional)

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 .

tags?

Type: any (optional)

The key-value tag pairs associated to your environment.

For example, "Environment": "Staging" . To learn more, see Tagging .

webserverAccessMode?

Type: string (optional)

The Apache Airflow Web server access mode.

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

weeklyMaintenanceWindowStart?

Type: string (optional)

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)