Skip to content

Commit bd3c41a

Browse files
author
awstools
committed
docs(client-ecs): Documentation-only update for LINEAR and CANARY deployment strategies.
1 parent f263170 commit bd3c41a

File tree

3 files changed

+35
-23
lines changed

3 files changed

+35
-23
lines changed

clients/client-ecs/src/commands/CreateServiceCommand.ts

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -181,10 +181,9 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
181181
* <code>LINEAR</code>: A <i>linear</i> deployment strategy
182182
* (<code>LINEAR</code>) gradually shifts traffic from the current
183183
* production environment to a new environment in equal percentage
184-
* increments over a specified time period. With Amazon ECS linear
185-
* deployments, you can control the pace of traffic shifting and validate
186-
* new service revisions with increasing amounts of production
187-
* traffic.</p>
184+
* increments. With Amazon ECS linear deployments, you can control the pace
185+
* of traffic shifting and validate new service revisions with increasing
186+
* amounts of production traffic.</p>
188187
* <p>Linear deployments are best suited for the following scenarios:</p>
189188
* <ul>
190189
* <li>
@@ -201,7 +200,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
201200
* </li>
202201
* <li>
203202
* <p>Load balancer requirement: When your service uses Application
204-
* Load Balancer, Network Load Balancer, or Service Connect</p>
203+
* Load Balancer or Service Connect</p>
205204
* </li>
206205
* </ul>
207206
* </li>
@@ -228,7 +227,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
228227
* </li>
229228
* <li>
230229
* <p>Load balancer requirement: When your service uses Application
231-
* Load Balancer, Network Load Balancer, or Service Connect</p>
230+
* Load Balancer or Service Connect</p>
232231
* </li>
233232
* </ul>
234233
* </li>

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

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2324,8 +2324,8 @@ export interface DeploymentAlarms {
23242324
}
23252325

23262326
/**
2327-
* <p>Configuration for canary deployment strategy that shifts a fixed percentage of traffic
2328-
* to the new service revision, waits for a specified bake time, then shifts the remaining
2327+
* <p>Configuration for a canary deployment strategy that shifts a fixed percentage of traffic to
2328+
* the new service revision, waits for a specified bake time, then shifts the remaining
23292329
* traffic. </p>
23302330
* <p>This is only valid when you run <code>CreateService</code> or
23312331
* <code>UpdateService</code> with <code>deploymentController</code> set to
@@ -2335,8 +2335,7 @@ export interface DeploymentAlarms {
23352335
*/
23362336
export interface CanaryConfiguration {
23372337
/**
2338-
* <p>The percentage of production traffic to shift to the new service revision during the
2339-
* canary phase. Valid values are 0.1 to 100.0. The default value is 5.0.</p>
2338+
* <p>The percentage of production traffic to shift to the new service revision during the canary phase. Valid values are multiples of 0.1 from 0.1 to 100.0. The default value is 5.0.</p>
23402339
* @public
23412340
*/
23422341
canaryPercent?: number | undefined;
@@ -2489,16 +2488,14 @@ export interface DeploymentLifecycleHook {
24892488
*/
24902489
export interface LinearConfiguration {
24912490
/**
2492-
* <p>The percentage of production traffic to shift in each step during a linear deployment.
2493-
* Valid values are 3.0 to 100.0. The default value is 10.0.</p>
2491+
* <p>The percentage of production traffic to shift in each step during a linear deployment. Valid
2492+
* values are multiples of 0.1 from 3.0 to 100.0. The default value is 10.0.</p>
24942493
* @public
24952494
*/
24962495
stepPercent?: number | undefined;
24972496

24982497
/**
2499-
* <p>The amount of time in minutes to wait between each traffic shifting step during a
2500-
* linear deployment. Valid values are 0 to 1440 minutes (24 hours). The default value is
2501-
* 6. This bake time is not applied after reaching 100% traffic.</p>
2498+
* <p>The amount of time in minutes to wait between each traffic shifting step during a linear deployment. Valid values are 0 to 1440 minutes (24 hours). The default value is 6. This bake time is not applied after reaching 100 percent traffic.</p>
25022499
* @public
25032500
*/
25042501
stepBakeTimeInMinutes?: number | undefined;
@@ -2686,6 +2683,22 @@ export interface DeploymentConfiguration {
26862683
* production traffic to them. This approach provides a safer way to deploy changes with
26872684
* the ability to quickly roll back if needed.</p>
26882685
* </li>
2686+
* <li>
2687+
* <p>
2688+
* <code>LINEAR</code> - A <i>linear</i> deployment strategy
2689+
* (<code>LINEAR</code>) gradually shifts traffic from the current production
2690+
* environment to a new environment in equal percentages over time. With Amazon ECS linear
2691+
* deployments, you can control the pace of traffic shifting and validate new service
2692+
* revisions with increasing amounts of production traffic.</p>
2693+
* </li>
2694+
* <li>
2695+
* <p>
2696+
* <code>CANARY</code> - A <i>canary</i> deployment strategy
2697+
* (<code>CANARY</code>) shifts a small percentage of traffic to the new service
2698+
* revision first, then shifts the remaining traffic all at once after a specified
2699+
* time period. This allows you to test the new version with a subset of users before
2700+
* full deployment.</p>
2701+
* </li>
26892702
* </ul>
26902703
* @public
26912704
*/
@@ -2992,7 +3005,7 @@ export interface AwsVpcConfiguration {
29923005
* <ul>
29933006
* <li>
29943007
* <p>When you use <code>create-service</code> or <code>update-service</code>, the
2995-
* The default is <code>DISABLED</code>. </p>
3008+
* default is <code>DISABLED</code>. </p>
29963009
* </li>
29973010
* <li>
29983011
* <p>When the service <code>deploymentController</code> is <code>ECS</code>, the

0 commit comments

Comments
 (0)