software.amazon.awssdk.services.mwaa.model

Interface CreateEnvironmentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>, MwaaRequest.Builder, SdkBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateEnvironmentRequest

public static interface CreateEnvironmentRequest.Builder
extends MwaaRequest.Builder, SdkPojo, CopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>

Method Summary

Modifier and Type	Method and Description
CreateEnvironmentRequest.Builder	airflowConfigurationOptions(Map<String,String> airflowConfigurationOptions) A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment.
CreateEnvironmentRequest.Builder	airflowVersion(String airflowVersion) The Apache Airflow version for your environment.
CreateEnvironmentRequest.Builder	dagS3Path(String dagS3Path) The relative path to the DAGs folder on your Amazon S3 bucket.
CreateEnvironmentRequest.Builder	environmentClass(String environmentClass) The environment class type.
CreateEnvironmentRequest.Builder	executionRoleArn(String executionRoleArn) The Amazon Resource Name (ARN) of the execution role for your environment.
CreateEnvironmentRequest.Builder	kmsKey(String kmsKey) The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment.
default CreateEnvironmentRequest.Builder	loggingConfiguration(Consumer<LoggingConfigurationInput.Builder> loggingConfiguration) Defines the Apache Airflow logs to send to CloudWatch Logs.
CreateEnvironmentRequest.Builder	loggingConfiguration(LoggingConfigurationInput loggingConfiguration) Defines the Apache Airflow logs to send to CloudWatch Logs.
CreateEnvironmentRequest.Builder	maxWorkers(Integer maxWorkers) The maximum number of workers that you want to run in your environment.
CreateEnvironmentRequest.Builder	minWorkers(Integer minWorkers) The minimum number of workers that you want to run in your environment.
CreateEnvironmentRequest.Builder	name(String name) The name of the Amazon MWAA environment.
default CreateEnvironmentRequest.Builder	networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration) The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment.
CreateEnvironmentRequest.Builder	networkConfiguration(NetworkConfiguration networkConfiguration) The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment.
CreateEnvironmentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateEnvironmentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateEnvironmentRequest.Builder	pluginsS3ObjectVersion(String pluginsS3ObjectVersion) The version of the plugins.zip file on your Amazon S3 bucket.
CreateEnvironmentRequest.Builder	pluginsS3Path(String pluginsS3Path) The relative path to the plugins.zip file on your Amazon S3 bucket.
CreateEnvironmentRequest.Builder	requirementsS3ObjectVersion(String requirementsS3ObjectVersion) The version of the requirements.txt file on your Amazon S3 bucket.
CreateEnvironmentRequest.Builder	requirementsS3Path(String requirementsS3Path) The relative path to the requirements.txt file on your Amazon S3 bucket.
CreateEnvironmentRequest.Builder	schedulers(Integer schedulers) The number of Apache Airflow schedulers to run in your environment.
CreateEnvironmentRequest.Builder	sourceBucketArn(String sourceBucketArn) The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
CreateEnvironmentRequest.Builder	tags(Map<String,String> tags) The key-value tag pairs you want to associate to your environment.
CreateEnvironmentRequest.Builder	webserverAccessMode(String webserverAccessMode) The Apache Airflow Web server access mode.
CreateEnvironmentRequest.Builder	webserverAccessMode(WebserverAccessMode webserverAccessMode) The Apache Airflow Web server access mode.
CreateEnvironmentRequest.Builder	weeklyMaintenanceWindowStart(String weeklyMaintenanceWindowStart) The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time to start weekly maintenance updates of your environment in the following format: DAY:HH:MM.

Methods inherited from interface software.amazon.awssdk.services.mwaa.model.MwaaRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

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

A list of key-value pairs containing the Apache Airflow configuration options you want to attach 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 you want to attach 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

CreateEnvironmentRequest.Builder airflowVersion(String airflowVersion)

The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. Valid values: 1.10.12, 2.0.2, and 2.2.2. To learn more, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).

Parameters:

airflowVersion - The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. Valid values: 1.10.12, 2.0.2, and 2.2.2. To learn more, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).

Returns:

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

dagS3Path

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

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

CreateEnvironmentRequest.Builder executionRoleArn(String executionRoleArn)

The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an Amazon Web Services Identity and Access Management (IAM) role that grants MWAA permission to access Amazon Web Services services and resources used by 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 for your environment. An execution role is an Amazon Web Services Identity and Access Management (IAM) role that grants MWAA permission to access Amazon Web Services services and resources used by 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

CreateEnvironmentRequest.Builder kmsKey(String kmsKey)

The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed CMK (advanced). To learn more, see Create an Amazon MWAA environment.

Parameters:

kmsKey - The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed CMK (advanced). To learn more, see Create an Amazon MWAA environment.

Returns:

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

loggingConfiguration

CreateEnvironmentRequest.Builder loggingConfiguration(LoggingConfigurationInput loggingConfiguration)

Defines the Apache Airflow logs to send to CloudWatch Logs.

Parameters:

loggingConfiguration - Defines the Apache Airflow logs to send to CloudWatch Logs.

Returns:

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

loggingConfiguration

default CreateEnvironmentRequest.Builder loggingConfiguration(Consumer<LoggingConfigurationInput.Builder> loggingConfiguration)

Defines the Apache Airflow logs to send to CloudWatch Logs.

This is a convenience method that creates an instance of the LoggingConfigurationInput.Builder avoiding the need to create one manually via LoggingConfigurationInput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loggingConfiguration(LoggingConfigurationInput).

Parameters:

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

Returns:

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

See Also:

loggingConfiguration(LoggingConfigurationInput)

maxWorkers

CreateEnvironmentRequest.Builder maxWorkers(Integer 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. 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:

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

minWorkers

CreateEnvironmentRequest.Builder minWorkers(Integer 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. 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:

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

name

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

CreateEnvironmentRequest.Builder networkConfiguration(NetworkConfiguration networkConfiguration)

The VPC networking components used to secure and enable network traffic between the Amazon Web Services 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 Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.

Returns:

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

networkConfiguration

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

The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.

This is a convenience method 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

CreateEnvironmentRequest.Builder pluginsS3ObjectVersion(String pluginsS3ObjectVersion)

The version of the plugins.zip file on your Amazon S3 bucket. A version must be specified each time a plugins.zip file is updated. To learn more, see How S3 Versioning works.

Parameters:

pluginsS3ObjectVersion - The version of the plugins.zip file on your Amazon S3 bucket. A version must be specified each time a plugins.zip file is updated. To learn more, see How S3 Versioning works.

Returns:

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

pluginsS3Path

CreateEnvironmentRequest.Builder pluginsS3Path(String pluginsS3Path)

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. If specified, then the plugins.zip version is required. 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. If specified, then the plugins.zip version is required. To learn more, see Installing custom plugins.

Returns:

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

requirementsS3ObjectVersion

CreateEnvironmentRequest.Builder requirementsS3ObjectVersion(String requirementsS3ObjectVersion)

The version of the requirements.txt file on your Amazon S3 bucket. A version must be specified each time a requirements.txt file is updated. To learn more, see How S3 Versioning works.

Parameters:

requirementsS3ObjectVersion - The version of the requirements.txt file on your Amazon S3 bucket. A version must be specified each time a requirements.txt file is updated. To learn more, see How S3 Versioning works.

Returns:

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

requirementsS3Path

CreateEnvironmentRequest.Builder requirementsS3Path(String requirementsS3Path)

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a file version is required. 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. If specified, then a file version is required. To learn more, see Installing Python dependencies.

Returns:

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

schedulers

CreateEnvironmentRequest.Builder schedulers(Integer schedulers)

The number of Apache Airflow schedulers to run in your environment. Valid values:

• v2 - Accepts between 2 to 5. Defaults to 2.

• v1 - Accepts 1.

Parameters:

schedulers - The number of Apache Airflow schedulers to run in your environment. Valid values:

• v2 - Accepts between 2 to 5. Defaults to 2.

• v1 - Accepts 1.

Returns:

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

sourceBucketArn

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

tags

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

The key-value tag pairs you want to associate to your environment. For example, "Environment": "Staging". To learn more, see Tagging Amazon Web Services resources.

Parameters:

tags - The key-value tag pairs you want to associate to your environment. For example, "Environment": "Staging". To learn more, see Tagging Amazon Web Services resources.

Returns:

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

webserverAccessMode

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

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

weeklyMaintenanceWindowStart

CreateEnvironmentRequest.Builder weeklyMaintenanceWindowStart(String weeklyMaintenanceWindowStart)

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time 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.

Parameters:

weeklyMaintenanceWindowStart - The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time 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.

Returns:

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

overrideConfiguration

CreateEnvironmentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateEnvironmentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder