software.amazon.awssdk.services.mwaa.model

Interface Environment.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Environment.Builder,Environment>, SdkBuilder<Environment.Builder,Environment>, SdkPojo

Enclosing class:

Environment

public static interface Environment.Builder
extends SdkPojo, CopyableBuilder<Environment.Builder,Environment>

Method Summary

Modifier and Type	Method and Description
Environment.Builder	airflowConfigurationOptions(Map<String,String> airflowConfigurationOptions) A list of key-value pairs containing the Apache Airflow configuration options attached to your environment.
Environment.Builder	airflowVersion(String airflowVersion) The Apache Airflow version on your environment.
Environment.Builder	arn(String arn) The Amazon Resource Name (ARN) of the Amazon MWAA environment.
Environment.Builder	createdAt(Instant createdAt) The day and time the environment was created.
Environment.Builder	dagS3Path(String dagS3Path) The relative path to the DAGs folder on your Amazon S3 bucket.
Environment.Builder	environmentClass(String environmentClass) The environment class type.
Environment.Builder	executionRoleArn(String executionRoleArn) The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.
Environment.Builder	kmsKey(String kmsKey) The Key Management Service (KMS) encryption key used to encrypt the data in your environment.
default Environment.Builder	lastUpdate(Consumer<LastUpdate.Builder> lastUpdate) Sets the value of the LastUpdate property for this object.
Environment.Builder	lastUpdate(LastUpdate lastUpdate) Sets the value of the LastUpdate property for this object.
default Environment.Builder	loggingConfiguration(Consumer<LoggingConfiguration.Builder> loggingConfiguration) The Apache Airflow logs being sent to CloudWatch Logs: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, WorkerLogs.
Environment.Builder	loggingConfiguration(LoggingConfiguration loggingConfiguration) The Apache Airflow logs being sent to CloudWatch Logs: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, WorkerLogs.
Environment.Builder	maxWorkers(Integer maxWorkers) The maximum number of workers that run in your environment.
Environment.Builder	minWorkers(Integer minWorkers) The minimum number of workers that run in your environment.
Environment.Builder	name(String name) The name of the Amazon MWAA environment.
default Environment.Builder	networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration) Sets the value of the NetworkConfiguration property for this object.
Environment.Builder	networkConfiguration(NetworkConfiguration networkConfiguration) Sets the value of the NetworkConfiguration property for this object.
Environment.Builder	pluginsS3ObjectVersion(String pluginsS3ObjectVersion) The version of the plugins.zip file on your Amazon S3 bucket.
Environment.Builder	pluginsS3Path(String pluginsS3Path) The relative path to the plugins.zip file on your Amazon S3 bucket.
Environment.Builder	requirementsS3ObjectVersion(String requirementsS3ObjectVersion) The version of the requirements.txt file on your Amazon S3 bucket.
Environment.Builder	requirementsS3Path(String requirementsS3Path) The relative path to the requirements.txt file on your Amazon S3 bucket.
Environment.Builder	schedulers(Integer schedulers) The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
Environment.Builder	serviceRoleArn(String serviceRoleArn) The Amazon Resource Name (ARN) for the service-linked role of the environment.
Environment.Builder	sourceBucketArn(String sourceBucketArn) The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
Environment.Builder	status(EnvironmentStatus status) The status of the Amazon MWAA environment.
Environment.Builder	status(String status) The status of the Amazon MWAA environment.
Environment.Builder	tags(Map<String,String> tags) The key-value tag pairs associated to your environment.
Environment.Builder	webserverAccessMode(String webserverAccessMode) The Apache Airflow Web server access mode.
Environment.Builder	webserverAccessMode(WebserverAccessMode webserverAccessMode) The Apache Airflow Web server access mode.
Environment.Builder	webserverUrl(String webserverUrl) The Apache Airflow Web server host name for the Amazon MWAA environment.
Environment.Builder	weeklyMaintenanceWindowStart(String weeklyMaintenanceWindowStart) The day and time of the week that weekly maintenance updates are scheduled.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

airflowConfigurationOptions

Environment.Builder airflowConfigurationOptions(Map<String,String> airflowConfigurationOptions)

A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. To learn more, see Apache Airflow configuration options.

Parameters:

airflowConfigurationOptions - A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. To learn more, see Apache Airflow configuration options.

Returns:

Returns a reference to this object so that method calls can be chained together.

airflowVersion

Environment.Builder airflowVersion(String airflowVersion)

The Apache Airflow version on your environment. For example, v1.10.12.

Parameters:

airflowVersion - The Apache Airflow version on your environment. For example, v1.10.12.

Returns:

Returns a reference to this object so that method calls can be chained together.

arn

Environment.Builder arn(String arn)

The Amazon Resource Name (ARN) of the Amazon MWAA environment.

Parameters:

arn - The Amazon Resource Name (ARN) of the Amazon MWAA environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdAt

Environment.Builder createdAt(Instant createdAt)

The day and time the environment was created.

Parameters:

createdAt - The day and time the environment was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

dagS3Path

Environment.Builder dagS3Path(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. For example, dags. To learn more, see Adding or updating DAGs.

Returns:

Returns a reference to this object so that method calls can be chained together.

environmentClass

Environment.Builder environmentClass(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. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class.

Returns:

Returns a reference to this object so that method calls can be chained together.

executionRoleArn

Environment.Builder executionRoleArn(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. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKey

Environment.Builder kmsKey(String kmsKey)

The Key Management Service (KMS) encryption key used to encrypt the data in your environment.

Parameters:

kmsKey - The Key Management Service (KMS) encryption key used to encrypt the data in your environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastUpdate

Environment.Builder lastUpdate(LastUpdate lastUpdate)

Sets the value of the LastUpdate property for this object.

Parameters:

lastUpdate - The new value for the LastUpdate property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastUpdate

default Environment.Builder lastUpdate(Consumer<LastUpdate.Builder> lastUpdate)

Sets the value of the LastUpdate property for this object. This is a convenience that creates an instance of the LastUpdate.Builder avoiding the need to create one manually via LastUpdate.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lastUpdate(LastUpdate).

Parameters:

lastUpdate - a consumer that will call methods on LastUpdate.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

lastUpdate(LastUpdate)

loggingConfiguration

Environment.Builder loggingConfiguration(LoggingConfiguration 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 .

Returns:

Returns a reference to this object so that method calls can be chained together.

loggingConfiguration

default Environment.Builder loggingConfiguration(Consumer<LoggingConfiguration.Builder> loggingConfiguration)

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

This is a convenience that creates an instance of the LoggingConfiguration.Builder avoiding the need to create one manually via LoggingConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loggingConfiguration(LoggingConfiguration).

Parameters:

loggingConfiguration - a consumer that will call methods on LoggingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

loggingConfiguration(LoggingConfiguration)

maxWorkers

Environment.Builder maxWorkers(Integer maxWorkers)

The maximum number of workers that run in your environment. For example, 20.

Parameters:

maxWorkers - The maximum number of workers that run in your environment. For example, 20.

Returns:

Returns a reference to this object so that method calls can be chained together.

minWorkers

Environment.Builder minWorkers(Integer minWorkers)

The minimum number of workers that run in your environment. For example, 2.

Parameters:

minWorkers - The minimum number of workers that run in your environment. For example, 2.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

Environment.Builder name(String name)

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

Parameters:

name - The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

Returns:

Returns a reference to this object so that method calls can be chained together.

networkConfiguration

Environment.Builder networkConfiguration(NetworkConfiguration networkConfiguration)

Sets the value of the NetworkConfiguration property for this object.

Parameters:

networkConfiguration - The new value for the NetworkConfiguration property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

networkConfiguration

default Environment.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)

Sets the value of the NetworkConfiguration property for this object. This is a convenience that creates an instance of the NetworkConfiguration.Builder avoiding the need to create one manually via NetworkConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to networkConfiguration(NetworkConfiguration).

Parameters:

networkConfiguration - a consumer that will call methods on NetworkConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

networkConfiguration(NetworkConfiguration)

pluginsS3ObjectVersion

Environment.Builder pluginsS3ObjectVersion(String pluginsS3ObjectVersion)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

pluginsS3Path

Environment.Builder pluginsS3Path(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.

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:

Returns a reference to this object so that method calls can be chained together.

requirementsS3ObjectVersion

Environment.Builder requirementsS3ObjectVersion(String requirementsS3ObjectVersion)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

requirementsS3Path

Environment.Builder requirementsS3Path(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.

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:

Returns a reference to this object so that method calls can be chained together.

schedulers

Environment.Builder schedulers(Integer schedulers)

The number of Apache Airflow schedulers that run in your Amazon MWAA environment.

Parameters:

schedulers - The number of Apache Airflow schedulers that run in your Amazon MWAA environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

serviceRoleArn

Environment.Builder serviceRoleArn(String serviceRoleArn)

The Amazon Resource Name (ARN) for the service-linked role of the environment. To learn more, see Amazon MWAA Service-linked role.

Parameters:

serviceRoleArn - The Amazon Resource Name (ARN) for the service-linked role of the environment. To learn more, see Amazon MWAA Service-linked role.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceBucketArn

Environment.Builder sourceBucketArn(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. For example, arn:aws:s3:::my-airflow-bucket-unique-name. To learn more, see Create an Amazon S3 bucket for Amazon MWAA.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

Environment.Builder status(String status)

The status of the Amazon MWAA environment. Valid values:

• CREATING - Indicates the request to create the environment is in progress.

• CREATE_FAILED - Indicates the request to create the environment failed, and the environment could not be created.

• AVAILABLE - Indicates the request was successful and the environment is ready to use.

• UPDATING - Indicates the request to update the environment is in progress.

• DELETING - Indicates the request to delete the environment is in progress.

• DELETED - Indicates the request to delete the environment is complete, and the environment has been deleted.

• UNAVAILABLE - Indicates the request failed, but the environment was unable to rollback and is not in a stable state.

• UPDATE_FAILED - Indicates the request to update the environment failed, and the environment has rolled back successfully and is ready to use.

We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. To learn more, see Amazon MWAA troubleshooting.

Parameters:

status - The status of the Amazon MWAA environment. Valid values:

• CREATING - Indicates the request to create the environment is in progress.

• CREATE_FAILED - Indicates the request to create the environment failed, and the environment could not be created.

• AVAILABLE - Indicates the request was successful and the environment is ready to use.

• UPDATING - Indicates the request to update the environment is in progress.

• DELETING - Indicates the request to delete the environment is in progress.

• DELETED - Indicates the request to delete the environment is complete, and the environment has been deleted.

• UNAVAILABLE - Indicates the request failed, but the environment was unable to rollback and is not in a stable state.

• UPDATE_FAILED - Indicates the request to update the environment failed, and the environment has rolled back successfully and is ready to use.

We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. To learn more, see Amazon MWAA troubleshooting.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnvironmentStatus, EnvironmentStatus

status

Environment.Builder status(EnvironmentStatus status)

The status of the Amazon MWAA environment. Valid values:

• CREATING - Indicates the request to create the environment is in progress.

• CREATE_FAILED - Indicates the request to create the environment failed, and the environment could not be created.

• AVAILABLE - Indicates the request was successful and the environment is ready to use.

• UPDATING - Indicates the request to update the environment is in progress.

• DELETING - Indicates the request to delete the environment is in progress.

• DELETED - Indicates the request to delete the environment is complete, and the environment has been deleted.

• UNAVAILABLE - Indicates the request failed, but the environment was unable to rollback and is not in a stable state.

• UPDATE_FAILED - Indicates the request to update the environment failed, and the environment has rolled back successfully and is ready to use.

We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. To learn more, see Amazon MWAA troubleshooting.

Parameters:

status - The status of the Amazon MWAA environment. Valid values:

• CREATING - Indicates the request to create the environment is in progress.

• CREATE_FAILED - Indicates the request to create the environment failed, and the environment could not be created.

• AVAILABLE - Indicates the request was successful and the environment is ready to use.

• UPDATING - Indicates the request to update the environment is in progress.

• DELETING - Indicates the request to delete the environment is in progress.

• DELETED - Indicates the request to delete the environment is complete, and the environment has been deleted.

• UNAVAILABLE - Indicates the request failed, but the environment was unable to rollback and is not in a stable state.

• UPDATE_FAILED - Indicates the request to update the environment failed, and the environment has rolled back successfully and is ready to use.

We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. To learn more, see Amazon MWAA troubleshooting.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnvironmentStatus, EnvironmentStatus

tags

Environment.Builder tags(Map<String,String> tags)

The key-value tag pairs associated to your environment. For example, "Environment": "Staging". To learn more, see Tagging AWS resources.

Parameters:

tags - The key-value tag pairs associated to your environment. For example, "Environment": "Staging". To learn more, see Tagging AWS resources.

Returns:

Returns a reference to this object so that method calls can be chained together.

webserverAccessMode

Environment.Builder webserverAccessMode(String webserverAccessMode)

The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

Parameters:

webserverAccessMode - The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

WebserverAccessMode, WebserverAccessMode

webserverAccessMode

Environment.Builder webserverAccessMode(WebserverAccessMode webserverAccessMode)

The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

Parameters:

webserverAccessMode - The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

WebserverAccessMode, WebserverAccessMode

webserverUrl

Environment.Builder webserverUrl(String webserverUrl)

The Apache Airflow Web server host name for the Amazon MWAA environment. To learn more, see Accessing the Apache Airflow UI.

Parameters:

webserverUrl - The Apache Airflow Web server host name for the Amazon MWAA environment. To learn more, see Accessing the Apache Airflow UI.

Returns:

Returns a reference to this object so that method calls can be chained together.

weeklyMaintenanceWindowStart

Environment.Builder weeklyMaintenanceWindowStart(String weeklyMaintenanceWindowStart)

The day and time of the week that weekly maintenance updates are scheduled. For example: TUE:03:30.

Parameters:

weeklyMaintenanceWindowStart - The day and time of the week that weekly maintenance updates are scheduled. For example: TUE:03:30.

Returns:

Returns a reference to this object so that method calls can be chained together.