Package software.amazon.awscdk.cfnpropertymixins.services.mwaa

Class CfnEnvironmentMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.mwaa.CfnEnvironmentMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEnvironmentMixinProps>

Enclosing interface:

CfnEnvironmentMixinProps

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

A builder for CfnEnvironmentMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnEnvironmentMixinProps.Builder	airflowConfigurationOptions(Object airflowConfigurationOptions)	Sets the value of CfnEnvironmentMixinProps.getAirflowConfigurationOptions()
CfnEnvironmentMixinProps.Builder	airflowVersion(String airflowVersion)	Sets the value of CfnEnvironmentMixinProps.getAirflowVersion()
CfnEnvironmentMixinProps	build()	Builds the configured instance.
CfnEnvironmentMixinProps.Builder	dagS3Path(String dagS3Path)	Sets the value of CfnEnvironmentMixinProps.getDagS3Path()
CfnEnvironmentMixinProps.Builder	endpointManagement(String endpointManagement)	Sets the value of CfnEnvironmentMixinProps.getEndpointManagement()
CfnEnvironmentMixinProps.Builder	environmentClass(String environmentClass)	Sets the value of CfnEnvironmentMixinProps.getEnvironmentClass()
CfnEnvironmentMixinProps.Builder	executionRoleArn(String executionRoleArn)	Sets the value of CfnEnvironmentMixinProps.getExecutionRoleArn()
CfnEnvironmentMixinProps.Builder	executionRoleArn(IRoleRef executionRoleArn)	Sets the value of CfnEnvironmentMixinProps.getExecutionRoleArn()
CfnEnvironmentMixinProps.Builder	kmsKey(String kmsKey)	Sets the value of CfnEnvironmentMixinProps.getKmsKey()
CfnEnvironmentMixinProps.Builder	kmsKey(IKeyRef kmsKey)	Sets the value of CfnEnvironmentMixinProps.getKmsKey()
CfnEnvironmentMixinProps.Builder	loggingConfiguration(CfnEnvironmentPropsMixin.LoggingConfigurationProperty loggingConfiguration)	Sets the value of CfnEnvironmentMixinProps.getLoggingConfiguration()
CfnEnvironmentMixinProps.Builder	loggingConfiguration(IResolvable loggingConfiguration)	Sets the value of CfnEnvironmentMixinProps.getLoggingConfiguration()
CfnEnvironmentMixinProps.Builder	maxWebservers(Number maxWebservers)	Sets the value of CfnEnvironmentMixinProps.getMaxWebservers()
CfnEnvironmentMixinProps.Builder	maxWorkers(Number maxWorkers)	Sets the value of CfnEnvironmentMixinProps.getMaxWorkers()
CfnEnvironmentMixinProps.Builder	minWebservers(Number minWebservers)	Sets the value of CfnEnvironmentMixinProps.getMinWebservers()
CfnEnvironmentMixinProps.Builder	minWorkers(Number minWorkers)	Sets the value of CfnEnvironmentMixinProps.getMinWorkers()
CfnEnvironmentMixinProps.Builder	name(String name)	Sets the value of CfnEnvironmentMixinProps.getName()
CfnEnvironmentMixinProps.Builder	networkConfiguration(CfnEnvironmentPropsMixin.NetworkConfigurationProperty networkConfiguration)	Sets the value of CfnEnvironmentMixinProps.getNetworkConfiguration()
CfnEnvironmentMixinProps.Builder	networkConfiguration(IResolvable networkConfiguration)	Sets the value of CfnEnvironmentMixinProps.getNetworkConfiguration()
CfnEnvironmentMixinProps.Builder	pluginsS3ObjectVersion(String pluginsS3ObjectVersion)	Sets the value of CfnEnvironmentMixinProps.getPluginsS3ObjectVersion()
CfnEnvironmentMixinProps.Builder	pluginsS3Path(String pluginsS3Path)	Sets the value of CfnEnvironmentMixinProps.getPluginsS3Path()
CfnEnvironmentMixinProps.Builder	requirementsS3ObjectVersion(String requirementsS3ObjectVersion)	Sets the value of CfnEnvironmentMixinProps.getRequirementsS3ObjectVersion()
CfnEnvironmentMixinProps.Builder	requirementsS3Path(String requirementsS3Path)	Sets the value of CfnEnvironmentMixinProps.getRequirementsS3Path()
CfnEnvironmentMixinProps.Builder	schedulers(Number schedulers)	Sets the value of CfnEnvironmentMixinProps.getSchedulers()
CfnEnvironmentMixinProps.Builder	sourceBucketArn(String sourceBucketArn)	Sets the value of CfnEnvironmentMixinProps.getSourceBucketArn()
CfnEnvironmentMixinProps.Builder	sourceBucketArn(IBucketRef sourceBucketArn)	Sets the value of CfnEnvironmentMixinProps.getSourceBucketArn()
CfnEnvironmentMixinProps.Builder	startupScriptS3ObjectVersion(String startupScriptS3ObjectVersion)	Sets the value of CfnEnvironmentMixinProps.getStartupScriptS3ObjectVersion()
CfnEnvironmentMixinProps.Builder	startupScriptS3Path(String startupScriptS3Path)	Sets the value of CfnEnvironmentMixinProps.getStartupScriptS3Path()
CfnEnvironmentMixinProps.Builder	tags(Object tags)	Sets the value of CfnEnvironmentMixinProps.getTags()
CfnEnvironmentMixinProps.Builder	webserverAccessMode(String webserverAccessMode)	Sets the value of CfnEnvironmentMixinProps.getWebserverAccessMode()
CfnEnvironmentMixinProps.Builder	weeklyMaintenanceWindowStart(String weeklyMaintenanceWindowStart)	Sets the value of CfnEnvironmentMixinProps.getWeeklyMaintenanceWindowStart()
CfnEnvironmentMixinProps.Builder	workerReplacementStrategy(String workerReplacementStrategy)	Sets the value of CfnEnvironmentMixinProps.getWorkerReplacementStrategy()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

airflowConfigurationOptions

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder airflowConfigurationOptions(Object airflowConfigurationOptions)

Sets the value of CfnEnvironmentMixinProps.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(Stable)
public CfnEnvironmentMixinProps.Builder airflowVersion(String airflowVersion)

Sets the value of CfnEnvironmentMixinProps.getAirflowVersion()

Parameters:

airflowVersion - The version of Apache Airflow to use for the environment. If no value is specified, defaults to the latest version.

If you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect.

Allowed Values : 2.7.2 | 2.8.1 | 2.9.2 | 2.10.1 | 2.10.3 | 3.0.6 (latest)

Returns:

this

dagS3Path

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder dagS3Path(String dagS3Path)

Sets the value of CfnEnvironmentMixinProps.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

endpointManagement

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder endpointManagement(String endpointManagement)

Sets the value of CfnEnvironmentMixinProps.getEndpointManagement()

Parameters:

endpointManagement - Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to SERVICE , Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to CUSTOMER , you must create, and manage, the VPC endpoints in your VPC.

Returns:

this

environmentClass

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder environmentClass(String environmentClass)

Sets the value of CfnEnvironmentMixinProps.getEnvironmentClass()

Parameters:

environmentClass - The environment class type. Valid values: mw1.micro , mw1.small , mw1.medium , mw1.large , mw1.1large , and mw1.2large . To learn more, see Amazon MWAA environment class .

Returns:

this

executionRoleArn

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder executionRoleArn(String executionRoleArn)

Sets the value of CfnEnvironmentMixinProps.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

executionRoleArn

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder executionRoleArn(IRoleRef executionRoleArn)

Sets the value of CfnEnvironmentMixinProps.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(Stable)
public CfnEnvironmentMixinProps.Builder kmsKey(String kmsKey)

Sets the value of CfnEnvironmentMixinProps.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

kmsKey

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder kmsKey(IKeyRef kmsKey)

Sets the value of CfnEnvironmentMixinProps.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(Stable)
public CfnEnvironmentMixinProps.Builder loggingConfiguration(IResolvable loggingConfiguration)

Sets the value of CfnEnvironmentMixinProps.getLoggingConfiguration()

Parameters:

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

Returns:

this

loggingConfiguration

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder loggingConfiguration(CfnEnvironmentPropsMixin.LoggingConfigurationProperty loggingConfiguration)

Sets the value of CfnEnvironmentMixinProps.getLoggingConfiguration()

Parameters:

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

Returns:

this

maxWebservers

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder maxWebservers(Number maxWebservers)

Sets the value of CfnEnvironmentMixinProps.getMaxWebservers()

Parameters:

maxWebservers - The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set in MaxWebserers . As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers .

Valid values: For environments larger than mw1.micro, accepts values from 2 to 5 . Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1 .

Returns:

this

maxWorkers

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder maxWorkers(Number maxWorkers)

Sets the value of CfnEnvironmentMixinProps.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

minWebservers

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder minWebservers(Number minWebservers)

Sets the value of CfnEnvironmentMixinProps.getMinWebservers()

Parameters:

minWebservers - The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers .

Valid values: For environments larger than mw1.micro, accepts values from 2 to 5 . Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1 .

Returns:

this

minWorkers

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder minWorkers(Number minWorkers)

Sets the value of CfnEnvironmentMixinProps.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

name

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder name(String name)

Sets the value of CfnEnvironmentMixinProps.getName()

Parameters:

name - The name of your Amazon MWAA environment.

Returns:

this

networkConfiguration

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder networkConfiguration(IResolvable networkConfiguration)

Sets the value of CfnEnvironmentMixinProps.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(Stable)
public CfnEnvironmentMixinProps.Builder networkConfiguration(CfnEnvironmentPropsMixin.NetworkConfigurationProperty networkConfiguration)

Sets the value of CfnEnvironmentMixinProps.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(Stable)
public CfnEnvironmentMixinProps.Builder pluginsS3ObjectVersion(String pluginsS3ObjectVersion)

Sets the value of CfnEnvironmentMixinProps.getPluginsS3ObjectVersion()

Parameters:

pluginsS3ObjectVersion - The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins .

Returns:

this

pluginsS3Path

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder pluginsS3Path(String pluginsS3Path)

Sets the value of CfnEnvironmentMixinProps.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 .

Returns:

this

requirementsS3ObjectVersion

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder requirementsS3ObjectVersion(String requirementsS3ObjectVersion)

Sets the value of CfnEnvironmentMixinProps.getRequirementsS3ObjectVersion()

Parameters:

requirementsS3ObjectVersion - The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies .

Returns:

this

requirementsS3Path

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder requirementsS3Path(String requirementsS3Path)

Sets the value of CfnEnvironmentMixinProps.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 .

Returns:

this

schedulers

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder schedulers(Number schedulers)

Sets the value of CfnEnvironmentMixinProps.getSchedulers()

Parameters:

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

• v2 - For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
• v1 - Accepts 1.

Returns:

this

sourceBucketArn

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder sourceBucketArn(String sourceBucketArn)

Sets the value of CfnEnvironmentMixinProps.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

sourceBucketArn

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder sourceBucketArn(IBucketRef sourceBucketArn)

Sets the value of CfnEnvironmentMixinProps.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

startupScriptS3ObjectVersion

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder startupScriptS3ObjectVersion(String startupScriptS3ObjectVersion)

Sets the value of CfnEnvironmentMixinProps.getStartupScriptS3ObjectVersion()

Parameters:

startupScriptS3ObjectVersion - The version of the startup shell script in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file every time you update the script.

Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:

3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo

For more information, see Using a startup script .

Returns:

this

startupScriptS3Path

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder startupScriptS3Path(String startupScriptS3Path)

Sets the value of CfnEnvironmentMixinProps.getStartupScriptS3Path()

Parameters:

startupScriptS3Path - The relative path to the startup shell script in your Amazon S3 bucket. For example, s3://mwaa-environment/startup.sh . Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see Using a startup script .

Returns:

this

tags

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder tags(Object tags)

Sets the value of CfnEnvironmentMixinProps.getTags()

Parameters:

tags - The key-value tag pairs associated to your environment. For example, "Environment": "Staging" . To learn more, see Tagging . If you specify new tags for an existing environment, the update requires service interruption before taking effect.

Returns:

this

webserverAccessMode

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder webserverAccessMode(String webserverAccessMode)

Sets the value of CfnEnvironmentMixinProps.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(Stable)
public CfnEnvironmentMixinProps.Builder weeklyMaintenanceWindowStart(String weeklyMaintenanceWindowStart)

Sets the value of CfnEnvironmentMixinProps.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

workerReplacementStrategy

@Stability(Stable)
public CfnEnvironmentMixinProps.Builder workerReplacementStrategy(String workerReplacementStrategy)

Sets the value of CfnEnvironmentMixinProps.getWorkerReplacementStrategy()

Parameters:

workerReplacementStrategy - The worker replacement strategy to use when updating the environment. Valid values: FORCED, GRACEFUL. FORCED means Apache Airflow workers will be stopped and replaced without waiting for tasks to complete before an update. GRACEFUL means Apache Airflow workers will be able to complete running tasks for up to 12 hours during an update before being stopped and replaced.

Returns:

this

build

@Stability(Stable)
public CfnEnvironmentMixinProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnEnvironmentMixinProps>

Returns:

a new instance of CfnEnvironmentMixinProps

Throws:

NullPointerException - if any required attribute was not provided