aws-sdk-mwaa 1.4.0 → 1.5.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.rb +1 -1
- data/lib/aws-sdk-mwaa/client.rb +244 -101
- data/lib/aws-sdk-mwaa/client_api.rb +4 -0
- data/lib/aws-sdk-mwaa/types.rb +501 -196
- metadata +5 -6
@@ -70,6 +70,7 @@ module Aws::MWAA
|
|
70
70
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
71
71
|
S3BucketArn = Shapes::StringShape.new(name: 'S3BucketArn')
|
72
72
|
S3ObjectVersion = Shapes::StringShape.new(name: 'S3ObjectVersion')
|
73
|
+
Schedulers = Shapes::IntegerShape.new(name: 'Schedulers')
|
73
74
|
SecurityGroupId = Shapes::StringShape.new(name: 'SecurityGroupId')
|
74
75
|
SecurityGroupList = Shapes::ListShape.new(name: 'SecurityGroupList')
|
75
76
|
StatisticSet = Shapes::StructureShape.new(name: 'StatisticSet')
|
@@ -129,6 +130,7 @@ module Aws::MWAA
|
|
129
130
|
CreateEnvironmentInput.add_member(:plugins_s3_path, Shapes::ShapeRef.new(shape: RelativePath, location_name: "PluginsS3Path"))
|
130
131
|
CreateEnvironmentInput.add_member(:requirements_s3_object_version, Shapes::ShapeRef.new(shape: S3ObjectVersion, location_name: "RequirementsS3ObjectVersion"))
|
131
132
|
CreateEnvironmentInput.add_member(:requirements_s3_path, Shapes::ShapeRef.new(shape: RelativePath, location_name: "RequirementsS3Path"))
|
133
|
+
CreateEnvironmentInput.add_member(:schedulers, Shapes::ShapeRef.new(shape: Schedulers, location_name: "Schedulers"))
|
132
134
|
CreateEnvironmentInput.add_member(:source_bucket_arn, Shapes::ShapeRef.new(shape: S3BucketArn, required: true, location_name: "SourceBucketArn"))
|
133
135
|
CreateEnvironmentInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
|
134
136
|
CreateEnvironmentInput.add_member(:webserver_access_mode, Shapes::ShapeRef.new(shape: WebserverAccessMode, location_name: "WebserverAccessMode"))
|
@@ -174,6 +176,7 @@ module Aws::MWAA
|
|
174
176
|
Environment.add_member(:plugins_s3_path, Shapes::ShapeRef.new(shape: RelativePath, location_name: "PluginsS3Path"))
|
175
177
|
Environment.add_member(:requirements_s3_object_version, Shapes::ShapeRef.new(shape: S3ObjectVersion, location_name: "RequirementsS3ObjectVersion"))
|
176
178
|
Environment.add_member(:requirements_s3_path, Shapes::ShapeRef.new(shape: RelativePath, location_name: "RequirementsS3Path"))
|
179
|
+
Environment.add_member(:schedulers, Shapes::ShapeRef.new(shape: Schedulers, location_name: "Schedulers"))
|
177
180
|
Environment.add_member(:service_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "ServiceRoleArn"))
|
178
181
|
Environment.add_member(:source_bucket_arn, Shapes::ShapeRef.new(shape: S3BucketArn, location_name: "SourceBucketArn"))
|
179
182
|
Environment.add_member(:status, Shapes::ShapeRef.new(shape: EnvironmentStatus, location_name: "Status"))
|
@@ -306,6 +309,7 @@ module Aws::MWAA
|
|
306
309
|
UpdateEnvironmentInput.add_member(:plugins_s3_path, Shapes::ShapeRef.new(shape: RelativePath, location_name: "PluginsS3Path"))
|
307
310
|
UpdateEnvironmentInput.add_member(:requirements_s3_object_version, Shapes::ShapeRef.new(shape: S3ObjectVersion, location_name: "RequirementsS3ObjectVersion"))
|
308
311
|
UpdateEnvironmentInput.add_member(:requirements_s3_path, Shapes::ShapeRef.new(shape: RelativePath, location_name: "RequirementsS3Path"))
|
312
|
+
UpdateEnvironmentInput.add_member(:schedulers, Shapes::ShapeRef.new(shape: Schedulers, location_name: "Schedulers"))
|
309
313
|
UpdateEnvironmentInput.add_member(:source_bucket_arn, Shapes::ShapeRef.new(shape: S3BucketArn, location_name: "SourceBucketArn"))
|
310
314
|
UpdateEnvironmentInput.add_member(:webserver_access_mode, Shapes::ShapeRef.new(shape: WebserverAccessMode, location_name: "WebserverAccessMode"))
|
311
315
|
UpdateEnvironmentInput.add_member(:weekly_maintenance_window_start, Shapes::ShapeRef.new(shape: WeeklyMaintenanceWindowStart, location_name: "WeeklyMaintenanceWindowStart"))
|
data/lib/aws-sdk-mwaa/types.rb
CHANGED
@@ -117,6 +117,7 @@ module Aws::MWAA
|
|
117
117
|
# plugins_s3_path: "RelativePath",
|
118
118
|
# requirements_s3_object_version: "S3ObjectVersion",
|
119
119
|
# requirements_s3_path: "RelativePath",
|
120
|
+
# schedulers: 1,
|
120
121
|
# source_bucket_arn: "S3BucketArn", # required
|
121
122
|
# tags: {
|
122
123
|
# "TagKey" => "TagValue",
|
@@ -126,9 +127,9 @@ module Aws::MWAA
|
|
126
127
|
# }
|
127
128
|
#
|
128
129
|
# @!attribute [rw] airflow_configuration_options
|
129
|
-
#
|
130
|
-
#
|
131
|
-
# configuration][1].
|
130
|
+
# A list of key-value pairs containing the Apache Airflow
|
131
|
+
# configuration options you want to attach to your environment. To
|
132
|
+
# learn more, see [Apache Airflow configuration options][1].
|
132
133
|
#
|
133
134
|
#
|
134
135
|
#
|
@@ -136,23 +137,27 @@ module Aws::MWAA
|
|
136
137
|
# @return [Hash<String,String>]
|
137
138
|
#
|
138
139
|
# @!attribute [rw] airflow_version
|
139
|
-
# The Apache Airflow version
|
140
|
+
# The Apache Airflow version for your environment. For example,
|
141
|
+
# `v1.10.12`. If no value is specified, defaults to the latest
|
142
|
+
# version. Valid values: `v1.10.12`.
|
140
143
|
# @return [String]
|
141
144
|
#
|
142
145
|
# @!attribute [rw] dag_s3_path
|
143
|
-
# The relative path to the
|
144
|
-
#
|
145
|
-
# DAGs on Amazon MWAA][1].
|
146
|
+
# The relative path to the DAGs folder on your Amazon S3 bucket. For
|
147
|
+
# example, `dags`. To learn more, see [Adding or updating DAGs][1].
|
146
148
|
#
|
147
149
|
#
|
148
150
|
#
|
149
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-
|
151
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html
|
150
152
|
# @return [String]
|
151
153
|
#
|
152
154
|
# @!attribute [rw] environment_class
|
153
|
-
# The environment class
|
154
|
-
#
|
155
|
-
#
|
155
|
+
# The environment class type. Valid values: `mw1.small`, `mw1.medium`,
|
156
|
+
# `mw1.large`. To learn more, see [Amazon MWAA environment class][1].
|
157
|
+
#
|
158
|
+
#
|
159
|
+
#
|
160
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html
|
156
161
|
# @return [String]
|
157
162
|
#
|
158
163
|
# @!attribute [rw] execution_role_arn
|
@@ -160,104 +165,126 @@ module Aws::MWAA
|
|
160
165
|
# environment. An execution role is an AWS Identity and Access
|
161
166
|
# Management (IAM) role that grants MWAA permission to access AWS
|
162
167
|
# services and resources used by your environment. For example,
|
163
|
-
# `arn:aws:iam::123456789:role/my-execution-role`.
|
164
|
-
#
|
165
|
-
# Apache Airflow][1].
|
168
|
+
# `arn:aws:iam::123456789:role/my-execution-role`. To learn more, see
|
169
|
+
# [Amazon MWAA Execution role][1].
|
166
170
|
#
|
167
171
|
#
|
168
172
|
#
|
169
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
173
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html
|
170
174
|
# @return [String]
|
171
175
|
#
|
172
176
|
# @!attribute [rw] kms_key
|
173
|
-
# The AWS Key Management Service (KMS) key to encrypt
|
174
|
-
#
|
175
|
-
#
|
176
|
-
#
|
177
|
+
# The AWS Key Management Service (KMS) key to encrypt the data in your
|
178
|
+
# environment. You can use an AWS owned CMK, or a Customer managed CMK
|
179
|
+
# (advanced). To learn more, see [Get started with Amazon Managed
|
180
|
+
# Workflows for Apache Airflow][1].
|
177
181
|
#
|
178
182
|
#
|
179
183
|
#
|
180
|
-
# [1]: https://docs.aws.amazon.com/
|
184
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/get-started.html
|
181
185
|
# @return [String]
|
182
186
|
#
|
183
187
|
# @!attribute [rw] logging_configuration
|
184
|
-
#
|
188
|
+
# Defines the Apache Airflow logs to send to CloudWatch Logs:
|
189
|
+
# `DagProcessingLogs`, `SchedulerLogs`, `TaskLogs`, `WebserverLogs`,
|
190
|
+
# `WorkerLogs`.
|
185
191
|
# @return [Types::LoggingConfigurationInput]
|
186
192
|
#
|
187
193
|
# @!attribute [rw] max_workers
|
188
194
|
# The maximum number of workers that you want to run in your
|
189
|
-
# environment. MWAA scales the number of Apache Airflow workers
|
190
|
-
# the
|
191
|
-
#
|
192
|
-
#
|
193
|
-
#
|
195
|
+
# environment. MWAA scales the number of Apache Airflow workers up to
|
196
|
+
# the number you specify in the `MaxWorkers` field. For example, `20`.
|
197
|
+
# When there are no more tasks running, and no more in the queue, MWAA
|
198
|
+
# disposes of the extra workers leaving the one worker that is
|
199
|
+
# included with your environment, or the number you specify in
|
200
|
+
# `MinWorkers`.
|
194
201
|
# @return [Integer]
|
195
202
|
#
|
196
203
|
# @!attribute [rw] min_workers
|
197
204
|
# The minimum number of workers that you want to run in your
|
198
|
-
# environment. MWAA scales the number of Apache Airflow workers
|
199
|
-
# the
|
200
|
-
#
|
201
|
-
#
|
202
|
-
#
|
203
|
-
# field.
|
205
|
+
# environment. MWAA scales the number of Apache Airflow workers up to
|
206
|
+
# the number you specify in the `MaxWorkers` field. When there are no
|
207
|
+
# more tasks running, and no more in the queue, MWAA disposes of the
|
208
|
+
# extra workers leaving the worker count you specify in the
|
209
|
+
# `MinWorkers` field. For example, `2`.
|
204
210
|
# @return [Integer]
|
205
211
|
#
|
206
212
|
# @!attribute [rw] name
|
207
|
-
# The name of
|
213
|
+
# The name of the Amazon MWAA environment. For example,
|
214
|
+
# `MyMWAAEnvironment`.
|
208
215
|
# @return [String]
|
209
216
|
#
|
210
217
|
# @!attribute [rw] network_configuration
|
211
|
-
# The VPC networking components
|
212
|
-
#
|
213
|
-
#
|
214
|
-
# information, see [Creating the VPC network for a MWAA
|
215
|
-
# environment][1].
|
218
|
+
# The VPC networking components used to secure and enable network
|
219
|
+
# traffic between the AWS resources for your environment. To learn
|
220
|
+
# more, see [About networking on Amazon MWAA][1].
|
216
221
|
#
|
217
222
|
#
|
218
223
|
#
|
219
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
224
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html
|
220
225
|
# @return [Types::NetworkConfiguration]
|
221
226
|
#
|
222
227
|
# @!attribute [rw] plugins_s3_object_version
|
223
|
-
# The
|
228
|
+
# The version of the plugins.zip file on your Amazon S3 bucket. A
|
229
|
+
# version must be specified each time a plugins.zip file is updated.
|
230
|
+
# To learn more, see [How S3 Versioning works][1].
|
231
|
+
#
|
232
|
+
#
|
233
|
+
#
|
234
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html
|
224
235
|
# @return [String]
|
225
236
|
#
|
226
237
|
# @!attribute [rw] plugins_s3_path
|
227
238
|
# The relative path to the `plugins.zip` file on your Amazon S3
|
228
|
-
#
|
229
|
-
#
|
230
|
-
#
|
239
|
+
# bucket. For example, `plugins.zip`. If specified, then the
|
240
|
+
# plugins.zip version is required. To learn more, see [Installing
|
241
|
+
# custom plugins][1].
|
231
242
|
#
|
232
243
|
#
|
233
244
|
#
|
234
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import.html
|
245
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html
|
235
246
|
# @return [String]
|
236
247
|
#
|
237
248
|
# @!attribute [rw] requirements_s3_object_version
|
238
|
-
# The
|
249
|
+
# The version of the requirements.txt file on your Amazon S3 bucket. A
|
250
|
+
# version must be specified each time a requirements.txt file is
|
251
|
+
# updated. To learn more, see [How S3 Versioning works][1].
|
252
|
+
#
|
253
|
+
#
|
254
|
+
#
|
255
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html
|
239
256
|
# @return [String]
|
240
257
|
#
|
241
258
|
# @!attribute [rw] requirements_s3_path
|
242
259
|
# The relative path to the `requirements.txt` file on your Amazon S3
|
243
|
-
#
|
244
|
-
# is
|
245
|
-
#
|
246
|
-
# MWAA][1].
|
260
|
+
# bucket. For example, `requirements.txt`. If specified, then a file
|
261
|
+
# version is required. To learn more, see [Installing Python
|
262
|
+
# dependencies][1].
|
247
263
|
#
|
248
264
|
#
|
249
265
|
#
|
250
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
266
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html
|
251
267
|
# @return [String]
|
252
268
|
#
|
269
|
+
# @!attribute [rw] schedulers
|
270
|
+
# The number of Apache Airflow schedulers to run in your environment.
|
271
|
+
# @return [Integer]
|
272
|
+
#
|
253
273
|
# @!attribute [rw] source_bucket_arn
|
254
|
-
# The Amazon Resource Name (ARN) of
|
255
|
-
# example,
|
274
|
+
# The Amazon Resource Name (ARN) of the Amazon S3 bucket where your
|
275
|
+
# DAG code and supporting files are stored. For example,
|
276
|
+
# `arn:aws:s3:::my-airflow-bucket-unique-name`. To learn more, see
|
277
|
+
# [Create an Amazon S3 bucket for Amazon MWAA][1].
|
278
|
+
#
|
279
|
+
#
|
280
|
+
#
|
281
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html
|
256
282
|
# @return [String]
|
257
283
|
#
|
258
284
|
# @!attribute [rw] tags
|
259
|
-
# The
|
260
|
-
#
|
285
|
+
# The key-value tag pairs you want to associate to your environment.
|
286
|
+
# For example, `"Environment": "Staging"`. To learn more, see [Tagging
|
287
|
+
# AWS resources][1].
|
261
288
|
#
|
262
289
|
#
|
263
290
|
#
|
@@ -265,21 +292,23 @@ module Aws::MWAA
|
|
265
292
|
# @return [Hash<String,String>]
|
266
293
|
#
|
267
294
|
# @!attribute [rw] webserver_access_mode
|
268
|
-
# The
|
269
|
-
#
|
270
|
-
# users granted access in your IAM policy. A private network limits
|
271
|
-
# access of your Airflow UI to users within your VPC. For more
|
272
|
-
# information, see [Creating the VPC network for a MWAA
|
273
|
-
# environment][1].
|
295
|
+
# The Apache Airflow *Web server* access mode. To learn more, see
|
296
|
+
# [Apache Airflow access modes][1].
|
274
297
|
#
|
275
298
|
#
|
276
299
|
#
|
277
|
-
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/
|
300
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html
|
278
301
|
# @return [String]
|
279
302
|
#
|
280
303
|
# @!attribute [rw] weekly_maintenance_window_start
|
281
|
-
# The day and time
|
282
|
-
#
|
304
|
+
# The day and time of the week to start weekly maintenance updates of
|
305
|
+
# your environment in the following format: `DAY:HH:MM`. For example:
|
306
|
+
# `TUE:03:30`. You can specify a start time in 30 minute increments
|
307
|
+
# only. Supported input includes the following:
|
308
|
+
#
|
309
|
+
# * MON\|TUE\|WED\|THU\|FRI\|SAT\|SUN:(\[01\]\\\\d\|2\[0-3\]):(00\|30)
|
310
|
+
#
|
311
|
+
# ^
|
283
312
|
# @return [String]
|
284
313
|
#
|
285
314
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/CreateEnvironmentInput AWS API Documentation
|
@@ -300,6 +329,7 @@ module Aws::MWAA
|
|
300
329
|
:plugins_s3_path,
|
301
330
|
:requirements_s3_object_version,
|
302
331
|
:requirements_s3_path,
|
332
|
+
:schedulers,
|
303
333
|
:source_bucket_arn,
|
304
334
|
:tags,
|
305
335
|
:webserver_access_mode,
|
@@ -309,7 +339,8 @@ module Aws::MWAA
|
|
309
339
|
end
|
310
340
|
|
311
341
|
# @!attribute [rw] arn
|
312
|
-
# The
|
342
|
+
# The Amazon Resource Name (ARN) returned in the response for the
|
343
|
+
# environment.
|
313
344
|
# @return [String]
|
314
345
|
#
|
315
346
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/CreateEnvironmentOutput AWS API Documentation
|
@@ -366,7 +397,8 @@ module Aws::MWAA
|
|
366
397
|
# }
|
367
398
|
#
|
368
399
|
# @!attribute [rw] name
|
369
|
-
# The name of the environment
|
400
|
+
# The name of the Amazon MWAA environment. For example,
|
401
|
+
# `MyMWAAEnvironment`.
|
370
402
|
# @return [String]
|
371
403
|
#
|
372
404
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/DeleteEnvironmentInput AWS API Documentation
|
@@ -408,111 +440,234 @@ module Aws::MWAA
|
|
408
440
|
include Aws::Structure
|
409
441
|
end
|
410
442
|
|
411
|
-
#
|
443
|
+
# The Amazon Managed Workflows for Apache Airflow (MWAA) environment.
|
412
444
|
#
|
413
445
|
# @!attribute [rw] airflow_configuration_options
|
414
|
-
#
|
446
|
+
# A list of key-value pairs containing the Apache Airflow
|
447
|
+
# configuration options attached to your environment. To learn more,
|
448
|
+
# see [Apache Airflow configuration options][1].
|
449
|
+
#
|
450
|
+
#
|
451
|
+
#
|
452
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html
|
415
453
|
# @return [Hash<String,String>]
|
416
454
|
#
|
417
455
|
# @!attribute [rw] airflow_version
|
418
|
-
# The
|
456
|
+
# The Apache Airflow version on your environment. For example,
|
457
|
+
# `v1.10.12`.
|
419
458
|
# @return [String]
|
420
459
|
#
|
421
460
|
# @!attribute [rw] arn
|
422
|
-
# The ARN of the Amazon MWAA
|
461
|
+
# The Amazon Resource Name (ARN) of the Amazon MWAA environment.
|
423
462
|
# @return [String]
|
424
463
|
#
|
425
464
|
# @!attribute [rw] created_at
|
426
|
-
# The
|
465
|
+
# The day and time the environment was created.
|
427
466
|
# @return [Time]
|
428
467
|
#
|
429
468
|
# @!attribute [rw] dag_s3_path
|
430
|
-
# The
|
469
|
+
# The relative path to the DAGs folder on your Amazon S3 bucket. For
|
470
|
+
# example, `dags`. To learn more, see [Adding or updating DAGs][1].
|
471
|
+
#
|
472
|
+
#
|
473
|
+
#
|
474
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html
|
431
475
|
# @return [String]
|
432
476
|
#
|
433
477
|
# @!attribute [rw] environment_class
|
434
|
-
# The
|
478
|
+
# The environment class type. Valid values: `mw1.small`, `mw1.medium`,
|
479
|
+
# `mw1.large`. To learn more, see [Amazon MWAA environment class][1].
|
480
|
+
#
|
481
|
+
#
|
482
|
+
#
|
483
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html
|
435
484
|
# @return [String]
|
436
485
|
#
|
437
486
|
# @!attribute [rw] execution_role_arn
|
438
|
-
# The
|
487
|
+
# The Amazon Resource Name (ARN) of the execution role in IAM that
|
488
|
+
# allows MWAA to access AWS resources in your environment. For
|
489
|
+
# example, `arn:aws:iam::123456789:role/my-execution-role`. To learn
|
490
|
+
# more, see [Amazon MWAA Execution role][1].
|
491
|
+
#
|
492
|
+
#
|
493
|
+
#
|
494
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html
|
439
495
|
# @return [String]
|
440
496
|
#
|
441
497
|
# @!attribute [rw] kms_key
|
442
|
-
# The
|
498
|
+
# The Key Management Service (KMS) encryption key used to encrypt the
|
499
|
+
# data in your environment.
|
443
500
|
# @return [String]
|
444
501
|
#
|
445
502
|
# @!attribute [rw] last_update
|
446
|
-
#
|
503
|
+
# The status of the last update on the environment, and any errors
|
504
|
+
# that were encountered.
|
447
505
|
# @return [Types::LastUpdate]
|
448
506
|
#
|
449
507
|
# @!attribute [rw] logging_configuration
|
450
|
-
# The
|
508
|
+
# The Apache Airflow logs being sent to CloudWatch Logs:
|
509
|
+
# `DagProcessingLogs`, `SchedulerLogs`, `TaskLogs`, `WebserverLogs`,
|
510
|
+
# `WorkerLogs`.
|
451
511
|
# @return [Types::LoggingConfiguration]
|
452
512
|
#
|
453
513
|
# @!attribute [rw] max_workers
|
454
|
-
# The maximum number of workers
|
455
|
-
#
|
514
|
+
# The maximum number of workers that run in your environment. For
|
515
|
+
# example, `20`.
|
456
516
|
# @return [Integer]
|
457
517
|
#
|
458
518
|
# @!attribute [rw] min_workers
|
459
|
-
# The minimum number of workers
|
460
|
-
#
|
519
|
+
# The minimum number of workers that run in your environment. For
|
520
|
+
# example, `2`.
|
461
521
|
# @return [Integer]
|
462
522
|
#
|
463
523
|
# @!attribute [rw] name
|
464
|
-
# The name of the Amazon MWAA
|
524
|
+
# The name of the Amazon MWAA environment. For example,
|
525
|
+
# `MyMWAAEnvironment`.
|
465
526
|
# @return [String]
|
466
527
|
#
|
467
528
|
# @!attribute [rw] network_configuration
|
468
|
-
#
|
469
|
-
#
|
529
|
+
# The VPC networking components used to secure and enable network
|
530
|
+
# traffic between the AWS resources for your environment. To learn
|
531
|
+
# more, see [About networking on Amazon MWAA][1].
|
532
|
+
#
|
533
|
+
#
|
534
|
+
#
|
535
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html
|
470
536
|
# @return [Types::NetworkConfiguration]
|
471
537
|
#
|
472
538
|
# @!attribute [rw] plugins_s3_object_version
|
473
|
-
# The
|
539
|
+
# The version of the plugins.zip file on your Amazon S3 bucket. To
|
540
|
+
# learn more, see [Installing custom plugins][1].
|
541
|
+
#
|
542
|
+
#
|
543
|
+
#
|
544
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html
|
474
545
|
# @return [String]
|
475
546
|
#
|
476
547
|
# @!attribute [rw] plugins_s3_path
|
477
|
-
# The
|
548
|
+
# The relative path to the `plugins.zip` file on your Amazon S3
|
549
|
+
# bucket. For example, `plugins.zip`. To learn more, see [Installing
|
550
|
+
# custom plugins][1].
|
551
|
+
#
|
552
|
+
#
|
553
|
+
#
|
554
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html
|
478
555
|
# @return [String]
|
479
556
|
#
|
480
557
|
# @!attribute [rw] requirements_s3_object_version
|
481
|
-
# The
|
482
|
-
#
|
558
|
+
# The version of the requirements.txt file on your Amazon S3 bucket.
|
559
|
+
# To learn more, see [Installing Python dependencies][1].
|
560
|
+
#
|
561
|
+
#
|
562
|
+
#
|
563
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html
|
483
564
|
# @return [String]
|
484
565
|
#
|
485
566
|
# @!attribute [rw] requirements_s3_path
|
486
|
-
# The
|
567
|
+
# The relative path to the `requirements.txt` file on your Amazon S3
|
568
|
+
# bucket. For example, `requirements.txt`. To learn more, see
|
569
|
+
# [Installing Python dependencies][1].
|
570
|
+
#
|
571
|
+
#
|
572
|
+
#
|
573
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html
|
487
574
|
# @return [String]
|
488
575
|
#
|
576
|
+
# @!attribute [rw] schedulers
|
577
|
+
# The number of Apache Airflow schedulers that run in your Amazon MWAA
|
578
|
+
# environment.
|
579
|
+
# @return [Integer]
|
580
|
+
#
|
489
581
|
# @!attribute [rw] service_role_arn
|
490
|
-
# The
|
582
|
+
# The Amazon Resource Name (ARN) for the service-linked role of the
|
583
|
+
# environment. To learn more, see [Amazon MWAA Service-linked
|
584
|
+
# role][1].
|
585
|
+
#
|
586
|
+
#
|
587
|
+
#
|
588
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-slr.html
|
491
589
|
# @return [String]
|
492
590
|
#
|
493
591
|
# @!attribute [rw] source_bucket_arn
|
494
|
-
# The
|
592
|
+
# The Amazon Resource Name (ARN) of the Amazon S3 bucket where your
|
593
|
+
# DAG code and supporting files are stored. For example,
|
594
|
+
# `arn:aws:s3:::my-airflow-bucket-unique-name`. To learn more, see
|
595
|
+
# [Create an Amazon S3 bucket for Amazon MWAA][1].
|
596
|
+
#
|
597
|
+
#
|
598
|
+
#
|
599
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html
|
495
600
|
# @return [String]
|
496
601
|
#
|
497
602
|
# @!attribute [rw] status
|
498
|
-
# The status of the Amazon MWAA
|
603
|
+
# The status of the Amazon MWAA environment. Valid values:
|
604
|
+
#
|
605
|
+
# * `CREATING` - Indicates the request to create the environment is in
|
606
|
+
# progress.
|
607
|
+
#
|
608
|
+
# * `CREATE_FAILED` - Indicates the request to create the environment
|
609
|
+
# failed, and the environment could not be created.
|
610
|
+
#
|
611
|
+
# * `AVAILABLE` - Indicates the request was successful and the
|
612
|
+
# environment is ready to use.
|
613
|
+
#
|
614
|
+
# * `UPDATING` - Indicates the request to update the environment is in
|
615
|
+
# progress.
|
616
|
+
#
|
617
|
+
# * `DELETING` - Indicates the request to delete the environment is in
|
618
|
+
# progress.
|
619
|
+
#
|
620
|
+
# * `DELETED` - Indicates the request to delete the environment is
|
621
|
+
# complete, and the environment has been deleted.
|
622
|
+
#
|
623
|
+
# * `UNAVAILABLE` - Indicates the request failed, but the environment
|
624
|
+
# was unable to rollback and is not in a stable state.
|
625
|
+
#
|
626
|
+
# * `UPDATE_FAILED` - Indicates the request to update the environment
|
627
|
+
# failed, and the environment has rolled back successfully and is
|
628
|
+
# ready to use.
|
629
|
+
#
|
630
|
+
# We recommend reviewing our troubleshooting guide for a list of
|
631
|
+
# common errors and their solutions. To learn more, see [Amazon MWAA
|
632
|
+
# troubleshooting][1].
|
633
|
+
#
|
634
|
+
#
|
635
|
+
#
|
636
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/troubleshooting.html
|
499
637
|
# @return [String]
|
500
638
|
#
|
501
639
|
# @!attribute [rw] tags
|
502
|
-
# The
|
640
|
+
# The key-value tag pairs associated to your environment. For example,
|
641
|
+
# `"Environment": "Staging"`. To learn more, see [Tagging AWS
|
642
|
+
# resources][1].
|
643
|
+
#
|
644
|
+
#
|
645
|
+
#
|
646
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
503
647
|
# @return [Hash<String,String>]
|
504
648
|
#
|
505
649
|
# @!attribute [rw] webserver_access_mode
|
506
|
-
# The
|
507
|
-
#
|
650
|
+
# The Apache Airflow *Web server* access mode. To learn more, see
|
651
|
+
# [Apache Airflow access modes][1].
|
652
|
+
#
|
653
|
+
#
|
654
|
+
#
|
655
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html
|
508
656
|
# @return [String]
|
509
657
|
#
|
510
658
|
# @!attribute [rw] webserver_url
|
511
|
-
# The
|
659
|
+
# The Apache Airflow *Web server* host name for the Amazon MWAA
|
660
|
+
# environment. To learn more, see [Accessing the Apache Airflow
|
661
|
+
# UI][1].
|
662
|
+
#
|
663
|
+
#
|
664
|
+
#
|
665
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/access-airflow-ui.html
|
512
666
|
# @return [String]
|
513
667
|
#
|
514
668
|
# @!attribute [rw] weekly_maintenance_window_start
|
515
|
-
# The
|
669
|
+
# The day and time of the week that weekly maintenance updates are
|
670
|
+
# scheduled. For example: `TUE:03:30`.
|
516
671
|
# @return [String]
|
517
672
|
#
|
518
673
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/Environment AWS API Documentation
|
@@ -536,6 +691,7 @@ module Aws::MWAA
|
|
536
691
|
:plugins_s3_path,
|
537
692
|
:requirements_s3_object_version,
|
538
693
|
:requirements_s3_path,
|
694
|
+
:schedulers,
|
539
695
|
:service_role_arn,
|
540
696
|
:source_bucket_arn,
|
541
697
|
:status,
|
@@ -555,7 +711,8 @@ module Aws::MWAA
|
|
555
711
|
# }
|
556
712
|
#
|
557
713
|
# @!attribute [rw] name
|
558
|
-
# The name of the environment
|
714
|
+
# The name of the Amazon MWAA environment. For example,
|
715
|
+
# `MyMWAAEnvironment`.
|
559
716
|
# @return [String]
|
560
717
|
#
|
561
718
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/GetEnvironmentInput AWS API Documentation
|
@@ -567,7 +724,7 @@ module Aws::MWAA
|
|
567
724
|
end
|
568
725
|
|
569
726
|
# @!attribute [rw] environment
|
570
|
-
#
|
727
|
+
# An object containing all available details about the environment.
|
571
728
|
# @return [Types::Environment]
|
572
729
|
#
|
573
730
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/GetEnvironmentOutput AWS API Documentation
|
@@ -591,18 +748,21 @@ module Aws::MWAA
|
|
591
748
|
include Aws::Structure
|
592
749
|
end
|
593
750
|
|
594
|
-
#
|
751
|
+
# The status of the last update on the environment, and any errors that
|
752
|
+
# were encountered.
|
595
753
|
#
|
596
754
|
# @!attribute [rw] created_at
|
597
|
-
#
|
755
|
+
# The day and time of the last update on the environment.
|
598
756
|
# @return [Time]
|
599
757
|
#
|
600
758
|
# @!attribute [rw] error
|
601
|
-
#
|
759
|
+
# The error that was encountered during the last update of the
|
760
|
+
# environment.
|
602
761
|
# @return [Types::UpdateError]
|
603
762
|
#
|
604
763
|
# @!attribute [rw] status
|
605
|
-
#
|
764
|
+
# The status of the last update on the environment. Valid values:
|
765
|
+
# `SUCCESS`, `PENDING`, `FAILED`.
|
606
766
|
# @return [String]
|
607
767
|
#
|
608
768
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/LastUpdate AWS API Documentation
|
@@ -624,11 +784,12 @@ module Aws::MWAA
|
|
624
784
|
# }
|
625
785
|
#
|
626
786
|
# @!attribute [rw] max_results
|
627
|
-
# The maximum results
|
787
|
+
# The maximum number of results to retrieve per page. For example, `5`
|
788
|
+
# environments per page.
|
628
789
|
# @return [Integer]
|
629
790
|
#
|
630
791
|
# @!attribute [rw] next_token
|
631
|
-
#
|
792
|
+
# Retrieves the next page of the results.
|
632
793
|
# @return [String]
|
633
794
|
#
|
634
795
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/ListEnvironmentsInput AWS API Documentation
|
@@ -641,11 +802,11 @@ module Aws::MWAA
|
|
641
802
|
end
|
642
803
|
|
643
804
|
# @!attribute [rw] environments
|
644
|
-
#
|
805
|
+
# Returns the list of Amazon MWAA environments.
|
645
806
|
# @return [Array<String>]
|
646
807
|
#
|
647
808
|
# @!attribute [rw] next_token
|
648
|
-
#
|
809
|
+
# Retrieves the next page of the results.
|
649
810
|
# @return [String]
|
650
811
|
#
|
651
812
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/ListEnvironmentsOutput AWS API Documentation
|
@@ -665,7 +826,9 @@ module Aws::MWAA
|
|
665
826
|
# }
|
666
827
|
#
|
667
828
|
# @!attribute [rw] resource_arn
|
668
|
-
# The ARN of the MWAA environment.
|
829
|
+
# The Amazon Resource Name (ARN) of the Amazon MWAA environment. For
|
830
|
+
# example,
|
831
|
+
# `arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment`.
|
669
832
|
# @return [String]
|
670
833
|
#
|
671
834
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/ListTagsForResourceInput AWS API Documentation
|
@@ -677,7 +840,12 @@ module Aws::MWAA
|
|
677
840
|
end
|
678
841
|
|
679
842
|
# @!attribute [rw] tags
|
680
|
-
# The
|
843
|
+
# The key-value tag pairs associated to your environment. To learn
|
844
|
+
# more, see [Tagging AWS resources][1].
|
845
|
+
#
|
846
|
+
#
|
847
|
+
#
|
848
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
681
849
|
# @return [Hash<String,String>]
|
682
850
|
#
|
683
851
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/ListTagsForResourceOutput AWS API Documentation
|
@@ -688,36 +856,38 @@ module Aws::MWAA
|
|
688
856
|
include Aws::Structure
|
689
857
|
end
|
690
858
|
|
691
|
-
#
|
859
|
+
# Defines the Apache Airflow logs to send to CloudWatch Logs:
|
860
|
+
# `DagProcessingLogs`, `SchedulerLogs`, `TaskLogs`, `WebserverLogs`,
|
861
|
+
# `WorkerLogs`.
|
692
862
|
#
|
693
863
|
# @!attribute [rw] dag_processing_logs
|
694
|
-
#
|
695
|
-
#
|
696
|
-
#
|
864
|
+
# Defines the type of logs to send for the Apache Airflow log type
|
865
|
+
# (e.g. `DagProcessingLogs`). Valid values: `CloudWatchLogGroupArn`,
|
866
|
+
# `Enabled`, `LogLevel`.
|
697
867
|
# @return [Types::ModuleLoggingConfiguration]
|
698
868
|
#
|
699
869
|
# @!attribute [rw] scheduler_logs
|
700
|
-
#
|
701
|
-
#
|
702
|
-
#
|
870
|
+
# Defines the type of logs to send for the Apache Airflow log type
|
871
|
+
# (e.g. `DagProcessingLogs`). Valid values: `CloudWatchLogGroupArn`,
|
872
|
+
# `Enabled`, `LogLevel`.
|
703
873
|
# @return [Types::ModuleLoggingConfiguration]
|
704
874
|
#
|
705
875
|
# @!attribute [rw] task_logs
|
706
|
-
#
|
707
|
-
#
|
708
|
-
#
|
876
|
+
# Defines the type of logs to send for the Apache Airflow log type
|
877
|
+
# (e.g. `DagProcessingLogs`). Valid values: `CloudWatchLogGroupArn`,
|
878
|
+
# `Enabled`, `LogLevel`.
|
709
879
|
# @return [Types::ModuleLoggingConfiguration]
|
710
880
|
#
|
711
881
|
# @!attribute [rw] webserver_logs
|
712
|
-
#
|
713
|
-
#
|
714
|
-
#
|
882
|
+
# Defines the type of logs to send for the Apache Airflow log type
|
883
|
+
# (e.g. `DagProcessingLogs`). Valid values: `CloudWatchLogGroupArn`,
|
884
|
+
# `Enabled`, `LogLevel`.
|
715
885
|
# @return [Types::ModuleLoggingConfiguration]
|
716
886
|
#
|
717
887
|
# @!attribute [rw] worker_logs
|
718
|
-
#
|
719
|
-
#
|
720
|
-
#
|
888
|
+
# Defines the type of logs to send for the Apache Airflow log type
|
889
|
+
# (e.g. `DagProcessingLogs`). Valid values: `CloudWatchLogGroupArn`,
|
890
|
+
# `Enabled`, `LogLevel`.
|
721
891
|
# @return [Types::ModuleLoggingConfiguration]
|
722
892
|
#
|
723
893
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/LoggingConfiguration AWS API Documentation
|
@@ -732,7 +902,9 @@ module Aws::MWAA
|
|
732
902
|
include Aws::Structure
|
733
903
|
end
|
734
904
|
|
735
|
-
#
|
905
|
+
# Defines the Apache Airflow logs to send to CloudWatch Logs:
|
906
|
+
# `DagProcessingLogs`, `SchedulerLogs`, `TaskLogs`, `WebserverLogs`,
|
907
|
+
# `WorkerLogs`.
|
736
908
|
#
|
737
909
|
# @note When making an API call, you may pass LoggingConfigurationInput
|
738
910
|
# data as a hash:
|
@@ -761,33 +933,33 @@ module Aws::MWAA
|
|
761
933
|
# }
|
762
934
|
#
|
763
935
|
# @!attribute [rw] dag_processing_logs
|
764
|
-
#
|
765
|
-
#
|
766
|
-
#
|
936
|
+
# Defines the type of logs to send for the Apache Airflow log type
|
937
|
+
# (e.g. `DagProcessingLogs`). Valid values: `CloudWatchLogGroupArn`,
|
938
|
+
# `Enabled`, `LogLevel`.
|
767
939
|
# @return [Types::ModuleLoggingConfigurationInput]
|
768
940
|
#
|
769
941
|
# @!attribute [rw] scheduler_logs
|
770
|
-
#
|
771
|
-
#
|
772
|
-
#
|
942
|
+
# Defines the type of logs to send for the Apache Airflow log type
|
943
|
+
# (e.g. `DagProcessingLogs`). Valid values: `CloudWatchLogGroupArn`,
|
944
|
+
# `Enabled`, `LogLevel`.
|
773
945
|
# @return [Types::ModuleLoggingConfigurationInput]
|
774
946
|
#
|
775
947
|
# @!attribute [rw] task_logs
|
776
|
-
#
|
777
|
-
#
|
778
|
-
#
|
948
|
+
# Defines the type of logs to send for the Apache Airflow log type
|
949
|
+
# (e.g. `DagProcessingLogs`). Valid values: `CloudWatchLogGroupArn`,
|
950
|
+
# `Enabled`, `LogLevel`.
|
779
951
|
# @return [Types::ModuleLoggingConfigurationInput]
|
780
952
|
#
|
781
953
|
# @!attribute [rw] webserver_logs
|
782
|
-
#
|
783
|
-
#
|
784
|
-
#
|
954
|
+
# Defines the type of logs to send for the Apache Airflow log type
|
955
|
+
# (e.g. `DagProcessingLogs`). Valid values: `CloudWatchLogGroupArn`,
|
956
|
+
# `Enabled`, `LogLevel`.
|
785
957
|
# @return [Types::ModuleLoggingConfigurationInput]
|
786
958
|
#
|
787
959
|
# @!attribute [rw] worker_logs
|
788
|
-
#
|
789
|
-
#
|
790
|
-
#
|
960
|
+
# Defines the type of logs to send for the Apache Airflow log type
|
961
|
+
# (e.g. `DagProcessingLogs`). Valid values: `CloudWatchLogGroupArn`,
|
962
|
+
# `Enabled`, `LogLevel`.
|
791
963
|
# @return [Types::ModuleLoggingConfigurationInput]
|
792
964
|
#
|
793
965
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/LoggingConfigurationInput AWS API Documentation
|
@@ -863,22 +1035,26 @@ module Aws::MWAA
|
|
863
1035
|
include Aws::Structure
|
864
1036
|
end
|
865
1037
|
|
866
|
-
#
|
867
|
-
#
|
868
|
-
#
|
1038
|
+
# Defines the type of logs to send for the Apache Airflow log type (e.g.
|
1039
|
+
# `DagProcessingLogs`). Valid values: `CloudWatchLogGroupArn`,
|
1040
|
+
# `Enabled`, `LogLevel`.
|
869
1041
|
#
|
870
1042
|
# @!attribute [rw] cloud_watch_log_group_arn
|
871
|
-
#
|
872
|
-
# published.
|
1043
|
+
# The Amazon Resource Name (ARN) for the CloudWatch Logs group where
|
1044
|
+
# the Apache Airflow log type (e.g. `DagProcessingLogs`) is published.
|
1045
|
+
# For example,
|
1046
|
+
# `arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*`.
|
873
1047
|
# @return [String]
|
874
1048
|
#
|
875
1049
|
# @!attribute [rw] enabled
|
876
|
-
#
|
1050
|
+
# Indicates whether to enable the Apache Airflow log type (e.g.
|
1051
|
+
# `DagProcessingLogs`) in CloudWatch Logs.
|
877
1052
|
# @return [Boolean]
|
878
1053
|
#
|
879
1054
|
# @!attribute [rw] log_level
|
880
|
-
# Defines the
|
881
|
-
#
|
1055
|
+
# Defines the Apache Airflow logs to send for the log type (e.g.
|
1056
|
+
# `DagProcessingLogs`) to CloudWatch Logs. Valid values: `CRITICAL`,
|
1057
|
+
# `ERROR`, `WARNING`, `INFO`.
|
882
1058
|
# @return [String]
|
883
1059
|
#
|
884
1060
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/ModuleLoggingConfiguration AWS API Documentation
|
@@ -891,9 +1067,9 @@ module Aws::MWAA
|
|
891
1067
|
include Aws::Structure
|
892
1068
|
end
|
893
1069
|
|
894
|
-
#
|
895
|
-
#
|
896
|
-
#
|
1070
|
+
# Defines the type of logs to send for the Apache Airflow log type (e.g.
|
1071
|
+
# `DagProcessingLogs`). Valid values: `CloudWatchLogGroupArn`,
|
1072
|
+
# `Enabled`, `LogLevel`.
|
897
1073
|
#
|
898
1074
|
# @note When making an API call, you may pass ModuleLoggingConfigurationInput
|
899
1075
|
# data as a hash:
|
@@ -904,12 +1080,14 @@ module Aws::MWAA
|
|
904
1080
|
# }
|
905
1081
|
#
|
906
1082
|
# @!attribute [rw] enabled
|
907
|
-
#
|
1083
|
+
# Indicates whether to enable the Apache Airflow log type (e.g.
|
1084
|
+
# `DagProcessingLogs`) in CloudWatch Logs.
|
908
1085
|
# @return [Boolean]
|
909
1086
|
#
|
910
1087
|
# @!attribute [rw] log_level
|
911
|
-
# Defines the
|
912
|
-
#
|
1088
|
+
# Defines the Apache Airflow logs to send for the log type (e.g.
|
1089
|
+
# `DagProcessingLogs`) to CloudWatch Logs. Valid values: `CRITICAL`,
|
1090
|
+
# `ERROR`, `WARNING`, `INFO`.
|
913
1091
|
# @return [String]
|
914
1092
|
#
|
915
1093
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/ModuleLoggingConfigurationInput AWS API Documentation
|
@@ -921,8 +1099,13 @@ module Aws::MWAA
|
|
921
1099
|
include Aws::Structure
|
922
1100
|
end
|
923
1101
|
|
924
|
-
#
|
925
|
-
#
|
1102
|
+
# The VPC networking components used to secure and enable network
|
1103
|
+
# traffic between the AWS resources for your environment. To learn more,
|
1104
|
+
# see [About networking on Amazon MWAA][1].
|
1105
|
+
#
|
1106
|
+
#
|
1107
|
+
#
|
1108
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html
|
926
1109
|
#
|
927
1110
|
# @note When making an API call, you may pass NetworkConfiguration
|
928
1111
|
# data as a hash:
|
@@ -933,13 +1116,20 @@ module Aws::MWAA
|
|
933
1116
|
# }
|
934
1117
|
#
|
935
1118
|
# @!attribute [rw] security_group_ids
|
936
|
-
# A
|
937
|
-
# VPC as the
|
1119
|
+
# A list of 1 or more security group IDs. Accepts up to 5 security
|
1120
|
+
# group IDs. A security group must be attached to the same VPC as the
|
1121
|
+
# subnets. To learn more, see [Security in your VPC on Amazon
|
1122
|
+
# MWAA][1].
|
1123
|
+
#
|
1124
|
+
#
|
1125
|
+
#
|
1126
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-security.html
|
938
1127
|
# @return [Array<String>]
|
939
1128
|
#
|
940
1129
|
# @!attribute [rw] subnet_ids
|
941
|
-
#
|
942
|
-
#
|
1130
|
+
# A list of 2 subnet IDs. **Required** to create an environment. Must
|
1131
|
+
# be private subnets in two different availability zones. A subnet
|
1132
|
+
# must be attached to the same VPC as the security group.
|
943
1133
|
# @return [Array<String>]
|
944
1134
|
#
|
945
1135
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/NetworkConfiguration AWS API Documentation
|
@@ -1063,11 +1253,19 @@ module Aws::MWAA
|
|
1063
1253
|
# }
|
1064
1254
|
#
|
1065
1255
|
# @!attribute [rw] resource_arn
|
1066
|
-
# The
|
1256
|
+
# The Amazon Resource Name (ARN) of the Amazon MWAA environment. For
|
1257
|
+
# example,
|
1258
|
+
# `arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment`.
|
1067
1259
|
# @return [String]
|
1068
1260
|
#
|
1069
1261
|
# @!attribute [rw] tags
|
1070
|
-
# The tag
|
1262
|
+
# The key-value tag pairs you want to associate to your environment.
|
1263
|
+
# For example, `"Environment": "Staging"`. To learn more, see [Tagging
|
1264
|
+
# AWS resources][1].
|
1265
|
+
#
|
1266
|
+
#
|
1267
|
+
#
|
1268
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1071
1269
|
# @return [Hash<String,String>]
|
1072
1270
|
#
|
1073
1271
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/TagResourceInput AWS API Documentation
|
@@ -1092,11 +1290,14 @@ module Aws::MWAA
|
|
1092
1290
|
# }
|
1093
1291
|
#
|
1094
1292
|
# @!attribute [rw] resource_arn
|
1095
|
-
# The
|
1293
|
+
# The Amazon Resource Name (ARN) of the Amazon MWAA environment. For
|
1294
|
+
# example,
|
1295
|
+
# `arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment`.
|
1096
1296
|
# @return [String]
|
1097
1297
|
#
|
1098
1298
|
# @!attribute [rw] tag_keys
|
1099
|
-
# The tag
|
1299
|
+
# The key-value tag pair you want to remove. For example,
|
1300
|
+
# `"Environment": "Staging"`.
|
1100
1301
|
# @return [Array<String>]
|
1101
1302
|
#
|
1102
1303
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/UntagResourceInput AWS API Documentation
|
@@ -1155,84 +1356,173 @@ module Aws::MWAA
|
|
1155
1356
|
# plugins_s3_path: "RelativePath",
|
1156
1357
|
# requirements_s3_object_version: "S3ObjectVersion",
|
1157
1358
|
# requirements_s3_path: "RelativePath",
|
1359
|
+
# schedulers: 1,
|
1158
1360
|
# source_bucket_arn: "S3BucketArn",
|
1159
1361
|
# webserver_access_mode: "PRIVATE_ONLY", # accepts PRIVATE_ONLY, PUBLIC_ONLY
|
1160
1362
|
# weekly_maintenance_window_start: "WeeklyMaintenanceWindowStart",
|
1161
1363
|
# }
|
1162
1364
|
#
|
1163
1365
|
# @!attribute [rw] airflow_configuration_options
|
1164
|
-
#
|
1165
|
-
# environment.
|
1366
|
+
# A list of key-value pairs containing the Apache Airflow
|
1367
|
+
# configuration options you want to attach to your environment. To
|
1368
|
+
# learn more, see [Apache Airflow configuration options][1].
|
1369
|
+
#
|
1370
|
+
#
|
1371
|
+
#
|
1372
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html
|
1166
1373
|
# @return [Hash<String,String>]
|
1167
1374
|
#
|
1168
1375
|
# @!attribute [rw] airflow_version
|
1169
|
-
# The Airflow
|
1376
|
+
# The Apache Airflow version for your environment. For example,
|
1377
|
+
# `v1.10.12`. If no value is specified, defaults to the latest
|
1378
|
+
# version. Valid values: `v1.10.12`.
|
1170
1379
|
# @return [String]
|
1171
1380
|
#
|
1172
1381
|
# @!attribute [rw] dag_s3_path
|
1173
|
-
# The
|
1382
|
+
# The relative path to the DAGs folder on your Amazon S3 bucket. For
|
1383
|
+
# example, `dags`. To learn more, see [Adding or updating DAGs][1].
|
1384
|
+
#
|
1385
|
+
#
|
1386
|
+
#
|
1387
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html
|
1174
1388
|
# @return [String]
|
1175
1389
|
#
|
1176
1390
|
# @!attribute [rw] environment_class
|
1177
|
-
# The
|
1391
|
+
# The environment class type. Valid values: `mw1.small`, `mw1.medium`,
|
1392
|
+
# `mw1.large`. To learn more, see [Amazon MWAA environment class][1].
|
1393
|
+
#
|
1394
|
+
#
|
1395
|
+
#
|
1396
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html
|
1178
1397
|
# @return [String]
|
1179
1398
|
#
|
1180
1399
|
# @!attribute [rw] execution_role_arn
|
1181
|
-
# The
|
1400
|
+
# The Amazon Resource Name (ARN) of the execution role in IAM that
|
1401
|
+
# allows MWAA to access AWS resources in your environment. For
|
1402
|
+
# example, `arn:aws:iam::123456789:role/my-execution-role`. To learn
|
1403
|
+
# more, see [Amazon MWAA Execution role][1].
|
1404
|
+
#
|
1405
|
+
#
|
1406
|
+
#
|
1407
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html
|
1182
1408
|
# @return [String]
|
1183
1409
|
#
|
1184
1410
|
# @!attribute [rw] logging_configuration
|
1185
|
-
#
|
1411
|
+
# Defines the Apache Airflow logs to send to CloudWatch Logs:
|
1412
|
+
# `DagProcessingLogs`, `SchedulerLogs`, `TaskLogs`, `WebserverLogs`,
|
1413
|
+
# `WorkerLogs`.
|
1186
1414
|
# @return [Types::LoggingConfigurationInput]
|
1187
1415
|
#
|
1188
1416
|
# @!attribute [rw] max_workers
|
1189
|
-
# The maximum number of workers to
|
1190
|
-
# environment.
|
1417
|
+
# The maximum number of workers that you want to run in your
|
1418
|
+
# environment. MWAA scales the number of Apache Airflow workers up to
|
1419
|
+
# the number you specify in the `MaxWorkers` field. For example, `20`.
|
1420
|
+
# When there are no more tasks running, and no more in the queue, MWAA
|
1421
|
+
# disposes of the extra workers leaving the one worker that is
|
1422
|
+
# included with your environment, or the number you specify in
|
1423
|
+
# `MinWorkers`.
|
1191
1424
|
# @return [Integer]
|
1192
1425
|
#
|
1193
1426
|
# @!attribute [rw] min_workers
|
1194
|
-
# The minimum number of workers to
|
1195
|
-
# environment.
|
1427
|
+
# The minimum number of workers that you want to run in your
|
1428
|
+
# environment. MWAA scales the number of Apache Airflow workers up to
|
1429
|
+
# the number you specify in the `MaxWorkers` field. When there are no
|
1430
|
+
# more tasks running, and no more in the queue, MWAA disposes of the
|
1431
|
+
# extra workers leaving the worker count you specify in the
|
1432
|
+
# `MinWorkers` field. For example, `2`.
|
1196
1433
|
# @return [Integer]
|
1197
1434
|
#
|
1198
1435
|
# @!attribute [rw] name
|
1199
|
-
# The name of your Amazon MWAA environment
|
1436
|
+
# The name of your Amazon MWAA environment. For example,
|
1437
|
+
# `MyMWAAEnvironment`.
|
1200
1438
|
# @return [String]
|
1201
1439
|
#
|
1202
1440
|
# @!attribute [rw] network_configuration
|
1203
|
-
# The
|
1441
|
+
# The VPC networking components used to secure and enable network
|
1442
|
+
# traffic between the AWS resources for your environment. To learn
|
1443
|
+
# more, see [About networking on Amazon MWAA][1].
|
1444
|
+
#
|
1445
|
+
#
|
1446
|
+
#
|
1447
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html
|
1204
1448
|
# @return [Types::UpdateNetworkConfigurationInput]
|
1205
1449
|
#
|
1206
1450
|
# @!attribute [rw] plugins_s3_object_version
|
1207
|
-
# The
|
1208
|
-
#
|
1451
|
+
# The version of the plugins.zip file on your Amazon S3 bucket. A
|
1452
|
+
# version must be specified each time a plugins.zip file is updated.
|
1453
|
+
# To learn more, see [How S3 Versioning works][1].
|
1454
|
+
#
|
1455
|
+
#
|
1456
|
+
#
|
1457
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html
|
1209
1458
|
# @return [String]
|
1210
1459
|
#
|
1211
1460
|
# @!attribute [rw] plugins_s3_path
|
1212
|
-
# The
|
1461
|
+
# The relative path to the `plugins.zip` file on your Amazon S3
|
1462
|
+
# bucket. For example, `plugins.zip`. If specified, then the
|
1463
|
+
# plugins.zip version is required. To learn more, see [Installing
|
1464
|
+
# custom plugins][1].
|
1465
|
+
#
|
1466
|
+
#
|
1467
|
+
#
|
1468
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html
|
1213
1469
|
# @return [String]
|
1214
1470
|
#
|
1215
1471
|
# @!attribute [rw] requirements_s3_object_version
|
1216
|
-
# The
|
1217
|
-
#
|
1472
|
+
# The version of the requirements.txt file on your Amazon S3 bucket. A
|
1473
|
+
# version must be specified each time a requirements.txt file is
|
1474
|
+
# updated. To learn more, see [How S3 Versioning works][1].
|
1475
|
+
#
|
1476
|
+
#
|
1477
|
+
#
|
1478
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html
|
1218
1479
|
# @return [String]
|
1219
1480
|
#
|
1220
1481
|
# @!attribute [rw] requirements_s3_path
|
1221
|
-
# The
|
1222
|
-
#
|
1482
|
+
# The relative path to the `requirements.txt` file on your Amazon S3
|
1483
|
+
# bucket. For example, `requirements.txt`. If specified, then a file
|
1484
|
+
# version is required. To learn more, see [Installing Python
|
1485
|
+
# dependencies][1].
|
1486
|
+
#
|
1487
|
+
#
|
1488
|
+
#
|
1489
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html
|
1223
1490
|
# @return [String]
|
1224
1491
|
#
|
1492
|
+
# @!attribute [rw] schedulers
|
1493
|
+
# The number of Apache Airflow schedulers to run in your Amazon MWAA
|
1494
|
+
# environment.
|
1495
|
+
# @return [Integer]
|
1496
|
+
#
|
1225
1497
|
# @!attribute [rw] source_bucket_arn
|
1226
|
-
# The
|
1498
|
+
# The Amazon Resource Name (ARN) of the Amazon S3 bucket where your
|
1499
|
+
# DAG code and supporting files are stored. For example,
|
1500
|
+
# `arn:aws:s3:::my-airflow-bucket-unique-name`. To learn more, see
|
1501
|
+
# [Create an Amazon S3 bucket for Amazon MWAA][1].
|
1502
|
+
#
|
1503
|
+
#
|
1504
|
+
#
|
1505
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html
|
1227
1506
|
# @return [String]
|
1228
1507
|
#
|
1229
1508
|
# @!attribute [rw] webserver_access_mode
|
1230
|
-
# The
|
1509
|
+
# The Apache Airflow *Web server* access mode. To learn more, see
|
1510
|
+
# [Apache Airflow access modes][1].
|
1511
|
+
#
|
1512
|
+
#
|
1513
|
+
#
|
1514
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html
|
1231
1515
|
# @return [String]
|
1232
1516
|
#
|
1233
1517
|
# @!attribute [rw] weekly_maintenance_window_start
|
1234
|
-
# The
|
1235
|
-
# environment
|
1518
|
+
# The day and time of the week to start weekly maintenance updates of
|
1519
|
+
# your environment in the following format: `DAY:HH:MM`. For example:
|
1520
|
+
# `TUE:03:30`. You can specify a start time in 30 minute increments
|
1521
|
+
# only. Supported input includes the following:
|
1522
|
+
#
|
1523
|
+
# * MON\|TUE\|WED\|THU\|FRI\|SAT\|SUN:(\[01\]\\\\d\|2\[0-3\]):(00\|30)
|
1524
|
+
#
|
1525
|
+
# ^
|
1236
1526
|
# @return [String]
|
1237
1527
|
#
|
1238
1528
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/UpdateEnvironmentInput AWS API Documentation
|
@@ -1252,6 +1542,7 @@ module Aws::MWAA
|
|
1252
1542
|
:plugins_s3_path,
|
1253
1543
|
:requirements_s3_object_version,
|
1254
1544
|
:requirements_s3_path,
|
1545
|
+
:schedulers,
|
1255
1546
|
:source_bucket_arn,
|
1256
1547
|
:webserver_access_mode,
|
1257
1548
|
:weekly_maintenance_window_start)
|
@@ -1260,7 +1551,9 @@ module Aws::MWAA
|
|
1260
1551
|
end
|
1261
1552
|
|
1262
1553
|
# @!attribute [rw] arn
|
1263
|
-
# The
|
1554
|
+
# The Amazon Resource Name (ARN) of the Amazon MWAA environment. For
|
1555
|
+
# example,
|
1556
|
+
# `arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment`.
|
1264
1557
|
# @return [String]
|
1265
1558
|
#
|
1266
1559
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/UpdateEnvironmentOutput AWS API Documentation
|
@@ -1271,14 +1564,15 @@ module Aws::MWAA
|
|
1271
1564
|
include Aws::Structure
|
1272
1565
|
end
|
1273
1566
|
|
1274
|
-
#
|
1567
|
+
# An object containing the error encountered with the last update:
|
1568
|
+
# `ErrorCode`, `ErrorMessage`.
|
1275
1569
|
#
|
1276
1570
|
# @!attribute [rw] error_code
|
1277
|
-
#
|
1571
|
+
# The error code that corresponds to the error with the last update.
|
1278
1572
|
# @return [String]
|
1279
1573
|
#
|
1280
1574
|
# @!attribute [rw] error_message
|
1281
|
-
#
|
1575
|
+
# The error message that corresponds to the error code.
|
1282
1576
|
# @return [String]
|
1283
1577
|
#
|
1284
1578
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/UpdateError AWS API Documentation
|
@@ -1290,8 +1584,13 @@ module Aws::MWAA
|
|
1290
1584
|
include Aws::Structure
|
1291
1585
|
end
|
1292
1586
|
|
1293
|
-
#
|
1294
|
-
#
|
1587
|
+
# The VPC networking components used to secure and enable network
|
1588
|
+
# traffic between the AWS resources for your environment. To learn more,
|
1589
|
+
# see [About networking on Amazon MWAA][1].
|
1590
|
+
#
|
1591
|
+
#
|
1592
|
+
#
|
1593
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html
|
1295
1594
|
#
|
1296
1595
|
# @note When making an API call, you may pass UpdateNetworkConfigurationInput
|
1297
1596
|
# data as a hash:
|
@@ -1301,8 +1600,14 @@ module Aws::MWAA
|
|
1301
1600
|
# }
|
1302
1601
|
#
|
1303
1602
|
# @!attribute [rw] security_group_ids
|
1304
|
-
#
|
1305
|
-
# same VPC as the
|
1603
|
+
# A list of 1 or more security group IDs. Accepts up to 5 security
|
1604
|
+
# group IDs. A security group must be attached to the same VPC as the
|
1605
|
+
# subnets. To learn more, see [Security in your VPC on Amazon
|
1606
|
+
# MWAA][1].
|
1607
|
+
#
|
1608
|
+
#
|
1609
|
+
#
|
1610
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-security.html
|
1306
1611
|
# @return [Array<String>]
|
1307
1612
|
#
|
1308
1613
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/UpdateNetworkConfigurationInput AWS API Documentation
|