docs(client-ecs): This is a documentation only Amazon ECS release that adds additional information for health checks.

Author: awstools

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

@@ -1615,7 +1615,7 @@ export type ClusterSettingName = (typeof ClusterSettingName)[keyof typeof Cluste
  */
 export interface ClusterSetting {
   /**
-   * <p>The name of the cluster setting. The value is <code>containerInsights</code> .</p>
+   * <p>The name of the cluster setting. The value is <code>containerInsights</code>.</p>
    * @public
    */
   name?: ClusterSettingName | undefined;
@@ -2263,7 +2263,7 @@ export interface DeploymentLifecycleHook {
   lifecycleStages?: DeploymentLifecycleHookStage[] | undefined;
 
   /**
-   * <p>The details of the deployment lifecycle hook. This provides additional configuration for how the hook should be executed during deployment operations on Amazon ECS Managed Instances.</p>
+   * <p>Use this field to specify custom parameters that Amazon ECS will pass to your hook target invocations (such as a Lambda function).</p>
    * @public
    */
   hookDetails?: __DocumentType | undefined;
@@ -2357,7 +2357,7 @@ export interface DeploymentConfiguration {
    * 			scheduler to start replacement tasks, the scheduler stops the unhealthy tasks one-by-one
    * 			— using the <code>minimumHealthyPercent</code> as a constraint — to clear up capacity to
    * 			launch replacement tasks. For more information about how the scheduler replaces
-   * 			unhealthy tasks, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Amazon ECS services</a> . </p>
+   * 			unhealthy tasks, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Amazon ECS services</a>. </p>
    *          <p>For services that <i>do not</i> use a load balancer, the following
    * 			should be noted:</p>
    *          <ul>
@@ -3893,14 +3893,23 @@ export interface CreateServiceRequest {
    * 			the <i>
    *                <i>Amazon Elastic Container Service Developer Guide</i>
    *             </i>.</p>
+   *          <p>The default behavior of <code>AvailabilityZoneRebalancing</code> differs between create and update requests:</p>
+   *          <ul>
+   *             <li>
+   *                <p>For create service requests, when no value is specified for <code>AvailabilityZoneRebalancing</code>, Amazon ECS defaults the value to <code>ENABLED</code>.</p>
+   *             </li>
+   *             <li>
+   *                <p>For update service requests, when no value is specified for <code>AvailabilityZoneRebalancing</code>, Amazon ECS defaults to the existing service’s <code>AvailabilityZoneRebalancing</code> value. If the service never had an <code>AvailabilityZoneRebalancing</code> value set, Amazon ECS treats this as <code>DISABLED</code>.</p>
+   *             </li>
+   *          </ul>
    * @public
    */
   availabilityZoneRebalancing?: AvailabilityZoneRebalancing | undefined;
 
   /**
    * <p>A load balancer object representing the load balancers to use with your service. For
    * 			more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
-   *          <p>If the service uses the rolling update (<code>ECS</code>) deployment controller and
+   *          <p>If the service uses the <code>ECS</code> deployment controller and
    * 			using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach
    * 			to the service. The service-linked role is required 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 service-linked roles for Amazon ECS</a> in the
@@ -4066,16 +4075,8 @@ export interface CreateServiceRequest {
   networkConfiguration?: NetworkConfiguration | undefined;
 
   /**
-   * <p>The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy
-   * 			Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't
-   * 			specify a health check grace period value, the default value of <code>0</code> is used.
-   * 			If you don't use any of the health checks, then
-   * 				<code>healthCheckGracePeriodSeconds</code> is unused.</p>
-   *          <p>If your service's tasks take a while to start and respond to health checks, you can
-   * 			specify a health check grace period of up to 2,147,483,647 seconds (about 69 years).
-   * 			During that time, the Amazon ECS service scheduler ignores health check status. This grace
-   * 			period can prevent the service scheduler from marking tasks as unhealthy and stopping
-   * 			them before they have time to come up.</p>
+   * <p>The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you do not specify a health check grace period value, the default value of 0 is used. If you do not use any of the health checks, then <code>healthCheckGracePeriodSeconds</code> is unused.</p>
+   *          <p>If your service has more running tasks than desired, unhealthy tasks in the grace period might be stopped to reach the desired count.</p>
    * @public
    */
   healthCheckGracePeriodSeconds?: number | undefined;
@@ -4959,6 +4960,7 @@ export interface Service {
   /**
    * <p>The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy
    * 			Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started.</p>
+   *          <p>If your service has more running tasks than desired, unhealthy tasks in the grace period might be stopped to reach the desired count.</p>
    * @public
    */
   healthCheckGracePeriodSeconds?: number | undefined;
@@ -5072,6 +5074,15 @@ export interface Service {
    * 			the <i>
    *                <i>Amazon Elastic Container Service Developer Guide</i>
    *             </i>.</p>
+   *          <p>The default behavior of <code>AvailabilityZoneRebalancing</code> differs between create and update requests:</p>
+   *          <ul>
+   *             <li>
+   *                <p>For create service requests, when no value is specified for <code>AvailabilityZoneRebalancing</code>, Amazon ECS defaults the value to <code>ENABLED</code>.</p>
+   *             </li>
+   *             <li>
+   *                <p>For update service requests, when no value is specified for <code>AvailabilityZoneRebalancing</code>, Amazon ECS defaults to the existing service’s <code>AvailabilityZoneRebalancing</code> value. If the service never had an <code>AvailabilityZoneRebalancing</code> value set, Amazon ECS treats this as <code>DISABLED</code>.</p>
+   *             </li>
+   *          </ul>
    * @public
    */
   availabilityZoneRebalancing?: AvailabilityZoneRebalancing | undefined;
@@ -7228,7 +7239,7 @@ export interface ContainerDefinition {
    *          <p>Port mappings on Windows use the <code>NetNAT</code> gateway address rather than
    * 				<code>localhost</code>. There's no loopback for port mappings on Windows, so you
    * 			can't access a container's mapped port from the host itself. </p>
-   *          <p>This parameter maps to <code>PortBindings</code> in the the docker container create
+   *          <p>This parameter maps to <code>PortBindings</code> in the docker container create
    * 			command and the <code>--publish</code> option to docker run. If the network mode of a
    * 			task definition is set to <code>none</code>, then you can't specify port mappings. If
    * 			the network mode of a task definition is set to <code>host</code>, then host ports must

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

@@ -1345,7 +1345,7 @@ export interface RunTaskRequest {
 
   /**
    * <p>The details of the volume that was <code>configuredAtLaunch</code>. You can configure
-   * 			the size, volumeType, IOPS, throughput, snapshot and encryption in in <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskManagedEBSVolumeConfiguration.html">TaskManagedEBSVolumeConfiguration</a>. The <code>name</code> of the volume must
+   * 			the size, volumeType, IOPS, throughput, snapshot and encryption in <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskManagedEBSVolumeConfiguration.html">TaskManagedEBSVolumeConfiguration</a>. The <code>name</code> of the volume must
    * 			match the <code>name</code> from the task definition.</p>
    * @public
    */
@@ -2427,6 +2427,15 @@ export interface UpdateServiceRequest {
    * 			the <i>
    *                <i>Amazon Elastic Container Service Developer Guide</i>
    *             </i>.</p>
+   *          <p>The default behavior of <code>AvailabilityZoneRebalancing</code> differs between create and update requests:</p>
+   *          <ul>
+   *             <li>
+   *                <p>For create service requests, when no value is specified for <code>AvailabilityZoneRebalancing</code>, Amazon ECS defaults the value to <code>ENABLED</code>.</p>
+   *             </li>
+   *             <li>
+   *                <p>For update service requests, when no value is specified for <code>AvailabilityZoneRebalancing</code>, Amazon ECS defaults to the existing service’s <code>AvailabilityZoneRebalancing</code> value. If the service never had an <code>AvailabilityZoneRebalancing</code> value set, Amazon ECS treats this as <code>DISABLED</code>.</p>
+   *             </li>
+   *          </ul>
    *          <p>This parameter doesn't trigger a new service deployment.</p>
    * @public
    */
@@ -2495,6 +2504,7 @@ export interface UpdateServiceRequest {
    * 			During that time, the Amazon ECS service scheduler ignores health check status. This grace
    * 			period can prevent the service scheduler from marking tasks as unhealthy and stopping
    * 			them before they have time to come up.</p>
+   *          <p>If your service has more running tasks than desired, unhealthy tasks in the grace period might be stopped to reach the desired count.</p>
    *          <p>This parameter doesn't trigger a new service deployment.</p>
    * @public
    */