aws-sdk-mwaa 1.37.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 +5 -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 +2 -2
data/lib/aws-sdk-mwaa/types.rb
CHANGED
@@ -68,62 +68,9 @@ module Aws::MWAA
|
|
68
68
|
#
|
69
69
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/get-started.html
|
70
70
|
#
|
71
|
-
# @!attribute [rw]
|
72
|
-
#
|
73
|
-
#
|
74
|
-
# more information, see [Apache Airflow configuration options][1].
|
75
|
-
#
|
76
|
-
#
|
77
|
-
#
|
78
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html
|
79
|
-
# @return [Hash<String,String>]
|
80
|
-
#
|
81
|
-
# @!attribute [rw] airflow_version
|
82
|
-
# The Apache Airflow version for your environment. If no value is
|
83
|
-
# specified, it defaults to the latest version. For more information,
|
84
|
-
# see [Apache Airflow versions on Amazon Managed Workflows for Apache
|
85
|
-
# Airflow (MWAA)][1].
|
86
|
-
#
|
87
|
-
# Valid values: `1.10.12`, `2.0.2`, `2.2.2`, `2.4.3`, `2.5.1`,
|
88
|
-
# `2.6.3`, `2.7.2` `2.8.1`
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
92
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/airflow-versions.html
|
93
|
-
# @return [String]
|
94
|
-
#
|
95
|
-
# @!attribute [rw] dag_s3_path
|
96
|
-
# The relative path to the DAGs folder on your Amazon S3 bucket. For
|
97
|
-
# example, `dags`. For more information, see [Adding or updating
|
98
|
-
# DAGs][1].
|
99
|
-
#
|
100
|
-
#
|
101
|
-
#
|
102
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html
|
103
|
-
# @return [String]
|
104
|
-
#
|
105
|
-
# @!attribute [rw] endpoint_management
|
106
|
-
# Defines whether the VPC endpoints configured for the environment are
|
107
|
-
# created, and managed, by the customer or by Amazon MWAA. If set to
|
108
|
-
# `SERVICE`, Amazon MWAA will create and manage the required VPC
|
109
|
-
# endpoints in your VPC. If set to `CUSTOMER`, you must create, and
|
110
|
-
# manage, the VPC endpoints for your VPC. If you choose to create an
|
111
|
-
# environment in a shared VPC, you must set this value to `CUSTOMER`.
|
112
|
-
# In a shared VPC deployment, the environment will remain in `PENDING`
|
113
|
-
# status until you create the VPC endpoints. If you do not take action
|
114
|
-
# to create the endpoints within 72 hours, the status will change to
|
115
|
-
# `CREATE_FAILED`. You can delete the failed environment and create a
|
116
|
-
# new one.
|
117
|
-
# @return [String]
|
118
|
-
#
|
119
|
-
# @!attribute [rw] environment_class
|
120
|
-
# The environment class type. Valid values: `mw1.small`, `mw1.medium`,
|
121
|
-
# `mw1.large`. For more information, see [Amazon MWAA environment
|
122
|
-
# class][1].
|
123
|
-
#
|
124
|
-
#
|
125
|
-
#
|
126
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html
|
71
|
+
# @!attribute [rw] name
|
72
|
+
# The name of the Amazon MWAA environment. For example,
|
73
|
+
# `MyMWAAEnvironment`.
|
127
74
|
# @return [String]
|
128
75
|
#
|
129
76
|
# @!attribute [rw] execution_role_arn
|
@@ -140,43 +87,25 @@ module Aws::MWAA
|
|
140
87
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html
|
141
88
|
# @return [String]
|
142
89
|
#
|
143
|
-
# @!attribute [rw]
|
144
|
-
# The Amazon
|
145
|
-
#
|
146
|
-
#
|
147
|
-
#
|
90
|
+
# @!attribute [rw] source_bucket_arn
|
91
|
+
# The Amazon Resource Name (ARN) of the Amazon S3 bucket where your
|
92
|
+
# DAG code and supporting files are stored. For example,
|
93
|
+
# `arn:aws:s3:::my-airflow-bucket-unique-name`. For more information,
|
94
|
+
# see [Create an Amazon S3 bucket for Amazon MWAA][1].
|
148
95
|
#
|
149
96
|
#
|
150
97
|
#
|
151
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
98
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html
|
152
99
|
# @return [String]
|
153
100
|
#
|
154
|
-
# @!attribute [rw]
|
155
|
-
#
|
156
|
-
#
|
101
|
+
# @!attribute [rw] dag_s3_path
|
102
|
+
# The relative path to the DAGs folder on your Amazon S3 bucket. For
|
103
|
+
# example, `dags`. For more information, see [Adding or updating
|
104
|
+
# DAGs][1].
|
157
105
|
#
|
158
|
-
# @!attribute [rw] max_workers
|
159
|
-
# The maximum number of workers that you want to run in your
|
160
|
-
# environment. MWAA scales the number of Apache Airflow workers up to
|
161
|
-
# the number you specify in the `MaxWorkers` field. For example, `20`.
|
162
|
-
# When there are no more tasks running, and no more in the queue, MWAA
|
163
|
-
# disposes of the extra workers leaving the one worker that is
|
164
|
-
# included with your environment, or the number you specify in
|
165
|
-
# `MinWorkers`.
|
166
|
-
# @return [Integer]
|
167
106
|
#
|
168
|
-
# @!attribute [rw] min_workers
|
169
|
-
# The minimum number of workers that you want to run in your
|
170
|
-
# environment. MWAA scales the number of Apache Airflow workers up to
|
171
|
-
# the number you specify in the `MaxWorkers` field. When there are no
|
172
|
-
# more tasks running, and no more in the queue, MWAA disposes of the
|
173
|
-
# extra workers leaving the worker count you specify in the
|
174
|
-
# `MinWorkers` field. For example, `2`.
|
175
|
-
# @return [Integer]
|
176
107
|
#
|
177
|
-
#
|
178
|
-
# The name of the Amazon MWAA environment. For example,
|
179
|
-
# `MyMWAAEnvironment`.
|
108
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html
|
180
109
|
# @return [String]
|
181
110
|
#
|
182
111
|
# @!attribute [rw] network_configuration
|
@@ -190,16 +119,6 @@ module Aws::MWAA
|
|
190
119
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html
|
191
120
|
# @return [Types::NetworkConfiguration]
|
192
121
|
#
|
193
|
-
# @!attribute [rw] plugins_s3_object_version
|
194
|
-
# The version of the plugins.zip file on your Amazon S3 bucket. You
|
195
|
-
# must specify a version each time a plugins.zip file is updated. For
|
196
|
-
# more information, see [How S3 Versioning works][1].
|
197
|
-
#
|
198
|
-
#
|
199
|
-
#
|
200
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html
|
201
|
-
# @return [String]
|
202
|
-
#
|
203
122
|
# @!attribute [rw] plugins_s3_path
|
204
123
|
# The relative path to the `plugins.zip` file on your Amazon S3
|
205
124
|
# bucket. For example, `plugins.zip`. If specified, then the
|
@@ -211,10 +130,10 @@ module Aws::MWAA
|
|
211
130
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html
|
212
131
|
# @return [String]
|
213
132
|
#
|
214
|
-
# @!attribute [rw]
|
215
|
-
# The version of the
|
216
|
-
#
|
217
|
-
#
|
133
|
+
# @!attribute [rw] plugins_s3_object_version
|
134
|
+
# The version of the plugins.zip file on your Amazon S3 bucket. You
|
135
|
+
# must specify a version each time a plugins.zip file is updated. For
|
136
|
+
# more information, see [How S3 Versioning works][1].
|
218
137
|
#
|
219
138
|
#
|
220
139
|
#
|
@@ -232,24 +151,29 @@ module Aws::MWAA
|
|
232
151
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html
|
233
152
|
# @return [String]
|
234
153
|
#
|
235
|
-
# @!attribute [rw]
|
236
|
-
# The
|
237
|
-
#
|
154
|
+
# @!attribute [rw] requirements_s3_object_version
|
155
|
+
# The version of the `requirements.txt` file on your Amazon S3 bucket.
|
156
|
+
# You must specify a version each time a requirements.txt file is
|
157
|
+
# updated. For more information, see [How S3 Versioning works][1].
|
238
158
|
#
|
239
|
-
# * v2 - Accepts between 2 to 5. Defaults to 2.
|
240
159
|
#
|
241
|
-
# * v1 - Accepts 1.
|
242
|
-
# @return [Integer]
|
243
160
|
#
|
244
|
-
#
|
245
|
-
#
|
246
|
-
# DAG code and supporting files are stored. For example,
|
247
|
-
# `arn:aws:s3:::my-airflow-bucket-unique-name`. For more information,
|
248
|
-
# see [Create an Amazon S3 bucket for Amazon MWAA][1].
|
161
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html
|
162
|
+
# @return [String]
|
249
163
|
#
|
164
|
+
# @!attribute [rw] startup_script_s3_path
|
165
|
+
# The relative path to the startup shell script in your Amazon S3
|
166
|
+
# bucket. For example, `s3://mwaa-environment/startup.sh`.
|
250
167
|
#
|
168
|
+
# Amazon MWAA runs the script as your environment starts, and before
|
169
|
+
# running the Apache Airflow process. You can use this script to
|
170
|
+
# install dependencies, modify Apache Airflow configuration options,
|
171
|
+
# and set environment variables. For more information, see [Using a
|
172
|
+
# startup script][1].
|
251
173
|
#
|
252
|
-
#
|
174
|
+
#
|
175
|
+
#
|
176
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html
|
253
177
|
# @return [String]
|
254
178
|
#
|
255
179
|
# @!attribute [rw] startup_script_s3_object_version
|
@@ -270,19 +194,71 @@ module Aws::MWAA
|
|
270
194
|
# [2]: https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html
|
271
195
|
# @return [String]
|
272
196
|
#
|
273
|
-
# @!attribute [rw]
|
274
|
-
#
|
275
|
-
#
|
197
|
+
# @!attribute [rw] airflow_configuration_options
|
198
|
+
# A list of key-value pairs containing the Apache Airflow
|
199
|
+
# configuration options you want to attach to your environment. For
|
200
|
+
# more information, see [Apache Airflow configuration options][1].
|
276
201
|
#
|
277
|
-
# Amazon MWAA runs the script as your environment starts, and before
|
278
|
-
# running the Apache Airflow process. You can use this script to
|
279
|
-
# install dependencies, modify Apache Airflow configuration options,
|
280
|
-
# and set environment variables. For more information, see [Using a
|
281
|
-
# startup script][1].
|
282
202
|
#
|
283
203
|
#
|
204
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html
|
205
|
+
# @return [Hash<String,String>]
|
284
206
|
#
|
285
|
-
#
|
207
|
+
# @!attribute [rw] environment_class
|
208
|
+
# The environment class type. Valid values: `mw1.small`, `mw1.medium`,
|
209
|
+
# `mw1.large`, `mw1.xlarge`, and `mw1.2xlarge`. For more information,
|
210
|
+
# see [Amazon MWAA environment class][1].
|
211
|
+
#
|
212
|
+
#
|
213
|
+
#
|
214
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html
|
215
|
+
# @return [String]
|
216
|
+
#
|
217
|
+
# @!attribute [rw] max_workers
|
218
|
+
# The maximum number of workers that you want to run in your
|
219
|
+
# environment. MWAA scales the number of Apache Airflow workers up to
|
220
|
+
# the number you specify in the `MaxWorkers` field. For example, `20`.
|
221
|
+
# When there are no more tasks running, and no more in the queue, MWAA
|
222
|
+
# disposes of the extra workers leaving the one worker that is
|
223
|
+
# included with your environment, or the number you specify in
|
224
|
+
# `MinWorkers`.
|
225
|
+
# @return [Integer]
|
226
|
+
#
|
227
|
+
# @!attribute [rw] kms_key
|
228
|
+
# The Amazon Web Services Key Management Service (KMS) key to encrypt
|
229
|
+
# the data in your environment. You can use an Amazon Web Services
|
230
|
+
# owned CMK, or a Customer managed CMK (advanced). For more
|
231
|
+
# information, see [Create an Amazon MWAA environment][1].
|
232
|
+
#
|
233
|
+
#
|
234
|
+
#
|
235
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/create-environment.html
|
236
|
+
# @return [String]
|
237
|
+
#
|
238
|
+
# @!attribute [rw] airflow_version
|
239
|
+
# The Apache Airflow version for your environment. If no value is
|
240
|
+
# specified, it defaults to the latest version. For more information,
|
241
|
+
# see [Apache Airflow versions on Amazon Managed Workflows for Apache
|
242
|
+
# Airflow (MWAA)][1].
|
243
|
+
#
|
244
|
+
# Valid values: `1.10.12`, `2.0.2`, `2.2.2`, `2.4.3`, `2.5.1`,
|
245
|
+
# `2.6.3`, `2.7.2` `2.8.1`
|
246
|
+
#
|
247
|
+
#
|
248
|
+
#
|
249
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/airflow-versions.html
|
250
|
+
# @return [String]
|
251
|
+
#
|
252
|
+
# @!attribute [rw] logging_configuration
|
253
|
+
# Defines the Apache Airflow logs to send to CloudWatch Logs.
|
254
|
+
# @return [Types::LoggingConfigurationInput]
|
255
|
+
#
|
256
|
+
# @!attribute [rw] weekly_maintenance_window_start
|
257
|
+
# The day and time of the week in Coordinated Universal Time (UTC)
|
258
|
+
# 24-hour standard time to start weekly maintenance updates of your
|
259
|
+
# environment in the following format: `DAY:HH:MM`. For example:
|
260
|
+
# `TUE:03:30`. You can specify a start time in 30 minute increments
|
261
|
+
# only.
|
286
262
|
# @return [String]
|
287
263
|
#
|
288
264
|
# @!attribute [rw] tags
|
@@ -304,40 +280,95 @@ module Aws::MWAA
|
|
304
280
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html
|
305
281
|
# @return [String]
|
306
282
|
#
|
307
|
-
# @!attribute [rw]
|
308
|
-
# The
|
309
|
-
#
|
310
|
-
#
|
311
|
-
#
|
312
|
-
#
|
283
|
+
# @!attribute [rw] min_workers
|
284
|
+
# The minimum number of workers that you want to run in your
|
285
|
+
# environment. MWAA scales the number of Apache Airflow workers up to
|
286
|
+
# the number you specify in the `MaxWorkers` field. When there are no
|
287
|
+
# more tasks running, and no more in the queue, MWAA disposes of the
|
288
|
+
# extra workers leaving the worker count you specify in the
|
289
|
+
# `MinWorkers` field. For example, `2`.
|
290
|
+
# @return [Integer]
|
291
|
+
#
|
292
|
+
# @!attribute [rw] schedulers
|
293
|
+
# The number of Apache Airflow schedulers to run in your environment.
|
294
|
+
# Valid values:
|
295
|
+
#
|
296
|
+
# * v2 - Accepts between `2` to `5`. Defaults to `2`.
|
297
|
+
#
|
298
|
+
# * v1 - Accepts `1`.
|
299
|
+
# @return [Integer]
|
300
|
+
#
|
301
|
+
# @!attribute [rw] endpoint_management
|
302
|
+
# Defines whether the VPC endpoints configured for the environment are
|
303
|
+
# created, and managed, by the customer or by Amazon MWAA. If set to
|
304
|
+
# `SERVICE`, Amazon MWAA will create and manage the required VPC
|
305
|
+
# endpoints in your VPC. If set to `CUSTOMER`, you must create, and
|
306
|
+
# manage, the VPC endpoints for your VPC. If you choose to create an
|
307
|
+
# environment in a shared VPC, you must set this value to `CUSTOMER`.
|
308
|
+
# In a shared VPC deployment, the environment will remain in `PENDING`
|
309
|
+
# status until you create the VPC endpoints. If you do not take action
|
310
|
+
# to create the endpoints within 72 hours, the status will change to
|
311
|
+
# `CREATE_FAILED`. You can delete the failed environment and create a
|
312
|
+
# new one.
|
313
313
|
# @return [String]
|
314
314
|
#
|
315
|
+
# @!attribute [rw] min_webservers
|
316
|
+
# The minimum number of web servers that you want to run in your
|
317
|
+
# environment. Amazon MWAA scales the number of Apache Airflow web
|
318
|
+
# servers up to the number you specify for `MaxWebservers` when you
|
319
|
+
# interact with your Apache Airflow environment using Apache Airflow
|
320
|
+
# REST API, or the Apache Airflow CLI. As the transaction-per-second
|
321
|
+
# rate, and the network load, decrease, Amazon MWAA disposes of the
|
322
|
+
# additional web servers, and scales down to the number set in
|
323
|
+
# `MinxWebserers`.
|
324
|
+
#
|
325
|
+
# Valid values: Accepts between `2` and `5`. Defaults to `2`.
|
326
|
+
# @return [Integer]
|
327
|
+
#
|
328
|
+
# @!attribute [rw] max_webservers
|
329
|
+
# The maximum number of web servers that you want to run in your
|
330
|
+
# environment. Amazon MWAA scales the number of Apache Airflow web
|
331
|
+
# servers up to the number you specify for `MaxWebservers` when you
|
332
|
+
# interact with your Apache Airflow environment using Apache Airflow
|
333
|
+
# REST API, or the Apache Airflow CLI. For example, in scenarios where
|
334
|
+
# your workload requires network calls to the Apache Airflow REST API
|
335
|
+
# with a high transaction-per-second (TPS) rate, Amazon MWAA will
|
336
|
+
# increase the number of web servers up to the number set in
|
337
|
+
# `MaxWebserers`. As TPS rates decrease Amazon MWAA disposes of the
|
338
|
+
# additional web servers, and scales down to the number set in
|
339
|
+
# `MinxWebserers`.
|
340
|
+
#
|
341
|
+
# Valid values: Accepts between `2` and `5`. Defaults to `2`.
|
342
|
+
# @return [Integer]
|
343
|
+
#
|
315
344
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/CreateEnvironmentInput AWS API Documentation
|
316
345
|
#
|
317
346
|
class CreateEnvironmentInput < Struct.new(
|
318
|
-
:airflow_configuration_options,
|
319
|
-
:airflow_version,
|
320
|
-
:dag_s3_path,
|
321
|
-
:endpoint_management,
|
322
|
-
:environment_class,
|
323
|
-
:execution_role_arn,
|
324
|
-
:kms_key,
|
325
|
-
:logging_configuration,
|
326
|
-
:max_workers,
|
327
|
-
:min_workers,
|
328
347
|
:name,
|
348
|
+
:execution_role_arn,
|
349
|
+
:source_bucket_arn,
|
350
|
+
:dag_s3_path,
|
329
351
|
:network_configuration,
|
330
|
-
:plugins_s3_object_version,
|
331
352
|
:plugins_s3_path,
|
332
|
-
:
|
333
|
-
:requirements_s3_path,
|
334
|
-
:
|
335
|
-
:source_bucket_arn,
|
336
|
-
:startup_script_s3_object_version,
|
353
|
+
:plugins_s3_object_version,
|
354
|
+
:requirements_s3_path,
|
355
|
+
:requirements_s3_object_version,
|
337
356
|
:startup_script_s3_path,
|
357
|
+
:startup_script_s3_object_version,
|
358
|
+
:airflow_configuration_options,
|
359
|
+
:environment_class,
|
360
|
+
:max_workers,
|
361
|
+
:kms_key,
|
362
|
+
:airflow_version,
|
363
|
+
:logging_configuration,
|
364
|
+
:weekly_maintenance_window_start,
|
338
365
|
:tags,
|
339
366
|
:webserver_access_mode,
|
340
|
-
:
|
367
|
+
:min_workers,
|
368
|
+
:schedulers,
|
369
|
+
:endpoint_management,
|
370
|
+
:min_webservers,
|
371
|
+
:max_webservers)
|
341
372
|
SENSITIVE = [:airflow_configuration_options]
|
342
373
|
include Aws::Structure
|
343
374
|
end
|
@@ -368,9 +399,12 @@ module Aws::MWAA
|
|
368
399
|
include Aws::Structure
|
369
400
|
end
|
370
401
|
|
371
|
-
# @!attribute [rw]
|
372
|
-
#
|
373
|
-
#
|
402
|
+
# @!attribute [rw] web_token
|
403
|
+
# An Airflow web server login token.
|
404
|
+
# @return [String]
|
405
|
+
#
|
406
|
+
# @!attribute [rw] web_server_hostname
|
407
|
+
# The Airflow web server hostname for the environment.
|
374
408
|
# @return [String]
|
375
409
|
#
|
376
410
|
# @!attribute [rw] iam_identity
|
@@ -379,21 +413,18 @@ module Aws::MWAA
|
|
379
413
|
# example, `assumed-role/Admin/your-name`.
|
380
414
|
# @return [String]
|
381
415
|
#
|
382
|
-
# @!attribute [rw]
|
383
|
-
# The
|
384
|
-
#
|
385
|
-
#
|
386
|
-
# @!attribute [rw] web_token
|
387
|
-
# An Airflow web server login token.
|
416
|
+
# @!attribute [rw] airflow_identity
|
417
|
+
# The user name of the Apache Airflow identity creating the web login
|
418
|
+
# token.
|
388
419
|
# @return [String]
|
389
420
|
#
|
390
421
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/CreateWebLoginTokenResponse AWS API Documentation
|
391
422
|
#
|
392
423
|
class CreateWebLoginTokenResponse < Struct.new(
|
393
|
-
:
|
394
|
-
:iam_identity,
|
424
|
+
:web_token,
|
395
425
|
:web_server_hostname,
|
396
|
-
:
|
426
|
+
:iam_identity,
|
427
|
+
:airflow_identity)
|
397
428
|
SENSITIVE = [:web_token]
|
398
429
|
include Aws::Structure
|
399
430
|
end
|
@@ -443,72 +474,90 @@ module Aws::MWAA
|
|
443
474
|
# Describes an Amazon Managed Workflows for Apache Airflow (MWAA)
|
444
475
|
# environment.
|
445
476
|
#
|
446
|
-
# @!attribute [rw]
|
447
|
-
#
|
448
|
-
#
|
449
|
-
#
|
477
|
+
# @!attribute [rw] name
|
478
|
+
# The name of the Amazon MWAA environment. For example,
|
479
|
+
# `MyMWAAEnvironment`.
|
480
|
+
# @return [String]
|
450
481
|
#
|
482
|
+
# @!attribute [rw] status
|
483
|
+
# The status of the Amazon MWAA environment.
|
451
484
|
#
|
485
|
+
# Valid values:
|
452
486
|
#
|
453
|
-
#
|
454
|
-
#
|
487
|
+
# * `CREATING` - Indicates the request to create the environment is in
|
488
|
+
# progress.
|
455
489
|
#
|
456
|
-
#
|
457
|
-
#
|
490
|
+
# * `CREATING_SNAPSHOT` - Indicates the request to update environment
|
491
|
+
# details, or upgrade the environment version, is in progress and
|
492
|
+
# Amazon MWAA is creating a storage volume snapshot of the Amazon
|
493
|
+
# RDS database cluster associated with the environment. A database
|
494
|
+
# snapshot is a backup created at a specific point in time. Amazon
|
495
|
+
# MWAA uses snapshots to recover environment metadata if the process
|
496
|
+
# to update or upgrade an environment fails.
|
458
497
|
#
|
459
|
-
#
|
460
|
-
#
|
461
|
-
# @return [String]
|
498
|
+
# * `CREATE_FAILED` - Indicates the request to create the environment
|
499
|
+
# failed, and the environment could not be created.
|
462
500
|
#
|
463
|
-
#
|
464
|
-
#
|
465
|
-
# @return [String]
|
501
|
+
# * `AVAILABLE` - Indicates the request was successful and the
|
502
|
+
# environment is ready to use.
|
466
503
|
#
|
467
|
-
#
|
468
|
-
#
|
469
|
-
#
|
470
|
-
#
|
471
|
-
#
|
504
|
+
# * `PENDING` - Indicates the request was successful, but the process
|
505
|
+
# to create the environment is paused until you create the required
|
506
|
+
# VPC endpoints in your VPC. After you create the VPC endpoints, the
|
507
|
+
# process resumes.
|
508
|
+
#
|
509
|
+
# * `UPDATING` - Indicates the request to update the environment is in
|
510
|
+
# progress.
|
472
511
|
#
|
512
|
+
# * `ROLLING_BACK` - Indicates the request to update environment
|
513
|
+
# details, or upgrade the environment version, failed and Amazon
|
514
|
+
# MWAA is restoring the environment using the latest storage volume
|
515
|
+
# snapshot.
|
473
516
|
#
|
517
|
+
# * `DELETING` - Indicates the request to delete the environment is in
|
518
|
+
# progress.
|
474
519
|
#
|
475
|
-
#
|
476
|
-
#
|
520
|
+
# * `DELETED` - Indicates the request to delete the environment is
|
521
|
+
# complete, and the environment has been deleted.
|
477
522
|
#
|
478
|
-
#
|
479
|
-
#
|
480
|
-
# @return [Time]
|
523
|
+
# * `UNAVAILABLE` - Indicates the request failed, but the environment
|
524
|
+
# did not return to its previous state and is not stable.
|
481
525
|
#
|
482
|
-
#
|
483
|
-
#
|
484
|
-
#
|
485
|
-
#
|
526
|
+
# * `UPDATE_FAILED` - Indicates the request to update the environment
|
527
|
+
# failed, and the environment was restored to its previous state
|
528
|
+
# successfully and is ready to use.
|
529
|
+
#
|
530
|
+
# * `MAINTENANCE` - Indicates that the environment is undergoing
|
531
|
+
# maintenance. Depending on the type of work Amazon MWAA is
|
532
|
+
# performing, your environment might become unavailable during this
|
533
|
+
# process. After all operations are done, your environment will
|
534
|
+
# return to its status prior to mainteneace operations.
|
486
535
|
#
|
536
|
+
# We recommend reviewing our troubleshooting guide for a list of
|
537
|
+
# common errors and their solutions. For more information, see [Amazon
|
538
|
+
# MWAA troubleshooting][1].
|
487
539
|
#
|
488
540
|
#
|
489
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html
|
490
|
-
# @return [String]
|
491
541
|
#
|
492
|
-
#
|
493
|
-
# The VPC endpoint for the environment's Amazon RDS database.
|
542
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/troubleshooting.html
|
494
543
|
# @return [String]
|
495
544
|
#
|
496
|
-
# @!attribute [rw]
|
497
|
-
#
|
498
|
-
# created, and managed, by the customer or by Amazon MWAA. If set to
|
499
|
-
# `SERVICE`, Amazon MWAA will create and manage the required VPC
|
500
|
-
# endpoints in your VPC. If set to `CUSTOMER`, you must create, and
|
501
|
-
# manage, the VPC endpoints in your VPC.
|
545
|
+
# @!attribute [rw] arn
|
546
|
+
# The Amazon Resource Name (ARN) of the Amazon MWAA environment.
|
502
547
|
# @return [String]
|
503
548
|
#
|
504
|
-
# @!attribute [rw]
|
505
|
-
# The
|
506
|
-
#
|
507
|
-
#
|
549
|
+
# @!attribute [rw] created_at
|
550
|
+
# The day and time the environment was created.
|
551
|
+
# @return [Time]
|
552
|
+
#
|
553
|
+
# @!attribute [rw] webserver_url
|
554
|
+
# The Apache Airflow *web server* host name for the Amazon MWAA
|
555
|
+
# environment. For more information, see [Accessing the Apache Airflow
|
556
|
+
# UI][1].
|
508
557
|
#
|
509
558
|
#
|
510
559
|
#
|
511
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
560
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/access-airflow-ui.html
|
512
561
|
# @return [String]
|
513
562
|
#
|
514
563
|
# @!attribute [rw] execution_role_arn
|
@@ -523,59 +572,46 @@ module Aws::MWAA
|
|
523
572
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html
|
524
573
|
# @return [String]
|
525
574
|
#
|
526
|
-
# @!attribute [rw]
|
527
|
-
# The
|
528
|
-
#
|
529
|
-
#
|
530
|
-
# @!attribute [rw] last_update
|
531
|
-
# The status of the last update on the environment.
|
532
|
-
# @return [Types::LastUpdate]
|
533
|
-
#
|
534
|
-
# @!attribute [rw] logging_configuration
|
535
|
-
# The Apache Airflow logs published to CloudWatch Logs.
|
536
|
-
# @return [Types::LoggingConfiguration]
|
575
|
+
# @!attribute [rw] service_role_arn
|
576
|
+
# The Amazon Resource Name (ARN) for the service-linked role of the
|
577
|
+
# environment. For more information, see [Amazon MWAA Service-linked
|
578
|
+
# role][1].
|
537
579
|
#
|
538
|
-
# @!attribute [rw] max_workers
|
539
|
-
# The maximum number of workers that run in your environment. For
|
540
|
-
# example, `20`.
|
541
|
-
# @return [Integer]
|
542
580
|
#
|
543
|
-
# @!attribute [rw] min_workers
|
544
|
-
# The minimum number of workers that run in your environment. For
|
545
|
-
# example, `2`.
|
546
|
-
# @return [Integer]
|
547
581
|
#
|
548
|
-
#
|
549
|
-
# The name of the Amazon MWAA environment. For example,
|
550
|
-
# `MyMWAAEnvironment`.
|
582
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-slr.html
|
551
583
|
# @return [String]
|
552
584
|
#
|
553
|
-
# @!attribute [rw]
|
554
|
-
#
|
555
|
-
#
|
556
|
-
# environment. For more information, see [About networking on Amazon
|
557
|
-
# MWAA][1].
|
585
|
+
# @!attribute [rw] kms_key
|
586
|
+
# The KMS encryption key used to encrypt the data in your environment.
|
587
|
+
# @return [String]
|
558
588
|
#
|
589
|
+
# @!attribute [rw] airflow_version
|
590
|
+
# The Apache Airflow version on your environment.
|
559
591
|
#
|
592
|
+
# Valid values: `1.10.12`, `2.0.2`, `2.2.2`, `2.4.3`, `2.5.1`,
|
593
|
+
# `2.6.3`, `2.7.2`, `2.8.1`.
|
594
|
+
# @return [String]
|
560
595
|
#
|
561
|
-
#
|
562
|
-
#
|
596
|
+
# @!attribute [rw] source_bucket_arn
|
597
|
+
# The Amazon Resource Name (ARN) of the Amazon S3 bucket where your
|
598
|
+
# DAG code and supporting files are stored. For example,
|
599
|
+
# `arn:aws:s3:::my-airflow-bucket-unique-name`. For more information,
|
600
|
+
# see [Create an Amazon S3 bucket for Amazon MWAA][1].
|
563
601
|
#
|
564
|
-
# @!attribute [rw] plugins_s3_object_version
|
565
|
-
# The version of the `plugins.zip` file in your Amazon S3 bucket. You
|
566
|
-
# must specify the [version ID][1] that Amazon S3 assigns to the file.
|
567
602
|
#
|
568
|
-
# Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings
|
569
|
-
# that are no more than 1,024 bytes long. The following is an example:
|
570
603
|
#
|
571
|
-
#
|
604
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html
|
605
|
+
# @return [String]
|
572
606
|
#
|
573
|
-
#
|
607
|
+
# @!attribute [rw] dag_s3_path
|
608
|
+
# The relative path to the DAGs folder in your Amazon S3 bucket. For
|
609
|
+
# example, `s3://mwaa-environment/dags`. For more information, see
|
610
|
+
# [Adding or updating DAGs][1].
|
574
611
|
#
|
575
612
|
#
|
576
613
|
#
|
577
|
-
# [1]: https://docs.aws.amazon.com/
|
578
|
-
# [2]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html
|
614
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html
|
579
615
|
# @return [String]
|
580
616
|
#
|
581
617
|
# @!attribute [rw] plugins_s3_path
|
@@ -588,22 +624,21 @@ module Aws::MWAA
|
|
588
624
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html
|
589
625
|
# @return [String]
|
590
626
|
#
|
591
|
-
# @!attribute [rw]
|
592
|
-
# The version of the `
|
593
|
-
#
|
594
|
-
# to the file.
|
627
|
+
# @!attribute [rw] plugins_s3_object_version
|
628
|
+
# The version of the `plugins.zip` file in your Amazon S3 bucket. You
|
629
|
+
# must specify the [version ID][1] that Amazon S3 assigns to the file.
|
595
630
|
#
|
596
631
|
# Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings
|
597
632
|
# that are no more than 1,024 bytes long. The following is an example:
|
598
633
|
#
|
599
634
|
# `3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo`
|
600
635
|
#
|
601
|
-
# For more information, see [Installing
|
636
|
+
# For more information, see [Installing custom plugins][2].
|
602
637
|
#
|
603
638
|
#
|
604
639
|
#
|
605
640
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html
|
606
|
-
# [2]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
641
|
+
# [2]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html
|
607
642
|
# @return [String]
|
608
643
|
#
|
609
644
|
# @!attribute [rw] requirements_s3_path
|
@@ -616,48 +651,22 @@ module Aws::MWAA
|
|
616
651
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html
|
617
652
|
# @return [String]
|
618
653
|
#
|
619
|
-
# @!attribute [rw]
|
620
|
-
# The
|
621
|
-
#
|
622
|
-
#
|
623
|
-
#
|
624
|
-
# @!attribute [rw] service_role_arn
|
625
|
-
# The Amazon Resource Name (ARN) for the service-linked role of the
|
626
|
-
# environment. For more information, see [Amazon MWAA Service-linked
|
627
|
-
# role][1].
|
628
|
-
#
|
629
|
-
#
|
630
|
-
#
|
631
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-slr.html
|
632
|
-
# @return [String]
|
633
|
-
#
|
634
|
-
# @!attribute [rw] source_bucket_arn
|
635
|
-
# The Amazon Resource Name (ARN) of the Amazon S3 bucket where your
|
636
|
-
# DAG code and supporting files are stored. For example,
|
637
|
-
# `arn:aws:s3:::my-airflow-bucket-unique-name`. For more information,
|
638
|
-
# see [Create an Amazon S3 bucket for Amazon MWAA][1].
|
639
|
-
#
|
640
|
-
#
|
641
|
-
#
|
642
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html
|
643
|
-
# @return [String]
|
644
|
-
#
|
645
|
-
# @!attribute [rw] startup_script_s3_object_version
|
646
|
-
# The version of the startup shell script in your Amazon S3 bucket.
|
647
|
-
# You must specify the [version ID][1] that Amazon S3 assigns to the
|
648
|
-
# file.
|
654
|
+
# @!attribute [rw] requirements_s3_object_version
|
655
|
+
# The version of the `requirements.txt ` file on your Amazon S3
|
656
|
+
# bucket. You must specify the [version ID][1] that Amazon S3 assigns
|
657
|
+
# to the file.
|
649
658
|
#
|
650
659
|
# Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings
|
651
660
|
# that are no more than 1,024 bytes long. The following is an example:
|
652
661
|
#
|
653
662
|
# `3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo`
|
654
663
|
#
|
655
|
-
# For more information, see [
|
664
|
+
# For more information, see [Installing Python dependencies][2].
|
656
665
|
#
|
657
666
|
#
|
658
667
|
#
|
659
668
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html
|
660
|
-
# [2]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
669
|
+
# [2]: https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html
|
661
670
|
# @return [String]
|
662
671
|
#
|
663
672
|
# @!attribute [rw] startup_script_s3_path
|
@@ -672,70 +681,75 @@ module Aws::MWAA
|
|
672
681
|
#
|
673
682
|
#
|
674
683
|
#
|
675
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html
|
676
|
-
# @return [String]
|
684
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html
|
685
|
+
# @return [String]
|
686
|
+
#
|
687
|
+
# @!attribute [rw] startup_script_s3_object_version
|
688
|
+
# The version of the startup shell script in your Amazon S3 bucket.
|
689
|
+
# You must specify the [version ID][1] that Amazon S3 assigns to the
|
690
|
+
# file.
|
691
|
+
#
|
692
|
+
# Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings
|
693
|
+
# that are no more than 1,024 bytes long. The following is an example:
|
694
|
+
#
|
695
|
+
# `3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo`
|
696
|
+
#
|
697
|
+
# For more information, see [Using a startup script][2].
|
698
|
+
#
|
677
699
|
#
|
678
|
-
# @!attribute [rw] status
|
679
|
-
# The status of the Amazon MWAA environment.
|
680
700
|
#
|
681
|
-
#
|
701
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html
|
702
|
+
# [2]: https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html
|
703
|
+
# @return [String]
|
682
704
|
#
|
683
|
-
#
|
684
|
-
#
|
705
|
+
# @!attribute [rw] airflow_configuration_options
|
706
|
+
# A list of key-value pairs containing the Apache Airflow
|
707
|
+
# configuration options attached to your environment. For more
|
708
|
+
# information, see [Apache Airflow configuration options][1].
|
685
709
|
#
|
686
|
-
# * `CREATING_SNAPSHOT` - Indicates the request to update environment
|
687
|
-
# details, or upgrade the environment version, is in progress and
|
688
|
-
# Amazon MWAA is creating a storage volume snapshot of the Amazon
|
689
|
-
# RDS database cluster associated with the environment. A database
|
690
|
-
# snapshot is a backup created at a specific point in time. Amazon
|
691
|
-
# MWAA uses snapshots to recover environment metadata if the process
|
692
|
-
# to update or upgrade an environment fails.
|
693
710
|
#
|
694
|
-
# * `CREATE_FAILED` - Indicates the request to create the environment
|
695
|
-
# failed, and the environment could not be created.
|
696
711
|
#
|
697
|
-
#
|
698
|
-
#
|
712
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html
|
713
|
+
# @return [Hash<String,String>]
|
699
714
|
#
|
700
|
-
#
|
701
|
-
#
|
702
|
-
#
|
703
|
-
#
|
715
|
+
# @!attribute [rw] environment_class
|
716
|
+
# The environment class type. Valid values: `mw1.small`, `mw1.medium`,
|
717
|
+
# `mw1.large`, `mw1.xlarge`, and `mw1.2xlarge`. For more information,
|
718
|
+
# see [Amazon MWAA environment class][1].
|
704
719
|
#
|
705
|
-
# * `UPDATING` - Indicates the request to update the environment is in
|
706
|
-
# progress.
|
707
720
|
#
|
708
|
-
# * `ROLLING_BACK` - Indicates the request to update environment
|
709
|
-
# details, or upgrade the environment version, failed and Amazon
|
710
|
-
# MWAA is restoring the environment using the latest storage volume
|
711
|
-
# snapshot.
|
712
721
|
#
|
713
|
-
#
|
714
|
-
#
|
722
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html
|
723
|
+
# @return [String]
|
715
724
|
#
|
716
|
-
#
|
717
|
-
#
|
725
|
+
# @!attribute [rw] max_workers
|
726
|
+
# The maximum number of workers that run in your environment. For
|
727
|
+
# example, `20`.
|
728
|
+
# @return [Integer]
|
718
729
|
#
|
719
|
-
#
|
720
|
-
#
|
730
|
+
# @!attribute [rw] network_configuration
|
731
|
+
# Describes the VPC networking components used to secure and enable
|
732
|
+
# network traffic between the Amazon Web Services resources for your
|
733
|
+
# environment. For more information, see [About networking on Amazon
|
734
|
+
# MWAA][1].
|
721
735
|
#
|
722
|
-
# * `UPDATE_FAILED` - Indicates the request to update the environment
|
723
|
-
# failed, and the environment was restored to its previous state
|
724
|
-
# successfully and is ready to use.
|
725
736
|
#
|
726
|
-
# * `MAINTENANCE` - Indicates that the environment is undergoing
|
727
|
-
# maintenance. Depending on the type of work Amazon MWAA is
|
728
|
-
# performing, your environment might become unavailable during this
|
729
|
-
# process. After all operations are done, your environment will
|
730
|
-
# return to its status prior to mainteneace operations.
|
731
737
|
#
|
732
|
-
#
|
733
|
-
#
|
734
|
-
# MWAA troubleshooting][1].
|
738
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html
|
739
|
+
# @return [Types::NetworkConfiguration]
|
735
740
|
#
|
741
|
+
# @!attribute [rw] logging_configuration
|
742
|
+
# The Apache Airflow logs published to CloudWatch Logs.
|
743
|
+
# @return [Types::LoggingConfiguration]
|
736
744
|
#
|
745
|
+
# @!attribute [rw] last_update
|
746
|
+
# The status of the last update on the environment.
|
747
|
+
# @return [Types::LastUpdate]
|
737
748
|
#
|
738
|
-
#
|
749
|
+
# @!attribute [rw] weekly_maintenance_window_start
|
750
|
+
# The day and time of the week in Coordinated Universal Time (UTC)
|
751
|
+
# 24-hour standard time that weekly maintenance updates are scheduled.
|
752
|
+
# For example: `TUE:03:30`.
|
739
753
|
# @return [String]
|
740
754
|
#
|
741
755
|
# @!attribute [rw] tags
|
@@ -757,61 +771,109 @@ module Aws::MWAA
|
|
757
771
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html
|
758
772
|
# @return [String]
|
759
773
|
#
|
760
|
-
# @!attribute [rw]
|
761
|
-
# The
|
762
|
-
#
|
763
|
-
#
|
774
|
+
# @!attribute [rw] min_workers
|
775
|
+
# The minimum number of workers that run in your environment. For
|
776
|
+
# example, `2`.
|
777
|
+
# @return [Integer]
|
764
778
|
#
|
779
|
+
# @!attribute [rw] schedulers
|
780
|
+
# The number of Apache Airflow schedulers that run in your Amazon MWAA
|
781
|
+
# environment.
|
782
|
+
# @return [Integer]
|
765
783
|
#
|
784
|
+
# @!attribute [rw] webserver_vpc_endpoint_service
|
785
|
+
# The VPC endpoint for the environment's web server.
|
786
|
+
# @return [String]
|
766
787
|
#
|
767
|
-
#
|
788
|
+
# @!attribute [rw] database_vpc_endpoint_service
|
789
|
+
# The VPC endpoint for the environment's Amazon RDS database.
|
768
790
|
# @return [String]
|
769
791
|
#
|
770
|
-
# @!attribute [rw]
|
771
|
-
# The
|
792
|
+
# @!attribute [rw] celery_executor_queue
|
793
|
+
# The queue ARN for the environment's [Celery Executor][1]. Amazon
|
794
|
+
# MWAA uses a Celery Executor to distribute tasks across multiple
|
795
|
+
# workers. When you create an environment in a shared VPC, you must
|
796
|
+
# provide access to the Celery Executor queue from your VPC.
|
797
|
+
#
|
798
|
+
#
|
799
|
+
#
|
800
|
+
# [1]: https://airflow.apache.org/docs/apache-airflow/stable/core-concepts/executor/celery.html
|
772
801
|
# @return [String]
|
773
802
|
#
|
774
|
-
# @!attribute [rw]
|
775
|
-
#
|
776
|
-
#
|
777
|
-
#
|
803
|
+
# @!attribute [rw] endpoint_management
|
804
|
+
# Defines whether the VPC endpoints configured for the environment are
|
805
|
+
# created, and managed, by the customer or by Amazon MWAA. If set to
|
806
|
+
# `SERVICE`, Amazon MWAA will create and manage the required VPC
|
807
|
+
# endpoints in your VPC. If set to `CUSTOMER`, you must create, and
|
808
|
+
# manage, the VPC endpoints in your VPC.
|
778
809
|
# @return [String]
|
779
810
|
#
|
811
|
+
# @!attribute [rw] min_webservers
|
812
|
+
# The minimum number of web servers that you want to run in your
|
813
|
+
# environment. Amazon MWAA scales the number of Apache Airflow web
|
814
|
+
# servers up to the number you specify for `MaxWebservers` when you
|
815
|
+
# interact with your Apache Airflow environment using Apache Airflow
|
816
|
+
# REST API, or the Apache Airflow CLI. As the transaction-per-second
|
817
|
+
# rate, and the network load, decrease, Amazon MWAA disposes of the
|
818
|
+
# additional web servers, and scales down to the number set in
|
819
|
+
# `MinxWebserers`.
|
820
|
+
#
|
821
|
+
# Valid values: Accepts between `2` and `5`. Defaults to `2`.
|
822
|
+
# @return [Integer]
|
823
|
+
#
|
824
|
+
# @!attribute [rw] max_webservers
|
825
|
+
# The maximum number of web servers that you want to run in your
|
826
|
+
# environment. Amazon MWAA scales the number of Apache Airflow web
|
827
|
+
# servers up to the number you specify for `MaxWebservers` when you
|
828
|
+
# interact with your Apache Airflow environment using Apache Airflow
|
829
|
+
# REST API, or the Apache Airflow CLI. For example, in scenarios where
|
830
|
+
# your workload requires network calls to the Apache Airflow REST API
|
831
|
+
# with a high transaction-per-second (TPS) rate, Amazon MWAA will
|
832
|
+
# increase the number of web servers up to the number set in
|
833
|
+
# `MaxWebserers`. As TPS rates decrease Amazon MWAA disposes of the
|
834
|
+
# additional web servers, and scales down to the number set in
|
835
|
+
# `MinxWebserers`.
|
836
|
+
#
|
837
|
+
# Valid values: Accepts between `2` and `5`. Defaults to `2`.
|
838
|
+
# @return [Integer]
|
839
|
+
#
|
780
840
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/Environment AWS API Documentation
|
781
841
|
#
|
782
842
|
class Environment < Struct.new(
|
783
|
-
:
|
784
|
-
:
|
843
|
+
:name,
|
844
|
+
:status,
|
785
845
|
:arn,
|
786
|
-
:celery_executor_queue,
|
787
846
|
:created_at,
|
788
|
-
:
|
789
|
-
:database_vpc_endpoint_service,
|
790
|
-
:endpoint_management,
|
791
|
-
:environment_class,
|
847
|
+
:webserver_url,
|
792
848
|
:execution_role_arn,
|
849
|
+
:service_role_arn,
|
793
850
|
:kms_key,
|
794
|
-
:
|
795
|
-
:
|
796
|
-
:
|
797
|
-
:min_workers,
|
798
|
-
:name,
|
799
|
-
:network_configuration,
|
800
|
-
:plugins_s3_object_version,
|
851
|
+
:airflow_version,
|
852
|
+
:source_bucket_arn,
|
853
|
+
:dag_s3_path,
|
801
854
|
:plugins_s3_path,
|
802
|
-
:
|
855
|
+
:plugins_s3_object_version,
|
803
856
|
:requirements_s3_path,
|
804
|
-
:
|
805
|
-
:service_role_arn,
|
806
|
-
:source_bucket_arn,
|
807
|
-
:startup_script_s3_object_version,
|
857
|
+
:requirements_s3_object_version,
|
808
858
|
:startup_script_s3_path,
|
809
|
-
:
|
859
|
+
:startup_script_s3_object_version,
|
860
|
+
:airflow_configuration_options,
|
861
|
+
:environment_class,
|
862
|
+
:max_workers,
|
863
|
+
:network_configuration,
|
864
|
+
:logging_configuration,
|
865
|
+
:last_update,
|
866
|
+
:weekly_maintenance_window_start,
|
810
867
|
:tags,
|
811
868
|
:webserver_access_mode,
|
812
|
-
:
|
869
|
+
:min_workers,
|
870
|
+
:schedulers,
|
813
871
|
:webserver_vpc_endpoint_service,
|
814
|
-
:
|
872
|
+
:database_vpc_endpoint_service,
|
873
|
+
:celery_executor_queue,
|
874
|
+
:endpoint_management,
|
875
|
+
:min_webservers,
|
876
|
+
:max_webservers)
|
815
877
|
SENSITIVE = [:airflow_configuration_options]
|
816
878
|
include Aws::Structure
|
817
879
|
end
|
@@ -857,6 +919,10 @@ module Aws::MWAA
|
|
857
919
|
# Describes the status of the last update on the environment, and any
|
858
920
|
# errors that were encountered.
|
859
921
|
#
|
922
|
+
# @!attribute [rw] status
|
923
|
+
# The status of the last update on the environment.
|
924
|
+
# @return [String]
|
925
|
+
#
|
860
926
|
# @!attribute [rw] created_at
|
861
927
|
# The day and time of the last update on the environment.
|
862
928
|
# @return [Time]
|
@@ -871,35 +937,31 @@ module Aws::MWAA
|
|
871
937
|
# processes by Amazon MWAA, such as an environment maintenance update.
|
872
938
|
# @return [String]
|
873
939
|
#
|
874
|
-
# @!attribute [rw] status
|
875
|
-
# The status of the last update on the environment.
|
876
|
-
# @return [String]
|
877
|
-
#
|
878
940
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/LastUpdate AWS API Documentation
|
879
941
|
#
|
880
942
|
class LastUpdate < Struct.new(
|
943
|
+
:status,
|
881
944
|
:created_at,
|
882
945
|
:error,
|
883
|
-
:source
|
884
|
-
:status)
|
946
|
+
:source)
|
885
947
|
SENSITIVE = []
|
886
948
|
include Aws::Structure
|
887
949
|
end
|
888
950
|
|
951
|
+
# @!attribute [rw] next_token
|
952
|
+
# Retrieves the next page of the results.
|
953
|
+
# @return [String]
|
954
|
+
#
|
889
955
|
# @!attribute [rw] max_results
|
890
956
|
# The maximum number of results to retrieve per page. For example, `5`
|
891
957
|
# environments per page.
|
892
958
|
# @return [Integer]
|
893
959
|
#
|
894
|
-
# @!attribute [rw] next_token
|
895
|
-
# Retrieves the next page of the results.
|
896
|
-
# @return [String]
|
897
|
-
#
|
898
960
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/ListEnvironmentsInput AWS API Documentation
|
899
961
|
#
|
900
962
|
class ListEnvironmentsInput < Struct.new(
|
901
|
-
:
|
902
|
-
:
|
963
|
+
:next_token,
|
964
|
+
:max_results)
|
903
965
|
SENSITIVE = []
|
904
966
|
include Aws::Structure
|
905
967
|
end
|
@@ -965,11 +1027,6 @@ module Aws::MWAA
|
|
965
1027
|
# level.
|
966
1028
|
# @return [Types::ModuleLoggingConfiguration]
|
967
1029
|
#
|
968
|
-
# @!attribute [rw] task_logs
|
969
|
-
# The Airflow task logs published to CloudWatch Logs and the log
|
970
|
-
# level.
|
971
|
-
# @return [Types::ModuleLoggingConfiguration]
|
972
|
-
#
|
973
1030
|
# @!attribute [rw] webserver_logs
|
974
1031
|
# The Airflow web server logs published to CloudWatch Logs and the log
|
975
1032
|
# level.
|
@@ -980,14 +1037,19 @@ module Aws::MWAA
|
|
980
1037
|
# level.
|
981
1038
|
# @return [Types::ModuleLoggingConfiguration]
|
982
1039
|
#
|
1040
|
+
# @!attribute [rw] task_logs
|
1041
|
+
# The Airflow task logs published to CloudWatch Logs and the log
|
1042
|
+
# level.
|
1043
|
+
# @return [Types::ModuleLoggingConfiguration]
|
1044
|
+
#
|
983
1045
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/LoggingConfiguration AWS API Documentation
|
984
1046
|
#
|
985
1047
|
class LoggingConfiguration < Struct.new(
|
986
1048
|
:dag_processing_logs,
|
987
1049
|
:scheduler_logs,
|
988
|
-
:task_logs,
|
989
1050
|
:webserver_logs,
|
990
|
-
:worker_logs
|
1051
|
+
:worker_logs,
|
1052
|
+
:task_logs)
|
991
1053
|
SENSITIVE = []
|
992
1054
|
include Aws::Structure
|
993
1055
|
end
|
@@ -1002,10 +1064,6 @@ module Aws::MWAA
|
|
1002
1064
|
# Publishes Airflow scheduler logs to CloudWatch Logs.
|
1003
1065
|
# @return [Types::ModuleLoggingConfigurationInput]
|
1004
1066
|
#
|
1005
|
-
# @!attribute [rw] task_logs
|
1006
|
-
# Publishes Airflow task logs to CloudWatch Logs.
|
1007
|
-
# @return [Types::ModuleLoggingConfigurationInput]
|
1008
|
-
#
|
1009
1067
|
# @!attribute [rw] webserver_logs
|
1010
1068
|
# Publishes Airflow web server logs to CloudWatch Logs.
|
1011
1069
|
# @return [Types::ModuleLoggingConfigurationInput]
|
@@ -1014,14 +1072,18 @@ module Aws::MWAA
|
|
1014
1072
|
# Publishes Airflow worker logs to CloudWatch Logs.
|
1015
1073
|
# @return [Types::ModuleLoggingConfigurationInput]
|
1016
1074
|
#
|
1075
|
+
# @!attribute [rw] task_logs
|
1076
|
+
# Publishes Airflow task logs to CloudWatch Logs.
|
1077
|
+
# @return [Types::ModuleLoggingConfigurationInput]
|
1078
|
+
#
|
1017
1079
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/LoggingConfigurationInput AWS API Documentation
|
1018
1080
|
#
|
1019
1081
|
class LoggingConfigurationInput < Struct.new(
|
1020
1082
|
:dag_processing_logs,
|
1021
1083
|
:scheduler_logs,
|
1022
|
-
:task_logs,
|
1023
1084
|
:webserver_logs,
|
1024
|
-
:worker_logs
|
1085
|
+
:worker_logs,
|
1086
|
+
:task_logs)
|
1025
1087
|
SENSITIVE = []
|
1026
1088
|
include Aws::Structure
|
1027
1089
|
end
|
@@ -1034,39 +1096,39 @@ module Aws::MWAA
|
|
1034
1096
|
#
|
1035
1097
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html
|
1036
1098
|
#
|
1037
|
-
# @!attribute [rw] dimensions
|
1038
|
-
# **Internal only**. The dimensions associated with the metric.
|
1039
|
-
# @return [Array<Types::Dimension>]
|
1040
|
-
#
|
1041
1099
|
# @!attribute [rw] metric_name
|
1042
1100
|
# **Internal only**. The name of the metric.
|
1043
1101
|
# @return [String]
|
1044
1102
|
#
|
1045
|
-
# @!attribute [rw] statistic_values
|
1046
|
-
# **Internal only**. The statistical values for the metric.
|
1047
|
-
# @return [Types::StatisticSet]
|
1048
|
-
#
|
1049
1103
|
# @!attribute [rw] timestamp
|
1050
1104
|
# **Internal only**. The time the metric data was received.
|
1051
1105
|
# @return [Time]
|
1052
1106
|
#
|
1053
|
-
# @!attribute [rw]
|
1054
|
-
# **Internal only**. The
|
1055
|
-
# @return [
|
1107
|
+
# @!attribute [rw] dimensions
|
1108
|
+
# **Internal only**. The dimensions associated with the metric.
|
1109
|
+
# @return [Array<Types::Dimension>]
|
1056
1110
|
#
|
1057
1111
|
# @!attribute [rw] value
|
1058
1112
|
# **Internal only**. The value for the metric.
|
1059
1113
|
# @return [Float]
|
1060
1114
|
#
|
1115
|
+
# @!attribute [rw] unit
|
1116
|
+
# **Internal only**. The unit used to store the metric.
|
1117
|
+
# @return [String]
|
1118
|
+
#
|
1119
|
+
# @!attribute [rw] statistic_values
|
1120
|
+
# **Internal only**. The statistical values for the metric.
|
1121
|
+
# @return [Types::StatisticSet]
|
1122
|
+
#
|
1061
1123
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/MetricDatum AWS API Documentation
|
1062
1124
|
#
|
1063
1125
|
class MetricDatum < Struct.new(
|
1064
|
-
:dimensions,
|
1065
1126
|
:metric_name,
|
1066
|
-
:statistic_values,
|
1067
1127
|
:timestamp,
|
1128
|
+
:dimensions,
|
1129
|
+
:value,
|
1068
1130
|
:unit,
|
1069
|
-
:
|
1131
|
+
:statistic_values)
|
1070
1132
|
SENSITIVE = []
|
1071
1133
|
include Aws::Structure
|
1072
1134
|
end
|
@@ -1074,13 +1136,6 @@ module Aws::MWAA
|
|
1074
1136
|
# Describes the Apache Airflow log details for the log type (e.g.
|
1075
1137
|
# `DagProcessingLogs`).
|
1076
1138
|
#
|
1077
|
-
# @!attribute [rw] cloud_watch_log_group_arn
|
1078
|
-
# The Amazon Resource Name (ARN) for the CloudWatch Logs group where
|
1079
|
-
# the Apache Airflow log type (e.g. `DagProcessingLogs`) is published.
|
1080
|
-
# For example,
|
1081
|
-
# `arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*`.
|
1082
|
-
# @return [String]
|
1083
|
-
#
|
1084
1139
|
# @!attribute [rw] enabled
|
1085
1140
|
# Indicates whether the Apache Airflow log type (e.g.
|
1086
1141
|
# `DagProcessingLogs`) is enabled.
|
@@ -1091,12 +1146,19 @@ module Aws::MWAA
|
|
1091
1146
|
# `DagProcessingLogs`).
|
1092
1147
|
# @return [String]
|
1093
1148
|
#
|
1149
|
+
# @!attribute [rw] cloud_watch_log_group_arn
|
1150
|
+
# The Amazon Resource Name (ARN) for the CloudWatch Logs group where
|
1151
|
+
# the Apache Airflow log type (e.g. `DagProcessingLogs`) is published.
|
1152
|
+
# For example,
|
1153
|
+
# `arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*`.
|
1154
|
+
# @return [String]
|
1155
|
+
#
|
1094
1156
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/ModuleLoggingConfiguration AWS API Documentation
|
1095
1157
|
#
|
1096
1158
|
class ModuleLoggingConfiguration < Struct.new(
|
1097
|
-
:cloud_watch_log_group_arn,
|
1098
1159
|
:enabled,
|
1099
|
-
:log_level
|
1160
|
+
:log_level,
|
1161
|
+
:cloud_watch_log_group_arn)
|
1100
1162
|
SENSITIVE = []
|
1101
1163
|
include Aws::Structure
|
1102
1164
|
end
|
@@ -1132,29 +1194,29 @@ module Aws::MWAA
|
|
1132
1194
|
#
|
1133
1195
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html
|
1134
1196
|
#
|
1135
|
-
# @!attribute [rw]
|
1136
|
-
# A list of
|
1137
|
-
#
|
1197
|
+
# @!attribute [rw] subnet_ids
|
1198
|
+
# A list of subnet IDs. For more information, see [About networking on
|
1199
|
+
# Amazon MWAA][1].
|
1138
1200
|
#
|
1139
1201
|
#
|
1140
1202
|
#
|
1141
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
1203
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html
|
1142
1204
|
# @return [Array<String>]
|
1143
1205
|
#
|
1144
|
-
# @!attribute [rw]
|
1145
|
-
# A list of
|
1146
|
-
# Amazon MWAA][1].
|
1206
|
+
# @!attribute [rw] security_group_ids
|
1207
|
+
# A list of security group IDs. For more information, see [Security in
|
1208
|
+
# your VPC on Amazon MWAA][1].
|
1147
1209
|
#
|
1148
1210
|
#
|
1149
1211
|
#
|
1150
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
1212
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-security.html
|
1151
1213
|
# @return [Array<String>]
|
1152
1214
|
#
|
1153
1215
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/NetworkConfiguration AWS API Documentation
|
1154
1216
|
#
|
1155
1217
|
class NetworkConfiguration < Struct.new(
|
1156
|
-
:
|
1157
|
-
:
|
1218
|
+
:subnet_ids,
|
1219
|
+
:security_group_ids)
|
1158
1220
|
SENSITIVE = []
|
1159
1221
|
include Aws::Structure
|
1160
1222
|
end
|
@@ -1208,14 +1270,6 @@ module Aws::MWAA
|
|
1208
1270
|
#
|
1209
1271
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html
|
1210
1272
|
#
|
1211
|
-
# @!attribute [rw] maximum
|
1212
|
-
# **Internal only**. The maximum value of the sample set.
|
1213
|
-
# @return [Float]
|
1214
|
-
#
|
1215
|
-
# @!attribute [rw] minimum
|
1216
|
-
# **Internal only**. The minimum value of the sample set.
|
1217
|
-
# @return [Float]
|
1218
|
-
#
|
1219
1273
|
# @!attribute [rw] sample_count
|
1220
1274
|
# **Internal only**. The number of samples used for the statistic set.
|
1221
1275
|
# @return [Integer]
|
@@ -1224,13 +1278,21 @@ module Aws::MWAA
|
|
1224
1278
|
# **Internal only**. The sum of values for the sample set.
|
1225
1279
|
# @return [Float]
|
1226
1280
|
#
|
1281
|
+
# @!attribute [rw] minimum
|
1282
|
+
# **Internal only**. The minimum value of the sample set.
|
1283
|
+
# @return [Float]
|
1284
|
+
#
|
1285
|
+
# @!attribute [rw] maximum
|
1286
|
+
# **Internal only**. The maximum value of the sample set.
|
1287
|
+
# @return [Float]
|
1288
|
+
#
|
1227
1289
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/StatisticSet AWS API Documentation
|
1228
1290
|
#
|
1229
1291
|
class StatisticSet < Struct.new(
|
1230
|
-
:maximum,
|
1231
|
-
:minimum,
|
1232
1292
|
:sample_count,
|
1233
|
-
:sum
|
1293
|
+
:sum,
|
1294
|
+
:minimum,
|
1295
|
+
:maximum)
|
1234
1296
|
SENSITIVE = []
|
1235
1297
|
include Aws::Structure
|
1236
1298
|
end
|
@@ -1288,15 +1350,22 @@ module Aws::MWAA
|
|
1288
1350
|
#
|
1289
1351
|
class UntagResourceOutput < Aws::EmptyStructure; end
|
1290
1352
|
|
1291
|
-
# @!attribute [rw]
|
1292
|
-
#
|
1293
|
-
#
|
1294
|
-
#
|
1353
|
+
# @!attribute [rw] name
|
1354
|
+
# The name of your Amazon MWAA environment. For example,
|
1355
|
+
# `MyMWAAEnvironment`.
|
1356
|
+
# @return [String]
|
1295
1357
|
#
|
1358
|
+
# @!attribute [rw] execution_role_arn
|
1359
|
+
# The Amazon Resource Name (ARN) of the execution role in IAM that
|
1360
|
+
# allows MWAA to access Amazon Web Services resources in your
|
1361
|
+
# environment. For example,
|
1362
|
+
# `arn:aws:iam::123456789:role/my-execution-role`. For more
|
1363
|
+
# information, see [Amazon MWAA Execution role][1].
|
1296
1364
|
#
|
1297
1365
|
#
|
1298
|
-
#
|
1299
|
-
#
|
1366
|
+
#
|
1367
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html
|
1368
|
+
# @return [String]
|
1300
1369
|
#
|
1301
1370
|
# @!attribute [rw] airflow_version
|
1302
1371
|
# The Apache Airflow version for your environment. To upgrade your
|
@@ -1310,84 +1379,45 @@ module Aws::MWAA
|
|
1310
1379
|
# environment][1].
|
1311
1380
|
#
|
1312
1381
|
# Valid values: `1.10.12`, `2.0.2`, `2.2.2`, `2.4.3`, `2.5.1`,
|
1313
|
-
# `2.6.3`, `2.7.2`.
|
1382
|
+
# `2.6.3`, `2.7.2`, `2.8.1`.
|
1314
1383
|
#
|
1315
1384
|
#
|
1316
1385
|
#
|
1317
1386
|
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/upgrading-environment.html
|
1318
1387
|
# @return [String]
|
1319
1388
|
#
|
1320
|
-
# @!attribute [rw]
|
1321
|
-
# The
|
1322
|
-
#
|
1323
|
-
#
|
1324
|
-
#
|
1325
|
-
#
|
1326
|
-
#
|
1327
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html
|
1328
|
-
# @return [String]
|
1329
|
-
#
|
1330
|
-
# @!attribute [rw] environment_class
|
1331
|
-
# The environment class type. Valid values: `mw1.small`, `mw1.medium`,
|
1332
|
-
# `mw1.large`. For more information, see [Amazon MWAA environment
|
1333
|
-
# class][1].
|
1389
|
+
# @!attribute [rw] source_bucket_arn
|
1390
|
+
# The Amazon Resource Name (ARN) of the Amazon S3 bucket where your
|
1391
|
+
# DAG code and supporting files are stored. For example,
|
1392
|
+
# `arn:aws:s3:::my-airflow-bucket-unique-name`. For more information,
|
1393
|
+
# see [Create an Amazon S3 bucket for Amazon MWAA][1].
|
1334
1394
|
#
|
1335
1395
|
#
|
1336
1396
|
#
|
1337
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
1397
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html
|
1338
1398
|
# @return [String]
|
1339
1399
|
#
|
1340
|
-
# @!attribute [rw]
|
1341
|
-
# The
|
1342
|
-
#
|
1343
|
-
#
|
1344
|
-
# `arn:aws:iam::123456789:role/my-execution-role`. For more
|
1345
|
-
# information, see [Amazon MWAA Execution role][1].
|
1400
|
+
# @!attribute [rw] dag_s3_path
|
1401
|
+
# The relative path to the DAGs folder on your Amazon S3 bucket. For
|
1402
|
+
# example, `dags`. For more information, see [Adding or updating
|
1403
|
+
# DAGs][1].
|
1346
1404
|
#
|
1347
1405
|
#
|
1348
1406
|
#
|
1349
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
1407
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html
|
1350
1408
|
# @return [String]
|
1351
1409
|
#
|
1352
|
-
# @!attribute [rw]
|
1353
|
-
# The
|
1354
|
-
#
|
1410
|
+
# @!attribute [rw] plugins_s3_path
|
1411
|
+
# The relative path to the `plugins.zip` file on your Amazon S3
|
1412
|
+
# bucket. For example, `plugins.zip`. If specified, then the
|
1413
|
+
# plugins.zip version is required. For more information, see
|
1414
|
+
# [Installing custom plugins][1].
|
1355
1415
|
#
|
1356
|
-
# @!attribute [rw] max_workers
|
1357
|
-
# The maximum number of workers that you want to run in your
|
1358
|
-
# environment. MWAA scales the number of Apache Airflow workers up to
|
1359
|
-
# the number you specify in the `MaxWorkers` field. For example, `20`.
|
1360
|
-
# When there are no more tasks running, and no more in the queue, MWAA
|
1361
|
-
# disposes of the extra workers leaving the one worker that is
|
1362
|
-
# included with your environment, or the number you specify in
|
1363
|
-
# `MinWorkers`.
|
1364
|
-
# @return [Integer]
|
1365
1416
|
#
|
1366
|
-
# @!attribute [rw] min_workers
|
1367
|
-
# The minimum number of workers that you want to run in your
|
1368
|
-
# environment. MWAA scales the number of Apache Airflow workers up to
|
1369
|
-
# the number you specify in the `MaxWorkers` field. When there are no
|
1370
|
-
# more tasks running, and no more in the queue, MWAA disposes of the
|
1371
|
-
# extra workers leaving the worker count you specify in the
|
1372
|
-
# `MinWorkers` field. For example, `2`.
|
1373
|
-
# @return [Integer]
|
1374
1417
|
#
|
1375
|
-
#
|
1376
|
-
# The name of your Amazon MWAA environment. For example,
|
1377
|
-
# `MyMWAAEnvironment`.
|
1418
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html
|
1378
1419
|
# @return [String]
|
1379
1420
|
#
|
1380
|
-
# @!attribute [rw] network_configuration
|
1381
|
-
# The VPC networking components used to secure and enable network
|
1382
|
-
# traffic between the Amazon Web Services resources for your
|
1383
|
-
# environment. For more information, see [About networking on Amazon
|
1384
|
-
# MWAA][1].
|
1385
|
-
#
|
1386
|
-
#
|
1387
|
-
#
|
1388
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html
|
1389
|
-
# @return [Types::UpdateNetworkConfigurationInput]
|
1390
|
-
#
|
1391
1421
|
# @!attribute [rw] plugins_s3_object_version
|
1392
1422
|
# The version of the plugins.zip file on your Amazon S3 bucket. You
|
1393
1423
|
# must specify a version each time a `plugins.zip` file is updated.
|
@@ -1398,15 +1428,15 @@ module Aws::MWAA
|
|
1398
1428
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html
|
1399
1429
|
# @return [String]
|
1400
1430
|
#
|
1401
|
-
# @!attribute [rw]
|
1402
|
-
# The relative path to the `
|
1403
|
-
# bucket. For example, `
|
1404
|
-
#
|
1405
|
-
#
|
1431
|
+
# @!attribute [rw] requirements_s3_path
|
1432
|
+
# The relative path to the `requirements.txt` file on your Amazon S3
|
1433
|
+
# bucket. For example, `requirements.txt`. If specified, then a file
|
1434
|
+
# version is required. For more information, see [Installing Python
|
1435
|
+
# dependencies][1].
|
1406
1436
|
#
|
1407
1437
|
#
|
1408
1438
|
#
|
1409
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
1439
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html
|
1410
1440
|
# @return [String]
|
1411
1441
|
#
|
1412
1442
|
# @!attribute [rw] requirements_s3_object_version
|
@@ -1419,31 +1449,19 @@ module Aws::MWAA
|
|
1419
1449
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html
|
1420
1450
|
# @return [String]
|
1421
1451
|
#
|
1422
|
-
# @!attribute [rw]
|
1423
|
-
# The relative path to the
|
1424
|
-
# bucket. For example, `
|
1425
|
-
# version is required. For more information, see [Installing Python
|
1426
|
-
# dependencies][1].
|
1427
|
-
#
|
1428
|
-
#
|
1429
|
-
#
|
1430
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html
|
1431
|
-
# @return [String]
|
1432
|
-
#
|
1433
|
-
# @!attribute [rw] schedulers
|
1434
|
-
# The number of Apache Airflow schedulers to run in your Amazon MWAA
|
1435
|
-
# environment.
|
1436
|
-
# @return [Integer]
|
1452
|
+
# @!attribute [rw] startup_script_s3_path
|
1453
|
+
# The relative path to the startup shell script in your Amazon S3
|
1454
|
+
# bucket. For example, `s3://mwaa-environment/startup.sh`.
|
1437
1455
|
#
|
1438
|
-
#
|
1439
|
-
#
|
1440
|
-
#
|
1441
|
-
#
|
1442
|
-
#
|
1456
|
+
# Amazon MWAA runs the script as your environment starts, and before
|
1457
|
+
# running the Apache Airflow process. You can use this script to
|
1458
|
+
# install dependencies, modify Apache Airflow configuration options,
|
1459
|
+
# and set environment variables. For more information, see [Using a
|
1460
|
+
# startup script][1].
|
1443
1461
|
#
|
1444
1462
|
#
|
1445
1463
|
#
|
1446
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
1464
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html
|
1447
1465
|
# @return [String]
|
1448
1466
|
#
|
1449
1467
|
# @!attribute [rw] startup_script_s3_object_version
|
@@ -1464,29 +1482,50 @@ module Aws::MWAA
|
|
1464
1482
|
# [2]: https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html
|
1465
1483
|
# @return [String]
|
1466
1484
|
#
|
1467
|
-
# @!attribute [rw]
|
1468
|
-
#
|
1469
|
-
#
|
1485
|
+
# @!attribute [rw] airflow_configuration_options
|
1486
|
+
# A list of key-value pairs containing the Apache Airflow
|
1487
|
+
# configuration options you want to attach to your environment. For
|
1488
|
+
# more information, see [Apache Airflow configuration options][1].
|
1470
1489
|
#
|
1471
|
-
# Amazon MWAA runs the script as your environment starts, and before
|
1472
|
-
# running the Apache Airflow process. You can use this script to
|
1473
|
-
# install dependencies, modify Apache Airflow configuration options,
|
1474
|
-
# and set environment variables. For more information, see [Using a
|
1475
|
-
# startup script][1].
|
1476
1490
|
#
|
1477
1491
|
#
|
1492
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html
|
1493
|
+
# @return [Hash<String,String>]
|
1478
1494
|
#
|
1479
|
-
#
|
1495
|
+
# @!attribute [rw] environment_class
|
1496
|
+
# The environment class type. Valid values: `mw1.small`, `mw1.medium`,
|
1497
|
+
# `mw1.large`, `mw1.xlarge`, and `mw1.2xlarge`. For more information,
|
1498
|
+
# see [Amazon MWAA environment class][1].
|
1499
|
+
#
|
1500
|
+
#
|
1501
|
+
#
|
1502
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html
|
1480
1503
|
# @return [String]
|
1481
1504
|
#
|
1482
|
-
# @!attribute [rw]
|
1483
|
-
# The
|
1484
|
-
#
|
1505
|
+
# @!attribute [rw] max_workers
|
1506
|
+
# The maximum number of workers that you want to run in your
|
1507
|
+
# environment. MWAA scales the number of Apache Airflow workers up to
|
1508
|
+
# the number you specify in the `MaxWorkers` field. For example, `20`.
|
1509
|
+
# When there are no more tasks running, and no more in the queue, MWAA
|
1510
|
+
# disposes of the extra workers leaving the one worker that is
|
1511
|
+
# included with your environment, or the number you specify in
|
1512
|
+
# `MinWorkers`.
|
1513
|
+
# @return [Integer]
|
1514
|
+
#
|
1515
|
+
# @!attribute [rw] network_configuration
|
1516
|
+
# The VPC networking components used to secure and enable network
|
1517
|
+
# traffic between the Amazon Web Services resources for your
|
1518
|
+
# environment. For more information, see [About networking on Amazon
|
1519
|
+
# MWAA][1].
|
1485
1520
|
#
|
1486
1521
|
#
|
1487
1522
|
#
|
1488
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
1489
|
-
# @return [
|
1523
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html
|
1524
|
+
# @return [Types::UpdateNetworkConfigurationInput]
|
1525
|
+
#
|
1526
|
+
# @!attribute [rw] logging_configuration
|
1527
|
+
# The Apache Airflow log types to send to CloudWatch Logs.
|
1528
|
+
# @return [Types::LoggingConfigurationInput]
|
1490
1529
|
#
|
1491
1530
|
# @!attribute [rw] weekly_maintenance_window_start
|
1492
1531
|
# The day and time of the week in Coordinated Universal Time (UTC)
|
@@ -1496,29 +1535,83 @@ module Aws::MWAA
|
|
1496
1535
|
# only.
|
1497
1536
|
# @return [String]
|
1498
1537
|
#
|
1538
|
+
# @!attribute [rw] webserver_access_mode
|
1539
|
+
# The Apache Airflow *Web server* access mode. For more information,
|
1540
|
+
# see [Apache Airflow access modes][1].
|
1541
|
+
#
|
1542
|
+
#
|
1543
|
+
#
|
1544
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html
|
1545
|
+
# @return [String]
|
1546
|
+
#
|
1547
|
+
# @!attribute [rw] min_workers
|
1548
|
+
# The minimum number of workers that you want to run in your
|
1549
|
+
# environment. MWAA scales the number of Apache Airflow workers up to
|
1550
|
+
# the number you specify in the `MaxWorkers` field. When there are no
|
1551
|
+
# more tasks running, and no more in the queue, MWAA disposes of the
|
1552
|
+
# extra workers leaving the worker count you specify in the
|
1553
|
+
# `MinWorkers` field. For example, `2`.
|
1554
|
+
# @return [Integer]
|
1555
|
+
#
|
1556
|
+
# @!attribute [rw] schedulers
|
1557
|
+
# The number of Apache Airflow schedulers to run in your Amazon MWAA
|
1558
|
+
# environment.
|
1559
|
+
# @return [Integer]
|
1560
|
+
#
|
1561
|
+
# @!attribute [rw] min_webservers
|
1562
|
+
# The minimum number of web servers that you want to run in your
|
1563
|
+
# environment. Amazon MWAA scales the number of Apache Airflow web
|
1564
|
+
# servers up to the number you specify for `MaxWebservers` when you
|
1565
|
+
# interact with your Apache Airflow environment using Apache Airflow
|
1566
|
+
# REST API, or the Apache Airflow CLI. As the transaction-per-second
|
1567
|
+
# rate, and the network load, decrease, Amazon MWAA disposes of the
|
1568
|
+
# additional web servers, and scales down to the number set in
|
1569
|
+
# `MinxWebserers`.
|
1570
|
+
#
|
1571
|
+
# Valid values: Accepts between `2` and `5`. Defaults to `2`.
|
1572
|
+
# @return [Integer]
|
1573
|
+
#
|
1574
|
+
# @!attribute [rw] max_webservers
|
1575
|
+
# The maximum number of web servers that you want to run in your
|
1576
|
+
# environment. Amazon MWAA scales the number of Apache Airflow web
|
1577
|
+
# servers up to the number you specify for `MaxWebservers` when you
|
1578
|
+
# interact with your Apache Airflow environment using Apache Airflow
|
1579
|
+
# REST API, or the Apache Airflow CLI. For example, in scenarios where
|
1580
|
+
# your workload requires network calls to the Apache Airflow REST API
|
1581
|
+
# with a high transaction-per-second (TPS) rate, Amazon MWAA will
|
1582
|
+
# increase the number of web servers up to the number set in
|
1583
|
+
# `MaxWebserers`. As TPS rates decrease Amazon MWAA disposes of the
|
1584
|
+
# additional web servers, and scales down to the number set in
|
1585
|
+
# `MinxWebserers`.
|
1586
|
+
#
|
1587
|
+
# Valid values: Accepts between `2` and `5`. Defaults to `2`.
|
1588
|
+
# @return [Integer]
|
1589
|
+
#
|
1499
1590
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/UpdateEnvironmentInput AWS API Documentation
|
1500
1591
|
#
|
1501
1592
|
class UpdateEnvironmentInput < Struct.new(
|
1502
|
-
:
|
1593
|
+
:name,
|
1594
|
+
:execution_role_arn,
|
1503
1595
|
:airflow_version,
|
1596
|
+
:source_bucket_arn,
|
1504
1597
|
:dag_s3_path,
|
1505
|
-
:environment_class,
|
1506
|
-
:execution_role_arn,
|
1507
|
-
:logging_configuration,
|
1508
|
-
:max_workers,
|
1509
|
-
:min_workers,
|
1510
|
-
:name,
|
1511
|
-
:network_configuration,
|
1512
|
-
:plugins_s3_object_version,
|
1513
1598
|
:plugins_s3_path,
|
1514
|
-
:
|
1599
|
+
:plugins_s3_object_version,
|
1515
1600
|
:requirements_s3_path,
|
1516
|
-
:
|
1517
|
-
:source_bucket_arn,
|
1518
|
-
:startup_script_s3_object_version,
|
1601
|
+
:requirements_s3_object_version,
|
1519
1602
|
:startup_script_s3_path,
|
1603
|
+
:startup_script_s3_object_version,
|
1604
|
+
:airflow_configuration_options,
|
1605
|
+
:environment_class,
|
1606
|
+
:max_workers,
|
1607
|
+
:network_configuration,
|
1608
|
+
:logging_configuration,
|
1609
|
+
:weekly_maintenance_window_start,
|
1520
1610
|
:webserver_access_mode,
|
1521
|
-
:
|
1611
|
+
:min_workers,
|
1612
|
+
:schedulers,
|
1613
|
+
:min_webservers,
|
1614
|
+
:max_webservers)
|
1522
1615
|
SENSITIVE = [:airflow_configuration_options]
|
1523
1616
|
include Aws::Structure
|
1524
1617
|
end
|