Skip to content

Commit cea1ccf

Browse files
This is a documentation only release that adds additional information for Amazon ECS Availability Zone rebalancing.
1 parent 800d70d commit cea1ccf

File tree

14 files changed

+92
-46
lines changed

14 files changed

+92
-46
lines changed

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

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

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

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ namespace Amazon.ECS.Model
3131
{
3232
/// <summary>
3333
/// Your Amazon Web Services account was blocked. For more information, contact <a href="http://aws.amazon.com/contact-us/">
34-
/// Amazon Web ServicesSupport</a>.
34+
/// Amazon Web Services Support</a>.
3535
/// </summary>
3636
#if !NETSTANDARD
3737
[Serializable]

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/CreateServiceRequest.cs

Lines changed: 26 additions & 16 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 when no value is specified for <c>AvailabilityZoneRebalancing</c>,
286+
/// Amazon ECS defaults the value to 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
{
@@ -466,20 +484,12 @@ internal bool IsSetEnableExecuteCommand()
466484
/// <summary>
467485
/// Gets and sets the property HealthCheckGracePeriodSeconds.
468486
/// <para>
469-
/// The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy
470-
/// 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>
487+
/// The period of time, in seconds, that the Amazon Amazon ECS service scheduler ignores
488+
/// unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a
489+
/// task has first started. If you do not specify a health check grace period value, the
490+
/// default value of 0 is used. If you do not use any of the health checks, then <c>healthCheckGracePeriodSeconds</c>
473491
/// is unused.
474492
/// </para>
475-
///
476-
/// <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.
482-
/// </para>
483493
/// </summary>
484494
public int HealthCheckGracePeriodSeconds
485495
{
@@ -546,10 +556,10 @@ internal bool IsSetLaunchType()
546556
/// </para>
547557
///
548558
/// <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
559+
/// If the service uses the <c>ECS</c> deployment controller and using either an Application
560+
/// Load Balancer or Network Load Balancer, you must specify one or more target group
561+
/// ARNs to attach to the service. The service-linked role is required for services that
562+
/// use multiple target groups. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using
553563
/// service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service
554564
/// Developer Guide</i>.
555565
/// </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/Service.cs

Lines changed: 20 additions & 1 deletion
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 when no value is specified for <c>AvailabilityZoneRebalancing</c>,
89+
/// Amazon ECS defaults the value to 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
{
@@ -302,7 +320,8 @@ internal bool IsSetEvents()
302320
/// Gets and sets the property HealthCheckGracePeriodSeconds.
303321
/// <para>
304322
/// The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy
305-
/// Elastic Load Balancing target health checks after a task has first started.
323+
/// Elastic Load Balancing, VPC Lattice, and container health checks after a task has
324+
/// first started.
306325
/// </para>
307326
/// </summary>
308327
public int HealthCheckGracePeriodSeconds

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

Lines changed: 17 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 when no value is specified for <c>AvailabilityZoneRebalancing</c>,
235+
/// Amazon ECS defaults the value to 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>

sdk/src/Services/ECS/Generated/_bcl35/AmazonECSClient.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4030,7 +4030,7 @@ public virtual RegisterTaskDefinitionResponse EndRegisterTaskDefinition(IAsyncRe
40304030
/// </exception>
40314031
/// <exception cref="Amazon.ECS.Model.BlockedException">
40324032
/// Your Amazon Web Services account was blocked. For more information, contact <a href="http://aws.amazon.com/contact-us/">
4033-
/// Amazon Web ServicesSupport</a>.
4033+
/// Amazon Web Services Support</a>.
40344034
/// </exception>
40354035
/// <exception cref="Amazon.ECS.Model.ClientException">
40364036
/// These errors are usually caused by a client action. This client action might be using

sdk/src/Services/ECS/Generated/_bcl35/IAmazonECS.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3252,7 +3252,7 @@ public partial interface IAmazonECS : IAmazonService, IDisposable
32523252
/// </exception>
32533253
/// <exception cref="Amazon.ECS.Model.BlockedException">
32543254
/// Your Amazon Web Services account was blocked. For more information, contact <a href="http://aws.amazon.com/contact-us/">
3255-
/// Amazon Web ServicesSupport</a>.
3255+
/// Amazon Web Services Support</a>.
32563256
/// </exception>
32573257
/// <exception cref="Amazon.ECS.Model.ClientException">
32583258
/// These errors are usually caused by a client action. This client action might be using

0 commit comments

Comments
 (0)