@aws-sdk/client-ecs 3.40.0 → 3.45.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/CHANGELOG.md +41 -0
- package/README.md +7 -7
- package/dist-cjs/endpoints.js +9 -0
- package/dist-cjs/models/models_0.js +29 -5
- package/dist-cjs/protocols/Aws_json1_1.js +33 -0
- package/dist-es/endpoints.js +9 -0
- package/dist-es/models/models_0.js +20 -0
- package/dist-es/protocols/Aws_json1_1.js +33 -0
- package/dist-types/ECS.d.ts +147 -152
- package/dist-types/ECSClient.d.ts +7 -7
- package/dist-types/commands/CreateCapacityProviderCommand.d.ts +5 -5
- package/dist-types/commands/CreateClusterCommand.d.ts +5 -5
- package/dist-types/commands/CreateServiceCommand.d.ts +52 -51
- package/dist-types/commands/CreateTaskSetCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAccountSettingCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAttributesCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +4 -4
- package/dist-types/commands/DeleteClusterCommand.d.ts +5 -6
- package/dist-types/commands/DeleteServiceCommand.d.ts +2 -2
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +8 -7
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +8 -9
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeClustersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeServicesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTasksCommand.d.ts +1 -1
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +2 -3
- package/dist-types/commands/ExecuteCommandCommand.d.ts +1 -1
- package/dist-types/commands/ListAccountSettingsCommand.d.ts +1 -1
- package/dist-types/commands/ListAttributesCommand.d.ts +4 -4
- package/dist-types/commands/ListClustersCommand.d.ts +1 -1
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +1 -1
- package/dist-types/commands/ListServicesCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +7 -7
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +1 -1
- package/dist-types/commands/ListTasksCommand.d.ts +1 -1
- package/dist-types/commands/PutAccountSettingCommand.d.ts +6 -6
- package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +1 -1
- package/dist-types/commands/PutAttributesCommand.d.ts +3 -3
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +7 -7
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +3 -4
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +2 -2
- package/dist-types/commands/RunTaskCommand.d.ts +6 -6
- package/dist-types/commands/StartTaskCommand.d.ts +1 -1
- package/dist-types/commands/StopTaskCommand.d.ts +1 -1
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +2 -3
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +2 -3
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +2 -3
- package/dist-types/commands/TagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +1 -1
- package/dist-types/commands/UpdateClusterCommand.d.ts +1 -1
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +4 -4
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +6 -6
- package/dist-types/commands/UpdateServiceCommand.d.ts +16 -16
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +1041 -948
- package/dist-types/ts3.4/models/models_0.d.ts +38 -0
- package/package.json +6 -6
package/dist-types/ECS.d.ts
CHANGED
|
@@ -54,28 +54,28 @@ import { UpdateTaskSetCommandInput, UpdateTaskSetCommandOutput } from "./command
|
|
|
54
54
|
import { ECSClient } from "./ECSClient";
|
|
55
55
|
/**
|
|
56
56
|
* <fullname>Amazon Elastic Container Service</fullname>
|
|
57
|
-
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service
|
|
57
|
+
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
|
|
58
58
|
* it easy to run, stop, and manage Docker containers on a cluster. You can host your
|
|
59
|
-
* cluster on a serverless infrastructure that
|
|
59
|
+
* cluster on a serverless infrastructure that's managed by Amazon ECS by launching your
|
|
60
60
|
* services or tasks on Fargate. For more control, you can host your tasks on a cluster
|
|
61
61
|
* of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage.</p>
|
|
62
62
|
* <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API
|
|
63
|
-
* calls
|
|
64
|
-
* you access to many familiar Amazon EC2 features.</p>
|
|
63
|
+
* calls. This makes it easy to get the state of your cluster from a centralized service,
|
|
64
|
+
* and gives you access to many familiar Amazon EC2 features.</p>
|
|
65
65
|
* <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on
|
|
66
|
-
* your resource needs, isolation policies, and availability requirements. Amazon ECS
|
|
67
|
-
*
|
|
68
|
-
*
|
|
66
|
+
* your resource needs, isolation policies, and availability requirements. With Amazon ECS, you
|
|
67
|
+
* don't need to operate your own cluster management and configuration management systems.
|
|
68
|
+
* You also don't need to worry about scaling your management infrastructure.</p>
|
|
69
69
|
*/
|
|
70
70
|
export declare class ECS extends ECSClient {
|
|
71
71
|
/**
|
|
72
72
|
* <p>Creates a new capacity provider. Capacity providers are associated with an Amazon ECS
|
|
73
73
|
* cluster and are used in capacity provider strategies to facilitate cluster auto
|
|
74
74
|
* scaling.</p>
|
|
75
|
-
* <p>Only capacity providers
|
|
76
|
-
* Fargate use the <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers
|
|
77
|
-
*
|
|
78
|
-
*
|
|
75
|
+
* <p>Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on
|
|
76
|
+
* Fargate use the <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers.
|
|
77
|
+
* These providers are available to all accounts in the Amazon Web Services Regions that Fargate
|
|
78
|
+
* supports.</p>
|
|
79
79
|
*/
|
|
80
80
|
createCapacityProvider(args: CreateCapacityProviderCommandInput, options?: __HttpHandlerOptions): Promise<CreateCapacityProviderCommandOutput>;
|
|
81
81
|
createCapacityProvider(args: CreateCapacityProviderCommandInput, cb: (err: any, data?: CreateCapacityProviderCommandOutput) => void): void;
|
|
@@ -86,10 +86,10 @@ export declare class ECS extends ECSClient {
|
|
|
86
86
|
* cluster with a unique name with the <code>CreateCluster</code> action.</p>
|
|
87
87
|
* <note>
|
|
88
88
|
* <p>When you call the <a>CreateCluster</a> API operation, Amazon ECS attempts to
|
|
89
|
-
* create the Amazon ECS service-linked role for your account so that
|
|
90
|
-
* other Amazon Web Services services
|
|
91
|
-
* makes the call
|
|
92
|
-
*
|
|
89
|
+
* create the Amazon ECS service-linked role for your account. This is so that it can manage
|
|
90
|
+
* required resources in other Amazon Web Services services on your behalf. However, if the IAM user
|
|
91
|
+
* that makes the call doesn't have permissions to create the service-linked role, it
|
|
92
|
+
* isn't created. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using
|
|
93
93
|
* Service-Linked Roles for Amazon ECS</a> in the
|
|
94
94
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
95
95
|
* </note>
|
|
@@ -98,26 +98,25 @@ export declare class ECS extends ECSClient {
|
|
|
98
98
|
createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void;
|
|
99
99
|
createCluster(args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void): void;
|
|
100
100
|
/**
|
|
101
|
-
* <p>Runs and maintains
|
|
102
|
-
* number of tasks running in a service drops below the <code>desiredCount</code>,
|
|
103
|
-
* runs another copy of the task in the specified cluster. To update an existing
|
|
104
|
-
* see the UpdateService action.</p>
|
|
101
|
+
* <p>Runs and maintains your desired number of tasks from a specified task definition. If
|
|
102
|
+
* the number of tasks running in a service drops below the <code>desiredCount</code>,
|
|
103
|
+
* Amazon ECS runs another copy of the task in the specified cluster. To update an existing
|
|
104
|
+
* service, see the UpdateService action.</p>
|
|
105
105
|
* <p>In addition to maintaining the desired count of tasks in your service, you can
|
|
106
106
|
* optionally run your service behind one or more load balancers. The load balancers
|
|
107
107
|
* distribute traffic across the tasks that are associated with the service. For more
|
|
108
108
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service Load Balancing</a> in the
|
|
109
109
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
110
|
-
* <p>Tasks for services that
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
* reported as healthy by the load balancer.</p>
|
|
110
|
+
* <p>Tasks for services that don't use a load balancer are considered healthy if they're in
|
|
111
|
+
* the <code>RUNNING</code> state. Tasks for services that use a load balancer are
|
|
112
|
+
* considered healthy if they're in the <code>RUNNING</code> state and the container
|
|
113
|
+
* instance that they're hosted on is reported as healthy by the load balancer.</p>
|
|
115
114
|
* <p>There are two service scheduler strategies available:</p>
|
|
116
115
|
* <ul>
|
|
117
116
|
* <li>
|
|
118
117
|
* <p>
|
|
119
118
|
* <code>REPLICA</code> - The replica scheduling strategy places and
|
|
120
|
-
* maintains
|
|
119
|
+
* maintains your desired number of tasks across your cluster. By default, the
|
|
121
120
|
* service scheduler spreads tasks across Availability Zones. You can use task
|
|
122
121
|
* placement strategies and constraints to customize task placement decisions. For
|
|
123
122
|
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service Scheduler Concepts</a> in the
|
|
@@ -128,50 +127,51 @@ export declare class ECS extends ECSClient {
|
|
|
128
127
|
* <code>DAEMON</code> - The daemon scheduling strategy deploys exactly one
|
|
129
128
|
* task on each active container instance that meets all of the task placement
|
|
130
129
|
* constraints that you specify in your cluster. The service scheduler also
|
|
131
|
-
* evaluates the task placement constraints for running tasks
|
|
132
|
-
* that
|
|
130
|
+
* evaluates the task placement constraints for running tasks. It also stops tasks
|
|
131
|
+
* that don't meet the placement constraints. When using this strategy, you don't
|
|
133
132
|
* need to specify a desired number of tasks, a task placement strategy, or use
|
|
134
133
|
* Service Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service Scheduler Concepts</a> in the
|
|
135
134
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
136
135
|
* </li>
|
|
137
136
|
* </ul>
|
|
138
137
|
* <p>You can optionally specify a deployment configuration for your service. The deployment
|
|
139
|
-
* is
|
|
140
|
-
* a service
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
* <p>If a service
|
|
138
|
+
* is initiated by changing properties. For example, the deployment might be initiated by
|
|
139
|
+
* the task definition or by your desired count of a service. This is done with an <a>UpdateService</a> operation. The default value for a replica service for
|
|
140
|
+
* <code>minimumHealthyPercent</code> is 100%. The default value for a daemon service
|
|
141
|
+
* for <code>minimumHealthyPercent</code> is 0%.</p>
|
|
142
|
+
* <p>If a service uses the <code>ECS</code> deployment controller, the minimum healthy
|
|
144
143
|
* percent represents a lower limit on the number of tasks in a service that must remain in
|
|
145
|
-
* the <code>RUNNING</code> state during a deployment,
|
|
146
|
-
* number of tasks (rounded up to the nearest integer)
|
|
147
|
-
* are in the <code>DRAINING</code> state if
|
|
148
|
-
*
|
|
149
|
-
* additional cluster capacity. For example, if
|
|
150
|
-
*
|
|
151
|
-
*
|
|
152
|
-
*
|
|
153
|
-
*
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
* percent is 100%.</p>
|
|
157
|
-
* <p>If a service
|
|
144
|
+
* the <code>RUNNING</code> state during a deployment. Specifically, it represents it as a
|
|
145
|
+
* percentage of your desired number of tasks (rounded up to the nearest integer). This
|
|
146
|
+
* happens when any of your container instances are in the <code>DRAINING</code> state if
|
|
147
|
+
* the service contains tasks using the EC2 launch type. Using this
|
|
148
|
+
* parameter, you can deploy without using additional cluster capacity. For example, if you
|
|
149
|
+
* set your service to have desired number of four tasks and a minimum healthy percent of
|
|
150
|
+
* 50%, the scheduler might stop two existing tasks to free up cluster capacity before
|
|
151
|
+
* starting two new tasks. If they're in the <code>RUNNING</code> state, tasks for services
|
|
152
|
+
* that don't use a load balancer are considered healthy . If they're in the
|
|
153
|
+
* <code>RUNNING</code> state and reported as healthy by the load balancer, tasks for
|
|
154
|
+
* services that <i>do</i> use a load balancer are considered healthy . The
|
|
155
|
+
* default value for minimum healthy percent is 100%.</p>
|
|
156
|
+
* <p>If a service uses the <code>ECS</code> deployment controller, the <b>maximum percent</b> parameter represents an upper limit on the
|
|
158
157
|
* number of tasks in a service that are allowed in the <code>RUNNING</code> or
|
|
159
|
-
* <code>PENDING</code> state during a deployment,
|
|
160
|
-
* number of tasks (rounded down to the nearest integer)
|
|
161
|
-
* are in the <code>DRAINING</code> state if
|
|
162
|
-
*
|
|
163
|
-
* size. For example, if your service has a
|
|
164
|
-
*
|
|
165
|
-
*
|
|
166
|
-
* default value for maximum percent is
|
|
167
|
-
*
|
|
158
|
+
* <code>PENDING</code> state during a deployment. Specifically, it represents it as a
|
|
159
|
+
* percentage of the desired number of tasks (rounded down to the nearest integer). This
|
|
160
|
+
* happens when any of your container instances are in the <code>DRAINING</code> state if
|
|
161
|
+
* the service contains tasks using the EC2 launch type. Using this
|
|
162
|
+
* parameter, you can define the deployment batch size. For example, if your service has a
|
|
163
|
+
* desired number of four tasks and a maximum percent value of 200%, the scheduler may
|
|
164
|
+
* start four new tasks before stopping the four older tasks (provided that the cluster
|
|
165
|
+
* resources required to do this are available). The default value for maximum percent is
|
|
166
|
+
* 200%.</p>
|
|
167
|
+
* <p>If a service uses either the <code>CODE_DEPLOY</code> or <code>EXTERNAL</code>
|
|
168
168
|
* deployment controller types and tasks that use the EC2 launch type, the
|
|
169
169
|
* <b>minimum healthy percent</b> and <b>maximum percent</b> values are used only to define the lower and upper limit
|
|
170
|
-
* on the number of the tasks in the service that remain in the <code>RUNNING</code> state
|
|
171
|
-
* while the container instances are in the <code>DRAINING</code> state. If the
|
|
172
|
-
* the service use the Fargate launch type, the minimum healthy
|
|
173
|
-
* maximum percent values aren't used
|
|
174
|
-
* your service.</p>
|
|
170
|
+
* on the number of the tasks in the service that remain in the <code>RUNNING</code> state.
|
|
171
|
+
* This is while the container instances are in the <code>DRAINING</code> state. If the
|
|
172
|
+
* tasks in the service use the Fargate launch type, the minimum healthy
|
|
173
|
+
* percent and maximum percent values aren't used. This is the case even if they're
|
|
174
|
+
* currently visible when describing your service.</p>
|
|
175
175
|
* <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you
|
|
176
176
|
* can specify only parameters that aren't controlled at the task set level. The only
|
|
177
177
|
* required parameter is the service name. You control your services using the <a>CreateTaskSet</a> operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS Deployment Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
@@ -179,14 +179,15 @@ export declare class ECS extends ECSClient {
|
|
|
179
179
|
* cluster using the following logic:</p>
|
|
180
180
|
* <ul>
|
|
181
181
|
* <li>
|
|
182
|
-
* <p>Determine which of the container instances in your cluster can support
|
|
183
|
-
*
|
|
184
|
-
* ports, and container instance attributes
|
|
182
|
+
* <p>Determine which of the container instances in your cluster can support the
|
|
183
|
+
* task definition of your service. For example, they have the required CPU,
|
|
184
|
+
* memory, ports, and container instance attributes.</p>
|
|
185
185
|
* </li>
|
|
186
186
|
* <li>
|
|
187
187
|
* <p>By default, the service scheduler attempts to balance tasks across
|
|
188
|
-
* Availability Zones in this manner
|
|
189
|
-
* strategy
|
|
188
|
+
* Availability Zones in this manner. This is the case even if you can choose a
|
|
189
|
+
* different placement strategy with the <code>placementStrategy</code>
|
|
190
|
+
* parameter.</p>
|
|
190
191
|
* <ul>
|
|
191
192
|
* <li>
|
|
192
193
|
* <p>Sort the valid container instances, giving priority to instances that
|
|
@@ -197,7 +198,7 @@ export declare class ECS extends ECSClient {
|
|
|
197
198
|
* </li>
|
|
198
199
|
* <li>
|
|
199
200
|
* <p>Place the new service task on a valid container instance in an optimal
|
|
200
|
-
* Availability Zone
|
|
201
|
+
* Availability Zone based on the previous steps, favoring container
|
|
201
202
|
* instances with the fewest number of running tasks for this
|
|
202
203
|
* service.</p>
|
|
203
204
|
* </li>
|
|
@@ -234,8 +235,8 @@ export declare class ECS extends ECSClient {
|
|
|
234
235
|
* <p>Deletes the specified capacity provider.</p>
|
|
235
236
|
* <note>
|
|
236
237
|
* <p>The <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers are
|
|
237
|
-
* reserved and
|
|
238
|
-
*
|
|
238
|
+
* reserved and can't be deleted. You can disassociate them from a cluster using either
|
|
239
|
+
* the <a>PutClusterCapacityProviders</a> API or by deleting the
|
|
239
240
|
* cluster.</p>
|
|
240
241
|
* </note>
|
|
241
242
|
* <p>Prior to a capacity provider being deleted, the capacity provider must be removed from
|
|
@@ -244,18 +245,17 @@ export declare class ECS extends ECSClient {
|
|
|
244
245
|
* strategy. When updating a service, the <code>forceNewDeployment</code> option can be
|
|
245
246
|
* used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity
|
|
246
247
|
* provider are transitioned to use the capacity from the remaining capacity providers.
|
|
247
|
-
* Only capacity providers that
|
|
248
|
+
* Only capacity providers that aren't associated with a cluster can be deleted. To remove
|
|
248
249
|
* a capacity provider from a cluster, you can either use <a>PutClusterCapacityProviders</a> or delete the cluster.</p>
|
|
249
250
|
*/
|
|
250
251
|
deleteCapacityProvider(args: DeleteCapacityProviderCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCapacityProviderCommandOutput>;
|
|
251
252
|
deleteCapacityProvider(args: DeleteCapacityProviderCommandInput, cb: (err: any, data?: DeleteCapacityProviderCommandOutput) => void): void;
|
|
252
253
|
deleteCapacityProvider(args: DeleteCapacityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCapacityProviderCommandOutput) => void): void;
|
|
253
254
|
/**
|
|
254
|
-
* <p>Deletes the specified cluster. The cluster
|
|
255
|
-
*
|
|
256
|
-
*
|
|
257
|
-
*
|
|
258
|
-
* clusters persisting.</p>
|
|
255
|
+
* <p>Deletes the specified cluster. The cluster transitions to the <code>INACTIVE</code>
|
|
256
|
+
* state. Clusters with an <code>INACTIVE</code> status might remain discoverable in your
|
|
257
|
+
* account for a period of time. However, this behavior is subject to change in the future.
|
|
258
|
+
* We don't recommend that you rely on <code>INACTIVE</code> clusters persisting.</p>
|
|
259
259
|
* <p>You must deregister all container instances from this cluster before you may delete
|
|
260
260
|
* it. You can list the container instances in a cluster with <a>ListContainerInstances</a> and deregister them with <a>DeregisterContainerInstance</a>.</p>
|
|
261
261
|
*/
|
|
@@ -265,7 +265,7 @@ export declare class ECS extends ECSClient {
|
|
|
265
265
|
/**
|
|
266
266
|
* <p>Deletes a specified service within a cluster. You can delete a service if you have no
|
|
267
267
|
* running tasks in it and the desired task count is zero. If the service is actively
|
|
268
|
-
* maintaining tasks, you
|
|
268
|
+
* maintaining tasks, you can't delete it, and you must update the service to a desired
|
|
269
269
|
* task count of zero. For more information, see <a>UpdateService</a>.</p>
|
|
270
270
|
* <note>
|
|
271
271
|
* <p>When you delete a service, if there are still running tasks that require cleanup,
|
|
@@ -299,15 +299,16 @@ export declare class ECS extends ECSClient {
|
|
|
299
299
|
* <p>Deregisters an Amazon ECS container instance from the specified cluster. This instance is
|
|
300
300
|
* no longer available to run tasks.</p>
|
|
301
301
|
* <p>If you intend to use the container instance for some other purpose after
|
|
302
|
-
* deregistration, you
|
|
303
|
-
* before deregistration. That prevents any orphaned tasks from consuming
|
|
304
|
-
*
|
|
305
|
-
*
|
|
306
|
-
* terminate
|
|
302
|
+
* deregistration, we recommend that you stop all of the tasks running on the container
|
|
303
|
+
* instance before deregistration. That prevents any orphaned tasks from consuming
|
|
304
|
+
* resources.</p>
|
|
305
|
+
* <p>Deregistering a container instance removes the instance from a cluster, but it doesn't
|
|
306
|
+
* terminate the EC2 instance. If you are finished using the instance, be sure to terminate
|
|
307
|
+
* it in the Amazon EC2 console to stop billing.</p>
|
|
307
308
|
* <note>
|
|
308
309
|
* <p>If you terminate a running container instance, Amazon ECS automatically deregisters the
|
|
309
310
|
* instance from your cluster (stopped container instances or instances with
|
|
310
|
-
* disconnected agents
|
|
311
|
+
* disconnected agents aren't automatically deregistered when terminated).</p>
|
|
311
312
|
* </note>
|
|
312
313
|
*/
|
|
313
314
|
deregisterContainerInstance(args: DeregisterContainerInstanceCommandInput, options?: __HttpHandlerOptions): Promise<DeregisterContainerInstanceCommandOutput>;
|
|
@@ -319,16 +320,15 @@ export declare class ECS extends ECSClient {
|
|
|
319
320
|
* reference an <code>INACTIVE</code> task definition continue to run without disruption.
|
|
320
321
|
* Existing services that reference an <code>INACTIVE</code> task definition can still
|
|
321
322
|
* scale up or down by modifying the service's desired count.</p>
|
|
322
|
-
* <p>You
|
|
323
|
-
* services, and you
|
|
324
|
-
*
|
|
325
|
-
*
|
|
326
|
-
* effect.</p>
|
|
323
|
+
* <p>You can't use an <code>INACTIVE</code> task definition to run new tasks or create new
|
|
324
|
+
* services, and you can't update an existing service to reference an <code>INACTIVE</code>
|
|
325
|
+
* task definition. However, there may be up to a 10-minute window following deregistration
|
|
326
|
+
* where these restrictions have not yet taken effect.</p>
|
|
327
327
|
* <note>
|
|
328
328
|
* <p>At this time, <code>INACTIVE</code> task definitions remain discoverable in your
|
|
329
|
-
* account indefinitely. However, this behavior is subject to change in the future
|
|
330
|
-
*
|
|
331
|
-
* lifecycle of any associated tasks and services.</p>
|
|
329
|
+
* account indefinitely. However, this behavior is subject to change in the future. We
|
|
330
|
+
* don't recommend that you rely on <code>INACTIVE</code> task definitions persisting
|
|
331
|
+
* beyond the lifecycle of any associated tasks and services.</p>
|
|
332
332
|
* </note>
|
|
333
333
|
*/
|
|
334
334
|
deregisterTaskDefinition(args: DeregisterTaskDefinitionCommandInput, options?: __HttpHandlerOptions): Promise<DeregisterTaskDefinitionCommandOutput>;
|
|
@@ -391,8 +391,7 @@ export declare class ECS extends ECSClient {
|
|
|
391
391
|
* <note>
|
|
392
392
|
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
|
|
393
393
|
* </note>
|
|
394
|
-
*
|
|
395
|
-
* the Amazon ECS agent to poll for updates.</p>
|
|
394
|
+
* <p>Returns an endpoint for the Amazon ECS agent to poll for updates.</p>
|
|
396
395
|
*/
|
|
397
396
|
discoverPollEndpoint(args: DiscoverPollEndpointCommandInput, options?: __HttpHandlerOptions): Promise<DiscoverPollEndpointCommandOutput>;
|
|
398
397
|
discoverPollEndpoint(args: DiscoverPollEndpointCommandInput, cb: (err: any, data?: DiscoverPollEndpointCommandOutput) => void): void;
|
|
@@ -414,9 +413,9 @@ export declare class ECS extends ECSClient {
|
|
|
414
413
|
* When you specify a target type and cluster, <code>ListAttributes</code> returns a list
|
|
415
414
|
* of attribute objects, one for each attribute on each resource. You can filter the list
|
|
416
415
|
* of results to a single attribute name to only return results that have that name. You
|
|
417
|
-
* can also filter the results by attribute name and value, for example,
|
|
418
|
-
* container instances in a cluster are running a Linux AMI
|
|
419
|
-
*
|
|
416
|
+
* can also filter the results by attribute name and value. You can do this, for example,
|
|
417
|
+
* to see which container instances in a cluster are running a Linux AMI
|
|
418
|
+
* (<code>ecs.os-type=linux</code>). </p>
|
|
420
419
|
*/
|
|
421
420
|
listAttributes(args: ListAttributesCommandInput, options?: __HttpHandlerOptions): Promise<ListAttributesCommandOutput>;
|
|
422
421
|
listAttributes(args: ListAttributesCommandInput, cb: (err: any, data?: ListAttributesCommandOutput) => void): void;
|
|
@@ -450,12 +449,12 @@ export declare class ECS extends ECSClient {
|
|
|
450
449
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
451
450
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
452
451
|
/**
|
|
453
|
-
* <p>Returns a list of task definition families that are registered to your account
|
|
454
|
-
*
|
|
455
|
-
* definition revisions
|
|
456
|
-
* <p>You can filter out task definition families that
|
|
457
|
-
*
|
|
458
|
-
*
|
|
452
|
+
* <p>Returns a list of task definition families that are registered to your account. This
|
|
453
|
+
* list includes task definition families that no longer have any <code>ACTIVE</code> task
|
|
454
|
+
* definition revisions.</p>
|
|
455
|
+
* <p>You can filter out task definition families that don't contain any <code>ACTIVE</code>
|
|
456
|
+
* task definition revisions by setting the <code>status</code> parameter to
|
|
457
|
+
* <code>ACTIVE</code>. You can also filter the results with the
|
|
459
458
|
* <code>familyPrefix</code> parameter.</p>
|
|
460
459
|
*/
|
|
461
460
|
listTaskDefinitionFamilies(args: ListTaskDefinitionFamiliesCommandInput, options?: __HttpHandlerOptions): Promise<ListTaskDefinitionFamiliesCommandOutput>;
|
|
@@ -482,16 +481,16 @@ export declare class ECS extends ECSClient {
|
|
|
482
481
|
/**
|
|
483
482
|
* <p>Modifies an account setting. Account settings are set on a per-Region basis.</p>
|
|
484
483
|
* <p>If you change the account setting for the root user, the default settings for all of
|
|
485
|
-
* the IAM users and roles
|
|
486
|
-
*
|
|
484
|
+
* the IAM users and roles that no individual account setting was specified are reset for.
|
|
485
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html">Account
|
|
487
486
|
* Settings</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
488
487
|
* <p>When <code>serviceLongArnFormat</code>, <code>taskLongArnFormat</code>, or
|
|
489
488
|
* <code>containerInstanceLongArnFormat</code> are specified, the Amazon Resource Name
|
|
490
489
|
* (ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or
|
|
491
490
|
* the root user for an account is affected. The opt-in and opt-out account setting must be
|
|
492
|
-
* set for each Amazon ECS resource separately. The ARN and resource ID format of a resource
|
|
493
|
-
*
|
|
494
|
-
*
|
|
491
|
+
* set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is
|
|
492
|
+
* defined by the opt-in status of the IAM user or role that created the resource. You must
|
|
493
|
+
* enable this setting to use Amazon ECS features such as resource tagging.</p>
|
|
495
494
|
* <p>When <code>awsvpcTrunking</code> is specified, the elastic network interface (ENI)
|
|
496
495
|
* limit for any new container instances that support the feature is changed. If
|
|
497
496
|
* <code>awsvpcTrunking</code> is enabled, any new container instances that support the
|
|
@@ -517,8 +516,8 @@ export declare class ECS extends ECSClient {
|
|
|
517
516
|
putAccountSettingDefault(args: PutAccountSettingDefaultCommandInput, cb: (err: any, data?: PutAccountSettingDefaultCommandOutput) => void): void;
|
|
518
517
|
putAccountSettingDefault(args: PutAccountSettingDefaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountSettingDefaultCommandOutput) => void): void;
|
|
519
518
|
/**
|
|
520
|
-
* <p>Create or update an attribute on an Amazon ECS resource. If the attribute
|
|
521
|
-
* it
|
|
519
|
+
* <p>Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist,
|
|
520
|
+
* it's created. If the attribute exists, its value is replaced with the specified value.
|
|
522
521
|
* To delete an attribute, use <a>DeleteAttributes</a>. For more information,
|
|
523
522
|
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes">Attributes</a> in the
|
|
524
523
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
@@ -532,14 +531,14 @@ export declare class ECS extends ECSClient {
|
|
|
532
531
|
* <p>You must specify both the available capacity providers and a default capacity provider
|
|
533
532
|
* strategy for the cluster. If the specified cluster has existing capacity providers
|
|
534
533
|
* associated with it, you must specify all existing capacity providers in addition to any
|
|
535
|
-
* new ones you want to add. Any existing capacity providers associated with a
|
|
536
|
-
* are omitted from a <a>PutClusterCapacityProviders</a> API call
|
|
537
|
-
* disassociated with the cluster. You can only disassociate an existing capacity
|
|
538
|
-
* from a cluster if it's not being used by any existing tasks.</p>
|
|
534
|
+
* new ones you want to add. Any existing capacity providers that are associated with a
|
|
535
|
+
* cluster that are omitted from a <a>PutClusterCapacityProviders</a> API call
|
|
536
|
+
* will be disassociated with the cluster. You can only disassociate an existing capacity
|
|
537
|
+
* provider from a cluster if it's not being used by any existing tasks.</p>
|
|
539
538
|
* <p>When creating a service or running a task on a cluster, if no capacity provider or
|
|
540
539
|
* launch type is specified, then the cluster's default capacity provider strategy is used.
|
|
541
|
-
*
|
|
542
|
-
*
|
|
540
|
+
* We recommend that you define a default capacity provider strategy for your cluster.
|
|
541
|
+
* However, you must specify an empty array (<code>[]</code>) to bypass defining a default
|
|
543
542
|
* strategy.</p>
|
|
544
543
|
*/
|
|
545
544
|
putClusterCapacityProviders(args: PutClusterCapacityProvidersCommandInput, options?: __HttpHandlerOptions): Promise<PutClusterCapacityProvidersCommandOutput>;
|
|
@@ -549,9 +548,8 @@ export declare class ECS extends ECSClient {
|
|
|
549
548
|
* <note>
|
|
550
549
|
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
|
|
551
550
|
* </note>
|
|
552
|
-
*
|
|
553
|
-
*
|
|
554
|
-
* on.</p>
|
|
551
|
+
* <p>Registers an EC2 instance into the specified cluster. This instance becomes available
|
|
552
|
+
* to place containers on.</p>
|
|
555
553
|
*/
|
|
556
554
|
registerContainerInstance(args: RegisterContainerInstanceCommandInput, options?: __HttpHandlerOptions): Promise<RegisterContainerInstanceCommandOutput>;
|
|
557
555
|
registerContainerInstance(args: RegisterContainerInstanceCommandInput, cb: (err: any, data?: RegisterContainerInstanceCommandOutput) => void): void;
|
|
@@ -565,7 +563,7 @@ export declare class ECS extends ECSClient {
|
|
|
565
563
|
* <p>You can specify an IAM role for your task with the <code>taskRoleArn</code> parameter.
|
|
566
564
|
* When you specify an IAM role for a task, its containers can then use the latest versions
|
|
567
565
|
* of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in
|
|
568
|
-
* the IAM policy associated with the role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM
|
|
566
|
+
* the IAM policy that's associated with the role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM
|
|
569
567
|
* Roles for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
570
568
|
* <p>You can specify a Docker networking mode for the containers in your task definition
|
|
571
569
|
* with the <code>networkMode</code> parameter. The available network modes correspond to
|
|
@@ -587,11 +585,11 @@ export declare class ECS extends ECSClient {
|
|
|
587
585
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
588
586
|
* <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or
|
|
589
587
|
* place tasks manually on specific container instances.</p>
|
|
590
|
-
* <p>The Amazon ECS API follows an eventual consistency model
|
|
591
|
-
* the system supporting the API. This means that the result of an API command
|
|
592
|
-
* affects your Amazon ECS resources might not be immediately visible to all
|
|
593
|
-
* you run. Keep this in mind when you carry out an API command that
|
|
594
|
-
* previous API command.</p>
|
|
588
|
+
* <p>The Amazon ECS API follows an eventual consistency model. This is because the distributed
|
|
589
|
+
* nature of the system supporting the API. This means that the result of an API command
|
|
590
|
+
* you run that affects your Amazon ECS resources might not be immediately visible to all
|
|
591
|
+
* subsequent commands you run. Keep this in mind when you carry out an API command that
|
|
592
|
+
* immediately follows a previous API command.</p>
|
|
595
593
|
* <p>To manage eventual consistency, you can do the following:</p>
|
|
596
594
|
* <ul>
|
|
597
595
|
* <li>
|
|
@@ -645,8 +643,7 @@ export declare class ECS extends ECSClient {
|
|
|
645
643
|
* <note>
|
|
646
644
|
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
|
|
647
645
|
* </note>
|
|
648
|
-
*
|
|
649
|
-
* acknowledge that an attachment changed states.</p>
|
|
646
|
+
* <p>Sent to acknowledge that an attachment changed states.</p>
|
|
650
647
|
*/
|
|
651
648
|
submitAttachmentStateChanges(args: SubmitAttachmentStateChangesCommandInput, options?: __HttpHandlerOptions): Promise<SubmitAttachmentStateChangesCommandOutput>;
|
|
652
649
|
submitAttachmentStateChanges(args: SubmitAttachmentStateChangesCommandInput, cb: (err: any, data?: SubmitAttachmentStateChangesCommandOutput) => void): void;
|
|
@@ -655,8 +652,7 @@ export declare class ECS extends ECSClient {
|
|
|
655
652
|
* <note>
|
|
656
653
|
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
|
|
657
654
|
* </note>
|
|
658
|
-
*
|
|
659
|
-
* acknowledge that a container changed states.</p>
|
|
655
|
+
* <p>Sent to acknowledge that a container changed states.</p>
|
|
660
656
|
*/
|
|
661
657
|
submitContainerStateChange(args: SubmitContainerStateChangeCommandInput, options?: __HttpHandlerOptions): Promise<SubmitContainerStateChangeCommandOutput>;
|
|
662
658
|
submitContainerStateChange(args: SubmitContainerStateChangeCommandInput, cb: (err: any, data?: SubmitContainerStateChangeCommandOutput) => void): void;
|
|
@@ -665,16 +661,15 @@ export declare class ECS extends ECSClient {
|
|
|
665
661
|
* <note>
|
|
666
662
|
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
|
|
667
663
|
* </note>
|
|
668
|
-
*
|
|
669
|
-
* that a task changed states.</p>
|
|
664
|
+
* <p>Sent to acknowledge that a task changed states.</p>
|
|
670
665
|
*/
|
|
671
666
|
submitTaskStateChange(args: SubmitTaskStateChangeCommandInput, options?: __HttpHandlerOptions): Promise<SubmitTaskStateChangeCommandOutput>;
|
|
672
667
|
submitTaskStateChange(args: SubmitTaskStateChangeCommandInput, cb: (err: any, data?: SubmitTaskStateChangeCommandOutput) => void): void;
|
|
673
668
|
submitTaskStateChange(args: SubmitTaskStateChangeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubmitTaskStateChangeCommandOutput) => void): void;
|
|
674
669
|
/**
|
|
675
670
|
* <p>Associates the specified tags to a resource with the specified
|
|
676
|
-
* <code>resourceArn</code>. If existing tags on a resource
|
|
677
|
-
* request parameters, they
|
|
671
|
+
* <code>resourceArn</code>. If existing tags on a resource aren't specified in the
|
|
672
|
+
* request parameters, they aren't changed. When a resource is deleted, the tags that are
|
|
678
673
|
* associated with that resource are deleted as well.</p>
|
|
679
674
|
*/
|
|
680
675
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
@@ -706,14 +701,14 @@ export declare class ECS extends ECSClient {
|
|
|
706
701
|
updateClusterSettings(args: UpdateClusterSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClusterSettingsCommandOutput) => void): void;
|
|
707
702
|
/**
|
|
708
703
|
* <p>Updates the Amazon ECS container agent on a specified container instance. Updating the
|
|
709
|
-
* Amazon ECS container agent
|
|
704
|
+
* Amazon ECS container agent doesn't interrupt running tasks or services on the container
|
|
710
705
|
* instance. The process for updating the agent differs depending on whether your container
|
|
711
706
|
* instance was launched with the Amazon ECS-optimized AMI or another operating system.</p>
|
|
712
707
|
* <note>
|
|
713
708
|
* <p>The <code>UpdateContainerAgent</code> API isn't supported for container instances
|
|
714
709
|
* using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent,
|
|
715
|
-
* you can update the <code>ecs-init</code> package
|
|
716
|
-
*
|
|
710
|
+
* you can update the <code>ecs-init</code> package. This updates the agent. For more
|
|
711
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html">Updating the
|
|
717
712
|
* Amazon ECS container agent</a> in the
|
|
718
713
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
719
714
|
* </note>
|
|
@@ -732,7 +727,7 @@ export declare class ECS extends ECSClient {
|
|
|
732
727
|
* from a cluster, for example to perform system updates, update the Docker daemon, or
|
|
733
728
|
* scale down the cluster size.</p>
|
|
734
729
|
* <important>
|
|
735
|
-
* <p>A container instance
|
|
730
|
+
* <p>A container instance can't be changed to <code>DRAINING</code> until it has
|
|
736
731
|
* reached an <code>ACTIVE</code> status. If the instance is in any other status, an
|
|
737
732
|
* error will be received.</p>
|
|
738
733
|
* </important>
|
|
@@ -753,14 +748,14 @@ export declare class ECS extends ECSClient {
|
|
|
753
748
|
* scheduler to stop two existing tasks before starting two new tasks. If the
|
|
754
749
|
* minimum is 100%, the service scheduler can't remove existing tasks until the
|
|
755
750
|
* replacement tasks are considered healthy. Tasks for services that do not use a
|
|
756
|
-
* load balancer are considered healthy if they
|
|
751
|
+
* load balancer are considered healthy if they're in the <code>RUNNING</code>
|
|
757
752
|
* state. Tasks for services that use a load balancer are considered healthy if
|
|
758
|
-
* they
|
|
753
|
+
* they're in the <code>RUNNING</code> state and the container instance they're
|
|
759
754
|
* hosted on is reported as healthy by the load balancer.</p>
|
|
760
755
|
* </li>
|
|
761
756
|
* <li>
|
|
762
757
|
* <p>The <code>maximumPercent</code> parameter represents an upper limit on the
|
|
763
|
-
* number of running tasks during task replacement
|
|
758
|
+
* number of running tasks during task replacement. You can use this to define the
|
|
764
759
|
* replacement batch size. For example, if <code>desiredCount</code> is four tasks,
|
|
765
760
|
* a maximum of 200% starts four new tasks before stopping the four tasks to be
|
|
766
761
|
* drained, provided that the cluster resources required to do this are available.
|
|
@@ -769,7 +764,7 @@ export declare class ECS extends ECSClient {
|
|
|
769
764
|
* </li>
|
|
770
765
|
* </ul>
|
|
771
766
|
* <p>Any <code>PENDING</code> or <code>RUNNING</code> tasks that do not belong to a service
|
|
772
|
-
*
|
|
767
|
+
* aren't affected. You must wait for them to finish or stop them manually.</p>
|
|
773
768
|
* <p>A container instance has completed draining when it has no more <code>RUNNING</code>
|
|
774
769
|
* tasks. You can verify this using <a>ListTasks</a>.</p>
|
|
775
770
|
* <p>When a container instance has been drained, you can set a container instance to
|
|
@@ -794,12 +789,12 @@ export declare class ECS extends ECSClient {
|
|
|
794
789
|
* only the desired count, deployment configuration, task placement constraints and
|
|
795
790
|
* strategies, and health check grace period can be updated using this API. If the network
|
|
796
791
|
* configuration, platform version, or task definition need to be updated, a new CodeDeploy
|
|
797
|
-
* deployment
|
|
792
|
+
* deployment is created. For more information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html">CreateDeployment</a> in the <i>CodeDeploy API Reference</i>.</p>
|
|
798
793
|
* <p>For services using an external deployment controller, you can update only the desired
|
|
799
794
|
* count, task placement constraints and strategies, and health check grace period using
|
|
800
795
|
* this API. If the launch type, load balancer, network configuration, platform version, or
|
|
801
|
-
* task definition need to be updated,
|
|
802
|
-
*
|
|
796
|
+
* task definition need to be updated, create a new task set. For more information, see
|
|
797
|
+
* <a>CreateTaskSet</a>.</p>
|
|
803
798
|
* <p>You can add to or subtract from the number of instantiations of a task definition in a
|
|
804
799
|
* service by specifying the cluster that the service is running in and a new
|
|
805
800
|
* <code>desiredCount</code> parameter.</p>
|
|
@@ -809,7 +804,7 @@ export declare class ECS extends ECSClient {
|
|
|
809
804
|
* configuration) to determine the deployment strategy.</p>
|
|
810
805
|
* <note>
|
|
811
806
|
* <p>If your updated Docker image uses the same tag as what is in the existing task
|
|
812
|
-
* definition for your service (for example, <code>my_image:latest</code>), you
|
|
807
|
+
* definition for your service (for example, <code>my_image:latest</code>), you don't
|
|
813
808
|
* need to create a new revision of your task definition. You can update the service
|
|
814
809
|
* using the <code>forceNewDeployment</code> option. The new tasks launched by the
|
|
815
810
|
* deployment pull the current image/tag combination from your repository when they
|
|
@@ -825,15 +820,15 @@ export declare class ECS extends ECSClient {
|
|
|
825
820
|
* <code>desiredCount</code> temporarily during a deployment. For example, if
|
|
826
821
|
* <code>desiredCount</code> is four tasks, a minimum of 50% allows the
|
|
827
822
|
* scheduler to stop two existing tasks before starting two new tasks. Tasks for
|
|
828
|
-
* services that
|
|
829
|
-
*
|
|
830
|
-
* considered healthy if they
|
|
831
|
-
* container instance they
|
|
823
|
+
* services that don't use a load balancer are considered healthy if they're in the
|
|
824
|
+
* <code>RUNNING</code> state. Tasks for services that use a load balancer are
|
|
825
|
+
* considered healthy if they're in the <code>RUNNING</code> state and the
|
|
826
|
+
* container instance they're hosted on is reported as healthy by the load
|
|
832
827
|
* balancer.</p>
|
|
833
828
|
* </li>
|
|
834
829
|
* <li>
|
|
835
830
|
* <p>The <code>maximumPercent</code> parameter represents an upper limit on the
|
|
836
|
-
* number of running tasks during a deployment
|
|
831
|
+
* number of running tasks during a deployment. You can use it to define the
|
|
837
832
|
* deployment batch size. For example, if <code>desiredCount</code> is four tasks,
|
|
838
833
|
* a maximum of 200% starts four new tasks before stopping the four older tasks
|
|
839
834
|
* (provided that the cluster resources required to do this are available).</p>
|
|
@@ -841,22 +836,22 @@ export declare class ECS extends ECSClient {
|
|
|
841
836
|
* </ul>
|
|
842
837
|
* <p>When <a>UpdateService</a> stops a task during a deployment, the equivalent
|
|
843
838
|
* of <code>docker stop</code> is issued to the containers running in the task. This
|
|
844
|
-
* results in a <code>SIGTERM</code> and a 30-second timeout
|
|
839
|
+
* results in a <code>SIGTERM</code> and a 30-second timeout. After this,
|
|
845
840
|
* <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the
|
|
846
841
|
* container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from
|
|
847
842
|
* receiving it, no <code>SIGKILL</code> is sent.</p>
|
|
848
843
|
* <p>When the service scheduler launches new tasks, it determines task placement in your
|
|
849
|
-
* cluster with the following logic
|
|
844
|
+
* cluster with the following logic.</p>
|
|
850
845
|
* <ul>
|
|
851
846
|
* <li>
|
|
852
847
|
* <p>Determine which of the container instances in your cluster can support your
|
|
853
|
-
* service's task definition
|
|
854
|
-
* ports, and container instance attributes
|
|
848
|
+
* service's task definition. For example, they have the required CPU, memory,
|
|
849
|
+
* ports, and container instance attributes.</p>
|
|
855
850
|
* </li>
|
|
856
851
|
* <li>
|
|
857
852
|
* <p>By default, the service scheduler attempts to balance tasks across
|
|
858
|
-
* Availability Zones in this manner
|
|
859
|
-
* strategy
|
|
853
|
+
* Availability Zones in this manner even though you can choose a different
|
|
854
|
+
* placement strategy.</p>
|
|
860
855
|
* <ul>
|
|
861
856
|
* <li>
|
|
862
857
|
* <p>Sort the valid container instances by the fewest number of running
|