CfnEnvironmentProps.Builder (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.awscdk.services.mwaa.CfnEnvironmentProps.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<CfnEnvironmentProps>

Enclosing interface:: CfnEnvironmentProps

@Stability(value=Stable)
public static final class CfnEnvironmentProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEnvironmentProps>

A builder for CfnEnvironmentProps

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CfnEnvironmentProps.Builder`	`airflowConfigurationOptions(Object airflowConfigurationOptions)` Sets the value of `CfnEnvironmentProps.getAirflowConfigurationOptions()`
`CfnEnvironmentProps.Builder`	`airflowVersion(String airflowVersion)` Sets the value of `CfnEnvironmentProps.getAirflowVersion()`
`CfnEnvironmentProps`	`build()` Builds the configured instance.
`CfnEnvironmentProps.Builder`	`dagS3Path(String dagS3Path)` Sets the value of `CfnEnvironmentProps.getDagS3Path()`
`CfnEnvironmentProps.Builder`	`environmentClass(String environmentClass)` Sets the value of `CfnEnvironmentProps.getEnvironmentClass()`
`CfnEnvironmentProps.Builder`	`executionRoleArn(String executionRoleArn)` Sets the value of `CfnEnvironmentProps.getExecutionRoleArn()`
`CfnEnvironmentProps.Builder`	`kmsKey(String kmsKey)` Sets the value of `CfnEnvironmentProps.getKmsKey()`
`CfnEnvironmentProps.Builder`	`loggingConfiguration(CfnEnvironment.LoggingConfigurationProperty loggingConfiguration)` Sets the value of `CfnEnvironmentProps.getLoggingConfiguration()`
`CfnEnvironmentProps.Builder`	`loggingConfiguration(IResolvable loggingConfiguration)` Sets the value of `CfnEnvironmentProps.getLoggingConfiguration()`
`CfnEnvironmentProps.Builder`	`maxWorkers(Number maxWorkers)` Sets the value of `CfnEnvironmentProps.getMaxWorkers()`
`CfnEnvironmentProps.Builder`	`minWorkers(Number minWorkers)` Sets the value of `CfnEnvironmentProps.getMinWorkers()`
`CfnEnvironmentProps.Builder`	`name(String name)` Sets the value of `CfnEnvironmentProps.getName()`
`CfnEnvironmentProps.Builder`	`networkConfiguration(CfnEnvironment.NetworkConfigurationProperty networkConfiguration)` Sets the value of `CfnEnvironmentProps.getNetworkConfiguration()`
`CfnEnvironmentProps.Builder`	`networkConfiguration(IResolvable networkConfiguration)` Sets the value of `CfnEnvironmentProps.getNetworkConfiguration()`
`CfnEnvironmentProps.Builder`	`pluginsS3ObjectVersion(String pluginsS3ObjectVersion)` Sets the value of `CfnEnvironmentProps.getPluginsS3ObjectVersion()`
`CfnEnvironmentProps.Builder`	`pluginsS3Path(String pluginsS3Path)` Sets the value of `CfnEnvironmentProps.getPluginsS3Path()`
`CfnEnvironmentProps.Builder`	`requirementsS3ObjectVersion(String requirementsS3ObjectVersion)` Sets the value of `CfnEnvironmentProps.getRequirementsS3ObjectVersion()`
`CfnEnvironmentProps.Builder`	`requirementsS3Path(String requirementsS3Path)` Sets the value of `CfnEnvironmentProps.getRequirementsS3Path()`
`CfnEnvironmentProps.Builder`	`schedulers(Number schedulers)` Sets the value of `CfnEnvironmentProps.getSchedulers()`
`CfnEnvironmentProps.Builder`	`sourceBucketArn(String sourceBucketArn)` Sets the value of `CfnEnvironmentProps.getSourceBucketArn()`
`CfnEnvironmentProps.Builder`	`tags(Object tags)` Sets the value of `CfnEnvironmentProps.getTags()`
`CfnEnvironmentProps.Builder`	`webserverAccessMode(String webserverAccessMode)` Sets the value of `CfnEnvironmentProps.getWebserverAccessMode()`
`CfnEnvironmentProps.Builder`	`weeklyMaintenanceWindowStart(String weeklyMaintenanceWindowStart)` Sets the value of `CfnEnvironmentProps.getWeeklyMaintenanceWindowStart()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - name
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder name(String name)
```
    Sets the value of CfnEnvironmentProps.getName()
    
    Parameters:
    
    name - The name of your Amazon MWAA environment. This parameter is required.
    
    Returns:
    
    this
  - airflowConfigurationOptions
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder airflowConfigurationOptions(Object airflowConfigurationOptions)
```
    Sets the value of CfnEnvironmentProps.getAirflowConfigurationOptions()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - airflowVersion
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder airflowVersion(String airflowVersion)
```
    Sets the value of CfnEnvironmentProps.getAirflowVersion()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - dagS3Path
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder dagS3Path(String dagS3Path)
```
    Sets the value of CfnEnvironmentProps.getDagS3Path()
    
    Parameters:
    
    dagS3Path - The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags . To learn more, see Adding or updating DAGs .
    
    Returns:
    
    this
  - environmentClass
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder environmentClass(String environmentClass)
```
    Sets the value of CfnEnvironmentProps.getEnvironmentClass()
    
    Parameters:
    
    environmentClass - The environment class type. Valid values: mw1.small , mw1.medium , mw1.large . To learn more, see Amazon MWAA environment class .
    
    Returns:
    
    this
  - executionRoleArn
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder executionRoleArn(String executionRoleArn)
```
    Sets the value of CfnEnvironmentProps.getExecutionRoleArn()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - kmsKey
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder kmsKey(String kmsKey)
```
    Sets the value of CfnEnvironmentProps.getKmsKey()
    
    Parameters:
    
    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).
    
    Returns:
    
    this
  - loggingConfiguration
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder loggingConfiguration(CfnEnvironment.LoggingConfigurationProperty loggingConfiguration)
```
    Sets the value of CfnEnvironmentProps.getLoggingConfiguration()
    
    Parameters:
    
    loggingConfiguration - The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .
    
    Returns:
    
    this
  - loggingConfiguration
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder loggingConfiguration(IResolvable loggingConfiguration)
```
    Sets the value of CfnEnvironmentProps.getLoggingConfiguration()
    
    Parameters:
    
    loggingConfiguration - The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .
    
    Returns:
    
    this
  - maxWorkers
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder maxWorkers(Number maxWorkers)
```
    Sets the value of CfnEnvironmentProps.getMaxWorkers()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - minWorkers
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder minWorkers(Number minWorkers)
```
    Sets the value of CfnEnvironmentProps.getMinWorkers()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - networkConfiguration
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder networkConfiguration(CfnEnvironment.NetworkConfigurationProperty networkConfiguration)
```
    Sets the value of CfnEnvironmentProps.getNetworkConfiguration()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - networkConfiguration
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder networkConfiguration(IResolvable networkConfiguration)
```
    Sets the value of CfnEnvironmentProps.getNetworkConfiguration()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - pluginsS3ObjectVersion
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder pluginsS3ObjectVersion(String pluginsS3ObjectVersion)
```
    Sets the value of CfnEnvironmentProps.getPluginsS3ObjectVersion()
    
    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) .
    
    Returns:
    
    this
  - pluginsS3Path
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder pluginsS3Path(String pluginsS3Path)
```
    Sets the value of CfnEnvironmentProps.getPluginsS3Path()
    
    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) .
    
    Returns:
    
    this
  - requirementsS3ObjectVersion
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder requirementsS3ObjectVersion(String requirementsS3ObjectVersion)
```
    Sets the value of CfnEnvironmentProps.getRequirementsS3ObjectVersion()
    
    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) .
    
    Returns:
    
    this
  - requirementsS3Path
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder requirementsS3Path(String requirementsS3Path)
```
    Sets the value of CfnEnvironmentProps.getRequirementsS3Path()
    
    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) .
    
    Returns:
    
    this
  - schedulers
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder schedulers(Number schedulers)
```
    Sets the value of CfnEnvironmentProps.getSchedulers()
    Parameters:
    schedulers - The number of schedulers that you want to run in your environment. Valid values:.
    
    v2.0.2 - Accepts between 2 to 5. Defaults to 2.
    
    v1.10.12 - Accepts 1.
    Returns:
    
    this
  - sourceBucketArn
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder sourceBucketArn(String sourceBucketArn)
```
    Sets the value of CfnEnvironmentProps.getSourceBucketArn()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - tags
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder tags(Object tags)
```
    Sets the value of CfnEnvironmentProps.getTags()
    
    Parameters:
    
    tags - The key-value tag pairs associated to your environment. For example, "Environment": "Staging" . To learn more, see Tagging .
    
    Returns:
    
    this
  - webserverAccessMode
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder webserverAccessMode(String webserverAccessMode)
```
    Sets the value of CfnEnvironmentProps.getWebserverAccessMode()
    
    Parameters:
    
    webserverAccessMode - The Apache Airflow *Web server* access mode. To learn more, see Apache Airflow access modes . Valid values: PRIVATE_ONLY or PUBLIC_ONLY .
    
    Returns:
    
    this
  - weeklyMaintenanceWindowStart
```
@Stability(value=Stable)
public CfnEnvironmentProps.Builder weeklyMaintenanceWindowStart(String weeklyMaintenanceWindowStart)
```
    Sets the value of CfnEnvironmentProps.getWeeklyMaintenanceWindowStart()
    Parameters:
    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)
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public CfnEnvironmentProps build()
```
    Builds the configured instance.
    
    Specified by:
    
    build in interface software.amazon.jsii.Builder<CfnEnvironmentProps>
    
    Returns:
    
    a new instance of CfnEnvironmentProps
    
    Throws:
    
    NullPointerException - if any required attribute was not provided

Class CfnEnvironmentProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

name

airflowConfigurationOptions

airflowVersion

dagS3Path

environmentClass

executionRoleArn

kmsKey

loggingConfiguration

loggingConfiguration

maxWorkers

minWorkers

networkConfiguration

networkConfiguration

pluginsS3ObjectVersion

pluginsS3Path

requirementsS3ObjectVersion

requirementsS3Path

schedulers

sourceBucketArn

tags

webserverAccessMode

weeklyMaintenanceWindowStart

build