@aws-sdk/client-mwaa 3.1042.0 → 3.1044.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/README.md +1 -78
- package/dist-cjs/index.js +1 -0
- package/dist-cjs/models/errors.js +14 -1
- package/dist-cjs/schemas/schemas_0.js +9 -2
- package/dist-es/models/enums.js +1 -0
- package/dist-es/models/errors.js +12 -0
- package/dist-es/schemas/schemas_0.js +8 -1
- package/dist-types/MWAA.d.ts +1 -78
- package/dist-types/MWAAClient.d.ts +1 -78
- package/dist-types/commands/CreateEnvironmentCommand.d.ts +3 -0
- package/dist-types/commands/DeleteEnvironmentCommand.d.ts +3 -0
- package/dist-types/commands/InvokeRestApiCommand.d.ts +3 -7
- package/dist-types/commands/PublishMetricsCommand.d.ts +1 -2
- package/dist-types/commands/UpdateEnvironmentCommand.d.ts +3 -0
- package/dist-types/index.d.ts +1 -78
- package/dist-types/models/enums.d.ts +1 -0
- package/dist-types/models/errors.d.ts +16 -8
- package/dist-types/models/models_0.d.ts +89 -333
- package/dist-types/schemas/schemas_0.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +1 -0
- package/dist-types/ts3.4/models/errors.d.ts +7 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +1 -0
- package/package.json +1 -1
|
@@ -73,23 +73,23 @@ export interface LoggingConfigurationInput {
|
|
|
73
73
|
TaskLogs?: ModuleLoggingConfigurationInput | undefined;
|
|
74
74
|
}
|
|
75
75
|
/**
|
|
76
|
-
* <p>Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information,
|
|
76
|
+
* <p>Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html">About networking on Amazon MWAA</a>.</p>
|
|
77
77
|
* @public
|
|
78
78
|
*/
|
|
79
79
|
export interface NetworkConfiguration {
|
|
80
80
|
/**
|
|
81
|
-
* <p>A list of subnet IDs. For more information,
|
|
81
|
+
* <p>A list of subnet IDs. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html">About networking on Amazon MWAA</a>.</p>
|
|
82
82
|
* @public
|
|
83
83
|
*/
|
|
84
84
|
SubnetIds?: string[] | undefined;
|
|
85
85
|
/**
|
|
86
|
-
* <p>A list of security group IDs. For more information,
|
|
86
|
+
* <p>A list of security group IDs. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-security.html">Security in your VPC on Amazon MWAA</a>.</p>
|
|
87
87
|
* @public
|
|
88
88
|
*/
|
|
89
89
|
SecurityGroupIds?: string[] | undefined;
|
|
90
90
|
}
|
|
91
91
|
/**
|
|
92
|
-
* <p>This section contains the Amazon Managed Workflows for Apache Airflow (Amazon MWAA) API reference documentation to create an environment. For more information,
|
|
92
|
+
* <p>This section contains the Amazon Managed Workflows for Apache Airflow (Amazon MWAA) API reference documentation to create an environment. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/get-started.html">Get started with Amazon Managed Workflows for Apache Airflow</a>.</p>
|
|
93
93
|
* @public
|
|
94
94
|
*/
|
|
95
95
|
export interface CreateEnvironmentInput {
|
|
@@ -99,78 +99,62 @@ export interface CreateEnvironmentInput {
|
|
|
99
99
|
*/
|
|
100
100
|
Name: string | undefined;
|
|
101
101
|
/**
|
|
102
|
-
* <p>The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an Amazon Web Services Identity and Access Management (IAM) role that grants MWAA permission to access Amazon Web Services services and resources used by your environment. For example, <code>arn:aws:iam::123456789:role/my-execution-role</code>. For more information,
|
|
102
|
+
* <p>The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an Amazon Web Services Identity and Access Management (IAM) role that grants MWAA permission to access Amazon Web Services services and resources used by your environment. For example, <code>arn:aws:iam::123456789:role/my-execution-role</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html">Amazon MWAA Execution role</a>.</p>
|
|
103
103
|
* @public
|
|
104
104
|
*/
|
|
105
105
|
ExecutionRoleArn: string | undefined;
|
|
106
106
|
/**
|
|
107
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, <code>arn:aws:s3:::my-airflow-bucket-unique-name</code>. For more information,
|
|
107
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, <code>arn:aws:s3:::my-airflow-bucket-unique-name</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html">Create an Amazon S3 bucket for Amazon MWAA</a>.</p>
|
|
108
108
|
* @public
|
|
109
109
|
*/
|
|
110
110
|
SourceBucketArn: string | undefined;
|
|
111
111
|
/**
|
|
112
|
-
* <p>The relative path to the DAGs folder on your Amazon S3 bucket. For example, <code>dags</code>. For more information,
|
|
112
|
+
* <p>The relative path to the DAGs folder on your Amazon S3 bucket. For example, <code>dags</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html">Adding or updating DAGs</a>.</p>
|
|
113
113
|
* @public
|
|
114
114
|
*/
|
|
115
115
|
DagS3Path: string | undefined;
|
|
116
116
|
/**
|
|
117
|
-
* <p>The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information,
|
|
117
|
+
* <p>The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html">About networking on Amazon MWAA</a>.</p>
|
|
118
118
|
* @public
|
|
119
119
|
*/
|
|
120
120
|
NetworkConfiguration: NetworkConfiguration | undefined;
|
|
121
121
|
/**
|
|
122
|
-
* <p>The relative path to the <code>plugins.zip</code> file on your Amazon S3 bucket. For example, <code>plugins.zip</code>. If specified, then the <code>plugins.zip</code> version is required. For more information,
|
|
122
|
+
* <p>The relative path to the <code>plugins.zip</code> file on your Amazon S3 bucket. For example, <code>plugins.zip</code>. If specified, then the <code>plugins.zip</code> version is required. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html">Installing custom plugins</a>.</p>
|
|
123
123
|
* @public
|
|
124
124
|
*/
|
|
125
125
|
PluginsS3Path?: string | undefined;
|
|
126
126
|
/**
|
|
127
|
-
* <p>The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a plugins.zip file is updated. For more information,
|
|
127
|
+
* <p>The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a plugins.zip file is updated. For more information, refer to <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</p>
|
|
128
128
|
* @public
|
|
129
129
|
*/
|
|
130
130
|
PluginsS3ObjectVersion?: string | undefined;
|
|
131
131
|
/**
|
|
132
|
-
* <p>The relative path to the <code>requirements.txt</code> file on your Amazon S3 bucket. For example, <code>requirements.txt</code>. If specified, then a version is required. For more information,
|
|
132
|
+
* <p>The relative path to the <code>requirements.txt</code> file on your Amazon S3 bucket. For example, <code>requirements.txt</code>. If specified, then a version is required. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html">Installing Python dependencies</a>.</p>
|
|
133
133
|
* @public
|
|
134
134
|
*/
|
|
135
135
|
RequirementsS3Path?: string | undefined;
|
|
136
136
|
/**
|
|
137
|
-
* <p>The version of the <code>requirements.txt</code> file on your Amazon S3 bucket. You must specify a version each time a requirements.txt file is updated. For more information,
|
|
137
|
+
* <p>The version of the <code>requirements.txt</code> file on your Amazon S3 bucket. You must specify a version each time a requirements.txt file is updated. For more information, refer to <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</p>
|
|
138
138
|
* @public
|
|
139
139
|
*/
|
|
140
140
|
RequirementsS3ObjectVersion?: string | undefined;
|
|
141
141
|
/**
|
|
142
|
-
* <p>The relative path to the startup shell script in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/startup.sh</code>.</p>
|
|
143
|
-
* <p>
|
|
144
|
-
* Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process.
|
|
145
|
-
* You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see
|
|
146
|
-
* <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>.
|
|
147
|
-
* </p>
|
|
142
|
+
* <p>The relative path to the startup shell script in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/startup.sh</code>.</p> <p> Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>. </p>
|
|
148
143
|
* @public
|
|
149
144
|
*/
|
|
150
145
|
StartupScriptS3Path?: string | undefined;
|
|
151
146
|
/**
|
|
152
|
-
* <p>The version of the startup shell script in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file
|
|
153
|
-
* every time you update the script.
|
|
154
|
-
* </p>
|
|
155
|
-
* <p>
|
|
156
|
-
* Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
|
|
157
|
-
* </p>
|
|
158
|
-
* <p>
|
|
159
|
-
* <code>3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo</code>
|
|
160
|
-
* </p>
|
|
161
|
-
* <p>
|
|
162
|
-
* For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>.
|
|
163
|
-
* </p>
|
|
147
|
+
* <p>The version of the startup shell script in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file every time you update the script. </p> <p> Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example: </p> <p> <code>3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo</code> </p> <p> For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>. </p>
|
|
164
148
|
* @public
|
|
165
149
|
*/
|
|
166
150
|
StartupScriptS3ObjectVersion?: string | undefined;
|
|
167
151
|
/**
|
|
168
|
-
* <p>A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information,
|
|
152
|
+
* <p>A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html">Apache Airflow configuration options</a>.</p>
|
|
169
153
|
* @public
|
|
170
154
|
*/
|
|
171
155
|
AirflowConfigurationOptions?: Record<string, string> | undefined;
|
|
172
156
|
/**
|
|
173
|
-
* <p>The environment class type. Valid values: <code>mw1.micro</code>, <code>mw1.small</code>, <code>mw1.medium</code>, <code>mw1.large</code>, <code>mw1.xlarge</code>, and <code>mw1.2xlarge</code>. For more information,
|
|
157
|
+
* <p>The environment class type. Valid values: <code>mw1.micro</code>, <code>mw1.small</code>, <code>mw1.medium</code>, <code>mw1.large</code>, <code>mw1.xlarge</code>, and <code>mw1.2xlarge</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html">Amazon MWAA environment class</a>.</p>
|
|
174
158
|
* @public
|
|
175
159
|
*/
|
|
176
160
|
EnvironmentClass?: string | undefined;
|
|
@@ -180,16 +164,12 @@ export interface CreateEnvironmentInput {
|
|
|
180
164
|
*/
|
|
181
165
|
MaxWorkers?: number | undefined;
|
|
182
166
|
/**
|
|
183
|
-
* <p>The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed CMK (advanced). For more information,
|
|
167
|
+
* <p>The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed CMK (advanced). For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/create-environment.html">Create an Amazon MWAA environment</a>.</p>
|
|
184
168
|
* @public
|
|
185
169
|
*/
|
|
186
170
|
KmsKey?: string | undefined;
|
|
187
171
|
/**
|
|
188
|
-
* <p>The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version.
|
|
189
|
-
* For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/airflow-versions.html">Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (Amazon MWAA)</a>.</p>
|
|
190
|
-
* <p>Valid values: <code>1.10.12</code>, <code>2.0.2</code>, <code>2.2.2</code>,
|
|
191
|
-
* <code>2.4.3</code>, <code>2.5.1</code>, <code>2.6.3</code>, <code>2.7.2</code>,
|
|
192
|
-
* <code>2.8.1</code>, <code>2.9.2</code>, <code>2.10.1</code>, and <code>2.10.3</code>.</p>
|
|
172
|
+
* <p>The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/airflow-versions.html">Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (Amazon MWAA)</a>.</p> <p>Valid values: <code>2.7.2</code>, <code>2.8.1</code>, <code>2.9.2</code>, <code>2.10.1</code>, <code>2.10.3</code>, <code>2.11.0</code>, and <code>3.0.6</code>.</p>
|
|
193
173
|
* @public
|
|
194
174
|
*/
|
|
195
175
|
AirflowVersion?: string | undefined;
|
|
@@ -204,12 +184,12 @@ export interface CreateEnvironmentInput {
|
|
|
204
184
|
*/
|
|
205
185
|
WeeklyMaintenanceWindowStart?: string | undefined;
|
|
206
186
|
/**
|
|
207
|
-
* <p>The key-value tag pairs you want to associate to your environment. For example, <code>"Environment": "Staging"</code>. For more information,
|
|
187
|
+
* <p>The key-value tag pairs you want to associate to your environment. For example, <code>"Environment": "Staging"</code>. For more information, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
|
|
208
188
|
* @public
|
|
209
189
|
*/
|
|
210
190
|
Tags?: Record<string, string> | undefined;
|
|
211
191
|
/**
|
|
212
|
-
* <p>Defines the access mode for the Apache Airflow <i>web server</i>. For more information,
|
|
192
|
+
* <p>Defines the access mode for the Apache Airflow <i>web server</i>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html">Apache Airflow access modes</a>.</p>
|
|
213
193
|
* @public
|
|
214
194
|
*/
|
|
215
195
|
WebserverAccessMode?: WebserverAccessMode | undefined;
|
|
@@ -219,54 +199,22 @@ export interface CreateEnvironmentInput {
|
|
|
219
199
|
*/
|
|
220
200
|
MinWorkers?: number | undefined;
|
|
221
201
|
/**
|
|
222
|
-
* <p>The number of Apache Airflow schedulers to run in your environment. Valid values:</p>
|
|
223
|
-
* <ul>
|
|
224
|
-
* <li>
|
|
225
|
-
* <p>v2 - For environments larger than mw1.micro, accepts values from
|
|
226
|
-
* <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all
|
|
227
|
-
* environment sizes except mw1.micro, which defaults to <code>1</code>.</p>
|
|
228
|
-
* </li>
|
|
229
|
-
* <li>
|
|
230
|
-
* <p>v1 - Accepts <code>1</code>.</p>
|
|
231
|
-
* </li>
|
|
232
|
-
* </ul>
|
|
202
|
+
* <p>The number of Apache Airflow schedulers to run in your environment. Valid values:</p> <ul> <li> <p>v2 - For environments larger than mw1.micro, accepts values from <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment sizes except mw1.micro, which defaults to <code>1</code>.</p> </li> <li> <p>v1 - Accepts <code>1</code>.</p> </li> </ul>
|
|
233
203
|
* @public
|
|
234
204
|
*/
|
|
235
205
|
Schedulers?: number | undefined;
|
|
236
206
|
/**
|
|
237
|
-
* <p>Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to <code>SERVICE</code>, Amazon MWAA will create and manage the required VPC endpoints in
|
|
238
|
-
* your VPC. If set to <code>CUSTOMER</code>, you must create, and manage, the VPC endpoints for your VPC. If you choose to create an environment in a shared VPC, you must set this value to <code>CUSTOMER</code>.
|
|
239
|
-
* In a shared VPC deployment, the environment will remain in <code>PENDING</code> status until you create the VPC endpoints. If you do not take action to
|
|
240
|
-
* create the endpoints within 72 hours, the status will change to <code>CREATE_FAILED</code>. You can delete the failed environment and create a new one.</p>
|
|
207
|
+
* <p>Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to <code>SERVICE</code>, Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to <code>CUSTOMER</code>, you must create, and manage, the VPC endpoints for your VPC. If you choose to create an environment in a shared VPC, you must set this value to <code>CUSTOMER</code>. In a shared VPC deployment, the environment will remain in <code>PENDING</code> status until you create the VPC endpoints. If you do not take action to create the endpoints within 72 hours, the status will change to <code>CREATE_FAILED</code>. You can delete the failed environment and create a new one.</p>
|
|
241
208
|
* @public
|
|
242
209
|
*/
|
|
243
210
|
EndpointManagement?: EndpointManagement | undefined;
|
|
244
211
|
/**
|
|
245
|
-
* <p>
|
|
246
|
-
* The minimum number of web servers that you want to run in your environment.
|
|
247
|
-
* Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for <code>MaxWebservers</code>
|
|
248
|
-
* when you interact with your Apache Airflow environment using Apache Airflow REST API, or
|
|
249
|
-
* the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease,
|
|
250
|
-
* Amazon MWAA disposes of the additional web servers, and scales down to the number set in <code>MinxWebserers</code>.
|
|
251
|
-
* </p>
|
|
252
|
-
* <p>Valid values: For environments larger than mw1.micro, accepts values from
|
|
253
|
-
* <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment
|
|
254
|
-
* sizes except mw1.micro, which defaults to <code>1</code>.</p>
|
|
212
|
+
* <p> The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for <code>MaxWebservers</code> when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in <code>MinxWebserers</code>. </p> <p>Valid values: For environments larger than mw1.micro, accepts values from <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment sizes except mw1.micro, which defaults to <code>1</code>.</p>
|
|
255
213
|
* @public
|
|
256
214
|
*/
|
|
257
215
|
MinWebservers?: number | undefined;
|
|
258
216
|
/**
|
|
259
|
-
* <p>
|
|
260
|
-
* The maximum number of web servers that you want to run in your environment.
|
|
261
|
-
* Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for <code>MaxWebservers</code>
|
|
262
|
-
* when you interact with your Apache Airflow environment using Apache Airflow REST API, or
|
|
263
|
-
* the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS)
|
|
264
|
-
* rate, Amazon MWAA will increase the number of web servers up to the number set in <code>MaxWebserers</code>. As TPS rates decrease
|
|
265
|
-
* Amazon MWAA disposes of the additional web servers, and scales down to the number set in <code>MinxWebserers</code>.
|
|
266
|
-
* </p>
|
|
267
|
-
* <p>Valid values: For environments larger than mw1.micro, accepts values from
|
|
268
|
-
* <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment
|
|
269
|
-
* sizes except mw1.micro, which defaults to <code>1</code>.</p>
|
|
217
|
+
* <p> The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for <code>MaxWebservers</code> when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network 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 the number set in <code>MaxWebserers</code>. As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in <code>MinxWebserers</code>. </p> <p>Valid values: For environments larger than mw1.micro, accepts values from <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment sizes except mw1.micro, which defaults to <code>1</code>.</p>
|
|
270
218
|
* @public
|
|
271
219
|
*/
|
|
272
220
|
MaxWebservers?: number | undefined;
|
|
@@ -451,64 +399,7 @@ export interface Environment {
|
|
|
451
399
|
*/
|
|
452
400
|
Name?: string | undefined;
|
|
453
401
|
/**
|
|
454
|
-
* <p>The status of the Amazon MWAA environment.</p>
|
|
455
|
-
* <p>Valid values:</p>
|
|
456
|
-
* <ul>
|
|
457
|
-
* <li>
|
|
458
|
-
* <p>
|
|
459
|
-
* <code>CREATING</code> - Indicates the request to create the environment is in progress.</p>
|
|
460
|
-
* </li>
|
|
461
|
-
* <li>
|
|
462
|
-
* <p>
|
|
463
|
-
* <code>CREATING_SNAPSHOT</code> - Indicates the request to update environment details, or upgrade the environment version, is in progress and Amazon MWAA is creating a storage volume snapshot of the Amazon RDS
|
|
464
|
-
* database cluster associated with the environment. A database snapshot is a backup created at a specific point in time. Amazon MWAA uses snapshots to recover environment metadata if the process to update or upgrade
|
|
465
|
-
* an environment fails.</p>
|
|
466
|
-
* </li>
|
|
467
|
-
* <li>
|
|
468
|
-
* <p>
|
|
469
|
-
* <code>CREATE_FAILED</code> - Indicates the request to create the environment failed, and the environment could not be created.</p>
|
|
470
|
-
* </li>
|
|
471
|
-
* <li>
|
|
472
|
-
* <p>
|
|
473
|
-
* <code>AVAILABLE</code> - Indicates the request was successful and the environment is ready to use.</p>
|
|
474
|
-
* </li>
|
|
475
|
-
* <li>
|
|
476
|
-
* <p>
|
|
477
|
-
* <code>PENDING</code> - Indicates the request was successful, but the process to create the environment is paused until you create the required
|
|
478
|
-
* VPC endpoints in your VPC. After you create the VPC endpoints, the process resumes.</p>
|
|
479
|
-
* </li>
|
|
480
|
-
* <li>
|
|
481
|
-
* <p>
|
|
482
|
-
* <code>UPDATING</code> - Indicates the request to update the environment is in progress.</p>
|
|
483
|
-
* </li>
|
|
484
|
-
* <li>
|
|
485
|
-
* <p>
|
|
486
|
-
* <code>ROLLING_BACK</code> - Indicates the request to update environment details, or upgrade the environment version, failed and Amazon MWAA is restoring the environment using the latest storage volume snapshot.</p>
|
|
487
|
-
* </li>
|
|
488
|
-
* <li>
|
|
489
|
-
* <p>
|
|
490
|
-
* <code>DELETING</code> - Indicates the request to delete the environment is in progress.</p>
|
|
491
|
-
* </li>
|
|
492
|
-
* <li>
|
|
493
|
-
* <p>
|
|
494
|
-
* <code>DELETED</code> - Indicates the request to delete the environment is complete, and the environment has been deleted.</p>
|
|
495
|
-
* </li>
|
|
496
|
-
* <li>
|
|
497
|
-
* <p>
|
|
498
|
-
* <code>UNAVAILABLE</code> - Indicates the request failed, but the environment did not return to its previous state and is not stable.</p>
|
|
499
|
-
* </li>
|
|
500
|
-
* <li>
|
|
501
|
-
* <p>
|
|
502
|
-
* <code>UPDATE_FAILED</code> - Indicates the request to update the environment failed, and the environment was restored to its previous state successfully and is ready to use.</p>
|
|
503
|
-
* </li>
|
|
504
|
-
* <li>
|
|
505
|
-
* <p>
|
|
506
|
-
* <code>MAINTENANCE</code> - Indicates that the environment is undergoing maintenance. Depending on the type of work Amazon MWAA is performing,
|
|
507
|
-
* your environment might become unavailable during this process. After all operations are done, your environment will return to its status prior to mainteneace operations.
|
|
508
|
-
* </p>
|
|
509
|
-
* </li>
|
|
510
|
-
* </ul>
|
|
511
|
-
* <p>We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/troubleshooting.html">Amazon MWAA troubleshooting</a>.</p>
|
|
402
|
+
* <p>The status of the Amazon MWAA environment.</p> <p>Valid values:</p> <ul> <li> <p> <code>CREATING</code> - The request to create the environment is in progress.</p> </li> <li> <p> <code>CREATING_SNAPSHOT</code> - The request to update environment details, or upgrade the environment version, is in progress and Amazon MWAA is creating a storage volume snapshot of the Amazon RDS database cluster associated with the environment. A database snapshot is a backup created at a specific point in time. Amazon MWAA uses snapshots to recover environment metadata if the process to update or upgrade an environment fails.</p> </li> <li> <p> <code>CREATE_FAILED</code> - The request to create the environment failed and the environment was not created.</p> </li> <li> <p> <code>AVAILABLE</code> - The request was successful and the environment is ready to use.</p> </li> <li> <p> <code>PENDING</code> - The request was successful, but the process to create the environment is paused until you create the required VPC endpoints in your VPC. After you create the VPC endpoints, the process resumes.</p> </li> <li> <p> <code>UPDATING</code> - The request to update the environment is in progress.</p> </li> <li> <p> <code>ROLLING_BACK</code> - The request to update environment details or upgrade the environment version failed and Amazon MWAA is restoring the environment using the latest storage volume snapshot.</p> </li> <li> <p> <code>DELETING</code> - The request to delete the environment is in progress.</p> </li> <li> <p> <code>DELETED</code> - The request to delete the environment is complete, and the environment has been deleted.</p> </li> <li> <p> <code>UNAVAILABLE</code> - The request failed, but the environment did not return to its previous state and is not stable.</p> </li> <li> <p> <code>UPDATE_FAILED</code> - The request to update the environment failed and the environment was restored to its previous state successfully and is ready to use.</p> </li> <li> <p> <code>MAINTENANCE</code> - The environment is undergoing maintenance. Depending on the type of work Amazon MWAA is performing, your environment might be unavailable during this process. Note that as part of the maintenance work, Amazon MWAA performs with a <code>GRACEFUL</code> <a href="https://docs.aws.amazon.com/mwaa/latest/API/API_UpdateEnvironment.html#mwaa-UpdateEnvironment-request-WorkerReplacementStrategy"> <code>workerReplacementStrategy</code> </a>.</p> </li> </ul> <p>You can review our troubleshooting guide for a list of common errors and their solutions. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/troubleshooting.html">Amazon MWAA troubleshooting</a>.</p>
|
|
512
403
|
* @public
|
|
513
404
|
*/
|
|
514
405
|
Status?: EnvironmentStatus | undefined;
|
|
@@ -523,17 +414,17 @@ export interface Environment {
|
|
|
523
414
|
*/
|
|
524
415
|
CreatedAt?: Date | undefined;
|
|
525
416
|
/**
|
|
526
|
-
* <p>The Apache Airflow <i>web server</i> host name for the Amazon MWAA environment. For more information,
|
|
417
|
+
* <p>The Apache Airflow <i>web server</i> host name for the Amazon MWAA environment. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/access-airflow-ui.html">Accessing the Apache Airflow UI</a>.</p>
|
|
527
418
|
* @public
|
|
528
419
|
*/
|
|
529
420
|
WebserverUrl?: string | undefined;
|
|
530
421
|
/**
|
|
531
|
-
* <p>The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, <code>arn:aws:iam::123456789:role/my-execution-role</code>. For more information,
|
|
422
|
+
* <p>The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, <code>arn:aws:iam::123456789:role/my-execution-role</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html">Amazon MWAA Execution role</a>.</p>
|
|
532
423
|
* @public
|
|
533
424
|
*/
|
|
534
425
|
ExecutionRoleArn?: string | undefined;
|
|
535
426
|
/**
|
|
536
|
-
* <p>The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information,
|
|
427
|
+
* <p>The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-slr.html">Amazon MWAA Service-linked role</a>.</p>
|
|
537
428
|
* @public
|
|
538
429
|
*/
|
|
539
430
|
ServiceRoleArn?: string | undefined;
|
|
@@ -543,91 +434,57 @@ export interface Environment {
|
|
|
543
434
|
*/
|
|
544
435
|
KmsKey?: string | undefined;
|
|
545
436
|
/**
|
|
546
|
-
* <p>The Apache Airflow version on your environment.</p>
|
|
547
|
-
* <p>Valid values: <code>1.10.12</code>, <code>2.0.2</code>, <code>2.2.2</code>,
|
|
548
|
-
* <code>2.4.3</code>, <code>2.5.1</code>, <code>2.6.3</code>, <code>2.7.2</code>,
|
|
549
|
-
* <code>2.8.1</code>, <code>2.9.2</code>, <code>2.10.1</code>, and <code>2.10.3</code>.</p>
|
|
437
|
+
* <p>The Apache Airflow version on your environment.</p> <p>Valid values: <code>2.7.2</code>, <code>2.8.1</code>, <code>2.9.2</code>, <code>2.10.1</code>, <code>2.10.3</code>, <code>2.11.0</code>, and <code>3.0.6</code>.</p>
|
|
550
438
|
* @public
|
|
551
439
|
*/
|
|
552
440
|
AirflowVersion?: string | undefined;
|
|
553
441
|
/**
|
|
554
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, <code>arn:aws:s3:::my-airflow-bucket-unique-name</code>. For more information,
|
|
442
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, <code>arn:aws:s3:::my-airflow-bucket-unique-name</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html">Create an Amazon S3 bucket for Amazon MWAA</a>.</p>
|
|
555
443
|
* @public
|
|
556
444
|
*/
|
|
557
445
|
SourceBucketArn?: string | undefined;
|
|
558
446
|
/**
|
|
559
|
-
* <p>The relative path to the DAGs folder in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/dags</code>. For more information,
|
|
447
|
+
* <p>The relative path to the DAGs folder in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/dags</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html">Adding or updating DAGs</a>.</p>
|
|
560
448
|
* @public
|
|
561
449
|
*/
|
|
562
450
|
DagS3Path?: string | undefined;
|
|
563
451
|
/**
|
|
564
|
-
* <p>The relative path to the file in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/plugins.zip</code>. For more information,
|
|
452
|
+
* <p>The relative path to the file in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/plugins.zip</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html">Installing custom plugins</a>.</p>
|
|
565
453
|
* @public
|
|
566
454
|
*/
|
|
567
455
|
PluginsS3Path?: string | undefined;
|
|
568
456
|
/**
|
|
569
|
-
* <p>The version of the <code>plugins.zip</code> file in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file.</p>
|
|
570
|
-
* <p>
|
|
571
|
-
* Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
|
|
572
|
-
* </p>
|
|
573
|
-
* <p>
|
|
574
|
-
* <code>3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo</code>
|
|
575
|
-
* </p>
|
|
576
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html">Installing custom plugins</a>.</p>
|
|
457
|
+
* <p>The version of the <code>plugins.zip</code> file in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file.</p> <p> Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example: </p> <p> <code>3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo</code> </p> <p>For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html">Installing custom plugins</a>.</p>
|
|
577
458
|
* @public
|
|
578
459
|
*/
|
|
579
460
|
PluginsS3ObjectVersion?: string | undefined;
|
|
580
461
|
/**
|
|
581
|
-
* <p>The relative path to the <code>requirements.txt</code> file in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/requirements.txt</code>. For more information,
|
|
582
|
-
* <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html">Installing Python dependencies</a>.</p>
|
|
462
|
+
* <p>The relative path to the <code>requirements.txt</code> file in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/requirements.txt</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html">Installing Python dependencies</a>.</p>
|
|
583
463
|
* @public
|
|
584
464
|
*/
|
|
585
465
|
RequirementsS3Path?: string | undefined;
|
|
586
466
|
/**
|
|
587
|
-
* <p>The version of the <code>requirements.txt </code> file on your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file.</p>
|
|
588
|
-
* <p>
|
|
589
|
-
* Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
|
|
590
|
-
* </p>
|
|
591
|
-
* <p>
|
|
592
|
-
* <code>3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo</code>
|
|
593
|
-
* </p>
|
|
594
|
-
* <p>
|
|
595
|
-
* For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html">Installing Python dependencies</a>.
|
|
596
|
-
* </p>
|
|
467
|
+
* <p>The version of the <code>requirements.txt </code> file on your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file.</p> <p> Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example: </p> <p> <code>3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo</code> </p> <p> For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html">Installing Python dependencies</a>. </p>
|
|
597
468
|
* @public
|
|
598
469
|
*/
|
|
599
470
|
RequirementsS3ObjectVersion?: string | undefined;
|
|
600
471
|
/**
|
|
601
|
-
* <p>The relative path to the startup shell script in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/startup.sh</code>.</p>
|
|
602
|
-
* <p>
|
|
603
|
-
* Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process.
|
|
604
|
-
* You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see
|
|
605
|
-
* <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>.
|
|
606
|
-
* </p>
|
|
472
|
+
* <p>The relative path to the startup shell script in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/startup.sh</code>.</p> <p> Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>. </p>
|
|
607
473
|
* @public
|
|
608
474
|
*/
|
|
609
475
|
StartupScriptS3Path?: string | undefined;
|
|
610
476
|
/**
|
|
611
|
-
* <p>The version of the startup shell script in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file.</p>
|
|
612
|
-
* <p>
|
|
613
|
-
* Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
|
|
614
|
-
* </p>
|
|
615
|
-
* <p>
|
|
616
|
-
* <code>3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo</code>
|
|
617
|
-
* </p>
|
|
618
|
-
* <p>
|
|
619
|
-
* For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>.
|
|
620
|
-
* </p>
|
|
477
|
+
* <p>The version of the startup shell script in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file.</p> <p> Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example: </p> <p> <code>3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo</code> </p> <p> For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>. </p>
|
|
621
478
|
* @public
|
|
622
479
|
*/
|
|
623
480
|
StartupScriptS3ObjectVersion?: string | undefined;
|
|
624
481
|
/**
|
|
625
|
-
* <p>A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. For more information,
|
|
482
|
+
* <p>A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html">Apache Airflow configuration options</a>.</p>
|
|
626
483
|
* @public
|
|
627
484
|
*/
|
|
628
485
|
AirflowConfigurationOptions?: Record<string, string> | undefined;
|
|
629
486
|
/**
|
|
630
|
-
* <p>The environment class type. Valid values: <code>mw1.micro</code>, <code>mw1.small</code>, <code>mw1.medium</code>, <code>mw1.large</code>, <code>mw1.xlarge</code>, and <code>mw1.2xlarge</code>. For more information,
|
|
487
|
+
* <p>The environment class type. Valid values: <code>mw1.micro</code>, <code>mw1.small</code>, <code>mw1.medium</code>, <code>mw1.large</code>, <code>mw1.xlarge</code>, and <code>mw1.2xlarge</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html">Amazon MWAA environment class</a>.</p>
|
|
631
488
|
* @public
|
|
632
489
|
*/
|
|
633
490
|
EnvironmentClass?: string | undefined;
|
|
@@ -637,7 +494,7 @@ export interface Environment {
|
|
|
637
494
|
*/
|
|
638
495
|
MaxWorkers?: number | undefined;
|
|
639
496
|
/**
|
|
640
|
-
* <p>Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information,
|
|
497
|
+
* <p>Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html">About networking on Amazon MWAA</a>.</p>
|
|
641
498
|
* @public
|
|
642
499
|
*/
|
|
643
500
|
NetworkConfiguration?: NetworkConfiguration | undefined;
|
|
@@ -657,12 +514,12 @@ export interface Environment {
|
|
|
657
514
|
*/
|
|
658
515
|
WeeklyMaintenanceWindowStart?: string | undefined;
|
|
659
516
|
/**
|
|
660
|
-
* <p>The key-value tag pairs associated to your environment. For example, <code>"Environment": "Staging"</code>. For more information,
|
|
517
|
+
* <p>The key-value tag pairs associated to your environment. For example, <code>"Environment": "Staging"</code>. For more information, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
|
|
661
518
|
* @public
|
|
662
519
|
*/
|
|
663
520
|
Tags?: Record<string, string> | undefined;
|
|
664
521
|
/**
|
|
665
|
-
* <p>The Apache Airflow <i>web server</i> access mode. For more information,
|
|
522
|
+
* <p>The Apache Airflow <i>web server</i> access mode. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html">Apache Airflow access modes</a>.</p>
|
|
666
523
|
* @public
|
|
667
524
|
*/
|
|
668
525
|
WebserverAccessMode?: WebserverAccessMode | undefined;
|
|
@@ -687,43 +544,22 @@ export interface Environment {
|
|
|
687
544
|
*/
|
|
688
545
|
DatabaseVpcEndpointService?: string | undefined;
|
|
689
546
|
/**
|
|
690
|
-
* <p>The queue ARN for the environment's <a href="https://airflow.apache.org/docs/apache-airflow/stable/core-concepts/executor/celery.html">Celery Executor</a>. Amazon MWAA uses a Celery Executor
|
|
691
|
-
* to distribute tasks across multiple workers. When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.</p>
|
|
547
|
+
* <p>The queue ARN for the environment's <a href="https://airflow.apache.org/docs/apache-airflow/stable/core-concepts/executor/celery.html">Celery Executor</a>. Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers. When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.</p>
|
|
692
548
|
* @public
|
|
693
549
|
*/
|
|
694
550
|
CeleryExecutorQueue?: string | undefined;
|
|
695
551
|
/**
|
|
696
|
-
* <p>Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to <code>SERVICE</code>, Amazon MWAA will create and manage the required VPC endpoints in
|
|
697
|
-
* your VPC. If set to <code>CUSTOMER</code>, you must create, and manage, the VPC endpoints in your VPC.</p>
|
|
552
|
+
* <p>Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to <code>SERVICE</code>, Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to <code>CUSTOMER</code>, you must create, and manage, the VPC endpoints in your VPC.</p>
|
|
698
553
|
* @public
|
|
699
554
|
*/
|
|
700
555
|
EndpointManagement?: EndpointManagement | undefined;
|
|
701
556
|
/**
|
|
702
|
-
* <p>
|
|
703
|
-
* The minimum number of web servers that you want to run in your environment.
|
|
704
|
-
* Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for <code>MaxWebservers</code>
|
|
705
|
-
* when you interact with your Apache Airflow environment using Apache Airflow REST API, or
|
|
706
|
-
* the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease,
|
|
707
|
-
* Amazon MWAA disposes of the additional web servers, and scales down to the number set in <code>MinxWebserers</code>.
|
|
708
|
-
* </p>
|
|
709
|
-
* <p>Valid values: For environments larger than mw1.micro, accepts values from
|
|
710
|
-
* <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment
|
|
711
|
-
* sizes except mw1.micro, which defaults to <code>1</code>.</p>
|
|
557
|
+
* <p> The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for <code>MaxWebservers</code> when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in <code>MinxWebserers</code>. </p> <p>Valid values: For environments larger than mw1.micro, accepts values from <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment sizes except mw1.micro, which defaults to <code>1</code>.</p>
|
|
712
558
|
* @public
|
|
713
559
|
*/
|
|
714
560
|
MinWebservers?: number | undefined;
|
|
715
561
|
/**
|
|
716
|
-
* <p>
|
|
717
|
-
* The maximum number of web servers that you want to run in your environment.
|
|
718
|
-
* Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for <code>MaxWebservers</code>
|
|
719
|
-
* when you interact with your Apache Airflow environment using Apache Airflow REST API, or
|
|
720
|
-
* the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS)
|
|
721
|
-
* rate, Amazon MWAA will increase the number of web servers up to the number set in <code>MaxWebserers</code>. As TPS rates decrease
|
|
722
|
-
* Amazon MWAA disposes of the additional web servers, and scales down to the number set in <code>MinxWebserers</code>.
|
|
723
|
-
* </p>
|
|
724
|
-
* <p>Valid values: For environments larger than mw1.micro, accepts values from
|
|
725
|
-
* <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment
|
|
726
|
-
* sizes except mw1.micro, which defaults to <code>1</code>.</p>
|
|
562
|
+
* <p> The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for <code>MaxWebservers</code> when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network 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 the number set in <code>MaxWebserers</code>. As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in <code>MinxWebserers</code>. </p> <p>Valid values: For environments larger than mw1.micro, accepts values from <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment sizes except mw1.micro, which defaults to <code>1</code>.</p>
|
|
727
563
|
* @public
|
|
728
564
|
*/
|
|
729
565
|
MaxWebservers?: number | undefined;
|
|
@@ -748,27 +584,22 @@ export interface InvokeRestApiRequest {
|
|
|
748
584
|
*/
|
|
749
585
|
Name: string | undefined;
|
|
750
586
|
/**
|
|
751
|
-
* <p>The Apache Airflow REST API endpoint path to be called. For example,
|
|
752
|
-
* <code>/dags/123456/clearTaskInstances</code>. For more information, see <a href="https://airflow.apache.org/docs/apache-airflow/stable/stable-rest-api-ref.html">Apache Airflow API</a>
|
|
753
|
-
* </p>
|
|
587
|
+
* <p>The Apache Airflow REST API endpoint path to be called. For example, <code>/dags/123456/clearTaskInstances</code>. For more information, see <a href="https://airflow.apache.org/docs/apache-airflow/stable/stable-rest-api-ref.html">Apache Airflow API</a> </p>
|
|
754
588
|
* @public
|
|
755
589
|
*/
|
|
756
590
|
Path: string | undefined;
|
|
757
591
|
/**
|
|
758
|
-
* <p>The HTTP method used for making Airflow REST API calls. For example,
|
|
759
|
-
* <code>POST</code>. </p>
|
|
592
|
+
* <p>The HTTP method used for making Airflow REST API calls. For example, <code>POST</code>. </p>
|
|
760
593
|
* @public
|
|
761
594
|
*/
|
|
762
595
|
Method: RestApiMethod | undefined;
|
|
763
596
|
/**
|
|
764
|
-
* <p>Query parameters to be included in the Apache Airflow REST API call, provided as a
|
|
765
|
-
* JSON object. </p>
|
|
597
|
+
* <p>Query parameters to be included in the Apache Airflow REST API call, provided as a JSON object. </p>
|
|
766
598
|
* @public
|
|
767
599
|
*/
|
|
768
600
|
QueryParameters?: __DocumentType | undefined;
|
|
769
601
|
/**
|
|
770
|
-
* <p>The request body for the Apache Airflow REST API call, provided as a JSON
|
|
771
|
-
* object.</p>
|
|
602
|
+
* <p>The request body for the Apache Airflow REST API call, provided as a JSON object.</p>
|
|
772
603
|
* @public
|
|
773
604
|
*/
|
|
774
605
|
Body?: __DocumentType | undefined;
|
|
@@ -783,8 +614,7 @@ export interface InvokeRestApiResponse {
|
|
|
783
614
|
*/
|
|
784
615
|
RestApiStatusCode?: number | undefined;
|
|
785
616
|
/**
|
|
786
|
-
* <p>The response data from the Apache Airflow REST API call, provided as a JSON
|
|
787
|
-
* object.</p>
|
|
617
|
+
* <p>The response data from the Apache Airflow REST API call, provided as a JSON object.</p>
|
|
788
618
|
* @public
|
|
789
619
|
*/
|
|
790
620
|
RestApiResponse?: __DocumentType | undefined;
|
|
@@ -834,108 +664,93 @@ export interface ListTagsForResourceInput {
|
|
|
834
664
|
*/
|
|
835
665
|
export interface ListTagsForResourceOutput {
|
|
836
666
|
/**
|
|
837
|
-
* <p>The key-value tag pairs associated to your environment. For more information,
|
|
667
|
+
* <p>The key-value tag pairs associated to your environment. For more information, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
|
|
838
668
|
* @public
|
|
839
669
|
*/
|
|
840
670
|
Tags?: Record<string, string> | undefined;
|
|
841
671
|
}
|
|
842
672
|
/**
|
|
843
|
-
* <p>
|
|
844
|
-
* <b>Internal only</b>. Represents the dimensions of a metric. To learn more about the metrics published to Amazon CloudWatch, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html">Amazon MWAA performance metrics in Amazon CloudWatch</a>.</p>
|
|
673
|
+
* <p> <b>Internal only</b>. Represents the dimensions of a metric. To learn more about the metrics published to Amazon CloudWatch, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html">Amazon MWAA performance metrics in Amazon CloudWatch</a>.</p>
|
|
845
674
|
*
|
|
846
675
|
* @deprecated This type is for internal use and not meant for public use. Data set for this type will be ignored.
|
|
847
676
|
* @public
|
|
848
677
|
*/
|
|
849
678
|
export interface Dimension {
|
|
850
679
|
/**
|
|
851
|
-
* <p>
|
|
852
|
-
* <b>Internal only</b>. The name of the dimension.</p>
|
|
680
|
+
* <p> <b>Internal only</b>. The name of the dimension.</p>
|
|
853
681
|
* @public
|
|
854
682
|
*/
|
|
855
683
|
Name: string | undefined;
|
|
856
684
|
/**
|
|
857
|
-
* <p>
|
|
858
|
-
* <b>Internal only</b>. The value of the dimension.</p>
|
|
685
|
+
* <p> <b>Internal only</b>. The value of the dimension.</p>
|
|
859
686
|
* @public
|
|
860
687
|
*/
|
|
861
688
|
Value: string | undefined;
|
|
862
689
|
}
|
|
863
690
|
/**
|
|
864
|
-
* <p>
|
|
865
|
-
* <b>Internal only</b>. Represents a set of statistics that describe a specific metric. To learn more about the metrics published to Amazon CloudWatch, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html">Amazon MWAA performance metrics in Amazon CloudWatch</a>.</p>
|
|
691
|
+
* <p> <b>Internal only</b>. Represents a set of statistics that describe a specific metric. To learn more about the metrics published to Amazon CloudWatch, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html">Amazon MWAA performance metrics in Amazon CloudWatch</a>.</p>
|
|
866
692
|
*
|
|
867
693
|
* @deprecated This type is for internal use and not meant for public use. Data set for this type will be ignored.
|
|
868
694
|
* @public
|
|
869
695
|
*/
|
|
870
696
|
export interface StatisticSet {
|
|
871
697
|
/**
|
|
872
|
-
* <p>
|
|
873
|
-
* <b>Internal only</b>. The number of samples used for the statistic set.</p>
|
|
698
|
+
* <p> <b>Internal only</b>. The number of samples used for the statistic set.</p>
|
|
874
699
|
* @public
|
|
875
700
|
*/
|
|
876
701
|
SampleCount?: number | undefined;
|
|
877
702
|
/**
|
|
878
|
-
* <p>
|
|
879
|
-
* <b>Internal only</b>. The sum of values for the sample set.</p>
|
|
703
|
+
* <p> <b>Internal only</b>. The sum of values for the sample set.</p>
|
|
880
704
|
* @public
|
|
881
705
|
*/
|
|
882
706
|
Sum?: number | undefined;
|
|
883
707
|
/**
|
|
884
|
-
* <p>
|
|
885
|
-
* <b>Internal only</b>. The minimum value of the sample set.</p>
|
|
708
|
+
* <p> <b>Internal only</b>. The minimum value of the sample set.</p>
|
|
886
709
|
* @public
|
|
887
710
|
*/
|
|
888
711
|
Minimum?: number | undefined;
|
|
889
712
|
/**
|
|
890
|
-
* <p>
|
|
891
|
-
* <b>Internal only</b>. The maximum value of the sample set.</p>
|
|
713
|
+
* <p> <b>Internal only</b>. The maximum value of the sample set.</p>
|
|
892
714
|
* @public
|
|
893
715
|
*/
|
|
894
716
|
Maximum?: number | undefined;
|
|
895
717
|
}
|
|
896
718
|
/**
|
|
897
|
-
* <p>
|
|
898
|
-
* <b>Internal only</b>. Collects Apache Airflow metrics. To learn more about the metrics published to Amazon CloudWatch, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html">Amazon MWAA performance metrics in Amazon CloudWatch</a>.</p>
|
|
719
|
+
* <p> <b>Internal only</b>. Collects Apache Airflow metrics. To learn more about the metrics published to Amazon CloudWatch, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html">Amazon MWAA performance metrics in Amazon CloudWatch</a>.</p>
|
|
899
720
|
*
|
|
900
721
|
* @deprecated This type is for internal use and not meant for public use. Data set for this type will be ignored.
|
|
901
722
|
* @public
|
|
902
723
|
*/
|
|
903
724
|
export interface MetricDatum {
|
|
904
725
|
/**
|
|
905
|
-
* <p>
|
|
906
|
-
* <b>Internal only</b>. The name of the metric.</p>
|
|
726
|
+
* <p> <b>Internal only</b>. The name of the metric.</p>
|
|
907
727
|
* @public
|
|
908
728
|
*/
|
|
909
729
|
MetricName: string | undefined;
|
|
910
730
|
/**
|
|
911
|
-
* <p>
|
|
912
|
-
* <b>Internal only</b>. The time the metric data was received.</p>
|
|
731
|
+
* <p> <b>Internal only</b>. The time the metric data was received, expressed as an ISO 8601 datetime string.</p>
|
|
913
732
|
* @public
|
|
914
733
|
*/
|
|
915
734
|
Timestamp: Date | undefined;
|
|
916
735
|
/**
|
|
917
|
-
* <p>
|
|
918
|
-
* <b>Internal only</b>. The dimensions associated with the metric.</p>
|
|
736
|
+
* <p> <b>Internal only</b>. The dimensions associated with the metric.</p>
|
|
919
737
|
*
|
|
920
738
|
* @deprecated This type is for internal use and not meant for public use. Data set for this type will be ignored.
|
|
921
739
|
* @public
|
|
922
740
|
*/
|
|
923
741
|
Dimensions?: Dimension[] | undefined;
|
|
924
742
|
/**
|
|
925
|
-
* <p>
|
|
926
|
-
* <b>Internal only</b>. The value for the metric.</p>
|
|
743
|
+
* <p> <b>Internal only</b>. The value for the metric.</p>
|
|
927
744
|
* @public
|
|
928
745
|
*/
|
|
929
746
|
Value?: number | undefined;
|
|
930
747
|
/**
|
|
931
|
-
* <p>
|
|
932
|
-
* <b>Internal only</b>. The unit used to store the metric.</p>
|
|
748
|
+
* <p> <b>Internal only</b>. The unit used to store the metric.</p>
|
|
933
749
|
* @public
|
|
934
750
|
*/
|
|
935
751
|
Unit?: Unit | undefined;
|
|
936
752
|
/**
|
|
937
|
-
* <p>
|
|
938
|
-
* <b>Internal only</b>. The statistical values for the metric.</p>
|
|
753
|
+
* <p> <b>Internal only</b>. The statistical values for the metric.</p>
|
|
939
754
|
*
|
|
940
755
|
* @deprecated This type is for internal use and not meant for public use. Data set for this type will be ignored.
|
|
941
756
|
* @public
|
|
@@ -948,14 +763,12 @@ export interface MetricDatum {
|
|
|
948
763
|
*/
|
|
949
764
|
export interface PublishMetricsInput {
|
|
950
765
|
/**
|
|
951
|
-
* <p>
|
|
952
|
-
* <b>Internal only</b>. The name of the environment.</p>
|
|
766
|
+
* <p> <b>Internal only</b>. The name of the environment.</p>
|
|
953
767
|
* @public
|
|
954
768
|
*/
|
|
955
769
|
EnvironmentName: string | undefined;
|
|
956
770
|
/**
|
|
957
|
-
* <p>
|
|
958
|
-
* <b>Internal only</b>. Publishes metrics to Amazon CloudWatch. To learn more about the metrics published to Amazon CloudWatch, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html">Amazon MWAA performance metrics in Amazon CloudWatch</a>.</p>
|
|
771
|
+
* <p> <b>Internal only</b>. Publishes metrics to Amazon CloudWatch. To learn more about the metrics published to Amazon CloudWatch, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html">Amazon MWAA performance metrics in Amazon CloudWatch</a>.</p>
|
|
959
772
|
*
|
|
960
773
|
* @deprecated This type is for internal use and not meant for public use. Data set for this type will be ignored.
|
|
961
774
|
* @public
|
|
@@ -978,7 +791,7 @@ export interface TagResourceInput {
|
|
|
978
791
|
*/
|
|
979
792
|
ResourceArn: string | undefined;
|
|
980
793
|
/**
|
|
981
|
-
* <p>The key-value tag pairs you want to associate to your environment. For example, <code>"Environment": "Staging"</code>. For more information,
|
|
794
|
+
* <p>The key-value tag pairs you want to associate to your environment. For example, <code>"Environment": "Staging"</code>. For more information, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
|
|
982
795
|
* @public
|
|
983
796
|
*/
|
|
984
797
|
Tags: Record<string, string> | undefined;
|
|
@@ -1009,12 +822,12 @@ export interface UntagResourceInput {
|
|
|
1009
822
|
export interface UntagResourceOutput {
|
|
1010
823
|
}
|
|
1011
824
|
/**
|
|
1012
|
-
* <p>Defines the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information,
|
|
825
|
+
* <p>Defines the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html">About networking on Amazon MWAA</a>.</p>
|
|
1013
826
|
* @public
|
|
1014
827
|
*/
|
|
1015
828
|
export interface UpdateNetworkConfigurationInput {
|
|
1016
829
|
/**
|
|
1017
|
-
* <p>A list of security group IDs. A security group must be attached to the same VPC as the subnets. For more information,
|
|
830
|
+
* <p>A list of security group IDs. A security group must be attached to the same VPC as the subnets. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-security.html">Security in your VPC on Amazon MWAA</a>.</p>
|
|
1018
831
|
* @public
|
|
1019
832
|
*/
|
|
1020
833
|
SecurityGroupIds: string[] | undefined;
|
|
@@ -1029,35 +842,27 @@ export interface UpdateEnvironmentInput {
|
|
|
1029
842
|
*/
|
|
1030
843
|
Name: string | undefined;
|
|
1031
844
|
/**
|
|
1032
|
-
* <p>The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, <code>arn:aws:iam::123456789:role/my-execution-role</code>. For more information,
|
|
845
|
+
* <p>The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, <code>arn:aws:iam::123456789:role/my-execution-role</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html">Amazon MWAA Execution role</a>.</p>
|
|
1033
846
|
* @public
|
|
1034
847
|
*/
|
|
1035
848
|
ExecutionRoleArn?: string | undefined;
|
|
1036
849
|
/**
|
|
1037
|
-
* <p>A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information,
|
|
850
|
+
* <p>A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html">Apache Airflow configuration options</a>.</p>
|
|
1038
851
|
* @public
|
|
1039
852
|
*/
|
|
1040
853
|
AirflowConfigurationOptions?: Record<string, string> | undefined;
|
|
1041
854
|
/**
|
|
1042
|
-
* <p>The Apache Airflow version for your environment. To upgrade your environment, specify a newer version of Apache Airflow supported by Amazon MWAA.</p>
|
|
1043
|
-
* <p>Before you upgrade an environment, make sure your requirements, DAGs, plugins, and other resources used in your workflows are compatible with the new Apache Airflow version. For more information about updating
|
|
1044
|
-
* your resources, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/upgrading-environment.html">Upgrading an Amazon MWAA environment</a>.</p>
|
|
1045
|
-
* <p>Valid values: <code>1.10.12</code>, <code>2.0.2</code>, <code>2.2.2</code>,
|
|
1046
|
-
* <code>2.4.3</code>, <code>2.5.1</code>, <code>2.6.3</code>, <code>2.7.2</code>,
|
|
1047
|
-
* <code>2.8.1</code>, <code>2.9.2</code>, <code>2.10.1</code>, and <code>2.10.3</code>.</p>
|
|
855
|
+
* <p>The Apache Airflow version for your environment. To upgrade your environment, specify a newer version of Apache Airflow supported by Amazon MWAA. To downgrade your environment, specify an older version of Apache Airflow supported by Amazon MWAA.</p> <p>Before you upgrade or downgrade an environment, make sure your requirements, DAGs, plugins, and other resources used in your workflows are compatible with the new Apache Airflow version. For more information about updating your resources, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/upgrading-environment.html">Upgrading and downgrading an Amazon MWAA environment</a>.</p> <p>Valid values: <code>2.7.2</code>, <code>2.8.1</code>, <code>2.9.2</code>, <code>2.10.1</code>, <code>2.10.3</code>, <code>2.11.0</code>, and <code>3.0.6</code>.</p>
|
|
1048
856
|
* @public
|
|
1049
857
|
*/
|
|
1050
858
|
AirflowVersion?: string | undefined;
|
|
1051
859
|
/**
|
|
1052
|
-
* <p>The relative path to the DAGs folder on your Amazon S3 bucket. For example, <code>dags</code>. For more information,
|
|
860
|
+
* <p>The relative path to the DAGs folder on your Amazon S3 bucket. For example, <code>dags</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html">Adding or updating DAGs</a>.</p>
|
|
1053
861
|
* @public
|
|
1054
862
|
*/
|
|
1055
863
|
DagS3Path?: string | undefined;
|
|
1056
864
|
/**
|
|
1057
|
-
* <p>The environment class type. Valid values: <code>mw1.micro</code>,
|
|
1058
|
-
* <code>mw1.small</code>, <code>mw1.medium</code>, <code>mw1.large</code>,
|
|
1059
|
-
* <code>mw1.xlarge</code>, and <code>mw1.2xlarge</code>. For more information, see
|
|
1060
|
-
* <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html">Amazon MWAA environment class</a>. </p>
|
|
865
|
+
* <p>The environment class type. Valid values: <code>mw1.micro</code>, <code>mw1.small</code>, <code>mw1.medium</code>, <code>mw1.large</code>, <code>mw1.xlarge</code>, and <code>mw1.2xlarge</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html">Amazon MWAA environment class</a>. </p>
|
|
1061
866
|
* @public
|
|
1062
867
|
*/
|
|
1063
868
|
EnvironmentClass?: string | undefined;
|
|
@@ -1077,74 +882,42 @@ export interface UpdateEnvironmentInput {
|
|
|
1077
882
|
*/
|
|
1078
883
|
MinWorkers?: number | undefined;
|
|
1079
884
|
/**
|
|
1080
|
-
* <p>
|
|
1081
|
-
* The maximum number of web servers that you want to run in your environment.
|
|
1082
|
-
* Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for <code>MaxWebservers</code>
|
|
1083
|
-
* when you interact with your Apache Airflow environment using Apache Airflow REST API, or
|
|
1084
|
-
* the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS)
|
|
1085
|
-
* rate, Amazon MWAA will increase the number of web servers up to the number set in <code>MaxWebserers</code>. As TPS rates decrease
|
|
1086
|
-
* Amazon MWAA disposes of the additional web servers, and scales down to the number set in <code>MinxWebserers</code>.
|
|
1087
|
-
* </p>
|
|
1088
|
-
* <p>Valid values: For environments larger than mw1.micro, accepts values from
|
|
1089
|
-
* <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment
|
|
1090
|
-
* sizes except mw1.micro, which defaults to <code>1</code>.</p>
|
|
885
|
+
* <p> The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for <code>MaxWebservers</code> when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network 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 the number set in <code>MaxWebserers</code>. As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in <code>MinxWebserers</code>. </p> <p>Valid values: For environments larger than mw1.micro, accepts values from <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment sizes except mw1.micro, which defaults to <code>1</code>.</p>
|
|
1091
886
|
* @public
|
|
1092
887
|
*/
|
|
1093
888
|
MaxWebservers?: number | undefined;
|
|
1094
889
|
/**
|
|
1095
|
-
* <p>
|
|
1096
|
-
* The minimum number of web servers that you want to run in your environment.
|
|
1097
|
-
* Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for <code>MaxWebservers</code>
|
|
1098
|
-
* when you interact with your Apache Airflow environment using Apache Airflow REST API, or
|
|
1099
|
-
* the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease,
|
|
1100
|
-
* Amazon MWAA disposes of the additional web servers, and scales down to the number set in <code>MinxWebserers</code>.
|
|
1101
|
-
* </p>
|
|
1102
|
-
* <p>Valid values: For environments larger than mw1.micro, accepts values from
|
|
1103
|
-
* <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment
|
|
1104
|
-
* sizes except mw1.micro, which defaults to <code>1</code>.</p>
|
|
890
|
+
* <p> The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for <code>MaxWebservers</code> when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in <code>MinxWebserers</code>. </p> <p>Valid values: For environments larger than mw1.micro, accepts values from <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment sizes except mw1.micro, which defaults to <code>1</code>.</p>
|
|
1105
891
|
* @public
|
|
1106
892
|
*/
|
|
1107
893
|
MinWebservers?: number | undefined;
|
|
1108
894
|
/**
|
|
1109
|
-
* <p>The worker replacement strategy to use when updating the environment.</p>
|
|
1110
|
-
* <p>You can select one of the following strategies:</p>
|
|
1111
|
-
* <ul>
|
|
1112
|
-
* <li>
|
|
1113
|
-
* <p>
|
|
1114
|
-
* <b>Forced -</b> Stops and replaces Apache Airflow workers without waiting for tasks to
|
|
1115
|
-
* complete before an update.</p>
|
|
1116
|
-
* </li>
|
|
1117
|
-
* <li>
|
|
1118
|
-
* <p>
|
|
1119
|
-
* <b>Graceful -</b> Allows Apache Airflow workers to complete running tasks for up to 12 hours during an update before
|
|
1120
|
-
* they're stopped and replaced.</p>
|
|
1121
|
-
* </li>
|
|
1122
|
-
* </ul>
|
|
895
|
+
* <p>The worker replacement strategy to use when updating the environment.</p> <p>You can select one of the following strategies:</p> <ul> <li> <p> <b>Forced -</b> Stops and replaces Apache Airflow workers without waiting for tasks to complete before an update.</p> </li> <li> <p> <b>Graceful -</b> Allows Apache Airflow workers to complete running tasks for up to 12 hours during an update before they're stopped and replaced.</p> </li> </ul>
|
|
1123
896
|
* @public
|
|
1124
897
|
*/
|
|
1125
898
|
WorkerReplacementStrategy?: WorkerReplacementStrategy | undefined;
|
|
1126
899
|
/**
|
|
1127
|
-
* <p>The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information,
|
|
900
|
+
* <p>The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html">About networking on Amazon MWAA</a>.</p>
|
|
1128
901
|
* @public
|
|
1129
902
|
*/
|
|
1130
903
|
NetworkConfiguration?: UpdateNetworkConfigurationInput | undefined;
|
|
1131
904
|
/**
|
|
1132
|
-
* <p>The relative path to the <code>plugins.zip</code> file on your Amazon S3 bucket. For example, <code>plugins.zip</code>. If specified, then the plugins.zip version is required. For more information,
|
|
905
|
+
* <p>The relative path to the <code>plugins.zip</code> file on your Amazon S3 bucket. For example, <code>plugins.zip</code>. If specified, then the plugins.zip version is required. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html">Installing custom plugins</a>.</p>
|
|
1133
906
|
* @public
|
|
1134
907
|
*/
|
|
1135
908
|
PluginsS3Path?: string | undefined;
|
|
1136
909
|
/**
|
|
1137
|
-
* <p>The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a <code>plugins.zip</code> file is updated. For more information,
|
|
910
|
+
* <p>The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a <code>plugins.zip</code> file is updated. For more information, refer to <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</p>
|
|
1138
911
|
* @public
|
|
1139
912
|
*/
|
|
1140
913
|
PluginsS3ObjectVersion?: string | undefined;
|
|
1141
914
|
/**
|
|
1142
|
-
* <p>The relative path to the <code>requirements.txt</code> file on your Amazon S3 bucket. For example, <code>requirements.txt</code>. If specified, then a file version is required. For more information,
|
|
915
|
+
* <p>The relative path to the <code>requirements.txt</code> file on your Amazon S3 bucket. For example, <code>requirements.txt</code>. If specified, then a file version is required. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html">Installing Python dependencies</a>.</p>
|
|
1143
916
|
* @public
|
|
1144
917
|
*/
|
|
1145
918
|
RequirementsS3Path?: string | undefined;
|
|
1146
919
|
/**
|
|
1147
|
-
* <p>The version of the requirements.txt file on your Amazon S3 bucket. You must specify a version each time a <code>requirements.txt</code> file is updated. For more information,
|
|
920
|
+
* <p>The version of the requirements.txt file on your Amazon S3 bucket. You must specify a version each time a <code>requirements.txt</code> file is updated. For more information, refer to <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</p>
|
|
1148
921
|
* @public
|
|
1149
922
|
*/
|
|
1150
923
|
RequirementsS3ObjectVersion?: string | undefined;
|
|
@@ -1154,39 +927,22 @@ export interface UpdateEnvironmentInput {
|
|
|
1154
927
|
*/
|
|
1155
928
|
Schedulers?: number | undefined;
|
|
1156
929
|
/**
|
|
1157
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, <code>arn:aws:s3:::my-airflow-bucket-unique-name</code>. For more information,
|
|
930
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, <code>arn:aws:s3:::my-airflow-bucket-unique-name</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html">Create an Amazon S3 bucket for Amazon MWAA</a>.</p>
|
|
1158
931
|
* @public
|
|
1159
932
|
*/
|
|
1160
933
|
SourceBucketArn?: string | undefined;
|
|
1161
934
|
/**
|
|
1162
|
-
* <p>The relative path to the startup shell script in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/startup.sh</code>.</p>
|
|
1163
|
-
* <p>
|
|
1164
|
-
* Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process.
|
|
1165
|
-
* You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see
|
|
1166
|
-
* <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>.
|
|
1167
|
-
* </p>
|
|
935
|
+
* <p>The relative path to the startup shell script in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/startup.sh</code>.</p> <p> Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>. </p>
|
|
1168
936
|
* @public
|
|
1169
937
|
*/
|
|
1170
938
|
StartupScriptS3Path?: string | undefined;
|
|
1171
939
|
/**
|
|
1172
|
-
* <p>
|
|
1173
|
-
* The version of the startup shell script in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file
|
|
1174
|
-
* every time you update the script.
|
|
1175
|
-
* </p>
|
|
1176
|
-
* <p>
|
|
1177
|
-
* Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
|
|
1178
|
-
* </p>
|
|
1179
|
-
* <p>
|
|
1180
|
-
* <code>3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo</code>
|
|
1181
|
-
* </p>
|
|
1182
|
-
* <p>
|
|
1183
|
-
* For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>.
|
|
1184
|
-
* </p>
|
|
940
|
+
* <p> The version of the startup shell script in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file every time you update the script. </p> <p> Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example: </p> <p> <code>3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo</code> </p> <p> For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>. </p>
|
|
1185
941
|
* @public
|
|
1186
942
|
*/
|
|
1187
943
|
StartupScriptS3ObjectVersion?: string | undefined;
|
|
1188
944
|
/**
|
|
1189
|
-
* <p>The Apache Airflow <i>Web server</i> access mode. For more information,
|
|
945
|
+
* <p>The Apache Airflow <i>Web server</i> access mode. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html">Apache Airflow access modes</a>.</p>
|
|
1190
946
|
* @public
|
|
1191
947
|
*/
|
|
1192
948
|
WebserverAccessMode?: WebserverAccessMode | undefined;
|