public static final class CfnEnvironment.Builder
extends java.lang.Object
CfnEnvironment
.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` .
|
public static CfnEnvironment.Builder create(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.CfnEnvironment.LoggingConfigurationProperty.Builder
.public CfnEnvironment.Builder name(java.lang.String name)
name
- The name of your Amazon MWAA environment. This parameter is required.this
public CfnEnvironment.Builder airflowConfigurationOptions(java.lang.Object airflowConfigurationOptions)
For example, core.default_timezone: utc
. To learn more, see Apache Airflow configuration options .
airflowConfigurationOptions
- A list of key-value pairs containing the Airflow configuration options for your environment. This parameter is required.this
public CfnEnvironment.Builder airflowVersion(java.lang.String airflowVersion)
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
.
airflowVersion
- The version of Apache Airflow to use for the environment. This parameter is required.this
public CfnEnvironment.Builder dagS3Path(java.lang.String dagS3Path)
For example, dags
. To learn more, see Adding or updating DAGs .
dagS3Path
- The relative path to the DAGs folder on your Amazon S3 bucket. This parameter is required.this
public CfnEnvironment.Builder environmentClass(java.lang.String environmentClass)
Valid values: mw1.small
, mw1.medium
, mw1.large
. To learn more, see Amazon MWAA environment class .
environmentClass
- The environment class type. This parameter is required.this
public CfnEnvironment.Builder executionRoleArn(java.lang.String executionRoleArn)
For example, arn:aws:iam::123456789:role/my-execution-role
. To learn more, see Amazon MWAA Execution role .
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.this
public CfnEnvironment.Builder kmsKey(java.lang.String kmsKey)
You can use an AWS KMS key managed by MWAA, or a customer-managed KMS key (advanced).
kmsKey
- The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. This parameter is required.this
public CfnEnvironment.Builder loggingConfiguration(IResolvable loggingConfiguration)
loggingConfiguration
- The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` . This parameter is required.this
public CfnEnvironment.Builder loggingConfiguration(CfnEnvironment.LoggingConfigurationProperty loggingConfiguration)
loggingConfiguration
- The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` . This parameter is required.this
public CfnEnvironment.Builder maxWorkers(java.lang.Number maxWorkers)
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
.
maxWorkers
- The maximum number of workers that you want to run in your environment. This parameter is required.this
public CfnEnvironment.Builder minWorkers(java.lang.Number minWorkers)
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
.
minWorkers
- The minimum number of workers that you want to run in your environment. This parameter is required.this
public CfnEnvironment.Builder networkConfiguration(IResolvable networkConfiguration)
To learn more, see About networking on Amazon MWAA .
networkConfiguration
- The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. This parameter is required.this
public CfnEnvironment.Builder networkConfiguration(CfnEnvironment.NetworkConfigurationProperty networkConfiguration)
To learn more, see About networking on Amazon MWAA .
networkConfiguration
- The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. This parameter is required.this
public CfnEnvironment.Builder pluginsS3ObjectVersion(java.lang.String pluginsS3ObjectVersion)
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.this
public CfnEnvironment.Builder pluginsS3Path(java.lang.String pluginsS3Path)
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.this
public CfnEnvironment.Builder requirementsS3ObjectVersion(java.lang.String requirementsS3ObjectVersion)
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.this
public CfnEnvironment.Builder requirementsS3Path(java.lang.String requirementsS3Path)
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.this
public CfnEnvironment.Builder schedulers(java.lang.Number schedulers)
schedulers
- The number of schedulers that you want to run in your environment. Valid values:. This parameter is required.this
public CfnEnvironment.Builder sourceBucketArn(java.lang.String sourceBucketArn)
For example, arn:aws:s3:::my-airflow-bucket-unique-name
. To learn more, see Create an Amazon S3 bucket for Amazon MWAA .
sourceBucketArn
- The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. This parameter is required.this
public CfnEnvironment.Builder tags(java.lang.Object tags)
For example, "Environment": "Staging"
. To learn more, see Tagging .
tags
- The key-value tag pairs associated to your environment. This parameter is required.this
public CfnEnvironment.Builder webserverAccessMode(java.lang.String webserverAccessMode)
To learn more, see Apache Airflow access modes . Valid values: PRIVATE_ONLY
or PUBLIC_ONLY
.
webserverAccessMode
- The Apache Airflow *Web server* access mode. This parameter is required.this
public CfnEnvironment.Builder weeklyMaintenanceWindowStart(java.lang.String weeklyMaintenanceWindowStart)
For example: TUE:03:30
. You can specify a start time in 30 minute increments only. Supported input includes the following:
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.this
public CfnEnvironment build()