Skip to content

Commit 2ccda78

Browse files
author
awstools
committed
docs(client-ecs): This is a documentation only release that adds additional information for the update-service request parameters.
1 parent 9341cdc commit 2ccda78

File tree

2 files changed

+68
-18
lines changed

2 files changed

+68
-18
lines changed

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

Lines changed: 50 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -161,10 +161,6 @@ export interface ManagedScaling {
161161
* value of <code>1</code> is used.</p>
162162
* <p>When additional capacity is required, Amazon ECS will scale up the minimum scaling step
163163
* size even if the actual demand is less than the minimum scaling step size.</p>
164-
* <p>If you use a capacity provider with an Auto Scaling group configured with more than
165-
* one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum
166-
* scaling step size value and will ignore both the maximum scaling step size as well as
167-
* the capacity demand.</p>
168164
* @public
169165
*/
170166
minimumScalingStepSize?: number | undefined;
@@ -774,7 +770,7 @@ export interface CapacityProviderStrategyItem {
774770
/**
775771
* <p>The <i>weight</i> value designates the relative percentage of the total
776772
* number of tasks launched that should use the specified capacity provider. The
777-
* <code>weight</code> value is taken into consideration after the <code>base</code>
773+
* <code>weight</code> value is taken into consideration after the <code>base</code>
778774
* value, if defined, is satisfied.</p>
779775
* <p>If no <code>weight</code> value is specified, the default value of <code>0</code> is
780776
* used. When multiple capacity providers are specified within a capacity provider
@@ -783,23 +779,60 @@ export interface CapacityProviderStrategyItem {
783779
* tasks. If you specify multiple capacity providers in a strategy that all have a weight
784780
* of <code>0</code>, any <code>RunTask</code> or <code>CreateService</code> actions using
785781
* the capacity provider strategy will fail.</p>
786-
* <p>An example scenario for using weights is defining a strategy that contains two
787-
* capacity providers and both have a weight of <code>1</code>, then when the
788-
* <code>base</code> is satisfied, the tasks will be split evenly across the two
789-
* capacity providers. Using that same logic, if you specify a weight of <code>1</code> for
790-
* <i>capacityProviderA</i> and a weight of <code>4</code> for
791-
* <i>capacityProviderB</i>, then for every one task that's run using
792-
* <i>capacityProviderA</i>, four tasks would use
793-
* <i>capacityProviderB</i>.</p>
782+
* <p>Weight value characteristics:</p>
783+
* <ul>
784+
* <li>
785+
* <p>Weight is considered after the base value is satisfied</p>
786+
* </li>
787+
* <li>
788+
* <p>Default value is <code>0</code> if not specified</p>
789+
* </li>
790+
* <li>
791+
* <p>Valid range: 0 to 1,000</p>
792+
* </li>
793+
* <li>
794+
* <p>At least one capacity provider must have a weight greater than zero</p>
795+
* </li>
796+
* <li>
797+
* <p>Capacity providers with weight of <code>0</code> cannot place tasks</p>
798+
* </li>
799+
* </ul>
800+
* <p>Task distribution logic:</p>
801+
* <ol>
802+
* <li>
803+
* <p>Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider</p>
804+
* </li>
805+
* <li>
806+
* <p>Weight distribution: After base requirements are met, additional tasks are distributed according to weight ratios</p>
807+
* </li>
808+
* </ol>
809+
* <p>Examples:</p>
810+
* <p>Equal Distribution: Two capacity providers both with weight <code>1</code> will split tasks evenly after base requirements are met.</p>
811+
* <p>Weighted Distribution: If capacityProviderA has weight <code>1</code> and capacityProviderB has weight <code>4</code>, then for every 1 task on A, 4 tasks will run on B.</p>
794812
* @public
795813
*/
796814
weight?: number | undefined;
797815

798816
/**
799817
* <p>The <i>base</i> value designates how many tasks, at a minimum, to run on
800-
* the specified capacity provider. Only one capacity provider in a capacity provider
818+
* the specified capacity provider for each service. Only one capacity provider in a capacity provider
801819
* strategy can have a <i>base</i> defined. If no value is specified, the
802820
* default value of <code>0</code> is used.</p>
821+
* <p>Base value characteristics:</p>
822+
* <ul>
823+
* <li>
824+
* <p>Only one capacity provider in a strategy can have a base defined</p>
825+
* </li>
826+
* <li>
827+
* <p>Default value is <code>0</code> if not specified</p>
828+
* </li>
829+
* <li>
830+
* <p>Valid range: 0 to 100,000</p>
831+
* </li>
832+
* <li>
833+
* <p>Base requirements are satisfied first before weight distribution</p>
834+
* </li>
835+
* </ul>
803836
* @public
804837
*/
805838
base?: number | undefined;
@@ -1175,7 +1208,7 @@ export interface Cluster {
11751208

11761209
/**
11771210
* <p>The number of services that are running on the cluster in an <code>ACTIVE</code>
1178-
* state. You can view these services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">PListServices</a>.</p>
1211+
* state. You can view these services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>.</p>
11791212
* @public
11801213
*/
11811214
activeServicesCount?: number | undefined;
@@ -2412,7 +2445,7 @@ export interface LogConfiguration {
24122445
* <dt>max-buffer-size</dt>
24132446
* <dd>
24142447
* <p>Required: No</p>
2415-
* <p>Default value: <code>1m</code>
2448+
* <p>Default value: <code>10m</code>
24162449
* </p>
24172450
* <p>When <code>non-blocking</code> mode is used, the
24182451
* <code>max-buffer-size</code> log option controls the size of the buffer
@@ -9484,8 +9517,7 @@ export type TaskField = (typeof TaskField)[keyof typeof TaskField];
94849517
export interface DescribeTasksRequest {
94859518
/**
94869519
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to
9487-
* describe. If you do not specify a cluster, the default cluster is assumed. If you do not specify a
9488-
* value, the <code>default</code> cluster is used.</p>
9520+
* describe. If you do not specify a cluster, the default cluster is assumed.</p>
94899521
* @public
94909522
*/
94919523
cluster?: string | undefined;

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -701,6 +701,7 @@ export interface UpdateServiceRequest {
701701
/**
702702
* <p>The number of instantiations of the task to place and keep running in your
703703
* service.</p>
704+
* <p>This parameter doesn't trigger a new service deployment.</p>
704705
* @public
705706
*/
706707
desiredCount?: number | undefined;
@@ -711,6 +712,7 @@ export interface UpdateServiceRequest {
711712
* not specified, the latest <code>ACTIVE</code> revision is used. If you modify the task
712713
* definition with <code>UpdateService</code>, Amazon ECS spawns a task with the new version of
713714
* the task definition and then stops an old task after the new version is running.</p>
715+
* <p>This parameter triggers a new service deployment.</p>
714716
* @public
715717
*/
716718
taskDefinition?: string | undefined;
@@ -743,13 +745,15 @@ export interface UpdateServiceRequest {
743745
* </li>
744746
* </ul>
745747
* <p>For information about Amazon Web Services CDK considerations, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-parameters.html">Amazon Web Services CDK considerations</a>.</p>
748+
* <p>This parameter doesn't trigger a new service deployment.</p>
746749
* @public
747750
*/
748751
capacityProviderStrategy?: CapacityProviderStrategyItem[] | undefined;
749752

750753
/**
751754
* <p>Optional deployment parameters that control how many tasks run during the deployment
752755
* and the ordering of stopping and starting tasks.</p>
756+
* <p>This parameter doesn't trigger a new service deployment.</p>
753757
* @public
754758
*/
755759
deploymentConfiguration?: DeploymentConfiguration | undefined;
@@ -760,12 +764,14 @@ export interface UpdateServiceRequest {
760764
* the <i>
761765
* <i>Amazon Elastic Container Service Developer Guide</i>
762766
* </i>.</p>
767+
* <p>This parameter doesn't trigger a new service deployment.</p>
763768
* @public
764769
*/
765770
availabilityZoneRebalancing?: AvailabilityZoneRebalancing | undefined;
766771

767772
/**
768773
* <p>An object representing the network configuration for the service.</p>
774+
* <p>This parameter triggers a new service deployment.</p>
769775
* @public
770776
*/
771777
networkConfiguration?: NetworkConfiguration | undefined;
@@ -778,6 +784,7 @@ export interface UpdateServiceRequest {
778784
* specify an empty array.</p>
779785
* <p>You can specify a maximum of 10 constraints for each task. This limit includes
780786
* constraints in the task definition and those specified at runtime.</p>
787+
* <p>This parameter doesn't trigger a new service deployment.</p>
781788
* @public
782789
*/
783790
placementConstraints?: PlacementConstraint[] | undefined;
@@ -788,6 +795,7 @@ export interface UpdateServiceRequest {
788795
* this value is specified, it will override the existing placement strategy defined for
789796
* the service. To remove an existing placement strategy, specify an empty object.</p>
790797
* <p>You can specify a maximum of five strategy rules for each service.</p>
798+
* <p>This parameter doesn't trigger a new service deployment.</p>
791799
* @public
792800
*/
793801
placementStrategy?: PlacementStrategy[] | undefined;
@@ -798,6 +806,7 @@ export interface UpdateServiceRequest {
798806
* is not specified, the <code>LATEST</code> platform version is used. For more
799807
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate Platform
800808
* Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
809+
* <p>This parameter triggers a new service deployment.</p>
801810
* @public
802811
*/
803812
platformVersion?: string | undefined;
@@ -823,6 +832,7 @@ export interface UpdateServiceRequest {
823832
* During that time, the Amazon ECS service scheduler ignores health check status. This grace
824833
* period can prevent the service scheduler from marking tasks as unhealthy and stopping
825834
* them before they have time to come up.</p>
835+
* <p>This parameter doesn't trigger a new service deployment.</p>
826836
* @public
827837
*/
828838
healthCheckGracePeriodSeconds?: number | undefined;
@@ -838,6 +848,7 @@ export interface UpdateServiceRequest {
838848
* containers.</p>
839849
* <p>If you do not want to override the value that was set when the service was created,
840850
* you can set this to <code>null</code> when performing this action.</p>
851+
* <p>This parameter doesn't trigger a new service deployment.</p>
841852
* @public
842853
*/
843854
enableExecuteCommand?: boolean | undefined;
@@ -849,6 +860,7 @@ export interface UpdateServiceRequest {
849860
* <p>Only tasks launched after the update will reflect the update. To update the tags on
850861
* all tasks, set <code>forceNewDeployment</code> to <code>true</code>, so that Amazon ECS
851862
* starts new tasks with the updated tags.</p>
863+
* <p>This parameter doesn't trigger a new service deployment.</p>
852864
* @public
853865
*/
854866
enableECSManagedTags?: boolean | undefined;
@@ -878,6 +890,7 @@ export interface UpdateServiceRequest {
878890
* information see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html">Register
879891
* multiple target groups with a service</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. </p>
880892
* <p>You can remove existing <code>loadBalancers</code> by passing an empty list.</p>
893+
* <p>This parameter triggers a new service deployment.</p>
881894
* @public
882895
*/
883896
loadBalancers?: LoadBalancer[] | undefined;
@@ -888,6 +901,7 @@ export interface UpdateServiceRequest {
888901
* <p>Only tasks launched after the update will reflect the update. To update the tags on
889902
* all tasks, set <code>forceNewDeployment</code> to <code>true</code>, so that Amazon ECS
890903
* starts new tasks with the updated tags.</p>
904+
* <p>This parameter doesn't trigger a new service deployment.</p>
891905
* @public
892906
*/
893907
propagateTags?: PropagateTags | undefined;
@@ -908,6 +922,7 @@ export interface UpdateServiceRequest {
908922
* when the new tasks are running.</p>
909923
* <p>You can remove existing <code>serviceRegistries</code> by passing an empty
910924
* list.</p>
925+
* <p>This parameter triggers a new service deployment.</p>
911926
* @public
912927
*/
913928
serviceRegistries?: ServiceRegistry[] | undefined;
@@ -921,6 +936,7 @@ export interface UpdateServiceRequest {
921936
* that collects logs and metrics for increased visibility.
922937
* Only the tasks that Amazon ECS services create are supported with Service Connect.
923938
* For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html">Service Connect</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
939+
* <p>This parameter triggers a new service deployment.</p>
924940
* @public
925941
*/
926942
serviceConnectConfiguration?: ServiceConnectConfiguration | undefined;
@@ -931,13 +947,15 @@ export interface UpdateServiceRequest {
931947
* must match the <code>name</code> from the task definition. If set to null, no new
932948
* deployment is triggered. Otherwise, if this configuration differs from the existing one,
933949
* it triggers a new deployment.</p>
950+
* <p>This parameter triggers a new service deployment.</p>
934951
* @public
935952
*/
936953
volumeConfigurations?: ServiceVolumeConfiguration[] | undefined;
937954

938955
/**
939956
* <p>An object representing the VPC Lattice configuration for the service being
940957
* updated.</p>
958+
* <p>This parameter triggers a new service deployment.</p>
941959
* @public
942960
*/
943961
vpcLatticeConfigurations?: VpcLatticeConfiguration[] | undefined;

0 commit comments

Comments
 (0)