Skip to content

Commit a5d7f70

Browse files
aws-sdk-dotnet-automationaws-sdk-dotnet-automation
committed
This Amazon ECS release supports updating the capacityProviderStrategy parameter in update-service.
1 parent 423f3fe commit a5d7f70

File tree

8 files changed

+132
-167
lines changed

8 files changed

+132
-167
lines changed

‎generator/ServiceModels/ecs/ecs-2014-11-13.docs.json

Lines changed: 6 additions & 6 deletions
Large diffs are not rendered by default.

‎generator/ServiceModels/ecs/ecs-2014-11-13.normal.json

Lines changed: 6 additions & 6 deletions
Large diffs are not rendered by default.

‎sdk/src/Services/ECS/Generated/Model/HealthCheck.cs

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,67 @@ namespace Amazon.ECS.Model
163163
/// </para>
164164
///
165165
/// <para>
166+
/// When a container health check fails for a task that is part of a service, the following
167+
/// process occurs:
168+
/// </para>
169+
/// <ol> <li>
170+
/// <para>
171+
/// The task is marked as <c>UNHEALTHY</c>.
172+
/// </para>
173+
/// </li> <li>
174+
/// <para>
175+
/// The unhealthy task will be stopped, and during the stopping process, it will go through
176+
/// the following states:
177+
/// </para>
178+
/// <ul> <li>
179+
/// <para>
180+
/// <c>DEACTIVATING</c> - In this state, Amazon ECS performs additional steps before
181+
/// stopping the task. For example, for tasks that are part of services configured to
182+
/// use Elastic Load Balancing target groups, target groups will be deregistered in this
183+
/// state.
184+
/// </para>
185+
/// </li> <li>
186+
/// <para>
187+
/// <c>STOPPING</c> - The task is in the process of being stopped.
188+
/// </para>
189+
/// </li> <li>
190+
/// <para>
191+
/// <c>DEPROVISIONING</c> - Resources associated with the task are being cleaned up.
192+
/// </para>
193+
/// </li> <li>
194+
/// <para>
195+
/// <c>STOPPED</c> - The task has been completely stopped.
196+
/// </para>
197+
/// </li> </ul> </li> <li>
198+
/// <para>
199+
/// After the old task stops, a new task will be launched to ensure service operation,
200+
/// and the new task will go through the following lifecycle:
201+
/// </para>
202+
/// <ul> <li>
203+
/// <para>
204+
/// <c>PROVISIONING</c> - Resources required for the task are being provisioned.
205+
/// </para>
206+
/// </li> <li>
207+
/// <para>
208+
/// <c>PENDING</c> - The task is waiting to be placed on a container instance.
209+
/// </para>
210+
/// </li> <li>
211+
/// <para>
212+
/// <c>ACTIVATING</c> - In this state, Amazon ECS pulls container images, creates containers,
213+
/// configures task networking, registers load balancer target groups, and configures
214+
/// service discovery status.
215+
/// </para>
216+
/// </li> <li>
217+
/// <para>
218+
/// <c>RUNNING</c> - The task is running and performing its work.
219+
/// </para>
220+
/// </li> </ul> </li> </ol>
221+
/// <para>
222+
/// For more detailed information about task lifecycle states, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle-explanation.html">Task
223+
/// lifecycle</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.
224+
/// </para>
225+
///
226+
/// <para>
166227
/// The following are notes about container health check support:
167228
/// </para>
168229
/// <ul> <li>

‎sdk/src/Services/ECS/Generated/Model/UpdateServiceRequest.cs

Lines changed: 53 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -186,25 +186,7 @@ namespace Amazon.ECS.Model
186186
/// previous steps), favoring container instances with the largest number of running tasks
187187
/// for this service.
188188
/// </para>
189-
/// </li> </ul> <note>
190-
/// <para>
191-
/// You must have a service-linked role when you update any of the following service properties:
192-
/// </para>
193-
/// <ul> <li>
194-
/// <para>
195-
/// <c>loadBalancers</c>,
196-
/// </para>
197-
/// </li> <li>
198-
/// <para>
199-
/// <c>serviceRegistries</c>
200-
/// </para>
201-
/// </li> </ul>
202-
/// <para>
203-
/// For more information about the role see the <c>CreateService</c> request parameter
204-
/// <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role">
205-
/// <c>role</c> </a>.
206-
/// </para>
207-
/// </note>
189+
/// </li> </ul>
208190
/// </summary>
209191
public partial class UpdateServiceRequest : AmazonECSRequest
210192
{
@@ -257,41 +239,53 @@ internal bool IsSetAvailabilityZoneRebalancing()
257239
/// <summary>
258240
/// Gets and sets the property CapacityProviderStrategy.
259241
/// <para>
260-
/// The capacity provider strategy to update the service to use.
242+
/// The details of a capacity provider strategy. You can set a capacity provider when
243+
/// you create a cluster, run a task, or update a service.
261244
/// </para>
262245
///
263246
/// <para>
264-
/// if the service uses the default capacity provider strategy for the cluster, the service
265-
/// can be updated to use one or more capacity providers as opposed to the default capacity
266-
/// provider strategy. However, when a service is using a capacity provider strategy that's
267-
/// not the default capacity provider strategy, the service can't be updated to use the
268-
/// cluster's default capacity provider strategy.
247+
/// When you use Fargate, the capacity providers are <c>FARGATE</c> or <c>FARGATE_SPOT</c>.
269248
/// </para>
270249
///
271250
/// <para>
272-
/// A capacity provider strategy consists of one or more capacity providers along with
273-
/// the <c>base</c> and <c>weight</c> to assign to them. A capacity provider must be associated
274-
/// 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>
275-
/// API is used to associate a capacity provider with a cluster. Only capacity providers
276-
/// with an <c>ACTIVE</c> or <c>UPDATING</c> status can be used.
251+
/// When you use Amazon EC2, the capacity providers are Auto Scaling groups.
277252
/// </para>
278253
///
279254
/// <para>
280-
/// If specifying a capacity provider that uses an Auto Scaling group, the capacity provider
281-
/// 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>
282-
/// API operation.
255+
/// You can change capacity providers for rolling deployments and blue/green deployments.
283256
/// </para>
284257
///
285258
/// <para>
286-
/// To use a Fargate capacity provider, specify either the <c>FARGATE</c> or <c>FARGATE_SPOT</c>
287-
/// capacity providers. The Fargate capacity providers are available to all accounts and
288-
/// only need to be associated with a cluster to be used.
259+
/// The following list provides the valid transitions:
260+
/// </para>
261+
/// <ul> <li>
262+
/// <para>
263+
/// Update the Fargate launch type to an EC2 capacity provider.
264+
/// </para>
265+
/// </li> <li>
266+
/// <para>
267+
/// Update the Amazon EC2 launch type to a Fargate capacity provider.
268+
/// </para>
269+
/// </li> <li>
270+
/// <para>
271+
/// Update the Fargate capacity provider to an EC2 capacity provider.
272+
/// </para>
273+
/// </li> <li>
274+
/// <para>
275+
/// Update the Amazon EC2 capacity provider to a Fargate capacity provider.
276+
/// </para>
277+
/// </li> <li>
278+
/// <para>
279+
/// Update the EC2 or Fargate capacity provider back to the launch type.
289280
/// </para>
290281
///
291282
/// <para>
292-
/// The <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a>API
293-
/// operation is used to update the list of available capacity providers for a cluster
294-
/// after the cluster is created.
283+
/// Pass an empty list in the <c>capacityProvider</c> parameter.
284+
/// </para>
285+
/// </li> </ul>
286+
/// <para>
287+
/// For information about Amazon Web Services CDK considerations, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-parameters.html">Amazon
288+
/// Web Services CDK considerations</a>.
295289
/// </para>
296290
/// <para />
297291
/// Starting with version 4 of the SDK this property will default to null. If no data for this property is returned
@@ -317,6 +311,10 @@ internal bool IsSetCapacityProviderStrategy()
317311
/// The short name or full Amazon Resource Name (ARN) of the cluster that your service
318312
/// runs on. If you do not specify a cluster, the default cluster is assumed.
319313
/// </para>
314+
///
315+
/// <para>
316+
/// You can't change the cluster name.
317+
/// </para>
320318
/// </summary>
321319
public string Cluster
322320
{
@@ -470,7 +468,11 @@ internal bool IsSetHealthCheckGracePeriodSeconds()
470468
}
471469

472470
/// <summary>
473-
/// Gets and sets the property LoadBalancers.
471+
/// Gets and sets the property LoadBalancers. <note>
472+
/// <para>
473+
/// You must have a service-linked role when you update this property
474+
/// </para>
475+
/// </note>
474476
/// <para>
475477
/// A list of Elastic Load Balancing load balancer objects. It contains the load balancer
476478
/// name, the container name, and the container port to access from the load balancer.
@@ -703,7 +705,17 @@ internal bool IsSetServiceConnectConfiguration()
703705
}
704706

705707
/// <summary>
706-
/// Gets and sets the property ServiceRegistries.
708+
/// Gets and sets the property ServiceRegistries. <note>
709+
/// <para>
710+
/// You must have a service-linked role when you update this property.
711+
/// </para>
712+
///
713+
/// <para>
714+
/// For more information about the role see the <c>CreateService</c> request parameter
715+
/// <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role">
716+
/// <c>role</c> </a>.
717+
/// </para>
718+
/// </note>
707719
/// <para>
708720
/// The details for the service discovery registries to assign to this service. For more
709721
/// information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html">Service

‎sdk/src/Services/ECS/Generated/_bcl/AmazonECSClient.cs

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -6518,25 +6518,7 @@ public virtual UpdateContainerInstancesStateResponse UpdateContainerInstancesSta
65186518
/// previous steps), favoring container instances with the largest number of running tasks
65196519
/// for this service.
65206520
/// </para>
6521-
/// </li> </ul> <note>
6522-
/// <para>
6523-
/// You must have a service-linked role when you update any of the following service properties:
6524-
/// </para>
6525-
/// <ul> <li>
6526-
/// <para>
6527-
/// <c>loadBalancers</c>,
6528-
/// </para>
6529-
/// </li> <li>
6530-
/// <para>
6531-
/// <c>serviceRegistries</c>
6532-
/// </para>
6533-
/// </li> </ul>
6534-
/// <para>
6535-
/// For more information about the role see the <c>CreateService</c> request parameter
6536-
/// <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role">
6537-
/// <c>role</c> </a>.
6538-
/// </para>
6539-
/// </note>
6521+
/// </li> </ul>
65406522
/// </summary>
65416523
/// <param name="request">Container for the necessary parameters to execute the UpdateService service method.</param>
65426524
///
@@ -6753,25 +6735,7 @@ public virtual UpdateServiceResponse UpdateService(UpdateServiceRequest request)
67536735
/// previous steps), favoring container instances with the largest number of running tasks
67546736
/// for this service.
67556737
/// </para>
6756-
/// </li> </ul> <note>
6757-
/// <para>
6758-
/// You must have a service-linked role when you update any of the following service properties:
6759-
/// </para>
6760-
/// <ul> <li>
6761-
/// <para>
6762-
/// <c>loadBalancers</c>,
6763-
/// </para>
6764-
/// </li> <li>
6765-
/// <para>
6766-
/// <c>serviceRegistries</c>
6767-
/// </para>
6768-
/// </li> </ul>
6769-
/// <para>
6770-
/// For more information about the role see the <c>CreateService</c> request parameter
6771-
/// <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role">
6772-
/// <c>role</c> </a>.
6773-
/// </para>
6774-
/// </note>
6738+
/// </li> </ul>
67756739
/// </summary>
67766740
/// <param name="request">Container for the necessary parameters to execute the UpdateService service method.</param>
67776741
/// <param name="cancellationToken">

‎sdk/src/Services/ECS/Generated/_bcl/IAmazonECS.cs

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -5626,25 +5626,7 @@ public partial interface IAmazonECS : IAmazonService, IDisposable
56265626
/// previous steps), favoring container instances with the largest number of running tasks
56275627
/// for this service.
56285628
/// </para>
5629-
/// </li> </ul> <note>
5630-
/// <para>
5631-
/// You must have a service-linked role when you update any of the following service properties:
5632-
/// </para>
5633-
/// <ul> <li>
5634-
/// <para>
5635-
/// <c>loadBalancers</c>,
5636-
/// </para>
5637-
/// </li> <li>
5638-
/// <para>
5639-
/// <c>serviceRegistries</c>
5640-
/// </para>
5641-
/// </li> </ul>
5642-
/// <para>
5643-
/// For more information about the role see the <c>CreateService</c> request parameter
5644-
/// <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role">
5645-
/// <c>role</c> </a>.
5646-
/// </para>
5647-
/// </note>
5629+
/// </li> </ul>
56485630
/// </summary>
56495631
/// <param name="request">Container for the necessary parameters to execute the UpdateService service method.</param>
56505632
///
@@ -5855,25 +5837,7 @@ public partial interface IAmazonECS : IAmazonService, IDisposable
58555837
/// previous steps), favoring container instances with the largest number of running tasks
58565838
/// for this service.
58575839
/// </para>
5858-
/// </li> </ul> <note>
5859-
/// <para>
5860-
/// You must have a service-linked role when you update any of the following service properties:
5861-
/// </para>
5862-
/// <ul> <li>
5863-
/// <para>
5864-
/// <c>loadBalancers</c>,
5865-
/// </para>
5866-
/// </li> <li>
5867-
/// <para>
5868-
/// <c>serviceRegistries</c>
5869-
/// </para>
5870-
/// </li> </ul>
5871-
/// <para>
5872-
/// For more information about the role see the <c>CreateService</c> request parameter
5873-
/// <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role">
5874-
/// <c>role</c> </a>.
5875-
/// </para>
5876-
/// </note>
5840+
/// </li> </ul>
58775841
/// </summary>
58785842
/// <param name="request">Container for the necessary parameters to execute the UpdateService service method.</param>
58795843
/// <param name="cancellationToken">

‎sdk/src/Services/ECS/Generated/_netstandard/AmazonECSClient.cs

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4143,25 +4143,7 @@ internal virtual UpdateServiceResponse UpdateService(UpdateServiceRequest reques
41434143
/// previous steps), favoring container instances with the largest number of running tasks
41444144
/// for this service.
41454145
/// </para>
4146-
/// </li> </ul> <note>
4147-
/// <para>
4148-
/// You must have a service-linked role when you update any of the following service properties:
4149-
/// </para>
4150-
/// <ul> <li>
4151-
/// <para>
4152-
/// <c>loadBalancers</c>,
4153-
/// </para>
4154-
/// </li> <li>
4155-
/// <para>
4156-
/// <c>serviceRegistries</c>
4157-
/// </para>
4158-
/// </li> </ul>
4159-
/// <para>
4160-
/// For more information about the role see the <c>CreateService</c> request parameter
4161-
/// <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role">
4162-
/// <c>role</c> </a>.
4163-
/// </para>
4164-
/// </note>
4146+
/// </li> </ul>
41654147
/// </summary>
41664148
/// <param name="request">Container for the necessary parameters to execute the UpdateService service method.</param>
41674149
/// <param name="cancellationToken">

‎sdk/src/Services/ECS/Generated/_netstandard/IAmazonECS.cs

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3134,25 +3134,7 @@ public partial interface IAmazonECS : IAmazonService, IDisposable
31343134
/// previous steps), favoring container instances with the largest number of running tasks
31353135
/// for this service.
31363136
/// </para>
3137-
/// </li> </ul> <note>
3138-
/// <para>
3139-
/// You must have a service-linked role when you update any of the following service properties:
3140-
/// </para>
3141-
/// <ul> <li>
3142-
/// <para>
3143-
/// <c>loadBalancers</c>,
3144-
/// </para>
3145-
/// </li> <li>
3146-
/// <para>
3147-
/// <c>serviceRegistries</c>
3148-
/// </para>
3149-
/// </li> </ul>
3150-
/// <para>
3151-
/// For more information about the role see the <c>CreateService</c> request parameter
3152-
/// <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role">
3153-
/// <c>role</c> </a>.
3154-
/// </para>
3155-
/// </note>
3137+
/// </li> </ul>
31563138
/// </summary>
31573139
/// <param name="request">Container for the necessary parameters to execute the UpdateService service method.</param>
31583140
/// <param name="cancellationToken">

0 commit comments

Comments
 (0)