2.178.2

interface CfnEnvironmentProps

LanguageType name
.NETAmazon.CDK.AWS.MWAA.CfnEnvironmentProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsmwaa#CfnEnvironmentProps
Javasoftware.amazon.awscdk.services.mwaa.CfnEnvironmentProps
Pythonaws_cdk.aws_mwaa.CfnEnvironmentProps
TypeScript aws-cdk-lib » aws_mwaa » CfnEnvironmentProps

Properties for defining a CfnEnvironment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html

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

Properties

NameTypeDescription
namestringThe name of your Amazon MWAA environment.
airflowConfigurationOptions?anyA list of key-value pairs containing the Airflow configuration options for your environment.
airflowVersion?stringThe version of Apache Airflow to use for the environment.
dagS3Path?stringThe relative path to the DAGs folder on your Amazon S3 bucket.
endpointManagement?stringDefines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
environmentClass?stringThe environment class type.
executionRoleArn?stringThe Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.
kmsKey?stringThe AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
loggingConfiguration?IResolvable | LoggingConfigurationPropertyThe Apache Airflow logs being sent to CloudWatch Logs: DagProcessingLogs , SchedulerLogs , TaskLogs , WebserverLogs , WorkerLogs .
maxWebservers?numberThe maximum number of web servers that you want to run in your environment.
maxWorkers?numberThe maximum number of workers that you want to run in your environment.
minWebservers?numberThe minimum number of web servers that you want to run in your environment.
minWorkers?numberThe minimum number of workers that you want to run in your environment.
networkConfiguration?IResolvable | NetworkConfigurationPropertyThe VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
pluginsS3ObjectVersion?stringThe version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins .
pluginsS3Path?stringThe relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip . To learn more, see Installing custom plugins .
requirementsS3ObjectVersion?stringThe version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies .
requirementsS3Path?stringThe relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt . To learn more, see Installing Python dependencies .
schedulers?numberThe number of schedulers that you want to run in your environment. Valid values:.
sourceBucketArn?stringThe Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
startupScriptS3ObjectVersion?stringThe version of the startup shell script in your Amazon S3 bucket.
startupScriptS3Path?stringThe relative path to the startup shell script in your Amazon S3 bucket. For example, s3://mwaa-environment/startup.sh .
tags?anyThe key-value tag pairs associated to your environment. For example, "Environment": "Staging" . To learn more, see Tagging .
webserverAccessMode?stringThe Apache Airflow Web server access mode.
weeklyMaintenanceWindowStart?stringThe 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-name

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-airflowconfigurationoptions

airflowVersion?

Type: string (optional)

The version of Apache Airflow to use for the environment.

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 : 1.10.12 | 2.0.2 | 2.2.2 | 2.4.3 | 2.5.1 | 2.6.3 | 2.7.2 | 2.8.1 | 2.9.2 (latest)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-airflowversion

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-dags3path

endpointManagement?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-endpointmanagement

environmentClass?

Type: string (optional)

The environment class type.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-environmentclass

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-executionrolearn

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-kmskey

loggingConfiguration?

Type: IResolvable | LoggingConfigurationProperty (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-loggingconfiguration

maxWebservers?

Type: number (optional)

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

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-maxwebservers

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-maxworkers

minWebservers?

Type: number (optional)

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

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-minwebservers

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-minworkers

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-networkconfiguration

pluginsS3ObjectVersion?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-pluginss3objectversion

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-pluginss3path

requirementsS3ObjectVersion?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-requirementss3objectversion

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-requirementss3path

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-schedulers

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-sourcebucketarn

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-startupscripts3objectversion

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-startupscripts3path

tags?

Type: any (optional)

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

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-tags

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-webserveraccessmode

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)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-weeklymaintenancewindowstart

← PreviousNext →