Skip to content

Commit 59ef177

Browse files
author
awstools
committed
feat(client-ecs): This release removes hookDetails for the Amazon ECS native blue/green deployments.
1 parent 7061230 commit 59ef177

File tree

8 files changed

+76
-225
lines changed

8 files changed

+76
-225
lines changed

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,10 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
7575
* <ul>
7676
* <li>
7777
* <p>ECS</p>
78-
* <p>When you create a service which uses the <code>ECS</code> deployment controller, you can choose between the following deployment strategies:</p>
78+
* <p> When you create a service which uses the <code>ECS</code> deployment controller, you can
79+
* choose between the following deployment strategies (which you can set in the
80+
* “<code>strategy</code>” field in “<code>deploymentConfiguration</code>”):
81+
* :</p>
7982
* <ul>
8083
* <li>
8184
* <p>
@@ -250,7 +253,6 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
250253
* lifecycleStages: [ // DeploymentLifecycleHookStageList
251254
* "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
252255
* ],
253-
* hookDetails: "DOCUMENT_VALUE",
254256
* },
255257
* ],
256258
* },
@@ -443,7 +445,6 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
443445
* // lifecycleStages: [ // DeploymentLifecycleHookStageList
444446
* // "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
445447
* // ],
446-
* // hookDetails: "DOCUMENT_VALUE",
447448
* // },
448449
* // ],
449450
* // },

‎clients/client-ecs/src/commands/DeleteServiceCommand.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,6 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
127127
* // lifecycleStages: [ // DeploymentLifecycleHookStageList
128128
* // "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
129129
* // ],
130-
* // hookDetails: "DOCUMENT_VALUE",
131130
* // },
132131
* // ],
133132
* // },

‎clients/client-ecs/src/commands/DescribeServiceDeploymentsCommand.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,6 @@ export interface DescribeServiceDeploymentsCommandOutput extends DescribeService
9595
* // lifecycleStages: [ // DeploymentLifecycleHookStageList
9696
* // "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
9797
* // ],
98-
* // hookDetails: "DOCUMENT_VALUE",
9998
* // },
10099
* // ],
101100
* // },

‎clients/client-ecs/src/commands/DescribeServicesCommand.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,6 @@ export interface DescribeServicesCommandOutput extends DescribeServicesResponse,
112112
* // lifecycleStages: [ // DeploymentLifecycleHookStageList
113113
* // "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
114114
* // ],
115-
* // hookDetails: "DOCUMENT_VALUE",
116115
* // },
117116
* // ],
118117
* // },

‎clients/client-ecs/src/commands/UpdateServiceCommand.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,6 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
186186
* lifecycleStages: [ // DeploymentLifecycleHookStageList
187187
* "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
188188
* ],
189-
* hookDetails: "DOCUMENT_VALUE",
190189
* },
191190
* ],
192191
* },
@@ -397,7 +396,6 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
397396
* // lifecycleStages: [ // DeploymentLifecycleHookStageList
398397
* // "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
399398
* // ],
400-
* // hookDetails: "DOCUMENT_VALUE",
401399
* // },
402400
* // ],
403401
* // },

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

Lines changed: 47 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
// smithy-typescript generated code
22
import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client";
33

4-
import { DocumentType as __DocumentType } from "@smithy/types";
5-
64
import { ECSServiceException as __BaseException } from "./ECSServiceException";
75

86
/**
@@ -34,19 +32,21 @@ export class AccessDeniedException extends __BaseException {
3432
*/
3533
export interface AdvancedConfiguration {
3634
/**
37-
* <p>The Amazon Resource Name (ARN) of the alternate target group for Amazon ECS blue/green deployments. </p>
35+
* <p>The Amazon Resource Name (ARN) of the alternate target group for Amazon ECS blue/green deployments.</p>
3836
* @public
3937
*/
4038
alternateTargetGroupArn?: string | undefined;
4139

4240
/**
43-
* <p>The Amazon Resource Name (ARN) that identifies the production listener rule for routing production traffic.</p>
41+
* <p>The Amazon Resource Name (ARN) that that identifies the production listener rule (in the case of an Application Load Balancer) or
42+
* listener (in the case for an Network Load Balancer) for routing production traffic.</p>
4443
* @public
4544
*/
4645
productionListenerRule?: string | undefined;
4746

4847
/**
49-
* <p>The Amazon Resource Name (ARN) that identifies the test listener rule or listener for routing test traffic.</p>
48+
* <p>The Amazon Resource Name (ARN) that identifies ) that identifies the test listener rule (in the case of an Application Load Balancer) or
49+
* listener (in the case for an Network Load Balancer) for routing test traffic.</p>
5050
* @public
5151
*/
5252
testListenerRule?: string | undefined;
@@ -1393,8 +1393,7 @@ export type AvailabilityZoneRebalancing =
13931393
* rollback parameter to have Amazon ECS to roll back your service to the last completed
13941394
* deployment after a failure.</p>
13951395
* <p>You can only use the <code>DeploymentAlarms</code> method to detect failures when the
1396-
* <code>DeploymentController</code> is set to <code>ECS</code> (rolling
1397-
* update).</p>
1396+
* <code>DeploymentController</code> is set to <code>ECS</code>.</p>
13981397
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html">Rolling
13991398
* update</a> in the <i>
14001399
* <i>Amazon Elastic Container Service Developer Guide</i>
@@ -1477,6 +1476,8 @@ export type DeploymentLifecycleHookStage =
14771476

14781477
/**
14791478
* <p>A deployment lifecycle hook runs custom logic at specific stages of the deployment process. Currently, you can use Lambda functions as hook targets.</p>
1479+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-lifecycle-hooks.html">Lifecycle hooks for Amazon ECS service deployments</a> in the <i>
1480+
* Amazon Elastic Container Service Developer Guide</i>.</p>
14801481
* @public
14811482
*/
14821483
export interface DeploymentLifecycleHook {
@@ -1490,7 +1491,7 @@ export interface DeploymentLifecycleHook {
14901491
/**
14911492
* <p>The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call Lambda functions on your behalf.</p>
14921493
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/blue-green-permissions.html">Permissions required
1493-
* for Lambda functions in Amazon ECS blue/green deployments</a> in the<i>
1494+
* for Lambda functions in Amazon ECS blue/green deployments</a> in the <i>
14941495
* Amazon Elastic Container Service Developer Guide</i>.</p>
14951496
* @public
14961497
*/
@@ -1501,7 +1502,7 @@ export interface DeploymentLifecycleHook {
15011502
* <ul>
15021503
* <li>
15031504
* <p>RECONCILE_SERVICE</p>
1504-
* <p>This stage only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.</p>
1505+
* <p>The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.</p>
15051506
* <p>You can use a lifecycle hook for this stage.</p>
15061507
* </li>
15071508
* <li>
@@ -1510,11 +1511,6 @@ export interface DeploymentLifecycleHook {
15101511
* <p>You can use a lifecycle hook for this stage.</p>
15111512
* </li>
15121513
* <li>
1513-
* <p>SCALE_UP</p>
1514-
* <p>The time when the green service revision scales up to 100% and launches new tasks. The green service revision is not serving any traffic at this point.</p>
1515-
* <p>You can't use a lifecycle hook for this stage.</p>
1516-
* </li>
1517-
* <li>
15181514
* <p>POST_SCALE_UP</p>
15191515
* <p>The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.</p>
15201516
* <p>You can use a lifecycle hook for this stage.</p>
@@ -1537,29 +1533,13 @@ export interface DeploymentLifecycleHook {
15371533
* <li>
15381534
* <p>POST_PRODUCTION_TRAFFIC_SHIFT</p>
15391535
* <p>The production traffic shift is complete.</p>
1540-
* <p>Yes</p>
1541-
* </li>
1542-
* <li>
1543-
* <p>BAKE_TIME</p>
1544-
* <p>The duration when both blue and green service revisions are running simultaneously.</p>
1545-
* <p>You can't use a lifecycle hook for this stage.</p>
1546-
* </li>
1547-
* <li>
1548-
* <p>CLEAN_UP</p>
1549-
* <p>The blue service revision has completely scaled down to 0 running tasks. The green service revision is now the production service revision after this stage.</p>
1550-
* <p>You can't use a lifecycle hook for this stage.</p>
1536+
* <p>You can use a lifecycle hook for this stage.</p>
15511537
* </li>
15521538
* </ul>
15531539
* <p>You must provide this parameter when configuring a deployment lifecycle hook.</p>
15541540
* @public
15551541
*/
15561542
lifecycleStages?: DeploymentLifecycleHookStage[] | undefined;
1557-
1558-
/**
1559-
* <p>Optionally provide details about the hook. Use this field to pass custom parameters to your hook target (such as a Lambda function).</p>
1560-
* @public
1561-
*/
1562-
hookDetails?: __DocumentType | undefined;
15631543
}
15641544

15651545
/**
@@ -1747,15 +1727,15 @@ export interface DeploymentConfiguration {
17471727
strategy?: DeploymentStrategy | undefined;
17481728

17491729
/**
1750-
* <p>The duration when both blue and green service revisions are running simultaneously after the production traffic has shifted.</p>
1730+
* <p>The time period when both blue and green service revisions are running simultaneously after the production traffic has shifted.</p>
17511731
* <p>You must provide this parameter when you use the <code>BLUE_GREEN</code> deployment
17521732
* strategy.</p>
17531733
* @public
17541734
*/
17551735
bakeTimeInMinutes?: number | undefined;
17561736

17571737
/**
1758-
* <p>An array of deployment lifecycle hook objects to run custom logic at specific stages of the deployment lifecycle. These hooks allow you to run custom logic at key points during the deployment process.</p>
1738+
* <p>An array of deployment lifecycle hook objects to run custom logic at specific stages of the deployment lifecycle.</p>
17591739
* @public
17601740
*/
17611741
lifecycleHooks?: DeploymentLifecycleHook[] | undefined;
@@ -2496,6 +2476,8 @@ export interface ServiceConnectTestTrafficHeaderMatchRules {
24962476
* <p>The HTTP header rules used to identify and route test traffic during Amazon ECS blue/green
24972477
* deployments. These rules specify which HTTP headers to examine and what values to match for
24982478
* routing decisions.</p>
2479+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect-blue-green.html">Service Connect for Amazon ECS blue/green deployments</a> in the <i>
2480+
* Amazon Elastic Container Service Developer Guide</i>.</p>
24992481
* @public
25002482
*/
25012483
export interface ServiceConnectTestTrafficHeaderRules {
@@ -2517,6 +2499,8 @@ export interface ServiceConnectTestTrafficHeaderRules {
25172499
* configuration allows you to define rules for routing specific traffic to the new service
25182500
* revision during the deployment process, allowing for safe testing before full production
25192501
* traffic shift.</p>
2502+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect-blue-green.html">Service Connect for Amazon ECS blue/green deployments</a> in the <i>
2503+
* Amazon Elastic Container Service Developer Guide</i>.</p>
25202504
* @public
25212505
*/
25222506
export interface ServiceConnectTestTrafficRules {
@@ -9022,24 +9006,44 @@ export interface ServiceDeployment {
90229006
* <p>The current lifecycle stage of the deployment. Possible values include:</p>
90239007
* <ul>
90249008
* <li>
9025-
* <p>
9026-
* <code>SCALE_UP_IN_PROGRESS</code> - Creating the new (green) tasks</p>
9009+
* <p>RECONCILE_SERVICE</p>
9010+
* <p>The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.</p>
90279011
* </li>
90289012
* <li>
9029-
* <p>
9030-
* <code>TEST_TRAFFIC_SHIFT_IN_PROGRESS</code> - Shifting test traffic to the new (green) tasks</p>
9013+
* <p>PRE_SCALE_UP</p>
9014+
* <p>The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.</p>
90319015
* </li>
90329016
* <li>
9033-
* <p>
9034-
* <code>PRODUCTION_TRAFFIC_SHIFT_IN_PROGRESS</code> - Shifting production traffic to the new (green) tasks</p>
9017+
* <p>SCALE_UP</p>
9018+
* <p>The stage when the green service revision scales up to 100% and launches new tasks. The green service revision is not serving any traffic at this point.</p>
90359019
* </li>
90369020
* <li>
9037-
* <p>
9038-
* <code>BAKE_TIME_IN_PROGRESS</code> - The duration when both blue and green service revisions are running simultaneously after the production traffic has shifted</p>
9021+
* <p>POST_SCALE_UP</p>
9022+
* <p>The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.</p>
90399023
* </li>
90409024
* <li>
9041-
* <p>
9042-
* <code>CLEAN_UP_IN_PROGRESS</code> - Stopping the old (blue) tasks</p>
9025+
* <p>TEST_TRAFFIC_SHIFT</p>
9026+
* <p>The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.</p>
9027+
* </li>
9028+
* <li>
9029+
* <p>POST_TEST_TRAFFIC_SHIFT</p>
9030+
* <p>The test traffic shift is complete. The green service revision handles 100% of the test traffic.</p>
9031+
* </li>
9032+
* <li>
9033+
* <p>PRODUCTION_TRAFFIC_SHIFT</p>
9034+
* <p>Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.</p>
9035+
* </li>
9036+
* <li>
9037+
* <p>POST_PRODUCTION_TRAFFIC_SHIFT</p>
9038+
* <p>The production traffic shift is complete.</p>
9039+
* </li>
9040+
* <li>
9041+
* <p>BAKE_TIME</p>
9042+
* <p>The stage when both blue and green service revisions are running simultaneously after the production traffic has shifted.</p>
9043+
* </li>
9044+
* <li>
9045+
* <p>CLEAN_UP</p>
9046+
* <p>The stage when the blue service revision has completely scaled down to 0 running tasks. The green service revision is now the production service revision after this stage.</p>
90439047
* </li>
90449048
* </ul>
90459049
* @public

0 commit comments

Comments
 (0)