create_environment¶

create_environment(**kwargs)¶

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

Request Syntax

response = client.create_environment(
    AirflowConfigurationOptions={
        'string': 'string'
    },
    AirflowVersion='string',
    DagS3Path='string',
    EnvironmentClass='string',
    ExecutionRoleArn='string',
    KmsKey='string',
    LoggingConfiguration={
        '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'
        }
    },
    MaxWorkers=123,
    MinWorkers=123,
    Name='string',
    NetworkConfiguration={
        'SecurityGroupIds': [
            'string',
        ],
        'SubnetIds': [
            'string',
        ]
    },
    PluginsS3ObjectVersion='string',
    PluginsS3Path='string',
    RequirementsS3ObjectVersion='string',
    RequirementsS3Path='string',
    Schedulers=123,
    SourceBucketArn='string',
    Tags={
        'string': 'string'
    },
    WebserverAccessMode='PRIVATE_ONLY'|'PUBLIC_ONLY',
    WeeklyMaintenanceWindowStart='string'
)

Parameters

AirflowConfigurationOptions (dict) --
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.
- (string) --
  - (string) --
AirflowVersion (string) -- The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. Valid values: 1.10.12 , 2.0.2 , 2.2.2 , and 2.4.3 . For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).
DagS3Path (string) --
[REQUIRED]

The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags . To learn more, see Adding or updating DAGs.
EnvironmentClass (string) -- The environment class type. Valid values: mw1.small , mw1.medium , mw1.large . To learn more, see Amazon MWAA environment class.
ExecutionRoleArn (string) --
[REQUIRED]

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 . To learn more, see Amazon MWAA Execution role.
KmsKey (string) -- 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). To learn more, see Create an Amazon MWAA environment.
LoggingConfiguration (dict) --
Defines the Apache Airflow logs to send to CloudWatch Logs.
- DagProcessingLogs (dict) --
  Publishes Airflow DAG processing logs to CloudWatch Logs.
  - Enabled (boolean) -- [REQUIRED]
    Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs ).
  - LogLevel (string) -- [REQUIRED]
    Defines the Apache Airflow log level (e.g. INFO ) to send to CloudWatch Logs.
- SchedulerLogs (dict) --
  Publishes Airflow scheduler logs to CloudWatch Logs.
  - Enabled (boolean) -- [REQUIRED]
    Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs ).
  - LogLevel (string) -- [REQUIRED]
    Defines the Apache Airflow log level (e.g. INFO ) to send to CloudWatch Logs.
- TaskLogs (dict) --
  Publishes Airflow task logs to CloudWatch Logs.
  - Enabled (boolean) -- [REQUIRED]
    Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs ).
  - LogLevel (string) -- [REQUIRED]
    Defines the Apache Airflow log level (e.g. INFO ) to send to CloudWatch Logs.
- WebserverLogs (dict) --
  Publishes Airflow web server logs to CloudWatch Logs.
  - Enabled (boolean) -- [REQUIRED]
    Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs ).
  - LogLevel (string) -- [REQUIRED]
    Defines the Apache Airflow log level (e.g. INFO ) to send to CloudWatch Logs.
- WorkerLogs (dict) --
  Publishes Airflow worker logs to CloudWatch Logs.
  - Enabled (boolean) -- [REQUIRED]
    Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs ).
  - LogLevel (string) -- [REQUIRED]
    Defines the Apache Airflow log level (e.g. INFO ) to send to CloudWatch Logs.
MaxWorkers (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 .
MinWorkers (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) --
[REQUIRED]

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment .
NetworkConfiguration (dict) --
[REQUIRED]

The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.
- SecurityGroupIds (list) --
  A list of security group IDs. To learn more, see Security in your VPC on Amazon MWAA.
  - (string) --
- SubnetIds (list) --
  A list of subnet IDs. To learn more, see About networking on Amazon MWAA.
  - (string) --
PluginsS3ObjectVersion (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.
PluginsS3Path (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.
RequirementsS3ObjectVersion (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.
RequirementsS3Path (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 environment. Valid values:
- v2 - Accepts between 2 to 5. Defaults to 2.
- v1 - Accepts 1.
SourceBucketArn (string) --
[REQUIRED]

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.
Tags (dict) --
The key-value tag pairs you want to associate to your environment. For example, "Environment": "Staging" . To learn more, see Tagging Amazon Web Services resources.
- (string) --
  - (string) --
WebserverAccessMode (string) -- The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.
WeeklyMaintenanceWindowStart (string) -- 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.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string'
}

Response Structure

(dict) --
- Arn (string) --
  
  The Amazon Resource Name (ARN) returned in the response for the environment.

Exceptions

MWAA.Client.exceptions.ValidationException
MWAA.Client.exceptions.InternalServerException

Table Of Contents

create_environment¶