aws-sdk-mwaa 1.36.0 → 1.38.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-mwaa/client.rb +370 -309
- data/lib/aws-sdk-mwaa/client_api.rb +75 -67
- data/lib/aws-sdk-mwaa/types.rb +633 -540
- data/lib/aws-sdk-mwaa.rb +1 -1
- data/sig/client.rbs +59 -55
- data/sig/types.rbs +72 -66
- metadata +2 -2
data/lib/aws-sdk-mwaa/client.rb
CHANGED
@@ -301,8 +301,9 @@ module Aws::MWAA
|
|
301
301
|
#
|
302
302
|
# @option options [String] :sdk_ua_app_id
|
303
303
|
# A unique and opaque application ID that is appended to the
|
304
|
-
# User-Agent header as app
|
305
|
-
# maximum length of 50.
|
304
|
+
# User-Agent header as app/sdk_ua_app_id. It should have a
|
305
|
+
# maximum length of 50. This variable is sourced from environment
|
306
|
+
# variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
|
306
307
|
#
|
307
308
|
# @option options [String] :secret_access_key
|
308
309
|
#
|
@@ -451,58 +452,9 @@ module Aws::MWAA
|
|
451
452
|
# Creates an Amazon Managed Workflows for Apache Airflow (MWAA)
|
452
453
|
# environment.
|
453
454
|
#
|
454
|
-
# @option params [
|
455
|
-
#
|
456
|
-
#
|
457
|
-
# see [Apache Airflow configuration options][1].
|
458
|
-
#
|
459
|
-
#
|
460
|
-
#
|
461
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html
|
462
|
-
#
|
463
|
-
# @option params [String] :airflow_version
|
464
|
-
# The Apache Airflow version for your environment. If no value is
|
465
|
-
# specified, it defaults to the latest version. For more information,
|
466
|
-
# see [Apache Airflow versions on Amazon Managed Workflows for Apache
|
467
|
-
# Airflow (MWAA)][1].
|
468
|
-
#
|
469
|
-
# Valid values: `1.10.12`, `2.0.2`, `2.2.2`, `2.4.3`, `2.5.1`, `2.6.3`,
|
470
|
-
# `2.7.2` `2.8.1`
|
471
|
-
#
|
472
|
-
#
|
473
|
-
#
|
474
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/airflow-versions.html
|
475
|
-
#
|
476
|
-
# @option params [required, String] :dag_s3_path
|
477
|
-
# The relative path to the DAGs folder on your Amazon S3 bucket. For
|
478
|
-
# example, `dags`. For more information, see [Adding or updating
|
479
|
-
# DAGs][1].
|
480
|
-
#
|
481
|
-
#
|
482
|
-
#
|
483
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html
|
484
|
-
#
|
485
|
-
# @option params [String] :endpoint_management
|
486
|
-
# Defines whether the VPC endpoints configured for the environment are
|
487
|
-
# created, and managed, by the customer or by Amazon MWAA. If set to
|
488
|
-
# `SERVICE`, Amazon MWAA will create and manage the required VPC
|
489
|
-
# endpoints in your VPC. If set to `CUSTOMER`, you must create, and
|
490
|
-
# manage, the VPC endpoints for your VPC. If you choose to create an
|
491
|
-
# environment in a shared VPC, you must set this value to `CUSTOMER`. In
|
492
|
-
# a shared VPC deployment, the environment will remain in `PENDING`
|
493
|
-
# status until you create the VPC endpoints. If you do not take action
|
494
|
-
# to create the endpoints within 72 hours, the status will change to
|
495
|
-
# `CREATE_FAILED`. You can delete the failed environment and create a
|
496
|
-
# new one.
|
497
|
-
#
|
498
|
-
# @option params [String] :environment_class
|
499
|
-
# The environment class type. Valid values: `mw1.small`, `mw1.medium`,
|
500
|
-
# `mw1.large`. For more information, see [Amazon MWAA environment
|
501
|
-
# class][1].
|
502
|
-
#
|
503
|
-
#
|
504
|
-
#
|
505
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html
|
455
|
+
# @option params [required, String] :name
|
456
|
+
# The name of the Amazon MWAA environment. For example,
|
457
|
+
# `MyMWAAEnvironment`.
|
506
458
|
#
|
507
459
|
# @option params [required, String] :execution_role_arn
|
508
460
|
# The Amazon Resource Name (ARN) of the execution role for your
|
@@ -516,38 +468,24 @@ module Aws::MWAA
|
|
516
468
|
#
|
517
469
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html
|
518
470
|
#
|
519
|
-
# @option params [String] :
|
520
|
-
# The Amazon
|
521
|
-
#
|
522
|
-
#
|
523
|
-
# [Create an Amazon MWAA
|
471
|
+
# @option params [required, String] :source_bucket_arn
|
472
|
+
# The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG
|
473
|
+
# code and supporting files are stored. For example,
|
474
|
+
# `arn:aws:s3:::my-airflow-bucket-unique-name`. For more information,
|
475
|
+
# see [Create an Amazon S3 bucket for Amazon MWAA][1].
|
524
476
|
#
|
525
477
|
#
|
526
478
|
#
|
527
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
479
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html
|
528
480
|
#
|
529
|
-
# @option params [
|
530
|
-
#
|
481
|
+
# @option params [required, String] :dag_s3_path
|
482
|
+
# The relative path to the DAGs folder on your Amazon S3 bucket. For
|
483
|
+
# example, `dags`. For more information, see [Adding or updating
|
484
|
+
# DAGs][1].
|
531
485
|
#
|
532
|
-
# @option params [Integer] :max_workers
|
533
|
-
# The maximum number of workers that you want to run in your
|
534
|
-
# environment. MWAA scales the number of Apache Airflow workers up to
|
535
|
-
# the number you specify in the `MaxWorkers` field. For example, `20`.
|
536
|
-
# When there are no more tasks running, and no more in the queue, MWAA
|
537
|
-
# disposes of the extra workers leaving the one worker that is included
|
538
|
-
# with your environment, or the number you specify in `MinWorkers`.
|
539
486
|
#
|
540
|
-
# @option params [Integer] :min_workers
|
541
|
-
# The minimum number of workers that you want to run in your
|
542
|
-
# environment. MWAA scales the number of Apache Airflow workers up to
|
543
|
-
# the number you specify in the `MaxWorkers` field. When there are no
|
544
|
-
# more tasks running, and no more in the queue, MWAA disposes of the
|
545
|
-
# extra workers leaving the worker count you specify in the `MinWorkers`
|
546
|
-
# field. For example, `2`.
|
547
487
|
#
|
548
|
-
#
|
549
|
-
# The name of the Amazon MWAA environment. For example,
|
550
|
-
# `MyMWAAEnvironment`.
|
488
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html
|
551
489
|
#
|
552
490
|
# @option params [required, Types::NetworkConfiguration] :network_configuration
|
553
491
|
# The VPC networking components used to secure and enable network
|
@@ -559,15 +497,6 @@ module Aws::MWAA
|
|
559
497
|
#
|
560
498
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html
|
561
499
|
#
|
562
|
-
# @option params [String] :plugins_s3_object_version
|
563
|
-
# The version of the plugins.zip file on your Amazon S3 bucket. You must
|
564
|
-
# specify a version each time a plugins.zip file is updated. For more
|
565
|
-
# information, see [How S3 Versioning works][1].
|
566
|
-
#
|
567
|
-
#
|
568
|
-
#
|
569
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html
|
570
|
-
#
|
571
500
|
# @option params [String] :plugins_s3_path
|
572
501
|
# The relative path to the `plugins.zip` file on your Amazon S3 bucket.
|
573
502
|
# For example, `plugins.zip`. If specified, then the `plugins.zip`
|
@@ -578,10 +507,10 @@ module Aws::MWAA
|
|
578
507
|
#
|
579
508
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html
|
580
509
|
#
|
581
|
-
# @option params [String] :
|
582
|
-
# The version of the
|
583
|
-
#
|
584
|
-
#
|
510
|
+
# @option params [String] :plugins_s3_object_version
|
511
|
+
# The version of the plugins.zip file on your Amazon S3 bucket. You must
|
512
|
+
# specify a version each time a plugins.zip file is updated. For more
|
513
|
+
# information, see [How S3 Versioning works][1].
|
585
514
|
#
|
586
515
|
#
|
587
516
|
#
|
@@ -597,23 +526,28 @@ module Aws::MWAA
|
|
597
526
|
#
|
598
527
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html
|
599
528
|
#
|
600
|
-
# @option params [
|
601
|
-
# The
|
602
|
-
#
|
529
|
+
# @option params [String] :requirements_s3_object_version
|
530
|
+
# The version of the `requirements.txt` file on your Amazon S3 bucket.
|
531
|
+
# You must specify a version each time a requirements.txt file is
|
532
|
+
# updated. For more information, see [How S3 Versioning works][1].
|
603
533
|
#
|
604
|
-
# * v2 - Accepts between 2 to 5. Defaults to 2.
|
605
534
|
#
|
606
|
-
# * v1 - Accepts 1.
|
607
535
|
#
|
608
|
-
#
|
609
|
-
# The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG
|
610
|
-
# code and supporting files are stored. For example,
|
611
|
-
# `arn:aws:s3:::my-airflow-bucket-unique-name`. For more information,
|
612
|
-
# see [Create an Amazon S3 bucket for Amazon MWAA][1].
|
536
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html
|
613
537
|
#
|
538
|
+
# @option params [String] :startup_script_s3_path
|
539
|
+
# The relative path to the startup shell script in your Amazon S3
|
540
|
+
# bucket. For example, `s3://mwaa-environment/startup.sh`.
|
541
|
+
#
|
542
|
+
# Amazon MWAA runs the script as your environment starts, and before
|
543
|
+
# running the Apache Airflow process. You can use this script to install
|
544
|
+
# dependencies, modify Apache Airflow configuration options, and set
|
545
|
+
# environment variables. For more information, see [Using a startup
|
546
|
+
# script][1].
|
614
547
|
#
|
615
548
|
#
|
616
|
-
#
|
549
|
+
#
|
550
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html
|
617
551
|
#
|
618
552
|
# @option params [String] :startup_script_s3_object_version
|
619
553
|
# The version of the startup shell script in your Amazon S3 bucket. You
|
@@ -632,19 +566,64 @@ module Aws::MWAA
|
|
632
566
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html
|
633
567
|
# [2]: https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html
|
634
568
|
#
|
635
|
-
# @option params [String] :
|
636
|
-
#
|
637
|
-
#
|
569
|
+
# @option params [Hash<String,String>] :airflow_configuration_options
|
570
|
+
# A list of key-value pairs containing the Apache Airflow configuration
|
571
|
+
# options you want to attach to your environment. For more information,
|
572
|
+
# see [Apache Airflow configuration options][1].
|
638
573
|
#
|
639
|
-
# Amazon MWAA runs the script as your environment starts, and before
|
640
|
-
# running the Apache Airflow process. You can use this script to install
|
641
|
-
# dependencies, modify Apache Airflow configuration options, and set
|
642
|
-
# environment variables. For more information, see [Using a startup
|
643
|
-
# script][1].
|
644
574
|
#
|
645
575
|
#
|
576
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html
|
646
577
|
#
|
647
|
-
#
|
578
|
+
# @option params [String] :environment_class
|
579
|
+
# The environment class type. Valid values: `mw1.small`, `mw1.medium`,
|
580
|
+
# `mw1.large`, `mw1.xlarge`, and `mw1.2xlarge`. For more information,
|
581
|
+
# see [Amazon MWAA environment class][1].
|
582
|
+
#
|
583
|
+
#
|
584
|
+
#
|
585
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html
|
586
|
+
#
|
587
|
+
# @option params [Integer] :max_workers
|
588
|
+
# The maximum number of workers that you want to run in your
|
589
|
+
# environment. MWAA scales the number of Apache Airflow workers up to
|
590
|
+
# the number you specify in the `MaxWorkers` field. For example, `20`.
|
591
|
+
# When there are no more tasks running, and no more in the queue, MWAA
|
592
|
+
# disposes of the extra workers leaving the one worker that is included
|
593
|
+
# with your environment, or the number you specify in `MinWorkers`.
|
594
|
+
#
|
595
|
+
# @option params [String] :kms_key
|
596
|
+
# The Amazon Web Services Key Management Service (KMS) key to encrypt
|
597
|
+
# the data in your environment. You can use an Amazon Web Services owned
|
598
|
+
# CMK, or a Customer managed CMK (advanced). For more information, see
|
599
|
+
# [Create an Amazon MWAA environment][1].
|
600
|
+
#
|
601
|
+
#
|
602
|
+
#
|
603
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/create-environment.html
|
604
|
+
#
|
605
|
+
# @option params [String] :airflow_version
|
606
|
+
# The Apache Airflow version for your environment. If no value is
|
607
|
+
# specified, it defaults to the latest version. For more information,
|
608
|
+
# see [Apache Airflow versions on Amazon Managed Workflows for Apache
|
609
|
+
# Airflow (MWAA)][1].
|
610
|
+
#
|
611
|
+
# Valid values: `1.10.12`, `2.0.2`, `2.2.2`, `2.4.3`, `2.5.1`, `2.6.3`,
|
612
|
+
# `2.7.2` `2.8.1`
|
613
|
+
#
|
614
|
+
#
|
615
|
+
#
|
616
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/airflow-versions.html
|
617
|
+
#
|
618
|
+
# @option params [Types::LoggingConfigurationInput] :logging_configuration
|
619
|
+
# Defines the Apache Airflow logs to send to CloudWatch Logs.
|
620
|
+
#
|
621
|
+
# @option params [String] :weekly_maintenance_window_start
|
622
|
+
# The day and time of the week in Coordinated Universal Time (UTC)
|
623
|
+
# 24-hour standard time to start weekly maintenance updates of your
|
624
|
+
# environment in the following format: `DAY:HH:MM`. For example:
|
625
|
+
# `TUE:03:30`. You can specify a start time in 30 minute increments
|
626
|
+
# only.
|
648
627
|
#
|
649
628
|
# @option params [Hash<String,String>] :tags
|
650
629
|
# The key-value tag pairs you want to associate to your environment. For
|
@@ -663,12 +642,61 @@ module Aws::MWAA
|
|
663
642
|
#
|
664
643
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html
|
665
644
|
#
|
666
|
-
# @option params [
|
667
|
-
# The
|
668
|
-
#
|
669
|
-
#
|
670
|
-
#
|
671
|
-
#
|
645
|
+
# @option params [Integer] :min_workers
|
646
|
+
# The minimum number of workers that you want to run in your
|
647
|
+
# environment. MWAA scales the number of Apache Airflow workers up to
|
648
|
+
# the number you specify in the `MaxWorkers` field. When there are no
|
649
|
+
# more tasks running, and no more in the queue, MWAA disposes of the
|
650
|
+
# extra workers leaving the worker count you specify in the `MinWorkers`
|
651
|
+
# field. For example, `2`.
|
652
|
+
#
|
653
|
+
# @option params [Integer] :schedulers
|
654
|
+
# The number of Apache Airflow schedulers to run in your environment.
|
655
|
+
# Valid values:
|
656
|
+
#
|
657
|
+
# * v2 - Accepts between `2` to `5`. Defaults to `2`.
|
658
|
+
#
|
659
|
+
# * v1 - Accepts `1`.
|
660
|
+
#
|
661
|
+
# @option params [String] :endpoint_management
|
662
|
+
# Defines whether the VPC endpoints configured for the environment are
|
663
|
+
# created, and managed, by the customer or by Amazon MWAA. If set to
|
664
|
+
# `SERVICE`, Amazon MWAA will create and manage the required VPC
|
665
|
+
# endpoints in your VPC. If set to `CUSTOMER`, you must create, and
|
666
|
+
# manage, the VPC endpoints for your VPC. If you choose to create an
|
667
|
+
# environment in a shared VPC, you must set this value to `CUSTOMER`. In
|
668
|
+
# a shared VPC deployment, the environment will remain in `PENDING`
|
669
|
+
# status until you create the VPC endpoints. If you do not take action
|
670
|
+
# to create the endpoints within 72 hours, the status will change to
|
671
|
+
# `CREATE_FAILED`. You can delete the failed environment and create a
|
672
|
+
# new one.
|
673
|
+
#
|
674
|
+
# @option params [Integer] :min_webservers
|
675
|
+
# The minimum number of web servers that you want to run in your
|
676
|
+
# environment. Amazon MWAA scales the number of Apache Airflow web
|
677
|
+
# servers up to the number you specify for `MaxWebservers` when you
|
678
|
+
# interact with your Apache Airflow environment using Apache Airflow
|
679
|
+
# REST API, or the Apache Airflow CLI. As the transaction-per-second
|
680
|
+
# rate, and the network load, decrease, Amazon MWAA disposes of the
|
681
|
+
# additional web servers, and scales down to the number set in
|
682
|
+
# `MinxWebserers`.
|
683
|
+
#
|
684
|
+
# Valid values: Accepts between `2` and `5`. Defaults to `2`.
|
685
|
+
#
|
686
|
+
# @option params [Integer] :max_webservers
|
687
|
+
# The maximum number of web servers that you want to run in your
|
688
|
+
# environment. Amazon MWAA scales the number of Apache Airflow web
|
689
|
+
# servers up to the number you specify for `MaxWebservers` when you
|
690
|
+
# interact with your Apache Airflow environment using Apache Airflow
|
691
|
+
# REST API, or the Apache Airflow CLI. For example, in scenarios where
|
692
|
+
# your workload requires network calls to the Apache Airflow REST API
|
693
|
+
# with a high transaction-per-second (TPS) rate, Amazon MWAA will
|
694
|
+
# increase the number of web servers up to the number set in
|
695
|
+
# `MaxWebserers`. As TPS rates decrease Amazon MWAA disposes of the
|
696
|
+
# additional web servers, and scales down to the number set in
|
697
|
+
# `MinxWebserers`.
|
698
|
+
#
|
699
|
+
# Valid values: Accepts between `2` and `5`. Defaults to `2`.
|
672
700
|
#
|
673
701
|
# @return [Types::CreateEnvironmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
674
702
|
#
|
@@ -677,15 +705,27 @@ module Aws::MWAA
|
|
677
705
|
# @example Request syntax with placeholder values
|
678
706
|
#
|
679
707
|
# resp = client.create_environment({
|
708
|
+
# name: "EnvironmentName", # required
|
709
|
+
# execution_role_arn: "IamRoleArn", # required
|
710
|
+
# source_bucket_arn: "S3BucketArn", # required
|
711
|
+
# dag_s3_path: "RelativePath", # required
|
712
|
+
# network_configuration: { # required
|
713
|
+
# subnet_ids: ["SubnetId"],
|
714
|
+
# security_group_ids: ["SecurityGroupId"],
|
715
|
+
# },
|
716
|
+
# plugins_s3_path: "RelativePath",
|
717
|
+
# plugins_s3_object_version: "S3ObjectVersion",
|
718
|
+
# requirements_s3_path: "RelativePath",
|
719
|
+
# requirements_s3_object_version: "S3ObjectVersion",
|
720
|
+
# startup_script_s3_path: "RelativePath",
|
721
|
+
# startup_script_s3_object_version: "S3ObjectVersion",
|
680
722
|
# airflow_configuration_options: {
|
681
723
|
# "ConfigKey" => "ConfigValue",
|
682
724
|
# },
|
683
|
-
# airflow_version: "AirflowVersion",
|
684
|
-
# dag_s3_path: "RelativePath", # required
|
685
|
-
# endpoint_management: "CUSTOMER", # accepts CUSTOMER, SERVICE
|
686
725
|
# environment_class: "EnvironmentClass",
|
687
|
-
#
|
726
|
+
# max_workers: 1,
|
688
727
|
# kms_key: "KmsKey",
|
728
|
+
# airflow_version: "AirflowVersion",
|
689
729
|
# logging_configuration: {
|
690
730
|
# dag_processing_logs: {
|
691
731
|
# enabled: false, # required
|
@@ -695,39 +735,29 @@ module Aws::MWAA
|
|
695
735
|
# enabled: false, # required
|
696
736
|
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
697
737
|
# },
|
698
|
-
#
|
738
|
+
# webserver_logs: {
|
699
739
|
# enabled: false, # required
|
700
740
|
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
701
741
|
# },
|
702
|
-
#
|
742
|
+
# worker_logs: {
|
703
743
|
# enabled: false, # required
|
704
744
|
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
705
745
|
# },
|
706
|
-
#
|
746
|
+
# task_logs: {
|
707
747
|
# enabled: false, # required
|
708
748
|
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
709
749
|
# },
|
710
750
|
# },
|
711
|
-
#
|
712
|
-
# min_workers: 1,
|
713
|
-
# name: "EnvironmentName", # required
|
714
|
-
# network_configuration: { # required
|
715
|
-
# security_group_ids: ["SecurityGroupId"],
|
716
|
-
# subnet_ids: ["SubnetId"],
|
717
|
-
# },
|
718
|
-
# plugins_s3_object_version: "S3ObjectVersion",
|
719
|
-
# plugins_s3_path: "RelativePath",
|
720
|
-
# requirements_s3_object_version: "S3ObjectVersion",
|
721
|
-
# requirements_s3_path: "RelativePath",
|
722
|
-
# schedulers: 1,
|
723
|
-
# source_bucket_arn: "S3BucketArn", # required
|
724
|
-
# startup_script_s3_object_version: "S3ObjectVersion",
|
725
|
-
# startup_script_s3_path: "RelativePath",
|
751
|
+
# weekly_maintenance_window_start: "WeeklyMaintenanceWindowStart",
|
726
752
|
# tags: {
|
727
753
|
# "TagKey" => "TagValue",
|
728
754
|
# },
|
729
755
|
# webserver_access_mode: "PRIVATE_ONLY", # accepts PRIVATE_ONLY, PUBLIC_ONLY
|
730
|
-
#
|
756
|
+
# min_workers: 1,
|
757
|
+
# schedulers: 1,
|
758
|
+
# endpoint_management: "CUSTOMER", # accepts CUSTOMER, SERVICE
|
759
|
+
# min_webservers: 1,
|
760
|
+
# max_webservers: 1,
|
731
761
|
# })
|
732
762
|
#
|
733
763
|
# @example Response structure
|
@@ -756,10 +786,10 @@ module Aws::MWAA
|
|
756
786
|
#
|
757
787
|
# @return [Types::CreateWebLoginTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
758
788
|
#
|
759
|
-
# * {Types::CreateWebLoginTokenResponse#airflow_identity #airflow_identity} => String
|
760
|
-
# * {Types::CreateWebLoginTokenResponse#iam_identity #iam_identity} => String
|
761
|
-
# * {Types::CreateWebLoginTokenResponse#web_server_hostname #web_server_hostname} => String
|
762
789
|
# * {Types::CreateWebLoginTokenResponse#web_token #web_token} => String
|
790
|
+
# * {Types::CreateWebLoginTokenResponse#web_server_hostname #web_server_hostname} => String
|
791
|
+
# * {Types::CreateWebLoginTokenResponse#iam_identity #iam_identity} => String
|
792
|
+
# * {Types::CreateWebLoginTokenResponse#airflow_identity #airflow_identity} => String
|
763
793
|
#
|
764
794
|
# @example Request syntax with placeholder values
|
765
795
|
#
|
@@ -769,10 +799,10 @@ module Aws::MWAA
|
|
769
799
|
#
|
770
800
|
# @example Response structure
|
771
801
|
#
|
772
|
-
# resp.airflow_identity #=> String
|
773
|
-
# resp.iam_identity #=> String
|
774
|
-
# resp.web_server_hostname #=> String
|
775
802
|
# resp.web_token #=> String
|
803
|
+
# resp.web_server_hostname #=> String
|
804
|
+
# resp.iam_identity #=> String
|
805
|
+
# resp.airflow_identity #=> String
|
776
806
|
#
|
777
807
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/CreateWebLoginToken AWS API Documentation
|
778
808
|
#
|
@@ -826,61 +856,63 @@ module Aws::MWAA
|
|
826
856
|
#
|
827
857
|
# @example Response structure
|
828
858
|
#
|
829
|
-
# resp.environment.
|
830
|
-
# resp.environment.
|
831
|
-
# resp.environment.airflow_version #=> String
|
859
|
+
# resp.environment.name #=> String
|
860
|
+
# resp.environment.status #=> String, one of "CREATING", "CREATE_FAILED", "AVAILABLE", "UPDATING", "DELETING", "DELETED", "UNAVAILABLE", "UPDATE_FAILED", "ROLLING_BACK", "CREATING_SNAPSHOT", "PENDING", "MAINTENANCE"
|
832
861
|
# resp.environment.arn #=> String
|
833
|
-
# resp.environment.celery_executor_queue #=> String
|
834
862
|
# resp.environment.created_at #=> Time
|
835
|
-
# resp.environment.
|
836
|
-
# resp.environment.database_vpc_endpoint_service #=> String
|
837
|
-
# resp.environment.endpoint_management #=> String, one of "CUSTOMER", "SERVICE"
|
838
|
-
# resp.environment.environment_class #=> String
|
863
|
+
# resp.environment.webserver_url #=> String
|
839
864
|
# resp.environment.execution_role_arn #=> String
|
865
|
+
# resp.environment.service_role_arn #=> String
|
840
866
|
# resp.environment.kms_key #=> String
|
841
|
-
# resp.environment.
|
842
|
-
# resp.environment.
|
843
|
-
# resp.environment.
|
844
|
-
# resp.environment.
|
845
|
-
# resp.environment.
|
846
|
-
# resp.environment.
|
867
|
+
# resp.environment.airflow_version #=> String
|
868
|
+
# resp.environment.source_bucket_arn #=> String
|
869
|
+
# resp.environment.dag_s3_path #=> String
|
870
|
+
# resp.environment.plugins_s3_path #=> String
|
871
|
+
# resp.environment.plugins_s3_object_version #=> String
|
872
|
+
# resp.environment.requirements_s3_path #=> String
|
873
|
+
# resp.environment.requirements_s3_object_version #=> String
|
874
|
+
# resp.environment.startup_script_s3_path #=> String
|
875
|
+
# resp.environment.startup_script_s3_object_version #=> String
|
876
|
+
# resp.environment.airflow_configuration_options #=> Hash
|
877
|
+
# resp.environment.airflow_configuration_options["ConfigKey"] #=> String
|
878
|
+
# resp.environment.environment_class #=> String
|
879
|
+
# resp.environment.max_workers #=> Integer
|
880
|
+
# resp.environment.network_configuration.subnet_ids #=> Array
|
881
|
+
# resp.environment.network_configuration.subnet_ids[0] #=> String
|
882
|
+
# resp.environment.network_configuration.security_group_ids #=> Array
|
883
|
+
# resp.environment.network_configuration.security_group_ids[0] #=> String
|
847
884
|
# resp.environment.logging_configuration.dag_processing_logs.enabled #=> Boolean
|
848
885
|
# resp.environment.logging_configuration.dag_processing_logs.log_level #=> String, one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"
|
849
|
-
# resp.environment.logging_configuration.
|
886
|
+
# resp.environment.logging_configuration.dag_processing_logs.cloud_watch_log_group_arn #=> String
|
850
887
|
# resp.environment.logging_configuration.scheduler_logs.enabled #=> Boolean
|
851
888
|
# resp.environment.logging_configuration.scheduler_logs.log_level #=> String, one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"
|
852
|
-
# resp.environment.logging_configuration.
|
853
|
-
# resp.environment.logging_configuration.task_logs.enabled #=> Boolean
|
854
|
-
# resp.environment.logging_configuration.task_logs.log_level #=> String, one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"
|
855
|
-
# resp.environment.logging_configuration.webserver_logs.cloud_watch_log_group_arn #=> String
|
889
|
+
# resp.environment.logging_configuration.scheduler_logs.cloud_watch_log_group_arn #=> String
|
856
890
|
# resp.environment.logging_configuration.webserver_logs.enabled #=> Boolean
|
857
891
|
# resp.environment.logging_configuration.webserver_logs.log_level #=> String, one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"
|
858
|
-
# resp.environment.logging_configuration.
|
892
|
+
# resp.environment.logging_configuration.webserver_logs.cloud_watch_log_group_arn #=> String
|
859
893
|
# resp.environment.logging_configuration.worker_logs.enabled #=> Boolean
|
860
894
|
# resp.environment.logging_configuration.worker_logs.log_level #=> String, one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"
|
861
|
-
# resp.environment.
|
862
|
-
# resp.environment.
|
863
|
-
# resp.environment.
|
864
|
-
# resp.environment.
|
865
|
-
# resp.environment.
|
866
|
-
# resp.environment.
|
867
|
-
# resp.environment.
|
868
|
-
# resp.environment.
|
869
|
-
# resp.environment.
|
870
|
-
# resp.environment.
|
871
|
-
# resp.environment.requirements_s3_path #=> String
|
872
|
-
# resp.environment.schedulers #=> Integer
|
873
|
-
# resp.environment.service_role_arn #=> String
|
874
|
-
# resp.environment.source_bucket_arn #=> String
|
875
|
-
# resp.environment.startup_script_s3_object_version #=> String
|
876
|
-
# resp.environment.startup_script_s3_path #=> String
|
877
|
-
# resp.environment.status #=> String, one of "CREATING", "CREATE_FAILED", "AVAILABLE", "UPDATING", "DELETING", "DELETED", "UNAVAILABLE", "UPDATE_FAILED", "ROLLING_BACK", "CREATING_SNAPSHOT", "PENDING", "MAINTENANCE"
|
895
|
+
# resp.environment.logging_configuration.worker_logs.cloud_watch_log_group_arn #=> String
|
896
|
+
# resp.environment.logging_configuration.task_logs.enabled #=> Boolean
|
897
|
+
# resp.environment.logging_configuration.task_logs.log_level #=> String, one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"
|
898
|
+
# resp.environment.logging_configuration.task_logs.cloud_watch_log_group_arn #=> String
|
899
|
+
# resp.environment.last_update.status #=> String, one of "SUCCESS", "PENDING", "FAILED"
|
900
|
+
# resp.environment.last_update.created_at #=> Time
|
901
|
+
# resp.environment.last_update.error.error_code #=> String
|
902
|
+
# resp.environment.last_update.error.error_message #=> String
|
903
|
+
# resp.environment.last_update.source #=> String
|
904
|
+
# resp.environment.weekly_maintenance_window_start #=> String
|
878
905
|
# resp.environment.tags #=> Hash
|
879
906
|
# resp.environment.tags["TagKey"] #=> String
|
880
907
|
# resp.environment.webserver_access_mode #=> String, one of "PRIVATE_ONLY", "PUBLIC_ONLY"
|
881
|
-
# resp.environment.
|
908
|
+
# resp.environment.min_workers #=> Integer
|
909
|
+
# resp.environment.schedulers #=> Integer
|
882
910
|
# resp.environment.webserver_vpc_endpoint_service #=> String
|
883
|
-
# resp.environment.
|
911
|
+
# resp.environment.database_vpc_endpoint_service #=> String
|
912
|
+
# resp.environment.celery_executor_queue #=> String
|
913
|
+
# resp.environment.endpoint_management #=> String, one of "CUSTOMER", "SERVICE"
|
914
|
+
# resp.environment.min_webservers #=> Integer
|
915
|
+
# resp.environment.max_webservers #=> Integer
|
884
916
|
#
|
885
917
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/GetEnvironment AWS API Documentation
|
886
918
|
#
|
@@ -894,13 +926,13 @@ module Aws::MWAA
|
|
894
926
|
# Lists the Amazon Managed Workflows for Apache Airflow (MWAA)
|
895
927
|
# environments.
|
896
928
|
#
|
929
|
+
# @option params [String] :next_token
|
930
|
+
# Retrieves the next page of the results.
|
931
|
+
#
|
897
932
|
# @option params [Integer] :max_results
|
898
933
|
# The maximum number of results to retrieve per page. For example, `5`
|
899
934
|
# environments per page.
|
900
935
|
#
|
901
|
-
# @option params [String] :next_token
|
902
|
-
# Retrieves the next page of the results.
|
903
|
-
#
|
904
936
|
# @return [Types::ListEnvironmentsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
905
937
|
#
|
906
938
|
# * {Types::ListEnvironmentsOutput#environments #environments} => Array<String>
|
@@ -911,8 +943,8 @@ module Aws::MWAA
|
|
911
943
|
# @example Request syntax with placeholder values
|
912
944
|
#
|
913
945
|
# resp = client.list_environments({
|
914
|
-
# max_results: 1,
|
915
946
|
# next_token: "NextToken",
|
947
|
+
# max_results: 1,
|
916
948
|
# })
|
917
949
|
#
|
918
950
|
# @example Response structure
|
@@ -986,22 +1018,22 @@ module Aws::MWAA
|
|
986
1018
|
# environment_name: "EnvironmentName", # required
|
987
1019
|
# metric_data: [ # required
|
988
1020
|
# {
|
1021
|
+
# metric_name: "String", # required
|
1022
|
+
# timestamp: Time.now, # required
|
989
1023
|
# dimensions: [
|
990
1024
|
# {
|
991
1025
|
# name: "String", # required
|
992
1026
|
# value: "String", # required
|
993
1027
|
# },
|
994
1028
|
# ],
|
995
|
-
#
|
1029
|
+
# value: 1.0,
|
1030
|
+
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
996
1031
|
# statistic_values: {
|
997
|
-
# maximum: 1.0,
|
998
|
-
# minimum: 1.0,
|
999
1032
|
# sample_count: 1,
|
1000
1033
|
# sum: 1.0,
|
1034
|
+
# minimum: 1.0,
|
1035
|
+
# maximum: 1.0,
|
1001
1036
|
# },
|
1002
|
-
# timestamp: Time.now, # required
|
1003
|
-
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
1004
|
-
# value: 1.0,
|
1005
1037
|
# },
|
1006
1038
|
# ],
|
1007
1039
|
# })
|
@@ -1086,14 +1118,20 @@ module Aws::MWAA
|
|
1086
1118
|
# Updates an Amazon Managed Workflows for Apache Airflow (MWAA)
|
1087
1119
|
# environment.
|
1088
1120
|
#
|
1089
|
-
# @option params [
|
1090
|
-
#
|
1091
|
-
#
|
1092
|
-
#
|
1121
|
+
# @option params [required, String] :name
|
1122
|
+
# The name of your Amazon MWAA environment. For example,
|
1123
|
+
# `MyMWAAEnvironment`.
|
1124
|
+
#
|
1125
|
+
# @option params [String] :execution_role_arn
|
1126
|
+
# The Amazon Resource Name (ARN) of the execution role in IAM that
|
1127
|
+
# allows MWAA to access Amazon Web Services resources in your
|
1128
|
+
# environment. For example,
|
1129
|
+
# `arn:aws:iam::123456789:role/my-execution-role`. For more information,
|
1130
|
+
# see [Amazon MWAA Execution role][1].
|
1093
1131
|
#
|
1094
1132
|
#
|
1095
1133
|
#
|
1096
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
1134
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html
|
1097
1135
|
#
|
1098
1136
|
# @option params [String] :airflow_version
|
1099
1137
|
# The Apache Airflow version for your environment. To upgrade your
|
@@ -1107,12 +1145,22 @@ module Aws::MWAA
|
|
1107
1145
|
# environment][1].
|
1108
1146
|
#
|
1109
1147
|
# Valid values: `1.10.12`, `2.0.2`, `2.2.2`, `2.4.3`, `2.5.1`, `2.6.3`,
|
1110
|
-
# `2.7.2`.
|
1148
|
+
# `2.7.2`, `2.8.1`.
|
1111
1149
|
#
|
1112
1150
|
#
|
1113
1151
|
#
|
1114
1152
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/upgrading-environment.html
|
1115
1153
|
#
|
1154
|
+
# @option params [String] :source_bucket_arn
|
1155
|
+
# The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG
|
1156
|
+
# code and supporting files are stored. For example,
|
1157
|
+
# `arn:aws:s3:::my-airflow-bucket-unique-name`. For more information,
|
1158
|
+
# see [Create an Amazon S3 bucket for Amazon MWAA][1].
|
1159
|
+
#
|
1160
|
+
#
|
1161
|
+
#
|
1162
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html
|
1163
|
+
#
|
1116
1164
|
# @option params [String] :dag_s3_path
|
1117
1165
|
# The relative path to the DAGs folder on your Amazon S3 bucket. For
|
1118
1166
|
# example, `dags`. For more information, see [Adding or updating
|
@@ -1122,58 +1170,14 @@ module Aws::MWAA
|
|
1122
1170
|
#
|
1123
1171
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html
|
1124
1172
|
#
|
1125
|
-
# @option params [String] :
|
1126
|
-
# The
|
1127
|
-
# `
|
1128
|
-
#
|
1129
|
-
#
|
1130
|
-
#
|
1131
|
-
#
|
1132
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html
|
1133
|
-
#
|
1134
|
-
# @option params [String] :execution_role_arn
|
1135
|
-
# The Amazon Resource Name (ARN) of the execution role in IAM that
|
1136
|
-
# allows MWAA to access Amazon Web Services resources in your
|
1137
|
-
# environment. For example,
|
1138
|
-
# `arn:aws:iam::123456789:role/my-execution-role`. For more information,
|
1139
|
-
# see [Amazon MWAA Execution role][1].
|
1140
|
-
#
|
1141
|
-
#
|
1142
|
-
#
|
1143
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html
|
1144
|
-
#
|
1145
|
-
# @option params [Types::LoggingConfigurationInput] :logging_configuration
|
1146
|
-
# The Apache Airflow log types to send to CloudWatch Logs.
|
1147
|
-
#
|
1148
|
-
# @option params [Integer] :max_workers
|
1149
|
-
# The maximum number of workers that you want to run in your
|
1150
|
-
# environment. MWAA scales the number of Apache Airflow workers up to
|
1151
|
-
# the number you specify in the `MaxWorkers` field. For example, `20`.
|
1152
|
-
# When there are no more tasks running, and no more in the queue, MWAA
|
1153
|
-
# disposes of the extra workers leaving the one worker that is included
|
1154
|
-
# with your environment, or the number you specify in `MinWorkers`.
|
1155
|
-
#
|
1156
|
-
# @option params [Integer] :min_workers
|
1157
|
-
# The minimum number of workers that you want to run in your
|
1158
|
-
# environment. MWAA scales the number of Apache Airflow workers up to
|
1159
|
-
# the number you specify in the `MaxWorkers` field. When there are no
|
1160
|
-
# more tasks running, and no more in the queue, MWAA disposes of the
|
1161
|
-
# extra workers leaving the worker count you specify in the `MinWorkers`
|
1162
|
-
# field. For example, `2`.
|
1163
|
-
#
|
1164
|
-
# @option params [required, String] :name
|
1165
|
-
# The name of your Amazon MWAA environment. For example,
|
1166
|
-
# `MyMWAAEnvironment`.
|
1167
|
-
#
|
1168
|
-
# @option params [Types::UpdateNetworkConfigurationInput] :network_configuration
|
1169
|
-
# The VPC networking components used to secure and enable network
|
1170
|
-
# traffic between the Amazon Web Services resources for your
|
1171
|
-
# environment. For more information, see [About networking on Amazon
|
1172
|
-
# MWAA][1].
|
1173
|
+
# @option params [String] :plugins_s3_path
|
1174
|
+
# The relative path to the `plugins.zip` file on your Amazon S3 bucket.
|
1175
|
+
# For example, `plugins.zip`. If specified, then the plugins.zip version
|
1176
|
+
# is required. For more information, see [Installing custom plugins][1].
|
1173
1177
|
#
|
1174
1178
|
#
|
1175
1179
|
#
|
1176
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
1180
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html
|
1177
1181
|
#
|
1178
1182
|
# @option params [String] :plugins_s3_object_version
|
1179
1183
|
# The version of the plugins.zip file on your Amazon S3 bucket. You must
|
@@ -1184,14 +1188,15 @@ module Aws::MWAA
|
|
1184
1188
|
#
|
1185
1189
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html
|
1186
1190
|
#
|
1187
|
-
# @option params [String] :
|
1188
|
-
# The relative path to the `
|
1189
|
-
# For example, `
|
1190
|
-
# is required. For more information, see [Installing
|
1191
|
+
# @option params [String] :requirements_s3_path
|
1192
|
+
# The relative path to the `requirements.txt` file on your Amazon S3
|
1193
|
+
# bucket. For example, `requirements.txt`. If specified, then a file
|
1194
|
+
# version is required. For more information, see [Installing Python
|
1195
|
+
# dependencies][1].
|
1191
1196
|
#
|
1192
1197
|
#
|
1193
1198
|
#
|
1194
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
1199
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html
|
1195
1200
|
#
|
1196
1201
|
# @option params [String] :requirements_s3_object_version
|
1197
1202
|
# The version of the requirements.txt file on your Amazon S3 bucket. You
|
@@ -1202,29 +1207,19 @@ module Aws::MWAA
|
|
1202
1207
|
#
|
1203
1208
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html
|
1204
1209
|
#
|
1205
|
-
# @option params [String] :
|
1206
|
-
# The relative path to the
|
1207
|
-
# bucket. For example, `
|
1208
|
-
# version is required. For more information, see [Installing Python
|
1209
|
-
# dependencies][1].
|
1210
|
-
#
|
1211
|
-
#
|
1212
|
-
#
|
1213
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html
|
1214
|
-
#
|
1215
|
-
# @option params [Integer] :schedulers
|
1216
|
-
# The number of Apache Airflow schedulers to run in your Amazon MWAA
|
1217
|
-
# environment.
|
1210
|
+
# @option params [String] :startup_script_s3_path
|
1211
|
+
# The relative path to the startup shell script in your Amazon S3
|
1212
|
+
# bucket. For example, `s3://mwaa-environment/startup.sh`.
|
1218
1213
|
#
|
1219
|
-
#
|
1220
|
-
#
|
1221
|
-
#
|
1222
|
-
#
|
1223
|
-
#
|
1214
|
+
# Amazon MWAA runs the script as your environment starts, and before
|
1215
|
+
# running the Apache Airflow process. You can use this script to install
|
1216
|
+
# dependencies, modify Apache Airflow configuration options, and set
|
1217
|
+
# environment variables. For more information, see [Using a startup
|
1218
|
+
# script][1].
|
1224
1219
|
#
|
1225
1220
|
#
|
1226
1221
|
#
|
1227
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
1222
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html
|
1228
1223
|
#
|
1229
1224
|
# @option params [String] :startup_script_s3_object_version
|
1230
1225
|
# The version of the startup shell script in your Amazon S3 bucket. You
|
@@ -1243,27 +1238,44 @@ module Aws::MWAA
|
|
1243
1238
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html
|
1244
1239
|
# [2]: https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html
|
1245
1240
|
#
|
1246
|
-
# @option params [String] :
|
1247
|
-
#
|
1248
|
-
#
|
1241
|
+
# @option params [Hash<String,String>] :airflow_configuration_options
|
1242
|
+
# A list of key-value pairs containing the Apache Airflow configuration
|
1243
|
+
# options you want to attach to your environment. For more information,
|
1244
|
+
# see [Apache Airflow configuration options][1].
|
1249
1245
|
#
|
1250
|
-
# Amazon MWAA runs the script as your environment starts, and before
|
1251
|
-
# running the Apache Airflow process. You can use this script to install
|
1252
|
-
# dependencies, modify Apache Airflow configuration options, and set
|
1253
|
-
# environment variables. For more information, see [Using a startup
|
1254
|
-
# script][1].
|
1255
1246
|
#
|
1256
1247
|
#
|
1248
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html
|
1257
1249
|
#
|
1258
|
-
#
|
1250
|
+
# @option params [String] :environment_class
|
1251
|
+
# The environment class type. Valid values: `mw1.small`, `mw1.medium`,
|
1252
|
+
# `mw1.large`, `mw1.xlarge`, and `mw1.2xlarge`. For more information,
|
1253
|
+
# see [Amazon MWAA environment class][1].
|
1259
1254
|
#
|
1260
|
-
# @option params [String] :webserver_access_mode
|
1261
|
-
# The Apache Airflow *Web server* access mode. For more information, see
|
1262
|
-
# [Apache Airflow access modes][1].
|
1263
1255
|
#
|
1264
1256
|
#
|
1257
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html
|
1265
1258
|
#
|
1266
|
-
#
|
1259
|
+
# @option params [Integer] :max_workers
|
1260
|
+
# The maximum number of workers that you want to run in your
|
1261
|
+
# environment. MWAA scales the number of Apache Airflow workers up to
|
1262
|
+
# the number you specify in the `MaxWorkers` field. For example, `20`.
|
1263
|
+
# When there are no more tasks running, and no more in the queue, MWAA
|
1264
|
+
# disposes of the extra workers leaving the one worker that is included
|
1265
|
+
# with your environment, or the number you specify in `MinWorkers`.
|
1266
|
+
#
|
1267
|
+
# @option params [Types::UpdateNetworkConfigurationInput] :network_configuration
|
1268
|
+
# The VPC networking components used to secure and enable network
|
1269
|
+
# traffic between the Amazon Web Services resources for your
|
1270
|
+
# environment. For more information, see [About networking on Amazon
|
1271
|
+
# MWAA][1].
|
1272
|
+
#
|
1273
|
+
#
|
1274
|
+
#
|
1275
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html
|
1276
|
+
#
|
1277
|
+
# @option params [Types::LoggingConfigurationInput] :logging_configuration
|
1278
|
+
# The Apache Airflow log types to send to CloudWatch Logs.
|
1267
1279
|
#
|
1268
1280
|
# @option params [String] :weekly_maintenance_window_start
|
1269
1281
|
# The day and time of the week in Coordinated Universal Time (UTC)
|
@@ -1272,6 +1284,53 @@ module Aws::MWAA
|
|
1272
1284
|
# `TUE:03:30`. You can specify a start time in 30 minute increments
|
1273
1285
|
# only.
|
1274
1286
|
#
|
1287
|
+
# @option params [String] :webserver_access_mode
|
1288
|
+
# The Apache Airflow *Web server* access mode. For more information, see
|
1289
|
+
# [Apache Airflow access modes][1].
|
1290
|
+
#
|
1291
|
+
#
|
1292
|
+
#
|
1293
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html
|
1294
|
+
#
|
1295
|
+
# @option params [Integer] :min_workers
|
1296
|
+
# The minimum number of workers that you want to run in your
|
1297
|
+
# environment. MWAA scales the number of Apache Airflow workers up to
|
1298
|
+
# the number you specify in the `MaxWorkers` field. When there are no
|
1299
|
+
# more tasks running, and no more in the queue, MWAA disposes of the
|
1300
|
+
# extra workers leaving the worker count you specify in the `MinWorkers`
|
1301
|
+
# field. For example, `2`.
|
1302
|
+
#
|
1303
|
+
# @option params [Integer] :schedulers
|
1304
|
+
# The number of Apache Airflow schedulers to run in your Amazon MWAA
|
1305
|
+
# environment.
|
1306
|
+
#
|
1307
|
+
# @option params [Integer] :min_webservers
|
1308
|
+
# The minimum number of web servers that you want to run in your
|
1309
|
+
# environment. Amazon MWAA scales the number of Apache Airflow web
|
1310
|
+
# servers up to the number you specify for `MaxWebservers` when you
|
1311
|
+
# interact with your Apache Airflow environment using Apache Airflow
|
1312
|
+
# REST API, or the Apache Airflow CLI. As the transaction-per-second
|
1313
|
+
# rate, and the network load, decrease, Amazon MWAA disposes of the
|
1314
|
+
# additional web servers, and scales down to the number set in
|
1315
|
+
# `MinxWebserers`.
|
1316
|
+
#
|
1317
|
+
# Valid values: Accepts between `2` and `5`. Defaults to `2`.
|
1318
|
+
#
|
1319
|
+
# @option params [Integer] :max_webservers
|
1320
|
+
# The maximum number of web servers that you want to run in your
|
1321
|
+
# environment. Amazon MWAA scales the number of Apache Airflow web
|
1322
|
+
# servers up to the number you specify for `MaxWebservers` when you
|
1323
|
+
# interact with your Apache Airflow environment using Apache Airflow
|
1324
|
+
# REST API, or the Apache Airflow CLI. For example, in scenarios where
|
1325
|
+
# your workload requires network calls to the Apache Airflow REST API
|
1326
|
+
# with a high transaction-per-second (TPS) rate, Amazon MWAA will
|
1327
|
+
# increase the number of web servers up to the number set in
|
1328
|
+
# `MaxWebserers`. As TPS rates decrease Amazon MWAA disposes of the
|
1329
|
+
# additional web servers, and scales down to the number set in
|
1330
|
+
# `MinxWebserers`.
|
1331
|
+
#
|
1332
|
+
# Valid values: Accepts between `2` and `5`. Defaults to `2`.
|
1333
|
+
#
|
1275
1334
|
# @return [Types::UpdateEnvironmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1276
1335
|
#
|
1277
1336
|
# * {Types::UpdateEnvironmentOutput#arn #arn} => String
|
@@ -1279,13 +1338,25 @@ module Aws::MWAA
|
|
1279
1338
|
# @example Request syntax with placeholder values
|
1280
1339
|
#
|
1281
1340
|
# resp = client.update_environment({
|
1341
|
+
# name: "EnvironmentName", # required
|
1342
|
+
# execution_role_arn: "IamRoleArn",
|
1343
|
+
# airflow_version: "AirflowVersion",
|
1344
|
+
# source_bucket_arn: "S3BucketArn",
|
1345
|
+
# dag_s3_path: "RelativePath",
|
1346
|
+
# plugins_s3_path: "RelativePath",
|
1347
|
+
# plugins_s3_object_version: "S3ObjectVersion",
|
1348
|
+
# requirements_s3_path: "RelativePath",
|
1349
|
+
# requirements_s3_object_version: "S3ObjectVersion",
|
1350
|
+
# startup_script_s3_path: "RelativePath",
|
1351
|
+
# startup_script_s3_object_version: "S3ObjectVersion",
|
1282
1352
|
# airflow_configuration_options: {
|
1283
1353
|
# "ConfigKey" => "ConfigValue",
|
1284
1354
|
# },
|
1285
|
-
# airflow_version: "AirflowVersion",
|
1286
|
-
# dag_s3_path: "RelativePath",
|
1287
1355
|
# environment_class: "EnvironmentClass",
|
1288
|
-
#
|
1356
|
+
# max_workers: 1,
|
1357
|
+
# network_configuration: {
|
1358
|
+
# security_group_ids: ["SecurityGroupId"], # required
|
1359
|
+
# },
|
1289
1360
|
# logging_configuration: {
|
1290
1361
|
# dag_processing_logs: {
|
1291
1362
|
# enabled: false, # required
|
@@ -1295,35 +1366,25 @@ module Aws::MWAA
|
|
1295
1366
|
# enabled: false, # required
|
1296
1367
|
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
1297
1368
|
# },
|
1298
|
-
#
|
1369
|
+
# webserver_logs: {
|
1299
1370
|
# enabled: false, # required
|
1300
1371
|
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
1301
1372
|
# },
|
1302
|
-
#
|
1373
|
+
# worker_logs: {
|
1303
1374
|
# enabled: false, # required
|
1304
1375
|
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
1305
1376
|
# },
|
1306
|
-
#
|
1377
|
+
# task_logs: {
|
1307
1378
|
# enabled: false, # required
|
1308
1379
|
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
1309
1380
|
# },
|
1310
1381
|
# },
|
1311
|
-
#
|
1382
|
+
# weekly_maintenance_window_start: "WeeklyMaintenanceWindowStart",
|
1383
|
+
# webserver_access_mode: "PRIVATE_ONLY", # accepts PRIVATE_ONLY, PUBLIC_ONLY
|
1312
1384
|
# min_workers: 1,
|
1313
|
-
# name: "EnvironmentName", # required
|
1314
|
-
# network_configuration: {
|
1315
|
-
# security_group_ids: ["SecurityGroupId"], # required
|
1316
|
-
# },
|
1317
|
-
# plugins_s3_object_version: "S3ObjectVersion",
|
1318
|
-
# plugins_s3_path: "RelativePath",
|
1319
|
-
# requirements_s3_object_version: "S3ObjectVersion",
|
1320
|
-
# requirements_s3_path: "RelativePath",
|
1321
1385
|
# schedulers: 1,
|
1322
|
-
#
|
1323
|
-
#
|
1324
|
-
# startup_script_s3_path: "RelativePath",
|
1325
|
-
# webserver_access_mode: "PRIVATE_ONLY", # accepts PRIVATE_ONLY, PUBLIC_ONLY
|
1326
|
-
# weekly_maintenance_window_start: "WeeklyMaintenanceWindowStart",
|
1386
|
+
# min_webservers: 1,
|
1387
|
+
# max_webservers: 1,
|
1327
1388
|
# })
|
1328
1389
|
#
|
1329
1390
|
# @example Response structure
|
@@ -1352,7 +1413,7 @@ module Aws::MWAA
|
|
1352
1413
|
params: params,
|
1353
1414
|
config: config)
|
1354
1415
|
context[:gem_name] = 'aws-sdk-mwaa'
|
1355
|
-
context[:gem_version] = '1.
|
1416
|
+
context[:gem_version] = '1.38.0'
|
1356
1417
|
Seahorse::Client::Request.new(handlers, context)
|
1357
1418
|
end
|
1358
1419
|
|