Skip to content

Commit 3ff00b2

Browse files
This is a documentation only Amazon ECS release that adds additional information for health checks.
1 parent 7f11d4a commit 3ff00b2

File tree

10 files changed

+101
-42
lines changed

10 files changed

+101
-42
lines changed

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

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

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

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

sdk/src/Services/ECS/Generated/Model/ClusterSetting.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public partial class ClusterSetting
6060
/// <summary>
6161
/// Gets and sets the property Name.
6262
/// <para>
63-
/// The name of the cluster setting. The value is <c>containerInsights</c> .
63+
/// The name of the cluster setting. The value is <c>containerInsights</c>.
6464
/// </para>
6565
/// </summary>
6666
public ClusterSettingName Name

sdk/src/Services/ECS/Generated/Model/ContainerDefinition.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -997,7 +997,7 @@ internal bool IsSetName()
997997
/// </para>
998998
///
999999
/// <para>
1000-
/// This parameter maps to <c>PortBindings</c> in the the docker container create command
1000+
/// This parameter maps to <c>PortBindings</c> in the docker container create command
10011001
/// and the <c>--publish</c> option to docker run. If the network mode of a task definition
10021002
/// is set to <c>none</c>, then you can't specify port mappings. If the network mode of
10031003
/// a task definition is set to <c>host</c>, then host ports must either be undefined

sdk/src/Services/ECS/Generated/Model/CreateServiceRequest.cs

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,24 @@ public partial class CreateServiceRequest : AmazonECSRequest
275275
/// an Amazon ECS service across Availability Zones</a> in the <i> <i>Amazon Elastic Container
276276
/// Service Developer Guide</i> </i>.
277277
/// </para>
278+
///
279+
/// <para>
280+
/// The default behavior of <c>AvailabilityZoneRebalancing</c> differs between create
281+
/// and update requests:
282+
/// </para>
283+
/// <ul> <li>
284+
/// <para>
285+
/// For create service requests, when no value is specified for <c>AvailabilityZoneRebalancing</c>,
286+
/// Amazon ECS defaults the value to <c>ENABLED</c>.
287+
/// </para>
288+
/// </li> <li>
289+
/// <para>
290+
/// For update service requests, when no value is specified for <c>AvailabilityZoneRebalancing</c>,
291+
/// Amazon ECS defaults to the existing service’s <c>AvailabilityZoneRebalancing</c> value.
292+
/// If the service never had an <c>AvailabilityZoneRebalancing</c> value set, Amazon ECS
293+
/// treats this as <c>DISABLED</c>.
294+
/// </para>
295+
/// </li> </ul>
278296
/// </summary>
279297
public AvailabilityZoneRebalancing AvailabilityZoneRebalancing
280298
{
@@ -468,17 +486,14 @@ internal bool IsSetEnableExecuteCommand()
468486
/// <para>
469487
/// The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy
470488
/// Elastic Load Balancing, VPC Lattice, and container health checks after a task has
471-
/// first started. If you don't specify a health check grace period value, the default
472-
/// value of <c>0</c> is used. If you don't use any of the health checks, then <c>healthCheckGracePeriodSeconds</c>
489+
/// first started. If you do not specify a health check grace period value, the default
490+
/// value of 0 is used. If you do not use any of the health checks, then <c>healthCheckGracePeriodSeconds</c>
473491
/// is unused.
474492
/// </para>
475493
///
476494
/// <para>
477-
/// If your service's tasks take a while to start and respond to health checks, you can
478-
/// specify a health check grace period of up to 2,147,483,647 seconds (about 69 years).
479-
/// During that time, the Amazon ECS service scheduler ignores health check status. This
480-
/// grace period can prevent the service scheduler from marking tasks as unhealthy and
481-
/// stopping them before they have time to come up.
495+
/// If your service has more running tasks than desired, unhealthy tasks in the grace
496+
/// period might be stopped to reach the desired count.
482497
/// </para>
483498
/// </summary>
484499
public int HealthCheckGracePeriodSeconds
@@ -546,10 +561,10 @@ internal bool IsSetLaunchType()
546561
/// </para>
547562
///
548563
/// <para>
549-
/// If the service uses the rolling update (<c>ECS</c>) deployment controller and using
550-
/// either an Application Load Balancer or Network Load Balancer, you must specify one
551-
/// or more target group ARNs to attach to the service. The service-linked role is required
552-
/// for services that use multiple target groups. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using
564+
/// If the service uses the <c>ECS</c> deployment controller and using either an Application
565+
/// Load Balancer or Network Load Balancer, you must specify one or more target group
566+
/// ARNs to attach to the service. The service-linked role is required for services that
567+
/// use multiple target groups. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using
553568
/// service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service
554569
/// Developer Guide</i>.
555570
/// </para>

sdk/src/Services/ECS/Generated/Model/DeploymentConfiguration.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ internal bool IsSetMaximumPercent()
207207
/// one-by-one — using the <c>minimumHealthyPercent</c> as a constraint — to clear up
208208
/// capacity to launch replacement tasks. For more information about how the scheduler
209209
/// replaces unhealthy tasks, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Amazon
210-
/// ECS services</a> .
210+
/// ECS services</a>.
211211
/// </para>
212212
///
213213
/// <para>

sdk/src/Services/ECS/Generated/Model/DeploymentLifecycleHook.cs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,8 @@ public partial class DeploymentLifecycleHook
5050
/// <summary>
5151
/// Gets and sets the property HookDetails.
5252
/// <para>
53-
/// The details of the deployment lifecycle hook. This provides additional configuration
54-
/// for how the hook should be executed during deployment operations on Amazon ECS Managed
55-
/// Instances.
53+
/// Use this field to specify custom parameters that Amazon ECS will pass to your hook
54+
/// target invocations (such as a Lambda function).
5655
/// </para>
5756
/// </summary>
5857
public Amazon.Runtime.Documents.Document HookDetails

sdk/src/Services/ECS/Generated/Model/RunTaskRequest.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -640,7 +640,7 @@ internal bool IsSetTaskDefinition()
640640
/// Gets and sets the property VolumeConfigurations.
641641
/// <para>
642642
/// The details of the volume that was <c>configuredAtLaunch</c>. You can configure the
643-
/// size, volumeType, IOPS, throughput, snapshot and encryption in in <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskManagedEBSVolumeConfiguration.html">TaskManagedEBSVolumeConfiguration</a>.
643+
/// size, volumeType, IOPS, throughput, snapshot and encryption in <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskManagedEBSVolumeConfiguration.html">TaskManagedEBSVolumeConfiguration</a>.
644644
/// The <c>name</c> of the volume must match the <c>name</c> from the task definition.
645645
/// </para>
646646
/// </summary>

sdk/src/Services/ECS/Generated/Model/Service.cs

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,24 @@ public partial class Service
7878
/// an Amazon ECS service across Availability Zones</a> in the <i> <i>Amazon Elastic Container
7979
/// Service Developer Guide</i> </i>.
8080
/// </para>
81+
///
82+
/// <para>
83+
/// The default behavior of <c>AvailabilityZoneRebalancing</c> differs between create
84+
/// and update requests:
85+
/// </para>
86+
/// <ul> <li>
87+
/// <para>
88+
/// For create service requests, when no value is specified for <c>AvailabilityZoneRebalancing</c>,
89+
/// Amazon ECS defaults the value to <c>ENABLED</c>.
90+
/// </para>
91+
/// </li> <li>
92+
/// <para>
93+
/// For update service requests, when no value is specified for <c>AvailabilityZoneRebalancing</c>,
94+
/// Amazon ECS defaults to the existing service’s <c>AvailabilityZoneRebalancing</c> value.
95+
/// If the service never had an <c>AvailabilityZoneRebalancing</c> value set, Amazon ECS
96+
/// treats this as <c>DISABLED</c>.
97+
/// </para>
98+
/// </li> </ul>
8199
/// </summary>
82100
public AvailabilityZoneRebalancing AvailabilityZoneRebalancing
83101
{
@@ -305,6 +323,11 @@ internal bool IsSetEvents()
305323
/// Elastic Load Balancing, VPC Lattice, and container health checks after a task has
306324
/// first started.
307325
/// </para>
326+
///
327+
/// <para>
328+
/// If your service has more running tasks than desired, unhealthy tasks in the grace
329+
/// period might be stopped to reach the desired count.
330+
/// </para>
308331
/// </summary>
309332
public int HealthCheckGracePeriodSeconds
310333
{

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,23 @@ public partial class UpdateServiceRequest : AmazonECSRequest
226226
/// </para>
227227
///
228228
/// <para>
229+
/// The default behavior of <c>AvailabilityZoneRebalancing</c> differs between create
230+
/// and update requests:
231+
/// </para>
232+
/// <ul> <li>
233+
/// <para>
234+
/// For create service requests, when no value is specified for <c>AvailabilityZoneRebalancing</c>,
235+
/// Amazon ECS defaults the value to <c>ENABLED</c>.
236+
/// </para>
237+
/// </li> <li>
238+
/// <para>
239+
/// For update service requests, when no value is specified for <c>AvailabilityZoneRebalancing</c>,
240+
/// Amazon ECS defaults to the existing service’s <c>AvailabilityZoneRebalancing</c> value.
241+
/// If the service never had an <c>AvailabilityZoneRebalancing</c> value set, Amazon ECS
242+
/// treats this as <c>DISABLED</c>.
243+
/// </para>
244+
/// </li> </ul>
245+
/// <para>
229246
/// This parameter doesn't trigger a new service deployment.
230247
/// </para>
231248
/// </summary>
@@ -491,6 +508,11 @@ internal bool IsSetForceNewDeployment()
491508
/// </para>
492509
///
493510
/// <para>
511+
/// If your service has more running tasks than desired, unhealthy tasks in the grace
512+
/// period might be stopped to reach the desired count.
513+
/// </para>
514+
///
515+
/// <para>
494516
/// This parameter doesn't trigger a new service deployment.
495517
/// </para>
496518
/// </summary>

0 commit comments

Comments
 (0)