aws-sdk-ecs 1.152.0 → 1.161.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +45 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ecs/client.rb +258 -143
- data/lib/aws-sdk-ecs/client_api.rb +11 -0
- data/lib/aws-sdk-ecs/endpoints.rb +56 -224
- data/lib/aws-sdk-ecs/plugins/endpoints.rb +18 -6
- data/lib/aws-sdk-ecs/types.rb +551 -625
- data/lib/aws-sdk-ecs.rb +16 -12
- data/sig/client.rbs +7 -0
- data/sig/resource.rbs +2 -0
- data/sig/types.rbs +8 -0
- metadata +4 -4
data/lib/aws-sdk-ecs/client.rb
CHANGED
@@ -32,11 +32,10 @@ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
|
32
32
|
require 'aws-sdk-core/plugins/request_compression.rb'
|
33
33
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
34
34
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
35
|
+
require 'aws-sdk-core/plugins/telemetry.rb'
|
35
36
|
require 'aws-sdk-core/plugins/sign.rb'
|
36
37
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
37
38
|
|
38
|
-
Aws::Plugins::GlobalConfiguration.add_identifier(:ecs)
|
39
|
-
|
40
39
|
module Aws::ECS
|
41
40
|
# An API client for ECS. To construct a client, you need to configure a `:region` and `:credentials`.
|
42
41
|
#
|
@@ -83,6 +82,7 @@ module Aws::ECS
|
|
83
82
|
add_plugin(Aws::Plugins::RequestCompression)
|
84
83
|
add_plugin(Aws::Plugins::DefaultsMode)
|
85
84
|
add_plugin(Aws::Plugins::RecursionDetection)
|
85
|
+
add_plugin(Aws::Plugins::Telemetry)
|
86
86
|
add_plugin(Aws::Plugins::Sign)
|
87
87
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
88
88
|
add_plugin(Aws::ECS::Plugins::Endpoints)
|
@@ -128,13 +128,15 @@ module Aws::ECS
|
|
128
128
|
# locations will be searched for credentials:
|
129
129
|
#
|
130
130
|
# * `Aws.config[:credentials]`
|
131
|
-
# * The `:access_key_id`, `:secret_access_key`,
|
132
|
-
#
|
131
|
+
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
132
|
+
# `:account_id` options.
|
133
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
|
134
|
+
# ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
|
133
135
|
# * `~/.aws/credentials`
|
134
136
|
# * `~/.aws/config`
|
135
137
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
136
138
|
# are very aggressive. Construct and pass an instance of
|
137
|
-
# `Aws::
|
139
|
+
# `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
138
140
|
# enable retries and extended timeouts. Instance profile credential
|
139
141
|
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
140
142
|
# to true.
|
@@ -153,6 +155,8 @@ module Aws::ECS
|
|
153
155
|
#
|
154
156
|
# @option options [String] :access_key_id
|
155
157
|
#
|
158
|
+
# @option options [String] :account_id
|
159
|
+
#
|
156
160
|
# @option options [Boolean] :active_endpoint_cache (false)
|
157
161
|
# When set to `true`, a thread polling for endpoints will be running in
|
158
162
|
# the background every 60 secs (default). Defaults to `false`.
|
@@ -337,6 +341,16 @@ module Aws::ECS
|
|
337
341
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
338
342
|
# requests are made, and retries are disabled.
|
339
343
|
#
|
344
|
+
# @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
|
345
|
+
# Allows you to provide a telemetry provider, which is used to
|
346
|
+
# emit telemetry data. By default, uses `NoOpTelemetryProvider` which
|
347
|
+
# will not record or emit any telemetry data. The SDK supports the
|
348
|
+
# following telemetry providers:
|
349
|
+
#
|
350
|
+
# * OpenTelemetry (OTel) - To use the OTel provider, install and require the
|
351
|
+
# `opentelemetry-sdk` gem and then, pass in an instance of a
|
352
|
+
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
353
|
+
#
|
340
354
|
# @option options [Aws::TokenProvider] :token_provider
|
341
355
|
# A Bearer Token Provider. This can be an instance of any one of the
|
342
356
|
# following classes:
|
@@ -364,7 +378,9 @@ module Aws::ECS
|
|
364
378
|
# sending the request.
|
365
379
|
#
|
366
380
|
# @option options [Aws::ECS::EndpointProvider] :endpoint_provider
|
367
|
-
# The endpoint provider used to resolve endpoints. Any object that responds to
|
381
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to
|
382
|
+
# `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
|
383
|
+
# `Aws::ECS::EndpointParameters`.
|
368
384
|
#
|
369
385
|
# @option options [Float] :http_continue_timeout (1)
|
370
386
|
# The number of seconds to wait for a 100-continue response before sending the
|
@@ -420,6 +436,12 @@ module Aws::ECS
|
|
420
436
|
# @option options [String] :ssl_ca_store
|
421
437
|
# Sets the X509::Store to verify peer certificate.
|
422
438
|
#
|
439
|
+
# @option options [OpenSSL::X509::Certificate] :ssl_cert
|
440
|
+
# Sets a client certificate when creating http connections.
|
441
|
+
#
|
442
|
+
# @option options [OpenSSL::PKey] :ssl_key
|
443
|
+
# Sets a client key when creating http connections.
|
444
|
+
#
|
423
445
|
# @option options [Float] :ssl_timeout
|
424
446
|
# Sets the SSL timeout in seconds
|
425
447
|
#
|
@@ -538,23 +560,23 @@ module Aws::ECS
|
|
538
560
|
|
539
561
|
# Creates a new Amazon ECS cluster. By default, your account receives a
|
540
562
|
# `default` cluster when you launch your first container instance.
|
541
|
-
# However, you can create your own cluster with a unique name
|
542
|
-
#
|
543
|
-
#
|
544
|
-
#
|
545
|
-
#
|
546
|
-
#
|
547
|
-
#
|
548
|
-
#
|
549
|
-
#
|
550
|
-
#
|
551
|
-
# Guide*.
|
563
|
+
# However, you can create your own cluster with a unique name.
|
564
|
+
#
|
565
|
+
# <note markdown="1"> When you call the [CreateCluster][1] API operation, Amazon ECS
|
566
|
+
# attempts to create the Amazon ECS service-linked role for your
|
567
|
+
# account. This is so that it can manage required resources in other
|
568
|
+
# Amazon Web Services services on your behalf. However, if the user that
|
569
|
+
# makes the call doesn't have permissions to create the service-linked
|
570
|
+
# role, it isn't created. For more information, see [Using
|
571
|
+
# service-linked roles for Amazon ECS][2] in the *Amazon Elastic
|
572
|
+
# Container Service Developer Guide*.
|
552
573
|
#
|
553
574
|
# </note>
|
554
575
|
#
|
555
576
|
#
|
556
577
|
#
|
557
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/
|
578
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html
|
579
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html
|
558
580
|
#
|
559
581
|
# @option params [String] :cluster_name
|
560
582
|
# The name of your cluster. If you don't specify a name for your
|
@@ -596,7 +618,12 @@ module Aws::ECS
|
|
596
618
|
# The setting to use when creating a cluster. This parameter is used to
|
597
619
|
# turn on CloudWatch Container Insights for a cluster. If this value is
|
598
620
|
# specified, it overrides the `containerInsights` value set with
|
599
|
-
# PutAccountSetting or PutAccountSettingDefault.
|
621
|
+
# [PutAccountSetting][1] or [PutAccountSettingDefault][2].
|
622
|
+
#
|
623
|
+
#
|
624
|
+
#
|
625
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html
|
626
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html
|
600
627
|
#
|
601
628
|
# @option params [Types::ClusterConfiguration] :configuration
|
602
629
|
# The `execute` command configuration for the cluster.
|
@@ -638,12 +665,13 @@ module Aws::ECS
|
|
638
665
|
#
|
639
666
|
# If a default capacity provider strategy isn't defined for a cluster
|
640
667
|
# when it was created, it can be defined later with the
|
641
|
-
# PutClusterCapacityProviders API operation.
|
668
|
+
# [PutClusterCapacityProviders][3] API operation.
|
642
669
|
#
|
643
670
|
#
|
644
671
|
#
|
645
672
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html
|
646
673
|
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html
|
674
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
647
675
|
#
|
648
676
|
# @option params [Types::ClusterServiceConnectDefaultsRequest] :service_connect_defaults
|
649
677
|
# Use this parameter to set a default Service Connect namespace. After
|
@@ -794,8 +822,8 @@ module Aws::ECS
|
|
794
822
|
# Runs and maintains your desired number of tasks from a specified task
|
795
823
|
# definition. If the number of tasks running in a service drops below
|
796
824
|
# the `desiredCount`, Amazon ECS runs another copy of the task in the
|
797
|
-
# specified cluster. To update an existing service,
|
798
|
-
# UpdateService
|
825
|
+
# specified cluster. To update an existing service, use
|
826
|
+
# [UpdateService][1].
|
799
827
|
#
|
800
828
|
# <note markdown="1"> On March 21, 2024, a change was made to resolve the task definition
|
801
829
|
# revision before authorization. When a task definition revision is not
|
@@ -808,13 +836,13 @@ module Aws::ECS
|
|
808
836
|
# you can optionally run your service behind one or more load balancers.
|
809
837
|
# The load balancers distribute traffic across the tasks that are
|
810
838
|
# associated with the service. For more information, see [Service load
|
811
|
-
# balancing][
|
839
|
+
# balancing][2] in the *Amazon Elastic Container Service Developer
|
812
840
|
# Guide*.
|
813
841
|
#
|
814
842
|
# You can attach Amazon EBS volumes to Amazon ECS tasks by configuring
|
815
843
|
# the volume when creating or updating a service. `volumeConfigurations`
|
816
844
|
# is only supported for REPLICA service and not DAEMON service. For more
|
817
|
-
# infomation, see [Amazon EBS volumes][
|
845
|
+
# infomation, see [Amazon EBS volumes][3] in the *Amazon Elastic
|
818
846
|
# Container Service Developer Guide*.
|
819
847
|
#
|
820
848
|
# Tasks for services that don't use a load balancer are considered
|
@@ -829,7 +857,7 @@ module Aws::ECS
|
|
829
857
|
# service scheduler spreads tasks across Availability Zones. You can
|
830
858
|
# use task placement strategies and constraints to customize task
|
831
859
|
# placement decisions. For more information, see [Service scheduler
|
832
|
-
# concepts][
|
860
|
+
# concepts][4] in the *Amazon Elastic Container Service Developer
|
833
861
|
# Guide*.
|
834
862
|
#
|
835
863
|
# * `DAEMON` - The daemon scheduling strategy deploys exactly one task
|
@@ -840,16 +868,16 @@ module Aws::ECS
|
|
840
868
|
# constraints. When using this strategy, you don't need to specify a
|
841
869
|
# desired number of tasks, a task placement strategy, or use Service
|
842
870
|
# Auto Scaling policies. For more information, see [Service scheduler
|
843
|
-
# concepts][
|
871
|
+
# concepts][4] in the *Amazon Elastic Container Service Developer
|
844
872
|
# Guide*.
|
845
873
|
#
|
846
874
|
# You can optionally specify a deployment configuration for your
|
847
875
|
# service. The deployment is initiated by changing properties. For
|
848
876
|
# example, the deployment might be initiated by the task definition or
|
849
|
-
# by your desired count of a service.
|
850
|
-
#
|
851
|
-
#
|
852
|
-
#
|
877
|
+
# by your desired count of a service. You can use [UpdateService][1].
|
878
|
+
# The default value for a replica service for `minimumHealthyPercent` is
|
879
|
+
# 100%. The default value for a daemon service for
|
880
|
+
# `minimumHealthyPercent` is 0%.
|
853
881
|
#
|
854
882
|
# If a service uses the `ECS` deployment controller, the minimum healthy
|
855
883
|
# percent represents a lower limit on the number of tasks in a service
|
@@ -895,13 +923,13 @@ module Aws::ECS
|
|
895
923
|
# When creating a service that uses the `EXTERNAL` deployment
|
896
924
|
# controller, you can specify only parameters that aren't controlled at
|
897
925
|
# the task set level. The only required parameter is the service name.
|
898
|
-
# You control your services using the CreateTaskSet
|
899
|
-
# information, see [Amazon ECS deployment types][
|
926
|
+
# You control your services using the [CreateTaskSet][5]. For more
|
927
|
+
# information, see [Amazon ECS deployment types][6] in the *Amazon
|
900
928
|
# Elastic Container Service Developer Guide*.
|
901
929
|
#
|
902
930
|
# When the service scheduler launches new tasks, it determines task
|
903
931
|
# placement. For information about task placement and task placement
|
904
|
-
# strategies, see [Amazon ECS task placement][
|
932
|
+
# strategies, see [Amazon ECS task placement][7] in the *Amazon Elastic
|
905
933
|
# Container Service Developer Guide*
|
906
934
|
#
|
907
935
|
# Starting April 15, 2023, Amazon Web Services will not onboard new
|
@@ -915,11 +943,13 @@ module Aws::ECS
|
|
915
943
|
#
|
916
944
|
#
|
917
945
|
#
|
918
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/
|
919
|
-
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
920
|
-
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
921
|
-
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
922
|
-
# [5]: https://docs.aws.amazon.com/AmazonECS/latest/
|
946
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
947
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html
|
948
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types
|
949
|
+
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html
|
950
|
+
# [5]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html
|
951
|
+
# [6]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html
|
952
|
+
# [7]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html
|
923
953
|
#
|
924
954
|
# @option params [String] :cluster
|
925
955
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
@@ -1749,7 +1779,7 @@ module Aws::ECS
|
|
1749
1779
|
#
|
1750
1780
|
# </note>
|
1751
1781
|
#
|
1752
|
-
# For information about the maximum number of task sets and
|
1782
|
+
# For information about the maximum number of task sets and other
|
1753
1783
|
# quotas, see [Amazon ECS service quotas][2] in the *Amazon Elastic
|
1754
1784
|
# Container Service Developer Guide*.
|
1755
1785
|
#
|
@@ -1811,8 +1841,8 @@ module Aws::ECS
|
|
1811
1841
|
# A capacity provider strategy consists of one or more capacity
|
1812
1842
|
# providers along with the `base` and `weight` to assign to them. A
|
1813
1843
|
# capacity provider must be associated with the cluster to be used in a
|
1814
|
-
# capacity provider strategy. The PutClusterCapacityProviders API
|
1815
|
-
# used to associate a capacity provider with a cluster. Only capacity
|
1844
|
+
# capacity provider strategy. The [PutClusterCapacityProviders][1] API
|
1845
|
+
# is used to associate a capacity provider with a cluster. Only capacity
|
1816
1846
|
# providers with an `ACTIVE` or `UPDATING` status can be used.
|
1817
1847
|
#
|
1818
1848
|
# If a `capacityProviderStrategy` is specified, the `launchType`
|
@@ -1822,16 +1852,21 @@ module Aws::ECS
|
|
1822
1852
|
#
|
1823
1853
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
1824
1854
|
# capacity provider must already be created. New capacity providers can
|
1825
|
-
# be created with the
|
1855
|
+
# be created with the [CreateCapacityProviderProvider][2]API operation.
|
1826
1856
|
#
|
1827
1857
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
1828
1858
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
1829
1859
|
# available to all accounts and only need to be associated with a
|
1830
1860
|
# cluster to be used.
|
1831
1861
|
#
|
1832
|
-
# The PutClusterCapacityProviders API operation is used to update
|
1833
|
-
# list of available capacity providers for a cluster after the
|
1834
|
-
# is created.
|
1862
|
+
# The [PutClusterCapacityProviders][1] API operation is used to update
|
1863
|
+
# the list of available capacity providers for a cluster after the
|
1864
|
+
# cluster is created.
|
1865
|
+
#
|
1866
|
+
#
|
1867
|
+
#
|
1868
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
1869
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProviderProvider.html
|
1835
1870
|
#
|
1836
1871
|
# @option params [String] :platform_version
|
1837
1872
|
# The platform version that the tasks in the task set uses. A platform
|
@@ -2126,20 +2161,26 @@ module Aws::ECS
|
|
2126
2161
|
#
|
2127
2162
|
# <note markdown="1"> The `FARGATE` and `FARGATE_SPOT` capacity providers are reserved and
|
2128
2163
|
# can't be deleted. You can disassociate them from a cluster using
|
2129
|
-
# either
|
2164
|
+
# either [PutCapacityProviderProviders][1] or by deleting the cluster.
|
2130
2165
|
#
|
2131
2166
|
# </note>
|
2132
2167
|
#
|
2133
2168
|
# Prior to a capacity provider being deleted, the capacity provider must
|
2134
2169
|
# be removed from the capacity provider strategy from all services. The
|
2135
|
-
# UpdateService API can be used to remove a capacity provider from
|
2136
|
-
# service's capacity provider strategy. When updating a service, the
|
2170
|
+
# [UpdateService][2] API can be used to remove a capacity provider from
|
2171
|
+
# a service's capacity provider strategy. When updating a service, the
|
2137
2172
|
# `forceNewDeployment` option can be used to ensure that any tasks using
|
2138
2173
|
# the Amazon EC2 instance capacity provided by the capacity provider are
|
2139
2174
|
# transitioned to use the capacity from the remaining capacity
|
2140
2175
|
# providers. Only capacity providers that aren't associated with a
|
2141
2176
|
# cluster can be deleted. To remove a capacity provider from a cluster,
|
2142
|
-
# you can either use
|
2177
|
+
# you can either use [PutCapacityProviderProviders][1] or delete the
|
2178
|
+
# cluster.
|
2179
|
+
#
|
2180
|
+
#
|
2181
|
+
#
|
2182
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProviderProviders.html
|
2183
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
2143
2184
|
#
|
2144
2185
|
# @option params [required, String] :capacity_provider
|
2145
2186
|
# The short name or full Amazon Resource Name (ARN) of the capacity
|
@@ -2191,8 +2232,13 @@ module Aws::ECS
|
|
2191
2232
|
#
|
2192
2233
|
# You must deregister all container instances from this cluster before
|
2193
2234
|
# you may delete it. You can list the container instances in a cluster
|
2194
|
-
# with ListContainerInstances and deregister them with
|
2195
|
-
# DeregisterContainerInstance.
|
2235
|
+
# with [ListContainerInstances][1] and deregister them with
|
2236
|
+
# [DeregisterContainerInstance][2].
|
2237
|
+
#
|
2238
|
+
#
|
2239
|
+
#
|
2240
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html
|
2241
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html
|
2196
2242
|
#
|
2197
2243
|
# @option params [required, String] :cluster
|
2198
2244
|
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
@@ -2286,18 +2332,19 @@ module Aws::ECS
|
|
2286
2332
|
# if you have no running tasks in it and the desired task count is zero.
|
2287
2333
|
# If the service is actively maintaining tasks, you can't delete it,
|
2288
2334
|
# and you must update the service to a desired task count of zero. For
|
2289
|
-
# more information, see UpdateService.
|
2335
|
+
# more information, see [UpdateService][1].
|
2290
2336
|
#
|
2291
2337
|
# <note markdown="1"> When you delete a service, if there are still running tasks that
|
2292
2338
|
# require cleanup, the service status moves from `ACTIVE` to `DRAINING`,
|
2293
2339
|
# and the service is no longer visible in the console or in the
|
2294
|
-
# ListServices API operation. After all tasks have transitioned to
|
2340
|
+
# [ListServices][2] API operation. After all tasks have transitioned to
|
2295
2341
|
# either `STOPPING` or `STOPPED` status, the service status moves from
|
2296
2342
|
# `DRAINING` to `INACTIVE`. Services in the `DRAINING` or `INACTIVE`
|
2297
|
-
# status can still be viewed with the DescribeServices API
|
2298
|
-
# However, in the future, `INACTIVE` services may be cleaned
|
2299
|
-
# purged from Amazon ECS record keeping, and
|
2300
|
-
# those services return a
|
2343
|
+
# status can still be viewed with the [DescribeServices][3] API
|
2344
|
+
# operation. However, in the future, `INACTIVE` services may be cleaned
|
2345
|
+
# up and purged from Amazon ECS record keeping, and
|
2346
|
+
# [DescribeServices][3] calls on those services return a
|
2347
|
+
# `ServiceNotFoundException` error.
|
2301
2348
|
#
|
2302
2349
|
# </note>
|
2303
2350
|
#
|
@@ -2305,6 +2352,12 @@ module Aws::ECS
|
|
2305
2352
|
# existing service in either `ACTIVE` or `DRAINING` status, you receive
|
2306
2353
|
# an error.
|
2307
2354
|
#
|
2355
|
+
#
|
2356
|
+
#
|
2357
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
2358
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html
|
2359
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html
|
2360
|
+
#
|
2308
2361
|
# @option params [String] :cluster
|
2309
2362
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
2310
2363
|
# hosts the service to delete. If you do not specify a cluster, the
|
@@ -2596,6 +2649,10 @@ module Aws::ECS
|
|
2596
2649
|
# resp.task_definitions[0].container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
|
2597
2650
|
# resp.task_definitions[0].container_definitions[0].port_mappings[0].container_port_range #=> String
|
2598
2651
|
# resp.task_definitions[0].container_definitions[0].essential #=> Boolean
|
2652
|
+
# resp.task_definitions[0].container_definitions[0].restart_policy.enabled #=> Boolean
|
2653
|
+
# resp.task_definitions[0].container_definitions[0].restart_policy.ignored_exit_codes #=> Array
|
2654
|
+
# resp.task_definitions[0].container_definitions[0].restart_policy.ignored_exit_codes[0] #=> Integer
|
2655
|
+
# resp.task_definitions[0].container_definitions[0].restart_policy.restart_attempt_period #=> Integer
|
2599
2656
|
# resp.task_definitions[0].container_definitions[0].entry_point #=> Array
|
2600
2657
|
# resp.task_definitions[0].container_definitions[0].entry_point[0] #=> String
|
2601
2658
|
# resp.task_definitions[0].container_definitions[0].command #=> Array
|
@@ -3053,6 +3110,10 @@ module Aws::ECS
|
|
3053
3110
|
# resp.task_definition.container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
|
3054
3111
|
# resp.task_definition.container_definitions[0].port_mappings[0].container_port_range #=> String
|
3055
3112
|
# resp.task_definition.container_definitions[0].essential #=> Boolean
|
3113
|
+
# resp.task_definition.container_definitions[0].restart_policy.enabled #=> Boolean
|
3114
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes #=> Array
|
3115
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes[0] #=> Integer
|
3116
|
+
# resp.task_definition.container_definitions[0].restart_policy.restart_attempt_period #=> Integer
|
3056
3117
|
# resp.task_definition.container_definitions[0].entry_point #=> Array
|
3057
3118
|
# resp.task_definition.container_definitions[0].entry_point[0] #=> String
|
3058
3119
|
# resp.task_definition.container_definitions[0].command #=> Array
|
@@ -3999,6 +4060,10 @@ module Aws::ECS
|
|
3999
4060
|
# resp.task_definition.container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
|
4000
4061
|
# resp.task_definition.container_definitions[0].port_mappings[0].container_port_range #=> String
|
4001
4062
|
# resp.task_definition.container_definitions[0].essential #=> Boolean
|
4063
|
+
# resp.task_definition.container_definitions[0].restart_policy.enabled #=> Boolean
|
4064
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes #=> Array
|
4065
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes[0] #=> Integer
|
4066
|
+
# resp.task_definition.container_definitions[0].restart_policy.restart_attempt_period #=> Integer
|
4002
4067
|
# resp.task_definition.container_definitions[0].entry_point #=> Array
|
4003
4068
|
# resp.task_definition.container_definitions[0].entry_point[0] #=> String
|
4004
4069
|
# resp.task_definition.container_definitions[0].command #=> Array
|
@@ -5009,9 +5074,14 @@ module Aws::ECS
|
|
5009
5074
|
# @option params [String] :status
|
5010
5075
|
# Filters the container instances by status. For example, if you specify
|
5011
5076
|
# the `DRAINING` status, the results include only container instances
|
5012
|
-
# that have been set to `DRAINING` using
|
5013
|
-
# If you don't specify this
|
5014
|
-
# container instances set to all
|
5077
|
+
# that have been set to `DRAINING` using
|
5078
|
+
# [UpdateContainerInstancesState][1]. If you don't specify this
|
5079
|
+
# parameter, the default is to include container instances set to all
|
5080
|
+
# states other than `INACTIVE`.
|
5081
|
+
#
|
5082
|
+
#
|
5083
|
+
#
|
5084
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateContainerInstancesState.html
|
5015
5085
|
#
|
5016
5086
|
# @return [Types::ListContainerInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5017
5087
|
#
|
@@ -5719,9 +5789,6 @@ module Aws::ECS
|
|
5719
5789
|
# mode][3]. For more information on using IPv6 with tasks launched on
|
5720
5790
|
# Fargate, see [Using a VPC in dual-stack mode][4].
|
5721
5791
|
#
|
5722
|
-
# * `fargateFIPSMode` - If you specify `fargateFIPSMode`, Fargate FIPS
|
5723
|
-
# 140 compliance is affected.
|
5724
|
-
#
|
5725
5792
|
# * `fargateTaskRetirementWaitPeriod` - When Amazon Web Services
|
5726
5793
|
# determines that a security or infrastructure update is needed for an
|
5727
5794
|
# Amazon ECS task hosted on Fargate, the tasks need to be stopped and
|
@@ -6024,12 +6091,13 @@ module Aws::ECS
|
|
6024
6091
|
# Create or update an attribute on an Amazon ECS resource. If the
|
6025
6092
|
# attribute doesn't exist, it's created. If the attribute exists, its
|
6026
6093
|
# value is replaced with the specified value. To delete an attribute,
|
6027
|
-
# use DeleteAttributes. For more information, see [Attributes][
|
6028
|
-
# *Amazon Elastic Container Service Developer Guide*.
|
6094
|
+
# use [DeleteAttributes][1]. For more information, see [Attributes][2]
|
6095
|
+
# in the *Amazon Elastic Container Service Developer Guide*.
|
6029
6096
|
#
|
6030
6097
|
#
|
6031
6098
|
#
|
6032
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/
|
6099
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteAttributes.html
|
6100
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes
|
6033
6101
|
#
|
6034
6102
|
# @option params [String] :cluster
|
6035
6103
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
@@ -6084,10 +6152,10 @@ module Aws::ECS
|
|
6084
6152
|
# has existing capacity providers associated with it, you must specify
|
6085
6153
|
# all existing capacity providers in addition to any new ones you want
|
6086
6154
|
# to add. Any existing capacity providers that are associated with a
|
6087
|
-
# cluster that are omitted from a PutClusterCapacityProviders API
|
6088
|
-
# will be disassociated with the cluster. You can only disassociate
|
6089
|
-
# existing capacity provider from a cluster if it's not being used
|
6090
|
-
# any existing tasks.
|
6155
|
+
# cluster that are omitted from a [PutClusterCapacityProviders][1] API
|
6156
|
+
# call will be disassociated with the cluster. You can only disassociate
|
6157
|
+
# an existing capacity provider from a cluster if it's not being used
|
6158
|
+
# by any existing tasks.
|
6091
6159
|
#
|
6092
6160
|
# When creating a service or running a task on a cluster, if no capacity
|
6093
6161
|
# provider or launch type is specified, then the cluster's default
|
@@ -6095,6 +6163,10 @@ module Aws::ECS
|
|
6095
6163
|
# default capacity provider strategy for your cluster. However, you must
|
6096
6164
|
# specify an empty array (`[]`) to bypass defining a default strategy.
|
6097
6165
|
#
|
6166
|
+
#
|
6167
|
+
#
|
6168
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
6169
|
+
#
|
6098
6170
|
# @option params [required, String] :cluster
|
6099
6171
|
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
6100
6172
|
# modify the capacity provider settings for. If you don't specify a
|
@@ -6106,13 +6178,17 @@ module Aws::ECS
|
|
6106
6178
|
#
|
6107
6179
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
6108
6180
|
# capacity provider must already be created. New capacity providers can
|
6109
|
-
# be created with the CreateCapacityProvider API operation.
|
6181
|
+
# be created with the [CreateCapacityProvider][1] API operation.
|
6110
6182
|
#
|
6111
6183
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
6112
6184
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
6113
6185
|
# available to all accounts and only need to be associated with a
|
6114
6186
|
# cluster to be used.
|
6115
6187
|
#
|
6188
|
+
#
|
6189
|
+
#
|
6190
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html
|
6191
|
+
#
|
6116
6192
|
# @option params [required, Array<Types::CapacityProviderStrategyItem>] :default_capacity_provider_strategy
|
6117
6193
|
# The capacity provider strategy to use by default for the cluster.
|
6118
6194
|
#
|
@@ -6123,19 +6199,24 @@ module Aws::ECS
|
|
6123
6199
|
# A capacity provider strategy consists of one or more capacity
|
6124
6200
|
# providers along with the `base` and `weight` to assign to them. A
|
6125
6201
|
# capacity provider must be associated with the cluster to be used in a
|
6126
|
-
# capacity provider strategy. The PutClusterCapacityProviders API
|
6127
|
-
# used to associate a capacity provider with a cluster. Only capacity
|
6202
|
+
# capacity provider strategy. The [PutClusterCapacityProviders][1] API
|
6203
|
+
# is used to associate a capacity provider with a cluster. Only capacity
|
6128
6204
|
# providers with an `ACTIVE` or `UPDATING` status can be used.
|
6129
6205
|
#
|
6130
6206
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
6131
6207
|
# capacity provider must already be created. New capacity providers can
|
6132
|
-
# be created with the CreateCapacityProvider API operation.
|
6208
|
+
# be created with the [CreateCapacityProvider][2] API operation.
|
6133
6209
|
#
|
6134
6210
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
6135
6211
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
6136
6212
|
# available to all accounts and only need to be associated with a
|
6137
6213
|
# cluster to be used.
|
6138
6214
|
#
|
6215
|
+
#
|
6216
|
+
#
|
6217
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
6218
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html
|
6219
|
+
#
|
6139
6220
|
# @return [Types::PutClusterCapacityProvidersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6140
6221
|
#
|
6141
6222
|
# * {Types::PutClusterCapacityProvidersResponse#cluster #cluster} => Types::Cluster
|
@@ -6405,20 +6486,18 @@ module Aws::ECS
|
|
6405
6486
|
# Tasks][2] in the *Amazon Elastic Container Service Developer Guide*.
|
6406
6487
|
#
|
6407
6488
|
# You can specify a Docker networking mode for the containers in your
|
6408
|
-
# task definition with the `networkMode` parameter.
|
6409
|
-
# network
|
6410
|
-
#
|
6411
|
-
#
|
6412
|
-
#
|
6413
|
-
#
|
6414
|
-
# Networking][4] in the *Amazon Elastic Container Service Developer
|
6415
|
-
# Guide*.
|
6489
|
+
# task definition with the `networkMode` parameter. If you specify the
|
6490
|
+
# `awsvpc` network mode, the task is allocated an elastic network
|
6491
|
+
# interface, and you must specify a [NetworkConfiguration][3] when you
|
6492
|
+
# create a service or run a task with the task definition. For more
|
6493
|
+
# information, see [Task Networking][4] in the *Amazon Elastic Container
|
6494
|
+
# Service Developer Guide*.
|
6416
6495
|
#
|
6417
6496
|
#
|
6418
6497
|
#
|
6419
6498
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html
|
6420
6499
|
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html
|
6421
|
-
# [3]: https://docs.
|
6500
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html
|
6422
6501
|
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
6423
6502
|
#
|
6424
6503
|
# @option params [required, String] :family
|
@@ -6441,14 +6520,13 @@ module Aws::ECS
|
|
6441
6520
|
# @option params [String] :execution_role_arn
|
6442
6521
|
# The Amazon Resource Name (ARN) of the task execution role that grants
|
6443
6522
|
# the Amazon ECS container agent permission to make Amazon Web Services
|
6444
|
-
# API calls on your behalf.
|
6445
|
-
#
|
6446
|
-
#
|
6447
|
-
# Container Service Developer Guide*.
|
6523
|
+
# API calls on your behalf. For informationabout the required IAM roles
|
6524
|
+
# for Amazon ECS, see [IAM roles for Amazon ECS][1] in the *Amazon
|
6525
|
+
# Elastic Container Service Developer Guide*.
|
6448
6526
|
#
|
6449
6527
|
#
|
6450
6528
|
#
|
6451
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
6529
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html
|
6452
6530
|
#
|
6453
6531
|
# @option params [String] :network_mode
|
6454
6532
|
# The Docker networking mode to use for the containers in the task. The
|
@@ -6477,22 +6555,19 @@ module Aws::ECS
|
|
6477
6555
|
# non-root user.
|
6478
6556
|
#
|
6479
6557
|
# If the network mode is `awsvpc`, the task is allocated an elastic
|
6480
|
-
# network interface, and you must specify a NetworkConfiguration
|
6481
|
-
# when you create a service or run a task with the task
|
6482
|
-
# more information, see [Task Networking][
|
6483
|
-
# Container Service Developer Guide*.
|
6558
|
+
# network interface, and you must specify a [NetworkConfiguration][1]
|
6559
|
+
# value when you create a service or run a task with the task
|
6560
|
+
# definition. For more information, see [Task Networking][2] in the
|
6561
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
6484
6562
|
#
|
6485
6563
|
# If the network mode is `host`, you cannot run multiple instantiations
|
6486
6564
|
# of the same task on a single container instance when port mappings are
|
6487
6565
|
# used.
|
6488
6566
|
#
|
6489
|
-
# For more information, see [Network settings][2] in the *Docker run
|
6490
|
-
# reference*.
|
6491
6567
|
#
|
6492
6568
|
#
|
6493
|
-
#
|
6494
|
-
# [
|
6495
|
-
# [2]: https://docs.docker.com/engine/reference/run/#network-settings
|
6569
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html
|
6570
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
6496
6571
|
#
|
6497
6572
|
# @option params [required, Array<Types::ContainerDefinition>] :container_definitions
|
6498
6573
|
# A list of container definitions in JSON format that describe the
|
@@ -6655,12 +6730,10 @@ module Aws::ECS
|
|
6655
6730
|
# the same process namespace.
|
6656
6731
|
#
|
6657
6732
|
# If no value is specified, the default is a private namespace for each
|
6658
|
-
# container.
|
6659
|
-
# run reference*.
|
6733
|
+
# container.
|
6660
6734
|
#
|
6661
6735
|
# If the `host` PID mode is used, there's a heightened risk of
|
6662
|
-
# undesired process namespace exposure.
|
6663
|
-
# [Docker security][2].
|
6736
|
+
# undesired process namespace exposure.
|
6664
6737
|
#
|
6665
6738
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
6666
6739
|
#
|
@@ -6672,11 +6745,6 @@ module Aws::ECS
|
|
6672
6745
|
#
|
6673
6746
|
# </note>
|
6674
6747
|
#
|
6675
|
-
#
|
6676
|
-
#
|
6677
|
-
# [1]: https://docs.docker.com/engine/reference/run/#pid-settings---pid
|
6678
|
-
# [2]: https://docs.docker.com/engine/security/security/
|
6679
|
-
#
|
6680
6748
|
# @option params [String] :ipc_mode
|
6681
6749
|
# The IPC resource namespace to use for the containers in the task. The
|
6682
6750
|
# valid values are `host`, `task`, or `none`. If `host` is specified,
|
@@ -6688,16 +6756,14 @@ module Aws::ECS
|
|
6688
6756
|
# private and not shared with other containers in a task or on the
|
6689
6757
|
# container instance. If no value is specified, then the IPC resource
|
6690
6758
|
# namespace sharing depends on the Docker daemon setting on the
|
6691
|
-
# container instance.
|
6692
|
-
# *Docker run reference*.
|
6759
|
+
# container instance.
|
6693
6760
|
#
|
6694
6761
|
# If the `host` IPC mode is used, be aware that there is a heightened
|
6695
|
-
# risk of undesired IPC namespace expose.
|
6696
|
-
# [Docker security][2].
|
6762
|
+
# risk of undesired IPC namespace expose.
|
6697
6763
|
#
|
6698
6764
|
# If you are setting namespaced kernel parameters using `systemControls`
|
6699
6765
|
# for the containers in the task, the following will apply to your IPC
|
6700
|
-
# resource namespace. For more information, see [System Controls][
|
6766
|
+
# resource namespace. For more information, see [System Controls][1] in
|
6701
6767
|
# the *Amazon Elastic Container Service Developer Guide*.
|
6702
6768
|
#
|
6703
6769
|
# * For tasks that use the `host` IPC mode, IPC namespace related
|
@@ -6713,9 +6779,7 @@ module Aws::ECS
|
|
6713
6779
|
#
|
6714
6780
|
#
|
6715
6781
|
#
|
6716
|
-
# [1]: https://docs.
|
6717
|
-
# [2]: https://docs.docker.com/engine/security/security/
|
6718
|
-
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html
|
6782
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html
|
6719
6783
|
#
|
6720
6784
|
# @option params [Types::ProxyConfiguration] :proxy_configuration
|
6721
6785
|
# The configuration details for the App Mesh proxy.
|
@@ -6852,6 +6916,11 @@ module Aws::ECS
|
|
6852
6916
|
# },
|
6853
6917
|
# ],
|
6854
6918
|
# essential: false,
|
6919
|
+
# restart_policy: {
|
6920
|
+
# enabled: false, # required
|
6921
|
+
# ignored_exit_codes: [1],
|
6922
|
+
# restart_attempt_period: 1,
|
6923
|
+
# },
|
6855
6924
|
# entry_point: ["String"],
|
6856
6925
|
# command: ["String"],
|
6857
6926
|
# environment: [
|
@@ -7084,6 +7153,10 @@ module Aws::ECS
|
|
7084
7153
|
# resp.task_definition.container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
|
7085
7154
|
# resp.task_definition.container_definitions[0].port_mappings[0].container_port_range #=> String
|
7086
7155
|
# resp.task_definition.container_definitions[0].essential #=> Boolean
|
7156
|
+
# resp.task_definition.container_definitions[0].restart_policy.enabled #=> Boolean
|
7157
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes #=> Array
|
7158
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes[0] #=> Integer
|
7159
|
+
# resp.task_definition.container_definitions[0].restart_policy.restart_attempt_period #=> Integer
|
7087
7160
|
# resp.task_definition.container_definitions[0].entry_point #=> Array
|
7088
7161
|
# resp.task_definition.container_definitions[0].entry_point[0] #=> String
|
7089
7162
|
# resp.task_definition.container_definitions[0].command #=> Array
|
@@ -7257,7 +7330,7 @@ module Aws::ECS
|
|
7257
7330
|
# strategies. For more information, see [Scheduling Tasks][1] in the
|
7258
7331
|
# *Amazon Elastic Container Service Developer Guide*.
|
7259
7332
|
#
|
7260
|
-
# Alternatively, you can use StartTask to use your own scheduler or
|
7333
|
+
# Alternatively, you can use `StartTask` to use your own scheduler or
|
7261
7334
|
# place tasks manually on specific container instances.
|
7262
7335
|
#
|
7263
7336
|
# Starting April 15, 2023, Amazon Web Services will not onboard new
|
@@ -7426,13 +7499,17 @@ module Aws::ECS
|
|
7426
7499
|
# Specifies whether to propagate the tags from the task definition to
|
7427
7500
|
# the task. If no value is specified, the tags aren't propagated. Tags
|
7428
7501
|
# can only be propagated to the task during task creation. To add tags
|
7429
|
-
# to a task after task creation, use the
|
7502
|
+
# to a task after task creation, use the[TagResource][1] API action.
|
7430
7503
|
#
|
7431
7504
|
# <note markdown="1"> An error will be received if you specify the `SERVICE` option when
|
7432
7505
|
# running a task.
|
7433
7506
|
#
|
7434
7507
|
# </note>
|
7435
7508
|
#
|
7509
|
+
#
|
7510
|
+
#
|
7511
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html
|
7512
|
+
#
|
7436
7513
|
# @option params [String] :reference_id
|
7437
7514
|
# The reference ID to use for the task. The reference ID can have a
|
7438
7515
|
# maximum length of 1024 characters.
|
@@ -7442,13 +7519,18 @@ module Aws::ECS
|
|
7442
7519
|
# automatically trigger a task to run a batch process job, you could
|
7443
7520
|
# apply a unique identifier for that job to your task with the
|
7444
7521
|
# `startedBy` parameter. You can then identify which tasks belong to
|
7445
|
-
# that job by filtering the results of a ListTasks call with the
|
7522
|
+
# that job by filtering the results of a [ListTasks][1] call with the
|
7446
7523
|
# `startedBy` value. Up to 128 letters (uppercase and lowercase),
|
7447
|
-
# numbers, hyphens (-), and underscores (\_) are
|
7524
|
+
# numbers, hyphens (-), forward slash (/), and underscores (\_) are
|
7525
|
+
# allowed.
|
7448
7526
|
#
|
7449
7527
|
# If a task is started by an Amazon ECS service, then the `startedBy`
|
7450
7528
|
# parameter contains the deployment ID of the service that starts it.
|
7451
7529
|
#
|
7530
|
+
#
|
7531
|
+
#
|
7532
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html
|
7533
|
+
#
|
7452
7534
|
# @option params [Array<Types::Tag>] :tags
|
7453
7535
|
# The metadata that you apply to the task to help you categorize and
|
7454
7536
|
# organize them. Each tag consists of a key and an optional value, both
|
@@ -7836,7 +7918,7 @@ module Aws::ECS
|
|
7836
7918
|
# at least once during the past 30-day period are considered current
|
7837
7919
|
# customers and will be able to continue using the service.
|
7838
7920
|
#
|
7839
|
-
# Alternatively, you can use
|
7921
|
+
# Alternatively, you can use`RunTask` to place tasks for you. For more
|
7840
7922
|
# information, see [Scheduling Tasks][1] in the *Amazon Elastic
|
7841
7923
|
# Container Service Developer Guide*.
|
7842
7924
|
#
|
@@ -7912,13 +7994,18 @@ module Aws::ECS
|
|
7912
7994
|
# automatically trigger a task to run a batch process job, you could
|
7913
7995
|
# apply a unique identifier for that job to your task with the
|
7914
7996
|
# `startedBy` parameter. You can then identify which tasks belong to
|
7915
|
-
# that job by filtering the results of a ListTasks call with the
|
7997
|
+
# that job by filtering the results of a [ListTasks][1] call with the
|
7916
7998
|
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
7917
|
-
# numbers, hyphens (-), and underscores (\_) are
|
7999
|
+
# numbers, hyphens (-), forward slash (/), and underscores (\_) are
|
8000
|
+
# allowed.
|
7918
8001
|
#
|
7919
8002
|
# If a task is started by an Amazon ECS service, the `startedBy`
|
7920
8003
|
# parameter contains the deployment ID of the service that starts it.
|
7921
8004
|
#
|
8005
|
+
#
|
8006
|
+
#
|
8007
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html
|
8008
|
+
#
|
7922
8009
|
# @option params [Array<Types::Tag>] :tags
|
7923
8010
|
# The metadata that you apply to the task to help you categorize and
|
7924
8011
|
# organize them. Each tag consists of a key and an optional value, both
|
@@ -8195,7 +8282,7 @@ module Aws::ECS
|
|
8195
8282
|
# Stops a running task. Any tags associated with the task will be
|
8196
8283
|
# deleted.
|
8197
8284
|
#
|
8198
|
-
# When
|
8285
|
+
# When you call `StopTask` on a task, the equivalent of `docker stop` is
|
8199
8286
|
# issued to the containers running in the task. This results in a
|
8200
8287
|
# `SIGTERM` value and a default 30-second timeout, after which the
|
8201
8288
|
# `SIGKILL` value is sent and the containers are forcibly stopped. If
|
@@ -8231,7 +8318,11 @@ module Aws::ECS
|
|
8231
8318
|
# An optional message specified when a task is stopped. For example, if
|
8232
8319
|
# you're using a custom scheduler, you can use this parameter to
|
8233
8320
|
# specify the reason for stopping the task here, and the message appears
|
8234
|
-
# in subsequent DescribeTasks API operations on this task.
|
8321
|
+
# in subsequent [DescribeTasks][1]> API operations on this task.
|
8322
|
+
#
|
8323
|
+
#
|
8324
|
+
#
|
8325
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html
|
8235
8326
|
#
|
8236
8327
|
# @return [Types::StopTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8237
8328
|
#
|
@@ -8891,7 +8982,7 @@ module Aws::ECS
|
|
8891
8982
|
# The setting to use by default for a cluster. This parameter is used to
|
8892
8983
|
# turn on CloudWatch Container Insights for a cluster. If this value is
|
8893
8984
|
# specified, it overrides the `containerInsights` value set with
|
8894
|
-
# PutAccountSetting or PutAccountSettingDefault.
|
8985
|
+
# [PutAccountSetting][1] or [PutAccountSettingDefault][2].
|
8895
8986
|
#
|
8896
8987
|
# Currently, if you delete an existing cluster that does not have
|
8897
8988
|
# Container Insights turned on, and then create a new cluster with the
|
@@ -8900,6 +8991,11 @@ module Aws::ECS
|
|
8900
8991
|
# your existing cluster and turn on Container Insights, you must wait 7
|
8901
8992
|
# days before you can re-create it.
|
8902
8993
|
#
|
8994
|
+
#
|
8995
|
+
#
|
8996
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html
|
8997
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html
|
8998
|
+
#
|
8903
8999
|
# @return [Types::UpdateClusterSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8904
9000
|
#
|
8905
9001
|
# * {Types::UpdateClusterSettingsResponse#cluster #cluster} => Types::Cluster
|
@@ -9108,7 +9204,7 @@ module Aws::ECS
|
|
9108
9204
|
# state are stopped and replaced according to the service's deployment
|
9109
9205
|
# configuration parameters, `minimumHealthyPercent` and
|
9110
9206
|
# `maximumPercent`. You can change the deployment configuration of your
|
9111
|
-
# service using UpdateService.
|
9207
|
+
# service using [UpdateService][1].
|
9112
9208
|
#
|
9113
9209
|
# * If `minimumHealthyPercent` is below 100%, the scheduler can ignore
|
9114
9210
|
# `desiredCount` temporarily during task replacement. For example,
|
@@ -9135,12 +9231,17 @@ module Aws::ECS
|
|
9135
9231
|
# manually.
|
9136
9232
|
#
|
9137
9233
|
# A container instance has completed draining when it has no more
|
9138
|
-
# `RUNNING` tasks. You can verify this using ListTasks.
|
9234
|
+
# `RUNNING` tasks. You can verify this using [ListTasks][2].
|
9139
9235
|
#
|
9140
9236
|
# When a container instance has been drained, you can set a container
|
9141
9237
|
# instance to `ACTIVE` status and once it has reached that status the
|
9142
9238
|
# Amazon ECS scheduler can begin scheduling tasks on the instance again.
|
9143
9239
|
#
|
9240
|
+
#
|
9241
|
+
#
|
9242
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
9243
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html
|
9244
|
+
#
|
9144
9245
|
# @option params [String] :cluster
|
9145
9246
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
9146
9247
|
# hosts the container instance to update. If you do not specify a
|
@@ -9281,7 +9382,7 @@ module Aws::ECS
|
|
9281
9382
|
# propagate tags option, using this API. If the launch type, load
|
9282
9383
|
# balancer, network configuration, platform version, or task definition
|
9283
9384
|
# need to be updated, create a new task set For more information, see
|
9284
|
-
# CreateTaskSet.
|
9385
|
+
# [CreateTaskSet][3].
|
9285
9386
|
#
|
9286
9387
|
# You can add to or subtract from the number of instantiations of a task
|
9287
9388
|
# definition in a service by specifying the cluster that the service is
|
@@ -9330,12 +9431,12 @@ module Aws::ECS
|
|
9330
9431
|
# the four older tasks (provided that the cluster resources required
|
9331
9432
|
# to do this are available).
|
9332
9433
|
#
|
9333
|
-
# When UpdateService stops a task during a deployment, the
|
9334
|
-
# `docker stop` is issued to the containers running in the
|
9335
|
-
# results in a `SIGTERM` and a 30-second timeout. After this,
|
9336
|
-
# is sent and the containers are forcibly stopped. If the
|
9337
|
-
# handles the `SIGTERM` gracefully and exits within 30 seconds
|
9338
|
-
# receiving it, no `SIGKILL` is sent.
|
9434
|
+
# When [UpdateService][4] stops a task during a deployment, the
|
9435
|
+
# equivalent of `docker stop` is issued to the containers running in the
|
9436
|
+
# task. This results in a `SIGTERM` and a 30-second timeout. After this,
|
9437
|
+
# `SIGKILL` is sent and the containers are forcibly stopped. If the
|
9438
|
+
# container handles the `SIGTERM` gracefully and exits within 30 seconds
|
9439
|
+
# from receiving it, no `SIGKILL` is sent.
|
9339
9440
|
#
|
9340
9441
|
# When the service scheduler launches new tasks, it determines task
|
9341
9442
|
# placement in your cluster with the following logic.
|
@@ -9381,7 +9482,7 @@ module Aws::ECS
|
|
9381
9482
|
# * `serviceRegistries`
|
9382
9483
|
#
|
9383
9484
|
# For more information about the role see the `CreateService` request
|
9384
|
-
# parameter [ `role` ][
|
9485
|
+
# parameter [ `role` ][5].
|
9385
9486
|
#
|
9386
9487
|
# </note>
|
9387
9488
|
#
|
@@ -9389,7 +9490,9 @@ module Aws::ECS
|
|
9389
9490
|
#
|
9390
9491
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types
|
9391
9492
|
# [2]: https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html
|
9392
|
-
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/
|
9493
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html
|
9494
|
+
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
9495
|
+
# [5]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role
|
9393
9496
|
#
|
9394
9497
|
# @option params [String] :cluster
|
9395
9498
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
@@ -9424,22 +9527,29 @@ module Aws::ECS
|
|
9424
9527
|
# A capacity provider strategy consists of one or more capacity
|
9425
9528
|
# providers along with the `base` and `weight` to assign to them. A
|
9426
9529
|
# capacity provider must be associated with the cluster to be used in a
|
9427
|
-
# capacity provider strategy. The PutClusterCapacityProviders API
|
9428
|
-
# used to associate a capacity provider with a cluster. Only capacity
|
9530
|
+
# capacity provider strategy. The [PutClusterCapacityProviders][1] API
|
9531
|
+
# is used to associate a capacity provider with a cluster. Only capacity
|
9429
9532
|
# providers with an `ACTIVE` or `UPDATING` status can be used.
|
9430
9533
|
#
|
9431
9534
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
9432
9535
|
# capacity provider must already be created. New capacity providers can
|
9433
|
-
# be created with the
|
9536
|
+
# be created with the [CreateClusterCapacityProvider][2] API operation.
|
9434
9537
|
#
|
9435
9538
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
9436
9539
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
9437
9540
|
# available to all accounts and only need to be associated with a
|
9438
9541
|
# cluster to be used.
|
9439
9542
|
#
|
9440
|
-
# The PutClusterCapacityProviders
|
9441
|
-
# list of available capacity providers for a cluster after the
|
9442
|
-
# is created.
|
9543
|
+
# The [PutClusterCapacityProviders][1]API operation is used to update
|
9544
|
+
# the list of available capacity providers for a cluster after the
|
9545
|
+
# cluster is created.
|
9546
|
+
#
|
9547
|
+
#
|
9548
|
+
#
|
9549
|
+
#
|
9550
|
+
#
|
9551
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
9552
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html
|
9443
9553
|
#
|
9444
9554
|
# @option params [Types::DeploymentConfiguration] :deployment_configuration
|
9445
9555
|
# Optional deployment parameters that control how many tasks run during
|
@@ -10324,14 +10434,19 @@ module Aws::ECS
|
|
10324
10434
|
# @api private
|
10325
10435
|
def build_request(operation_name, params = {})
|
10326
10436
|
handlers = @handlers.for(operation_name)
|
10437
|
+
tracer = config.telemetry_provider.tracer_provider.tracer(
|
10438
|
+
Aws::Telemetry.module_to_tracer_name('Aws::ECS')
|
10439
|
+
)
|
10327
10440
|
context = Seahorse::Client::RequestContext.new(
|
10328
10441
|
operation_name: operation_name,
|
10329
10442
|
operation: config.api.operation(operation_name),
|
10330
10443
|
client: self,
|
10331
10444
|
params: params,
|
10332
|
-
config: config
|
10445
|
+
config: config,
|
10446
|
+
tracer: tracer
|
10447
|
+
)
|
10333
10448
|
context[:gem_name] = 'aws-sdk-ecs'
|
10334
|
-
context[:gem_version] = '1.
|
10449
|
+
context[:gem_version] = '1.161.0'
|
10335
10450
|
Seahorse::Client::Request.new(handlers, context)
|
10336
10451
|
end
|
10337
10452
|
|