1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateEnvironment`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl ::std::convert::Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_name): <p>The name of your Amazon MWAA environment. For example, <code>MyMWAAEnvironment</code>.</p>
    ///   - [`execution_role_arn(impl ::std::convert::Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::execution_role_arn) / [`set_execution_role_arn(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_execution_role_arn): <p>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, <code>arn:aws:iam::123456789:role/my-execution-role</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html">Amazon MWAA Execution role</a>.</p>
    ///   - [`airflow_version(impl ::std::convert::Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::airflow_version) / [`set_airflow_version(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_airflow_version): <p>The Apache Airflow version for your environment. To upgrade your environment, specify a newer version of Apache Airflow supported by Amazon MWAA.</p>  <p>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 <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/upgrading-environment.html">Upgrading an Amazon MWAA environment</a>.</p>  <p>Valid values: <code>1.10.12</code>, <code>2.0.2</code>, <code>2.2.2</code>, <code>2.4.3</code>, and <code>2.5.1</code>.</p>
    ///   - [`source_bucket_arn(impl ::std::convert::Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::source_bucket_arn) / [`set_source_bucket_arn(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_source_bucket_arn): <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, <code>arn:aws:s3:::my-airflow-bucket-unique-name</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html">Create an Amazon S3 bucket for Amazon MWAA</a>.</p>
    ///   - [`dag_s3_path(impl ::std::convert::Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::dag_s3_path) / [`set_dag_s3_path(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_dag_s3_path): <p>The relative path to the DAGs folder on your Amazon S3 bucket. For example, <code>dags</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html">Adding or updating DAGs</a>.</p>
    ///   - [`plugins_s3_path(impl ::std::convert::Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::plugins_s3_path) / [`set_plugins_s3_path(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_plugins_s3_path): <p>The relative path to the <code>plugins.zip</code> file on your Amazon S3 bucket. For example, <code>plugins.zip</code>. If specified, then the plugins.zip version is required. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html">Installing custom plugins</a>.</p>
    ///   - [`plugins_s3_object_version(impl ::std::convert::Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::plugins_s3_object_version) / [`set_plugins_s3_object_version(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_plugins_s3_object_version): <p>The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a <code>plugins.zip</code> file is updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</p>
    ///   - [`requirements_s3_path(impl ::std::convert::Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::requirements_s3_path) / [`set_requirements_s3_path(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_requirements_s3_path): <p>The relative path to the <code>requirements.txt</code> file on your Amazon S3 bucket. For example, <code>requirements.txt</code>. If specified, then a file version is required. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html">Installing Python dependencies</a>.</p>
    ///   - [`requirements_s3_object_version(impl ::std::convert::Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::requirements_s3_object_version) / [`set_requirements_s3_object_version(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_requirements_s3_object_version): <p>The version of the requirements.txt file on your Amazon S3 bucket. You must specify a version each time a <code>requirements.txt</code> file is updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</p>
    ///   - [`startup_script_s3_path(impl ::std::convert::Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::startup_script_s3_path) / [`set_startup_script_s3_path(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_startup_script_s3_path): <p>The relative path to the startup shell script in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/startup.sh</code>.</p>  <p> 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 <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>. </p>
    ///   - [`startup_script_s3_object_version(impl ::std::convert::Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::startup_script_s3_object_version) / [`set_startup_script_s3_object_version(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_startup_script_s3_object_version): <p> The version of the startup shell script in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file every time you update the script. </p>  <p> 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: </p>  <p> <code>3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo</code> </p>  <p> For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>. </p>
    ///   - [`airflow_configuration_options(HashMap<String, String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::airflow_configuration_options) / [`set_airflow_configuration_options(Option<HashMap<String, String>>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_airflow_configuration_options): <p>A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html">Apache Airflow configuration options</a>.</p>
    ///   - [`environment_class(impl ::std::convert::Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::environment_class) / [`set_environment_class(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_environment_class): <p>The environment class type. Valid values: <code>mw1.small</code>, <code>mw1.medium</code>, <code>mw1.large</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html">Amazon MWAA environment class</a>.</p>
    ///   - [`max_workers(i32)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::max_workers) / [`set_max_workers(Option<i32>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_max_workers): <p>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 <code>MaxWorkers</code> field. For example, <code>20</code>. 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 <code>MinWorkers</code>.</p>
    ///   - [`network_configuration(UpdateNetworkConfigurationInput)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::network_configuration) / [`set_network_configuration(Option<UpdateNetworkConfigurationInput>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_network_configuration): <p>The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html">About networking on Amazon MWAA</a>.</p>
    ///   - [`logging_configuration(LoggingConfigurationInput)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::logging_configuration) / [`set_logging_configuration(Option<LoggingConfigurationInput>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_logging_configuration): <p>The Apache Airflow log types to send to CloudWatch Logs.</p>
    ///   - [`weekly_maintenance_window_start(impl ::std::convert::Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::weekly_maintenance_window_start) / [`set_weekly_maintenance_window_start(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_weekly_maintenance_window_start): <p>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: <code>DAY:HH:MM</code>. For example: <code>TUE:03:30</code>. You can specify a start time in 30 minute increments only.</p>
    ///   - [`webserver_access_mode(WebserverAccessMode)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::webserver_access_mode) / [`set_webserver_access_mode(Option<WebserverAccessMode>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_webserver_access_mode): <p>The Apache Airflow <i>Web server</i> access mode. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html">Apache Airflow access modes</a>.</p>
    ///   - [`min_workers(i32)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::min_workers) / [`set_min_workers(Option<i32>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_min_workers): <p>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 <code>MaxWorkers</code> 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 <code>MinWorkers</code> field. For example, <code>2</code>.</p>
    ///   - [`schedulers(i32)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::schedulers) / [`set_schedulers(Option<i32>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_schedulers): <p>The number of Apache Airflow schedulers to run in your Amazon MWAA environment.</p>
    /// - On success, responds with [`UpdateEnvironmentOutput`](crate::operation::update_environment::UpdateEnvironmentOutput) with field(s):
    ///   - [`arn(Option<String>)`](crate::operation::update_environment::UpdateEnvironmentOutput::arn): <p>The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, <code>arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment</code>.</p>
    /// - On failure, responds with [`SdkError<UpdateEnvironmentError>`](crate::operation::update_environment::UpdateEnvironmentError)
    pub fn update_environment(&self) -> crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder {
        crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::new(self.handle.clone())
    }
}