Package software.amazon.awssdk.services.mwaa.model

Interface UpdateEnvironmentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>, MwaaRequest.Builder, SdkBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateEnvironmentRequest
public static interface UpdateEnvironmentRequest.Builder extends MwaaRequest.Builder, SdkPojo, CopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

  • Method Details

    • airflowConfigurationOptions

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

    • airflowVersion

      UpdateEnvironmentRequest.Builder airflowVersion(String airflowVersion)

      The Apache Airflow version for your environment. To upgrade your environment, specify a newer version of Apache Airflow supported by Amazon MWAA.

      Before you upgrade an environment, make sure your requirements, DAGs, plugins, and other resources used in your workflows are compatible with the new Apache Airflow version. For more information about updating your resources, see Upgrading an Amazon MWAA environment.

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

      Parameters:
      airflowVersion - The Apache Airflow version for your environment. To upgrade your environment, specify a newer version of Apache Airflow supported by Amazon MWAA.

      Before you upgrade an environment, make sure your requirements, DAGs, plugins, and other resources used in your workflows are compatible with the new Apache Airflow version. For more information about updating your resources, see Upgrading an Amazon MWAA environment.

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

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

    • dagS3Path

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

    • environmentClass

      UpdateEnvironmentRequest.Builder environmentClass(String environmentClass)

      The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. For more information, see Amazon MWAA environment class.

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

    • executionRoleArn

      UpdateEnvironmentRequest.Builder executionRoleArn(String executionRoleArn)

      The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in 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 in IAM that allows MWAA to access Amazon Web Services resources in 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.

    • loggingConfiguration

      UpdateEnvironmentRequest.Builder loggingConfiguration(LoggingConfigurationInput loggingConfiguration)

      The Apache Airflow log types to send to CloudWatch Logs.

      Parameters:
      loggingConfiguration - The Apache Airflow log types to send to CloudWatch Logs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loggingConfiguration

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

      The Apache Airflow log types 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:

    • maxWorkers

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

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

      UpdateEnvironmentRequest.Builder name(String name)

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

      Parameters:
      name - The name of your Amazon MWAA environment. For example, MyMWAAEnvironment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkConfiguration

      UpdateEnvironmentRequest.Builder networkConfiguration(UpdateNetworkConfigurationInput 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 UpdateEnvironmentRequest.Builder networkConfiguration(Consumer<UpdateNetworkConfigurationInput.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 UpdateNetworkConfigurationInput.Builder avoiding the need to create one manually via UpdateNetworkConfigurationInput.builder().

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

      Parameters:
      networkConfiguration - a consumer that will call methods on UpdateNetworkConfigurationInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pluginsS3ObjectVersion

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

    • pluginsS3Path

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

    • requirementsS3ObjectVersion

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

    • requirementsS3Path

      UpdateEnvironmentRequest.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. 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 file 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.

    • schedulers

      UpdateEnvironmentRequest.Builder schedulers(Integer schedulers)

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

      Parameters:
      schedulers - The number of Apache Airflow schedulers to run in your Amazon MWAA environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceBucketArn

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

    • startupScriptS3ObjectVersion

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

    • startupScriptS3Path

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

    • webserverAccessMode

      UpdateEnvironmentRequest.Builder webserverAccessMode(String webserverAccessMode)

      The Apache Airflow Web server access mode. For more information, see Apache Airflow access modes.

      Parameters:
      webserverAccessMode - The Apache Airflow Web server access mode. 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

      UpdateEnvironmentRequest.Builder webserverAccessMode(WebserverAccessMode webserverAccessMode)

      The Apache Airflow Web server access mode. For more information, see Apache Airflow access modes.

      Parameters:
      webserverAccessMode - The Apache Airflow Web server access mode. 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:

    • weeklyMaintenanceWindowStart

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

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

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