@aws-sdk/client-ecs 3.744.0 → 3.748.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -575,11 +575,13 @@ export interface ExecuteCommandConfiguration {
575
575
  export interface ManagedStorageConfiguration {
576
576
  /**
577
577
  * <p>Specify a Key Management Service key ID to encrypt the managed storage.</p>
578
+ * <p>The key must be a single Region key.</p>
578
579
  * @public
579
580
  */
580
581
  kmsKeyId?: string | undefined;
581
582
  /**
582
583
  * <p>Specify the Key Management Service key ID for the Fargate ephemeral storage.</p>
584
+ * <p>The key must be a single Region key.</p>
583
585
  * @public
584
586
  */
585
587
  fargateEphemeralStorageKmsKeyId?: string | undefined;
@@ -2556,7 +2558,9 @@ export interface CreateServiceRequest {
2556
2558
  /**
2557
2559
  * <p>Indicates whether to use Availability Zone rebalancing for the service.</p>
2558
2560
  * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html">Balancing an Amazon ECS service across Availability Zones</a> in
2559
- * the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
2561
+ * the <i>
2562
+ * <i>Amazon Elastic Container Service Developer Guide</i>
2563
+ * </i>.</p>
2560
2564
  * @public
2561
2565
  */
2562
2566
  availabilityZoneRebalancing?: AvailabilityZoneRebalancing | undefined;
@@ -3619,7 +3623,9 @@ export interface Service {
3619
3623
  /**
3620
3624
  * <p>Indicates whether to use Availability Zone rebalancing for the service.</p>
3621
3625
  * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html">Balancing an Amazon ECS service across Availability Zones</a> in
3622
- * the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
3626
+ * the <i>
3627
+ * <i>Amazon Elastic Container Service Developer Guide</i>
3628
+ * </i>.</p>
3623
3629
  * @public
3624
3630
  */
3625
3631
  availabilityZoneRebalancing?: AvailabilityZoneRebalancing | undefined;
@@ -4552,6 +4558,7 @@ export interface FirelensConfiguration {
4552
4558
  * that's configured to use a Classic Load Balancer.</p>
4553
4559
  * </li>
4554
4560
  * </ul>
4561
+ * <p>For an example of how to specify a task definition with multiple containers where container dependency is specified, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/example_task_definitions.html#example_task_definition-containerdependency">Container dependency</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
4555
4562
  * @public
4556
4563
  */
4557
4564
  export interface HealthCheck {
@@ -4576,28 +4583,31 @@ export interface HealthCheck {
4576
4583
  */
4577
4584
  command: string[] | undefined;
4578
4585
  /**
4579
- * <p>The time period in seconds between each health check execution. You may specify
4580
- * between 5 and 300 seconds. The default value is 30 seconds.</p>
4586
+ * <p>The time period in seconds between each health check execution. You may specify between 5
4587
+ * and 300 seconds. The default value is 30 seconds. This value applies only when you
4588
+ * specify a <code>command</code>. </p>
4581
4589
  * @public
4582
4590
  */
4583
4591
  interval?: number | undefined;
4584
4592
  /**
4585
- * <p>The time period in seconds to wait for a health check to succeed before it is
4586
- * considered a failure. You may specify between 2 and 60 seconds. The default value is
4587
- * 5.</p>
4593
+ * <p>The time period in seconds to wait for a health check to succeed before it is considered a
4594
+ * failure. You may specify between 2 and 60 seconds. The default value is 5. This value
4595
+ * applies only when you specify a <code>command</code>. </p>
4588
4596
  * @public
4589
4597
  */
4590
4598
  timeout?: number | undefined;
4591
4599
  /**
4592
4600
  * <p>The number of times to retry a failed health check before the container is considered
4593
- * unhealthy. You may specify between 1 and 10 retries. The default value is 3.</p>
4601
+ * unhealthy. You may specify between 1 and 10 retries. The default value is 3. This value
4602
+ * applies only when you specify a <code>command</code>. </p>
4594
4603
  * @public
4595
4604
  */
4596
4605
  retries?: number | undefined;
4597
4606
  /**
4598
4607
  * <p>The optional grace period to provide containers time to bootstrap before failed health
4599
4608
  * checks count towards the maximum number of retries. You can specify between 0 and 300
4600
- * seconds. By default, the <code>startPeriod</code> is off.</p>
4609
+ * seconds. By default, the <code>startPeriod</code> is off. This value applies only when
4610
+ * you specify a <code>command</code>. </p>
4601
4611
  * <note>
4602
4612
  * <p>If a health check succeeds within the <code>startPeriod</code>, then the container
4603
4613
  * is considered healthy and any subsequent failures count toward the maximum number of
@@ -4611,6 +4621,35 @@ export interface HealthCheck {
4611
4621
  * <p>The Linux capabilities to add or remove from the default Docker configuration for a
4612
4622
  * container defined in the task definition. For more detailed information about these
4613
4623
  * Linux capabilities, see the <a href="http://man7.org/linux/man-pages/man7/capabilities.7.html">capabilities(7)</a> Linux manual page.</p>
4624
+ * <p>The following describes how Docker processes the Linux capabilities specified in the <code>add</code> and
4625
+ * <code>drop</code> request parameters. For information about the latest behavior, see
4626
+ * <a href="https://forums.docker.com/t/docker-compose-order-of-cap-drop-and-cap-add/97136/1">Docker Compose: order of cap_drop and cap_add</a> in the Docker Community Forum.</p>
4627
+ * <ul>
4628
+ * <li>
4629
+ * <p>When the container is a privleged container, the container capabilities are all of the
4630
+ * default Docker capabilities. The capabilities specified in the <code>add</code>
4631
+ * request parameter, and the <code>drop</code> request parameter are
4632
+ * ignored.</p>
4633
+ * </li>
4634
+ * <li>
4635
+ * <p>When the <code>add</code> request parameter is set to ALL, the container
4636
+ * capabilities are all of the default Docker capabilities, excluding those
4637
+ * specified in the <code>drop</code> request parameter.</p>
4638
+ * </li>
4639
+ * <li>
4640
+ * <p>When the <code>drop</code> request parameter is set to ALL, the container capabilities are
4641
+ * the capabilities specified in the <code>add</code> request parameter.</p>
4642
+ * </li>
4643
+ * <li>
4644
+ * <p>When the <code>add</code> request parameter and the <code>drop</code> request parameter are both empty, the capabilities the container
4645
+ * capabilities are all of the default Docker capabilities.</p>
4646
+ * </li>
4647
+ * <li>
4648
+ * <p>The default is to first drop the capabilities specified in the <code>drop</code> request
4649
+ * parameter, and then add the capabilities specified in the <code>add</code>
4650
+ * request parameter.</p>
4651
+ * </li>
4652
+ * </ul>
4614
4653
  * @public
4615
4654
  */
4616
4655
  export interface KernelCapabilities {
@@ -11677,7 +11716,7 @@ export interface StopTaskRequest {
11677
11716
  */
11678
11717
  cluster?: string | undefined;
11679
11718
  /**
11680
- * <p>The task ID of the task to stop.</p>
11719
+ * <p>Thefull Amazon Resource Name (ARN) of the task.</p>
11681
11720
  * @public
11682
11721
  */
11683
11722
  task: string | undefined;
@@ -11938,6 +11977,17 @@ export interface TagResourceRequest {
11938
11977
  * <p>The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are
11939
11978
  * Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container
11940
11979
  * instances.</p>
11980
+ * <p>In order to tag a service that has the following ARN format, you need to migrate the
11981
+ * service to the long ARN. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-arn-migration.html">Migrate an Amazon ECS short service ARN to a long ARN</a> in the <i>Amazon Elastic Container Service
11982
+ * Developer Guide</i>.</p>
11983
+ * <p>
11984
+ * <code>arn:aws:ecs:region:aws_account_id:service/service-name</code>
11985
+ * </p>
11986
+ * <p>After the migration is complete, the service has the long ARN format, as shown below. Use this ARN to tag the service.</p>
11987
+ * <p>
11988
+ * <code>arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name</code>
11989
+ * </p>
11990
+ * <p>If you try to tag a service with a short ARN, you receive an <code>InvalidParameterException</code> error.</p>
11941
11991
  * @public
11942
11992
  */
11943
11993
  resourceArn: string | undefined;
@@ -301,7 +301,9 @@ export interface UpdateServiceRequest {
301
301
  /**
302
302
  * <p>Indicates whether to use Availability Zone rebalancing for the service.</p>
303
303
  * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html">Balancing an Amazon ECS service across Availability Zones</a> in
304
- * the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
304
+ * the <i>
305
+ * <i>Amazon Elastic Container Service Developer Guide</i>
306
+ * </i>.</p>
305
307
  * @public
306
308
  */
307
309
  availabilityZoneRebalancing?: AvailabilityZoneRebalancing | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-ecs",
3
3
  "description": "AWS SDK for JavaScript Ecs Client for Node.js, Browser and React Native",
4
- "version": "3.744.0",
4
+ "version": "3.748.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-ecs",