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