software.amazon.awscdk.services.mwaa

Class CfnEnvironment.Builder

java.lang.Object

software.amazon.awscdk.services.mwaa.CfnEnvironment.Builder

Enclosing class:

CfnEnvironment

public static final class CfnEnvironment.Builder
extends java.lang.Object

A fluent builder for CfnEnvironment.

Method Summary

Modifier and Type	Method and Description
CfnEnvironment.Builder	airflowConfigurationOptions(java.lang.Object airflowConfigurationOptions) A list of key-value pairs containing the Airflow configuration options for your environment.
CfnEnvironment.Builder	airflowVersion(java.lang.String airflowVersion) The version of Apache Airflow to use for the environment.
CfnEnvironment	build()
static CfnEnvironment.Builder	create(Construct scope, java.lang.String id)
CfnEnvironment.Builder	dagS3Path(java.lang.String dagS3Path) The relative path to the DAGs folder on your Amazon S3 bucket.
CfnEnvironment.Builder	environmentClass(java.lang.String environmentClass) The environment class type.
CfnEnvironment.Builder	executionRoleArn(java.lang.String executionRoleArn) The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.
CfnEnvironment.Builder	kmsKey(java.lang.String kmsKey) The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
CfnEnvironment.Builder	loggingConfiguration(CfnEnvironment.LoggingConfigurationProperty loggingConfiguration) The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .
CfnEnvironment.Builder	loggingConfiguration(IResolvable loggingConfiguration) The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .
CfnEnvironment.Builder	maxWorkers(java.lang.Number maxWorkers) The maximum number of workers that you want to run in your environment.
CfnEnvironment.Builder	minWorkers(java.lang.Number minWorkers) The minimum number of workers that you want to run in your environment.
CfnEnvironment.Builder	name(java.lang.String name) The name of your Amazon MWAA environment.
CfnEnvironment.Builder	networkConfiguration(CfnEnvironment.NetworkConfigurationProperty networkConfiguration) The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
CfnEnvironment.Builder	networkConfiguration(IResolvable networkConfiguration) The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
CfnEnvironment.Builder	pluginsS3ObjectVersion(java.lang.String pluginsS3ObjectVersion) The version of the plugins.zip file on your Amazon S3 bucket.
CfnEnvironment.Builder	pluginsS3Path(java.lang.String pluginsS3Path) The relative path to the `plugins.zip` file on your Amazon S3 bucket.
CfnEnvironment.Builder	requirementsS3ObjectVersion(java.lang.String requirementsS3ObjectVersion) The version of the requirements.txt file on your Amazon S3 bucket.
CfnEnvironment.Builder	requirementsS3Path(java.lang.String requirementsS3Path) The relative path to the `requirements.txt` file on your Amazon S3 bucket.
CfnEnvironment.Builder	schedulers(java.lang.Number schedulers) The number of schedulers that you want to run in your environment.
CfnEnvironment.Builder	sourceBucketArn(java.lang.String sourceBucketArn) The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
CfnEnvironment.Builder	tags(java.lang.Object tags) The key-value tag pairs associated to your environment.
CfnEnvironment.Builder	webserverAccessMode(java.lang.String webserverAccessMode) The Apache Airflow *Web server* access mode.
CfnEnvironment.Builder	weeklyMaintenanceWindowStart(java.lang.String weeklyMaintenanceWindowStart) The day and time of the week to start weekly maintenance updates of your environment in the following format: `DAY:HH:MM` .

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CfnEnvironment.Builder create(Construct scope,
                                            java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnEnvironment.LoggingConfigurationProperty.Builder.

name

public CfnEnvironment.Builder name(java.lang.String name)

The name of your Amazon MWAA environment.

Parameters:

name - The name of your Amazon MWAA environment. This parameter is required.

Returns:

this

airflowConfigurationOptions

public CfnEnvironment.Builder airflowConfigurationOptions(java.lang.Object airflowConfigurationOptions)

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 .

Parameters:

airflowConfigurationOptions - A list of key-value pairs containing the Airflow configuration options for your environment. This parameter is required.

Returns:

this

airflowVersion

public CfnEnvironment.Builder airflowVersion(java.lang.String airflowVersion)

The version of Apache Airflow to use for the environment.

If no value is specified, defaults to the latest version. Valid values: 2.0.2 , 1.10.12 , 2.2.2 , and 2.4.3 .

Parameters:

airflowVersion - The version of Apache Airflow to use for the environment. This parameter is required.

Returns:

this

dagS3Path

public CfnEnvironment.Builder dagS3Path(java.lang.String dagS3Path)

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

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

Parameters:

dagS3Path - The relative path to the DAGs folder on your Amazon S3 bucket. This parameter is required.

Returns:

this

environmentClass

public CfnEnvironment.Builder environmentClass(java.lang.String environmentClass)

The environment class type.

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

Parameters:

environmentClass - The environment class type. This parameter is required.

Returns:

this

executionRoleArn

public CfnEnvironment.Builder executionRoleArn(java.lang.String executionRoleArn)

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 .

Parameters:

executionRoleArn - The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment. This parameter is required.

Returns:

this

kmsKey

public CfnEnvironment.Builder kmsKey(java.lang.String kmsKey)

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

Parameters:

kmsKey - The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. This parameter is required.

Returns:

this

loggingConfiguration

public CfnEnvironment.Builder loggingConfiguration(IResolvable loggingConfiguration)

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

Parameters:

loggingConfiguration - The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` . This parameter is required.

Returns:

this

loggingConfiguration

public CfnEnvironment.Builder loggingConfiguration(CfnEnvironment.LoggingConfigurationProperty loggingConfiguration)

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

Parameters:

loggingConfiguration - The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` . This parameter is required.

Returns:

this

maxWorkers

public CfnEnvironment.Builder maxWorkers(java.lang.Number maxWorkers)

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 .

Parameters:

maxWorkers - The maximum number of workers that you want to run in your environment. This parameter is required.

Returns:

this

minWorkers

public CfnEnvironment.Builder minWorkers(java.lang.Number minWorkers)

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 .

Parameters:

minWorkers - The minimum number of workers that you want to run in your environment. This parameter is required.

Returns:

this

networkConfiguration

public CfnEnvironment.Builder networkConfiguration(IResolvable networkConfiguration)

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 .

Parameters:

networkConfiguration - The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. This parameter is required.

Returns:

this

networkConfiguration

public CfnEnvironment.Builder networkConfiguration(CfnEnvironment.NetworkConfigurationProperty networkConfiguration)

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 .

Parameters:

networkConfiguration - The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. This parameter is required.

Returns:

this

pluginsS3ObjectVersion

public CfnEnvironment.Builder pluginsS3ObjectVersion(java.lang.String pluginsS3ObjectVersion)

The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .

Parameters:

pluginsS3ObjectVersion - The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) . This parameter is required.

Returns:

this

pluginsS3Path

public CfnEnvironment.Builder pluginsS3Path(java.lang.String pluginsS3Path)

The relative path to the `plugins.zip` file on your Amazon S3 bucket. For example, `plugins.zip` . To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .

Parameters:

pluginsS3Path - The relative path to the `plugins.zip` file on your Amazon S3 bucket. For example, `plugins.zip` . To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) . This parameter is required.

Returns:

this

requirementsS3ObjectVersion

public CfnEnvironment.Builder requirementsS3ObjectVersion(java.lang.String requirementsS3ObjectVersion)

The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .

Parameters:

requirementsS3ObjectVersion - The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) . This parameter is required.

Returns:

this

requirementsS3Path

public CfnEnvironment.Builder requirementsS3Path(java.lang.String requirementsS3Path)

The relative path to the `requirements.txt` file on your Amazon S3 bucket. For example, `requirements.txt` . To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .

Parameters:

requirementsS3Path - The relative path to the `requirements.txt` file on your Amazon S3 bucket. For example, `requirements.txt` . To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) . This parameter is required.

Returns:

this

schedulers

public CfnEnvironment.Builder schedulers(java.lang.Number schedulers)

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.

Parameters:

schedulers - The number of schedulers that you want to run in your environment. Valid values:. This parameter is required.

Returns:

this

sourceBucketArn

public CfnEnvironment.Builder sourceBucketArn(java.lang.String sourceBucketArn)

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 .

Parameters:

sourceBucketArn - The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. This parameter is required.

Returns:

this

tags

public CfnEnvironment.Builder tags(java.lang.Object tags)

The key-value tag pairs associated to your environment.

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

Parameters:

tags - The key-value tag pairs associated to your environment. This parameter is required.

Returns:

this

webserverAccessMode

public CfnEnvironment.Builder webserverAccessMode(java.lang.String webserverAccessMode)

The Apache Airflow *Web server* access mode.

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

Parameters:

webserverAccessMode - The Apache Airflow *Web server* access mode. This parameter is required.

Returns:

this

weeklyMaintenanceWindowStart

public CfnEnvironment.Builder weeklyMaintenanceWindowStart(java.lang.String weeklyMaintenanceWindowStart)

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)

Parameters:

weeklyMaintenanceWindowStart - The day and time of the week to start weekly maintenance updates of your environment in the following format: `DAY:HH:MM` . This parameter is required.

Returns:

this

build

public CfnEnvironment build()