Class: Aws::MWAA::Types::UpdateEnvironmentInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::MWAA::Types::UpdateEnvironmentInput
- Defined in:
- gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:airflow_configuration_options]
Instance Attribute Summary collapse
-
#airflow_configuration_options ⇒ Hash<String,String>
A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment.
-
#airflow_version ⇒ String
The Apache Airflow version for your environment.
-
#dag_s3_path ⇒ String
The relative path to the DAGs folder on your Amazon S3 bucket.
-
#environment_class ⇒ String
The environment class type.
-
#execution_role_arn ⇒ String
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment.
-
#logging_configuration ⇒ Types::LoggingConfigurationInput
The Apache Airflow log types to send to CloudWatch Logs.
-
#max_workers ⇒ Integer
The maximum number of workers that you want to run in your environment.
-
#min_workers ⇒ Integer
The minimum number of workers that you want to run in your environment.
-
#name ⇒ String
The name of your Amazon MWAA environment.
-
#network_configuration ⇒ Types::UpdateNetworkConfigurationInput
The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment.
-
#plugins_s3_object_version ⇒ String
The version of the plugins.zip file on your Amazon S3 bucket.
-
#plugins_s3_path ⇒ String
The relative path to the
plugins.zip
file on your Amazon S3 bucket. -
#requirements_s3_object_version ⇒ String
The version of the requirements.txt file on your Amazon S3 bucket.
-
#requirements_s3_path ⇒ String
The relative path to the
requirements.txt
file on your Amazon S3 bucket. -
#schedulers ⇒ Integer
The number of Apache Airflow schedulers to run in your Amazon MWAA environment.
-
#source_bucket_arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
-
#startup_script_s3_object_version ⇒ String
The version of the startup shell script in your Amazon S3 bucket.
-
#startup_script_s3_path ⇒ String
The relative path to the startup shell script in your Amazon S3 bucket.
-
#webserver_access_mode ⇒ String
The Apache Airflow Web server access mode.
-
#weekly_maintenance_window_start ⇒ String
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
.
Instance Attribute Details
#airflow_configuration_options ⇒ Hash<String,String>
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.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#airflow_version ⇒ String
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
.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#dag_s3_path ⇒ String
The relative path to the DAGs folder on your Amazon S3 bucket. For
example, dags
. For more information, see Adding or updating
DAGs.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#environment_class ⇒ String
The environment class type. Valid values: mw1.small
, mw1.medium
,
mw1.large
. For more information, see Amazon MWAA environment
class.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#execution_role_arn ⇒ String
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.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#logging_configuration ⇒ Types::LoggingConfigurationInput
The Apache Airflow log types to send to CloudWatch Logs.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#max_workers ⇒ Integer
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
.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#min_workers ⇒ Integer
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
.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#name ⇒ String
The name of your Amazon MWAA environment. For example,
MyMWAAEnvironment
.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#network_configuration ⇒ Types::UpdateNetworkConfigurationInput
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.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#plugins_s3_object_version ⇒ String
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.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#plugins_s3_path ⇒ String
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.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#requirements_s3_object_version ⇒ String
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.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#requirements_s3_path ⇒ String
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.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#schedulers ⇒ Integer
The number of Apache Airflow schedulers to run in your Amazon MWAA environment.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#source_bucket_arn ⇒ String
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.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#startup_script_s3_object_version ⇒ String
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.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#startup_script_s3_path ⇒ String
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.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#webserver_access_mode ⇒ String
The Apache Airflow Web server access mode. For more information, see Apache Airflow access modes.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |
#weekly_maintenance_window_start ⇒ String
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.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 1501 class UpdateEnvironmentInput < Struct.new( :airflow_configuration_options, :airflow_version, :dag_s3_path, :environment_class, :execution_role_arn, :logging_configuration, :max_workers, :min_workers, :name, :network_configuration, :plugins_s3_object_version, :plugins_s3_path, :requirements_s3_object_version, :requirements_s3_path, :schedulers, :source_bucket_arn, :startup_script_s3_object_version, :startup_script_s3_path, :webserver_access_mode, :weekly_maintenance_window_start) SENSITIVE = [:airflow_configuration_options] include Aws::Structure end |