pulumi-aws-kotlin/com.pulumi.aws.mwaa.kotlin/EnvironmentArgs

EnvironmentArgs

data class EnvironmentArgs(val airflowConfigurationOptions: Output<Map<String, String>>? = null, val airflowVersion: Output<String>? = null, val dagS3Path: Output<String>? = null, val environmentClass: Output<String>? = null, val executionRoleArn: Output<String>? = null, val kmsKey: Output<String>? = null, val loggingConfiguration: Output<EnvironmentLoggingConfigurationArgs>? = null, val maxWorkers: Output<Int>? = null, val minWorkers: Output<Int>? = null, val name: Output<String>? = null, val networkConfiguration: Output<EnvironmentNetworkConfigurationArgs>? = null, val pluginsS3ObjectVersion: Output<String>? = null, val pluginsS3Path: Output<String>? = null, val requirementsS3ObjectVersion: Output<String>? = null, val requirementsS3Path: Output<String>? = null, val schedulers: Output<Int>? = null, val sourceBucketArn: Output<String>? = null, val startupScriptS3ObjectVersion: Output<String>? = null, val startupScriptS3Path: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val webserverAccessMode: Output<String>? = null, val weeklyMaintenanceWindowStart: Output<String>? = null) : ConvertibleToJava<EnvironmentArgs>

Creates a MWAA Environment resource.

Example Usage

A MWAA Environment requires an IAM role (aws.iam.Role), two subnets in the private zone (aws.ec2.Subnet) and a versioned S3 bucket (aws.s3.BucketV2).

Basic Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.mwaa.Environment;
import com.pulumi.aws.mwaa.EnvironmentArgs;
import com.pulumi.aws.mwaa.inputs.EnvironmentNetworkConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new Environment("example", EnvironmentArgs.builder()
            .dagS3Path("dags/")
            .executionRoleArn(aws_iam_role.example().arn())
            .networkConfiguration(EnvironmentNetworkConfigurationArgs.builder()
                .securityGroupIds(aws_security_group.example().id())
                .subnetIds(aws_subnet.private().stream().map(element -> element.id()).collect(toList()))
                .build())
            .sourceBucketArn(aws_s3_bucket.example().arn())
            .build());
    }
}
Content copied to clipboard

Example with Airflow configuration options

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.mwaa.Environment;
import com.pulumi.aws.mwaa.EnvironmentArgs;
import com.pulumi.aws.mwaa.inputs.EnvironmentNetworkConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new Environment("example", EnvironmentArgs.builder()
            .airflowConfigurationOptions(Map.ofEntries(
                Map.entry("core.default_task_retries", 16),
                Map.entry("core.parallelism", 1)
            ))
            .dagS3Path("dags/")
            .executionRoleArn(aws_iam_role.example().arn())
            .networkConfiguration(EnvironmentNetworkConfigurationArgs.builder()
                .securityGroupIds(aws_security_group.example().id())
                .subnetIds(aws_subnet.private().stream().map(element -> element.id()).collect(toList()))
                .build())
            .sourceBucketArn(aws_s3_bucket.example().arn())
            .build());
    }
}
Content copied to clipboard

Example with logging configurations

Note that Airflow task logs are enabled by default with the INFO log level.

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.mwaa.Environment;
import com.pulumi.aws.mwaa.EnvironmentArgs;
import com.pulumi.aws.mwaa.inputs.EnvironmentLoggingConfigurationArgs;
import com.pulumi.aws.mwaa.inputs.EnvironmentLoggingConfigurationDagProcessingLogsArgs;
import com.pulumi.aws.mwaa.inputs.EnvironmentLoggingConfigurationSchedulerLogsArgs;
import com.pulumi.aws.mwaa.inputs.EnvironmentLoggingConfigurationTaskLogsArgs;
import com.pulumi.aws.mwaa.inputs.EnvironmentLoggingConfigurationWebserverLogsArgs;
import com.pulumi.aws.mwaa.inputs.EnvironmentLoggingConfigurationWorkerLogsArgs;
import com.pulumi.aws.mwaa.inputs.EnvironmentNetworkConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new Environment("example", EnvironmentArgs.builder()
            .dagS3Path("dags/")
            .executionRoleArn(aws_iam_role.example().arn())
            .loggingConfiguration(EnvironmentLoggingConfigurationArgs.builder()
                .dagProcessingLogs(EnvironmentLoggingConfigurationDagProcessingLogsArgs.builder()
                    .enabled(true)
                    .logLevel("DEBUG")
                    .build())
                .schedulerLogs(EnvironmentLoggingConfigurationSchedulerLogsArgs.builder()
                    .enabled(true)
                    .logLevel("INFO")
                    .build())
                .taskLogs(EnvironmentLoggingConfigurationTaskLogsArgs.builder()
                    .enabled(true)
                    .logLevel("WARNING")
                    .build())
                .webserverLogs(EnvironmentLoggingConfigurationWebserverLogsArgs.builder()
                    .enabled(true)
                    .logLevel("ERROR")
                    .build())
                .workerLogs(EnvironmentLoggingConfigurationWorkerLogsArgs.builder()
                    .enabled(true)
                    .logLevel("CRITICAL")
                    .build())
                .build())
            .networkConfiguration(EnvironmentNetworkConfigurationArgs.builder()
                .securityGroupIds(aws_security_group.example().id())
                .subnetIds(aws_subnet.private().stream().map(element -> element.id()).collect(toList()))
                .build())
            .sourceBucketArn(aws_s3_bucket.example().arn())
            .build());
    }
}
Content copied to clipboard

Example with tags

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.mwaa.Environment;
import com.pulumi.aws.mwaa.EnvironmentArgs;
import com.pulumi.aws.mwaa.inputs.EnvironmentNetworkConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new Environment("example", EnvironmentArgs.builder()
            .dagS3Path("dags/")
            .executionRoleArn(aws_iam_role.example().arn())
            .networkConfiguration(EnvironmentNetworkConfigurationArgs.builder()
                .securityGroupIds(aws_security_group.example().id())
                .subnetIds(aws_subnet.private().stream().map(element -> element.id()).collect(toList()))
                .build())
            .sourceBucketArn(aws_s3_bucket.example().arn())
            .tags(Map.ofEntries(
                Map.entry("Name", "example"),
                Map.entry("Environment", "production")
            ))
            .build());
    }
}
Content copied to clipboard

Import

Using pulumi import, import MWAA Environment using Name. For example:

$ pulumi import aws:mwaa/environment:Environment example MyAirflowEnvironment
Content copied to clipboard

Constructors

Link copied to clipboard
fun EnvironmentArgs(airflowConfigurationOptions: Output<Map<String, String>>? = null, airflowVersion: Output<String>? = null, dagS3Path: Output<String>? = null, environmentClass: Output<String>? = null, executionRoleArn: Output<String>? = null, kmsKey: Output<String>? = null, loggingConfiguration: Output<EnvironmentLoggingConfigurationArgs>? = null, maxWorkers: Output<Int>? = null, minWorkers: Output<Int>? = null, name: Output<String>? = null, networkConfiguration: Output<EnvironmentNetworkConfigurationArgs>? = null, pluginsS3ObjectVersion: Output<String>? = null, pluginsS3Path: Output<String>? = null, requirementsS3ObjectVersion: Output<String>? = null, requirementsS3Path: Output<String>? = null, schedulers: Output<Int>? = null, sourceBucketArn: Output<String>? = null, startupScriptS3ObjectVersion: Output<String>? = null, startupScriptS3Path: Output<String>? = null, tags: Output<Map<String, String>>? = null, webserverAccessMode: Output<String>? = null, weeklyMaintenanceWindowStart: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): EnvironmentArgs

Properties

Link copied to clipboard
val airflowConfigurationOptions: Output<Map<String, String>>? = null

The airflow_configuration_options parameter specifies airflow override options. Check the Official documentation for all possible configuration options.

Link copied to clipboard
val airflowVersion: Output<String>? = null

Airflow version of your environment, will be set by default to the latest version that MWAA supports.

Link copied to clipboard
val dagS3Path: Output<String>? = null

The relative path to the DAG folder on your Amazon S3 storage bucket. For example, dags. For more information, see Importing DAGs on Amazon MWAA.

Link copied to clipboard
val environmentClass: Output<String>? = null

Environment class for the cluster. Possible options are mw1.small, mw1.medium, mw1.large. Will be set by default to mw1.small. Please check the AWS Pricing for more information about the environment classes.

Link copied to clipboard
val executionRoleArn: Output<String>? = null

The Amazon Resource Name (ARN) of the task execution role that the Amazon MWAA and its environment can assume. Check the official AWS documentation for the detailed role specification.

Link copied to clipboard
val kmsKey: Output<String>? = null

The Amazon Resource Name (ARN) of your KMS key that you want to use for encryption. Will be set to the ARN of the managed KMS key aws/airflow by default. Please check the Official Documentation for more information.

Link copied to clipboard
val loggingConfiguration: Output<EnvironmentLoggingConfigurationArgs>? = null

The Apache Airflow logs you want to send to Amazon CloudWatch Logs.

Link copied to clipboard
val maxWorkers: Output<Int>? = null

The maximum number of workers that can be automatically scaled up. Value need to be between 1 and 25. Will be 10 by default.

Link copied to clipboard
val minWorkers: Output<Int>? = null

The minimum number of workers that you want to run in your environment. Will be 1 by default.

Link copied to clipboard
val name: Output<String>? = null

The name of the Apache Airflow Environment

Link copied to clipboard
val networkConfiguration: Output<EnvironmentNetworkConfigurationArgs>? = null

Specifies the network configuration for your Apache Airflow Environment. This includes two private subnets as well as security groups for the Airflow environment. Each subnet requires internet connection, otherwise the deployment will fail. See Network configuration below for details.

Link copied to clipboard
val pluginsS3ObjectVersion: Output<String>? = null

The plugins.zip file version you want to use.

Link copied to clipboard
val pluginsS3Path: Output<String>? = null

The relative path to the plugins.zip file on your Amazon S3 storage bucket. For example, plugins.zip. If a relative path is provided in the request, then plugins_s3_object_version is required. For more information, see Importing DAGs on Amazon MWAA.

Link copied to clipboard
val requirementsS3ObjectVersion: Output<String>? = null

The requirements.txt file version you want to use.

Link copied to clipboard
val requirementsS3Path: Output<String>? = null

The relative path to the requirements.txt file on your Amazon S3 storage bucket. For example, requirements.txt. If a relative path is provided in the request, then requirements_s3_object_version is required. For more information, see Importing DAGs on Amazon MWAA.

Link copied to clipboard
val schedulers: Output<Int>? = null

The number of schedulers that you want to run in your environment. v2.0.2 and above accepts 2 - 5, default 2. v1.10.12 accepts 1.

Link copied to clipboard
val sourceBucketArn: Output<String>? = null

The Amazon Resource Name (ARN) of your Amazon S3 storage bucket. For example, arn:aws:s3:::airflow-mybucketname.

Link copied to clipboard
val startupScriptS3ObjectVersion: Output<String>? = null

The version of the startup shell script you want to use. You must specify the version ID that Amazon S3 assigns to the file every time you update the script.

Link copied to clipboard
val startupScriptS3Path: Output<String>? = null

The relative path to the script hosted in your bucket. The script runs as your environment starts before starting the Apache Airflow process. Use this script to install dependencies, modify configuration options, and set environment variables. See Using a startup script. Supported for environment versions 2.x and later.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

A map of resource tags to associate with the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val webserverAccessMode: Output<String>? = null

Specifies whether the webserver should be accessible over the internet or via your specified VPC. Possible options: PRIVATE_ONLY (default) and PUBLIC_ONLY.

Link copied to clipboard
val weeklyMaintenanceWindowStart: Output<String>? = null

Specifies the start date for the weekly maintenance window.