@robhan-cdk-lib/aws_mwaa 0.0.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.
- package/.jsii +7679 -0
- package/API.md +3319 -0
- package/LICENSE +19 -0
- package/README.md +54 -0
- package/lib/environment-base.d.ts +462 -0
- package/lib/environment-base.js +53 -0
- package/lib/environment.d.ts +533 -0
- package/lib/environment.js +230 -0
- package/lib/index.d.ts +2 -0
- package/lib/index.js +19 -0
- package/lib/validation/environment-base.d.ts +18 -0
- package/lib/validation/environment-base.js +350 -0
- package/package.json +155 -0
|
@@ -0,0 +1,533 @@
|
|
|
1
|
+
import { IRole } from 'aws-cdk-lib/aws-iam';
|
|
2
|
+
import { IKey } from 'aws-cdk-lib/aws-kms';
|
|
3
|
+
import { IBucket } from 'aws-cdk-lib/aws-s3';
|
|
4
|
+
import { Construct } from 'constructs';
|
|
5
|
+
import { AirflowVersion, EndpointManagement, EnvironmentBase, EnvironmentClass, IEnvironment, LoggingConfiguration, NetworkConfiguration, WebserverAccessMode } from './environment-base';
|
|
6
|
+
/**
|
|
7
|
+
* Properties for creating an Amazon Managed Workflows for Apache Airflow Environment.
|
|
8
|
+
*/
|
|
9
|
+
export interface EnvironmentProps {
|
|
10
|
+
/**
|
|
11
|
+
* A list of key-value pairs containing the Airflow configuration options for your environment. For example, core.default_timezone: utc.
|
|
12
|
+
*/
|
|
13
|
+
readonly airflowConfigurationOptions: {
|
|
14
|
+
[key: string]: string;
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* The version of Apache Airflow to use for the environment. If no value is specified, defaults to the latest version.
|
|
18
|
+
*
|
|
19
|
+
* If you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect.
|
|
20
|
+
*/
|
|
21
|
+
readonly airflowVersion?: AirflowVersion;
|
|
22
|
+
/**
|
|
23
|
+
* The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags.
|
|
24
|
+
*/
|
|
25
|
+
readonly dagS3Path?: string;
|
|
26
|
+
/**
|
|
27
|
+
* Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
|
|
28
|
+
* If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC.
|
|
29
|
+
* If set to CUSTOMER, you must create, and manage, the VPC endpoints in your VPC.
|
|
30
|
+
*/
|
|
31
|
+
readonly endpointManagement?: EndpointManagement;
|
|
32
|
+
/**
|
|
33
|
+
* The environment class type.
|
|
34
|
+
*/
|
|
35
|
+
readonly environmentClass?: EnvironmentClass;
|
|
36
|
+
/**
|
|
37
|
+
* The execution role in IAM that allows MWAA to access AWS resources in your environment.
|
|
38
|
+
*/
|
|
39
|
+
readonly executionRole?: IRole;
|
|
40
|
+
/**
|
|
41
|
+
* The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
|
|
42
|
+
* You can use an AWS KMS key managed by MWAA, or a customer-managed KMS key (advanced).
|
|
43
|
+
*/
|
|
44
|
+
readonly kmsKey?: IKey;
|
|
45
|
+
/**
|
|
46
|
+
* The Apache Airflow logs being sent to CloudWatch Logs.
|
|
47
|
+
*/
|
|
48
|
+
readonly loggingConfiguration?: LoggingConfiguration;
|
|
49
|
+
/**
|
|
50
|
+
* The maximum number of web servers that you want to run in your environment.
|
|
51
|
+
* Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache
|
|
52
|
+
* Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network
|
|
53
|
+
* calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to
|
|
54
|
+
* the number set in MaxWebserers. As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in
|
|
55
|
+
* MinxWebserers.
|
|
56
|
+
*
|
|
57
|
+
* Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro,
|
|
58
|
+
* which defaults to 1.
|
|
59
|
+
*/
|
|
60
|
+
readonly maxWebservers?: number;
|
|
61
|
+
/**
|
|
62
|
+
* The maximum number of workers that you want to run in your environment.
|
|
63
|
+
* MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. For example, 20. When there are no more
|
|
64
|
+
* tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or
|
|
65
|
+
* the number you specify in MinWorkers.
|
|
66
|
+
*/
|
|
67
|
+
readonly maxWorkers?: number;
|
|
68
|
+
/**
|
|
69
|
+
* The minimum number of web servers that you want to run in your environment.
|
|
70
|
+
* Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache
|
|
71
|
+
* Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load,
|
|
72
|
+
* decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.
|
|
73
|
+
*
|
|
74
|
+
* Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro,
|
|
75
|
+
* which defaults to 1.
|
|
76
|
+
*/
|
|
77
|
+
readonly minWebservers?: number;
|
|
78
|
+
/**
|
|
79
|
+
* The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you
|
|
80
|
+
* specify in the MaxWorkers field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving
|
|
81
|
+
* the worker count you specify in the MinWorkers field. For example, 2.
|
|
82
|
+
*/
|
|
83
|
+
readonly minWorkers?: number;
|
|
84
|
+
/**
|
|
85
|
+
* The name of your Amazon MWAA environment.
|
|
86
|
+
*/
|
|
87
|
+
readonly name: string;
|
|
88
|
+
/**
|
|
89
|
+
* The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
|
|
90
|
+
*/
|
|
91
|
+
readonly networkConfiguration?: NetworkConfiguration;
|
|
92
|
+
/**
|
|
93
|
+
* The version of the plugins.zip file on your Amazon S3 bucket.
|
|
94
|
+
*/
|
|
95
|
+
readonly pluginsS3ObjectVersion?: string;
|
|
96
|
+
/**
|
|
97
|
+
* The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip.
|
|
98
|
+
*/
|
|
99
|
+
readonly pluginsS3Path?: string;
|
|
100
|
+
/**
|
|
101
|
+
* The version of the requirements.txt file on your Amazon S3 bucket.
|
|
102
|
+
*/
|
|
103
|
+
readonly requirementsS3ObjectVersion?: string;
|
|
104
|
+
/**
|
|
105
|
+
* The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt.
|
|
106
|
+
*/
|
|
107
|
+
readonly requirementsS3Path?: string;
|
|
108
|
+
/**
|
|
109
|
+
* The number of schedulers that you want to run in your environment.
|
|
110
|
+
*
|
|
111
|
+
* Valid values:
|
|
112
|
+
* v2 - For environments larger than mw1.micro, accepts values from 2 to 5.
|
|
113
|
+
* Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
|
|
114
|
+
* v1 - Accepts 1.
|
|
115
|
+
*/
|
|
116
|
+
readonly schedulers?: number;
|
|
117
|
+
/**
|
|
118
|
+
* The Amazon S3 bucket where your DAG code and supporting files are stored.
|
|
119
|
+
*/
|
|
120
|
+
readonly sourceBucket?: IBucket;
|
|
121
|
+
/**
|
|
122
|
+
* The version of the startup shell script in your Amazon S3 bucket.
|
|
123
|
+
* You must specify the version ID that Amazon S3 assigns to the file every time you update the script.
|
|
124
|
+
* Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long.
|
|
125
|
+
*
|
|
126
|
+
* The following is an example:
|
|
127
|
+
* 3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
|
|
128
|
+
*/
|
|
129
|
+
readonly startupScriptS3ObjectVersion?: string;
|
|
130
|
+
/**
|
|
131
|
+
* The relative path to the startup shell script in your Amazon S3 bucket.
|
|
132
|
+
* For example, s3://mwaa-environment/startup.sh.
|
|
133
|
+
* Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process.
|
|
134
|
+
* You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables.
|
|
135
|
+
*/
|
|
136
|
+
readonly startupScriptS3Path?: string;
|
|
137
|
+
/**
|
|
138
|
+
* The Apache Airflow Web server access mode.
|
|
139
|
+
*/
|
|
140
|
+
readonly webserverAccessMode?: WebserverAccessMode;
|
|
141
|
+
/**
|
|
142
|
+
* The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM.
|
|
143
|
+
* For example: TUE:03:30. You can specify a start time in 30 minute increments only.
|
|
144
|
+
*
|
|
145
|
+
* Supported input includes the following:
|
|
146
|
+
* MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)
|
|
147
|
+
*/
|
|
148
|
+
readonly weeklyMaintenanceWindowStart?: string;
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* Properties for importing an Amazon Managed Workflows for Apache Airflow Environment.
|
|
152
|
+
*/
|
|
153
|
+
export interface EnvironmentAttributes {
|
|
154
|
+
/**
|
|
155
|
+
* A list of key-value pairs containing the Airflow configuration options for your environment. For example, core.default_timezone: utc.
|
|
156
|
+
*/
|
|
157
|
+
readonly airflowConfigurationOptions: {
|
|
158
|
+
[key: string]: string;
|
|
159
|
+
};
|
|
160
|
+
/**
|
|
161
|
+
* The version of Apache Airflow to use for the environment. If no value is specified, defaults to the latest version.
|
|
162
|
+
*
|
|
163
|
+
* If you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect.
|
|
164
|
+
*/
|
|
165
|
+
readonly airflowVersion?: AirflowVersion;
|
|
166
|
+
/**
|
|
167
|
+
* The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags.
|
|
168
|
+
*/
|
|
169
|
+
readonly dagS3Path?: string;
|
|
170
|
+
/**
|
|
171
|
+
* Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
|
|
172
|
+
* If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC.
|
|
173
|
+
* If set to CUSTOMER, you must create, and manage, the VPC endpoints in your VPC.
|
|
174
|
+
*/
|
|
175
|
+
readonly endpointManagement?: EndpointManagement;
|
|
176
|
+
/**
|
|
177
|
+
* The environment class type.
|
|
178
|
+
*/
|
|
179
|
+
readonly environmentClass?: EnvironmentClass;
|
|
180
|
+
/**
|
|
181
|
+
* The execution role in IAM that allows MWAA to access AWS resources in your environment.
|
|
182
|
+
*/
|
|
183
|
+
readonly executionRole?: IRole;
|
|
184
|
+
/**
|
|
185
|
+
* The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
|
|
186
|
+
* You can use an AWS KMS key managed by MWAA, or a customer-managed KMS key (advanced).
|
|
187
|
+
*/
|
|
188
|
+
readonly kmsKey?: IKey;
|
|
189
|
+
/**
|
|
190
|
+
* The Apache Airflow logs being sent to CloudWatch Logs.
|
|
191
|
+
*/
|
|
192
|
+
readonly loggingConfiguration?: LoggingConfiguration;
|
|
193
|
+
/**
|
|
194
|
+
* The maximum number of web servers that you want to run in your environment.
|
|
195
|
+
* Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache
|
|
196
|
+
* Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network
|
|
197
|
+
* calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to
|
|
198
|
+
* the number set in MaxWebserers. As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in
|
|
199
|
+
* MinxWebserers.
|
|
200
|
+
*
|
|
201
|
+
* Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro,
|
|
202
|
+
* which defaults to 1.
|
|
203
|
+
*/
|
|
204
|
+
readonly maxWebservers?: number;
|
|
205
|
+
/**
|
|
206
|
+
* The maximum number of workers that you want to run in your environment.
|
|
207
|
+
* MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. For example, 20. When there are no more
|
|
208
|
+
* tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or
|
|
209
|
+
* the number you specify in MinWorkers.
|
|
210
|
+
*/
|
|
211
|
+
readonly maxWorkers?: number;
|
|
212
|
+
/**
|
|
213
|
+
* The minimum number of web servers that you want to run in your environment.
|
|
214
|
+
* Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache
|
|
215
|
+
* Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load,
|
|
216
|
+
* decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.
|
|
217
|
+
*
|
|
218
|
+
* Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro,
|
|
219
|
+
* which defaults to 1.
|
|
220
|
+
*/
|
|
221
|
+
readonly minWebservers?: number;
|
|
222
|
+
/**
|
|
223
|
+
* The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you
|
|
224
|
+
* specify in the MaxWorkers field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving
|
|
225
|
+
* the worker count you specify in the MinWorkers field. For example, 2.
|
|
226
|
+
*/
|
|
227
|
+
readonly minWorkers?: number;
|
|
228
|
+
/**
|
|
229
|
+
* The name of your Amazon MWAA environment.
|
|
230
|
+
*/
|
|
231
|
+
readonly name: string;
|
|
232
|
+
/**
|
|
233
|
+
* The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
|
|
234
|
+
*/
|
|
235
|
+
readonly networkConfiguration?: NetworkConfiguration;
|
|
236
|
+
/**
|
|
237
|
+
* The version of the plugins.zip file on your Amazon S3 bucket.
|
|
238
|
+
*/
|
|
239
|
+
readonly pluginsS3ObjectVersion?: string;
|
|
240
|
+
/**
|
|
241
|
+
* The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip.
|
|
242
|
+
*/
|
|
243
|
+
readonly pluginsS3Path?: string;
|
|
244
|
+
/**
|
|
245
|
+
* The version of the requirements.txt file on your Amazon S3 bucket.
|
|
246
|
+
*/
|
|
247
|
+
readonly requirementsS3ObjectVersion?: string;
|
|
248
|
+
/**
|
|
249
|
+
* The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt.
|
|
250
|
+
*/
|
|
251
|
+
readonly requirementsS3Path?: string;
|
|
252
|
+
/**
|
|
253
|
+
* The number of schedulers that you want to run in your environment.
|
|
254
|
+
*
|
|
255
|
+
* Valid values:
|
|
256
|
+
* v2 - For environments larger than mw1.micro, accepts values from 2 to 5.
|
|
257
|
+
* Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
|
|
258
|
+
* v1 - Accepts 1.
|
|
259
|
+
*/
|
|
260
|
+
readonly schedulers?: number;
|
|
261
|
+
/**
|
|
262
|
+
* The Amazon S3 bucket where your DAG code and supporting files are stored.
|
|
263
|
+
*/
|
|
264
|
+
readonly sourceBucket?: IBucket;
|
|
265
|
+
/**
|
|
266
|
+
* The version of the startup shell script in your Amazon S3 bucket.
|
|
267
|
+
* You must specify the version ID that Amazon S3 assigns to the file every time you update the script.
|
|
268
|
+
* Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long.
|
|
269
|
+
*
|
|
270
|
+
* The following is an example:
|
|
271
|
+
* 3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
|
|
272
|
+
*/
|
|
273
|
+
readonly startupScriptS3ObjectVersion?: string;
|
|
274
|
+
/**
|
|
275
|
+
* The relative path to the startup shell script in your Amazon S3 bucket.
|
|
276
|
+
* For example, s3://mwaa-environment/startup.sh.
|
|
277
|
+
* Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process.
|
|
278
|
+
* You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables.
|
|
279
|
+
*/
|
|
280
|
+
readonly startupScriptS3Path?: string;
|
|
281
|
+
/**
|
|
282
|
+
* The Apache Airflow Web server access mode.
|
|
283
|
+
*/
|
|
284
|
+
readonly webserverAccessMode?: WebserverAccessMode;
|
|
285
|
+
/**
|
|
286
|
+
* The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM.
|
|
287
|
+
* For example: TUE:03:30. You can specify a start time in 30 minute increments only.
|
|
288
|
+
*
|
|
289
|
+
* Supported input includes the following:
|
|
290
|
+
* MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)
|
|
291
|
+
*/
|
|
292
|
+
readonly weeklyMaintenanceWindowStart?: string;
|
|
293
|
+
/**
|
|
294
|
+
* The ARN for the Amazon MWAA environment.
|
|
295
|
+
*/
|
|
296
|
+
readonly environmentArn: string;
|
|
297
|
+
/**
|
|
298
|
+
* The queue ARN for the environment's Celery Executor. Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers.
|
|
299
|
+
* When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.
|
|
300
|
+
*/
|
|
301
|
+
readonly celeryExecutorQueue?: string;
|
|
302
|
+
/**
|
|
303
|
+
* The VPC endpoint for the environment's Amazon RDS database.
|
|
304
|
+
*/
|
|
305
|
+
readonly databaseVpcEndpointService?: string;
|
|
306
|
+
/**
|
|
307
|
+
* The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published.
|
|
308
|
+
*/
|
|
309
|
+
readonly loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn?: string;
|
|
310
|
+
/**
|
|
311
|
+
* The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published.
|
|
312
|
+
*/
|
|
313
|
+
readonly loggingConfigurationSchedulerLogsCloudWatchLogGroupArn?: string;
|
|
314
|
+
/**
|
|
315
|
+
* The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published.
|
|
316
|
+
*/
|
|
317
|
+
readonly loggingConfigurationTaskLogsCloudWatchLogGroupArn?: string;
|
|
318
|
+
/**
|
|
319
|
+
* The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published.
|
|
320
|
+
*/
|
|
321
|
+
readonly loggingConfigurationWebserverLogsCloudWatchLogGroupArn?: string;
|
|
322
|
+
/**
|
|
323
|
+
* The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published.
|
|
324
|
+
*/
|
|
325
|
+
readonly loggingConfigurationWorkerLogsCloudWatchLogGroupArn?: string;
|
|
326
|
+
/**
|
|
327
|
+
* The URL of your Apache Airflow UI.
|
|
328
|
+
*/
|
|
329
|
+
readonly webserverUrl?: string;
|
|
330
|
+
/**
|
|
331
|
+
* The VPC endpoint for the environment's web server.
|
|
332
|
+
*/
|
|
333
|
+
readonly webserverVpcEndpointService?: string;
|
|
334
|
+
}
|
|
335
|
+
export declare class Environment extends EnvironmentBase {
|
|
336
|
+
static isEnvironment(x: any): x is Environment;
|
|
337
|
+
static fromEnvironmentAttributes(scope: Construct, id: string, attrs: EnvironmentAttributes): IEnvironment;
|
|
338
|
+
/**
|
|
339
|
+
* Validates all environment properties.
|
|
340
|
+
*
|
|
341
|
+
* @param props - The environment properties to validate
|
|
342
|
+
* @returns An array of error messages if validation fails, or an empty array if valid
|
|
343
|
+
*
|
|
344
|
+
* This method aggregates validation results from all individual property validators.
|
|
345
|
+
* It throws an error if props is not an object.
|
|
346
|
+
*/
|
|
347
|
+
private static validateProps;
|
|
348
|
+
/**
|
|
349
|
+
* A list of key-value pairs containing the Airflow configuration options for your environment. For example, core.default_timezone: utc.
|
|
350
|
+
*/
|
|
351
|
+
readonly airflowConfigurationOptions: {
|
|
352
|
+
[key: string]: string;
|
|
353
|
+
};
|
|
354
|
+
/**
|
|
355
|
+
* The version of Apache Airflow to use for the environment. If no value is specified, defaults to the latest version.
|
|
356
|
+
*
|
|
357
|
+
* If you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect.
|
|
358
|
+
*/
|
|
359
|
+
readonly airflowVersion?: AirflowVersion;
|
|
360
|
+
/**
|
|
361
|
+
* The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags.
|
|
362
|
+
*/
|
|
363
|
+
readonly dagS3Path?: string;
|
|
364
|
+
/**
|
|
365
|
+
* Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
|
|
366
|
+
* If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC.
|
|
367
|
+
* If set to CUSTOMER, you must create, and manage, the VPC endpoints in your VPC.
|
|
368
|
+
*/
|
|
369
|
+
readonly endpointManagement?: EndpointManagement;
|
|
370
|
+
/**
|
|
371
|
+
* The environment class type.
|
|
372
|
+
*/
|
|
373
|
+
readonly environmentClass?: EnvironmentClass;
|
|
374
|
+
/**
|
|
375
|
+
* The execution role in IAM that allows MWAA to access AWS resources in your environment.
|
|
376
|
+
*/
|
|
377
|
+
readonly executionRole?: IRole;
|
|
378
|
+
/**
|
|
379
|
+
* The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
|
|
380
|
+
* You can use an AWS KMS key managed by MWAA, or a customer-managed KMS key (advanced).
|
|
381
|
+
*/
|
|
382
|
+
readonly kmsKey?: IKey;
|
|
383
|
+
/**
|
|
384
|
+
* The Apache Airflow logs being sent to CloudWatch Logs.
|
|
385
|
+
*/
|
|
386
|
+
readonly loggingConfiguration?: LoggingConfiguration;
|
|
387
|
+
/**
|
|
388
|
+
* The maximum number of web servers that you want to run in your environment.
|
|
389
|
+
* Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache
|
|
390
|
+
* Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network
|
|
391
|
+
* calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to
|
|
392
|
+
* the number set in MaxWebserers. As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in
|
|
393
|
+
* MinxWebserers.
|
|
394
|
+
*
|
|
395
|
+
* Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro,
|
|
396
|
+
* which defaults to 1.
|
|
397
|
+
*/
|
|
398
|
+
readonly maxWebservers?: number;
|
|
399
|
+
/**
|
|
400
|
+
* The maximum number of workers that you want to run in your environment.
|
|
401
|
+
* MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. For example, 20. When there are no more
|
|
402
|
+
* tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or
|
|
403
|
+
* the number you specify in MinWorkers.
|
|
404
|
+
*/
|
|
405
|
+
readonly maxWorkers?: number;
|
|
406
|
+
/**
|
|
407
|
+
* The minimum number of web servers that you want to run in your environment.
|
|
408
|
+
* Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache
|
|
409
|
+
* Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load,
|
|
410
|
+
* decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.
|
|
411
|
+
*
|
|
412
|
+
* Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro,
|
|
413
|
+
* which defaults to 1.
|
|
414
|
+
*/
|
|
415
|
+
readonly minWebservers?: number;
|
|
416
|
+
/**
|
|
417
|
+
* The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you
|
|
418
|
+
* specify in the MaxWorkers field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving
|
|
419
|
+
* the worker count you specify in the MinWorkers field. For example, 2.
|
|
420
|
+
*/
|
|
421
|
+
readonly minWorkers?: number;
|
|
422
|
+
/**
|
|
423
|
+
* The name of your Amazon MWAA environment.
|
|
424
|
+
*/
|
|
425
|
+
readonly name: string;
|
|
426
|
+
/**
|
|
427
|
+
* The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
|
|
428
|
+
*/
|
|
429
|
+
readonly networkConfiguration?: NetworkConfiguration;
|
|
430
|
+
/**
|
|
431
|
+
* The version of the plugins.zip file on your Amazon S3 bucket.
|
|
432
|
+
*/
|
|
433
|
+
readonly pluginsS3ObjectVersion?: string;
|
|
434
|
+
/**
|
|
435
|
+
* The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip.
|
|
436
|
+
*/
|
|
437
|
+
readonly pluginsS3Path?: string;
|
|
438
|
+
/**
|
|
439
|
+
* The version of the requirements.txt file on your Amazon S3 bucket.
|
|
440
|
+
*/
|
|
441
|
+
readonly requirementsS3ObjectVersion?: string;
|
|
442
|
+
/**
|
|
443
|
+
* The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt.
|
|
444
|
+
*/
|
|
445
|
+
readonly requirementsS3Path?: string;
|
|
446
|
+
/**
|
|
447
|
+
* The number of schedulers that you want to run in your environment.
|
|
448
|
+
*
|
|
449
|
+
* Valid values:
|
|
450
|
+
* v2 - For environments larger than mw1.micro, accepts values from 2 to 5.
|
|
451
|
+
* Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
|
|
452
|
+
* v1 - Accepts 1.
|
|
453
|
+
*/
|
|
454
|
+
readonly schedulers?: number;
|
|
455
|
+
/**
|
|
456
|
+
* The Amazon S3 bucket where your DAG code and supporting files are stored.
|
|
457
|
+
*/
|
|
458
|
+
readonly sourceBucket?: IBucket;
|
|
459
|
+
/**
|
|
460
|
+
* The version of the startup shell script in your Amazon S3 bucket.
|
|
461
|
+
* You must specify the version ID that Amazon S3 assigns to the file every time you update the script.
|
|
462
|
+
* Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long.
|
|
463
|
+
*
|
|
464
|
+
* The following is an example:
|
|
465
|
+
* 3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
|
|
466
|
+
*/
|
|
467
|
+
readonly startupScriptS3ObjectVersion?: string;
|
|
468
|
+
/**
|
|
469
|
+
* The relative path to the startup shell script in your Amazon S3 bucket.
|
|
470
|
+
* For example, s3://mwaa-environment/startup.sh.
|
|
471
|
+
* Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process.
|
|
472
|
+
* You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables.
|
|
473
|
+
*/
|
|
474
|
+
readonly startupScriptS3Path?: string;
|
|
475
|
+
/**
|
|
476
|
+
* The Apache Airflow Web server access mode.
|
|
477
|
+
*/
|
|
478
|
+
readonly webserverAccessMode?: WebserverAccessMode;
|
|
479
|
+
/**
|
|
480
|
+
* The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM.
|
|
481
|
+
* For example: TUE:03:30. You can specify a start time in 30 minute increments only.
|
|
482
|
+
*
|
|
483
|
+
* Supported input includes the following:
|
|
484
|
+
* MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)
|
|
485
|
+
*/
|
|
486
|
+
readonly weeklyMaintenanceWindowStart?: string;
|
|
487
|
+
/**
|
|
488
|
+
* The ARN for the Amazon MWAA environment.
|
|
489
|
+
*/
|
|
490
|
+
readonly environmentArn: string;
|
|
491
|
+
/**
|
|
492
|
+
* The queue ARN for the environment's Celery Executor. Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers.
|
|
493
|
+
* When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.
|
|
494
|
+
*/
|
|
495
|
+
readonly celeryExecutorQueue?: string;
|
|
496
|
+
/**
|
|
497
|
+
* The VPC endpoint for the environment's Amazon RDS database.
|
|
498
|
+
*/
|
|
499
|
+
readonly databaseVpcEndpointService?: string;
|
|
500
|
+
/**
|
|
501
|
+
* The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published.
|
|
502
|
+
*/
|
|
503
|
+
readonly loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn?: string;
|
|
504
|
+
/**
|
|
505
|
+
* The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published.
|
|
506
|
+
*/
|
|
507
|
+
readonly loggingConfigurationSchedulerLogsCloudWatchLogGroupArn?: string;
|
|
508
|
+
/**
|
|
509
|
+
* The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published.
|
|
510
|
+
*/
|
|
511
|
+
readonly loggingConfigurationTaskLogsCloudWatchLogGroupArn?: string;
|
|
512
|
+
/**
|
|
513
|
+
* The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published.
|
|
514
|
+
*/
|
|
515
|
+
readonly loggingConfigurationWebserverLogsCloudWatchLogGroupArn?: string;
|
|
516
|
+
/**
|
|
517
|
+
* The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published.
|
|
518
|
+
*/
|
|
519
|
+
readonly loggingConfigurationWorkerLogsCloudWatchLogGroupArn?: string;
|
|
520
|
+
/**
|
|
521
|
+
* The URL of your Apache Airflow UI.
|
|
522
|
+
*/
|
|
523
|
+
readonly webserverUrl?: string;
|
|
524
|
+
/**
|
|
525
|
+
* The VPC endpoint for the environment's web server.
|
|
526
|
+
*/
|
|
527
|
+
readonly webserverVpcEndpointService?: string;
|
|
528
|
+
/**
|
|
529
|
+
* The underlying CloudFormation resource.
|
|
530
|
+
*/
|
|
531
|
+
private readonly environment;
|
|
532
|
+
constructor(scope: Construct, id: string, props: EnvironmentProps);
|
|
533
|
+
}
|