@aws-sdk/client-ecs 3.693.0 → 3.696.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 +11 -12
- package/dist-cjs/index.js +10 -2
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_json1_1.js +2 -0
- package/dist-types/ECS.d.ts +11 -12
- package/dist-types/ECSClient.d.ts +11 -12
- package/dist-types/commands/CreateCapacityProviderCommand.d.ts +17 -22
- package/dist-types/commands/CreateClusterCommand.d.ts +17 -19
- package/dist-types/commands/CreateServiceCommand.d.ts +89 -80
- package/dist-types/commands/CreateTaskSetCommand.d.ts +15 -19
- package/dist-types/commands/DeleteAccountSettingCommand.d.ts +9 -12
- package/dist-types/commands/DeleteAttributesCommand.d.ts +2 -4
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +17 -21
- package/dist-types/commands/DeleteClusterCommand.d.ts +23 -27
- package/dist-types/commands/DeleteServiceCommand.d.ts +30 -29
- package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +24 -28
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +14 -17
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +19 -22
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +24 -26
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +8 -10
- package/dist-types/commands/DescribeClustersCommand.d.ts +8 -10
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +10 -12
- package/dist-types/commands/DescribeServiceDeploymentsCommand.d.ts +9 -12
- package/dist-types/commands/DescribeServiceRevisionsCommand.d.ts +16 -12
- package/dist-types/commands/DescribeServicesCommand.d.ts +15 -10
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +14 -16
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +13 -17
- package/dist-types/commands/DescribeTasksCommand.d.ts +11 -13
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +7 -8
- package/dist-types/commands/ExecuteCommandCommand.d.ts +19 -23
- package/dist-types/commands/GetTaskProtectionCommand.d.ts +8 -10
- package/dist-types/commands/ListAccountSettingsCommand.d.ts +8 -10
- package/dist-types/commands/ListAttributesCommand.d.ts +6 -8
- package/dist-types/commands/ListClustersCommand.d.ts +8 -10
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +12 -13
- package/dist-types/commands/ListServiceDeploymentsCommand.d.ts +9 -12
- package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +12 -15
- package/dist-types/commands/ListServicesCommand.d.ts +10 -12
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -10
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +13 -17
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +11 -13
- package/dist-types/commands/ListTasksCommand.d.ts +12 -15
- package/dist-types/commands/PutAccountSettingCommand.d.ts +11 -14
- package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +10 -12
- package/dist-types/commands/PutAttributesCommand.d.ts +7 -11
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +24 -29
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +10 -12
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +23 -23
- package/dist-types/commands/RunTaskCommand.d.ts +33 -37
- package/dist-types/commands/StartTaskCommand.d.ts +16 -16
- package/dist-types/commands/StopTaskCommand.d.ts +18 -22
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +8 -10
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +7 -8
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +8 -10
- package/dist-types/commands/TagResourceCommand.d.ts +11 -14
- package/dist-types/commands/UntagResourceCommand.d.ts +8 -10
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +9 -11
- package/dist-types/commands/UpdateClusterCommand.d.ts +8 -10
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +8 -10
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +33 -37
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +42 -48
- package/dist-types/commands/UpdateServiceCommand.d.ts +105 -101
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +15 -20
- package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +20 -25
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +15 -19
- package/dist-types/index.d.ts +11 -12
- package/dist-types/models/models_0.d.ts +2882 -3340
- package/dist-types/models/models_1.d.ts +166 -152
- package/dist-types/ts3.4/commands/UpdateCapacityProviderCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +15 -7
- package/dist-types/ts3.4/models/models_1.d.ts +11 -0
- package/package.json +36 -36
|
@@ -1,6 +1,32 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { ECSServiceException as __BaseException } from "./ECSServiceException";
|
|
3
|
-
import { CapacityProviderStrategyItem, Cluster, ClusterConfiguration, ClusterServiceConnectDefaultsRequest, ClusterSetting, ContainerInstance, ContainerInstanceStatus, DeploymentConfiguration, Failure, LoadBalancer, NetworkConfiguration, PlacementConstraint, PlacementStrategy, PropagateTags, ProtectedTask, Scale, Service, ServiceConnectConfiguration, ServiceRegistry, ServiceVolumeConfiguration, TaskSet } from "./models_0";
|
|
3
|
+
import { AutoScalingGroupProviderUpdate, CapacityProvider, CapacityProviderStrategyItem, Cluster, ClusterConfiguration, ClusterServiceConnectDefaultsRequest, ClusterSetting, ContainerInstance, ContainerInstanceStatus, DeploymentConfiguration, Failure, LoadBalancer, NetworkConfiguration, PlacementConstraint, PlacementStrategy, PropagateTags, ProtectedTask, Scale, Service, ServiceConnectConfiguration, ServiceRegistry, ServiceVolumeConfiguration, TaskSet, VpcLatticeConfiguration } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface UpdateCapacityProviderRequest {
|
|
8
|
+
/**
|
|
9
|
+
* <p>The name of the capacity provider to update.</p>
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
name: string | undefined;
|
|
13
|
+
/**
|
|
14
|
+
* <p>An object that represent the parameters to update for the Auto Scaling group capacity
|
|
15
|
+
* provider.</p>
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
autoScalingGroupProvider: AutoScalingGroupProviderUpdate | undefined;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
export interface UpdateCapacityProviderResponse {
|
|
24
|
+
/**
|
|
25
|
+
* <p>Details about the capacity provider.</p>
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
capacityProvider?: CapacityProvider | undefined;
|
|
29
|
+
}
|
|
4
30
|
/**
|
|
5
31
|
* @public
|
|
6
32
|
*/
|
|
@@ -57,16 +83,14 @@ export interface UpdateClusterSettingsRequest {
|
|
|
57
83
|
*/
|
|
58
84
|
cluster: string | undefined;
|
|
59
85
|
/**
|
|
60
|
-
* <p>The setting to use by default for a cluster. This parameter is used to turn on CloudWatch
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html">PutAccountSettingDefault</a>.</p>
|
|
86
|
+
* <p>The setting to use by default for a cluster. This parameter is used to turn on CloudWatch Container
|
|
87
|
+
* Insights for a cluster. If this value is specified, it overrides the <code>containerInsights</code>
|
|
88
|
+
* 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>
|
|
64
89
|
* <important>
|
|
65
|
-
* <p>Currently, if you delete an existing cluster that does not have Container Insights
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
* wait 7 days before you can re-create it.</p>
|
|
90
|
+
* <p>Currently, if you delete an existing cluster that does not have Container Insights turned on, and
|
|
91
|
+
* then create a new cluster with the same name with Container Insights tuned on, Container Insights
|
|
92
|
+
* will not actually be turned on. If you want to preserve the same name for your existing cluster and
|
|
93
|
+
* turn on Container Insights, you must wait 7 days before you can re-create it.</p>
|
|
70
94
|
* </important>
|
|
71
95
|
* @public
|
|
72
96
|
*/
|
|
@@ -83,10 +107,9 @@ export interface UpdateClusterSettingsResponse {
|
|
|
83
107
|
cluster?: Cluster | undefined;
|
|
84
108
|
}
|
|
85
109
|
/**
|
|
86
|
-
* <p>Amazon ECS can't determine the current version of the Amazon ECS container agent on the
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
* version that doesn't use our version information.</p>
|
|
110
|
+
* <p>Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and
|
|
111
|
+
* doesn't have enough information to proceed with an update. This could be because the agent running on
|
|
112
|
+
* the container instance is a previous or custom version that doesn't use our version information.</p>
|
|
90
113
|
* @public
|
|
91
114
|
*/
|
|
92
115
|
export declare class MissingVersionException extends __BaseException {
|
|
@@ -98,9 +121,9 @@ export declare class MissingVersionException extends __BaseException {
|
|
|
98
121
|
constructor(opts: __ExceptionOptionType<MissingVersionException, __BaseException>);
|
|
99
122
|
}
|
|
100
123
|
/**
|
|
101
|
-
* <p>There's no update available for this Amazon ECS container agent. This might be because the
|
|
102
|
-
*
|
|
103
|
-
*
|
|
124
|
+
* <p>There's no update available for this Amazon ECS container agent. This might be because the agent is
|
|
125
|
+
* already running the latest version or because it's so old that there's no update path to the current
|
|
126
|
+
* version.</p>
|
|
104
127
|
* @public
|
|
105
128
|
*/
|
|
106
129
|
export declare class NoUpdateAvailableException extends __BaseException {
|
|
@@ -116,14 +139,14 @@ export declare class NoUpdateAvailableException extends __BaseException {
|
|
|
116
139
|
*/
|
|
117
140
|
export interface UpdateContainerAgentRequest {
|
|
118
141
|
/**
|
|
119
|
-
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is
|
|
120
|
-
*
|
|
142
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on.
|
|
143
|
+
* If you do not specify a cluster, the default cluster is assumed.</p>
|
|
121
144
|
* @public
|
|
122
145
|
*/
|
|
123
146
|
cluster?: string | undefined;
|
|
124
147
|
/**
|
|
125
|
-
* <p>The container instance ID or full ARN entries for the container instance where you
|
|
126
|
-
*
|
|
148
|
+
* <p>The container instance ID or full ARN entries for the container instance where you would like to
|
|
149
|
+
* update the Amazon ECS container agent.</p>
|
|
127
150
|
* @public
|
|
128
151
|
*/
|
|
129
152
|
containerInstance: string | undefined;
|
|
@@ -143,8 +166,8 @@ export interface UpdateContainerAgentResponse {
|
|
|
143
166
|
*/
|
|
144
167
|
export interface UpdateContainerInstancesStateRequest {
|
|
145
168
|
/**
|
|
146
|
-
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to
|
|
147
|
-
*
|
|
169
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update.
|
|
170
|
+
* If you do not specify a cluster, the default cluster is assumed.</p>
|
|
148
171
|
* @public
|
|
149
172
|
*/
|
|
150
173
|
cluster?: string | undefined;
|
|
@@ -154,12 +177,12 @@ export interface UpdateContainerInstancesStateRequest {
|
|
|
154
177
|
*/
|
|
155
178
|
containerInstances: string[] | undefined;
|
|
156
179
|
/**
|
|
157
|
-
* <p>The container instance state to update the container instance with. The only valid
|
|
158
|
-
*
|
|
159
|
-
*
|
|
160
|
-
*
|
|
161
|
-
* <code>
|
|
162
|
-
*
|
|
180
|
+
* <p>The container instance state to update the container instance with. The only valid values for this
|
|
181
|
+
* action are <code>ACTIVE</code> and <code>DRAINING</code>. A container instance can only be updated to
|
|
182
|
+
* <code>DRAINING</code> status once it has reached an <code>ACTIVE</code> state. If a container
|
|
183
|
+
* instance is in <code>REGISTERING</code>, <code>DEREGISTERING</code>, or
|
|
184
|
+
* <code>REGISTRATION_FAILED</code> state you can describe the container instance but can't update the
|
|
185
|
+
* container instance state.</p>
|
|
163
186
|
* @public
|
|
164
187
|
*/
|
|
165
188
|
status: ContainerInstanceStatus | undefined;
|
|
@@ -195,48 +218,43 @@ export interface UpdateServiceRequest {
|
|
|
195
218
|
*/
|
|
196
219
|
service: string | undefined;
|
|
197
220
|
/**
|
|
198
|
-
* <p>The number of instantiations of the task to place and keep running in your
|
|
199
|
-
* service.</p>
|
|
221
|
+
* <p>The number of instantiations of the task to place and keep running in your service.</p>
|
|
200
222
|
* @public
|
|
201
223
|
*/
|
|
202
224
|
desiredCount?: number | undefined;
|
|
203
225
|
/**
|
|
204
|
-
* <p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or
|
|
205
|
-
*
|
|
206
|
-
*
|
|
207
|
-
*
|
|
208
|
-
*
|
|
226
|
+
* <p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full ARN of the
|
|
227
|
+
* task definition to run in your service. If a <code>revision</code> is not specified, the latest
|
|
228
|
+
* <code>ACTIVE</code> revision is used. If you modify the task definition with
|
|
229
|
+
* <code>UpdateService</code>, Amazon ECS spawns a task with the new version of the task definition and
|
|
230
|
+
* then stops an old task after the new version is running.</p>
|
|
209
231
|
* @public
|
|
210
232
|
*/
|
|
211
233
|
taskDefinition?: string | undefined;
|
|
212
234
|
/**
|
|
213
235
|
* <p>The capacity provider strategy to update the service to use.</p>
|
|
214
|
-
* <p>if the service uses the default capacity provider strategy for the cluster, the
|
|
215
|
-
*
|
|
216
|
-
*
|
|
217
|
-
* strategy
|
|
218
|
-
* to use the cluster's default capacity provider strategy.</p>
|
|
236
|
+
* <p>if the service uses the default capacity provider strategy for the cluster, the service can be
|
|
237
|
+
* updated to use one or more capacity providers as opposed to the default capacity provider strategy.
|
|
238
|
+
* However, when a service is using a capacity provider strategy that's not the default capacity provider
|
|
239
|
+
* strategy, the service can't be updated to use the cluster's default capacity provider strategy.</p>
|
|
219
240
|
* <p>A capacity provider strategy consists of one or more capacity providers along with the
|
|
220
|
-
* <code>base</code> and <code>weight</code> to assign to them. A capacity provider
|
|
221
|
-
*
|
|
222
|
-
* <
|
|
223
|
-
*
|
|
224
|
-
*
|
|
225
|
-
* <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity
|
|
226
|
-
* 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>
|
|
241
|
+
* <code>base</code> and <code>weight</code> to assign to them. A capacity provider must be associated
|
|
242
|
+
* with the cluster to be used in a capacity provider strategy. The <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> API is used to associate a capacity provider with a cluster.
|
|
243
|
+
* Only capacity providers with an <code>ACTIVE</code> or <code>UPDATING</code> status can be used.</p>
|
|
244
|
+
* <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already
|
|
245
|
+
* 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>
|
|
227
246
|
* <p>To use a Fargate capacity provider, specify either the <code>FARGATE</code> or
|
|
228
|
-
* <code>FARGATE_SPOT</code> capacity providers. The Fargate capacity providers are
|
|
229
|
-
*
|
|
230
|
-
*
|
|
231
|
-
*
|
|
232
|
-
* list of available capacity providers for a cluster after the cluster is created.</p>
|
|
247
|
+
* <code>FARGATE_SPOT</code> capacity providers. The Fargate capacity providers are available to all
|
|
248
|
+
* accounts and only need to be associated with a cluster to be used.</p>
|
|
249
|
+
* <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 available capacity
|
|
250
|
+
* providers for a cluster after the cluster is created.</p>
|
|
233
251
|
* <p></p>
|
|
234
252
|
* @public
|
|
235
253
|
*/
|
|
236
254
|
capacityProviderStrategy?: CapacityProviderStrategyItem[] | undefined;
|
|
237
255
|
/**
|
|
238
|
-
* <p>Optional deployment parameters that control how many tasks run during the deployment and the
|
|
239
|
-
*
|
|
256
|
+
* <p>Optional deployment parameters that control how many tasks run during the deployment and the ordering
|
|
257
|
+
* of stopping and starting tasks.</p>
|
|
240
258
|
* @public
|
|
241
259
|
*/
|
|
242
260
|
deploymentConfiguration?: DeploymentConfiguration | undefined;
|
|
@@ -246,116 +264,109 @@ export interface UpdateServiceRequest {
|
|
|
246
264
|
*/
|
|
247
265
|
networkConfiguration?: NetworkConfiguration | undefined;
|
|
248
266
|
/**
|
|
249
|
-
* <p>An array of task placement constraint objects to update the service to use. If no
|
|
250
|
-
*
|
|
251
|
-
*
|
|
252
|
-
* constraints
|
|
253
|
-
*
|
|
254
|
-
*
|
|
255
|
-
* constraints in the task definition and those specified at runtime.</p>
|
|
267
|
+
* <p>An array of task placement constraint objects to update the service to use. If no value is specified,
|
|
268
|
+
* the existing placement constraints for the service will remain unchanged. If this value is specified,
|
|
269
|
+
* it will override any existing placement constraints defined for the service. To remove all existing
|
|
270
|
+
* placement constraints, specify an empty array.</p>
|
|
271
|
+
* <p>You can specify a maximum of 10 constraints for each task. This limit includes constraints in the
|
|
272
|
+
* task definition and those specified at runtime.</p>
|
|
256
273
|
* @public
|
|
257
274
|
*/
|
|
258
275
|
placementConstraints?: PlacementConstraint[] | undefined;
|
|
259
276
|
/**
|
|
260
|
-
* <p>The task placement strategy objects to update the service to use. If no value is
|
|
261
|
-
*
|
|
262
|
-
*
|
|
263
|
-
*
|
|
277
|
+
* <p>The task placement strategy objects to update the service to use. If no value is specified, the
|
|
278
|
+
* existing placement strategy for the service will remain unchanged. If this value is specified, it will
|
|
279
|
+
* override the existing placement strategy defined for the service. To remove an existing placement
|
|
280
|
+
* strategy, specify an empty object.</p>
|
|
264
281
|
* <p>You can specify a maximum of five strategy rules for each service.</p>
|
|
265
282
|
* @public
|
|
266
283
|
*/
|
|
267
284
|
placementStrategy?: PlacementStrategy[] | undefined;
|
|
268
285
|
/**
|
|
269
|
-
* <p>The platform version that your tasks in the service run on. A platform version is only
|
|
270
|
-
*
|
|
271
|
-
*
|
|
272
|
-
*
|
|
273
|
-
* Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
286
|
+
* <p>The platform version that your tasks in the service run on. A platform version is only specified for
|
|
287
|
+
* tasks using the Fargate launch type. If a platform version is not specified, the
|
|
288
|
+
* <code>LATEST</code> platform version is used. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate Platform Versions</a> in
|
|
289
|
+
* the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
274
290
|
* @public
|
|
275
291
|
*/
|
|
276
292
|
platformVersion?: string | undefined;
|
|
277
293
|
/**
|
|
278
|
-
* <p>Determines whether to force a new deployment of the service. By default, deployments
|
|
279
|
-
*
|
|
280
|
-
*
|
|
281
|
-
*
|
|
282
|
-
* Fargate tasks onto a newer platform version.</p>
|
|
294
|
+
* <p>Determines whether to force a new deployment of the service. By default, deployments aren't forced.
|
|
295
|
+
* You can use this option to start a new deployment with no service definition changes. For example, you
|
|
296
|
+
* can update a service's tasks to use a newer Docker image with the same image/tag combination
|
|
297
|
+
* (<code>my_image:latest</code>) or to roll Fargate tasks onto a newer platform version.</p>
|
|
283
298
|
* @public
|
|
284
299
|
*/
|
|
285
300
|
forceNewDeployment?: boolean | undefined;
|
|
286
301
|
/**
|
|
287
|
-
* <p>The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy
|
|
288
|
-
*
|
|
289
|
-
*
|
|
290
|
-
*
|
|
291
|
-
*
|
|
292
|
-
*
|
|
293
|
-
*
|
|
294
|
-
* up.</p>
|
|
302
|
+
* <p>The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container
|
|
303
|
+
* health checks after a task has first started. If you don't specify a health check grace
|
|
304
|
+
* period value, the default value of <code>0</code> is used. If you don't use any of the health checks,
|
|
305
|
+
* then <code>healthCheckGracePeriodSeconds</code> is unused.</p>
|
|
306
|
+
* <p>If your service's tasks take a while to start and respond to health checks, you can specify a
|
|
307
|
+
* health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS
|
|
308
|
+
* service scheduler ignores health check status. This grace period can prevent the service scheduler from
|
|
309
|
+
* marking tasks as unhealthy and stopping them before they have time to come up.</p>
|
|
295
310
|
* @public
|
|
296
311
|
*/
|
|
297
312
|
healthCheckGracePeriodSeconds?: number | undefined;
|
|
298
313
|
/**
|
|
299
|
-
* <p>If <code>true</code>, this enables execute command functionality on all task
|
|
300
|
-
*
|
|
301
|
-
*
|
|
302
|
-
* you can set this to <code>null</code> when performing this action.</p>
|
|
314
|
+
* <p>If <code>true</code>, this enables execute command functionality on all task containers.</p>
|
|
315
|
+
* <p>If you do not want to override the value that was set when the service was created, you can set this
|
|
316
|
+
* to <code>null</code> when performing this action.</p>
|
|
303
317
|
* @public
|
|
304
318
|
*/
|
|
305
319
|
enableExecuteCommand?: boolean | undefined;
|
|
306
320
|
/**
|
|
307
|
-
* <p>Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For
|
|
308
|
-
*
|
|
309
|
-
* Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
310
|
-
* <p>Only tasks launched after the update will reflect the update. To update the tags on
|
|
311
|
-
*
|
|
312
|
-
*
|
|
321
|
+
* <p>Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For more information,
|
|
322
|
+
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your
|
|
323
|
+
* Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
324
|
+
* <p>Only tasks launched after the update will reflect the update. To update the tags on all tasks, set
|
|
325
|
+
* <code>forceNewDeployment</code> to <code>true</code>, so that Amazon ECS starts new tasks with the
|
|
326
|
+
* updated tags.</p>
|
|
313
327
|
* @public
|
|
314
328
|
*/
|
|
315
329
|
enableECSManagedTags?: boolean | undefined;
|
|
316
330
|
/**
|
|
317
|
-
* <p>A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the
|
|
318
|
-
*
|
|
319
|
-
*
|
|
320
|
-
* <p>When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks
|
|
321
|
-
*
|
|
322
|
-
*
|
|
323
|
-
*
|
|
324
|
-
*
|
|
325
|
-
*
|
|
326
|
-
*
|
|
327
|
-
* using <code>
|
|
331
|
+
* <p>A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and
|
|
332
|
+
* the container port to access from the load balancer. The container name is as it appears in a container
|
|
333
|
+
* definition.</p>
|
|
334
|
+
* <p>When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with the
|
|
335
|
+
* updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are running.</p>
|
|
336
|
+
* <p>For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target groups. You can
|
|
337
|
+
* update from a single target group to multiple target groups and from multiple target groups to a single
|
|
338
|
+
* target group.</p>
|
|
339
|
+
* <p>For services that use blue/green deployments, you can update Elastic Load Balancing target groups by using
|
|
340
|
+
* <code>
|
|
328
341
|
* <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html">CreateDeployment</a>
|
|
329
|
-
* </code>
|
|
330
|
-
* are not supported for blue/green deployments. For more
|
|
331
|
-
*
|
|
332
|
-
*
|
|
333
|
-
*
|
|
334
|
-
*
|
|
335
|
-
* information see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html">Register
|
|
336
|
-
* multiple target groups with a service</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. </p>
|
|
342
|
+
* </code>
|
|
343
|
+
* through CodeDeploy. Note that multiple target groups are not supported for blue/green deployments. For more
|
|
344
|
+
* information see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html">Register multiple target
|
|
345
|
+
* groups with a service</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. </p>
|
|
346
|
+
* <p>For services that use the external deployment controller, you can add, update, or remove load
|
|
347
|
+
* balancers by using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>. Note that
|
|
348
|
+
* multiple target groups are not supported for external deployments. For more information see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html">Register multiple target groups with a service</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. </p>
|
|
337
349
|
* <p>You can remove existing <code>loadBalancers</code> by passing an empty list.</p>
|
|
338
350
|
* @public
|
|
339
351
|
*/
|
|
340
352
|
loadBalancers?: LoadBalancer[] | undefined;
|
|
341
353
|
/**
|
|
342
|
-
* <p>Determines whether to propagate the tags from the task definition or the service to
|
|
343
|
-
*
|
|
344
|
-
* <p>Only tasks launched after the update will reflect the update. To update the tags on
|
|
345
|
-
*
|
|
346
|
-
*
|
|
354
|
+
* <p>Determines whether to propagate the tags from the task definition or the service to the task. If no
|
|
355
|
+
* value is specified, the tags aren't propagated.</p>
|
|
356
|
+
* <p>Only tasks launched after the update will reflect the update. To update the tags on all tasks, set
|
|
357
|
+
* <code>forceNewDeployment</code> to <code>true</code>, so that Amazon ECS starts new tasks with the
|
|
358
|
+
* updated tags.</p>
|
|
347
359
|
* @public
|
|
348
360
|
*/
|
|
349
361
|
propagateTags?: PropagateTags | undefined;
|
|
350
362
|
/**
|
|
351
|
-
* <p>The details for the service discovery registries to assign to this service. For more
|
|
352
|
-
*
|
|
363
|
+
* <p>The details for the service discovery registries to assign to this service. For more information, see
|
|
364
|
+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html">Service
|
|
353
365
|
* Discovery</a>.</p>
|
|
354
|
-
* <p>When you add, update, or remove the service registries configuration, Amazon ECS starts new
|
|
355
|
-
*
|
|
356
|
-
*
|
|
357
|
-
* <p>You can remove existing <code>serviceRegistries</code> by passing an empty
|
|
358
|
-
* list.</p>
|
|
366
|
+
* <p>When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks with the
|
|
367
|
+
* updated service registries configuration, and then stops the old tasks when the new tasks are
|
|
368
|
+
* running.</p>
|
|
369
|
+
* <p>You can remove existing <code>serviceRegistries</code> by passing an empty list.</p>
|
|
359
370
|
* @public
|
|
360
371
|
*/
|
|
361
372
|
serviceRegistries?: ServiceRegistry[] | undefined;
|
|
@@ -372,14 +383,18 @@ export interface UpdateServiceRequest {
|
|
|
372
383
|
*/
|
|
373
384
|
serviceConnectConfiguration?: ServiceConnectConfiguration | undefined;
|
|
374
385
|
/**
|
|
375
|
-
* <p>The details of the volume that was <code>configuredAtLaunch</code>. You can configure
|
|
376
|
-
*
|
|
377
|
-
*
|
|
378
|
-
*
|
|
379
|
-
* it triggers a new deployment.</p>
|
|
386
|
+
* <p>The details of the volume that was <code>configuredAtLaunch</code>. You can configure the size,
|
|
387
|
+
* 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 must match the
|
|
388
|
+
* <code>name</code> from the task definition. If set to null, no new deployment is triggered.
|
|
389
|
+
* Otherwise, if this configuration differs from the existing one, it triggers a new deployment.</p>
|
|
380
390
|
* @public
|
|
381
391
|
*/
|
|
382
392
|
volumeConfigurations?: ServiceVolumeConfiguration[] | undefined;
|
|
393
|
+
/**
|
|
394
|
+
* <p>An object representing the VPC Lattice configuration for the service being updated.</p>
|
|
395
|
+
* @public
|
|
396
|
+
*/
|
|
397
|
+
vpcLatticeConfigurations?: VpcLatticeConfiguration[] | undefined;
|
|
383
398
|
}
|
|
384
399
|
/**
|
|
385
400
|
* @public
|
|
@@ -396,8 +411,8 @@ export interface UpdateServiceResponse {
|
|
|
396
411
|
*/
|
|
397
412
|
export interface UpdateServicePrimaryTaskSetRequest {
|
|
398
413
|
/**
|
|
399
|
-
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task
|
|
400
|
-
*
|
|
414
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists
|
|
415
|
+
* in.</p>
|
|
401
416
|
* @public
|
|
402
417
|
*/
|
|
403
418
|
cluster: string | undefined;
|
|
@@ -428,8 +443,8 @@ export interface UpdateServicePrimaryTaskSetResponse {
|
|
|
428
443
|
*/
|
|
429
444
|
export interface UpdateTaskProtectionRequest {
|
|
430
445
|
/**
|
|
431
|
-
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task
|
|
432
|
-
*
|
|
446
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist
|
|
447
|
+
* in.</p>
|
|
433
448
|
* @public
|
|
434
449
|
*/
|
|
435
450
|
cluster: string | undefined;
|
|
@@ -439,19 +454,19 @@ export interface UpdateTaskProtectionRequest {
|
|
|
439
454
|
*/
|
|
440
455
|
tasks: string[] | undefined;
|
|
441
456
|
/**
|
|
442
|
-
* <p>Specify <code>true</code> to mark a task for protection and <code>false</code> to
|
|
443
|
-
*
|
|
457
|
+
* <p>Specify <code>true</code> to mark a task for protection and <code>false</code> to unset protection,
|
|
458
|
+
* making it eligible for termination.</p>
|
|
444
459
|
* @public
|
|
445
460
|
*/
|
|
446
461
|
protectionEnabled: boolean | undefined;
|
|
447
462
|
/**
|
|
448
|
-
* <p>If you set <code>protectionEnabled</code> to <code>true</code>, you can specify the
|
|
449
|
-
*
|
|
450
|
-
*
|
|
451
|
-
*
|
|
452
|
-
* <code>
|
|
453
|
-
* <p>If you don’t specify the time, then the task is automatically protected for 120
|
|
454
|
-
*
|
|
463
|
+
* <p>If you set <code>protectionEnabled</code> to <code>true</code>, you can specify the duration for task
|
|
464
|
+
* protection in minutes. You can specify a value from 1 minute to up to 2,880 minutes (48 hours). During
|
|
465
|
+
* this time, your task will not be terminated by scale-in events from Service Auto Scaling or
|
|
466
|
+
* deployments. After this time period lapses, <code>protectionEnabled</code> will be reset to
|
|
467
|
+
* <code>false</code>.</p>
|
|
468
|
+
* <p>If you don’t specify the time, then the task is automatically protected for 120 minutes (2
|
|
469
|
+
* hours).</p>
|
|
455
470
|
* @public
|
|
456
471
|
*/
|
|
457
472
|
expiresInMinutes?: number | undefined;
|
|
@@ -469,14 +484,13 @@ export interface UpdateTaskProtectionResponse {
|
|
|
469
484
|
* </li>
|
|
470
485
|
* <li>
|
|
471
486
|
* <p>
|
|
472
|
-
* <code>protectionEnabled</code>: The protection status of the task. If scale-in
|
|
473
|
-
*
|
|
474
|
-
*
|
|
487
|
+
* <code>protectionEnabled</code>: The protection status of the task. If scale-in protection is
|
|
488
|
+
* turned on for a task, the value is <code>true</code>. Otherwise, it is
|
|
489
|
+
* <code>false</code>.</p>
|
|
475
490
|
* </li>
|
|
476
491
|
* <li>
|
|
477
492
|
* <p>
|
|
478
|
-
* <code>expirationDate</code>: The epoch time when protection for the task will
|
|
479
|
-
* expire.</p>
|
|
493
|
+
* <code>expirationDate</code>: The epoch time when protection for the task will expire.</p>
|
|
480
494
|
* </li>
|
|
481
495
|
* </ul>
|
|
482
496
|
* @public
|
|
@@ -493,8 +507,8 @@ export interface UpdateTaskProtectionResponse {
|
|
|
493
507
|
*/
|
|
494
508
|
export interface UpdateTaskSetRequest {
|
|
495
509
|
/**
|
|
496
|
-
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task
|
|
497
|
-
*
|
|
510
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set is found
|
|
511
|
+
* in.</p>
|
|
498
512
|
* @public
|
|
499
513
|
*/
|
|
500
514
|
cluster: string | undefined;
|
|
@@ -509,8 +523,8 @@ export interface UpdateTaskSetRequest {
|
|
|
509
523
|
*/
|
|
510
524
|
taskSet: string | undefined;
|
|
511
525
|
/**
|
|
512
|
-
* <p>A floating-point percentage of the desired number of tasks to place and keep running
|
|
513
|
-
*
|
|
526
|
+
* <p>A floating-point percentage of the desired number of tasks to place and keep running in the task
|
|
527
|
+
* set.</p>
|
|
514
528
|
* @public
|
|
515
529
|
*/
|
|
516
530
|
scale: Scale | undefined;
|
|
@@ -391,6 +391,11 @@ export interface ServiceVolumeConfiguration {
|
|
|
391
391
|
name: string | undefined;
|
|
392
392
|
managedEBSVolume?: ServiceManagedEBSVolumeConfiguration | undefined;
|
|
393
393
|
}
|
|
394
|
+
export interface VpcLatticeConfiguration {
|
|
395
|
+
roleArn: string | undefined;
|
|
396
|
+
targetGroupArn: string | undefined;
|
|
397
|
+
portName: string | undefined;
|
|
398
|
+
}
|
|
394
399
|
export interface CreateServiceRequest {
|
|
395
400
|
cluster?: string | undefined;
|
|
396
401
|
serviceName: string | undefined;
|
|
@@ -416,6 +421,7 @@ export interface CreateServiceRequest {
|
|
|
416
421
|
enableExecuteCommand?: boolean | undefined;
|
|
417
422
|
serviceConnectConfiguration?: ServiceConnectConfiguration | undefined;
|
|
418
423
|
volumeConfigurations?: ServiceVolumeConfiguration[] | undefined;
|
|
424
|
+
vpcLatticeConfigurations?: VpcLatticeConfiguration[] | undefined;
|
|
419
425
|
}
|
|
420
426
|
export interface DeploymentEphemeralStorage {
|
|
421
427
|
kmsKeyId?: string | undefined;
|
|
@@ -452,6 +458,7 @@ export interface Deployment {
|
|
|
452
458
|
serviceConnectResources?: ServiceConnectServiceResource[] | undefined;
|
|
453
459
|
volumeConfigurations?: ServiceVolumeConfiguration[] | undefined;
|
|
454
460
|
fargateEphemeralStorage?: DeploymentEphemeralStorage | undefined;
|
|
461
|
+
vpcLatticeConfigurations?: VpcLatticeConfiguration[] | undefined;
|
|
455
462
|
}
|
|
456
463
|
export interface ServiceEvent {
|
|
457
464
|
id?: string | undefined;
|
|
@@ -848,6 +855,12 @@ export interface Ulimit {
|
|
|
848
855
|
softLimit: number | undefined;
|
|
849
856
|
hardLimit: number | undefined;
|
|
850
857
|
}
|
|
858
|
+
export declare const VersionConsistency: {
|
|
859
|
+
readonly DISABLED: "disabled";
|
|
860
|
+
readonly ENABLED: "enabled";
|
|
861
|
+
};
|
|
862
|
+
export type VersionConsistency =
|
|
863
|
+
(typeof VersionConsistency)[keyof typeof VersionConsistency];
|
|
851
864
|
export interface VolumeFrom {
|
|
852
865
|
sourceContainer?: string | undefined;
|
|
853
866
|
readOnly?: boolean | undefined;
|
|
@@ -874,6 +887,7 @@ export interface ContainerDefinition {
|
|
|
874
887
|
dependsOn?: ContainerDependency[] | undefined;
|
|
875
888
|
startTimeout?: number | undefined;
|
|
876
889
|
stopTimeout?: number | undefined;
|
|
890
|
+
versionConsistency?: VersionConsistency | undefined;
|
|
877
891
|
hostname?: string | undefined;
|
|
878
892
|
user?: string | undefined;
|
|
879
893
|
workingDirectory?: string | undefined;
|
|
@@ -1279,6 +1293,7 @@ export interface ServiceRevision {
|
|
|
1279
1293
|
volumeConfigurations?: ServiceVolumeConfiguration[] | undefined;
|
|
1280
1294
|
fargateEphemeralStorage?: DeploymentEphemeralStorage | undefined;
|
|
1281
1295
|
createdAt?: Date | undefined;
|
|
1296
|
+
vpcLatticeConfigurations?: VpcLatticeConfiguration[] | undefined;
|
|
1282
1297
|
}
|
|
1283
1298
|
export interface DescribeServiceRevisionsResponse {
|
|
1284
1299
|
serviceRevisions?: ServiceRevision[] | undefined;
|
|
@@ -1926,13 +1941,6 @@ export interface AutoScalingGroupProviderUpdate {
|
|
|
1926
1941
|
managedTerminationProtection?: ManagedTerminationProtection | undefined;
|
|
1927
1942
|
managedDraining?: ManagedDraining | undefined;
|
|
1928
1943
|
}
|
|
1929
|
-
export interface UpdateCapacityProviderRequest {
|
|
1930
|
-
name: string | undefined;
|
|
1931
|
-
autoScalingGroupProvider: AutoScalingGroupProviderUpdate | undefined;
|
|
1932
|
-
}
|
|
1933
|
-
export interface UpdateCapacityProviderResponse {
|
|
1934
|
-
capacityProvider?: CapacityProvider | undefined;
|
|
1935
|
-
}
|
|
1936
1944
|
export declare const SessionFilterSensitiveLog: (obj: Session) => any;
|
|
1937
1945
|
export declare const ExecuteCommandResponseFilterSensitiveLog: (
|
|
1938
1946
|
obj: ExecuteCommandResponse
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { ECSServiceException as __BaseException } from "./ECSServiceException";
|
|
3
3
|
import {
|
|
4
|
+
AutoScalingGroupProviderUpdate,
|
|
5
|
+
CapacityProvider,
|
|
4
6
|
CapacityProviderStrategyItem,
|
|
5
7
|
Cluster,
|
|
6
8
|
ClusterConfiguration,
|
|
@@ -22,7 +24,15 @@ import {
|
|
|
22
24
|
ServiceRegistry,
|
|
23
25
|
ServiceVolumeConfiguration,
|
|
24
26
|
TaskSet,
|
|
27
|
+
VpcLatticeConfiguration,
|
|
25
28
|
} from "./models_0";
|
|
29
|
+
export interface UpdateCapacityProviderRequest {
|
|
30
|
+
name: string | undefined;
|
|
31
|
+
autoScalingGroupProvider: AutoScalingGroupProviderUpdate | undefined;
|
|
32
|
+
}
|
|
33
|
+
export interface UpdateCapacityProviderResponse {
|
|
34
|
+
capacityProvider?: CapacityProvider | undefined;
|
|
35
|
+
}
|
|
26
36
|
export interface UpdateClusterRequest {
|
|
27
37
|
cluster: string | undefined;
|
|
28
38
|
settings?: ClusterSetting[] | undefined;
|
|
@@ -89,6 +99,7 @@ export interface UpdateServiceRequest {
|
|
|
89
99
|
serviceRegistries?: ServiceRegistry[] | undefined;
|
|
90
100
|
serviceConnectConfiguration?: ServiceConnectConfiguration | undefined;
|
|
91
101
|
volumeConfigurations?: ServiceVolumeConfiguration[] | undefined;
|
|
102
|
+
vpcLatticeConfigurations?: VpcLatticeConfiguration[] | undefined;
|
|
92
103
|
}
|
|
93
104
|
export interface UpdateServiceResponse {
|
|
94
105
|
service?: Service | undefined;
|