@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
package/API.md
ADDED
|
@@ -0,0 +1,3319 @@
|
|
|
1
|
+
# API Reference <a name="API Reference" id="api-reference"></a>
|
|
2
|
+
|
|
3
|
+
## Constructs <a name="Constructs" id="Constructs"></a>
|
|
4
|
+
|
|
5
|
+
### Environment <a name="Environment" id="@robhan-cdk-lib/aws_mwaa.Environment"></a>
|
|
6
|
+
|
|
7
|
+
#### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_mwaa.Environment.Initializer"></a>
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
import { Environment } from '@robhan-cdk-lib/aws_mwaa'
|
|
11
|
+
|
|
12
|
+
new Environment(scope: Construct, id: string, props: EnvironmentProps)
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
| **Name** | **Type** | **Description** |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
18
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
19
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.Initializer.parameter.props">props</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps">EnvironmentProps</a></code> | *No description.* |
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_mwaa.Environment.Initializer.parameter.scope"></a>
|
|
24
|
+
|
|
25
|
+
- *Type:* constructs.Construct
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_mwaa.Environment.Initializer.parameter.id"></a>
|
|
30
|
+
|
|
31
|
+
- *Type:* string
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
##### `props`<sup>Required</sup> <a name="props" id="@robhan-cdk-lib/aws_mwaa.Environment.Initializer.parameter.props"></a>
|
|
36
|
+
|
|
37
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps">EnvironmentProps</a>
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
42
|
+
|
|
43
|
+
| **Name** | **Description** |
|
|
44
|
+
| --- | --- |
|
|
45
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
46
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_mwaa.Environment.toString"></a>
|
|
51
|
+
|
|
52
|
+
```typescript
|
|
53
|
+
public toString(): string
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Returns a string representation of this construct.
|
|
57
|
+
|
|
58
|
+
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_mwaa.Environment.applyRemovalPolicy"></a>
|
|
59
|
+
|
|
60
|
+
```typescript
|
|
61
|
+
public applyRemovalPolicy(policy: RemovalPolicy): void
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Apply the given removal policy to this resource.
|
|
65
|
+
|
|
66
|
+
The Removal Policy controls what happens to this resource when it stops
|
|
67
|
+
being managed by CloudFormation, either because you've removed it from the
|
|
68
|
+
CDK application or because you've made a change that requires the resource
|
|
69
|
+
to be replaced.
|
|
70
|
+
|
|
71
|
+
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
|
|
72
|
+
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
73
|
+
|
|
74
|
+
###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_mwaa.Environment.applyRemovalPolicy.parameter.policy"></a>
|
|
75
|
+
|
|
76
|
+
- *Type:* aws-cdk-lib.RemovalPolicy
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
81
|
+
|
|
82
|
+
| **Name** | **Description** |
|
|
83
|
+
| --- | --- |
|
|
84
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
85
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
|
|
86
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
|
|
87
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.fromEnvironmentAttributes">fromEnvironmentAttributes</a></code> | *No description.* |
|
|
88
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.isEnvironment">isEnvironment</a></code> | *No description.* |
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
##### `isConstruct` <a name="isConstruct" id="@robhan-cdk-lib/aws_mwaa.Environment.isConstruct"></a>
|
|
93
|
+
|
|
94
|
+
```typescript
|
|
95
|
+
import { Environment } from '@robhan-cdk-lib/aws_mwaa'
|
|
96
|
+
|
|
97
|
+
Environment.isConstruct(x: any)
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Checks if `x` is a construct.
|
|
101
|
+
|
|
102
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
103
|
+
instances, even when the construct library is symlinked.
|
|
104
|
+
|
|
105
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
106
|
+
disk are seen as independent, completely different libraries. As a
|
|
107
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
108
|
+
is seen as a different class, and an instance of one class will not test as
|
|
109
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
110
|
+
like this, but users may manually symlink construct libraries together or
|
|
111
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
112
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
113
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
114
|
+
this type-testing method instead.
|
|
115
|
+
|
|
116
|
+
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_mwaa.Environment.isConstruct.parameter.x"></a>
|
|
117
|
+
|
|
118
|
+
- *Type:* any
|
|
119
|
+
|
|
120
|
+
Any object.
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_mwaa.Environment.isOwnedResource"></a>
|
|
125
|
+
|
|
126
|
+
```typescript
|
|
127
|
+
import { Environment } from '@robhan-cdk-lib/aws_mwaa'
|
|
128
|
+
|
|
129
|
+
Environment.isOwnedResource(construct: IConstruct)
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Returns true if the construct was created by CDK, and false otherwise.
|
|
133
|
+
|
|
134
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_mwaa.Environment.isOwnedResource.parameter.construct"></a>
|
|
135
|
+
|
|
136
|
+
- *Type:* constructs.IConstruct
|
|
137
|
+
|
|
138
|
+
---
|
|
139
|
+
|
|
140
|
+
##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_mwaa.Environment.isResource"></a>
|
|
141
|
+
|
|
142
|
+
```typescript
|
|
143
|
+
import { Environment } from '@robhan-cdk-lib/aws_mwaa'
|
|
144
|
+
|
|
145
|
+
Environment.isResource(construct: IConstruct)
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
Check whether the given construct is a Resource.
|
|
149
|
+
|
|
150
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_mwaa.Environment.isResource.parameter.construct"></a>
|
|
151
|
+
|
|
152
|
+
- *Type:* constructs.IConstruct
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
##### `fromEnvironmentAttributes` <a name="fromEnvironmentAttributes" id="@robhan-cdk-lib/aws_mwaa.Environment.fromEnvironmentAttributes"></a>
|
|
157
|
+
|
|
158
|
+
```typescript
|
|
159
|
+
import { Environment } from '@robhan-cdk-lib/aws_mwaa'
|
|
160
|
+
|
|
161
|
+
Environment.fromEnvironmentAttributes(scope: Construct, id: string, attrs: EnvironmentAttributes)
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
###### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_mwaa.Environment.fromEnvironmentAttributes.parameter.scope"></a>
|
|
165
|
+
|
|
166
|
+
- *Type:* constructs.Construct
|
|
167
|
+
|
|
168
|
+
---
|
|
169
|
+
|
|
170
|
+
###### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_mwaa.Environment.fromEnvironmentAttributes.parameter.id"></a>
|
|
171
|
+
|
|
172
|
+
- *Type:* string
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
###### `attrs`<sup>Required</sup> <a name="attrs" id="@robhan-cdk-lib/aws_mwaa.Environment.fromEnvironmentAttributes.parameter.attrs"></a>
|
|
177
|
+
|
|
178
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes">EnvironmentAttributes</a>
|
|
179
|
+
|
|
180
|
+
---
|
|
181
|
+
|
|
182
|
+
##### `isEnvironment` <a name="isEnvironment" id="@robhan-cdk-lib/aws_mwaa.Environment.isEnvironment"></a>
|
|
183
|
+
|
|
184
|
+
```typescript
|
|
185
|
+
import { Environment } from '@robhan-cdk-lib/aws_mwaa'
|
|
186
|
+
|
|
187
|
+
Environment.isEnvironment(x: any)
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_mwaa.Environment.isEnvironment.parameter.x"></a>
|
|
191
|
+
|
|
192
|
+
- *Type:* any
|
|
193
|
+
|
|
194
|
+
---
|
|
195
|
+
|
|
196
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
197
|
+
|
|
198
|
+
| **Name** | **Type** | **Description** |
|
|
199
|
+
| --- | --- | --- |
|
|
200
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
201
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
202
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
|
|
203
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.airflowConfigurationOptions">airflowConfigurationOptions</a></code> | <code>{[ key: string ]: string}</code> | A list of key-value pairs containing the Airflow configuration options for your environment. |
|
|
204
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.environmentArn">environmentArn</a></code> | <code>string</code> | The ARN for the Amazon MWAA environment. |
|
|
205
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.name">name</a></code> | <code>string</code> | The name of your Amazon MWAA environment. |
|
|
206
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.airflowVersion">airflowVersion</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.AirflowVersion">AirflowVersion</a></code> | The version of Apache Airflow to use for the environment. |
|
|
207
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.celeryExecutorQueue">celeryExecutorQueue</a></code> | <code>string</code> | The queue ARN for the environment's Celery Executor. |
|
|
208
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.dagS3Path">dagS3Path</a></code> | <code>string</code> | The relative path to the DAGs folder on your Amazon S3 bucket. |
|
|
209
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.databaseVpcEndpointService">databaseVpcEndpointService</a></code> | <code>string</code> | The VPC endpoint for the environment's Amazon RDS database. |
|
|
210
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.endpointManagement">endpointManagement</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.EndpointManagement">EndpointManagement</a></code> | Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. |
|
|
211
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.environmentClass">environmentClass</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentClass">EnvironmentClass</a></code> | The environment class type. |
|
|
212
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.executionRole">executionRole</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | The execution role in IAM that allows MWAA to access AWS resources in your environment. |
|
|
213
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.kmsKey">kmsKey</a></code> | <code>aws-cdk-lib.aws_kms.IKey</code> | The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. |
|
|
214
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.loggingConfiguration">loggingConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.LoggingConfiguration">LoggingConfiguration</a></code> | The Apache Airflow logs being sent to CloudWatch Logs. |
|
|
215
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn">loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published. |
|
|
216
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.loggingConfigurationSchedulerLogsCloudWatchLogGroupArn">loggingConfigurationSchedulerLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published. |
|
|
217
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.loggingConfigurationTaskLogsCloudWatchLogGroupArn">loggingConfigurationTaskLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published. |
|
|
218
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.loggingConfigurationWebserverLogsCloudWatchLogGroupArn">loggingConfigurationWebserverLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published. |
|
|
219
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.loggingConfigurationWorkerLogsCloudWatchLogGroupArn">loggingConfigurationWorkerLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published. |
|
|
220
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.maxWebservers">maxWebservers</a></code> | <code>number</code> | The maximum number of web servers that you want to run in your environment. |
|
|
221
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.maxWorkers">maxWorkers</a></code> | <code>number</code> | The maximum number of workers that you want to run in your environment. |
|
|
222
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.minWebservers">minWebservers</a></code> | <code>number</code> | The minimum number of web servers that you want to run in your environment. |
|
|
223
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.minWorkers">minWorkers</a></code> | <code>number</code> | The minimum number of workers that you want to run in your environment. |
|
|
224
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.networkConfiguration">networkConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.NetworkConfiguration">NetworkConfiguration</a></code> | The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. |
|
|
225
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.pluginsS3ObjectVersion">pluginsS3ObjectVersion</a></code> | <code>string</code> | The version of the plugins.zip file on your Amazon S3 bucket. |
|
|
226
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.pluginsS3Path">pluginsS3Path</a></code> | <code>string</code> | The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. |
|
|
227
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.requirementsS3ObjectVersion">requirementsS3ObjectVersion</a></code> | <code>string</code> | The version of the requirements.txt file on your Amazon S3 bucket. |
|
|
228
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.requirementsS3Path">requirementsS3Path</a></code> | <code>string</code> | The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. |
|
|
229
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.schedulers">schedulers</a></code> | <code>number</code> | The number of schedulers that you want to run in your environment. |
|
|
230
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.sourceBucket">sourceBucket</a></code> | <code>aws-cdk-lib.aws_s3.IBucket</code> | The Amazon S3 bucket where your DAG code and supporting files are stored. |
|
|
231
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.startupScriptS3ObjectVersion">startupScriptS3ObjectVersion</a></code> | <code>string</code> | The version of the startup shell script in your Amazon S3 bucket. |
|
|
232
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.startupScriptS3Path">startupScriptS3Path</a></code> | <code>string</code> | The relative path to the startup shell script in your Amazon S3 bucket. |
|
|
233
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.webserverAccessMode">webserverAccessMode</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.WebserverAccessMode">WebserverAccessMode</a></code> | The Apache Airflow Web server access mode. |
|
|
234
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.webserverUrl">webserverUrl</a></code> | <code>string</code> | The URL of your Apache Airflow UI. |
|
|
235
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.webserverVpcEndpointService">webserverVpcEndpointService</a></code> | <code>string</code> | The VPC endpoint for the environment's web server. |
|
|
236
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.Environment.property.weeklyMaintenanceWindowStart">weeklyMaintenanceWindowStart</a></code> | <code>string</code> | The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. |
|
|
237
|
+
|
|
238
|
+
---
|
|
239
|
+
|
|
240
|
+
##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_mwaa.Environment.property.node"></a>
|
|
241
|
+
|
|
242
|
+
```typescript
|
|
243
|
+
public readonly node: Node;
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
- *Type:* constructs.Node
|
|
247
|
+
|
|
248
|
+
The tree node.
|
|
249
|
+
|
|
250
|
+
---
|
|
251
|
+
|
|
252
|
+
##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_mwaa.Environment.property.env"></a>
|
|
253
|
+
|
|
254
|
+
```typescript
|
|
255
|
+
public readonly env: ResourceEnvironment;
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
- *Type:* aws-cdk-lib.ResourceEnvironment
|
|
259
|
+
|
|
260
|
+
The environment this resource belongs to.
|
|
261
|
+
|
|
262
|
+
For resources that are created and managed by the CDK
|
|
263
|
+
(generally, those created by creating new class instances like Role, Bucket, etc.),
|
|
264
|
+
this is always the same as the environment of the stack they belong to;
|
|
265
|
+
however, for imported resources
|
|
266
|
+
(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
|
|
267
|
+
that might be different than the stack they were imported into.
|
|
268
|
+
|
|
269
|
+
---
|
|
270
|
+
|
|
271
|
+
##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_mwaa.Environment.property.stack"></a>
|
|
272
|
+
|
|
273
|
+
```typescript
|
|
274
|
+
public readonly stack: Stack;
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
- *Type:* aws-cdk-lib.Stack
|
|
278
|
+
|
|
279
|
+
The stack in which this resource is defined.
|
|
280
|
+
|
|
281
|
+
---
|
|
282
|
+
|
|
283
|
+
##### `airflowConfigurationOptions`<sup>Required</sup> <a name="airflowConfigurationOptions" id="@robhan-cdk-lib/aws_mwaa.Environment.property.airflowConfigurationOptions"></a>
|
|
284
|
+
|
|
285
|
+
```typescript
|
|
286
|
+
public readonly airflowConfigurationOptions: {[ key: string ]: string};
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
- *Type:* {[ key: string ]: string}
|
|
290
|
+
|
|
291
|
+
A list of key-value pairs containing the Airflow configuration options for your environment.
|
|
292
|
+
|
|
293
|
+
For example, core.default_timezone: utc.
|
|
294
|
+
|
|
295
|
+
---
|
|
296
|
+
|
|
297
|
+
##### `environmentArn`<sup>Required</sup> <a name="environmentArn" id="@robhan-cdk-lib/aws_mwaa.Environment.property.environmentArn"></a>
|
|
298
|
+
|
|
299
|
+
```typescript
|
|
300
|
+
public readonly environmentArn: string;
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
- *Type:* string
|
|
304
|
+
|
|
305
|
+
The ARN for the Amazon MWAA environment.
|
|
306
|
+
|
|
307
|
+
---
|
|
308
|
+
|
|
309
|
+
##### `name`<sup>Required</sup> <a name="name" id="@robhan-cdk-lib/aws_mwaa.Environment.property.name"></a>
|
|
310
|
+
|
|
311
|
+
```typescript
|
|
312
|
+
public readonly name: string;
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
- *Type:* string
|
|
316
|
+
|
|
317
|
+
The name of your Amazon MWAA environment.
|
|
318
|
+
|
|
319
|
+
---
|
|
320
|
+
|
|
321
|
+
##### `airflowVersion`<sup>Optional</sup> <a name="airflowVersion" id="@robhan-cdk-lib/aws_mwaa.Environment.property.airflowVersion"></a>
|
|
322
|
+
|
|
323
|
+
```typescript
|
|
324
|
+
public readonly airflowVersion: AirflowVersion;
|
|
325
|
+
```
|
|
326
|
+
|
|
327
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.AirflowVersion">AirflowVersion</a>
|
|
328
|
+
|
|
329
|
+
The version of Apache Airflow to use for the environment.
|
|
330
|
+
|
|
331
|
+
If no value is specified, defaults to the latest version.
|
|
332
|
+
|
|
333
|
+
If you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect.
|
|
334
|
+
|
|
335
|
+
---
|
|
336
|
+
|
|
337
|
+
##### `celeryExecutorQueue`<sup>Optional</sup> <a name="celeryExecutorQueue" id="@robhan-cdk-lib/aws_mwaa.Environment.property.celeryExecutorQueue"></a>
|
|
338
|
+
|
|
339
|
+
```typescript
|
|
340
|
+
public readonly celeryExecutorQueue: string;
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
- *Type:* string
|
|
344
|
+
|
|
345
|
+
The queue ARN for the environment's Celery Executor.
|
|
346
|
+
|
|
347
|
+
Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers.
|
|
348
|
+
When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.
|
|
349
|
+
|
|
350
|
+
---
|
|
351
|
+
|
|
352
|
+
##### `dagS3Path`<sup>Optional</sup> <a name="dagS3Path" id="@robhan-cdk-lib/aws_mwaa.Environment.property.dagS3Path"></a>
|
|
353
|
+
|
|
354
|
+
```typescript
|
|
355
|
+
public readonly dagS3Path: string;
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
- *Type:* string
|
|
359
|
+
|
|
360
|
+
The relative path to the DAGs folder on your Amazon S3 bucket.
|
|
361
|
+
|
|
362
|
+
For example, dags.
|
|
363
|
+
|
|
364
|
+
---
|
|
365
|
+
|
|
366
|
+
##### `databaseVpcEndpointService`<sup>Optional</sup> <a name="databaseVpcEndpointService" id="@robhan-cdk-lib/aws_mwaa.Environment.property.databaseVpcEndpointService"></a>
|
|
367
|
+
|
|
368
|
+
```typescript
|
|
369
|
+
public readonly databaseVpcEndpointService: string;
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
- *Type:* string
|
|
373
|
+
|
|
374
|
+
The VPC endpoint for the environment's Amazon RDS database.
|
|
375
|
+
|
|
376
|
+
---
|
|
377
|
+
|
|
378
|
+
##### `endpointManagement`<sup>Optional</sup> <a name="endpointManagement" id="@robhan-cdk-lib/aws_mwaa.Environment.property.endpointManagement"></a>
|
|
379
|
+
|
|
380
|
+
```typescript
|
|
381
|
+
public readonly endpointManagement: EndpointManagement;
|
|
382
|
+
```
|
|
383
|
+
|
|
384
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.EndpointManagement">EndpointManagement</a>
|
|
385
|
+
|
|
386
|
+
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
|
|
387
|
+
|
|
388
|
+
If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC.
|
|
389
|
+
If set to CUSTOMER, you must create, and manage, the VPC endpoints in your VPC.
|
|
390
|
+
|
|
391
|
+
---
|
|
392
|
+
|
|
393
|
+
##### `environmentClass`<sup>Optional</sup> <a name="environmentClass" id="@robhan-cdk-lib/aws_mwaa.Environment.property.environmentClass"></a>
|
|
394
|
+
|
|
395
|
+
```typescript
|
|
396
|
+
public readonly environmentClass: EnvironmentClass;
|
|
397
|
+
```
|
|
398
|
+
|
|
399
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentClass">EnvironmentClass</a>
|
|
400
|
+
|
|
401
|
+
The environment class type.
|
|
402
|
+
|
|
403
|
+
---
|
|
404
|
+
|
|
405
|
+
##### `executionRole`<sup>Optional</sup> <a name="executionRole" id="@robhan-cdk-lib/aws_mwaa.Environment.property.executionRole"></a>
|
|
406
|
+
|
|
407
|
+
```typescript
|
|
408
|
+
public readonly executionRole: IRole;
|
|
409
|
+
```
|
|
410
|
+
|
|
411
|
+
- *Type:* aws-cdk-lib.aws_iam.IRole
|
|
412
|
+
|
|
413
|
+
The execution role in IAM that allows MWAA to access AWS resources in your environment.
|
|
414
|
+
|
|
415
|
+
---
|
|
416
|
+
|
|
417
|
+
##### `kmsKey`<sup>Optional</sup> <a name="kmsKey" id="@robhan-cdk-lib/aws_mwaa.Environment.property.kmsKey"></a>
|
|
418
|
+
|
|
419
|
+
```typescript
|
|
420
|
+
public readonly kmsKey: IKey;
|
|
421
|
+
```
|
|
422
|
+
|
|
423
|
+
- *Type:* aws-cdk-lib.aws_kms.IKey
|
|
424
|
+
|
|
425
|
+
The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
|
|
426
|
+
|
|
427
|
+
You can use an AWS KMS key managed by MWAA, or a customer-managed KMS key (advanced).
|
|
428
|
+
|
|
429
|
+
---
|
|
430
|
+
|
|
431
|
+
##### `loggingConfiguration`<sup>Optional</sup> <a name="loggingConfiguration" id="@robhan-cdk-lib/aws_mwaa.Environment.property.loggingConfiguration"></a>
|
|
432
|
+
|
|
433
|
+
```typescript
|
|
434
|
+
public readonly loggingConfiguration: LoggingConfiguration;
|
|
435
|
+
```
|
|
436
|
+
|
|
437
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.LoggingConfiguration">LoggingConfiguration</a>
|
|
438
|
+
|
|
439
|
+
The Apache Airflow logs being sent to CloudWatch Logs.
|
|
440
|
+
|
|
441
|
+
---
|
|
442
|
+
|
|
443
|
+
##### `loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.Environment.property.loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn"></a>
|
|
444
|
+
|
|
445
|
+
```typescript
|
|
446
|
+
public readonly loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn: string;
|
|
447
|
+
```
|
|
448
|
+
|
|
449
|
+
- *Type:* string
|
|
450
|
+
|
|
451
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published.
|
|
452
|
+
|
|
453
|
+
---
|
|
454
|
+
|
|
455
|
+
##### `loggingConfigurationSchedulerLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationSchedulerLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.Environment.property.loggingConfigurationSchedulerLogsCloudWatchLogGroupArn"></a>
|
|
456
|
+
|
|
457
|
+
```typescript
|
|
458
|
+
public readonly loggingConfigurationSchedulerLogsCloudWatchLogGroupArn: string;
|
|
459
|
+
```
|
|
460
|
+
|
|
461
|
+
- *Type:* string
|
|
462
|
+
|
|
463
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published.
|
|
464
|
+
|
|
465
|
+
---
|
|
466
|
+
|
|
467
|
+
##### `loggingConfigurationTaskLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationTaskLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.Environment.property.loggingConfigurationTaskLogsCloudWatchLogGroupArn"></a>
|
|
468
|
+
|
|
469
|
+
```typescript
|
|
470
|
+
public readonly loggingConfigurationTaskLogsCloudWatchLogGroupArn: string;
|
|
471
|
+
```
|
|
472
|
+
|
|
473
|
+
- *Type:* string
|
|
474
|
+
|
|
475
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published.
|
|
476
|
+
|
|
477
|
+
---
|
|
478
|
+
|
|
479
|
+
##### `loggingConfigurationWebserverLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationWebserverLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.Environment.property.loggingConfigurationWebserverLogsCloudWatchLogGroupArn"></a>
|
|
480
|
+
|
|
481
|
+
```typescript
|
|
482
|
+
public readonly loggingConfigurationWebserverLogsCloudWatchLogGroupArn: string;
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
- *Type:* string
|
|
486
|
+
|
|
487
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published.
|
|
488
|
+
|
|
489
|
+
---
|
|
490
|
+
|
|
491
|
+
##### `loggingConfigurationWorkerLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationWorkerLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.Environment.property.loggingConfigurationWorkerLogsCloudWatchLogGroupArn"></a>
|
|
492
|
+
|
|
493
|
+
```typescript
|
|
494
|
+
public readonly loggingConfigurationWorkerLogsCloudWatchLogGroupArn: string;
|
|
495
|
+
```
|
|
496
|
+
|
|
497
|
+
- *Type:* string
|
|
498
|
+
|
|
499
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published.
|
|
500
|
+
|
|
501
|
+
---
|
|
502
|
+
|
|
503
|
+
##### `maxWebservers`<sup>Optional</sup> <a name="maxWebservers" id="@robhan-cdk-lib/aws_mwaa.Environment.property.maxWebservers"></a>
|
|
504
|
+
|
|
505
|
+
```typescript
|
|
506
|
+
public readonly maxWebservers: number;
|
|
507
|
+
```
|
|
508
|
+
|
|
509
|
+
- *Type:* number
|
|
510
|
+
|
|
511
|
+
The maximum number of web servers that you want to run in your environment.
|
|
512
|
+
|
|
513
|
+
Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache
|
|
514
|
+
Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network
|
|
515
|
+
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
|
|
516
|
+
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
|
|
517
|
+
MinxWebserers.
|
|
518
|
+
|
|
519
|
+
Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro,
|
|
520
|
+
which defaults to 1.
|
|
521
|
+
|
|
522
|
+
---
|
|
523
|
+
|
|
524
|
+
##### `maxWorkers`<sup>Optional</sup> <a name="maxWorkers" id="@robhan-cdk-lib/aws_mwaa.Environment.property.maxWorkers"></a>
|
|
525
|
+
|
|
526
|
+
```typescript
|
|
527
|
+
public readonly maxWorkers: number;
|
|
528
|
+
```
|
|
529
|
+
|
|
530
|
+
- *Type:* number
|
|
531
|
+
|
|
532
|
+
The maximum number of workers that you want to run in your environment.
|
|
533
|
+
|
|
534
|
+
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
|
|
535
|
+
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
|
|
536
|
+
the number you specify in MinWorkers.
|
|
537
|
+
|
|
538
|
+
---
|
|
539
|
+
|
|
540
|
+
##### `minWebservers`<sup>Optional</sup> <a name="minWebservers" id="@robhan-cdk-lib/aws_mwaa.Environment.property.minWebservers"></a>
|
|
541
|
+
|
|
542
|
+
```typescript
|
|
543
|
+
public readonly minWebservers: number;
|
|
544
|
+
```
|
|
545
|
+
|
|
546
|
+
- *Type:* number
|
|
547
|
+
|
|
548
|
+
The minimum number of web servers that you want to run in your environment.
|
|
549
|
+
|
|
550
|
+
Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache
|
|
551
|
+
Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load,
|
|
552
|
+
decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.
|
|
553
|
+
|
|
554
|
+
Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro,
|
|
555
|
+
which defaults to 1.
|
|
556
|
+
|
|
557
|
+
---
|
|
558
|
+
|
|
559
|
+
##### `minWorkers`<sup>Optional</sup> <a name="minWorkers" id="@robhan-cdk-lib/aws_mwaa.Environment.property.minWorkers"></a>
|
|
560
|
+
|
|
561
|
+
```typescript
|
|
562
|
+
public readonly minWorkers: number;
|
|
563
|
+
```
|
|
564
|
+
|
|
565
|
+
- *Type:* number
|
|
566
|
+
|
|
567
|
+
The minimum number of workers that you want to run in your environment.
|
|
568
|
+
|
|
569
|
+
MWAA scales the number of Apache Airflow workers up to the number you
|
|
570
|
+
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
|
|
571
|
+
the worker count you specify in the MinWorkers field. For example, 2.
|
|
572
|
+
|
|
573
|
+
---
|
|
574
|
+
|
|
575
|
+
##### `networkConfiguration`<sup>Optional</sup> <a name="networkConfiguration" id="@robhan-cdk-lib/aws_mwaa.Environment.property.networkConfiguration"></a>
|
|
576
|
+
|
|
577
|
+
```typescript
|
|
578
|
+
public readonly networkConfiguration: NetworkConfiguration;
|
|
579
|
+
```
|
|
580
|
+
|
|
581
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.NetworkConfiguration">NetworkConfiguration</a>
|
|
582
|
+
|
|
583
|
+
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
|
|
584
|
+
|
|
585
|
+
---
|
|
586
|
+
|
|
587
|
+
##### `pluginsS3ObjectVersion`<sup>Optional</sup> <a name="pluginsS3ObjectVersion" id="@robhan-cdk-lib/aws_mwaa.Environment.property.pluginsS3ObjectVersion"></a>
|
|
588
|
+
|
|
589
|
+
```typescript
|
|
590
|
+
public readonly pluginsS3ObjectVersion: string;
|
|
591
|
+
```
|
|
592
|
+
|
|
593
|
+
- *Type:* string
|
|
594
|
+
|
|
595
|
+
The version of the plugins.zip file on your Amazon S3 bucket.
|
|
596
|
+
|
|
597
|
+
---
|
|
598
|
+
|
|
599
|
+
##### `pluginsS3Path`<sup>Optional</sup> <a name="pluginsS3Path" id="@robhan-cdk-lib/aws_mwaa.Environment.property.pluginsS3Path"></a>
|
|
600
|
+
|
|
601
|
+
```typescript
|
|
602
|
+
public readonly pluginsS3Path: string;
|
|
603
|
+
```
|
|
604
|
+
|
|
605
|
+
- *Type:* string
|
|
606
|
+
|
|
607
|
+
The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip.
|
|
608
|
+
|
|
609
|
+
---
|
|
610
|
+
|
|
611
|
+
##### `requirementsS3ObjectVersion`<sup>Optional</sup> <a name="requirementsS3ObjectVersion" id="@robhan-cdk-lib/aws_mwaa.Environment.property.requirementsS3ObjectVersion"></a>
|
|
612
|
+
|
|
613
|
+
```typescript
|
|
614
|
+
public readonly requirementsS3ObjectVersion: string;
|
|
615
|
+
```
|
|
616
|
+
|
|
617
|
+
- *Type:* string
|
|
618
|
+
|
|
619
|
+
The version of the requirements.txt file on your Amazon S3 bucket.
|
|
620
|
+
|
|
621
|
+
---
|
|
622
|
+
|
|
623
|
+
##### `requirementsS3Path`<sup>Optional</sup> <a name="requirementsS3Path" id="@robhan-cdk-lib/aws_mwaa.Environment.property.requirementsS3Path"></a>
|
|
624
|
+
|
|
625
|
+
```typescript
|
|
626
|
+
public readonly requirementsS3Path: string;
|
|
627
|
+
```
|
|
628
|
+
|
|
629
|
+
- *Type:* string
|
|
630
|
+
|
|
631
|
+
The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt.
|
|
632
|
+
|
|
633
|
+
---
|
|
634
|
+
|
|
635
|
+
##### `schedulers`<sup>Optional</sup> <a name="schedulers" id="@robhan-cdk-lib/aws_mwaa.Environment.property.schedulers"></a>
|
|
636
|
+
|
|
637
|
+
```typescript
|
|
638
|
+
public readonly schedulers: number;
|
|
639
|
+
```
|
|
640
|
+
|
|
641
|
+
- *Type:* number
|
|
642
|
+
|
|
643
|
+
The number of schedulers that you want to run in your environment.
|
|
644
|
+
|
|
645
|
+
Valid values:
|
|
646
|
+
v2 - For environments larger than mw1.micro, accepts values from 2 to 5.
|
|
647
|
+
Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
|
|
648
|
+
v1 - Accepts 1.
|
|
649
|
+
|
|
650
|
+
---
|
|
651
|
+
|
|
652
|
+
##### `sourceBucket`<sup>Optional</sup> <a name="sourceBucket" id="@robhan-cdk-lib/aws_mwaa.Environment.property.sourceBucket"></a>
|
|
653
|
+
|
|
654
|
+
```typescript
|
|
655
|
+
public readonly sourceBucket: IBucket;
|
|
656
|
+
```
|
|
657
|
+
|
|
658
|
+
- *Type:* aws-cdk-lib.aws_s3.IBucket
|
|
659
|
+
|
|
660
|
+
The Amazon S3 bucket where your DAG code and supporting files are stored.
|
|
661
|
+
|
|
662
|
+
---
|
|
663
|
+
|
|
664
|
+
##### `startupScriptS3ObjectVersion`<sup>Optional</sup> <a name="startupScriptS3ObjectVersion" id="@robhan-cdk-lib/aws_mwaa.Environment.property.startupScriptS3ObjectVersion"></a>
|
|
665
|
+
|
|
666
|
+
```typescript
|
|
667
|
+
public readonly startupScriptS3ObjectVersion: string;
|
|
668
|
+
```
|
|
669
|
+
|
|
670
|
+
- *Type:* string
|
|
671
|
+
|
|
672
|
+
The version of the startup shell script in your Amazon S3 bucket.
|
|
673
|
+
|
|
674
|
+
You must specify the version ID that Amazon S3 assigns to the file every time you update the script.
|
|
675
|
+
Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long.
|
|
676
|
+
|
|
677
|
+
The following is an example:
|
|
678
|
+
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
|
|
679
|
+
|
|
680
|
+
---
|
|
681
|
+
|
|
682
|
+
##### `startupScriptS3Path`<sup>Optional</sup> <a name="startupScriptS3Path" id="@robhan-cdk-lib/aws_mwaa.Environment.property.startupScriptS3Path"></a>
|
|
683
|
+
|
|
684
|
+
```typescript
|
|
685
|
+
public readonly startupScriptS3Path: string;
|
|
686
|
+
```
|
|
687
|
+
|
|
688
|
+
- *Type:* string
|
|
689
|
+
|
|
690
|
+
The relative path to the startup shell script in your Amazon S3 bucket.
|
|
691
|
+
|
|
692
|
+
For example, s3://mwaa-environment/startup.sh.
|
|
693
|
+
Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process.
|
|
694
|
+
You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables.
|
|
695
|
+
|
|
696
|
+
---
|
|
697
|
+
|
|
698
|
+
##### `webserverAccessMode`<sup>Optional</sup> <a name="webserverAccessMode" id="@robhan-cdk-lib/aws_mwaa.Environment.property.webserverAccessMode"></a>
|
|
699
|
+
|
|
700
|
+
```typescript
|
|
701
|
+
public readonly webserverAccessMode: WebserverAccessMode;
|
|
702
|
+
```
|
|
703
|
+
|
|
704
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.WebserverAccessMode">WebserverAccessMode</a>
|
|
705
|
+
|
|
706
|
+
The Apache Airflow Web server access mode.
|
|
707
|
+
|
|
708
|
+
---
|
|
709
|
+
|
|
710
|
+
##### `webserverUrl`<sup>Optional</sup> <a name="webserverUrl" id="@robhan-cdk-lib/aws_mwaa.Environment.property.webserverUrl"></a>
|
|
711
|
+
|
|
712
|
+
```typescript
|
|
713
|
+
public readonly webserverUrl: string;
|
|
714
|
+
```
|
|
715
|
+
|
|
716
|
+
- *Type:* string
|
|
717
|
+
|
|
718
|
+
The URL of your Apache Airflow UI.
|
|
719
|
+
|
|
720
|
+
---
|
|
721
|
+
|
|
722
|
+
##### `webserverVpcEndpointService`<sup>Optional</sup> <a name="webserverVpcEndpointService" id="@robhan-cdk-lib/aws_mwaa.Environment.property.webserverVpcEndpointService"></a>
|
|
723
|
+
|
|
724
|
+
```typescript
|
|
725
|
+
public readonly webserverVpcEndpointService: string;
|
|
726
|
+
```
|
|
727
|
+
|
|
728
|
+
- *Type:* string
|
|
729
|
+
|
|
730
|
+
The VPC endpoint for the environment's web server.
|
|
731
|
+
|
|
732
|
+
---
|
|
733
|
+
|
|
734
|
+
##### `weeklyMaintenanceWindowStart`<sup>Optional</sup> <a name="weeklyMaintenanceWindowStart" id="@robhan-cdk-lib/aws_mwaa.Environment.property.weeklyMaintenanceWindowStart"></a>
|
|
735
|
+
|
|
736
|
+
```typescript
|
|
737
|
+
public readonly weeklyMaintenanceWindowStart: string;
|
|
738
|
+
```
|
|
739
|
+
|
|
740
|
+
- *Type:* string
|
|
741
|
+
|
|
742
|
+
The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM.
|
|
743
|
+
|
|
744
|
+
For example: TUE:03:30. You can specify a start time in 30 minute increments only.
|
|
745
|
+
|
|
746
|
+
Supported input includes the following:
|
|
747
|
+
MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)
|
|
748
|
+
|
|
749
|
+
---
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
### EnvironmentBase <a name="EnvironmentBase" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase"></a>
|
|
753
|
+
|
|
754
|
+
- *Implements:* <a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment">IEnvironment</a>
|
|
755
|
+
|
|
756
|
+
#### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.Initializer"></a>
|
|
757
|
+
|
|
758
|
+
```typescript
|
|
759
|
+
import { EnvironmentBase } from '@robhan-cdk-lib/aws_mwaa'
|
|
760
|
+
|
|
761
|
+
new EnvironmentBase(scope: Construct, id: string, props?: ResourceProps)
|
|
762
|
+
```
|
|
763
|
+
|
|
764
|
+
| **Name** | **Type** | **Description** |
|
|
765
|
+
| --- | --- | --- |
|
|
766
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
767
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
768
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.Initializer.parameter.props">props</a></code> | <code>aws-cdk-lib.ResourceProps</code> | *No description.* |
|
|
769
|
+
|
|
770
|
+
---
|
|
771
|
+
|
|
772
|
+
##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.Initializer.parameter.scope"></a>
|
|
773
|
+
|
|
774
|
+
- *Type:* constructs.Construct
|
|
775
|
+
|
|
776
|
+
---
|
|
777
|
+
|
|
778
|
+
##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.Initializer.parameter.id"></a>
|
|
779
|
+
|
|
780
|
+
- *Type:* string
|
|
781
|
+
|
|
782
|
+
---
|
|
783
|
+
|
|
784
|
+
##### `props`<sup>Optional</sup> <a name="props" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.Initializer.parameter.props"></a>
|
|
785
|
+
|
|
786
|
+
- *Type:* aws-cdk-lib.ResourceProps
|
|
787
|
+
|
|
788
|
+
---
|
|
789
|
+
|
|
790
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
791
|
+
|
|
792
|
+
| **Name** | **Description** |
|
|
793
|
+
| --- | --- |
|
|
794
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
795
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
|
|
796
|
+
|
|
797
|
+
---
|
|
798
|
+
|
|
799
|
+
##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.toString"></a>
|
|
800
|
+
|
|
801
|
+
```typescript
|
|
802
|
+
public toString(): string
|
|
803
|
+
```
|
|
804
|
+
|
|
805
|
+
Returns a string representation of this construct.
|
|
806
|
+
|
|
807
|
+
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.applyRemovalPolicy"></a>
|
|
808
|
+
|
|
809
|
+
```typescript
|
|
810
|
+
public applyRemovalPolicy(policy: RemovalPolicy): void
|
|
811
|
+
```
|
|
812
|
+
|
|
813
|
+
Apply the given removal policy to this resource.
|
|
814
|
+
|
|
815
|
+
The Removal Policy controls what happens to this resource when it stops
|
|
816
|
+
being managed by CloudFormation, either because you've removed it from the
|
|
817
|
+
CDK application or because you've made a change that requires the resource
|
|
818
|
+
to be replaced.
|
|
819
|
+
|
|
820
|
+
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
|
|
821
|
+
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
822
|
+
|
|
823
|
+
###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.applyRemovalPolicy.parameter.policy"></a>
|
|
824
|
+
|
|
825
|
+
- *Type:* aws-cdk-lib.RemovalPolicy
|
|
826
|
+
|
|
827
|
+
---
|
|
828
|
+
|
|
829
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
830
|
+
|
|
831
|
+
| **Name** | **Description** |
|
|
832
|
+
| --- | --- |
|
|
833
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
834
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
|
|
835
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
|
|
836
|
+
|
|
837
|
+
---
|
|
838
|
+
|
|
839
|
+
##### `isConstruct` <a name="isConstruct" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.isConstruct"></a>
|
|
840
|
+
|
|
841
|
+
```typescript
|
|
842
|
+
import { EnvironmentBase } from '@robhan-cdk-lib/aws_mwaa'
|
|
843
|
+
|
|
844
|
+
EnvironmentBase.isConstruct(x: any)
|
|
845
|
+
```
|
|
846
|
+
|
|
847
|
+
Checks if `x` is a construct.
|
|
848
|
+
|
|
849
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
850
|
+
instances, even when the construct library is symlinked.
|
|
851
|
+
|
|
852
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
853
|
+
disk are seen as independent, completely different libraries. As a
|
|
854
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
855
|
+
is seen as a different class, and an instance of one class will not test as
|
|
856
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
857
|
+
like this, but users may manually symlink construct libraries together or
|
|
858
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
859
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
860
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
861
|
+
this type-testing method instead.
|
|
862
|
+
|
|
863
|
+
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.isConstruct.parameter.x"></a>
|
|
864
|
+
|
|
865
|
+
- *Type:* any
|
|
866
|
+
|
|
867
|
+
Any object.
|
|
868
|
+
|
|
869
|
+
---
|
|
870
|
+
|
|
871
|
+
##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.isOwnedResource"></a>
|
|
872
|
+
|
|
873
|
+
```typescript
|
|
874
|
+
import { EnvironmentBase } from '@robhan-cdk-lib/aws_mwaa'
|
|
875
|
+
|
|
876
|
+
EnvironmentBase.isOwnedResource(construct: IConstruct)
|
|
877
|
+
```
|
|
878
|
+
|
|
879
|
+
Returns true if the construct was created by CDK, and false otherwise.
|
|
880
|
+
|
|
881
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.isOwnedResource.parameter.construct"></a>
|
|
882
|
+
|
|
883
|
+
- *Type:* constructs.IConstruct
|
|
884
|
+
|
|
885
|
+
---
|
|
886
|
+
|
|
887
|
+
##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.isResource"></a>
|
|
888
|
+
|
|
889
|
+
```typescript
|
|
890
|
+
import { EnvironmentBase } from '@robhan-cdk-lib/aws_mwaa'
|
|
891
|
+
|
|
892
|
+
EnvironmentBase.isResource(construct: IConstruct)
|
|
893
|
+
```
|
|
894
|
+
|
|
895
|
+
Check whether the given construct is a Resource.
|
|
896
|
+
|
|
897
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.isResource.parameter.construct"></a>
|
|
898
|
+
|
|
899
|
+
- *Type:* constructs.IConstruct
|
|
900
|
+
|
|
901
|
+
---
|
|
902
|
+
|
|
903
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
904
|
+
|
|
905
|
+
| **Name** | **Type** | **Description** |
|
|
906
|
+
| --- | --- | --- |
|
|
907
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
908
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
909
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
|
|
910
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.airflowConfigurationOptions">airflowConfigurationOptions</a></code> | <code>{[ key: string ]: string}</code> | A list of key-value pairs containing the Airflow configuration options for your environment. |
|
|
911
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.environmentArn">environmentArn</a></code> | <code>string</code> | The ARN for the Amazon MWAA environment. |
|
|
912
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.name">name</a></code> | <code>string</code> | The name of your Amazon MWAA environment. |
|
|
913
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.airflowVersion">airflowVersion</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.AirflowVersion">AirflowVersion</a></code> | The version of Apache Airflow to use for the environment. |
|
|
914
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.celeryExecutorQueue">celeryExecutorQueue</a></code> | <code>string</code> | The queue ARN for the environment's Celery Executor. |
|
|
915
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.dagS3Path">dagS3Path</a></code> | <code>string</code> | The relative path to the DAGs folder on your Amazon S3 bucket. |
|
|
916
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.databaseVpcEndpointService">databaseVpcEndpointService</a></code> | <code>string</code> | The VPC endpoint for the environment's Amazon RDS database. |
|
|
917
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.endpointManagement">endpointManagement</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.EndpointManagement">EndpointManagement</a></code> | Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. |
|
|
918
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.environmentClass">environmentClass</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentClass">EnvironmentClass</a></code> | The environment class type. |
|
|
919
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.executionRole">executionRole</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | The execution role in IAM that allows MWAA to access AWS resources in your environment. |
|
|
920
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.kmsKey">kmsKey</a></code> | <code>aws-cdk-lib.aws_kms.IKey</code> | The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. |
|
|
921
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.loggingConfiguration">loggingConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.LoggingConfiguration">LoggingConfiguration</a></code> | The Apache Airflow logs being sent to CloudWatch Logs. |
|
|
922
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn">loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published. |
|
|
923
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.loggingConfigurationSchedulerLogsCloudWatchLogGroupArn">loggingConfigurationSchedulerLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published. |
|
|
924
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.loggingConfigurationTaskLogsCloudWatchLogGroupArn">loggingConfigurationTaskLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published. |
|
|
925
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.loggingConfigurationWebserverLogsCloudWatchLogGroupArn">loggingConfigurationWebserverLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published. |
|
|
926
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.loggingConfigurationWorkerLogsCloudWatchLogGroupArn">loggingConfigurationWorkerLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published. |
|
|
927
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.maxWebservers">maxWebservers</a></code> | <code>number</code> | The maximum number of web servers that you want to run in your environment. |
|
|
928
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.maxWorkers">maxWorkers</a></code> | <code>number</code> | The maximum number of workers that you want to run in your environment. |
|
|
929
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.minWebservers">minWebservers</a></code> | <code>number</code> | The minimum number of web servers that you want to run in your environment. |
|
|
930
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.minWorkers">minWorkers</a></code> | <code>number</code> | The minimum number of workers that you want to run in your environment. |
|
|
931
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.networkConfiguration">networkConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.NetworkConfiguration">NetworkConfiguration</a></code> | The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. |
|
|
932
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.pluginsS3ObjectVersion">pluginsS3ObjectVersion</a></code> | <code>string</code> | The version of the plugins.zip file on your Amazon S3 bucket. |
|
|
933
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.pluginsS3Path">pluginsS3Path</a></code> | <code>string</code> | The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. |
|
|
934
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.requirementsS3ObjectVersion">requirementsS3ObjectVersion</a></code> | <code>string</code> | The version of the requirements.txt file on your Amazon S3 bucket. |
|
|
935
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.requirementsS3Path">requirementsS3Path</a></code> | <code>string</code> | The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. |
|
|
936
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.schedulers">schedulers</a></code> | <code>number</code> | The number of schedulers that you want to run in your environment. |
|
|
937
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.sourceBucket">sourceBucket</a></code> | <code>aws-cdk-lib.aws_s3.IBucket</code> | The Amazon S3 bucket where your DAG code and supporting files are stored. |
|
|
938
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.startupScriptS3ObjectVersion">startupScriptS3ObjectVersion</a></code> | <code>string</code> | The version of the startup shell script in your Amazon S3 bucket. |
|
|
939
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.startupScriptS3Path">startupScriptS3Path</a></code> | <code>string</code> | The relative path to the startup shell script in your Amazon S3 bucket. |
|
|
940
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.webserverAccessMode">webserverAccessMode</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.WebserverAccessMode">WebserverAccessMode</a></code> | The Apache Airflow Web server access mode. |
|
|
941
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.webserverUrl">webserverUrl</a></code> | <code>string</code> | The URL of your Apache Airflow UI. |
|
|
942
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.webserverVpcEndpointService">webserverVpcEndpointService</a></code> | <code>string</code> | The VPC endpoint for the environment's web server. |
|
|
943
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.weeklyMaintenanceWindowStart">weeklyMaintenanceWindowStart</a></code> | <code>string</code> | The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. |
|
|
944
|
+
|
|
945
|
+
---
|
|
946
|
+
|
|
947
|
+
##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.node"></a>
|
|
948
|
+
|
|
949
|
+
```typescript
|
|
950
|
+
public readonly node: Node;
|
|
951
|
+
```
|
|
952
|
+
|
|
953
|
+
- *Type:* constructs.Node
|
|
954
|
+
|
|
955
|
+
The tree node.
|
|
956
|
+
|
|
957
|
+
---
|
|
958
|
+
|
|
959
|
+
##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.env"></a>
|
|
960
|
+
|
|
961
|
+
```typescript
|
|
962
|
+
public readonly env: ResourceEnvironment;
|
|
963
|
+
```
|
|
964
|
+
|
|
965
|
+
- *Type:* aws-cdk-lib.ResourceEnvironment
|
|
966
|
+
|
|
967
|
+
The environment this resource belongs to.
|
|
968
|
+
|
|
969
|
+
For resources that are created and managed by the CDK
|
|
970
|
+
(generally, those created by creating new class instances like Role, Bucket, etc.),
|
|
971
|
+
this is always the same as the environment of the stack they belong to;
|
|
972
|
+
however, for imported resources
|
|
973
|
+
(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
|
|
974
|
+
that might be different than the stack they were imported into.
|
|
975
|
+
|
|
976
|
+
---
|
|
977
|
+
|
|
978
|
+
##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.stack"></a>
|
|
979
|
+
|
|
980
|
+
```typescript
|
|
981
|
+
public readonly stack: Stack;
|
|
982
|
+
```
|
|
983
|
+
|
|
984
|
+
- *Type:* aws-cdk-lib.Stack
|
|
985
|
+
|
|
986
|
+
The stack in which this resource is defined.
|
|
987
|
+
|
|
988
|
+
---
|
|
989
|
+
|
|
990
|
+
##### `airflowConfigurationOptions`<sup>Required</sup> <a name="airflowConfigurationOptions" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.airflowConfigurationOptions"></a>
|
|
991
|
+
|
|
992
|
+
```typescript
|
|
993
|
+
public readonly airflowConfigurationOptions: {[ key: string ]: string};
|
|
994
|
+
```
|
|
995
|
+
|
|
996
|
+
- *Type:* {[ key: string ]: string}
|
|
997
|
+
|
|
998
|
+
A list of key-value pairs containing the Airflow configuration options for your environment.
|
|
999
|
+
|
|
1000
|
+
For example, core.default_timezone: utc.
|
|
1001
|
+
|
|
1002
|
+
---
|
|
1003
|
+
|
|
1004
|
+
##### `environmentArn`<sup>Required</sup> <a name="environmentArn" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.environmentArn"></a>
|
|
1005
|
+
|
|
1006
|
+
```typescript
|
|
1007
|
+
public readonly environmentArn: string;
|
|
1008
|
+
```
|
|
1009
|
+
|
|
1010
|
+
- *Type:* string
|
|
1011
|
+
|
|
1012
|
+
The ARN for the Amazon MWAA environment.
|
|
1013
|
+
|
|
1014
|
+
---
|
|
1015
|
+
|
|
1016
|
+
##### `name`<sup>Required</sup> <a name="name" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.name"></a>
|
|
1017
|
+
|
|
1018
|
+
```typescript
|
|
1019
|
+
public readonly name: string;
|
|
1020
|
+
```
|
|
1021
|
+
|
|
1022
|
+
- *Type:* string
|
|
1023
|
+
|
|
1024
|
+
The name of your Amazon MWAA environment.
|
|
1025
|
+
|
|
1026
|
+
---
|
|
1027
|
+
|
|
1028
|
+
##### `airflowVersion`<sup>Optional</sup> <a name="airflowVersion" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.airflowVersion"></a>
|
|
1029
|
+
|
|
1030
|
+
```typescript
|
|
1031
|
+
public readonly airflowVersion: AirflowVersion;
|
|
1032
|
+
```
|
|
1033
|
+
|
|
1034
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.AirflowVersion">AirflowVersion</a>
|
|
1035
|
+
|
|
1036
|
+
The version of Apache Airflow to use for the environment.
|
|
1037
|
+
|
|
1038
|
+
If no value is specified, defaults to the latest version.
|
|
1039
|
+
|
|
1040
|
+
If you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect.
|
|
1041
|
+
|
|
1042
|
+
---
|
|
1043
|
+
|
|
1044
|
+
##### `celeryExecutorQueue`<sup>Optional</sup> <a name="celeryExecutorQueue" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.celeryExecutorQueue"></a>
|
|
1045
|
+
|
|
1046
|
+
```typescript
|
|
1047
|
+
public readonly celeryExecutorQueue: string;
|
|
1048
|
+
```
|
|
1049
|
+
|
|
1050
|
+
- *Type:* string
|
|
1051
|
+
|
|
1052
|
+
The queue ARN for the environment's Celery Executor.
|
|
1053
|
+
|
|
1054
|
+
Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers.
|
|
1055
|
+
When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.
|
|
1056
|
+
|
|
1057
|
+
---
|
|
1058
|
+
|
|
1059
|
+
##### `dagS3Path`<sup>Optional</sup> <a name="dagS3Path" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.dagS3Path"></a>
|
|
1060
|
+
|
|
1061
|
+
```typescript
|
|
1062
|
+
public readonly dagS3Path: string;
|
|
1063
|
+
```
|
|
1064
|
+
|
|
1065
|
+
- *Type:* string
|
|
1066
|
+
|
|
1067
|
+
The relative path to the DAGs folder on your Amazon S3 bucket.
|
|
1068
|
+
|
|
1069
|
+
For example, dags.
|
|
1070
|
+
|
|
1071
|
+
---
|
|
1072
|
+
|
|
1073
|
+
##### `databaseVpcEndpointService`<sup>Optional</sup> <a name="databaseVpcEndpointService" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.databaseVpcEndpointService"></a>
|
|
1074
|
+
|
|
1075
|
+
```typescript
|
|
1076
|
+
public readonly databaseVpcEndpointService: string;
|
|
1077
|
+
```
|
|
1078
|
+
|
|
1079
|
+
- *Type:* string
|
|
1080
|
+
|
|
1081
|
+
The VPC endpoint for the environment's Amazon RDS database.
|
|
1082
|
+
|
|
1083
|
+
---
|
|
1084
|
+
|
|
1085
|
+
##### `endpointManagement`<sup>Optional</sup> <a name="endpointManagement" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.endpointManagement"></a>
|
|
1086
|
+
|
|
1087
|
+
```typescript
|
|
1088
|
+
public readonly endpointManagement: EndpointManagement;
|
|
1089
|
+
```
|
|
1090
|
+
|
|
1091
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.EndpointManagement">EndpointManagement</a>
|
|
1092
|
+
|
|
1093
|
+
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
|
|
1094
|
+
|
|
1095
|
+
If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC.
|
|
1096
|
+
If set to CUSTOMER, you must create, and manage, the VPC endpoints in your VPC.
|
|
1097
|
+
|
|
1098
|
+
---
|
|
1099
|
+
|
|
1100
|
+
##### `environmentClass`<sup>Optional</sup> <a name="environmentClass" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.environmentClass"></a>
|
|
1101
|
+
|
|
1102
|
+
```typescript
|
|
1103
|
+
public readonly environmentClass: EnvironmentClass;
|
|
1104
|
+
```
|
|
1105
|
+
|
|
1106
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentClass">EnvironmentClass</a>
|
|
1107
|
+
|
|
1108
|
+
The environment class type.
|
|
1109
|
+
|
|
1110
|
+
---
|
|
1111
|
+
|
|
1112
|
+
##### `executionRole`<sup>Optional</sup> <a name="executionRole" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.executionRole"></a>
|
|
1113
|
+
|
|
1114
|
+
```typescript
|
|
1115
|
+
public readonly executionRole: IRole;
|
|
1116
|
+
```
|
|
1117
|
+
|
|
1118
|
+
- *Type:* aws-cdk-lib.aws_iam.IRole
|
|
1119
|
+
|
|
1120
|
+
The execution role in IAM that allows MWAA to access AWS resources in your environment.
|
|
1121
|
+
|
|
1122
|
+
---
|
|
1123
|
+
|
|
1124
|
+
##### `kmsKey`<sup>Optional</sup> <a name="kmsKey" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.kmsKey"></a>
|
|
1125
|
+
|
|
1126
|
+
```typescript
|
|
1127
|
+
public readonly kmsKey: IKey;
|
|
1128
|
+
```
|
|
1129
|
+
|
|
1130
|
+
- *Type:* aws-cdk-lib.aws_kms.IKey
|
|
1131
|
+
|
|
1132
|
+
The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
|
|
1133
|
+
|
|
1134
|
+
You can use an AWS KMS key managed by MWAA, or a customer-managed KMS key (advanced).
|
|
1135
|
+
|
|
1136
|
+
---
|
|
1137
|
+
|
|
1138
|
+
##### `loggingConfiguration`<sup>Optional</sup> <a name="loggingConfiguration" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.loggingConfiguration"></a>
|
|
1139
|
+
|
|
1140
|
+
```typescript
|
|
1141
|
+
public readonly loggingConfiguration: LoggingConfiguration;
|
|
1142
|
+
```
|
|
1143
|
+
|
|
1144
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.LoggingConfiguration">LoggingConfiguration</a>
|
|
1145
|
+
|
|
1146
|
+
The Apache Airflow logs being sent to CloudWatch Logs.
|
|
1147
|
+
|
|
1148
|
+
---
|
|
1149
|
+
|
|
1150
|
+
##### `loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn"></a>
|
|
1151
|
+
|
|
1152
|
+
```typescript
|
|
1153
|
+
public readonly loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn: string;
|
|
1154
|
+
```
|
|
1155
|
+
|
|
1156
|
+
- *Type:* string
|
|
1157
|
+
|
|
1158
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published.
|
|
1159
|
+
|
|
1160
|
+
---
|
|
1161
|
+
|
|
1162
|
+
##### `loggingConfigurationSchedulerLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationSchedulerLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.loggingConfigurationSchedulerLogsCloudWatchLogGroupArn"></a>
|
|
1163
|
+
|
|
1164
|
+
```typescript
|
|
1165
|
+
public readonly loggingConfigurationSchedulerLogsCloudWatchLogGroupArn: string;
|
|
1166
|
+
```
|
|
1167
|
+
|
|
1168
|
+
- *Type:* string
|
|
1169
|
+
|
|
1170
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published.
|
|
1171
|
+
|
|
1172
|
+
---
|
|
1173
|
+
|
|
1174
|
+
##### `loggingConfigurationTaskLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationTaskLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.loggingConfigurationTaskLogsCloudWatchLogGroupArn"></a>
|
|
1175
|
+
|
|
1176
|
+
```typescript
|
|
1177
|
+
public readonly loggingConfigurationTaskLogsCloudWatchLogGroupArn: string;
|
|
1178
|
+
```
|
|
1179
|
+
|
|
1180
|
+
- *Type:* string
|
|
1181
|
+
|
|
1182
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published.
|
|
1183
|
+
|
|
1184
|
+
---
|
|
1185
|
+
|
|
1186
|
+
##### `loggingConfigurationWebserverLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationWebserverLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.loggingConfigurationWebserverLogsCloudWatchLogGroupArn"></a>
|
|
1187
|
+
|
|
1188
|
+
```typescript
|
|
1189
|
+
public readonly loggingConfigurationWebserverLogsCloudWatchLogGroupArn: string;
|
|
1190
|
+
```
|
|
1191
|
+
|
|
1192
|
+
- *Type:* string
|
|
1193
|
+
|
|
1194
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published.
|
|
1195
|
+
|
|
1196
|
+
---
|
|
1197
|
+
|
|
1198
|
+
##### `loggingConfigurationWorkerLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationWorkerLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.loggingConfigurationWorkerLogsCloudWatchLogGroupArn"></a>
|
|
1199
|
+
|
|
1200
|
+
```typescript
|
|
1201
|
+
public readonly loggingConfigurationWorkerLogsCloudWatchLogGroupArn: string;
|
|
1202
|
+
```
|
|
1203
|
+
|
|
1204
|
+
- *Type:* string
|
|
1205
|
+
|
|
1206
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published.
|
|
1207
|
+
|
|
1208
|
+
---
|
|
1209
|
+
|
|
1210
|
+
##### `maxWebservers`<sup>Optional</sup> <a name="maxWebservers" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.maxWebservers"></a>
|
|
1211
|
+
|
|
1212
|
+
```typescript
|
|
1213
|
+
public readonly maxWebservers: number;
|
|
1214
|
+
```
|
|
1215
|
+
|
|
1216
|
+
- *Type:* number
|
|
1217
|
+
|
|
1218
|
+
The maximum number of web servers that you want to run in your environment.
|
|
1219
|
+
|
|
1220
|
+
Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache
|
|
1221
|
+
Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network
|
|
1222
|
+
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
|
|
1223
|
+
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
|
|
1224
|
+
MinxWebserers.
|
|
1225
|
+
|
|
1226
|
+
Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro,
|
|
1227
|
+
which defaults to 1.
|
|
1228
|
+
|
|
1229
|
+
---
|
|
1230
|
+
|
|
1231
|
+
##### `maxWorkers`<sup>Optional</sup> <a name="maxWorkers" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.maxWorkers"></a>
|
|
1232
|
+
|
|
1233
|
+
```typescript
|
|
1234
|
+
public readonly maxWorkers: number;
|
|
1235
|
+
```
|
|
1236
|
+
|
|
1237
|
+
- *Type:* number
|
|
1238
|
+
|
|
1239
|
+
The maximum number of workers that you want to run in your environment.
|
|
1240
|
+
|
|
1241
|
+
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
|
|
1242
|
+
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
|
|
1243
|
+
the number you specify in MinWorkers.
|
|
1244
|
+
|
|
1245
|
+
---
|
|
1246
|
+
|
|
1247
|
+
##### `minWebservers`<sup>Optional</sup> <a name="minWebservers" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.minWebservers"></a>
|
|
1248
|
+
|
|
1249
|
+
```typescript
|
|
1250
|
+
public readonly minWebservers: number;
|
|
1251
|
+
```
|
|
1252
|
+
|
|
1253
|
+
- *Type:* number
|
|
1254
|
+
|
|
1255
|
+
The minimum number of web servers that you want to run in your environment.
|
|
1256
|
+
|
|
1257
|
+
Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache
|
|
1258
|
+
Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load,
|
|
1259
|
+
decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.
|
|
1260
|
+
|
|
1261
|
+
Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro,
|
|
1262
|
+
which defaults to 1.
|
|
1263
|
+
|
|
1264
|
+
---
|
|
1265
|
+
|
|
1266
|
+
##### `minWorkers`<sup>Optional</sup> <a name="minWorkers" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.minWorkers"></a>
|
|
1267
|
+
|
|
1268
|
+
```typescript
|
|
1269
|
+
public readonly minWorkers: number;
|
|
1270
|
+
```
|
|
1271
|
+
|
|
1272
|
+
- *Type:* number
|
|
1273
|
+
|
|
1274
|
+
The minimum number of workers that you want to run in your environment.
|
|
1275
|
+
|
|
1276
|
+
MWAA scales the number of Apache Airflow workers up to the number you
|
|
1277
|
+
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
|
|
1278
|
+
the worker count you specify in the MinWorkers field. For example, 2.
|
|
1279
|
+
|
|
1280
|
+
---
|
|
1281
|
+
|
|
1282
|
+
##### `networkConfiguration`<sup>Optional</sup> <a name="networkConfiguration" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.networkConfiguration"></a>
|
|
1283
|
+
|
|
1284
|
+
```typescript
|
|
1285
|
+
public readonly networkConfiguration: NetworkConfiguration;
|
|
1286
|
+
```
|
|
1287
|
+
|
|
1288
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.NetworkConfiguration">NetworkConfiguration</a>
|
|
1289
|
+
|
|
1290
|
+
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
|
|
1291
|
+
|
|
1292
|
+
---
|
|
1293
|
+
|
|
1294
|
+
##### `pluginsS3ObjectVersion`<sup>Optional</sup> <a name="pluginsS3ObjectVersion" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.pluginsS3ObjectVersion"></a>
|
|
1295
|
+
|
|
1296
|
+
```typescript
|
|
1297
|
+
public readonly pluginsS3ObjectVersion: string;
|
|
1298
|
+
```
|
|
1299
|
+
|
|
1300
|
+
- *Type:* string
|
|
1301
|
+
|
|
1302
|
+
The version of the plugins.zip file on your Amazon S3 bucket.
|
|
1303
|
+
|
|
1304
|
+
---
|
|
1305
|
+
|
|
1306
|
+
##### `pluginsS3Path`<sup>Optional</sup> <a name="pluginsS3Path" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.pluginsS3Path"></a>
|
|
1307
|
+
|
|
1308
|
+
```typescript
|
|
1309
|
+
public readonly pluginsS3Path: string;
|
|
1310
|
+
```
|
|
1311
|
+
|
|
1312
|
+
- *Type:* string
|
|
1313
|
+
|
|
1314
|
+
The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip.
|
|
1315
|
+
|
|
1316
|
+
---
|
|
1317
|
+
|
|
1318
|
+
##### `requirementsS3ObjectVersion`<sup>Optional</sup> <a name="requirementsS3ObjectVersion" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.requirementsS3ObjectVersion"></a>
|
|
1319
|
+
|
|
1320
|
+
```typescript
|
|
1321
|
+
public readonly requirementsS3ObjectVersion: string;
|
|
1322
|
+
```
|
|
1323
|
+
|
|
1324
|
+
- *Type:* string
|
|
1325
|
+
|
|
1326
|
+
The version of the requirements.txt file on your Amazon S3 bucket.
|
|
1327
|
+
|
|
1328
|
+
---
|
|
1329
|
+
|
|
1330
|
+
##### `requirementsS3Path`<sup>Optional</sup> <a name="requirementsS3Path" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.requirementsS3Path"></a>
|
|
1331
|
+
|
|
1332
|
+
```typescript
|
|
1333
|
+
public readonly requirementsS3Path: string;
|
|
1334
|
+
```
|
|
1335
|
+
|
|
1336
|
+
- *Type:* string
|
|
1337
|
+
|
|
1338
|
+
The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt.
|
|
1339
|
+
|
|
1340
|
+
---
|
|
1341
|
+
|
|
1342
|
+
##### `schedulers`<sup>Optional</sup> <a name="schedulers" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.schedulers"></a>
|
|
1343
|
+
|
|
1344
|
+
```typescript
|
|
1345
|
+
public readonly schedulers: number;
|
|
1346
|
+
```
|
|
1347
|
+
|
|
1348
|
+
- *Type:* number
|
|
1349
|
+
|
|
1350
|
+
The number of schedulers that you want to run in your environment.
|
|
1351
|
+
|
|
1352
|
+
Valid values:
|
|
1353
|
+
v2 - For environments larger than mw1.micro, accepts values from 2 to 5.
|
|
1354
|
+
Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
|
|
1355
|
+
v1 - Accepts 1.
|
|
1356
|
+
|
|
1357
|
+
---
|
|
1358
|
+
|
|
1359
|
+
##### `sourceBucket`<sup>Optional</sup> <a name="sourceBucket" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.sourceBucket"></a>
|
|
1360
|
+
|
|
1361
|
+
```typescript
|
|
1362
|
+
public readonly sourceBucket: IBucket;
|
|
1363
|
+
```
|
|
1364
|
+
|
|
1365
|
+
- *Type:* aws-cdk-lib.aws_s3.IBucket
|
|
1366
|
+
|
|
1367
|
+
The Amazon S3 bucket where your DAG code and supporting files are stored.
|
|
1368
|
+
|
|
1369
|
+
---
|
|
1370
|
+
|
|
1371
|
+
##### `startupScriptS3ObjectVersion`<sup>Optional</sup> <a name="startupScriptS3ObjectVersion" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.startupScriptS3ObjectVersion"></a>
|
|
1372
|
+
|
|
1373
|
+
```typescript
|
|
1374
|
+
public readonly startupScriptS3ObjectVersion: string;
|
|
1375
|
+
```
|
|
1376
|
+
|
|
1377
|
+
- *Type:* string
|
|
1378
|
+
|
|
1379
|
+
The version of the startup shell script in your Amazon S3 bucket.
|
|
1380
|
+
|
|
1381
|
+
You must specify the version ID that Amazon S3 assigns to the file every time you update the script.
|
|
1382
|
+
Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long.
|
|
1383
|
+
|
|
1384
|
+
The following is an example:
|
|
1385
|
+
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
|
|
1386
|
+
|
|
1387
|
+
---
|
|
1388
|
+
|
|
1389
|
+
##### `startupScriptS3Path`<sup>Optional</sup> <a name="startupScriptS3Path" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.startupScriptS3Path"></a>
|
|
1390
|
+
|
|
1391
|
+
```typescript
|
|
1392
|
+
public readonly startupScriptS3Path: string;
|
|
1393
|
+
```
|
|
1394
|
+
|
|
1395
|
+
- *Type:* string
|
|
1396
|
+
|
|
1397
|
+
The relative path to the startup shell script in your Amazon S3 bucket.
|
|
1398
|
+
|
|
1399
|
+
For example, s3://mwaa-environment/startup.sh.
|
|
1400
|
+
Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process.
|
|
1401
|
+
You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables.
|
|
1402
|
+
|
|
1403
|
+
---
|
|
1404
|
+
|
|
1405
|
+
##### `webserverAccessMode`<sup>Optional</sup> <a name="webserverAccessMode" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.webserverAccessMode"></a>
|
|
1406
|
+
|
|
1407
|
+
```typescript
|
|
1408
|
+
public readonly webserverAccessMode: WebserverAccessMode;
|
|
1409
|
+
```
|
|
1410
|
+
|
|
1411
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.WebserverAccessMode">WebserverAccessMode</a>
|
|
1412
|
+
|
|
1413
|
+
The Apache Airflow Web server access mode.
|
|
1414
|
+
|
|
1415
|
+
---
|
|
1416
|
+
|
|
1417
|
+
##### `webserverUrl`<sup>Optional</sup> <a name="webserverUrl" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.webserverUrl"></a>
|
|
1418
|
+
|
|
1419
|
+
```typescript
|
|
1420
|
+
public readonly webserverUrl: string;
|
|
1421
|
+
```
|
|
1422
|
+
|
|
1423
|
+
- *Type:* string
|
|
1424
|
+
|
|
1425
|
+
The URL of your Apache Airflow UI.
|
|
1426
|
+
|
|
1427
|
+
---
|
|
1428
|
+
|
|
1429
|
+
##### `webserverVpcEndpointService`<sup>Optional</sup> <a name="webserverVpcEndpointService" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.webserverVpcEndpointService"></a>
|
|
1430
|
+
|
|
1431
|
+
```typescript
|
|
1432
|
+
public readonly webserverVpcEndpointService: string;
|
|
1433
|
+
```
|
|
1434
|
+
|
|
1435
|
+
- *Type:* string
|
|
1436
|
+
|
|
1437
|
+
The VPC endpoint for the environment's web server.
|
|
1438
|
+
|
|
1439
|
+
---
|
|
1440
|
+
|
|
1441
|
+
##### `weeklyMaintenanceWindowStart`<sup>Optional</sup> <a name="weeklyMaintenanceWindowStart" id="@robhan-cdk-lib/aws_mwaa.EnvironmentBase.property.weeklyMaintenanceWindowStart"></a>
|
|
1442
|
+
|
|
1443
|
+
```typescript
|
|
1444
|
+
public readonly weeklyMaintenanceWindowStart: string;
|
|
1445
|
+
```
|
|
1446
|
+
|
|
1447
|
+
- *Type:* string
|
|
1448
|
+
|
|
1449
|
+
The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM.
|
|
1450
|
+
|
|
1451
|
+
For example: TUE:03:30. You can specify a start time in 30 minute increments only.
|
|
1452
|
+
|
|
1453
|
+
Supported input includes the following:
|
|
1454
|
+
MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)
|
|
1455
|
+
|
|
1456
|
+
---
|
|
1457
|
+
|
|
1458
|
+
|
|
1459
|
+
## Structs <a name="Structs" id="Structs"></a>
|
|
1460
|
+
|
|
1461
|
+
### EnvironmentAttributes <a name="EnvironmentAttributes" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes"></a>
|
|
1462
|
+
|
|
1463
|
+
Properties for importing an Amazon Managed Workflows for Apache Airflow Environment.
|
|
1464
|
+
|
|
1465
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.Initializer"></a>
|
|
1466
|
+
|
|
1467
|
+
```typescript
|
|
1468
|
+
import { EnvironmentAttributes } from '@robhan-cdk-lib/aws_mwaa'
|
|
1469
|
+
|
|
1470
|
+
const environmentAttributes: EnvironmentAttributes = { ... }
|
|
1471
|
+
```
|
|
1472
|
+
|
|
1473
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1474
|
+
|
|
1475
|
+
| **Name** | **Type** | **Description** |
|
|
1476
|
+
| --- | --- | --- |
|
|
1477
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.airflowConfigurationOptions">airflowConfigurationOptions</a></code> | <code>{[ key: string ]: string}</code> | A list of key-value pairs containing the Airflow configuration options for your environment. |
|
|
1478
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.environmentArn">environmentArn</a></code> | <code>string</code> | The ARN for the Amazon MWAA environment. |
|
|
1479
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.name">name</a></code> | <code>string</code> | The name of your Amazon MWAA environment. |
|
|
1480
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.airflowVersion">airflowVersion</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.AirflowVersion">AirflowVersion</a></code> | The version of Apache Airflow to use for the environment. |
|
|
1481
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.celeryExecutorQueue">celeryExecutorQueue</a></code> | <code>string</code> | The queue ARN for the environment's Celery Executor. |
|
|
1482
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.dagS3Path">dagS3Path</a></code> | <code>string</code> | The relative path to the DAGs folder on your Amazon S3 bucket. |
|
|
1483
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.databaseVpcEndpointService">databaseVpcEndpointService</a></code> | <code>string</code> | The VPC endpoint for the environment's Amazon RDS database. |
|
|
1484
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.endpointManagement">endpointManagement</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.EndpointManagement">EndpointManagement</a></code> | Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. |
|
|
1485
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.environmentClass">environmentClass</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentClass">EnvironmentClass</a></code> | The environment class type. |
|
|
1486
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.executionRole">executionRole</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | The execution role in IAM that allows MWAA to access AWS resources in your environment. |
|
|
1487
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.kmsKey">kmsKey</a></code> | <code>aws-cdk-lib.aws_kms.IKey</code> | The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. |
|
|
1488
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.loggingConfiguration">loggingConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.LoggingConfiguration">LoggingConfiguration</a></code> | The Apache Airflow logs being sent to CloudWatch Logs. |
|
|
1489
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn">loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published. |
|
|
1490
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.loggingConfigurationSchedulerLogsCloudWatchLogGroupArn">loggingConfigurationSchedulerLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published. |
|
|
1491
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.loggingConfigurationTaskLogsCloudWatchLogGroupArn">loggingConfigurationTaskLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published. |
|
|
1492
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.loggingConfigurationWebserverLogsCloudWatchLogGroupArn">loggingConfigurationWebserverLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published. |
|
|
1493
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.loggingConfigurationWorkerLogsCloudWatchLogGroupArn">loggingConfigurationWorkerLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published. |
|
|
1494
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.maxWebservers">maxWebservers</a></code> | <code>number</code> | The maximum number of web servers that you want to run in your environment. |
|
|
1495
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.maxWorkers">maxWorkers</a></code> | <code>number</code> | The maximum number of workers that you want to run in your environment. |
|
|
1496
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.minWebservers">minWebservers</a></code> | <code>number</code> | The minimum number of web servers that you want to run in your environment. |
|
|
1497
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.minWorkers">minWorkers</a></code> | <code>number</code> | The minimum number of workers that you want to run in your environment. |
|
|
1498
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.networkConfiguration">networkConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.NetworkConfiguration">NetworkConfiguration</a></code> | The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. |
|
|
1499
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.pluginsS3ObjectVersion">pluginsS3ObjectVersion</a></code> | <code>string</code> | The version of the plugins.zip file on your Amazon S3 bucket. |
|
|
1500
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.pluginsS3Path">pluginsS3Path</a></code> | <code>string</code> | The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. |
|
|
1501
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.requirementsS3ObjectVersion">requirementsS3ObjectVersion</a></code> | <code>string</code> | The version of the requirements.txt file on your Amazon S3 bucket. |
|
|
1502
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.requirementsS3Path">requirementsS3Path</a></code> | <code>string</code> | The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. |
|
|
1503
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.schedulers">schedulers</a></code> | <code>number</code> | The number of schedulers that you want to run in your environment. |
|
|
1504
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.sourceBucket">sourceBucket</a></code> | <code>aws-cdk-lib.aws_s3.IBucket</code> | The Amazon S3 bucket where your DAG code and supporting files are stored. |
|
|
1505
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.startupScriptS3ObjectVersion">startupScriptS3ObjectVersion</a></code> | <code>string</code> | The version of the startup shell script in your Amazon S3 bucket. |
|
|
1506
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.startupScriptS3Path">startupScriptS3Path</a></code> | <code>string</code> | The relative path to the startup shell script in your Amazon S3 bucket. |
|
|
1507
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.webserverAccessMode">webserverAccessMode</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.WebserverAccessMode">WebserverAccessMode</a></code> | The Apache Airflow Web server access mode. |
|
|
1508
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.webserverUrl">webserverUrl</a></code> | <code>string</code> | The URL of your Apache Airflow UI. |
|
|
1509
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.webserverVpcEndpointService">webserverVpcEndpointService</a></code> | <code>string</code> | The VPC endpoint for the environment's web server. |
|
|
1510
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.weeklyMaintenanceWindowStart">weeklyMaintenanceWindowStart</a></code> | <code>string</code> | The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. |
|
|
1511
|
+
|
|
1512
|
+
---
|
|
1513
|
+
|
|
1514
|
+
##### `airflowConfigurationOptions`<sup>Required</sup> <a name="airflowConfigurationOptions" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.airflowConfigurationOptions"></a>
|
|
1515
|
+
|
|
1516
|
+
```typescript
|
|
1517
|
+
public readonly airflowConfigurationOptions: {[ key: string ]: string};
|
|
1518
|
+
```
|
|
1519
|
+
|
|
1520
|
+
- *Type:* {[ key: string ]: string}
|
|
1521
|
+
|
|
1522
|
+
A list of key-value pairs containing the Airflow configuration options for your environment.
|
|
1523
|
+
|
|
1524
|
+
For example, core.default_timezone: utc.
|
|
1525
|
+
|
|
1526
|
+
---
|
|
1527
|
+
|
|
1528
|
+
##### `environmentArn`<sup>Required</sup> <a name="environmentArn" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.environmentArn"></a>
|
|
1529
|
+
|
|
1530
|
+
```typescript
|
|
1531
|
+
public readonly environmentArn: string;
|
|
1532
|
+
```
|
|
1533
|
+
|
|
1534
|
+
- *Type:* string
|
|
1535
|
+
|
|
1536
|
+
The ARN for the Amazon MWAA environment.
|
|
1537
|
+
|
|
1538
|
+
---
|
|
1539
|
+
|
|
1540
|
+
##### `name`<sup>Required</sup> <a name="name" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.name"></a>
|
|
1541
|
+
|
|
1542
|
+
```typescript
|
|
1543
|
+
public readonly name: string;
|
|
1544
|
+
```
|
|
1545
|
+
|
|
1546
|
+
- *Type:* string
|
|
1547
|
+
|
|
1548
|
+
The name of your Amazon MWAA environment.
|
|
1549
|
+
|
|
1550
|
+
---
|
|
1551
|
+
|
|
1552
|
+
##### `airflowVersion`<sup>Optional</sup> <a name="airflowVersion" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.airflowVersion"></a>
|
|
1553
|
+
|
|
1554
|
+
```typescript
|
|
1555
|
+
public readonly airflowVersion: AirflowVersion;
|
|
1556
|
+
```
|
|
1557
|
+
|
|
1558
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.AirflowVersion">AirflowVersion</a>
|
|
1559
|
+
|
|
1560
|
+
The version of Apache Airflow to use for the environment.
|
|
1561
|
+
|
|
1562
|
+
If no value is specified, defaults to the latest version.
|
|
1563
|
+
|
|
1564
|
+
If you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect.
|
|
1565
|
+
|
|
1566
|
+
---
|
|
1567
|
+
|
|
1568
|
+
##### `celeryExecutorQueue`<sup>Optional</sup> <a name="celeryExecutorQueue" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.celeryExecutorQueue"></a>
|
|
1569
|
+
|
|
1570
|
+
```typescript
|
|
1571
|
+
public readonly celeryExecutorQueue: string;
|
|
1572
|
+
```
|
|
1573
|
+
|
|
1574
|
+
- *Type:* string
|
|
1575
|
+
|
|
1576
|
+
The queue ARN for the environment's Celery Executor.
|
|
1577
|
+
|
|
1578
|
+
Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers.
|
|
1579
|
+
When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.
|
|
1580
|
+
|
|
1581
|
+
---
|
|
1582
|
+
|
|
1583
|
+
##### `dagS3Path`<sup>Optional</sup> <a name="dagS3Path" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.dagS3Path"></a>
|
|
1584
|
+
|
|
1585
|
+
```typescript
|
|
1586
|
+
public readonly dagS3Path: string;
|
|
1587
|
+
```
|
|
1588
|
+
|
|
1589
|
+
- *Type:* string
|
|
1590
|
+
|
|
1591
|
+
The relative path to the DAGs folder on your Amazon S3 bucket.
|
|
1592
|
+
|
|
1593
|
+
For example, dags.
|
|
1594
|
+
|
|
1595
|
+
---
|
|
1596
|
+
|
|
1597
|
+
##### `databaseVpcEndpointService`<sup>Optional</sup> <a name="databaseVpcEndpointService" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.databaseVpcEndpointService"></a>
|
|
1598
|
+
|
|
1599
|
+
```typescript
|
|
1600
|
+
public readonly databaseVpcEndpointService: string;
|
|
1601
|
+
```
|
|
1602
|
+
|
|
1603
|
+
- *Type:* string
|
|
1604
|
+
|
|
1605
|
+
The VPC endpoint for the environment's Amazon RDS database.
|
|
1606
|
+
|
|
1607
|
+
---
|
|
1608
|
+
|
|
1609
|
+
##### `endpointManagement`<sup>Optional</sup> <a name="endpointManagement" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.endpointManagement"></a>
|
|
1610
|
+
|
|
1611
|
+
```typescript
|
|
1612
|
+
public readonly endpointManagement: EndpointManagement;
|
|
1613
|
+
```
|
|
1614
|
+
|
|
1615
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.EndpointManagement">EndpointManagement</a>
|
|
1616
|
+
|
|
1617
|
+
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
|
|
1618
|
+
|
|
1619
|
+
If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC.
|
|
1620
|
+
If set to CUSTOMER, you must create, and manage, the VPC endpoints in your VPC.
|
|
1621
|
+
|
|
1622
|
+
---
|
|
1623
|
+
|
|
1624
|
+
##### `environmentClass`<sup>Optional</sup> <a name="environmentClass" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.environmentClass"></a>
|
|
1625
|
+
|
|
1626
|
+
```typescript
|
|
1627
|
+
public readonly environmentClass: EnvironmentClass;
|
|
1628
|
+
```
|
|
1629
|
+
|
|
1630
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentClass">EnvironmentClass</a>
|
|
1631
|
+
|
|
1632
|
+
The environment class type.
|
|
1633
|
+
|
|
1634
|
+
---
|
|
1635
|
+
|
|
1636
|
+
##### `executionRole`<sup>Optional</sup> <a name="executionRole" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.executionRole"></a>
|
|
1637
|
+
|
|
1638
|
+
```typescript
|
|
1639
|
+
public readonly executionRole: IRole;
|
|
1640
|
+
```
|
|
1641
|
+
|
|
1642
|
+
- *Type:* aws-cdk-lib.aws_iam.IRole
|
|
1643
|
+
|
|
1644
|
+
The execution role in IAM that allows MWAA to access AWS resources in your environment.
|
|
1645
|
+
|
|
1646
|
+
---
|
|
1647
|
+
|
|
1648
|
+
##### `kmsKey`<sup>Optional</sup> <a name="kmsKey" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.kmsKey"></a>
|
|
1649
|
+
|
|
1650
|
+
```typescript
|
|
1651
|
+
public readonly kmsKey: IKey;
|
|
1652
|
+
```
|
|
1653
|
+
|
|
1654
|
+
- *Type:* aws-cdk-lib.aws_kms.IKey
|
|
1655
|
+
|
|
1656
|
+
The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
|
|
1657
|
+
|
|
1658
|
+
You can use an AWS KMS key managed by MWAA, or a customer-managed KMS key (advanced).
|
|
1659
|
+
|
|
1660
|
+
---
|
|
1661
|
+
|
|
1662
|
+
##### `loggingConfiguration`<sup>Optional</sup> <a name="loggingConfiguration" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.loggingConfiguration"></a>
|
|
1663
|
+
|
|
1664
|
+
```typescript
|
|
1665
|
+
public readonly loggingConfiguration: LoggingConfiguration;
|
|
1666
|
+
```
|
|
1667
|
+
|
|
1668
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.LoggingConfiguration">LoggingConfiguration</a>
|
|
1669
|
+
|
|
1670
|
+
The Apache Airflow logs being sent to CloudWatch Logs.
|
|
1671
|
+
|
|
1672
|
+
---
|
|
1673
|
+
|
|
1674
|
+
##### `loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn"></a>
|
|
1675
|
+
|
|
1676
|
+
```typescript
|
|
1677
|
+
public readonly loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn: string;
|
|
1678
|
+
```
|
|
1679
|
+
|
|
1680
|
+
- *Type:* string
|
|
1681
|
+
|
|
1682
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published.
|
|
1683
|
+
|
|
1684
|
+
---
|
|
1685
|
+
|
|
1686
|
+
##### `loggingConfigurationSchedulerLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationSchedulerLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.loggingConfigurationSchedulerLogsCloudWatchLogGroupArn"></a>
|
|
1687
|
+
|
|
1688
|
+
```typescript
|
|
1689
|
+
public readonly loggingConfigurationSchedulerLogsCloudWatchLogGroupArn: string;
|
|
1690
|
+
```
|
|
1691
|
+
|
|
1692
|
+
- *Type:* string
|
|
1693
|
+
|
|
1694
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published.
|
|
1695
|
+
|
|
1696
|
+
---
|
|
1697
|
+
|
|
1698
|
+
##### `loggingConfigurationTaskLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationTaskLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.loggingConfigurationTaskLogsCloudWatchLogGroupArn"></a>
|
|
1699
|
+
|
|
1700
|
+
```typescript
|
|
1701
|
+
public readonly loggingConfigurationTaskLogsCloudWatchLogGroupArn: string;
|
|
1702
|
+
```
|
|
1703
|
+
|
|
1704
|
+
- *Type:* string
|
|
1705
|
+
|
|
1706
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published.
|
|
1707
|
+
|
|
1708
|
+
---
|
|
1709
|
+
|
|
1710
|
+
##### `loggingConfigurationWebserverLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationWebserverLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.loggingConfigurationWebserverLogsCloudWatchLogGroupArn"></a>
|
|
1711
|
+
|
|
1712
|
+
```typescript
|
|
1713
|
+
public readonly loggingConfigurationWebserverLogsCloudWatchLogGroupArn: string;
|
|
1714
|
+
```
|
|
1715
|
+
|
|
1716
|
+
- *Type:* string
|
|
1717
|
+
|
|
1718
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published.
|
|
1719
|
+
|
|
1720
|
+
---
|
|
1721
|
+
|
|
1722
|
+
##### `loggingConfigurationWorkerLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationWorkerLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.loggingConfigurationWorkerLogsCloudWatchLogGroupArn"></a>
|
|
1723
|
+
|
|
1724
|
+
```typescript
|
|
1725
|
+
public readonly loggingConfigurationWorkerLogsCloudWatchLogGroupArn: string;
|
|
1726
|
+
```
|
|
1727
|
+
|
|
1728
|
+
- *Type:* string
|
|
1729
|
+
|
|
1730
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published.
|
|
1731
|
+
|
|
1732
|
+
---
|
|
1733
|
+
|
|
1734
|
+
##### `maxWebservers`<sup>Optional</sup> <a name="maxWebservers" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.maxWebservers"></a>
|
|
1735
|
+
|
|
1736
|
+
```typescript
|
|
1737
|
+
public readonly maxWebservers: number;
|
|
1738
|
+
```
|
|
1739
|
+
|
|
1740
|
+
- *Type:* number
|
|
1741
|
+
|
|
1742
|
+
The maximum number of web servers that you want to run in your environment.
|
|
1743
|
+
|
|
1744
|
+
Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache
|
|
1745
|
+
Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network
|
|
1746
|
+
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
|
|
1747
|
+
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
|
|
1748
|
+
MinxWebserers.
|
|
1749
|
+
|
|
1750
|
+
Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro,
|
|
1751
|
+
which defaults to 1.
|
|
1752
|
+
|
|
1753
|
+
---
|
|
1754
|
+
|
|
1755
|
+
##### `maxWorkers`<sup>Optional</sup> <a name="maxWorkers" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.maxWorkers"></a>
|
|
1756
|
+
|
|
1757
|
+
```typescript
|
|
1758
|
+
public readonly maxWorkers: number;
|
|
1759
|
+
```
|
|
1760
|
+
|
|
1761
|
+
- *Type:* number
|
|
1762
|
+
|
|
1763
|
+
The maximum number of workers that you want to run in your environment.
|
|
1764
|
+
|
|
1765
|
+
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
|
|
1766
|
+
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
|
|
1767
|
+
the number you specify in MinWorkers.
|
|
1768
|
+
|
|
1769
|
+
---
|
|
1770
|
+
|
|
1771
|
+
##### `minWebservers`<sup>Optional</sup> <a name="minWebservers" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.minWebservers"></a>
|
|
1772
|
+
|
|
1773
|
+
```typescript
|
|
1774
|
+
public readonly minWebservers: number;
|
|
1775
|
+
```
|
|
1776
|
+
|
|
1777
|
+
- *Type:* number
|
|
1778
|
+
|
|
1779
|
+
The minimum number of web servers that you want to run in your environment.
|
|
1780
|
+
|
|
1781
|
+
Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache
|
|
1782
|
+
Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load,
|
|
1783
|
+
decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.
|
|
1784
|
+
|
|
1785
|
+
Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro,
|
|
1786
|
+
which defaults to 1.
|
|
1787
|
+
|
|
1788
|
+
---
|
|
1789
|
+
|
|
1790
|
+
##### `minWorkers`<sup>Optional</sup> <a name="minWorkers" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.minWorkers"></a>
|
|
1791
|
+
|
|
1792
|
+
```typescript
|
|
1793
|
+
public readonly minWorkers: number;
|
|
1794
|
+
```
|
|
1795
|
+
|
|
1796
|
+
- *Type:* number
|
|
1797
|
+
|
|
1798
|
+
The minimum number of workers that you want to run in your environment.
|
|
1799
|
+
|
|
1800
|
+
MWAA scales the number of Apache Airflow workers up to the number you
|
|
1801
|
+
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
|
|
1802
|
+
the worker count you specify in the MinWorkers field. For example, 2.
|
|
1803
|
+
|
|
1804
|
+
---
|
|
1805
|
+
|
|
1806
|
+
##### `networkConfiguration`<sup>Optional</sup> <a name="networkConfiguration" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.networkConfiguration"></a>
|
|
1807
|
+
|
|
1808
|
+
```typescript
|
|
1809
|
+
public readonly networkConfiguration: NetworkConfiguration;
|
|
1810
|
+
```
|
|
1811
|
+
|
|
1812
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.NetworkConfiguration">NetworkConfiguration</a>
|
|
1813
|
+
|
|
1814
|
+
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
|
|
1815
|
+
|
|
1816
|
+
---
|
|
1817
|
+
|
|
1818
|
+
##### `pluginsS3ObjectVersion`<sup>Optional</sup> <a name="pluginsS3ObjectVersion" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.pluginsS3ObjectVersion"></a>
|
|
1819
|
+
|
|
1820
|
+
```typescript
|
|
1821
|
+
public readonly pluginsS3ObjectVersion: string;
|
|
1822
|
+
```
|
|
1823
|
+
|
|
1824
|
+
- *Type:* string
|
|
1825
|
+
|
|
1826
|
+
The version of the plugins.zip file on your Amazon S3 bucket.
|
|
1827
|
+
|
|
1828
|
+
---
|
|
1829
|
+
|
|
1830
|
+
##### `pluginsS3Path`<sup>Optional</sup> <a name="pluginsS3Path" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.pluginsS3Path"></a>
|
|
1831
|
+
|
|
1832
|
+
```typescript
|
|
1833
|
+
public readonly pluginsS3Path: string;
|
|
1834
|
+
```
|
|
1835
|
+
|
|
1836
|
+
- *Type:* string
|
|
1837
|
+
|
|
1838
|
+
The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip.
|
|
1839
|
+
|
|
1840
|
+
---
|
|
1841
|
+
|
|
1842
|
+
##### `requirementsS3ObjectVersion`<sup>Optional</sup> <a name="requirementsS3ObjectVersion" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.requirementsS3ObjectVersion"></a>
|
|
1843
|
+
|
|
1844
|
+
```typescript
|
|
1845
|
+
public readonly requirementsS3ObjectVersion: string;
|
|
1846
|
+
```
|
|
1847
|
+
|
|
1848
|
+
- *Type:* string
|
|
1849
|
+
|
|
1850
|
+
The version of the requirements.txt file on your Amazon S3 bucket.
|
|
1851
|
+
|
|
1852
|
+
---
|
|
1853
|
+
|
|
1854
|
+
##### `requirementsS3Path`<sup>Optional</sup> <a name="requirementsS3Path" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.requirementsS3Path"></a>
|
|
1855
|
+
|
|
1856
|
+
```typescript
|
|
1857
|
+
public readonly requirementsS3Path: string;
|
|
1858
|
+
```
|
|
1859
|
+
|
|
1860
|
+
- *Type:* string
|
|
1861
|
+
|
|
1862
|
+
The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt.
|
|
1863
|
+
|
|
1864
|
+
---
|
|
1865
|
+
|
|
1866
|
+
##### `schedulers`<sup>Optional</sup> <a name="schedulers" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.schedulers"></a>
|
|
1867
|
+
|
|
1868
|
+
```typescript
|
|
1869
|
+
public readonly schedulers: number;
|
|
1870
|
+
```
|
|
1871
|
+
|
|
1872
|
+
- *Type:* number
|
|
1873
|
+
|
|
1874
|
+
The number of schedulers that you want to run in your environment.
|
|
1875
|
+
|
|
1876
|
+
Valid values:
|
|
1877
|
+
v2 - For environments larger than mw1.micro, accepts values from 2 to 5.
|
|
1878
|
+
Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
|
|
1879
|
+
v1 - Accepts 1.
|
|
1880
|
+
|
|
1881
|
+
---
|
|
1882
|
+
|
|
1883
|
+
##### `sourceBucket`<sup>Optional</sup> <a name="sourceBucket" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.sourceBucket"></a>
|
|
1884
|
+
|
|
1885
|
+
```typescript
|
|
1886
|
+
public readonly sourceBucket: IBucket;
|
|
1887
|
+
```
|
|
1888
|
+
|
|
1889
|
+
- *Type:* aws-cdk-lib.aws_s3.IBucket
|
|
1890
|
+
|
|
1891
|
+
The Amazon S3 bucket where your DAG code and supporting files are stored.
|
|
1892
|
+
|
|
1893
|
+
---
|
|
1894
|
+
|
|
1895
|
+
##### `startupScriptS3ObjectVersion`<sup>Optional</sup> <a name="startupScriptS3ObjectVersion" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.startupScriptS3ObjectVersion"></a>
|
|
1896
|
+
|
|
1897
|
+
```typescript
|
|
1898
|
+
public readonly startupScriptS3ObjectVersion: string;
|
|
1899
|
+
```
|
|
1900
|
+
|
|
1901
|
+
- *Type:* string
|
|
1902
|
+
|
|
1903
|
+
The version of the startup shell script in your Amazon S3 bucket.
|
|
1904
|
+
|
|
1905
|
+
You must specify the version ID that Amazon S3 assigns to the file every time you update the script.
|
|
1906
|
+
Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long.
|
|
1907
|
+
|
|
1908
|
+
The following is an example:
|
|
1909
|
+
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
|
|
1910
|
+
|
|
1911
|
+
---
|
|
1912
|
+
|
|
1913
|
+
##### `startupScriptS3Path`<sup>Optional</sup> <a name="startupScriptS3Path" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.startupScriptS3Path"></a>
|
|
1914
|
+
|
|
1915
|
+
```typescript
|
|
1916
|
+
public readonly startupScriptS3Path: string;
|
|
1917
|
+
```
|
|
1918
|
+
|
|
1919
|
+
- *Type:* string
|
|
1920
|
+
|
|
1921
|
+
The relative path to the startup shell script in your Amazon S3 bucket.
|
|
1922
|
+
|
|
1923
|
+
For example, s3://mwaa-environment/startup.sh.
|
|
1924
|
+
Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process.
|
|
1925
|
+
You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables.
|
|
1926
|
+
|
|
1927
|
+
---
|
|
1928
|
+
|
|
1929
|
+
##### `webserverAccessMode`<sup>Optional</sup> <a name="webserverAccessMode" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.webserverAccessMode"></a>
|
|
1930
|
+
|
|
1931
|
+
```typescript
|
|
1932
|
+
public readonly webserverAccessMode: WebserverAccessMode;
|
|
1933
|
+
```
|
|
1934
|
+
|
|
1935
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.WebserverAccessMode">WebserverAccessMode</a>
|
|
1936
|
+
|
|
1937
|
+
The Apache Airflow Web server access mode.
|
|
1938
|
+
|
|
1939
|
+
---
|
|
1940
|
+
|
|
1941
|
+
##### `webserverUrl`<sup>Optional</sup> <a name="webserverUrl" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.webserverUrl"></a>
|
|
1942
|
+
|
|
1943
|
+
```typescript
|
|
1944
|
+
public readonly webserverUrl: string;
|
|
1945
|
+
```
|
|
1946
|
+
|
|
1947
|
+
- *Type:* string
|
|
1948
|
+
|
|
1949
|
+
The URL of your Apache Airflow UI.
|
|
1950
|
+
|
|
1951
|
+
---
|
|
1952
|
+
|
|
1953
|
+
##### `webserverVpcEndpointService`<sup>Optional</sup> <a name="webserverVpcEndpointService" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.webserverVpcEndpointService"></a>
|
|
1954
|
+
|
|
1955
|
+
```typescript
|
|
1956
|
+
public readonly webserverVpcEndpointService: string;
|
|
1957
|
+
```
|
|
1958
|
+
|
|
1959
|
+
- *Type:* string
|
|
1960
|
+
|
|
1961
|
+
The VPC endpoint for the environment's web server.
|
|
1962
|
+
|
|
1963
|
+
---
|
|
1964
|
+
|
|
1965
|
+
##### `weeklyMaintenanceWindowStart`<sup>Optional</sup> <a name="weeklyMaintenanceWindowStart" id="@robhan-cdk-lib/aws_mwaa.EnvironmentAttributes.property.weeklyMaintenanceWindowStart"></a>
|
|
1966
|
+
|
|
1967
|
+
```typescript
|
|
1968
|
+
public readonly weeklyMaintenanceWindowStart: string;
|
|
1969
|
+
```
|
|
1970
|
+
|
|
1971
|
+
- *Type:* string
|
|
1972
|
+
|
|
1973
|
+
The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM.
|
|
1974
|
+
|
|
1975
|
+
For example: TUE:03:30. You can specify a start time in 30 minute increments only.
|
|
1976
|
+
|
|
1977
|
+
Supported input includes the following:
|
|
1978
|
+
MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)
|
|
1979
|
+
|
|
1980
|
+
---
|
|
1981
|
+
|
|
1982
|
+
### EnvironmentProps <a name="EnvironmentProps" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps"></a>
|
|
1983
|
+
|
|
1984
|
+
Properties for creating an Amazon Managed Workflows for Apache Airflow Environment.
|
|
1985
|
+
|
|
1986
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.Initializer"></a>
|
|
1987
|
+
|
|
1988
|
+
```typescript
|
|
1989
|
+
import { EnvironmentProps } from '@robhan-cdk-lib/aws_mwaa'
|
|
1990
|
+
|
|
1991
|
+
const environmentProps: EnvironmentProps = { ... }
|
|
1992
|
+
```
|
|
1993
|
+
|
|
1994
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1995
|
+
|
|
1996
|
+
| **Name** | **Type** | **Description** |
|
|
1997
|
+
| --- | --- | --- |
|
|
1998
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.airflowConfigurationOptions">airflowConfigurationOptions</a></code> | <code>{[ key: string ]: string}</code> | A list of key-value pairs containing the Airflow configuration options for your environment. |
|
|
1999
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.name">name</a></code> | <code>string</code> | The name of your Amazon MWAA environment. |
|
|
2000
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.airflowVersion">airflowVersion</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.AirflowVersion">AirflowVersion</a></code> | The version of Apache Airflow to use for the environment. |
|
|
2001
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.dagS3Path">dagS3Path</a></code> | <code>string</code> | The relative path to the DAGs folder on your Amazon S3 bucket. |
|
|
2002
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.endpointManagement">endpointManagement</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.EndpointManagement">EndpointManagement</a></code> | Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. |
|
|
2003
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.environmentClass">environmentClass</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentClass">EnvironmentClass</a></code> | The environment class type. |
|
|
2004
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.executionRole">executionRole</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | The execution role in IAM that allows MWAA to access AWS resources in your environment. |
|
|
2005
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.kmsKey">kmsKey</a></code> | <code>aws-cdk-lib.aws_kms.IKey</code> | The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. |
|
|
2006
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.loggingConfiguration">loggingConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.LoggingConfiguration">LoggingConfiguration</a></code> | The Apache Airflow logs being sent to CloudWatch Logs. |
|
|
2007
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.maxWebservers">maxWebservers</a></code> | <code>number</code> | The maximum number of web servers that you want to run in your environment. |
|
|
2008
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.maxWorkers">maxWorkers</a></code> | <code>number</code> | The maximum number of workers that you want to run in your environment. |
|
|
2009
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.minWebservers">minWebservers</a></code> | <code>number</code> | The minimum number of web servers that you want to run in your environment. |
|
|
2010
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.minWorkers">minWorkers</a></code> | <code>number</code> | The minimum number of workers that you want to run in your environment. |
|
|
2011
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.networkConfiguration">networkConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.NetworkConfiguration">NetworkConfiguration</a></code> | The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. |
|
|
2012
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.pluginsS3ObjectVersion">pluginsS3ObjectVersion</a></code> | <code>string</code> | The version of the plugins.zip file on your Amazon S3 bucket. |
|
|
2013
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.pluginsS3Path">pluginsS3Path</a></code> | <code>string</code> | The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. |
|
|
2014
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.requirementsS3ObjectVersion">requirementsS3ObjectVersion</a></code> | <code>string</code> | The version of the requirements.txt file on your Amazon S3 bucket. |
|
|
2015
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.requirementsS3Path">requirementsS3Path</a></code> | <code>string</code> | The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. |
|
|
2016
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.schedulers">schedulers</a></code> | <code>number</code> | The number of schedulers that you want to run in your environment. |
|
|
2017
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.sourceBucket">sourceBucket</a></code> | <code>aws-cdk-lib.aws_s3.IBucket</code> | The Amazon S3 bucket where your DAG code and supporting files are stored. |
|
|
2018
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.startupScriptS3ObjectVersion">startupScriptS3ObjectVersion</a></code> | <code>string</code> | The version of the startup shell script in your Amazon S3 bucket. |
|
|
2019
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.startupScriptS3Path">startupScriptS3Path</a></code> | <code>string</code> | The relative path to the startup shell script in your Amazon S3 bucket. |
|
|
2020
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.webserverAccessMode">webserverAccessMode</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.WebserverAccessMode">WebserverAccessMode</a></code> | The Apache Airflow Web server access mode. |
|
|
2021
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.weeklyMaintenanceWindowStart">weeklyMaintenanceWindowStart</a></code> | <code>string</code> | The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. |
|
|
2022
|
+
|
|
2023
|
+
---
|
|
2024
|
+
|
|
2025
|
+
##### `airflowConfigurationOptions`<sup>Required</sup> <a name="airflowConfigurationOptions" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.airflowConfigurationOptions"></a>
|
|
2026
|
+
|
|
2027
|
+
```typescript
|
|
2028
|
+
public readonly airflowConfigurationOptions: {[ key: string ]: string};
|
|
2029
|
+
```
|
|
2030
|
+
|
|
2031
|
+
- *Type:* {[ key: string ]: string}
|
|
2032
|
+
|
|
2033
|
+
A list of key-value pairs containing the Airflow configuration options for your environment.
|
|
2034
|
+
|
|
2035
|
+
For example, core.default_timezone: utc.
|
|
2036
|
+
|
|
2037
|
+
---
|
|
2038
|
+
|
|
2039
|
+
##### `name`<sup>Required</sup> <a name="name" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.name"></a>
|
|
2040
|
+
|
|
2041
|
+
```typescript
|
|
2042
|
+
public readonly name: string;
|
|
2043
|
+
```
|
|
2044
|
+
|
|
2045
|
+
- *Type:* string
|
|
2046
|
+
|
|
2047
|
+
The name of your Amazon MWAA environment.
|
|
2048
|
+
|
|
2049
|
+
---
|
|
2050
|
+
|
|
2051
|
+
##### `airflowVersion`<sup>Optional</sup> <a name="airflowVersion" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.airflowVersion"></a>
|
|
2052
|
+
|
|
2053
|
+
```typescript
|
|
2054
|
+
public readonly airflowVersion: AirflowVersion;
|
|
2055
|
+
```
|
|
2056
|
+
|
|
2057
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.AirflowVersion">AirflowVersion</a>
|
|
2058
|
+
|
|
2059
|
+
The version of Apache Airflow to use for the environment.
|
|
2060
|
+
|
|
2061
|
+
If no value is specified, defaults to the latest version.
|
|
2062
|
+
|
|
2063
|
+
If you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect.
|
|
2064
|
+
|
|
2065
|
+
---
|
|
2066
|
+
|
|
2067
|
+
##### `dagS3Path`<sup>Optional</sup> <a name="dagS3Path" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.dagS3Path"></a>
|
|
2068
|
+
|
|
2069
|
+
```typescript
|
|
2070
|
+
public readonly dagS3Path: string;
|
|
2071
|
+
```
|
|
2072
|
+
|
|
2073
|
+
- *Type:* string
|
|
2074
|
+
|
|
2075
|
+
The relative path to the DAGs folder on your Amazon S3 bucket.
|
|
2076
|
+
|
|
2077
|
+
For example, dags.
|
|
2078
|
+
|
|
2079
|
+
---
|
|
2080
|
+
|
|
2081
|
+
##### `endpointManagement`<sup>Optional</sup> <a name="endpointManagement" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.endpointManagement"></a>
|
|
2082
|
+
|
|
2083
|
+
```typescript
|
|
2084
|
+
public readonly endpointManagement: EndpointManagement;
|
|
2085
|
+
```
|
|
2086
|
+
|
|
2087
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.EndpointManagement">EndpointManagement</a>
|
|
2088
|
+
|
|
2089
|
+
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
|
|
2090
|
+
|
|
2091
|
+
If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC.
|
|
2092
|
+
If set to CUSTOMER, you must create, and manage, the VPC endpoints in your VPC.
|
|
2093
|
+
|
|
2094
|
+
---
|
|
2095
|
+
|
|
2096
|
+
##### `environmentClass`<sup>Optional</sup> <a name="environmentClass" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.environmentClass"></a>
|
|
2097
|
+
|
|
2098
|
+
```typescript
|
|
2099
|
+
public readonly environmentClass: EnvironmentClass;
|
|
2100
|
+
```
|
|
2101
|
+
|
|
2102
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentClass">EnvironmentClass</a>
|
|
2103
|
+
|
|
2104
|
+
The environment class type.
|
|
2105
|
+
|
|
2106
|
+
---
|
|
2107
|
+
|
|
2108
|
+
##### `executionRole`<sup>Optional</sup> <a name="executionRole" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.executionRole"></a>
|
|
2109
|
+
|
|
2110
|
+
```typescript
|
|
2111
|
+
public readonly executionRole: IRole;
|
|
2112
|
+
```
|
|
2113
|
+
|
|
2114
|
+
- *Type:* aws-cdk-lib.aws_iam.IRole
|
|
2115
|
+
|
|
2116
|
+
The execution role in IAM that allows MWAA to access AWS resources in your environment.
|
|
2117
|
+
|
|
2118
|
+
---
|
|
2119
|
+
|
|
2120
|
+
##### `kmsKey`<sup>Optional</sup> <a name="kmsKey" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.kmsKey"></a>
|
|
2121
|
+
|
|
2122
|
+
```typescript
|
|
2123
|
+
public readonly kmsKey: IKey;
|
|
2124
|
+
```
|
|
2125
|
+
|
|
2126
|
+
- *Type:* aws-cdk-lib.aws_kms.IKey
|
|
2127
|
+
|
|
2128
|
+
The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
|
|
2129
|
+
|
|
2130
|
+
You can use an AWS KMS key managed by MWAA, or a customer-managed KMS key (advanced).
|
|
2131
|
+
|
|
2132
|
+
---
|
|
2133
|
+
|
|
2134
|
+
##### `loggingConfiguration`<sup>Optional</sup> <a name="loggingConfiguration" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.loggingConfiguration"></a>
|
|
2135
|
+
|
|
2136
|
+
```typescript
|
|
2137
|
+
public readonly loggingConfiguration: LoggingConfiguration;
|
|
2138
|
+
```
|
|
2139
|
+
|
|
2140
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.LoggingConfiguration">LoggingConfiguration</a>
|
|
2141
|
+
|
|
2142
|
+
The Apache Airflow logs being sent to CloudWatch Logs.
|
|
2143
|
+
|
|
2144
|
+
---
|
|
2145
|
+
|
|
2146
|
+
##### `maxWebservers`<sup>Optional</sup> <a name="maxWebservers" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.maxWebservers"></a>
|
|
2147
|
+
|
|
2148
|
+
```typescript
|
|
2149
|
+
public readonly maxWebservers: number;
|
|
2150
|
+
```
|
|
2151
|
+
|
|
2152
|
+
- *Type:* number
|
|
2153
|
+
|
|
2154
|
+
The maximum number of web servers that you want to run in your environment.
|
|
2155
|
+
|
|
2156
|
+
Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache
|
|
2157
|
+
Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network
|
|
2158
|
+
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
|
|
2159
|
+
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
|
|
2160
|
+
MinxWebserers.
|
|
2161
|
+
|
|
2162
|
+
Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro,
|
|
2163
|
+
which defaults to 1.
|
|
2164
|
+
|
|
2165
|
+
---
|
|
2166
|
+
|
|
2167
|
+
##### `maxWorkers`<sup>Optional</sup> <a name="maxWorkers" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.maxWorkers"></a>
|
|
2168
|
+
|
|
2169
|
+
```typescript
|
|
2170
|
+
public readonly maxWorkers: number;
|
|
2171
|
+
```
|
|
2172
|
+
|
|
2173
|
+
- *Type:* number
|
|
2174
|
+
|
|
2175
|
+
The maximum number of workers that you want to run in your environment.
|
|
2176
|
+
|
|
2177
|
+
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
|
|
2178
|
+
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
|
|
2179
|
+
the number you specify in MinWorkers.
|
|
2180
|
+
|
|
2181
|
+
---
|
|
2182
|
+
|
|
2183
|
+
##### `minWebservers`<sup>Optional</sup> <a name="minWebservers" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.minWebservers"></a>
|
|
2184
|
+
|
|
2185
|
+
```typescript
|
|
2186
|
+
public readonly minWebservers: number;
|
|
2187
|
+
```
|
|
2188
|
+
|
|
2189
|
+
- *Type:* number
|
|
2190
|
+
|
|
2191
|
+
The minimum number of web servers that you want to run in your environment.
|
|
2192
|
+
|
|
2193
|
+
Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache
|
|
2194
|
+
Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load,
|
|
2195
|
+
decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.
|
|
2196
|
+
|
|
2197
|
+
Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro,
|
|
2198
|
+
which defaults to 1.
|
|
2199
|
+
|
|
2200
|
+
---
|
|
2201
|
+
|
|
2202
|
+
##### `minWorkers`<sup>Optional</sup> <a name="minWorkers" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.minWorkers"></a>
|
|
2203
|
+
|
|
2204
|
+
```typescript
|
|
2205
|
+
public readonly minWorkers: number;
|
|
2206
|
+
```
|
|
2207
|
+
|
|
2208
|
+
- *Type:* number
|
|
2209
|
+
|
|
2210
|
+
The minimum number of workers that you want to run in your environment.
|
|
2211
|
+
|
|
2212
|
+
MWAA scales the number of Apache Airflow workers up to the number you
|
|
2213
|
+
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
|
|
2214
|
+
the worker count you specify in the MinWorkers field. For example, 2.
|
|
2215
|
+
|
|
2216
|
+
---
|
|
2217
|
+
|
|
2218
|
+
##### `networkConfiguration`<sup>Optional</sup> <a name="networkConfiguration" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.networkConfiguration"></a>
|
|
2219
|
+
|
|
2220
|
+
```typescript
|
|
2221
|
+
public readonly networkConfiguration: NetworkConfiguration;
|
|
2222
|
+
```
|
|
2223
|
+
|
|
2224
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.NetworkConfiguration">NetworkConfiguration</a>
|
|
2225
|
+
|
|
2226
|
+
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
|
|
2227
|
+
|
|
2228
|
+
---
|
|
2229
|
+
|
|
2230
|
+
##### `pluginsS3ObjectVersion`<sup>Optional</sup> <a name="pluginsS3ObjectVersion" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.pluginsS3ObjectVersion"></a>
|
|
2231
|
+
|
|
2232
|
+
```typescript
|
|
2233
|
+
public readonly pluginsS3ObjectVersion: string;
|
|
2234
|
+
```
|
|
2235
|
+
|
|
2236
|
+
- *Type:* string
|
|
2237
|
+
|
|
2238
|
+
The version of the plugins.zip file on your Amazon S3 bucket.
|
|
2239
|
+
|
|
2240
|
+
---
|
|
2241
|
+
|
|
2242
|
+
##### `pluginsS3Path`<sup>Optional</sup> <a name="pluginsS3Path" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.pluginsS3Path"></a>
|
|
2243
|
+
|
|
2244
|
+
```typescript
|
|
2245
|
+
public readonly pluginsS3Path: string;
|
|
2246
|
+
```
|
|
2247
|
+
|
|
2248
|
+
- *Type:* string
|
|
2249
|
+
|
|
2250
|
+
The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip.
|
|
2251
|
+
|
|
2252
|
+
---
|
|
2253
|
+
|
|
2254
|
+
##### `requirementsS3ObjectVersion`<sup>Optional</sup> <a name="requirementsS3ObjectVersion" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.requirementsS3ObjectVersion"></a>
|
|
2255
|
+
|
|
2256
|
+
```typescript
|
|
2257
|
+
public readonly requirementsS3ObjectVersion: string;
|
|
2258
|
+
```
|
|
2259
|
+
|
|
2260
|
+
- *Type:* string
|
|
2261
|
+
|
|
2262
|
+
The version of the requirements.txt file on your Amazon S3 bucket.
|
|
2263
|
+
|
|
2264
|
+
---
|
|
2265
|
+
|
|
2266
|
+
##### `requirementsS3Path`<sup>Optional</sup> <a name="requirementsS3Path" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.requirementsS3Path"></a>
|
|
2267
|
+
|
|
2268
|
+
```typescript
|
|
2269
|
+
public readonly requirementsS3Path: string;
|
|
2270
|
+
```
|
|
2271
|
+
|
|
2272
|
+
- *Type:* string
|
|
2273
|
+
|
|
2274
|
+
The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt.
|
|
2275
|
+
|
|
2276
|
+
---
|
|
2277
|
+
|
|
2278
|
+
##### `schedulers`<sup>Optional</sup> <a name="schedulers" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.schedulers"></a>
|
|
2279
|
+
|
|
2280
|
+
```typescript
|
|
2281
|
+
public readonly schedulers: number;
|
|
2282
|
+
```
|
|
2283
|
+
|
|
2284
|
+
- *Type:* number
|
|
2285
|
+
|
|
2286
|
+
The number of schedulers that you want to run in your environment.
|
|
2287
|
+
|
|
2288
|
+
Valid values:
|
|
2289
|
+
v2 - For environments larger than mw1.micro, accepts values from 2 to 5.
|
|
2290
|
+
Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
|
|
2291
|
+
v1 - Accepts 1.
|
|
2292
|
+
|
|
2293
|
+
---
|
|
2294
|
+
|
|
2295
|
+
##### `sourceBucket`<sup>Optional</sup> <a name="sourceBucket" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.sourceBucket"></a>
|
|
2296
|
+
|
|
2297
|
+
```typescript
|
|
2298
|
+
public readonly sourceBucket: IBucket;
|
|
2299
|
+
```
|
|
2300
|
+
|
|
2301
|
+
- *Type:* aws-cdk-lib.aws_s3.IBucket
|
|
2302
|
+
|
|
2303
|
+
The Amazon S3 bucket where your DAG code and supporting files are stored.
|
|
2304
|
+
|
|
2305
|
+
---
|
|
2306
|
+
|
|
2307
|
+
##### `startupScriptS3ObjectVersion`<sup>Optional</sup> <a name="startupScriptS3ObjectVersion" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.startupScriptS3ObjectVersion"></a>
|
|
2308
|
+
|
|
2309
|
+
```typescript
|
|
2310
|
+
public readonly startupScriptS3ObjectVersion: string;
|
|
2311
|
+
```
|
|
2312
|
+
|
|
2313
|
+
- *Type:* string
|
|
2314
|
+
|
|
2315
|
+
The version of the startup shell script in your Amazon S3 bucket.
|
|
2316
|
+
|
|
2317
|
+
You must specify the version ID that Amazon S3 assigns to the file every time you update the script.
|
|
2318
|
+
Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long.
|
|
2319
|
+
|
|
2320
|
+
The following is an example:
|
|
2321
|
+
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
|
|
2322
|
+
|
|
2323
|
+
---
|
|
2324
|
+
|
|
2325
|
+
##### `startupScriptS3Path`<sup>Optional</sup> <a name="startupScriptS3Path" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.startupScriptS3Path"></a>
|
|
2326
|
+
|
|
2327
|
+
```typescript
|
|
2328
|
+
public readonly startupScriptS3Path: string;
|
|
2329
|
+
```
|
|
2330
|
+
|
|
2331
|
+
- *Type:* string
|
|
2332
|
+
|
|
2333
|
+
The relative path to the startup shell script in your Amazon S3 bucket.
|
|
2334
|
+
|
|
2335
|
+
For example, s3://mwaa-environment/startup.sh.
|
|
2336
|
+
Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process.
|
|
2337
|
+
You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables.
|
|
2338
|
+
|
|
2339
|
+
---
|
|
2340
|
+
|
|
2341
|
+
##### `webserverAccessMode`<sup>Optional</sup> <a name="webserverAccessMode" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.webserverAccessMode"></a>
|
|
2342
|
+
|
|
2343
|
+
```typescript
|
|
2344
|
+
public readonly webserverAccessMode: WebserverAccessMode;
|
|
2345
|
+
```
|
|
2346
|
+
|
|
2347
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.WebserverAccessMode">WebserverAccessMode</a>
|
|
2348
|
+
|
|
2349
|
+
The Apache Airflow Web server access mode.
|
|
2350
|
+
|
|
2351
|
+
---
|
|
2352
|
+
|
|
2353
|
+
##### `weeklyMaintenanceWindowStart`<sup>Optional</sup> <a name="weeklyMaintenanceWindowStart" id="@robhan-cdk-lib/aws_mwaa.EnvironmentProps.property.weeklyMaintenanceWindowStart"></a>
|
|
2354
|
+
|
|
2355
|
+
```typescript
|
|
2356
|
+
public readonly weeklyMaintenanceWindowStart: string;
|
|
2357
|
+
```
|
|
2358
|
+
|
|
2359
|
+
- *Type:* string
|
|
2360
|
+
|
|
2361
|
+
The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM.
|
|
2362
|
+
|
|
2363
|
+
For example: TUE:03:30. You can specify a start time in 30 minute increments only.
|
|
2364
|
+
|
|
2365
|
+
Supported input includes the following:
|
|
2366
|
+
MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)
|
|
2367
|
+
|
|
2368
|
+
---
|
|
2369
|
+
|
|
2370
|
+
### LoggingConfiguration <a name="LoggingConfiguration" id="@robhan-cdk-lib/aws_mwaa.LoggingConfiguration"></a>
|
|
2371
|
+
|
|
2372
|
+
The type of Apache Airflow logs to send to CloudWatch Logs.
|
|
2373
|
+
|
|
2374
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_mwaa.LoggingConfiguration.Initializer"></a>
|
|
2375
|
+
|
|
2376
|
+
```typescript
|
|
2377
|
+
import { LoggingConfiguration } from '@robhan-cdk-lib/aws_mwaa'
|
|
2378
|
+
|
|
2379
|
+
const loggingConfiguration: LoggingConfiguration = { ... }
|
|
2380
|
+
```
|
|
2381
|
+
|
|
2382
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
2383
|
+
|
|
2384
|
+
| **Name** | **Type** | **Description** |
|
|
2385
|
+
| --- | --- | --- |
|
|
2386
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.LoggingConfiguration.property.dagProcessingLogs">dagProcessingLogs</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration">ModuleLoggingConfiguration</a></code> | Defines the processing logs sent to CloudWatch Logs and the logging level to send. |
|
|
2387
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.LoggingConfiguration.property.schedulerLogs">schedulerLogs</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration">ModuleLoggingConfiguration</a></code> | Defines the scheduler logs sent to CloudWatch Logs and the logging level to send. |
|
|
2388
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.LoggingConfiguration.property.taskLogs">taskLogs</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration">ModuleLoggingConfiguration</a></code> | Defines the task logs sent to CloudWatch Logs and the logging level to send. |
|
|
2389
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.LoggingConfiguration.property.webServerLogs">webServerLogs</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration">ModuleLoggingConfiguration</a></code> | Defines the web server logs sent to CloudWatch Logs and the logging level to send. |
|
|
2390
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.LoggingConfiguration.property.workerLogs">workerLogs</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration">ModuleLoggingConfiguration</a></code> | Defines the worker logs sent to CloudWatch Logs and the logging level to send. |
|
|
2391
|
+
|
|
2392
|
+
---
|
|
2393
|
+
|
|
2394
|
+
##### `dagProcessingLogs`<sup>Optional</sup> <a name="dagProcessingLogs" id="@robhan-cdk-lib/aws_mwaa.LoggingConfiguration.property.dagProcessingLogs"></a>
|
|
2395
|
+
|
|
2396
|
+
```typescript
|
|
2397
|
+
public readonly dagProcessingLogs: ModuleLoggingConfiguration;
|
|
2398
|
+
```
|
|
2399
|
+
|
|
2400
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration">ModuleLoggingConfiguration</a>
|
|
2401
|
+
|
|
2402
|
+
Defines the processing logs sent to CloudWatch Logs and the logging level to send.
|
|
2403
|
+
|
|
2404
|
+
---
|
|
2405
|
+
|
|
2406
|
+
##### `schedulerLogs`<sup>Optional</sup> <a name="schedulerLogs" id="@robhan-cdk-lib/aws_mwaa.LoggingConfiguration.property.schedulerLogs"></a>
|
|
2407
|
+
|
|
2408
|
+
```typescript
|
|
2409
|
+
public readonly schedulerLogs: ModuleLoggingConfiguration;
|
|
2410
|
+
```
|
|
2411
|
+
|
|
2412
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration">ModuleLoggingConfiguration</a>
|
|
2413
|
+
|
|
2414
|
+
Defines the scheduler logs sent to CloudWatch Logs and the logging level to send.
|
|
2415
|
+
|
|
2416
|
+
---
|
|
2417
|
+
|
|
2418
|
+
##### `taskLogs`<sup>Optional</sup> <a name="taskLogs" id="@robhan-cdk-lib/aws_mwaa.LoggingConfiguration.property.taskLogs"></a>
|
|
2419
|
+
|
|
2420
|
+
```typescript
|
|
2421
|
+
public readonly taskLogs: ModuleLoggingConfiguration;
|
|
2422
|
+
```
|
|
2423
|
+
|
|
2424
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration">ModuleLoggingConfiguration</a>
|
|
2425
|
+
|
|
2426
|
+
Defines the task logs sent to CloudWatch Logs and the logging level to send.
|
|
2427
|
+
|
|
2428
|
+
---
|
|
2429
|
+
|
|
2430
|
+
##### `webServerLogs`<sup>Optional</sup> <a name="webServerLogs" id="@robhan-cdk-lib/aws_mwaa.LoggingConfiguration.property.webServerLogs"></a>
|
|
2431
|
+
|
|
2432
|
+
```typescript
|
|
2433
|
+
public readonly webServerLogs: ModuleLoggingConfiguration;
|
|
2434
|
+
```
|
|
2435
|
+
|
|
2436
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration">ModuleLoggingConfiguration</a>
|
|
2437
|
+
|
|
2438
|
+
Defines the web server logs sent to CloudWatch Logs and the logging level to send.
|
|
2439
|
+
|
|
2440
|
+
---
|
|
2441
|
+
|
|
2442
|
+
##### `workerLogs`<sup>Optional</sup> <a name="workerLogs" id="@robhan-cdk-lib/aws_mwaa.LoggingConfiguration.property.workerLogs"></a>
|
|
2443
|
+
|
|
2444
|
+
```typescript
|
|
2445
|
+
public readonly workerLogs: ModuleLoggingConfiguration;
|
|
2446
|
+
```
|
|
2447
|
+
|
|
2448
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration">ModuleLoggingConfiguration</a>
|
|
2449
|
+
|
|
2450
|
+
Defines the worker logs sent to CloudWatch Logs and the logging level to send.
|
|
2451
|
+
|
|
2452
|
+
---
|
|
2453
|
+
|
|
2454
|
+
### ModuleLoggingConfiguration <a name="ModuleLoggingConfiguration" id="@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration"></a>
|
|
2455
|
+
|
|
2456
|
+
Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs).
|
|
2457
|
+
|
|
2458
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration.Initializer"></a>
|
|
2459
|
+
|
|
2460
|
+
```typescript
|
|
2461
|
+
import { ModuleLoggingConfiguration } from '@robhan-cdk-lib/aws_mwaa'
|
|
2462
|
+
|
|
2463
|
+
const moduleLoggingConfiguration: ModuleLoggingConfiguration = { ... }
|
|
2464
|
+
```
|
|
2465
|
+
|
|
2466
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
2467
|
+
|
|
2468
|
+
| **Name** | **Type** | **Description** |
|
|
2469
|
+
| --- | --- | --- |
|
|
2470
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration.property.cloudWatchLogGroup">cloudWatchLogGroup</a></code> | <code>aws-cdk-lib.aws_logs.ILogGroup</code> | The CloudWatch Logs log group for each type ofApache Airflow log type that you have enabled. |
|
|
2471
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration.property.enabled">enabled</a></code> | <code>boolean</code> | Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs. |
|
|
2472
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration.property.logLevel">logLevel</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.LogLevel">LogLevel</a></code> | Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. |
|
|
2473
|
+
|
|
2474
|
+
---
|
|
2475
|
+
|
|
2476
|
+
##### `cloudWatchLogGroup`<sup>Optional</sup> <a name="cloudWatchLogGroup" id="@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration.property.cloudWatchLogGroup"></a>
|
|
2477
|
+
|
|
2478
|
+
```typescript
|
|
2479
|
+
public readonly cloudWatchLogGroup: ILogGroup;
|
|
2480
|
+
```
|
|
2481
|
+
|
|
2482
|
+
- *Type:* aws-cdk-lib.aws_logs.ILogGroup
|
|
2483
|
+
|
|
2484
|
+
The CloudWatch Logs log group for each type ofApache Airflow log type that you have enabled.
|
|
2485
|
+
|
|
2486
|
+
---
|
|
2487
|
+
|
|
2488
|
+
##### `enabled`<sup>Optional</sup> <a name="enabled" id="@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration.property.enabled"></a>
|
|
2489
|
+
|
|
2490
|
+
```typescript
|
|
2491
|
+
public readonly enabled: boolean;
|
|
2492
|
+
```
|
|
2493
|
+
|
|
2494
|
+
- *Type:* boolean
|
|
2495
|
+
|
|
2496
|
+
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
|
|
2497
|
+
|
|
2498
|
+
---
|
|
2499
|
+
|
|
2500
|
+
##### `logLevel`<sup>Optional</sup> <a name="logLevel" id="@robhan-cdk-lib/aws_mwaa.ModuleLoggingConfiguration.property.logLevel"></a>
|
|
2501
|
+
|
|
2502
|
+
```typescript
|
|
2503
|
+
public readonly logLevel: LogLevel;
|
|
2504
|
+
```
|
|
2505
|
+
|
|
2506
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.LogLevel">LogLevel</a>
|
|
2507
|
+
|
|
2508
|
+
Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs.
|
|
2509
|
+
|
|
2510
|
+
---
|
|
2511
|
+
|
|
2512
|
+
### NetworkConfiguration <a name="NetworkConfiguration" id="@robhan-cdk-lib/aws_mwaa.NetworkConfiguration"></a>
|
|
2513
|
+
|
|
2514
|
+
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
|
|
2515
|
+
|
|
2516
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_mwaa.NetworkConfiguration.Initializer"></a>
|
|
2517
|
+
|
|
2518
|
+
```typescript
|
|
2519
|
+
import { NetworkConfiguration } from '@robhan-cdk-lib/aws_mwaa'
|
|
2520
|
+
|
|
2521
|
+
const networkConfiguration: NetworkConfiguration = { ... }
|
|
2522
|
+
```
|
|
2523
|
+
|
|
2524
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
2525
|
+
|
|
2526
|
+
| **Name** | **Type** | **Description** |
|
|
2527
|
+
| --- | --- | --- |
|
|
2528
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.NetworkConfiguration.property.securityGroups">securityGroups</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup[]</code> | A list of one or more security groups. |
|
|
2529
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.NetworkConfiguration.property.subnets">subnets</a></code> | <code>aws-cdk-lib.aws_ec2.ISubnet[]</code> | A list of subnets. |
|
|
2530
|
+
|
|
2531
|
+
---
|
|
2532
|
+
|
|
2533
|
+
##### `securityGroups`<sup>Optional</sup> <a name="securityGroups" id="@robhan-cdk-lib/aws_mwaa.NetworkConfiguration.property.securityGroups"></a>
|
|
2534
|
+
|
|
2535
|
+
```typescript
|
|
2536
|
+
public readonly securityGroups: ISecurityGroup[];
|
|
2537
|
+
```
|
|
2538
|
+
|
|
2539
|
+
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
|
|
2540
|
+
|
|
2541
|
+
A list of one or more security groups.
|
|
2542
|
+
|
|
2543
|
+
Accepts up to 5 security groups. A security group must be attached to the same VPC as the subnets.
|
|
2544
|
+
|
|
2545
|
+
---
|
|
2546
|
+
|
|
2547
|
+
##### `subnets`<sup>Optional</sup> <a name="subnets" id="@robhan-cdk-lib/aws_mwaa.NetworkConfiguration.property.subnets"></a>
|
|
2548
|
+
|
|
2549
|
+
```typescript
|
|
2550
|
+
public readonly subnets: ISubnet[];
|
|
2551
|
+
```
|
|
2552
|
+
|
|
2553
|
+
- *Type:* aws-cdk-lib.aws_ec2.ISubnet[]
|
|
2554
|
+
|
|
2555
|
+
A list of subnets.
|
|
2556
|
+
|
|
2557
|
+
Required to create an environment. Must be private subnets in two different availability zones.
|
|
2558
|
+
A subnet must be attached to the same VPC as the security group.
|
|
2559
|
+
|
|
2560
|
+
---
|
|
2561
|
+
|
|
2562
|
+
|
|
2563
|
+
## Protocols <a name="Protocols" id="Protocols"></a>
|
|
2564
|
+
|
|
2565
|
+
### IEnvironment <a name="IEnvironment" id="@robhan-cdk-lib/aws_mwaa.IEnvironment"></a>
|
|
2566
|
+
|
|
2567
|
+
- *Extends:* aws-cdk-lib.IResource
|
|
2568
|
+
|
|
2569
|
+
- *Implemented By:* <a href="#@robhan-cdk-lib/aws_mwaa.Environment">Environment</a>, <a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentBase">EnvironmentBase</a>, <a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment">IEnvironment</a>
|
|
2570
|
+
|
|
2571
|
+
|
|
2572
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
2573
|
+
|
|
2574
|
+
| **Name** | **Type** | **Description** |
|
|
2575
|
+
| --- | --- | --- |
|
|
2576
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
2577
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
2578
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
|
|
2579
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.airflowConfigurationOptions">airflowConfigurationOptions</a></code> | <code>{[ key: string ]: string}</code> | A list of key-value pairs containing the Airflow configuration options for your environment. |
|
|
2580
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.environmentArn">environmentArn</a></code> | <code>string</code> | The ARN for the Amazon MWAA environment. |
|
|
2581
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.name">name</a></code> | <code>string</code> | The name of your Amazon MWAA environment. |
|
|
2582
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.airflowVersion">airflowVersion</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.AirflowVersion">AirflowVersion</a></code> | The version of Apache Airflow to use for the environment. |
|
|
2583
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.celeryExecutorQueue">celeryExecutorQueue</a></code> | <code>string</code> | The queue ARN for the environment's Celery Executor. |
|
|
2584
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.dagS3Path">dagS3Path</a></code> | <code>string</code> | The relative path to the DAGs folder on your Amazon S3 bucket. |
|
|
2585
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.databaseVpcEndpointService">databaseVpcEndpointService</a></code> | <code>string</code> | The VPC endpoint for the environment's Amazon RDS database. |
|
|
2586
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.endpointManagement">endpointManagement</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.EndpointManagement">EndpointManagement</a></code> | Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. |
|
|
2587
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.environmentClass">environmentClass</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentClass">EnvironmentClass</a></code> | The environment class type. |
|
|
2588
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.executionRole">executionRole</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | The execution role in IAM that allows MWAA to access AWS resources in your environment. |
|
|
2589
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.kmsKey">kmsKey</a></code> | <code>aws-cdk-lib.aws_kms.IKey</code> | The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. |
|
|
2590
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.loggingConfiguration">loggingConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.LoggingConfiguration">LoggingConfiguration</a></code> | The Apache Airflow logs being sent to CloudWatch Logs. |
|
|
2591
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn">loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published. |
|
|
2592
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.loggingConfigurationSchedulerLogsCloudWatchLogGroupArn">loggingConfigurationSchedulerLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published. |
|
|
2593
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.loggingConfigurationTaskLogsCloudWatchLogGroupArn">loggingConfigurationTaskLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published. |
|
|
2594
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.loggingConfigurationWebserverLogsCloudWatchLogGroupArn">loggingConfigurationWebserverLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published. |
|
|
2595
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.loggingConfigurationWorkerLogsCloudWatchLogGroupArn">loggingConfigurationWorkerLogsCloudWatchLogGroupArn</a></code> | <code>string</code> | The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published. |
|
|
2596
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.maxWebservers">maxWebservers</a></code> | <code>number</code> | The maximum number of web servers that you want to run in your environment. |
|
|
2597
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.maxWorkers">maxWorkers</a></code> | <code>number</code> | The maximum number of workers that you want to run in your environment. |
|
|
2598
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.minWebservers">minWebservers</a></code> | <code>number</code> | The minimum number of web servers that you want to run in your environment. |
|
|
2599
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.minWorkers">minWorkers</a></code> | <code>number</code> | The minimum number of workers that you want to run in your environment. |
|
|
2600
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.networkConfiguration">networkConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.NetworkConfiguration">NetworkConfiguration</a></code> | The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. |
|
|
2601
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.pluginsS3ObjectVersion">pluginsS3ObjectVersion</a></code> | <code>string</code> | The version of the plugins.zip file on your Amazon S3 bucket. |
|
|
2602
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.pluginsS3Path">pluginsS3Path</a></code> | <code>string</code> | The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. |
|
|
2603
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.requirementsS3ObjectVersion">requirementsS3ObjectVersion</a></code> | <code>string</code> | The version of the requirements.txt file on your Amazon S3 bucket. |
|
|
2604
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.requirementsS3Path">requirementsS3Path</a></code> | <code>string</code> | The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. |
|
|
2605
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.schedulers">schedulers</a></code> | <code>number</code> | The number of schedulers that you want to run in your environment. |
|
|
2606
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.sourceBucket">sourceBucket</a></code> | <code>aws-cdk-lib.aws_s3.IBucket</code> | The Amazon S3 bucket where your DAG code and supporting files are stored. |
|
|
2607
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.startupScriptS3ObjectVersion">startupScriptS3ObjectVersion</a></code> | <code>string</code> | The version of the startup shell script in your Amazon S3 bucket. |
|
|
2608
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.startupScriptS3Path">startupScriptS3Path</a></code> | <code>string</code> | The relative path to the startup shell script in your Amazon S3 bucket. |
|
|
2609
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.webserverAccessMode">webserverAccessMode</a></code> | <code><a href="#@robhan-cdk-lib/aws_mwaa.WebserverAccessMode">WebserverAccessMode</a></code> | The Apache Airflow Web server access mode. |
|
|
2610
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.webserverUrl">webserverUrl</a></code> | <code>string</code> | The URL of your Apache Airflow UI. |
|
|
2611
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.webserverVpcEndpointService">webserverVpcEndpointService</a></code> | <code>string</code> | The VPC endpoint for the environment's web server. |
|
|
2612
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.IEnvironment.property.weeklyMaintenanceWindowStart">weeklyMaintenanceWindowStart</a></code> | <code>string</code> | The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. |
|
|
2613
|
+
|
|
2614
|
+
---
|
|
2615
|
+
|
|
2616
|
+
##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.node"></a>
|
|
2617
|
+
|
|
2618
|
+
```typescript
|
|
2619
|
+
public readonly node: Node;
|
|
2620
|
+
```
|
|
2621
|
+
|
|
2622
|
+
- *Type:* constructs.Node
|
|
2623
|
+
|
|
2624
|
+
The tree node.
|
|
2625
|
+
|
|
2626
|
+
---
|
|
2627
|
+
|
|
2628
|
+
##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.env"></a>
|
|
2629
|
+
|
|
2630
|
+
```typescript
|
|
2631
|
+
public readonly env: ResourceEnvironment;
|
|
2632
|
+
```
|
|
2633
|
+
|
|
2634
|
+
- *Type:* aws-cdk-lib.ResourceEnvironment
|
|
2635
|
+
|
|
2636
|
+
The environment this resource belongs to.
|
|
2637
|
+
|
|
2638
|
+
For resources that are created and managed by the CDK
|
|
2639
|
+
(generally, those created by creating new class instances like Role, Bucket, etc.),
|
|
2640
|
+
this is always the same as the environment of the stack they belong to;
|
|
2641
|
+
however, for imported resources
|
|
2642
|
+
(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
|
|
2643
|
+
that might be different than the stack they were imported into.
|
|
2644
|
+
|
|
2645
|
+
---
|
|
2646
|
+
|
|
2647
|
+
##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.stack"></a>
|
|
2648
|
+
|
|
2649
|
+
```typescript
|
|
2650
|
+
public readonly stack: Stack;
|
|
2651
|
+
```
|
|
2652
|
+
|
|
2653
|
+
- *Type:* aws-cdk-lib.Stack
|
|
2654
|
+
|
|
2655
|
+
The stack in which this resource is defined.
|
|
2656
|
+
|
|
2657
|
+
---
|
|
2658
|
+
|
|
2659
|
+
##### `airflowConfigurationOptions`<sup>Required</sup> <a name="airflowConfigurationOptions" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.airflowConfigurationOptions"></a>
|
|
2660
|
+
|
|
2661
|
+
```typescript
|
|
2662
|
+
public readonly airflowConfigurationOptions: {[ key: string ]: string};
|
|
2663
|
+
```
|
|
2664
|
+
|
|
2665
|
+
- *Type:* {[ key: string ]: string}
|
|
2666
|
+
|
|
2667
|
+
A list of key-value pairs containing the Airflow configuration options for your environment.
|
|
2668
|
+
|
|
2669
|
+
For example, core.default_timezone: utc.
|
|
2670
|
+
|
|
2671
|
+
---
|
|
2672
|
+
|
|
2673
|
+
##### `environmentArn`<sup>Required</sup> <a name="environmentArn" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.environmentArn"></a>
|
|
2674
|
+
|
|
2675
|
+
```typescript
|
|
2676
|
+
public readonly environmentArn: string;
|
|
2677
|
+
```
|
|
2678
|
+
|
|
2679
|
+
- *Type:* string
|
|
2680
|
+
|
|
2681
|
+
The ARN for the Amazon MWAA environment.
|
|
2682
|
+
|
|
2683
|
+
---
|
|
2684
|
+
|
|
2685
|
+
##### `name`<sup>Required</sup> <a name="name" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.name"></a>
|
|
2686
|
+
|
|
2687
|
+
```typescript
|
|
2688
|
+
public readonly name: string;
|
|
2689
|
+
```
|
|
2690
|
+
|
|
2691
|
+
- *Type:* string
|
|
2692
|
+
|
|
2693
|
+
The name of your Amazon MWAA environment.
|
|
2694
|
+
|
|
2695
|
+
---
|
|
2696
|
+
|
|
2697
|
+
##### `airflowVersion`<sup>Optional</sup> <a name="airflowVersion" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.airflowVersion"></a>
|
|
2698
|
+
|
|
2699
|
+
```typescript
|
|
2700
|
+
public readonly airflowVersion: AirflowVersion;
|
|
2701
|
+
```
|
|
2702
|
+
|
|
2703
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.AirflowVersion">AirflowVersion</a>
|
|
2704
|
+
|
|
2705
|
+
The version of Apache Airflow to use for the environment.
|
|
2706
|
+
|
|
2707
|
+
If no value is specified, defaults to the latest version.
|
|
2708
|
+
|
|
2709
|
+
If you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect.
|
|
2710
|
+
|
|
2711
|
+
---
|
|
2712
|
+
|
|
2713
|
+
##### `celeryExecutorQueue`<sup>Optional</sup> <a name="celeryExecutorQueue" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.celeryExecutorQueue"></a>
|
|
2714
|
+
|
|
2715
|
+
```typescript
|
|
2716
|
+
public readonly celeryExecutorQueue: string;
|
|
2717
|
+
```
|
|
2718
|
+
|
|
2719
|
+
- *Type:* string
|
|
2720
|
+
|
|
2721
|
+
The queue ARN for the environment's Celery Executor.
|
|
2722
|
+
|
|
2723
|
+
Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers.
|
|
2724
|
+
When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.
|
|
2725
|
+
|
|
2726
|
+
---
|
|
2727
|
+
|
|
2728
|
+
##### `dagS3Path`<sup>Optional</sup> <a name="dagS3Path" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.dagS3Path"></a>
|
|
2729
|
+
|
|
2730
|
+
```typescript
|
|
2731
|
+
public readonly dagS3Path: string;
|
|
2732
|
+
```
|
|
2733
|
+
|
|
2734
|
+
- *Type:* string
|
|
2735
|
+
|
|
2736
|
+
The relative path to the DAGs folder on your Amazon S3 bucket.
|
|
2737
|
+
|
|
2738
|
+
For example, dags.
|
|
2739
|
+
|
|
2740
|
+
---
|
|
2741
|
+
|
|
2742
|
+
##### `databaseVpcEndpointService`<sup>Optional</sup> <a name="databaseVpcEndpointService" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.databaseVpcEndpointService"></a>
|
|
2743
|
+
|
|
2744
|
+
```typescript
|
|
2745
|
+
public readonly databaseVpcEndpointService: string;
|
|
2746
|
+
```
|
|
2747
|
+
|
|
2748
|
+
- *Type:* string
|
|
2749
|
+
|
|
2750
|
+
The VPC endpoint for the environment's Amazon RDS database.
|
|
2751
|
+
|
|
2752
|
+
---
|
|
2753
|
+
|
|
2754
|
+
##### `endpointManagement`<sup>Optional</sup> <a name="endpointManagement" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.endpointManagement"></a>
|
|
2755
|
+
|
|
2756
|
+
```typescript
|
|
2757
|
+
public readonly endpointManagement: EndpointManagement;
|
|
2758
|
+
```
|
|
2759
|
+
|
|
2760
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.EndpointManagement">EndpointManagement</a>
|
|
2761
|
+
|
|
2762
|
+
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
|
|
2763
|
+
|
|
2764
|
+
If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC.
|
|
2765
|
+
If set to CUSTOMER, you must create, and manage, the VPC endpoints in your VPC.
|
|
2766
|
+
|
|
2767
|
+
---
|
|
2768
|
+
|
|
2769
|
+
##### `environmentClass`<sup>Optional</sup> <a name="environmentClass" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.environmentClass"></a>
|
|
2770
|
+
|
|
2771
|
+
```typescript
|
|
2772
|
+
public readonly environmentClass: EnvironmentClass;
|
|
2773
|
+
```
|
|
2774
|
+
|
|
2775
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentClass">EnvironmentClass</a>
|
|
2776
|
+
|
|
2777
|
+
The environment class type.
|
|
2778
|
+
|
|
2779
|
+
---
|
|
2780
|
+
|
|
2781
|
+
##### `executionRole`<sup>Optional</sup> <a name="executionRole" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.executionRole"></a>
|
|
2782
|
+
|
|
2783
|
+
```typescript
|
|
2784
|
+
public readonly executionRole: IRole;
|
|
2785
|
+
```
|
|
2786
|
+
|
|
2787
|
+
- *Type:* aws-cdk-lib.aws_iam.IRole
|
|
2788
|
+
|
|
2789
|
+
The execution role in IAM that allows MWAA to access AWS resources in your environment.
|
|
2790
|
+
|
|
2791
|
+
---
|
|
2792
|
+
|
|
2793
|
+
##### `kmsKey`<sup>Optional</sup> <a name="kmsKey" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.kmsKey"></a>
|
|
2794
|
+
|
|
2795
|
+
```typescript
|
|
2796
|
+
public readonly kmsKey: IKey;
|
|
2797
|
+
```
|
|
2798
|
+
|
|
2799
|
+
- *Type:* aws-cdk-lib.aws_kms.IKey
|
|
2800
|
+
|
|
2801
|
+
The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
|
|
2802
|
+
|
|
2803
|
+
You can use an AWS KMS key managed by MWAA, or a customer-managed KMS key (advanced).
|
|
2804
|
+
|
|
2805
|
+
---
|
|
2806
|
+
|
|
2807
|
+
##### `loggingConfiguration`<sup>Optional</sup> <a name="loggingConfiguration" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.loggingConfiguration"></a>
|
|
2808
|
+
|
|
2809
|
+
```typescript
|
|
2810
|
+
public readonly loggingConfiguration: LoggingConfiguration;
|
|
2811
|
+
```
|
|
2812
|
+
|
|
2813
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.LoggingConfiguration">LoggingConfiguration</a>
|
|
2814
|
+
|
|
2815
|
+
The Apache Airflow logs being sent to CloudWatch Logs.
|
|
2816
|
+
|
|
2817
|
+
---
|
|
2818
|
+
|
|
2819
|
+
##### `loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn"></a>
|
|
2820
|
+
|
|
2821
|
+
```typescript
|
|
2822
|
+
public readonly loggingConfigurationDagProcessingLogsCloudWatchLogGroupArn: string;
|
|
2823
|
+
```
|
|
2824
|
+
|
|
2825
|
+
- *Type:* string
|
|
2826
|
+
|
|
2827
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published.
|
|
2828
|
+
|
|
2829
|
+
---
|
|
2830
|
+
|
|
2831
|
+
##### `loggingConfigurationSchedulerLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationSchedulerLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.loggingConfigurationSchedulerLogsCloudWatchLogGroupArn"></a>
|
|
2832
|
+
|
|
2833
|
+
```typescript
|
|
2834
|
+
public readonly loggingConfigurationSchedulerLogsCloudWatchLogGroupArn: string;
|
|
2835
|
+
```
|
|
2836
|
+
|
|
2837
|
+
- *Type:* string
|
|
2838
|
+
|
|
2839
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published.
|
|
2840
|
+
|
|
2841
|
+
---
|
|
2842
|
+
|
|
2843
|
+
##### `loggingConfigurationTaskLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationTaskLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.loggingConfigurationTaskLogsCloudWatchLogGroupArn"></a>
|
|
2844
|
+
|
|
2845
|
+
```typescript
|
|
2846
|
+
public readonly loggingConfigurationTaskLogsCloudWatchLogGroupArn: string;
|
|
2847
|
+
```
|
|
2848
|
+
|
|
2849
|
+
- *Type:* string
|
|
2850
|
+
|
|
2851
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published.
|
|
2852
|
+
|
|
2853
|
+
---
|
|
2854
|
+
|
|
2855
|
+
##### `loggingConfigurationWebserverLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationWebserverLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.loggingConfigurationWebserverLogsCloudWatchLogGroupArn"></a>
|
|
2856
|
+
|
|
2857
|
+
```typescript
|
|
2858
|
+
public readonly loggingConfigurationWebserverLogsCloudWatchLogGroupArn: string;
|
|
2859
|
+
```
|
|
2860
|
+
|
|
2861
|
+
- *Type:* string
|
|
2862
|
+
|
|
2863
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published.
|
|
2864
|
+
|
|
2865
|
+
---
|
|
2866
|
+
|
|
2867
|
+
##### `loggingConfigurationWorkerLogsCloudWatchLogGroupArn`<sup>Optional</sup> <a name="loggingConfigurationWorkerLogsCloudWatchLogGroupArn" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.loggingConfigurationWorkerLogsCloudWatchLogGroupArn"></a>
|
|
2868
|
+
|
|
2869
|
+
```typescript
|
|
2870
|
+
public readonly loggingConfigurationWorkerLogsCloudWatchLogGroupArn: string;
|
|
2871
|
+
```
|
|
2872
|
+
|
|
2873
|
+
- *Type:* string
|
|
2874
|
+
|
|
2875
|
+
The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published.
|
|
2876
|
+
|
|
2877
|
+
---
|
|
2878
|
+
|
|
2879
|
+
##### `maxWebservers`<sup>Optional</sup> <a name="maxWebservers" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.maxWebservers"></a>
|
|
2880
|
+
|
|
2881
|
+
```typescript
|
|
2882
|
+
public readonly maxWebservers: number;
|
|
2883
|
+
```
|
|
2884
|
+
|
|
2885
|
+
- *Type:* number
|
|
2886
|
+
|
|
2887
|
+
The maximum number of web servers that you want to run in your environment.
|
|
2888
|
+
|
|
2889
|
+
Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache
|
|
2890
|
+
Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network
|
|
2891
|
+
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
|
|
2892
|
+
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
|
|
2893
|
+
MinxWebserers.
|
|
2894
|
+
|
|
2895
|
+
Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro,
|
|
2896
|
+
which defaults to 1.
|
|
2897
|
+
|
|
2898
|
+
---
|
|
2899
|
+
|
|
2900
|
+
##### `maxWorkers`<sup>Optional</sup> <a name="maxWorkers" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.maxWorkers"></a>
|
|
2901
|
+
|
|
2902
|
+
```typescript
|
|
2903
|
+
public readonly maxWorkers: number;
|
|
2904
|
+
```
|
|
2905
|
+
|
|
2906
|
+
- *Type:* number
|
|
2907
|
+
|
|
2908
|
+
The maximum number of workers that you want to run in your environment.
|
|
2909
|
+
|
|
2910
|
+
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
|
|
2911
|
+
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
|
|
2912
|
+
the number you specify in MinWorkers.
|
|
2913
|
+
|
|
2914
|
+
---
|
|
2915
|
+
|
|
2916
|
+
##### `minWebservers`<sup>Optional</sup> <a name="minWebservers" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.minWebservers"></a>
|
|
2917
|
+
|
|
2918
|
+
```typescript
|
|
2919
|
+
public readonly minWebservers: number;
|
|
2920
|
+
```
|
|
2921
|
+
|
|
2922
|
+
- *Type:* number
|
|
2923
|
+
|
|
2924
|
+
The minimum number of web servers that you want to run in your environment.
|
|
2925
|
+
|
|
2926
|
+
Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache
|
|
2927
|
+
Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load,
|
|
2928
|
+
decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.
|
|
2929
|
+
|
|
2930
|
+
Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro,
|
|
2931
|
+
which defaults to 1.
|
|
2932
|
+
|
|
2933
|
+
---
|
|
2934
|
+
|
|
2935
|
+
##### `minWorkers`<sup>Optional</sup> <a name="minWorkers" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.minWorkers"></a>
|
|
2936
|
+
|
|
2937
|
+
```typescript
|
|
2938
|
+
public readonly minWorkers: number;
|
|
2939
|
+
```
|
|
2940
|
+
|
|
2941
|
+
- *Type:* number
|
|
2942
|
+
|
|
2943
|
+
The minimum number of workers that you want to run in your environment.
|
|
2944
|
+
|
|
2945
|
+
MWAA scales the number of Apache Airflow workers up to the number you
|
|
2946
|
+
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
|
|
2947
|
+
the worker count you specify in the MinWorkers field. For example, 2.
|
|
2948
|
+
|
|
2949
|
+
---
|
|
2950
|
+
|
|
2951
|
+
##### `networkConfiguration`<sup>Optional</sup> <a name="networkConfiguration" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.networkConfiguration"></a>
|
|
2952
|
+
|
|
2953
|
+
```typescript
|
|
2954
|
+
public readonly networkConfiguration: NetworkConfiguration;
|
|
2955
|
+
```
|
|
2956
|
+
|
|
2957
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.NetworkConfiguration">NetworkConfiguration</a>
|
|
2958
|
+
|
|
2959
|
+
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
|
|
2960
|
+
|
|
2961
|
+
---
|
|
2962
|
+
|
|
2963
|
+
##### `pluginsS3ObjectVersion`<sup>Optional</sup> <a name="pluginsS3ObjectVersion" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.pluginsS3ObjectVersion"></a>
|
|
2964
|
+
|
|
2965
|
+
```typescript
|
|
2966
|
+
public readonly pluginsS3ObjectVersion: string;
|
|
2967
|
+
```
|
|
2968
|
+
|
|
2969
|
+
- *Type:* string
|
|
2970
|
+
|
|
2971
|
+
The version of the plugins.zip file on your Amazon S3 bucket.
|
|
2972
|
+
|
|
2973
|
+
---
|
|
2974
|
+
|
|
2975
|
+
##### `pluginsS3Path`<sup>Optional</sup> <a name="pluginsS3Path" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.pluginsS3Path"></a>
|
|
2976
|
+
|
|
2977
|
+
```typescript
|
|
2978
|
+
public readonly pluginsS3Path: string;
|
|
2979
|
+
```
|
|
2980
|
+
|
|
2981
|
+
- *Type:* string
|
|
2982
|
+
|
|
2983
|
+
The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip.
|
|
2984
|
+
|
|
2985
|
+
---
|
|
2986
|
+
|
|
2987
|
+
##### `requirementsS3ObjectVersion`<sup>Optional</sup> <a name="requirementsS3ObjectVersion" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.requirementsS3ObjectVersion"></a>
|
|
2988
|
+
|
|
2989
|
+
```typescript
|
|
2990
|
+
public readonly requirementsS3ObjectVersion: string;
|
|
2991
|
+
```
|
|
2992
|
+
|
|
2993
|
+
- *Type:* string
|
|
2994
|
+
|
|
2995
|
+
The version of the requirements.txt file on your Amazon S3 bucket.
|
|
2996
|
+
|
|
2997
|
+
---
|
|
2998
|
+
|
|
2999
|
+
##### `requirementsS3Path`<sup>Optional</sup> <a name="requirementsS3Path" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.requirementsS3Path"></a>
|
|
3000
|
+
|
|
3001
|
+
```typescript
|
|
3002
|
+
public readonly requirementsS3Path: string;
|
|
3003
|
+
```
|
|
3004
|
+
|
|
3005
|
+
- *Type:* string
|
|
3006
|
+
|
|
3007
|
+
The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt.
|
|
3008
|
+
|
|
3009
|
+
---
|
|
3010
|
+
|
|
3011
|
+
##### `schedulers`<sup>Optional</sup> <a name="schedulers" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.schedulers"></a>
|
|
3012
|
+
|
|
3013
|
+
```typescript
|
|
3014
|
+
public readonly schedulers: number;
|
|
3015
|
+
```
|
|
3016
|
+
|
|
3017
|
+
- *Type:* number
|
|
3018
|
+
|
|
3019
|
+
The number of schedulers that you want to run in your environment.
|
|
3020
|
+
|
|
3021
|
+
Valid values:
|
|
3022
|
+
v2 - For environments larger than mw1.micro, accepts values from 2 to 5.
|
|
3023
|
+
Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
|
|
3024
|
+
v1 - Accepts 1.
|
|
3025
|
+
|
|
3026
|
+
---
|
|
3027
|
+
|
|
3028
|
+
##### `sourceBucket`<sup>Optional</sup> <a name="sourceBucket" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.sourceBucket"></a>
|
|
3029
|
+
|
|
3030
|
+
```typescript
|
|
3031
|
+
public readonly sourceBucket: IBucket;
|
|
3032
|
+
```
|
|
3033
|
+
|
|
3034
|
+
- *Type:* aws-cdk-lib.aws_s3.IBucket
|
|
3035
|
+
|
|
3036
|
+
The Amazon S3 bucket where your DAG code and supporting files are stored.
|
|
3037
|
+
|
|
3038
|
+
---
|
|
3039
|
+
|
|
3040
|
+
##### `startupScriptS3ObjectVersion`<sup>Optional</sup> <a name="startupScriptS3ObjectVersion" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.startupScriptS3ObjectVersion"></a>
|
|
3041
|
+
|
|
3042
|
+
```typescript
|
|
3043
|
+
public readonly startupScriptS3ObjectVersion: string;
|
|
3044
|
+
```
|
|
3045
|
+
|
|
3046
|
+
- *Type:* string
|
|
3047
|
+
|
|
3048
|
+
The version of the startup shell script in your Amazon S3 bucket.
|
|
3049
|
+
|
|
3050
|
+
You must specify the version ID that Amazon S3 assigns to the file every time you update the script.
|
|
3051
|
+
Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long.
|
|
3052
|
+
|
|
3053
|
+
The following is an example:
|
|
3054
|
+
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
|
|
3055
|
+
|
|
3056
|
+
---
|
|
3057
|
+
|
|
3058
|
+
##### `startupScriptS3Path`<sup>Optional</sup> <a name="startupScriptS3Path" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.startupScriptS3Path"></a>
|
|
3059
|
+
|
|
3060
|
+
```typescript
|
|
3061
|
+
public readonly startupScriptS3Path: string;
|
|
3062
|
+
```
|
|
3063
|
+
|
|
3064
|
+
- *Type:* string
|
|
3065
|
+
|
|
3066
|
+
The relative path to the startup shell script in your Amazon S3 bucket.
|
|
3067
|
+
|
|
3068
|
+
For example, s3://mwaa-environment/startup.sh.
|
|
3069
|
+
Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process.
|
|
3070
|
+
You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables.
|
|
3071
|
+
|
|
3072
|
+
---
|
|
3073
|
+
|
|
3074
|
+
##### `webserverAccessMode`<sup>Optional</sup> <a name="webserverAccessMode" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.webserverAccessMode"></a>
|
|
3075
|
+
|
|
3076
|
+
```typescript
|
|
3077
|
+
public readonly webserverAccessMode: WebserverAccessMode;
|
|
3078
|
+
```
|
|
3079
|
+
|
|
3080
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_mwaa.WebserverAccessMode">WebserverAccessMode</a>
|
|
3081
|
+
|
|
3082
|
+
The Apache Airflow Web server access mode.
|
|
3083
|
+
|
|
3084
|
+
---
|
|
3085
|
+
|
|
3086
|
+
##### `webserverUrl`<sup>Optional</sup> <a name="webserverUrl" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.webserverUrl"></a>
|
|
3087
|
+
|
|
3088
|
+
```typescript
|
|
3089
|
+
public readonly webserverUrl: string;
|
|
3090
|
+
```
|
|
3091
|
+
|
|
3092
|
+
- *Type:* string
|
|
3093
|
+
|
|
3094
|
+
The URL of your Apache Airflow UI.
|
|
3095
|
+
|
|
3096
|
+
---
|
|
3097
|
+
|
|
3098
|
+
##### `webserverVpcEndpointService`<sup>Optional</sup> <a name="webserverVpcEndpointService" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.webserverVpcEndpointService"></a>
|
|
3099
|
+
|
|
3100
|
+
```typescript
|
|
3101
|
+
public readonly webserverVpcEndpointService: string;
|
|
3102
|
+
```
|
|
3103
|
+
|
|
3104
|
+
- *Type:* string
|
|
3105
|
+
|
|
3106
|
+
The VPC endpoint for the environment's web server.
|
|
3107
|
+
|
|
3108
|
+
---
|
|
3109
|
+
|
|
3110
|
+
##### `weeklyMaintenanceWindowStart`<sup>Optional</sup> <a name="weeklyMaintenanceWindowStart" id="@robhan-cdk-lib/aws_mwaa.IEnvironment.property.weeklyMaintenanceWindowStart"></a>
|
|
3111
|
+
|
|
3112
|
+
```typescript
|
|
3113
|
+
public readonly weeklyMaintenanceWindowStart: string;
|
|
3114
|
+
```
|
|
3115
|
+
|
|
3116
|
+
- *Type:* string
|
|
3117
|
+
|
|
3118
|
+
The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM.
|
|
3119
|
+
|
|
3120
|
+
For example: TUE:03:30. You can specify a start time in 30 minute increments only.
|
|
3121
|
+
|
|
3122
|
+
Supported input includes the following:
|
|
3123
|
+
MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)
|
|
3124
|
+
|
|
3125
|
+
---
|
|
3126
|
+
|
|
3127
|
+
## Enums <a name="Enums" id="Enums"></a>
|
|
3128
|
+
|
|
3129
|
+
### AirflowVersion <a name="AirflowVersion" id="@robhan-cdk-lib/aws_mwaa.AirflowVersion"></a>
|
|
3130
|
+
|
|
3131
|
+
#### Members <a name="Members" id="Members"></a>
|
|
3132
|
+
|
|
3133
|
+
| **Name** | **Description** |
|
|
3134
|
+
| --- | --- |
|
|
3135
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.AirflowVersion.V2_7_2">V2_7_2</a></code> | *No description.* |
|
|
3136
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.AirflowVersion.V2_8_1">V2_8_1</a></code> | *No description.* |
|
|
3137
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.AirflowVersion.V2_9_2">V2_9_2</a></code> | *No description.* |
|
|
3138
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.AirflowVersion.V2_10_1">V2_10_1</a></code> | *No description.* |
|
|
3139
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.AirflowVersion.V2_10_3">V2_10_3</a></code> | *No description.* |
|
|
3140
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.AirflowVersion.V3_0_6">V3_0_6</a></code> | *No description.* |
|
|
3141
|
+
|
|
3142
|
+
---
|
|
3143
|
+
|
|
3144
|
+
##### `V2_7_2` <a name="V2_7_2" id="@robhan-cdk-lib/aws_mwaa.AirflowVersion.V2_7_2"></a>
|
|
3145
|
+
|
|
3146
|
+
---
|
|
3147
|
+
|
|
3148
|
+
|
|
3149
|
+
##### `V2_8_1` <a name="V2_8_1" id="@robhan-cdk-lib/aws_mwaa.AirflowVersion.V2_8_1"></a>
|
|
3150
|
+
|
|
3151
|
+
---
|
|
3152
|
+
|
|
3153
|
+
|
|
3154
|
+
##### `V2_9_2` <a name="V2_9_2" id="@robhan-cdk-lib/aws_mwaa.AirflowVersion.V2_9_2"></a>
|
|
3155
|
+
|
|
3156
|
+
---
|
|
3157
|
+
|
|
3158
|
+
|
|
3159
|
+
##### `V2_10_1` <a name="V2_10_1" id="@robhan-cdk-lib/aws_mwaa.AirflowVersion.V2_10_1"></a>
|
|
3160
|
+
|
|
3161
|
+
---
|
|
3162
|
+
|
|
3163
|
+
|
|
3164
|
+
##### `V2_10_3` <a name="V2_10_3" id="@robhan-cdk-lib/aws_mwaa.AirflowVersion.V2_10_3"></a>
|
|
3165
|
+
|
|
3166
|
+
---
|
|
3167
|
+
|
|
3168
|
+
|
|
3169
|
+
##### `V3_0_6` <a name="V3_0_6" id="@robhan-cdk-lib/aws_mwaa.AirflowVersion.V3_0_6"></a>
|
|
3170
|
+
|
|
3171
|
+
---
|
|
3172
|
+
|
|
3173
|
+
|
|
3174
|
+
### EndpointManagement <a name="EndpointManagement" id="@robhan-cdk-lib/aws_mwaa.EndpointManagement"></a>
|
|
3175
|
+
|
|
3176
|
+
#### Members <a name="Members" id="Members"></a>
|
|
3177
|
+
|
|
3178
|
+
| **Name** | **Description** |
|
|
3179
|
+
| --- | --- |
|
|
3180
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EndpointManagement.CUSTOMER">CUSTOMER</a></code> | *No description.* |
|
|
3181
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EndpointManagement.SERVICE">SERVICE</a></code> | *No description.* |
|
|
3182
|
+
|
|
3183
|
+
---
|
|
3184
|
+
|
|
3185
|
+
##### `CUSTOMER` <a name="CUSTOMER" id="@robhan-cdk-lib/aws_mwaa.EndpointManagement.CUSTOMER"></a>
|
|
3186
|
+
|
|
3187
|
+
---
|
|
3188
|
+
|
|
3189
|
+
|
|
3190
|
+
##### `SERVICE` <a name="SERVICE" id="@robhan-cdk-lib/aws_mwaa.EndpointManagement.SERVICE"></a>
|
|
3191
|
+
|
|
3192
|
+
---
|
|
3193
|
+
|
|
3194
|
+
|
|
3195
|
+
### EnvironmentClass <a name="EnvironmentClass" id="@robhan-cdk-lib/aws_mwaa.EnvironmentClass"></a>
|
|
3196
|
+
|
|
3197
|
+
#### Members <a name="Members" id="Members"></a>
|
|
3198
|
+
|
|
3199
|
+
| **Name** | **Description** |
|
|
3200
|
+
| --- | --- |
|
|
3201
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentClass.MW1_MICRO">MW1_MICRO</a></code> | *No description.* |
|
|
3202
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentClass.MW1_SMALL">MW1_SMALL</a></code> | *No description.* |
|
|
3203
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentClass.MW1_MEDIUM">MW1_MEDIUM</a></code> | *No description.* |
|
|
3204
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentClass.MW1_LARGE">MW1_LARGE</a></code> | *No description.* |
|
|
3205
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentClass.MW1_1LARGE">MW1_1LARGE</a></code> | *No description.* |
|
|
3206
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.EnvironmentClass.MW1_2LARGE">MW1_2LARGE</a></code> | *No description.* |
|
|
3207
|
+
|
|
3208
|
+
---
|
|
3209
|
+
|
|
3210
|
+
##### `MW1_MICRO` <a name="MW1_MICRO" id="@robhan-cdk-lib/aws_mwaa.EnvironmentClass.MW1_MICRO"></a>
|
|
3211
|
+
|
|
3212
|
+
---
|
|
3213
|
+
|
|
3214
|
+
|
|
3215
|
+
##### `MW1_SMALL` <a name="MW1_SMALL" id="@robhan-cdk-lib/aws_mwaa.EnvironmentClass.MW1_SMALL"></a>
|
|
3216
|
+
|
|
3217
|
+
---
|
|
3218
|
+
|
|
3219
|
+
|
|
3220
|
+
##### `MW1_MEDIUM` <a name="MW1_MEDIUM" id="@robhan-cdk-lib/aws_mwaa.EnvironmentClass.MW1_MEDIUM"></a>
|
|
3221
|
+
|
|
3222
|
+
---
|
|
3223
|
+
|
|
3224
|
+
|
|
3225
|
+
##### `MW1_LARGE` <a name="MW1_LARGE" id="@robhan-cdk-lib/aws_mwaa.EnvironmentClass.MW1_LARGE"></a>
|
|
3226
|
+
|
|
3227
|
+
---
|
|
3228
|
+
|
|
3229
|
+
|
|
3230
|
+
##### `MW1_1LARGE` <a name="MW1_1LARGE" id="@robhan-cdk-lib/aws_mwaa.EnvironmentClass.MW1_1LARGE"></a>
|
|
3231
|
+
|
|
3232
|
+
---
|
|
3233
|
+
|
|
3234
|
+
|
|
3235
|
+
##### `MW1_2LARGE` <a name="MW1_2LARGE" id="@robhan-cdk-lib/aws_mwaa.EnvironmentClass.MW1_2LARGE"></a>
|
|
3236
|
+
|
|
3237
|
+
---
|
|
3238
|
+
|
|
3239
|
+
|
|
3240
|
+
### LogLevel <a name="LogLevel" id="@robhan-cdk-lib/aws_mwaa.LogLevel"></a>
|
|
3241
|
+
|
|
3242
|
+
#### Members <a name="Members" id="Members"></a>
|
|
3243
|
+
|
|
3244
|
+
| **Name** | **Description** |
|
|
3245
|
+
| --- | --- |
|
|
3246
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.LogLevel.DEBUG">DEBUG</a></code> | *No description.* |
|
|
3247
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.LogLevel.INFO">INFO</a></code> | *No description.* |
|
|
3248
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.LogLevel.WARNING">WARNING</a></code> | *No description.* |
|
|
3249
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.LogLevel.ERROR">ERROR</a></code> | *No description.* |
|
|
3250
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.LogLevel.CRITICAL">CRITICAL</a></code> | *No description.* |
|
|
3251
|
+
|
|
3252
|
+
---
|
|
3253
|
+
|
|
3254
|
+
##### `DEBUG` <a name="DEBUG" id="@robhan-cdk-lib/aws_mwaa.LogLevel.DEBUG"></a>
|
|
3255
|
+
|
|
3256
|
+
---
|
|
3257
|
+
|
|
3258
|
+
|
|
3259
|
+
##### `INFO` <a name="INFO" id="@robhan-cdk-lib/aws_mwaa.LogLevel.INFO"></a>
|
|
3260
|
+
|
|
3261
|
+
---
|
|
3262
|
+
|
|
3263
|
+
|
|
3264
|
+
##### `WARNING` <a name="WARNING" id="@robhan-cdk-lib/aws_mwaa.LogLevel.WARNING"></a>
|
|
3265
|
+
|
|
3266
|
+
---
|
|
3267
|
+
|
|
3268
|
+
|
|
3269
|
+
##### `ERROR` <a name="ERROR" id="@robhan-cdk-lib/aws_mwaa.LogLevel.ERROR"></a>
|
|
3270
|
+
|
|
3271
|
+
---
|
|
3272
|
+
|
|
3273
|
+
|
|
3274
|
+
##### `CRITICAL` <a name="CRITICAL" id="@robhan-cdk-lib/aws_mwaa.LogLevel.CRITICAL"></a>
|
|
3275
|
+
|
|
3276
|
+
---
|
|
3277
|
+
|
|
3278
|
+
|
|
3279
|
+
### WebserverAccessMode <a name="WebserverAccessMode" id="@robhan-cdk-lib/aws_mwaa.WebserverAccessMode"></a>
|
|
3280
|
+
|
|
3281
|
+
#### Members <a name="Members" id="Members"></a>
|
|
3282
|
+
|
|
3283
|
+
| **Name** | **Description** |
|
|
3284
|
+
| --- | --- |
|
|
3285
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.WebserverAccessMode.PRIVATE_ONLY">PRIVATE_ONLY</a></code> | *No description.* |
|
|
3286
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.WebserverAccessMode.PUBLIC_ONLY">PUBLIC_ONLY</a></code> | *No description.* |
|
|
3287
|
+
|
|
3288
|
+
---
|
|
3289
|
+
|
|
3290
|
+
##### `PRIVATE_ONLY` <a name="PRIVATE_ONLY" id="@robhan-cdk-lib/aws_mwaa.WebserverAccessMode.PRIVATE_ONLY"></a>
|
|
3291
|
+
|
|
3292
|
+
---
|
|
3293
|
+
|
|
3294
|
+
|
|
3295
|
+
##### `PUBLIC_ONLY` <a name="PUBLIC_ONLY" id="@robhan-cdk-lib/aws_mwaa.WebserverAccessMode.PUBLIC_ONLY"></a>
|
|
3296
|
+
|
|
3297
|
+
---
|
|
3298
|
+
|
|
3299
|
+
|
|
3300
|
+
### WorkerReplacementStrategy <a name="WorkerReplacementStrategy" id="@robhan-cdk-lib/aws_mwaa.WorkerReplacementStrategy"></a>
|
|
3301
|
+
|
|
3302
|
+
#### Members <a name="Members" id="Members"></a>
|
|
3303
|
+
|
|
3304
|
+
| **Name** | **Description** |
|
|
3305
|
+
| --- | --- |
|
|
3306
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.WorkerReplacementStrategy.FORCED">FORCED</a></code> | *No description.* |
|
|
3307
|
+
| <code><a href="#@robhan-cdk-lib/aws_mwaa.WorkerReplacementStrategy.GRACEFUL">GRACEFUL</a></code> | *No description.* |
|
|
3308
|
+
|
|
3309
|
+
---
|
|
3310
|
+
|
|
3311
|
+
##### `FORCED` <a name="FORCED" id="@robhan-cdk-lib/aws_mwaa.WorkerReplacementStrategy.FORCED"></a>
|
|
3312
|
+
|
|
3313
|
+
---
|
|
3314
|
+
|
|
3315
|
+
|
|
3316
|
+
##### `GRACEFUL` <a name="GRACEFUL" id="@robhan-cdk-lib/aws_mwaa.WorkerReplacementStrategy.GRACEFUL"></a>
|
|
3317
|
+
|
|
3318
|
+
---
|
|
3319
|
+
|