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) The Apache Airflow configuration setting you want to override in your environment.
CreateEnvironmentRequest.Builder	airflowVersion(String airflowVersion) The Apache Airflow version you want to use for your environment.
CreateEnvironmentRequest.Builder	dagS3Path(String dagS3Path) The relative path to the DAG folder on your Amazon S3 storage bucket.
CreateEnvironmentRequest.Builder	environmentClass(String environmentClass) The environment class you want to use for your environment.
CreateEnvironmentRequest.Builder	executionRoleArn(String executionRoleArn) The Amazon Resource Name (ARN) of the execution role for your environment.
CreateEnvironmentRequest.Builder	kmsKey(String kmsKey) The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
default CreateEnvironmentRequest.Builder	loggingConfiguration(Consumer<LoggingConfigurationInput.Builder> loggingConfiguration) The Apache Airflow logs you want to send to Amazon CloudWatch Logs.
CreateEnvironmentRequest.Builder	loggingConfiguration(LoggingConfigurationInput loggingConfiguration) The Apache Airflow logs you want to send to Amazon CloudWatch Logs.
CreateEnvironmentRequest.Builder	maxWorkers(Integer maxWorkers) The maximum number of workers that you want to run in your environment.
CreateEnvironmentRequest.Builder	name(String name) The name of your MWAA environment.
default CreateEnvironmentRequest.Builder	networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration) The VPC networking components you want to use for your environment.
CreateEnvironmentRequest.Builder	networkConfiguration(NetworkConfiguration networkConfiguration) The VPC networking components you want to use for your environment.
CreateEnvironmentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateEnvironmentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateEnvironmentRequest.Builder	pluginsS3ObjectVersion(String pluginsS3ObjectVersion) The plugins.zip file version you want to use.
CreateEnvironmentRequest.Builder	pluginsS3Path(String pluginsS3Path) The relative path to the plugins.zip file on your Amazon S3 storage bucket.
CreateEnvironmentRequest.Builder	requirementsS3ObjectVersion(String requirementsS3ObjectVersion) The requirements.txt file version you want to use.
CreateEnvironmentRequest.Builder	requirementsS3Path(String requirementsS3Path) The relative path to the requirements.txt file on your Amazon S3 storage bucket.
CreateEnvironmentRequest.Builder	sourceBucketArn(String sourceBucketArn) The Amazon Resource Name (ARN) of your Amazon S3 storage bucket.
CreateEnvironmentRequest.Builder	tags(Map<String,String> tags) The metadata tags you want to attach to your environment.
CreateEnvironmentRequest.Builder	webserverAccessMode(String webserverAccessMode) The networking access of your Apache Airflow web server.
CreateEnvironmentRequest.Builder	webserverAccessMode(WebserverAccessMode webserverAccessMode) The networking access of your Apache Airflow web server.
CreateEnvironmentRequest.Builder	weeklyMaintenanceWindowStart(String weeklyMaintenanceWindowStart) The day and time you want MWAA to start weekly maintenance updates on your environment.

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)

The Apache Airflow configuration setting you want to override in your environment. For more information, see Environment configuration.

Parameters:

airflowConfigurationOptions - The Apache Airflow configuration setting you want to override in your environment. For more information, see Environment configuration.

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 you want to use for your environment.

Parameters:

airflowVersion - The Apache Airflow version you want to use for your environment.

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 DAG folder on your Amazon S3 storage bucket. For example, dags. For more information, see Importing DAGs on Amazon MWAA.

Parameters:

dagS3Path - The relative path to the DAG folder on your Amazon S3 storage bucket. For example, dags. For more information, see Importing DAGs on Amazon MWAA.

Returns:

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

environmentClass

CreateEnvironmentRequest.Builder environmentClass(String environmentClass)

The environment class you want to use for your environment. The environment class determines the size of the containers and database used for your Apache Airflow services.

Parameters:

environmentClass - The environment class you want to use for your environment. The environment class determines the size of the containers and database used for your Apache Airflow services.

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 AWS Identity and Access Management (IAM) role that grants MWAA permission to access AWS services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. For more information, see Managing access to Amazon Managed Workflows for Apache Airflow.

Parameters:

executionRoleArn - The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an AWS Identity and Access Management (IAM) role that grants MWAA permission to access AWS services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. For more information, see Managing access to Amazon Managed Workflows for Apache Airflow.

Returns:

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

kmsKey

CreateEnvironmentRequest.Builder kmsKey(String 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 custom KMS key (advanced). For more information, see Customer master keys (CMKs) in the AWS KMS developer guide.

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 custom KMS key (advanced). For more information, see Customer master keys (CMKs) in the AWS KMS developer guide.

Returns:

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

loggingConfiguration

CreateEnvironmentRequest.Builder loggingConfiguration(LoggingConfigurationInput loggingConfiguration)

The Apache Airflow logs you want to send to Amazon CloudWatch Logs.

Parameters:

loggingConfiguration - The Apache Airflow logs you want to send to Amazon 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)

The Apache Airflow logs you want to send to Amazon CloudWatch Logs.

This is a convenience 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 and the Fargate containers that run your tasks up to the number you specify in this field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra containers leaving the one worker that is included with your environment.

Parameters:

maxWorkers - The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers and the Fargate containers that run your tasks up to the number you specify in this field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra containers leaving the one worker that is included with your environment.

Returns:

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

name

CreateEnvironmentRequest.Builder name(String name)

The name of your MWAA environment.

Parameters:

name - The name of your MWAA environment.

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 you want to use for your environment. At least two private subnet identifiers and one VPC security group identifier are required to create an environment. For more information, see Creating the VPC network for a MWAA environment.

Parameters:

networkConfiguration - The VPC networking components you want to use for your environment. At least two private subnet identifiers and one VPC security group identifier are required to create an environment. For more information, see Creating the VPC network for a MWAA environment.

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 you want to use for your environment. At least two private subnet identifiers and one VPC security group identifier are required to create an environment. For more information, see Creating the VPC network for a MWAA environment.

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

CreateEnvironmentRequest.Builder pluginsS3ObjectVersion(String pluginsS3ObjectVersion)

The plugins.zip file version you want to use.

Parameters:

pluginsS3ObjectVersion - The plugins.zip file version you want to use.

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 storage bucket. For example, plugins.zip. If a relative path is provided in the request, then PluginsS3ObjectVersion is required. For more information, see Importing DAGs on Amazon MWAA.

Parameters:

pluginsS3Path - The relative path to the plugins.zip file on your Amazon S3 storage bucket. For example, plugins.zip. If a relative path is provided in the request, then PluginsS3ObjectVersion is required. For more information, see Importing DAGs on Amazon MWAA.

Returns:

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

requirementsS3ObjectVersion

CreateEnvironmentRequest.Builder requirementsS3ObjectVersion(String requirementsS3ObjectVersion)

The requirements.txt file version you want to use.

Parameters:

requirementsS3ObjectVersion - The requirements.txt file version you want to use.

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 storage bucket. For example, requirements.txt. If a relative path is provided in the request, then RequirementsS3ObjectVersion is required. For more information, see Importing DAGs on Amazon MWAA.

Parameters:

requirementsS3Path - The relative path to the requirements.txt file on your Amazon S3 storage bucket. For example, requirements.txt. If a relative path is provided in the request, then RequirementsS3ObjectVersion is required. For more information, see Importing DAGs on Amazon MWAA.

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 your Amazon S3 storage bucket. For example, arn:aws:s3:::airflow-mybucketname.

Parameters:

sourceBucketArn - The Amazon Resource Name (ARN) of your Amazon S3 storage bucket. For example, arn:aws:s3:::airflow-mybucketname.

Returns:

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

tags

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

The metadata tags you want to attach to your environment. For more information, see Tagging AWS resources.

Parameters:

tags - The metadata tags you want to attach to your environment. For more information, see Tagging AWS resources.

Returns:

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

webserverAccessMode

CreateEnvironmentRequest.Builder webserverAccessMode(String webserverAccessMode)

The networking access of your Apache Airflow web server. A public network allows your Airflow UI to be accessed over the Internet by users granted access in your IAM policy. A private network limits access of your Airflow UI to users within your VPC. For more information, see Creating the VPC network for a MWAA environment.

Parameters:

webserverAccessMode - The networking access of your Apache Airflow web server. A public network allows your Airflow UI to be accessed over the Internet by users granted access in your IAM policy. A private network limits access of your Airflow UI to users within your VPC. For more information, see Creating the VPC network for a MWAA environment.

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 networking access of your Apache Airflow web server. A public network allows your Airflow UI to be accessed over the Internet by users granted access in your IAM policy. A private network limits access of your Airflow UI to users within your VPC. For more information, see Creating the VPC network for a MWAA environment.

Parameters:

webserverAccessMode - The networking access of your Apache Airflow web server. A public network allows your Airflow UI to be accessed over the Internet by users granted access in your IAM policy. A private network limits access of your Airflow UI to users within your VPC. For more information, see Creating the VPC network for a MWAA environment.

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 you want MWAA to start weekly maintenance updates on your environment.

Parameters:

weeklyMaintenanceWindowStart - The day and time you want MWAA to start weekly maintenance updates on your environment.

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