aws-sdk-ecs 1.126.0 → 1.127.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51b258bd6d7e20038a798090223de8f77ab8e5fe1d6cd10f474c570f0dbf0535
-  data.tar.gz: 735e186b6140b57f10be602091e845a925af78e5f5ee913c4af7f752f4d8f2b9
+  metadata.gz: be19bad5e5c9a653ec7741bc5504596fba18fa3412aadc1bc9c221d03d024ce8
+  data.tar.gz: c46d0060da3110f6fda12a3c39763f2a9e2751beb8738b6cd550bfd00d6de7a0
 SHA512:
-  metadata.gz: db7ebb7443c6a2557d3261f0a6326bb2a98cc7b46c659db03a33a40c21246bd008e962607c244078b4f6e59fb8a201eb524aef40985918e87becff30650e817a
-  data.tar.gz: dea09257f059d88f7199457973dde97ee5da08eb1c2e1c8c39acb0560e9e905ddfee742f0eea5c8046e1d37b52a8ebb256088d2b389d2c456d0298222aadb7a3
+  metadata.gz: c6345f4afabbd40bb6683b5e43370c94510720f9a6d30aa02ab048d18b42bc382375d3fb23bd56eed442ba6647110ae163075e2ffb9b93e3aab08cfc31670afb
+  data.tar.gz: 406c373f515f15827e31d4a47121f41f3a9dbb6dab4a6683decd3b28af6950205bf0ee240df6dccc03738551473099f46061fc9365ebef5905d65ffa5bef804a

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.127.0 (2023-08-04)
+------------------
+
+* Feature - This is a documentation update to address various tickets.
+
 1.126.0 (2023-07-11)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.126.0
+1.127.0

data/lib/aws-sdk-ecs/client.rb

@@ -1635,7 +1635,8 @@ module Aws::ECS
     #   value.
     #
     # @option params [required, String] :task_definition
-    #   The task definition for the tasks in the task set to use.
+    #   The task definition for the tasks in the task set to use. If a
+    #   revision isn't specified, the latest `ACTIVE` revision is used.
     #
     # @option params [Types::NetworkConfiguration] :network_configuration
     #   An object representing the network configuration for a task set.
@@ -4061,6 +4062,11 @@ module Aws::ECS
     # Currently, stopped tasks appear in the returned results for at least
     # one hour.
     #
+    # If you have tasks with tags, and then delete the cluster, the tagged
+    # tasks are returned in the response. If you create a new cluster with
+    # the same name as the deleted cluster, the tagged tasks are not
+    # included in the response.
+    #
     # @option params [String] :cluster
     #   The short name or full Amazon Resource Name (ARN) of the cluster that
     #   hosts the task or tasks to describe. If you do not specify a cluster,
@@ -5303,8 +5309,6 @@ module Aws::ECS
     # started the task, or by the desired status of the task.
     #
     # Recently stopped tasks might appear in the returned results.
-    # Currently, stopped tasks appear in the returned results for at least
-    # one hour.
     #
     # @option params [String] :cluster
     #   The short name or full Amazon Resource Name (ARN) of the cluster to
@@ -8865,23 +8869,21 @@ module Aws::ECS
     #   with the largest number of running tasks for this service.
     #
     # <note markdown="1"> You must have a service-linked role when you update any of the
-    # following service properties. If you specified a custom role when you
-    # created the service, Amazon ECS automatically replaces the
-    # [roleARN][2] associated with the service with the ARN of your
-    # service-linked role. For more information, see [Service-linked
-    # roles][3] in the *Amazon Elastic Container Service Developer Guide*.
+    # following service properties:
     #
-    #  * `loadBalancers,`
+    #  * `loadBalancers`,
     #
     # * `serviceRegistries`
     #
+    #  For more information about the role see the `CreateService` request
+    # parameter [ `role` ][2].
+    #
     #  </note>
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html
-    # [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Service.html#ECS-Type-Service-roleArn
-    # [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html
+    # [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role
     #
     # @option params [String] :cluster
     #   The short name or full Amazon Resource Name (ARN) of the cluster that
@@ -9746,7 +9748,7 @@ module Aws::ECS
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-ecs'
-      context[:gem_version] = '1.126.0'
+      context[:gem_version] = '1.127.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-ecs/types.rb

@@ -127,11 +127,11 @@ module Aws::ECS
     #
     # @!attribute [rw] auto_scaling_group_arn
     #   The Amazon Resource Name (ARN) that identifies the Auto Scaling
-    #   group.
+    #   group, or the Auto Scaling group name.
     #   @return [String]
     #
     # @!attribute [rw] managed_scaling
-    #   The managed scaling settings for the Auto Scaling group capacity
+    #   he managed scaling settings for the Auto Scaling group capacity
     #   provider.
     #   @return [Types::ManagedScaling]
     #
@@ -1404,6 +1404,8 @@ module Aws::ECS
     #   [Amazon ECS-optimized Linux AMI][2] in the *Amazon Elastic Container
     #   Service Developer Guide*.
     #
+    #   The valid values are 2-120 seconds.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html
@@ -1444,6 +1446,8 @@ module Aws::ECS
     #   ECS-optimized Linux AMI][2] in the *Amazon Elastic Container Service
     #   Developer Guide*.
     #
+    #   The valid values are 2-120 seconds.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html
@@ -1838,22 +1842,44 @@ module Aws::ECS
     #   @return [Types::FirelensConfiguration]
     #
     # @!attribute [rw] credential_specs
-    #   A list of ARNs in SSM or Amazon S3 to a credential spec
-    #   (`credspec`code>) file that configures a container for Active
-    #   Directory authentication. This parameter is only used with
-    #   domainless authentication.
+    #   A list of ARNs in SSM or Amazon S3 to a credential spec (`CredSpec`)
+    #   file that configures the container for Active Directory
+    #   authentication. We recommend that you use this parameter instead of
+    #   the `dockerSecurityOptions`. The maximum number of ARNs is 1.
+    #
+    #   There are two formats for each ARN.
+    #
+    #   credentialspecdomainless:MyARN
+    #
+    #   : You use `credentialspecdomainless:MyARN` to provide a `CredSpec`
+    #     with an additional section for a secret in Secrets Manager. You
+    #     provide the login credentials to the domain in the secret.
+    #
+    #     Each task that runs on any container instance can join different
+    #     domains.
+    #
+    #     You can use this format without joining the container instance to
+    #     a domain.
+    #
+    #   credentialspec:MyARN
     #
-    #   The format for each ARN is `credentialspecdomainless:MyARN`. Replace
-    #   `MyARN` with the ARN in SSM or Amazon S3.
+    #   : You use `credentialspec:MyARN` to provide a `CredSpec` for a
+    #     single domain.
     #
-    #   The `credspec` must provide a ARN in Secrets Manager for a secret
-    #   containing the username, password, and the domain to connect to. For
-    #   better security, the instance isn't joined to the domain for
-    #   domainless authentication. Other applications on the instance can't
-    #   use the domainless credentials. You can use this parameter to run
-    #   tasks on the same instance, even it the tasks need to join different
-    #   domains. For more information, see [Using gMSAs for Windows
-    #   Containers][1] and [Using gMSAs for Linux Containers][2].
+    #     You must join the container instance to the domain before you
+    #     start any tasks that use this task definition.
+    #
+    #   In both formats, replace `MyARN` with the ARN in SSM or Amazon S3.
+    #
+    #   If you provide a `credentialspecdomainless:MyARN`, the `credspec`
+    #   must provide a ARN in Secrets Manager for a secret containing the
+    #   username, password, and the domain to connect to. For better
+    #   security, the instance isn't joined to the domain for domainless
+    #   authentication. Other applications on the instance can't use the
+    #   domainless credentials. You can use this parameter to run tasks on
+    #   the same instance, even it the tasks need to join different domains.
+    #   For more information, see [Using gMSAs for Windows Containers][1]
+    #   and [Using gMSAs for Linux Containers][2].
     #
     #
     #
@@ -2197,6 +2223,15 @@ module Aws::ECS
     # is `\{"containerOverrides": [ ] \}`. If a non-empty container override
     # is specified, the `name` parameter must be included.
     #
+    # You can use Secrets Manager or Amazon Web Services Systems Manager
+    # Parameter Store to store the sensitive data. For more information, see
+    # [Retrieve secrets through environment variables][1] in the Amazon ECS
+    # Developer Guide.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/secrets-envvar.html
+    #
     # @!attribute [rw] name
     #   The name of the container that receives the override. This parameter
     #   is required if any override is specified.
@@ -2974,7 +3009,8 @@ module Aws::ECS
     #   @return [String]
     #
     # @!attribute [rw] task_definition
-    #   The task definition for the tasks in the task set to use.
+    #   The task definition for the tasks in the task set to use. If a
+    #   revision isn't specified, the latest `ACTIVE` revision is used.
     #   @return [String]
     #
     # @!attribute [rw] network_configuration
@@ -3603,9 +3639,13 @@ module Aws::ECS
     # failure. For more information, see [Rolling update][1] in the *Amazon
     # Elastic Container Service Developer Guide*.
     #
+    # For more information about API failure reasons, see [API failure
+    # reasons][2] in the *Amazon Elastic Container Service Developer Guide*.
+    #
     #
     #
     # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html
+    # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html
     #
     # @!attribute [rw] enable
     #   Determines whether to use the deployment circuit breaker logic for
@@ -4538,8 +4578,7 @@ module Aws::ECS
     # variables][2] in the *Amazon Elastic Container Service Developer
     # Guide*.
     #
-    # This parameter is only supported for tasks hosted on Fargate using the
-    # following platform versions:
+    # You must use the following platforms for the Fargate launch type:
     #
     # * Linux platform version `1.4.0` or later.
     #
@@ -6263,8 +6302,7 @@ module Aws::ECS
     #   target group or groups associated with a service or task set.
     #
     #   A target group ARN is only specified when using an Application Load
-    #   Balancer or Network Load Balancer. If you're using a Classic Load
-    #   Balancer, omit the target group ARN.
+    #   Balancer or Network Load Balancer.
     #
     #   For services using the `ECS` deployment controller, you can specify
     #   one or multiple target groups. For more information, see
@@ -6293,9 +6331,8 @@ module Aws::ECS
     #   The name of the load balancer to associate with the Amazon ECS
     #   service or task set.
     #
-    #   A load balancer name is only specified when using a Classic Load
-    #   Balancer. If you are using an Application Load Balancer or a Network
-    #   Load Balancer the load balancer name parameter should be omitted.
+    #   If you are using an Application Load Balancer or a Network Load
+    #   Balancer the load balancer name parameter should be omitted.
     #   @return [String]
     #
     # @!attribute [rw] container_name
@@ -6337,9 +6374,15 @@ module Aws::ECS
     # containers.
     #
     # * Amazon ECS currently supports a subset of the logging drivers
-    #   available to the Docker daemon (shown in the valid values below).
-    #   Additional log drivers may be available in future releases of the
-    #   Amazon ECS container agent.
+    #   available to the Docker daemon. Additional log drivers may be
+    #   available in future releases of the Amazon ECS container agent.
+    #
+    #   For tasks on Fargate, the supported log drivers are `awslogs`,
+    #   `splunk`, and `awsfirelens`.
+    #
+    #   For tasks hosted on Amazon EC2 instances, the supported log drivers
+    #   are `awslogs`, `fluentd`, `gelf`, `json-file`, `journald`,
+    #   `logentries`,`syslog`, `splunk`, and `awsfirelens`.
     #
     # * This parameter requires version 1.18 of the Docker Remote API or
     #   greater on your container instance.
@@ -6540,8 +6583,8 @@ module Aws::ECS
     # @!attribute [rw] maximum_scaling_step_size
     #   The maximum number of Amazon EC2 instances that Amazon ECS will
     #   scale out at one time. The scale in process is not affected by this
-    #   parameter. If this parameter is omitted, the default value of `1` is
-    #   used.
+    #   parameter. If this parameter is omitted, the default value of
+    #   `10000` is used.
     #   @return [Integer]
     #
     # @!attribute [rw] instance_warmup_period
@@ -6955,10 +6998,10 @@ module Aws::ECS
     #   is listed on the instance under
     #   `/proc/sys/net/ipv4/ip_local_port_range`. If this kernel parameter
     #   is unavailable, the default ephemeral port range from 49153 through
-    #   65535 is used. Do not attempt to specify a host port in the
-    #   ephemeral port range as these are reserved for automatic assignment.
-    #   In general, ports below 32768 are outside of the ephemeral port
-    #   range.
+    #   65535 (Linux) or 49152 through 65535 (Windows) is used. Do not
+    #   attempt to specify a host port in the ephemeral port range as these
+    #   are reserved for automatic assignment. In general, ports below 32768
+    #   are outside of the ephemeral port range.
     #
     #   The default reserved ports are 22 for SSH, the Docker ports 2375 and
     #   2376, and the Amazon ECS container agent ports 51678-51680. Any host
@@ -8824,9 +8867,15 @@ module Aws::ECS
     #   your containers.
     #
     #   * Amazon ECS currently supports a subset of the logging drivers
-    #     available to the Docker daemon (shown in the valid values below).
-    #     Additional log drivers may be available in future releases of the
-    #     Amazon ECS container agent.
+    #     available to the Docker daemon. Additional log drivers may be
+    #     available in future releases of the Amazon ECS container agent.
+    #
+    #     For tasks on Fargate, the supported log drivers are `awslogs`,
+    #     `splunk`, and `awsfirelens`.
+    #
+    #     For tasks hosted on Amazon EC2 instances, the supported log
+    #     drivers are `awslogs`, `fluentd`, `gelf`, `json-file`, `journald`,
+    #     `logentries`,`syslog`, `splunk`, and `awsfirelens`.
     #
     #   * This parameter requires version 1.18 of the Docker Remote API or
     #     greater on your container instance.
@@ -9900,6 +9949,9 @@ module Aws::ECS
     #   The stop code indicating why a task was stopped. The `stoppedReason`
     #   might contain additional details.
     #
+    #   For more information about stop code, see [Stopped tasks error
+    #   codes][1] in the *Amazon ECS User Guide*.
+    #
     #   The following are valid values:
     #
     #   * `TaskFailedToStart`
@@ -9913,6 +9965,10 @@ module Aws::ECS
     #   * `ServiceSchedulerInitiated`
     #
     #   * `SpotInterruption`
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonECS/latest/userguide/stopped-task-error-codes.html
     #   @return [String]
     #
     # @!attribute [rw] stopped_at
@@ -9928,7 +9984,7 @@ module Aws::ECS
     # @!attribute [rw] stopping_at
     #   The Unix timestamp for the time when the task stops. More
     #   specifically, it's for the time when the task transitions from the
-    #   `RUNNING` state to `STOPPED`.
+    #   `RUNNING` state to `STOPPING`.
     #   @return [Time]
     #
     # @!attribute [rw] tags
@@ -10213,9 +10269,10 @@ module Aws::ECS
     #   @return [Types::RuntimePlatform]
     #
     # @!attribute [rw] requires_compatibilities
-    #   The task launch types the task definition was validated against. For
-    #   more information, see [Amazon ECS launch types][1] in the *Amazon
-    #   Elastic Container Service Developer Guide*.
+    #   The task launch types the task definition was validated against. The
+    #   valid values are `EC2`, `FARGATE`, and `EXTERNAL`. For more
+    #   information, see [Amazon ECS launch types][1] in the *Amazon Elastic
+    #   Container Service Developer Guide*.
     #
     #
     #
@@ -11565,6 +11622,8 @@ module Aws::ECS
     #   numbers, underscores, and hyphens are allowed. This name is
     #   referenced in the `sourceVolume` parameter of container definition
     #   `mountPoints`.
+    #
+    #   This is required wwhen you use an Amazon EFS volume.
     #   @return [String]
     #
     # @!attribute [rw] host

data/lib/aws-sdk-ecs.rb

@@ -53,6 +53,6 @@ require_relative 'aws-sdk-ecs/customizations'
 # @!group service
 module Aws::ECS
 
-  GEM_VERSION = '1.126.0'
+  GEM_VERSION = '1.127.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-ecs
 version: !ruby/object:Gem::Version
-  version: 1.126.0
+  version: 1.127.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-11 00:00:00.000000000 Z
+date: 2023-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core