update-environment¶

Description¶

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

Synopsis¶

  update-environment
[--airflow-configuration-options <value>]
[--airflow-version <value>]
[--dag-s3-path <value>]
[--environment-class <value>]
[--execution-role-arn <value>]
[--logging-configuration <value>]
[--max-workers <value>]
[--min-workers <value>]
--name <value>
[--network-configuration <value>]
[--plugins-s3-object-version <value>]
[--plugins-s3-path <value>]
[--requirements-s3-object-version <value>]
[--requirements-s3-path <value>]
[--schedulers <value>]
[--source-bucket-arn <value>]
[--webserver-access-mode <value>]
[--weekly-maintenance-window-start <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--airflow-configuration-options (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--airflow-version (string)

The Apache Airflow version for your environment. For example, v1.10.12 . If no value is specified, defaults to the latest version. Valid values: v1.10.12 .

--dag-s3-path (string)

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

--environment-class (string)

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

--execution-role-arn (string)

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 .

--logging-configuration (structure)

Defines the Apache Airflow logs to send to CloudWatch Logs: DagProcessingLogs , SchedulerLogs , TaskLogs , WebserverLogs , WorkerLogs .

DagProcessingLogs -> (structure)

Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs ). Valid values: CloudWatchLogGroupArn , Enabled , LogLevel .

Enabled -> (boolean)

Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs ) in CloudWatch Logs.

LogLevel -> (string)

Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs ) to CloudWatch Logs. Valid values: CRITICAL , ERROR , WARNING , INFO .

SchedulerLogs -> (structure)

Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs ). Valid values: CloudWatchLogGroupArn , Enabled , LogLevel .

Enabled -> (boolean)

Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs ) in CloudWatch Logs.

LogLevel -> (string)

Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs ) to CloudWatch Logs. Valid values: CRITICAL , ERROR , WARNING , INFO .

TaskLogs -> (structure)

Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs ). Valid values: CloudWatchLogGroupArn , Enabled , LogLevel .

Enabled -> (boolean)

Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs ) in CloudWatch Logs.

LogLevel -> (string)

Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs ) to CloudWatch Logs. Valid values: CRITICAL , ERROR , WARNING , INFO .

WebserverLogs -> (structure)

Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs ). Valid values: CloudWatchLogGroupArn , Enabled , LogLevel .

Enabled -> (boolean)

Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs ) in CloudWatch Logs.

LogLevel -> (string)

Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs ) to CloudWatch Logs. Valid values: CRITICAL , ERROR , WARNING , INFO .

WorkerLogs -> (structure)

Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs ). Valid values: CloudWatchLogGroupArn , Enabled , LogLevel .

Enabled -> (boolean)

Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs ) in CloudWatch Logs.

LogLevel -> (string)

Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs ) to CloudWatch Logs. Valid values: CRITICAL , ERROR , WARNING , INFO .

Shorthand Syntax:

DagProcessingLogs={Enabled=boolean,LogLevel=string},SchedulerLogs={Enabled=boolean,LogLevel=string},TaskLogs={Enabled=boolean,LogLevel=string},WebserverLogs={Enabled=boolean,LogLevel=string},WorkerLogs={Enabled=boolean,LogLevel=string}

JSON Syntax:

{
  "DagProcessingLogs": {
    "Enabled": true|false,
    "LogLevel": "CRITICAL"|"ERROR"|"WARNING"|"INFO"|"DEBUG"
  },
  "SchedulerLogs": {
    "Enabled": true|false,
    "LogLevel": "CRITICAL"|"ERROR"|"WARNING"|"INFO"|"DEBUG"
  },
  "TaskLogs": {
    "Enabled": true|false,
    "LogLevel": "CRITICAL"|"ERROR"|"WARNING"|"INFO"|"DEBUG"
  },
  "WebserverLogs": {
    "Enabled": true|false,
    "LogLevel": "CRITICAL"|"ERROR"|"WARNING"|"INFO"|"DEBUG"
  },
  "WorkerLogs": {
    "Enabled": true|false,
    "LogLevel": "CRITICAL"|"ERROR"|"WARNING"|"INFO"|"DEBUG"
  }
}

--max-workers (integer)

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 .

--min-workers (integer)

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 .

--name (string)

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

--network-configuration (structure)

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 .

SecurityGroupIds -> (list)

A list of 1 or more security group IDs. Accepts up to 5 security group IDs. A security group must be attached to the same VPC as the subnets. To learn more, see Security in your VPC on Amazon MWAA .

(string)

Shorthand Syntax:

SecurityGroupIds=string,string

JSON Syntax:

{
  "SecurityGroupIds": ["string", ...]
}

--plugins-s3-object-version (string)

The version of the plugins.zip file on your Amazon S3 bucket. A version must be specified each time a plugins.zip file is updated. To learn more, see How S3 Versioning works .

--plugins-s3-path (string)

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. To learn more, see Installing custom plugins .

--requirements-s3-object-version (string)

The version of the requirements.txt file on your Amazon S3 bucket. A version must be specified each time a requirements.txt file is updated. To learn more, see How S3 Versioning works .

--requirements-s3-path (string)

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. To learn more, see Installing Python dependencies .

--schedulers (integer)

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

--source-bucket-arn (string)

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 .

--webserver-access-mode (string)

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

Possible values:

PRIVATE_ONLY

PUBLIC_ONLY

--weekly-maintenance-window-start (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)

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output¶

Arn -> (string)

The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment .

Table of Contents

Feedback

User Guide

update-environment¶

Description¶

Synopsis¶

Options¶

Output¶