Skip to content

Commit eb8c772

Browse files
author
awstools
committed
docs(client-ecs): This Amazon ECS release supports updating the capacityProviderStrategy parameter in update-service.
1 parent 4ec8cbf commit eb8c772

File tree

4 files changed

+100
-48
lines changed

4 files changed

+100
-48
lines changed

‎clients/client-ecs/src/commands/UpdateServiceCommand.ts

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -145,25 +145,6 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
145145
* running tasks for this service.</p>
146146
* </li>
147147
* </ul>
148-
* <note>
149-
* <p>You must have a service-linked role when you update any of the following service
150-
* properties:</p>
151-
* <ul>
152-
* <li>
153-
* <p>
154-
* <code>loadBalancers</code>,</p>
155-
* </li>
156-
* <li>
157-
* <p>
158-
* <code>serviceRegistries</code>
159-
* </p>
160-
* </li>
161-
* </ul>
162-
* <p>For more information about the role see the <code>CreateService</code> request
163-
* parameter <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role">
164-
* <code>role</code>
165-
* </a>. </p>
166-
* </note>
167148
* @example
168149
* Use a bare-bones client and the command you need to make an API call.
169150
* ```javascript

‎clients/client-ecs/src/models/models_0.ts

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5070,6 +5070,60 @@ export interface FirelensConfiguration {
50705070
* lifecycle regardless of its health status. For tasks that are part of a service, if the
50715071
* task reports as unhealthy then the task will be stopped and the service scheduler will
50725072
* replace it.</p>
5073+
* <p>When a container health check fails for a task that is part of a service, the following process occurs:</p>
5074+
* <ol>
5075+
* <li>
5076+
* <p>The task is marked as <code>UNHEALTHY</code>.</p>
5077+
* </li>
5078+
* <li>
5079+
* <p>The unhealthy task will be stopped, and during the stopping process, it will go through the following states:</p>
5080+
* <ul>
5081+
* <li>
5082+
* <p>
5083+
* <code>DEACTIVATING</code> - In this state, Amazon ECS performs additional steps before stopping the
5084+
* task. For example, for tasks that are part of services configured to use
5085+
* Elastic Load Balancing target groups, target groups will be deregistered
5086+
* in this state.</p>
5087+
* </li>
5088+
* <li>
5089+
* <p>
5090+
* <code>STOPPING</code> - The task is in the process of being stopped.</p>
5091+
* </li>
5092+
* <li>
5093+
* <p>
5094+
* <code>DEPROVISIONING</code> - Resources associated with the task are being cleaned up.</p>
5095+
* </li>
5096+
* <li>
5097+
* <p>
5098+
* <code>STOPPED</code> - The task has been completely stopped.</p>
5099+
* </li>
5100+
* </ul>
5101+
* </li>
5102+
* <li>
5103+
* <p>After the old task stops, a new task will be launched to ensure service operation, and the new task will go through the following lifecycle:</p>
5104+
* <ul>
5105+
* <li>
5106+
* <p>
5107+
* <code>PROVISIONING</code> - Resources required for the task are being provisioned.</p>
5108+
* </li>
5109+
* <li>
5110+
* <p>
5111+
* <code>PENDING</code> - The task is waiting to be placed on a container instance.</p>
5112+
* </li>
5113+
* <li>
5114+
* <p>
5115+
* <code>ACTIVATING</code> - In this state, Amazon ECS pulls container images, creates containers,
5116+
* configures task networking, registers load balancer target groups, and
5117+
* configures service discovery status.</p>
5118+
* </li>
5119+
* <li>
5120+
* <p>
5121+
* <code>RUNNING</code> - The task is running and performing its work.</p>
5122+
* </li>
5123+
* </ul>
5124+
* </li>
5125+
* </ol>
5126+
* <p>For more detailed information about task lifecycle states, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle-explanation.html">Task lifecycle</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
50735127
* <p>The following are notes about container health check support:</p>
50745128
* <ul>
50755129
* <li>

‎clients/client-ecs/src/models/models_1.ts

Lines changed: 40 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -406,6 +406,7 @@ export interface UpdateServiceRequest {
406406
/**
407407
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that your service runs on.
408408
* If you do not specify a cluster, the default cluster is assumed.</p>
409+
* <p>You can't change the cluster name.</p>
409410
* @public
410411
*/
411412
cluster?: string | undefined;
@@ -434,27 +435,33 @@ export interface UpdateServiceRequest {
434435
taskDefinition?: string | undefined;
435436

436437
/**
437-
* <p>The capacity provider strategy to update the service to use.</p>
438-
* <p>if the service uses the default capacity provider strategy for the cluster, the
439-
* service can be updated to use one or more capacity providers as opposed to the default
440-
* capacity provider strategy. However, when a service is using a capacity provider
441-
* strategy that's not the default capacity provider strategy, the service can't be updated
442-
* to use the cluster's default capacity provider strategy.</p>
443-
* <p>A capacity provider strategy consists of one or more capacity providers along with the
444-
* <code>base</code> and <code>weight</code> to assign to them. A capacity provider
445-
* must be associated with the cluster to be used in a capacity provider strategy. The
446-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> API is used to associate a capacity provider
447-
* with a cluster. Only capacity providers with an <code>ACTIVE</code> or
448-
* <code>UPDATING</code> status can be used.</p>
449-
* <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity
450-
* 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>
451-
* <p>To use a Fargate capacity provider, specify either the <code>FARGATE</code> or
452-
* <code>FARGATE_SPOT</code> capacity providers. The Fargate capacity providers are
453-
* available to all accounts and only need to be associated with a cluster to be
454-
* used.</p>
455-
* <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
456-
* available capacity providers for a cluster after the cluster is created.</p>
457-
* <p></p>
438+
* <p>The details of a capacity provider strategy. You can set a capacity provider when you
439+
* create a cluster, run a task, or update a service.</p>
440+
* <p>When you use Fargate, the capacity providers are <code>FARGATE</code> or
441+
* <code>FARGATE_SPOT</code>.</p>
442+
* <p>When you use Amazon EC2, the capacity providers are Auto Scaling groups.</p>
443+
* <p>You can change capacity providers for rolling deployments and blue/green
444+
* deployments.</p>
445+
* <p>The following list provides the valid transitions:</p>
446+
* <ul>
447+
* <li>
448+
* <p>Update the Fargate launch type to an EC2 capacity provider.</p>
449+
* </li>
450+
* <li>
451+
* <p>Update the Amazon EC2 launch type to a Fargate capacity provider.</p>
452+
* </li>
453+
* <li>
454+
* <p>Update the Fargate capacity provider to an EC2 capacity provider.</p>
455+
* </li>
456+
* <li>
457+
* <p>Update the Amazon EC2 capacity provider to a Fargate capacity provider. </p>
458+
* </li>
459+
* <li>
460+
* <p>Update the EC2 or Fargate capacity provider back to the launch type.</p>
461+
* <p>Pass an empty list in the <code>capacityProvider</code> parameter.</p>
462+
* </li>
463+
* </ul>
464+
* <p>For information about Amazon Web Services CDK considerations, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-parameters.html">Amazon Web Services CDK considerations</a>.</p>
458465
* @public
459466
*/
460467
capacityProviderStrategy?: CapacityProviderStrategyItem[] | undefined;
@@ -560,7 +567,10 @@ export interface UpdateServiceRequest {
560567
enableECSManagedTags?: boolean | undefined;
561568

562569
/**
563-
* <p>A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the
570+
* <note>
571+
* <p>You must have a service-linked role when you update this property</p>
572+
* </note>
573+
* <p>A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the
564574
* container name, and the container port to access from the load balancer. The container
565575
* name is as it appears in a container definition.</p>
566576
* <p>When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks
@@ -596,7 +606,14 @@ export interface UpdateServiceRequest {
596606
propagateTags?: PropagateTags | undefined;
597607

598608
/**
599-
* <p>The details for the service discovery registries to assign to this service. For more
609+
* <note>
610+
* <p>You must have a service-linked role when you update this property.</p>
611+
* <p>For more information about the role see the <code>CreateService</code> request
612+
* parameter <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role">
613+
* <code>role</code>
614+
* </a>. </p>
615+
* </note>
616+
* <p>The details for the service discovery registries to assign to this service. For more
600617
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html">Service
601618
* Discovery</a>.</p>
602619
* <p>When you add, update, or remove the service registries configuration, Amazon ECS starts new

0 commit comments

Comments
 (0)