@aws-sdk/client-ecs 3.703.0 → 3.708.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 +12 -11
- package/dist-types/ECS.d.ts +12 -11
- package/dist-types/ECSClient.d.ts +12 -11
- package/dist-types/commands/CreateCapacityProviderCommand.d.ts +22 -17
- package/dist-types/commands/CreateClusterCommand.d.ts +19 -17
- package/dist-types/commands/CreateServiceCommand.d.ts +80 -75
- package/dist-types/commands/CreateTaskSetCommand.d.ts +19 -15
- package/dist-types/commands/DeleteAccountSettingCommand.d.ts +12 -9
- package/dist-types/commands/DeleteAttributesCommand.d.ts +4 -2
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +21 -17
- package/dist-types/commands/DeleteClusterCommand.d.ts +28 -23
- package/dist-types/commands/DeleteServiceCommand.d.ts +29 -23
- package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +28 -23
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +17 -14
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +22 -19
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +26 -23
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +10 -8
- package/dist-types/commands/DescribeClustersCommand.d.ts +10 -8
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +12 -10
- package/dist-types/commands/DescribeServiceDeploymentsCommand.d.ts +15 -10
- package/dist-types/commands/DescribeServiceRevisionsCommand.d.ts +14 -11
- package/dist-types/commands/DescribeServicesCommand.d.ts +10 -8
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +16 -13
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +17 -13
- package/dist-types/commands/DescribeTasksCommand.d.ts +13 -11
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +8 -7
- package/dist-types/commands/ExecuteCommandCommand.d.ts +23 -19
- package/dist-types/commands/GetTaskProtectionCommand.d.ts +10 -8
- package/dist-types/commands/ListAccountSettingsCommand.d.ts +10 -8
- package/dist-types/commands/ListAttributesCommand.d.ts +8 -6
- package/dist-types/commands/ListClustersCommand.d.ts +10 -8
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +13 -12
- package/dist-types/commands/ListServiceDeploymentsCommand.d.ts +14 -10
- package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +15 -12
- package/dist-types/commands/ListServicesCommand.d.ts +12 -10
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +10 -8
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +17 -13
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +13 -11
- package/dist-types/commands/ListTasksCommand.d.ts +15 -12
- package/dist-types/commands/PutAccountSettingCommand.d.ts +14 -11
- package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +12 -10
- package/dist-types/commands/PutAttributesCommand.d.ts +10 -7
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +29 -24
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +12 -10
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +24 -21
- package/dist-types/commands/RunTaskCommand.d.ts +37 -33
- package/dist-types/commands/StartTaskCommand.d.ts +16 -16
- package/dist-types/commands/StopTaskCommand.d.ts +22 -18
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +10 -8
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +8 -7
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +10 -8
- package/dist-types/commands/TagResourceCommand.d.ts +14 -11
- package/dist-types/commands/UntagResourceCommand.d.ts +10 -8
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +10 -8
- package/dist-types/commands/UpdateClusterCommand.d.ts +10 -8
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +10 -8
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +37 -33
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +48 -42
- package/dist-types/commands/UpdateServiceCommand.d.ts +101 -91
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +20 -15
- package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +25 -20
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +19 -15
- package/dist-types/index.d.ts +12 -11
- package/dist-types/models/models_0.d.ts +3378 -2890
- package/dist-types/models/models_1.d.ts +165 -146
- package/package.json +1 -1
|
@@ -12,19 +12,19 @@ export interface AutoScalingGroupProviderUpdate {
|
|
|
12
12
|
*/
|
|
13
13
|
managedScaling?: ManagedScaling | undefined;
|
|
14
14
|
/**
|
|
15
|
-
* <p>The managed termination protection setting to use for the Auto Scaling group capacity
|
|
16
|
-
* determines whether the Auto Scaling group has managed termination
|
|
15
|
+
* <p>The managed termination protection setting to use for the Auto Scaling group capacity
|
|
16
|
+
* provider. This determines whether the Auto Scaling group has managed termination
|
|
17
|
+
* protection.</p>
|
|
17
18
|
* <important>
|
|
18
|
-
* <p>When using managed termination protection, managed scaling must also be used
|
|
19
|
-
* termination protection doesn't work.</p>
|
|
19
|
+
* <p>When using managed termination protection, managed scaling must also be used
|
|
20
|
+
* otherwise managed termination protection doesn't work.</p>
|
|
20
21
|
* </important>
|
|
21
|
-
* <p>When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an
|
|
22
|
-
* group that contain tasks from being terminated during a scale-in action.
|
|
23
|
-
* each instance in the Auto Scaling group must have instance
|
|
24
|
-
* more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection">Instance
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
* when the Auto Scaling group scales in.</p>
|
|
22
|
+
* <p>When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an
|
|
23
|
+
* Auto Scaling group that contain tasks from being terminated during a scale-in action.
|
|
24
|
+
* The Auto Scaling group and each instance in the Auto Scaling group must have instance
|
|
25
|
+
* protection from scale-in actions on. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection">Instance Protection</a> in the <i>Auto Scaling User Guide</i>.</p>
|
|
26
|
+
* <p>When managed termination protection is off, your Amazon EC2 instances aren't protected from
|
|
27
|
+
* termination when the Auto Scaling group scales in.</p>
|
|
28
28
|
* @public
|
|
29
29
|
*/
|
|
30
30
|
managedTerminationProtection?: ManagedTerminationProtection | undefined;
|
|
@@ -116,14 +116,15 @@ export interface UpdateClusterSettingsRequest {
|
|
|
116
116
|
*/
|
|
117
117
|
cluster: string | undefined;
|
|
118
118
|
/**
|
|
119
|
-
* <p>The setting to use by default for a cluster. This parameter is used to turn on CloudWatch
|
|
120
|
-
* Insights for a cluster. If this value is specified, it overrides the
|
|
121
|
-
*
|
|
119
|
+
* <p>The setting to use by default for a cluster. This parameter is used to turn on CloudWatch
|
|
120
|
+
* Container Insights for a cluster. If this value is specified, it overrides the
|
|
121
|
+
* <code>containerInsights</code> value set with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html">PutAccountSetting</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html">PutAccountSettingDefault</a>.</p>
|
|
122
122
|
* <important>
|
|
123
|
-
* <p>Currently, if you delete an existing cluster that does not have Container Insights
|
|
124
|
-
* then create a new cluster with the same name with Container Insights
|
|
125
|
-
* will not actually be turned on. If you want to preserve
|
|
126
|
-
*
|
|
123
|
+
* <p>Currently, if you delete an existing cluster that does not have Container Insights
|
|
124
|
+
* turned on, and then create a new cluster with the same name with Container Insights
|
|
125
|
+
* tuned on, Container Insights will not actually be turned on. If you want to preserve
|
|
126
|
+
* the same name for your existing cluster and turn on Container Insights, you must
|
|
127
|
+
* wait 7 days before you can re-create it.</p>
|
|
127
128
|
* </important>
|
|
128
129
|
* @public
|
|
129
130
|
*/
|
|
@@ -140,9 +141,10 @@ export interface UpdateClusterSettingsResponse {
|
|
|
140
141
|
cluster?: Cluster | undefined;
|
|
141
142
|
}
|
|
142
143
|
/**
|
|
143
|
-
* <p>Amazon ECS can't determine the current version of the Amazon ECS container agent on the
|
|
144
|
-
* doesn't have enough information to proceed with an update. This
|
|
145
|
-
* the container instance is a previous or custom
|
|
144
|
+
* <p>Amazon ECS can't determine the current version of the Amazon ECS container agent on the
|
|
145
|
+
* container instance and doesn't have enough information to proceed with an update. This
|
|
146
|
+
* could be because the agent running on the container instance is a previous or custom
|
|
147
|
+
* version that doesn't use our version information.</p>
|
|
146
148
|
* @public
|
|
147
149
|
*/
|
|
148
150
|
export declare class MissingVersionException extends __BaseException {
|
|
@@ -154,9 +156,9 @@ export declare class MissingVersionException extends __BaseException {
|
|
|
154
156
|
constructor(opts: __ExceptionOptionType<MissingVersionException, __BaseException>);
|
|
155
157
|
}
|
|
156
158
|
/**
|
|
157
|
-
* <p>There's no update available for this Amazon ECS container agent. This might be because the
|
|
158
|
-
* already running the latest version or because it's so old that there's no
|
|
159
|
-
* version.</p>
|
|
159
|
+
* <p>There's no update available for this Amazon ECS container agent. This might be because the
|
|
160
|
+
* agent is already running the latest version or because it's so old that there's no
|
|
161
|
+
* update path to the current version.</p>
|
|
160
162
|
* @public
|
|
161
163
|
*/
|
|
162
164
|
export declare class NoUpdateAvailableException extends __BaseException {
|
|
@@ -172,14 +174,14 @@ export declare class NoUpdateAvailableException extends __BaseException {
|
|
|
172
174
|
*/
|
|
173
175
|
export interface UpdateContainerAgentRequest {
|
|
174
176
|
/**
|
|
175
|
-
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is
|
|
176
|
-
* If you do not specify a cluster, the default cluster is assumed.</p>
|
|
177
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is
|
|
178
|
+
* running on. If you do not specify a cluster, the default cluster is assumed.</p>
|
|
177
179
|
* @public
|
|
178
180
|
*/
|
|
179
181
|
cluster?: string | undefined;
|
|
180
182
|
/**
|
|
181
|
-
* <p>The container instance ID or full ARN entries for the container instance where you
|
|
182
|
-
* update the Amazon ECS container agent.</p>
|
|
183
|
+
* <p>The container instance ID or full ARN entries for the container instance where you
|
|
184
|
+
* would like to update the Amazon ECS container agent.</p>
|
|
183
185
|
* @public
|
|
184
186
|
*/
|
|
185
187
|
containerInstance: string | undefined;
|
|
@@ -199,8 +201,8 @@ export interface UpdateContainerAgentResponse {
|
|
|
199
201
|
*/
|
|
200
202
|
export interface UpdateContainerInstancesStateRequest {
|
|
201
203
|
/**
|
|
202
|
-
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to
|
|
203
|
-
* If you do not specify a cluster, the default cluster is assumed.</p>
|
|
204
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to
|
|
205
|
+
* update. If you do not specify a cluster, the default cluster is assumed.</p>
|
|
204
206
|
* @public
|
|
205
207
|
*/
|
|
206
208
|
cluster?: string | undefined;
|
|
@@ -210,12 +212,12 @@ export interface UpdateContainerInstancesStateRequest {
|
|
|
210
212
|
*/
|
|
211
213
|
containerInstances: string[] | undefined;
|
|
212
214
|
/**
|
|
213
|
-
* <p>The container instance state to update the container instance with. The only valid
|
|
214
|
-
* action are <code>ACTIVE</code> and <code>DRAINING</code>. A container
|
|
215
|
-
*
|
|
216
|
-
*
|
|
217
|
-
* <code>REGISTRATION_FAILED</code> state you can
|
|
218
|
-
* container instance state.</p>
|
|
215
|
+
* <p>The container instance state to update the container instance with. The only valid
|
|
216
|
+
* values for this action are <code>ACTIVE</code> and <code>DRAINING</code>. A container
|
|
217
|
+
* instance can only be updated to <code>DRAINING</code> status once it has reached an
|
|
218
|
+
* <code>ACTIVE</code> state. If a container instance is in <code>REGISTERING</code>,
|
|
219
|
+
* <code>DEREGISTERING</code>, or <code>REGISTRATION_FAILED</code> state you can
|
|
220
|
+
* describe the container instance but can't update the container instance state.</p>
|
|
219
221
|
* @public
|
|
220
222
|
*/
|
|
221
223
|
status: ContainerInstanceStatus | undefined;
|
|
@@ -251,43 +253,48 @@ export interface UpdateServiceRequest {
|
|
|
251
253
|
*/
|
|
252
254
|
service: string | undefined;
|
|
253
255
|
/**
|
|
254
|
-
* <p>The number of instantiations of the task to place and keep running in your
|
|
256
|
+
* <p>The number of instantiations of the task to place and keep running in your
|
|
257
|
+
* service.</p>
|
|
255
258
|
* @public
|
|
256
259
|
*/
|
|
257
260
|
desiredCount?: number | undefined;
|
|
258
261
|
/**
|
|
259
|
-
* <p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or
|
|
260
|
-
* task definition to run in your service. If a <code>revision</code> is
|
|
261
|
-
*
|
|
262
|
-
*
|
|
263
|
-
* then stops an old task after the new version is running.</p>
|
|
262
|
+
* <p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or
|
|
263
|
+
* full ARN of the task definition to run in your service. If a <code>revision</code> is
|
|
264
|
+
* not specified, the latest <code>ACTIVE</code> revision is used. If you modify the task
|
|
265
|
+
* definition with <code>UpdateService</code>, Amazon ECS spawns a task with the new version of
|
|
266
|
+
* the task definition and then stops an old task after the new version is running.</p>
|
|
264
267
|
* @public
|
|
265
268
|
*/
|
|
266
269
|
taskDefinition?: string | undefined;
|
|
267
270
|
/**
|
|
268
271
|
* <p>The capacity provider strategy to update the service to use.</p>
|
|
269
|
-
* <p>if the service uses the default capacity provider strategy for the cluster, the
|
|
270
|
-
* updated to use one or more capacity providers as opposed to the default
|
|
271
|
-
* However, when a service is using a capacity provider
|
|
272
|
-
* strategy, the service can't be updated
|
|
272
|
+
* <p>if the service uses the default capacity provider strategy for the cluster, the
|
|
273
|
+
* service can be updated to use one or more capacity providers as opposed to the default
|
|
274
|
+
* capacity provider strategy. However, when a service is using a capacity provider
|
|
275
|
+
* strategy that's not the default capacity provider strategy, the service can't be updated
|
|
276
|
+
* to use the cluster's default capacity provider strategy.</p>
|
|
273
277
|
* <p>A capacity provider strategy consists of one or more capacity providers along with the
|
|
274
|
-
* <code>base</code> and <code>weight</code> to assign to them. A capacity provider
|
|
275
|
-
* with the cluster to be used in a capacity provider strategy. The
|
|
276
|
-
*
|
|
277
|
-
*
|
|
278
|
-
*
|
|
278
|
+
* <code>base</code> and <code>weight</code> to assign to them. A capacity provider
|
|
279
|
+
* must be associated with the cluster to be used in a capacity provider strategy. The
|
|
280
|
+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> API is used to associate a capacity provider
|
|
281
|
+
* with a cluster. Only capacity providers with an <code>ACTIVE</code> or
|
|
282
|
+
* <code>UPDATING</code> status can be used.</p>
|
|
283
|
+
* <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity
|
|
284
|
+
* provider must already be created. New capacity providers can be created with the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html">CreateClusterCapacityProvider</a> API operation.</p>
|
|
279
285
|
* <p>To use a Fargate capacity provider, specify either the <code>FARGATE</code> or
|
|
280
|
-
* <code>FARGATE_SPOT</code> capacity providers. The Fargate capacity providers are
|
|
281
|
-
* accounts and only need to be associated with a cluster to be
|
|
282
|
-
*
|
|
283
|
-
*
|
|
286
|
+
* <code>FARGATE_SPOT</code> capacity providers. The Fargate capacity providers are
|
|
287
|
+
* available to all accounts and only need to be associated with a cluster to be
|
|
288
|
+
* used.</p>
|
|
289
|
+
* <p>The <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a>API operation is used to update the list of
|
|
290
|
+
* available capacity providers for a cluster after the cluster is created.</p>
|
|
284
291
|
* <p></p>
|
|
285
292
|
* @public
|
|
286
293
|
*/
|
|
287
294
|
capacityProviderStrategy?: CapacityProviderStrategyItem[] | undefined;
|
|
288
295
|
/**
|
|
289
|
-
* <p>Optional deployment parameters that control how many tasks run during the deployment
|
|
290
|
-
* of stopping and starting tasks.</p>
|
|
296
|
+
* <p>Optional deployment parameters that control how many tasks run during the deployment
|
|
297
|
+
* and the ordering of stopping and starting tasks.</p>
|
|
291
298
|
* @public
|
|
292
299
|
*/
|
|
293
300
|
deploymentConfiguration?: DeploymentConfiguration | undefined;
|
|
@@ -304,109 +311,118 @@ export interface UpdateServiceRequest {
|
|
|
304
311
|
*/
|
|
305
312
|
networkConfiguration?: NetworkConfiguration | undefined;
|
|
306
313
|
/**
|
|
307
|
-
* <p>An array of task placement constraint objects to update the service to use. If no
|
|
308
|
-
* the existing placement constraints for the service will remain
|
|
309
|
-
* it will override any existing placement
|
|
310
|
-
*
|
|
311
|
-
*
|
|
312
|
-
*
|
|
314
|
+
* <p>An array of task placement constraint objects to update the service to use. If no
|
|
315
|
+
* value is specified, the existing placement constraints for the service will remain
|
|
316
|
+
* unchanged. If this value is specified, it will override any existing placement
|
|
317
|
+
* constraints defined for the service. To remove all existing placement constraints,
|
|
318
|
+
* specify an empty array.</p>
|
|
319
|
+
* <p>You can specify a maximum of 10 constraints for each task. This limit includes
|
|
320
|
+
* constraints in the task definition and those specified at runtime.</p>
|
|
313
321
|
* @public
|
|
314
322
|
*/
|
|
315
323
|
placementConstraints?: PlacementConstraint[] | undefined;
|
|
316
324
|
/**
|
|
317
|
-
* <p>The task placement strategy objects to update the service to use. If no value is
|
|
318
|
-
* existing placement strategy for the service will remain unchanged. If
|
|
319
|
-
* override the existing placement strategy defined for
|
|
320
|
-
* strategy, specify an empty object.</p>
|
|
325
|
+
* <p>The task placement strategy objects to update the service to use. If no value is
|
|
326
|
+
* specified, the existing placement strategy for the service will remain unchanged. If
|
|
327
|
+
* this value is specified, it will override the existing placement strategy defined for
|
|
328
|
+
* the service. To remove an existing placement strategy, specify an empty object.</p>
|
|
321
329
|
* <p>You can specify a maximum of five strategy rules for each service.</p>
|
|
322
330
|
* @public
|
|
323
331
|
*/
|
|
324
332
|
placementStrategy?: PlacementStrategy[] | undefined;
|
|
325
333
|
/**
|
|
326
|
-
* <p>The platform version that your tasks in the service run on. A platform version is only
|
|
327
|
-
* tasks using the Fargate launch type. If a platform version
|
|
328
|
-
*
|
|
329
|
-
*
|
|
334
|
+
* <p>The platform version that your tasks in the service run on. A platform version is only
|
|
335
|
+
* specified for tasks using the Fargate launch type. If a platform version
|
|
336
|
+
* is not specified, the <code>LATEST</code> platform version is used. For more
|
|
337
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate Platform
|
|
338
|
+
* Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
330
339
|
* @public
|
|
331
340
|
*/
|
|
332
341
|
platformVersion?: string | undefined;
|
|
333
342
|
/**
|
|
334
|
-
* <p>Determines whether to force a new deployment of the service. By default, deployments
|
|
335
|
-
* You can use this option to start a new deployment with no service
|
|
336
|
-
* can update a service's tasks to use a newer Docker
|
|
337
|
-
*
|
|
343
|
+
* <p>Determines whether to force a new deployment of the service. By default, deployments
|
|
344
|
+
* aren't forced. You can use this option to start a new deployment with no service
|
|
345
|
+
* definition changes. For example, you can update a service's tasks to use a newer Docker
|
|
346
|
+
* image with the same image/tag combination (<code>my_image:latest</code>) or to roll
|
|
347
|
+
* Fargate tasks onto a newer platform version.</p>
|
|
338
348
|
* @public
|
|
339
349
|
*/
|
|
340
350
|
forceNewDeployment?: boolean | undefined;
|
|
341
351
|
/**
|
|
342
|
-
* <p>The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy
|
|
343
|
-
* health checks after a task has first started. If you don't
|
|
344
|
-
* period value, the default value of <code>0</code> is used.
|
|
345
|
-
*
|
|
346
|
-
*
|
|
347
|
-
*
|
|
348
|
-
*
|
|
349
|
-
*
|
|
352
|
+
* <p>The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy
|
|
353
|
+
* Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't
|
|
354
|
+
* specify a health check grace period value, the default value of <code>0</code> is used.
|
|
355
|
+
* If you don't use any of the health checks, then
|
|
356
|
+
* <code>healthCheckGracePeriodSeconds</code> is unused.</p>
|
|
357
|
+
* <p>If your service's tasks take a while to start and respond to health checks, you can
|
|
358
|
+
* specify a health check grace period of up to 2,147,483,647 seconds (about 69 years).
|
|
359
|
+
* During that time, the Amazon ECS service scheduler ignores health check status. This grace
|
|
360
|
+
* period can prevent the service scheduler from marking tasks as unhealthy and stopping
|
|
361
|
+
* them before they have time to come up.</p>
|
|
350
362
|
* @public
|
|
351
363
|
*/
|
|
352
364
|
healthCheckGracePeriodSeconds?: number | undefined;
|
|
353
365
|
/**
|
|
354
|
-
* <p>If <code>true</code>, this enables execute command functionality on all task
|
|
355
|
-
*
|
|
356
|
-
*
|
|
366
|
+
* <p>If <code>true</code>, this enables execute command functionality on all task
|
|
367
|
+
* containers.</p>
|
|
368
|
+
* <p>If you do not want to override the value that was set when the service was created,
|
|
369
|
+
* you can set this to <code>null</code> when performing this action.</p>
|
|
357
370
|
* @public
|
|
358
371
|
*/
|
|
359
372
|
enableExecuteCommand?: boolean | undefined;
|
|
360
373
|
/**
|
|
361
|
-
* <p>Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For
|
|
362
|
-
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your
|
|
363
|
-
*
|
|
364
|
-
* <p>Only tasks launched after the update will reflect the update. To update the tags on
|
|
365
|
-
*
|
|
366
|
-
* updated tags.</p>
|
|
374
|
+
* <p>Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For
|
|
375
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your Amazon ECS
|
|
376
|
+
* Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
377
|
+
* <p>Only tasks launched after the update will reflect the update. To update the tags on
|
|
378
|
+
* all tasks, set <code>forceNewDeployment</code> to <code>true</code>, so that Amazon ECS
|
|
379
|
+
* starts new tasks with the updated tags.</p>
|
|
367
380
|
* @public
|
|
368
381
|
*/
|
|
369
382
|
enableECSManagedTags?: boolean | undefined;
|
|
370
383
|
/**
|
|
371
|
-
* <p>A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the
|
|
372
|
-
* the container port to access from the load balancer. The container
|
|
373
|
-
* definition.</p>
|
|
374
|
-
* <p>When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks
|
|
375
|
-
* updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks
|
|
376
|
-
*
|
|
377
|
-
*
|
|
378
|
-
* target group
|
|
379
|
-
*
|
|
380
|
-
*
|
|
384
|
+
* <p>A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the
|
|
385
|
+
* container name, and the container port to access from the load balancer. The container
|
|
386
|
+
* name is as it appears in a container definition.</p>
|
|
387
|
+
* <p>When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks
|
|
388
|
+
* with the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks
|
|
389
|
+
* are running.</p>
|
|
390
|
+
* <p>For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target
|
|
391
|
+
* groups. You can update from a single target group to multiple target groups and from
|
|
392
|
+
* multiple target groups to a single target group.</p>
|
|
393
|
+
* <p>For services that use blue/green deployments, you can update Elastic Load Balancing target groups by
|
|
394
|
+
* using <code>
|
|
381
395
|
* <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html">CreateDeployment</a>
|
|
382
|
-
* </code>
|
|
383
|
-
*
|
|
384
|
-
*
|
|
385
|
-
*
|
|
386
|
-
*
|
|
387
|
-
*
|
|
388
|
-
*
|
|
396
|
+
* </code> through CodeDeploy. Note that multiple target groups
|
|
397
|
+
* are not supported for blue/green deployments. For more information see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html">Register
|
|
398
|
+
* multiple target groups with a service</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. </p>
|
|
399
|
+
* <p>For services that use the external deployment controller, you can add, update, or
|
|
400
|
+
* remove load balancers by using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>.
|
|
401
|
+
* Note that multiple target groups are not supported for external deployments. For more
|
|
402
|
+
* information see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html">Register
|
|
403
|
+
* multiple target groups with a service</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. </p>
|
|
389
404
|
* <p>You can remove existing <code>loadBalancers</code> by passing an empty list.</p>
|
|
390
405
|
* @public
|
|
391
406
|
*/
|
|
392
407
|
loadBalancers?: LoadBalancer[] | undefined;
|
|
393
408
|
/**
|
|
394
|
-
* <p>Determines whether to propagate the tags from the task definition or the service to
|
|
395
|
-
* value is specified, the tags aren't propagated.</p>
|
|
396
|
-
* <p>Only tasks launched after the update will reflect the update. To update the tags on
|
|
397
|
-
*
|
|
398
|
-
* updated tags.</p>
|
|
409
|
+
* <p>Determines whether to propagate the tags from the task definition or the service to
|
|
410
|
+
* the task. If no value is specified, the tags aren't propagated.</p>
|
|
411
|
+
* <p>Only tasks launched after the update will reflect the update. To update the tags on
|
|
412
|
+
* all tasks, set <code>forceNewDeployment</code> to <code>true</code>, so that Amazon ECS
|
|
413
|
+
* starts new tasks with the updated tags.</p>
|
|
399
414
|
* @public
|
|
400
415
|
*/
|
|
401
416
|
propagateTags?: PropagateTags | undefined;
|
|
402
417
|
/**
|
|
403
|
-
* <p>The details for the service discovery registries to assign to this service. For more
|
|
404
|
-
*
|
|
418
|
+
* <p>The details for the service discovery registries to assign to this service. For more
|
|
419
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html">Service
|
|
405
420
|
* Discovery</a>.</p>
|
|
406
|
-
* <p>When you add, update, or remove the service registries configuration, Amazon ECS starts new
|
|
407
|
-
* updated service registries configuration, and then stops the old tasks
|
|
408
|
-
* running.</p>
|
|
409
|
-
* <p>You can remove existing <code>serviceRegistries</code> by passing an empty
|
|
421
|
+
* <p>When you add, update, or remove the service registries configuration, Amazon ECS starts new
|
|
422
|
+
* tasks with the updated service registries configuration, and then stops the old tasks
|
|
423
|
+
* when the new tasks are running.</p>
|
|
424
|
+
* <p>You can remove existing <code>serviceRegistries</code> by passing an empty
|
|
425
|
+
* list.</p>
|
|
410
426
|
* @public
|
|
411
427
|
*/
|
|
412
428
|
serviceRegistries?: ServiceRegistry[] | undefined;
|
|
@@ -423,15 +439,17 @@ export interface UpdateServiceRequest {
|
|
|
423
439
|
*/
|
|
424
440
|
serviceConnectConfiguration?: ServiceConnectConfiguration | undefined;
|
|
425
441
|
/**
|
|
426
|
-
* <p>The details of the volume that was <code>configuredAtLaunch</code>. You can configure
|
|
427
|
-
* volumeType, IOPS, throughput, snapshot and encryption in <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html">ServiceManagedEBSVolumeConfiguration</a>. The <code>name</code> of the volume
|
|
428
|
-
*
|
|
429
|
-
* Otherwise, if this configuration differs from the existing one,
|
|
442
|
+
* <p>The details of the volume that was <code>configuredAtLaunch</code>. You can configure
|
|
443
|
+
* the size, volumeType, IOPS, throughput, snapshot and encryption in <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html">ServiceManagedEBSVolumeConfiguration</a>. The <code>name</code> of the volume
|
|
444
|
+
* must match the <code>name</code> from the task definition. If set to null, no new
|
|
445
|
+
* deployment is triggered. Otherwise, if this configuration differs from the existing one,
|
|
446
|
+
* it triggers a new deployment.</p>
|
|
430
447
|
* @public
|
|
431
448
|
*/
|
|
432
449
|
volumeConfigurations?: ServiceVolumeConfiguration[] | undefined;
|
|
433
450
|
/**
|
|
434
|
-
* <p>An object representing the VPC Lattice configuration for the service being
|
|
451
|
+
* <p>An object representing the VPC Lattice configuration for the service being
|
|
452
|
+
* updated.</p>
|
|
435
453
|
* @public
|
|
436
454
|
*/
|
|
437
455
|
vpcLatticeConfigurations?: VpcLatticeConfiguration[] | undefined;
|
|
@@ -451,8 +469,8 @@ export interface UpdateServiceResponse {
|
|
|
451
469
|
*/
|
|
452
470
|
export interface UpdateServicePrimaryTaskSetRequest {
|
|
453
471
|
/**
|
|
454
|
-
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task
|
|
455
|
-
* in.</p>
|
|
472
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task
|
|
473
|
+
* set exists in.</p>
|
|
456
474
|
* @public
|
|
457
475
|
*/
|
|
458
476
|
cluster: string | undefined;
|
|
@@ -483,8 +501,8 @@ export interface UpdateServicePrimaryTaskSetResponse {
|
|
|
483
501
|
*/
|
|
484
502
|
export interface UpdateTaskProtectionRequest {
|
|
485
503
|
/**
|
|
486
|
-
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task
|
|
487
|
-
* in.</p>
|
|
504
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task
|
|
505
|
+
* sets exist in.</p>
|
|
488
506
|
* @public
|
|
489
507
|
*/
|
|
490
508
|
cluster: string | undefined;
|
|
@@ -494,19 +512,19 @@ export interface UpdateTaskProtectionRequest {
|
|
|
494
512
|
*/
|
|
495
513
|
tasks: string[] | undefined;
|
|
496
514
|
/**
|
|
497
|
-
* <p>Specify <code>true</code> to mark a task for protection and <code>false</code> to
|
|
498
|
-
* making it eligible for termination.</p>
|
|
515
|
+
* <p>Specify <code>true</code> to mark a task for protection and <code>false</code> to
|
|
516
|
+
* unset protection, making it eligible for termination.</p>
|
|
499
517
|
* @public
|
|
500
518
|
*/
|
|
501
519
|
protectionEnabled: boolean | undefined;
|
|
502
520
|
/**
|
|
503
|
-
* <p>If you set <code>protectionEnabled</code> to <code>true</code>, you can specify the
|
|
504
|
-
* protection in minutes. You can specify a value from 1 minute to up to
|
|
505
|
-
* this time, your task will not be terminated by scale-in
|
|
506
|
-
* deployments. After this time period lapses,
|
|
507
|
-
* <code>false</code>.</p>
|
|
508
|
-
* <p>If you don’t specify the time, then the task is automatically protected for 120
|
|
509
|
-
* hours).</p>
|
|
521
|
+
* <p>If you set <code>protectionEnabled</code> to <code>true</code>, you can specify the
|
|
522
|
+
* duration for task protection in minutes. You can specify a value from 1 minute to up to
|
|
523
|
+
* 2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in
|
|
524
|
+
* events from Service Auto Scaling or deployments. After this time period lapses,
|
|
525
|
+
* <code>protectionEnabled</code> will be reset to <code>false</code>.</p>
|
|
526
|
+
* <p>If you don’t specify the time, then the task is automatically protected for 120
|
|
527
|
+
* minutes (2 hours).</p>
|
|
510
528
|
* @public
|
|
511
529
|
*/
|
|
512
530
|
expiresInMinutes?: number | undefined;
|
|
@@ -524,13 +542,14 @@ export interface UpdateTaskProtectionResponse {
|
|
|
524
542
|
* </li>
|
|
525
543
|
* <li>
|
|
526
544
|
* <p>
|
|
527
|
-
* <code>protectionEnabled</code>: The protection status of the task. If scale-in
|
|
528
|
-
* turned on for a task, the value is <code>true</code>. Otherwise,
|
|
529
|
-
* <code>false</code>.</p>
|
|
545
|
+
* <code>protectionEnabled</code>: The protection status of the task. If scale-in
|
|
546
|
+
* protection is turned on for a task, the value is <code>true</code>. Otherwise,
|
|
547
|
+
* it is <code>false</code>.</p>
|
|
530
548
|
* </li>
|
|
531
549
|
* <li>
|
|
532
550
|
* <p>
|
|
533
|
-
* <code>expirationDate</code>: The epoch time when protection for the task will
|
|
551
|
+
* <code>expirationDate</code>: The epoch time when protection for the task will
|
|
552
|
+
* expire.</p>
|
|
534
553
|
* </li>
|
|
535
554
|
* </ul>
|
|
536
555
|
* @public
|
|
@@ -547,8 +566,8 @@ export interface UpdateTaskProtectionResponse {
|
|
|
547
566
|
*/
|
|
548
567
|
export interface UpdateTaskSetRequest {
|
|
549
568
|
/**
|
|
550
|
-
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task
|
|
551
|
-
* in.</p>
|
|
569
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task
|
|
570
|
+
* set is found in.</p>
|
|
552
571
|
* @public
|
|
553
572
|
*/
|
|
554
573
|
cluster: string | undefined;
|
|
@@ -563,8 +582,8 @@ export interface UpdateTaskSetRequest {
|
|
|
563
582
|
*/
|
|
564
583
|
taskSet: string | undefined;
|
|
565
584
|
/**
|
|
566
|
-
* <p>A floating-point percentage of the desired number of tasks to place and keep running
|
|
567
|
-
* set.</p>
|
|
585
|
+
* <p>A floating-point percentage of the desired number of tasks to place and keep running
|
|
586
|
+
* in the task set.</p>
|
|
568
587
|
* @public
|
|
569
588
|
*/
|
|
570
589
|
scale: Scale | undefined;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-ecs",
|
|
3
3
|
"description": "AWS SDK for JavaScript Ecs Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.708.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-ecs",
|