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 Details

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

    • 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. For more information, 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. For more information, see Amazon MWAA Execution role.
      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. For more information, 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. For more information, see Create an Amazon S3 bucket for Amazon 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. For more information, see Adding or updating DAGs.

      Parameters:
      dagS3Path - The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. For more information, see Adding or updating DAGs.
      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. For more information, 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. For more information, 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. For more information, 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:

    • 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. For more information, 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. For more information, see Installing custom plugins.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pluginsS3ObjectVersion

      CreateEnvironmentRequest.Builder pluginsS3ObjectVersion(String pluginsS3ObjectVersion)

      The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a plugins.zip file is updated. For more information, see How S3 Versioning works.

      Parameters:
      pluginsS3ObjectVersion - The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a plugins.zip file is updated. For more information, 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 version is required. For more information, 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 version is required. For more information, see Installing Python dependencies.
      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. You must specify a version each time a requirements.txt file is updated. For more information, see How S3 Versioning works.

      Parameters:
      requirementsS3ObjectVersion - The version of the requirements.txt file on your Amazon S3 bucket. You must specify a version each time a requirements.txt file is updated. For more information, see How S3 Versioning works.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startupScriptS3Path

      CreateEnvironmentRequest.Builder startupScriptS3Path(String 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.

      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:
      Returns a reference to this object so that method calls can be chained together.

    • startupScriptS3ObjectVersion

      CreateEnvironmentRequest.Builder startupScriptS3ObjectVersion(String 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.

      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:
      Returns a reference to this object so that method calls can be chained together.

    • 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. For more information, 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. For more information, see Apache Airflow configuration options.
      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, mw1.xlarge, and mw1.2xlarge. For more information, see Amazon MWAA environment class.

      Parameters:
      environmentClass - The environment class type. Valid values: mw1.small, mw1.medium, mw1.large, mw1.xlarge, and mw1.2xlarge. For more information, see Amazon MWAA environment class.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

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

    • 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). For more information, 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). For more information, see Create an Amazon MWAA environment.
      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. For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).

      Valid values: 1.10.12, 2.0.2, 2.2.2, 2.4.3, 2.5.1, 2.6.3, 2.7.2 2.8.1

      Parameters:
      airflowVersion - The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).

      Valid values: 1.10.12, 2.0.2, 2.2.2, 2.4.3, 2.5.1, 2.6.3, 2.7.2 2.8.1

      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:

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

    • tags

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

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

      Parameters:
      tags - The key-value tag pairs you want to associate to your environment. For example, "Environment": "Staging". For more information, 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)

      Defines the access mode for the Apache Airflow web server. For more information, see Apache Airflow access modes.

      Parameters:
      webserverAccessMode - Defines the access mode for the Apache Airflow web server. For more information, see Apache Airflow access modes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • webserverAccessMode

      CreateEnvironmentRequest.Builder webserverAccessMode(WebserverAccessMode webserverAccessMode)

      Defines the access mode for the Apache Airflow web server. For more information, see Apache Airflow access modes.

      Parameters:
      webserverAccessMode - Defines the access mode for the Apache Airflow web server. For more information, see Apache Airflow access modes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

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

    • endpointManagement

      CreateEnvironmentRequest.Builder endpointManagement(String 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 for your VPC. If you choose to create an environment in a shared VPC, you must set this value to CUSTOMER. In a shared VPC deployment, the environment will remain in PENDING status until you create the VPC endpoints. If you do not take action to create the endpoints within 72 hours, the status will change to CREATE_FAILED. You can delete the failed environment and create a new one.

      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 for your VPC. If you choose to create an environment in a shared VPC, you must set this value to CUSTOMER. In a shared VPC deployment, the environment will remain in PENDING status until you create the VPC endpoints. If you do not take action to create the endpoints within 72 hours, the status will change to CREATE_FAILED. You can delete the failed environment and create a new one.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • endpointManagement

      CreateEnvironmentRequest.Builder endpointManagement(EndpointManagement 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 for your VPC. If you choose to create an environment in a shared VPC, you must set this value to CUSTOMER. In a shared VPC deployment, the environment will remain in PENDING status until you create the VPC endpoints. If you do not take action to create the endpoints within 72 hours, the status will change to CREATE_FAILED. You can delete the failed environment and create a new one.

      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 for your VPC. If you choose to create an environment in a shared VPC, you must set this value to CUSTOMER. In a shared VPC deployment, the environment will remain in PENDING status until you create the VPC endpoints. If you do not take action to create the endpoints within 72 hours, the status will change to CREATE_FAILED. You can delete the failed environment and create a new one.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • minWebservers

      CreateEnvironmentRequest.Builder minWebservers(Integer 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: Accepts between 2 and 5. Defaults to 2.

      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: Accepts between 2 and 5. Defaults to 2.

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

    • maxWebservers

      CreateEnvironmentRequest.Builder maxWebservers(Integer 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: Accepts between 2 and 5. Defaults to 2.

      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: Accepts between 2 and 5. Defaults to 2.

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

    • overrideConfiguration

      CreateEnvironmentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateEnvironmentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.