aws-sdk-ecs 1.153.0 → 1.155.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ecs/client.rb +185 -94
- data/lib/aws-sdk-ecs/types.rb +279 -141
- data/lib/aws-sdk-ecs.rb +1 -1
- data/sig/client.rbs +1 -0
- data/sig/resource.rbs +1 -0
- metadata +4 -4
data/lib/aws-sdk-ecs/client.rb
CHANGED
|
@@ -32,6 +32,7 @@ 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
|
|
|
@@ -83,6 +84,7 @@ module Aws::ECS
|
|
|
83
84
|
add_plugin(Aws::Plugins::RequestCompression)
|
|
84
85
|
add_plugin(Aws::Plugins::DefaultsMode)
|
|
85
86
|
add_plugin(Aws::Plugins::RecursionDetection)
|
|
87
|
+
add_plugin(Aws::Plugins::Telemetry)
|
|
86
88
|
add_plugin(Aws::Plugins::Sign)
|
|
87
89
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
|
88
90
|
add_plugin(Aws::ECS::Plugins::Endpoints)
|
|
@@ -337,6 +339,16 @@ module Aws::ECS
|
|
|
337
339
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
338
340
|
# requests are made, and retries are disabled.
|
|
339
341
|
#
|
|
342
|
+
# @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
|
|
343
|
+
# Allows you to provide a telemetry provider, which is used to
|
|
344
|
+
# emit telemetry data. By default, uses `NoOpTelemetryProvider` which
|
|
345
|
+
# will not record or emit any telemetry data. The SDK supports the
|
|
346
|
+
# following telemetry providers:
|
|
347
|
+
#
|
|
348
|
+
# * OpenTelemetry (OTel) - To use the OTel provider, install and require the
|
|
349
|
+
# `opentelemetry-sdk` gem and then, pass in an instance of a
|
|
350
|
+
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
|
351
|
+
#
|
|
340
352
|
# @option options [Aws::TokenProvider] :token_provider
|
|
341
353
|
# A Bearer Token Provider. This can be an instance of any one of the
|
|
342
354
|
# following classes:
|
|
@@ -538,23 +550,23 @@ module Aws::ECS
|
|
|
538
550
|
|
|
539
551
|
# Creates a new Amazon ECS cluster. By default, your account receives a
|
|
540
552
|
# `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*.
|
|
553
|
+
# However, you can create your own cluster with a unique name.
|
|
554
|
+
#
|
|
555
|
+
# <note markdown="1"> When you call the [CreateCluster][1] API operation, Amazon ECS
|
|
556
|
+
# attempts to create the Amazon ECS service-linked role for your
|
|
557
|
+
# account. This is so that it can manage required resources in other
|
|
558
|
+
# Amazon Web Services services on your behalf. However, if the user that
|
|
559
|
+
# makes the call doesn't have permissions to create the service-linked
|
|
560
|
+
# role, it isn't created. For more information, see [Using
|
|
561
|
+
# service-linked roles for Amazon ECS][2] in the *Amazon Elastic
|
|
562
|
+
# Container Service Developer Guide*.
|
|
552
563
|
#
|
|
553
564
|
# </note>
|
|
554
565
|
#
|
|
555
566
|
#
|
|
556
567
|
#
|
|
557
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/
|
|
568
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html
|
|
569
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html
|
|
558
570
|
#
|
|
559
571
|
# @option params [String] :cluster_name
|
|
560
572
|
# The name of your cluster. If you don't specify a name for your
|
|
@@ -596,7 +608,12 @@ module Aws::ECS
|
|
|
596
608
|
# The setting to use when creating a cluster. This parameter is used to
|
|
597
609
|
# turn on CloudWatch Container Insights for a cluster. If this value is
|
|
598
610
|
# specified, it overrides the `containerInsights` value set with
|
|
599
|
-
# PutAccountSetting or PutAccountSettingDefault.
|
|
611
|
+
# [PutAccountSetting][1] or [PutAccountSettingDefault][2].
|
|
612
|
+
#
|
|
613
|
+
#
|
|
614
|
+
#
|
|
615
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html
|
|
616
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html
|
|
600
617
|
#
|
|
601
618
|
# @option params [Types::ClusterConfiguration] :configuration
|
|
602
619
|
# The `execute` command configuration for the cluster.
|
|
@@ -638,12 +655,13 @@ module Aws::ECS
|
|
|
638
655
|
#
|
|
639
656
|
# If a default capacity provider strategy isn't defined for a cluster
|
|
640
657
|
# when it was created, it can be defined later with the
|
|
641
|
-
# PutClusterCapacityProviders API operation.
|
|
658
|
+
# [PutClusterCapacityProviders][3] API operation.
|
|
642
659
|
#
|
|
643
660
|
#
|
|
644
661
|
#
|
|
645
662
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html
|
|
646
663
|
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html
|
|
664
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
|
647
665
|
#
|
|
648
666
|
# @option params [Types::ClusterServiceConnectDefaultsRequest] :service_connect_defaults
|
|
649
667
|
# Use this parameter to set a default Service Connect namespace. After
|
|
@@ -794,8 +812,8 @@ module Aws::ECS
|
|
|
794
812
|
# Runs and maintains your desired number of tasks from a specified task
|
|
795
813
|
# definition. If the number of tasks running in a service drops below
|
|
796
814
|
# the `desiredCount`, Amazon ECS runs another copy of the task in the
|
|
797
|
-
# specified cluster. To update an existing service,
|
|
798
|
-
# UpdateService
|
|
815
|
+
# specified cluster. To update an existing service, use
|
|
816
|
+
# [UpdateService][1].
|
|
799
817
|
#
|
|
800
818
|
# <note markdown="1"> On March 21, 2024, a change was made to resolve the task definition
|
|
801
819
|
# revision before authorization. When a task definition revision is not
|
|
@@ -808,13 +826,13 @@ module Aws::ECS
|
|
|
808
826
|
# you can optionally run your service behind one or more load balancers.
|
|
809
827
|
# The load balancers distribute traffic across the tasks that are
|
|
810
828
|
# associated with the service. For more information, see [Service load
|
|
811
|
-
# balancing][
|
|
829
|
+
# balancing][2] in the *Amazon Elastic Container Service Developer
|
|
812
830
|
# Guide*.
|
|
813
831
|
#
|
|
814
832
|
# You can attach Amazon EBS volumes to Amazon ECS tasks by configuring
|
|
815
833
|
# the volume when creating or updating a service. `volumeConfigurations`
|
|
816
834
|
# is only supported for REPLICA service and not DAEMON service. For more
|
|
817
|
-
# infomation, see [Amazon EBS volumes][
|
|
835
|
+
# infomation, see [Amazon EBS volumes][3] in the *Amazon Elastic
|
|
818
836
|
# Container Service Developer Guide*.
|
|
819
837
|
#
|
|
820
838
|
# Tasks for services that don't use a load balancer are considered
|
|
@@ -829,7 +847,7 @@ module Aws::ECS
|
|
|
829
847
|
# service scheduler spreads tasks across Availability Zones. You can
|
|
830
848
|
# use task placement strategies and constraints to customize task
|
|
831
849
|
# placement decisions. For more information, see [Service scheduler
|
|
832
|
-
# concepts][
|
|
850
|
+
# concepts][4] in the *Amazon Elastic Container Service Developer
|
|
833
851
|
# Guide*.
|
|
834
852
|
#
|
|
835
853
|
# * `DAEMON` - The daemon scheduling strategy deploys exactly one task
|
|
@@ -840,16 +858,16 @@ module Aws::ECS
|
|
|
840
858
|
# constraints. When using this strategy, you don't need to specify a
|
|
841
859
|
# desired number of tasks, a task placement strategy, or use Service
|
|
842
860
|
# Auto Scaling policies. For more information, see [Service scheduler
|
|
843
|
-
# concepts][
|
|
861
|
+
# concepts][4] in the *Amazon Elastic Container Service Developer
|
|
844
862
|
# Guide*.
|
|
845
863
|
#
|
|
846
864
|
# You can optionally specify a deployment configuration for your
|
|
847
865
|
# service. The deployment is initiated by changing properties. For
|
|
848
866
|
# example, the deployment might be initiated by the task definition or
|
|
849
|
-
# by your desired count of a service.
|
|
850
|
-
#
|
|
851
|
-
#
|
|
852
|
-
#
|
|
867
|
+
# by your desired count of a service. You can use [UpdateService][1].
|
|
868
|
+
# The default value for a replica service for `minimumHealthyPercent` is
|
|
869
|
+
# 100%. The default value for a daemon service for
|
|
870
|
+
# `minimumHealthyPercent` is 0%.
|
|
853
871
|
#
|
|
854
872
|
# If a service uses the `ECS` deployment controller, the minimum healthy
|
|
855
873
|
# percent represents a lower limit on the number of tasks in a service
|
|
@@ -895,13 +913,13 @@ module Aws::ECS
|
|
|
895
913
|
# When creating a service that uses the `EXTERNAL` deployment
|
|
896
914
|
# controller, you can specify only parameters that aren't controlled at
|
|
897
915
|
# 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][
|
|
916
|
+
# You control your services using the [CreateTaskSet][5]. For more
|
|
917
|
+
# information, see [Amazon ECS deployment types][6] in the *Amazon
|
|
900
918
|
# Elastic Container Service Developer Guide*.
|
|
901
919
|
#
|
|
902
920
|
# When the service scheduler launches new tasks, it determines task
|
|
903
921
|
# placement. For information about task placement and task placement
|
|
904
|
-
# strategies, see [Amazon ECS task placement][
|
|
922
|
+
# strategies, see [Amazon ECS task placement][7] in the *Amazon Elastic
|
|
905
923
|
# Container Service Developer Guide*
|
|
906
924
|
#
|
|
907
925
|
# Starting April 15, 2023, Amazon Web Services will not onboard new
|
|
@@ -915,11 +933,13 @@ module Aws::ECS
|
|
|
915
933
|
#
|
|
916
934
|
#
|
|
917
935
|
#
|
|
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/
|
|
936
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
|
937
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html
|
|
938
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types
|
|
939
|
+
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html
|
|
940
|
+
# [5]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html
|
|
941
|
+
# [6]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html
|
|
942
|
+
# [7]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html
|
|
923
943
|
#
|
|
924
944
|
# @option params [String] :cluster
|
|
925
945
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
@@ -1811,8 +1831,8 @@ module Aws::ECS
|
|
|
1811
1831
|
# A capacity provider strategy consists of one or more capacity
|
|
1812
1832
|
# providers along with the `base` and `weight` to assign to them. A
|
|
1813
1833
|
# 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
|
|
1834
|
+
# capacity provider strategy. The [PutClusterCapacityProviders][1] API
|
|
1835
|
+
# is used to associate a capacity provider with a cluster. Only capacity
|
|
1816
1836
|
# providers with an `ACTIVE` or `UPDATING` status can be used.
|
|
1817
1837
|
#
|
|
1818
1838
|
# If a `capacityProviderStrategy` is specified, the `launchType`
|
|
@@ -1822,16 +1842,21 @@ module Aws::ECS
|
|
|
1822
1842
|
#
|
|
1823
1843
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
|
1824
1844
|
# capacity provider must already be created. New capacity providers can
|
|
1825
|
-
# be created with the
|
|
1845
|
+
# be created with the [CreateCapacityProviderProvider][2]API operation.
|
|
1826
1846
|
#
|
|
1827
1847
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
|
1828
1848
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
|
1829
1849
|
# available to all accounts and only need to be associated with a
|
|
1830
1850
|
# cluster to be used.
|
|
1831
1851
|
#
|
|
1832
|
-
# The PutClusterCapacityProviders API operation is used to update
|
|
1833
|
-
# list of available capacity providers for a cluster after the
|
|
1834
|
-
# is created.
|
|
1852
|
+
# The [PutClusterCapacityProviders][1] API operation is used to update
|
|
1853
|
+
# the list of available capacity providers for a cluster after the
|
|
1854
|
+
# cluster is created.
|
|
1855
|
+
#
|
|
1856
|
+
#
|
|
1857
|
+
#
|
|
1858
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
|
1859
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProviderProvider.html
|
|
1835
1860
|
#
|
|
1836
1861
|
# @option params [String] :platform_version
|
|
1837
1862
|
# The platform version that the tasks in the task set uses. A platform
|
|
@@ -2126,20 +2151,26 @@ module Aws::ECS
|
|
|
2126
2151
|
#
|
|
2127
2152
|
# <note markdown="1"> The `FARGATE` and `FARGATE_SPOT` capacity providers are reserved and
|
|
2128
2153
|
# can't be deleted. You can disassociate them from a cluster using
|
|
2129
|
-
# either
|
|
2154
|
+
# either [PutCapacityProviderProviders][1] or by deleting the cluster.
|
|
2130
2155
|
#
|
|
2131
2156
|
# </note>
|
|
2132
2157
|
#
|
|
2133
2158
|
# Prior to a capacity provider being deleted, the capacity provider must
|
|
2134
2159
|
# 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
|
|
2160
|
+
# [UpdateService][2] API can be used to remove a capacity provider from
|
|
2161
|
+
# a service's capacity provider strategy. When updating a service, the
|
|
2137
2162
|
# `forceNewDeployment` option can be used to ensure that any tasks using
|
|
2138
2163
|
# the Amazon EC2 instance capacity provided by the capacity provider are
|
|
2139
2164
|
# transitioned to use the capacity from the remaining capacity
|
|
2140
2165
|
# providers. Only capacity providers that aren't associated with a
|
|
2141
2166
|
# cluster can be deleted. To remove a capacity provider from a cluster,
|
|
2142
|
-
# you can either use
|
|
2167
|
+
# you can either use [PutCapacityProviderProviders][1] or delete the
|
|
2168
|
+
# cluster.
|
|
2169
|
+
#
|
|
2170
|
+
#
|
|
2171
|
+
#
|
|
2172
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProviderProviders.html
|
|
2173
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
|
2143
2174
|
#
|
|
2144
2175
|
# @option params [required, String] :capacity_provider
|
|
2145
2176
|
# The short name or full Amazon Resource Name (ARN) of the capacity
|
|
@@ -2191,8 +2222,13 @@ module Aws::ECS
|
|
|
2191
2222
|
#
|
|
2192
2223
|
# You must deregister all container instances from this cluster before
|
|
2193
2224
|
# you may delete it. You can list the container instances in a cluster
|
|
2194
|
-
# with ListContainerInstances and deregister them with
|
|
2195
|
-
# DeregisterContainerInstance.
|
|
2225
|
+
# with [ListContainerInstances][1] and deregister them with
|
|
2226
|
+
# [DeregisterContainerInstance][2].
|
|
2227
|
+
#
|
|
2228
|
+
#
|
|
2229
|
+
#
|
|
2230
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html
|
|
2231
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html
|
|
2196
2232
|
#
|
|
2197
2233
|
# @option params [required, String] :cluster
|
|
2198
2234
|
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
@@ -2286,18 +2322,19 @@ module Aws::ECS
|
|
|
2286
2322
|
# if you have no running tasks in it and the desired task count is zero.
|
|
2287
2323
|
# If the service is actively maintaining tasks, you can't delete it,
|
|
2288
2324
|
# and you must update the service to a desired task count of zero. For
|
|
2289
|
-
# more information, see UpdateService.
|
|
2325
|
+
# more information, see [UpdateService][1].
|
|
2290
2326
|
#
|
|
2291
2327
|
# <note markdown="1"> When you delete a service, if there are still running tasks that
|
|
2292
2328
|
# require cleanup, the service status moves from `ACTIVE` to `DRAINING`,
|
|
2293
2329
|
# and the service is no longer visible in the console or in the
|
|
2294
|
-
# ListServices API operation. After all tasks have transitioned to
|
|
2330
|
+
# [ListServices][2] API operation. After all tasks have transitioned to
|
|
2295
2331
|
# either `STOPPING` or `STOPPED` status, the service status moves from
|
|
2296
2332
|
# `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
|
|
2333
|
+
# status can still be viewed with the [DescribeServices][3] API
|
|
2334
|
+
# operation. However, in the future, `INACTIVE` services may be cleaned
|
|
2335
|
+
# up and purged from Amazon ECS record keeping, and
|
|
2336
|
+
# [DescribeServices][3] calls on those services return a
|
|
2337
|
+
# `ServiceNotFoundException` error.
|
|
2301
2338
|
#
|
|
2302
2339
|
# </note>
|
|
2303
2340
|
#
|
|
@@ -2305,6 +2342,12 @@ module Aws::ECS
|
|
|
2305
2342
|
# existing service in either `ACTIVE` or `DRAINING` status, you receive
|
|
2306
2343
|
# an error.
|
|
2307
2344
|
#
|
|
2345
|
+
#
|
|
2346
|
+
#
|
|
2347
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
|
2348
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html
|
|
2349
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html
|
|
2350
|
+
#
|
|
2308
2351
|
# @option params [String] :cluster
|
|
2309
2352
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
2310
2353
|
# hosts the service to delete. If you do not specify a cluster, the
|
|
@@ -5021,9 +5064,14 @@ module Aws::ECS
|
|
|
5021
5064
|
# @option params [String] :status
|
|
5022
5065
|
# Filters the container instances by status. For example, if you specify
|
|
5023
5066
|
# the `DRAINING` status, the results include only container instances
|
|
5024
|
-
# that have been set to `DRAINING` using
|
|
5025
|
-
# If you don't specify this
|
|
5026
|
-
# container instances set to all
|
|
5067
|
+
# that have been set to `DRAINING` using
|
|
5068
|
+
# [UpdateContainerInstancesState][1]. If you don't specify this
|
|
5069
|
+
# parameter, the default is to include container instances set to all
|
|
5070
|
+
# states other than `INACTIVE`.
|
|
5071
|
+
#
|
|
5072
|
+
#
|
|
5073
|
+
#
|
|
5074
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateContainerInstancesState.html
|
|
5027
5075
|
#
|
|
5028
5076
|
# @return [Types::ListContainerInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5029
5077
|
#
|
|
@@ -6036,12 +6084,13 @@ module Aws::ECS
|
|
|
6036
6084
|
# Create or update an attribute on an Amazon ECS resource. If the
|
|
6037
6085
|
# attribute doesn't exist, it's created. If the attribute exists, its
|
|
6038
6086
|
# value is replaced with the specified value. To delete an attribute,
|
|
6039
|
-
# use DeleteAttributes. For more information, see [Attributes][
|
|
6040
|
-
# *Amazon Elastic Container Service Developer Guide*.
|
|
6087
|
+
# use [DeleteAttributes][1]. For more information, see [Attributes][2]
|
|
6088
|
+
# in the *Amazon Elastic Container Service Developer Guide*.
|
|
6041
6089
|
#
|
|
6042
6090
|
#
|
|
6043
6091
|
#
|
|
6044
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/
|
|
6092
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteAttributes.html
|
|
6093
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes
|
|
6045
6094
|
#
|
|
6046
6095
|
# @option params [String] :cluster
|
|
6047
6096
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
@@ -6096,10 +6145,10 @@ module Aws::ECS
|
|
|
6096
6145
|
# has existing capacity providers associated with it, you must specify
|
|
6097
6146
|
# all existing capacity providers in addition to any new ones you want
|
|
6098
6147
|
# to add. Any existing capacity providers that are associated with a
|
|
6099
|
-
# cluster that are omitted from a PutClusterCapacityProviders API
|
|
6100
|
-
# will be disassociated with the cluster. You can only disassociate
|
|
6101
|
-
# existing capacity provider from a cluster if it's not being used
|
|
6102
|
-
# any existing tasks.
|
|
6148
|
+
# cluster that are omitted from a [PutClusterCapacityProviders][1] API
|
|
6149
|
+
# call will be disassociated with the cluster. You can only disassociate
|
|
6150
|
+
# an existing capacity provider from a cluster if it's not being used
|
|
6151
|
+
# by any existing tasks.
|
|
6103
6152
|
#
|
|
6104
6153
|
# When creating a service or running a task on a cluster, if no capacity
|
|
6105
6154
|
# provider or launch type is specified, then the cluster's default
|
|
@@ -6107,6 +6156,10 @@ module Aws::ECS
|
|
|
6107
6156
|
# default capacity provider strategy for your cluster. However, you must
|
|
6108
6157
|
# specify an empty array (`[]`) to bypass defining a default strategy.
|
|
6109
6158
|
#
|
|
6159
|
+
#
|
|
6160
|
+
#
|
|
6161
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
|
6162
|
+
#
|
|
6110
6163
|
# @option params [required, String] :cluster
|
|
6111
6164
|
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
6112
6165
|
# modify the capacity provider settings for. If you don't specify a
|
|
@@ -6118,13 +6171,17 @@ module Aws::ECS
|
|
|
6118
6171
|
#
|
|
6119
6172
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
|
6120
6173
|
# capacity provider must already be created. New capacity providers can
|
|
6121
|
-
# be created with the CreateCapacityProvider API operation.
|
|
6174
|
+
# be created with the [CreateCapacityProvider][1] API operation.
|
|
6122
6175
|
#
|
|
6123
6176
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
|
6124
6177
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
|
6125
6178
|
# available to all accounts and only need to be associated with a
|
|
6126
6179
|
# cluster to be used.
|
|
6127
6180
|
#
|
|
6181
|
+
#
|
|
6182
|
+
#
|
|
6183
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html
|
|
6184
|
+
#
|
|
6128
6185
|
# @option params [required, Array<Types::CapacityProviderStrategyItem>] :default_capacity_provider_strategy
|
|
6129
6186
|
# The capacity provider strategy to use by default for the cluster.
|
|
6130
6187
|
#
|
|
@@ -6135,19 +6192,24 @@ module Aws::ECS
|
|
|
6135
6192
|
# A capacity provider strategy consists of one or more capacity
|
|
6136
6193
|
# providers along with the `base` and `weight` to assign to them. A
|
|
6137
6194
|
# capacity provider must be associated with the cluster to be used in a
|
|
6138
|
-
# capacity provider strategy. The PutClusterCapacityProviders API
|
|
6139
|
-
# used to associate a capacity provider with a cluster. Only capacity
|
|
6195
|
+
# capacity provider strategy. The [PutClusterCapacityProviders][1] API
|
|
6196
|
+
# is used to associate a capacity provider with a cluster. Only capacity
|
|
6140
6197
|
# providers with an `ACTIVE` or `UPDATING` status can be used.
|
|
6141
6198
|
#
|
|
6142
6199
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
|
6143
6200
|
# capacity provider must already be created. New capacity providers can
|
|
6144
|
-
# be created with the CreateCapacityProvider API operation.
|
|
6201
|
+
# be created with the [CreateCapacityProvider][2] API operation.
|
|
6145
6202
|
#
|
|
6146
6203
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
|
6147
6204
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
|
6148
6205
|
# available to all accounts and only need to be associated with a
|
|
6149
6206
|
# cluster to be used.
|
|
6150
6207
|
#
|
|
6208
|
+
#
|
|
6209
|
+
#
|
|
6210
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
|
6211
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html
|
|
6212
|
+
#
|
|
6151
6213
|
# @return [Types::PutClusterCapacityProvidersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6152
6214
|
#
|
|
6153
6215
|
# * {Types::PutClusterCapacityProvidersResponse#cluster #cluster} => Types::Cluster
|
|
@@ -6419,16 +6481,17 @@ module Aws::ECS
|
|
|
6419
6481
|
# You can specify a Docker networking mode for the containers in your
|
|
6420
6482
|
# task definition with the `networkMode` parameter. If you specify the
|
|
6421
6483
|
# `awsvpc` network mode, the task is allocated an elastic network
|
|
6422
|
-
# interface, and you must specify a NetworkConfiguration when you
|
|
6423
|
-
# a service or run a task with the task definition. For more
|
|
6424
|
-
# information, see [Task Networking][
|
|
6484
|
+
# interface, and you must specify a [NetworkConfiguration][3] when you
|
|
6485
|
+
# create a service or run a task with the task definition. For more
|
|
6486
|
+
# information, see [Task Networking][4] in the *Amazon Elastic Container
|
|
6425
6487
|
# Service Developer Guide*.
|
|
6426
6488
|
#
|
|
6427
6489
|
#
|
|
6428
6490
|
#
|
|
6429
6491
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html
|
|
6430
6492
|
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html
|
|
6431
|
-
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/
|
|
6493
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html
|
|
6494
|
+
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
|
6432
6495
|
#
|
|
6433
6496
|
# @option params [required, String] :family
|
|
6434
6497
|
# You must specify a `family` for a task definition. You can use it
|
|
@@ -7260,7 +7323,7 @@ module Aws::ECS
|
|
|
7260
7323
|
# strategies. For more information, see [Scheduling Tasks][1] in the
|
|
7261
7324
|
# *Amazon Elastic Container Service Developer Guide*.
|
|
7262
7325
|
#
|
|
7263
|
-
# Alternatively, you can use StartTask to use your own scheduler or
|
|
7326
|
+
# Alternatively, you can use `StartTask` to use your own scheduler or
|
|
7264
7327
|
# place tasks manually on specific container instances.
|
|
7265
7328
|
#
|
|
7266
7329
|
# Starting April 15, 2023, Amazon Web Services will not onboard new
|
|
@@ -7429,13 +7492,17 @@ module Aws::ECS
|
|
|
7429
7492
|
# Specifies whether to propagate the tags from the task definition to
|
|
7430
7493
|
# the task. If no value is specified, the tags aren't propagated. Tags
|
|
7431
7494
|
# can only be propagated to the task during task creation. To add tags
|
|
7432
|
-
# to a task after task creation, use the
|
|
7495
|
+
# to a task after task creation, use the[TagResource][1] API action.
|
|
7433
7496
|
#
|
|
7434
7497
|
# <note markdown="1"> An error will be received if you specify the `SERVICE` option when
|
|
7435
7498
|
# running a task.
|
|
7436
7499
|
#
|
|
7437
7500
|
# </note>
|
|
7438
7501
|
#
|
|
7502
|
+
#
|
|
7503
|
+
#
|
|
7504
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html
|
|
7505
|
+
#
|
|
7439
7506
|
# @option params [String] :reference_id
|
|
7440
7507
|
# The reference ID to use for the task. The reference ID can have a
|
|
7441
7508
|
# maximum length of 1024 characters.
|
|
@@ -7844,7 +7911,7 @@ module Aws::ECS
|
|
|
7844
7911
|
# at least once during the past 30-day period are considered current
|
|
7845
7912
|
# customers and will be able to continue using the service.
|
|
7846
7913
|
#
|
|
7847
|
-
# Alternatively, you can use
|
|
7914
|
+
# Alternatively, you can use`RunTask` to place tasks for you. For more
|
|
7848
7915
|
# information, see [Scheduling Tasks][1] in the *Amazon Elastic
|
|
7849
7916
|
# Container Service Developer Guide*.
|
|
7850
7917
|
#
|
|
@@ -8208,7 +8275,7 @@ module Aws::ECS
|
|
|
8208
8275
|
# Stops a running task. Any tags associated with the task will be
|
|
8209
8276
|
# deleted.
|
|
8210
8277
|
#
|
|
8211
|
-
# When
|
|
8278
|
+
# When you call `StopTask` on a task, the equivalent of `docker stop` is
|
|
8212
8279
|
# issued to the containers running in the task. This results in a
|
|
8213
8280
|
# `SIGTERM` value and a default 30-second timeout, after which the
|
|
8214
8281
|
# `SIGKILL` value is sent and the containers are forcibly stopped. If
|
|
@@ -8244,7 +8311,11 @@ module Aws::ECS
|
|
|
8244
8311
|
# An optional message specified when a task is stopped. For example, if
|
|
8245
8312
|
# you're using a custom scheduler, you can use this parameter to
|
|
8246
8313
|
# specify the reason for stopping the task here, and the message appears
|
|
8247
|
-
# in subsequent DescribeTasks API operations on this task.
|
|
8314
|
+
# in subsequent [DescribeTasks][1]> API operations on this task.
|
|
8315
|
+
#
|
|
8316
|
+
#
|
|
8317
|
+
#
|
|
8318
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html
|
|
8248
8319
|
#
|
|
8249
8320
|
# @return [Types::StopTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
8250
8321
|
#
|
|
@@ -8904,7 +8975,7 @@ module Aws::ECS
|
|
|
8904
8975
|
# The setting to use by default for a cluster. This parameter is used to
|
|
8905
8976
|
# turn on CloudWatch Container Insights for a cluster. If this value is
|
|
8906
8977
|
# specified, it overrides the `containerInsights` value set with
|
|
8907
|
-
# PutAccountSetting or PutAccountSettingDefault.
|
|
8978
|
+
# [PutAccountSetting][1] or [PutAccountSettingDefault][2].
|
|
8908
8979
|
#
|
|
8909
8980
|
# Currently, if you delete an existing cluster that does not have
|
|
8910
8981
|
# Container Insights turned on, and then create a new cluster with the
|
|
@@ -8913,6 +8984,11 @@ module Aws::ECS
|
|
|
8913
8984
|
# your existing cluster and turn on Container Insights, you must wait 7
|
|
8914
8985
|
# days before you can re-create it.
|
|
8915
8986
|
#
|
|
8987
|
+
#
|
|
8988
|
+
#
|
|
8989
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html
|
|
8990
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html
|
|
8991
|
+
#
|
|
8916
8992
|
# @return [Types::UpdateClusterSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
8917
8993
|
#
|
|
8918
8994
|
# * {Types::UpdateClusterSettingsResponse#cluster #cluster} => Types::Cluster
|
|
@@ -9121,7 +9197,7 @@ module Aws::ECS
|
|
|
9121
9197
|
# state are stopped and replaced according to the service's deployment
|
|
9122
9198
|
# configuration parameters, `minimumHealthyPercent` and
|
|
9123
9199
|
# `maximumPercent`. You can change the deployment configuration of your
|
|
9124
|
-
# service using UpdateService.
|
|
9200
|
+
# service using [UpdateService][1].
|
|
9125
9201
|
#
|
|
9126
9202
|
# * If `minimumHealthyPercent` is below 100%, the scheduler can ignore
|
|
9127
9203
|
# `desiredCount` temporarily during task replacement. For example,
|
|
@@ -9148,7 +9224,7 @@ module Aws::ECS
|
|
|
9148
9224
|
# manually.
|
|
9149
9225
|
#
|
|
9150
9226
|
# A container instance has completed draining when it has no more
|
|
9151
|
-
# `RUNNING` tasks. You can verify this using [ListTasks][
|
|
9227
|
+
# `RUNNING` tasks. You can verify this using [ListTasks][2].
|
|
9152
9228
|
#
|
|
9153
9229
|
# When a container instance has been drained, you can set a container
|
|
9154
9230
|
# instance to `ACTIVE` status and once it has reached that status the
|
|
@@ -9156,7 +9232,8 @@ module Aws::ECS
|
|
|
9156
9232
|
#
|
|
9157
9233
|
#
|
|
9158
9234
|
#
|
|
9159
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/
|
|
9235
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
|
9236
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html
|
|
9160
9237
|
#
|
|
9161
9238
|
# @option params [String] :cluster
|
|
9162
9239
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
@@ -9298,7 +9375,7 @@ module Aws::ECS
|
|
|
9298
9375
|
# propagate tags option, using this API. If the launch type, load
|
|
9299
9376
|
# balancer, network configuration, platform version, or task definition
|
|
9300
9377
|
# need to be updated, create a new task set For more information, see
|
|
9301
|
-
# CreateTaskSet.
|
|
9378
|
+
# [CreateTaskSet][3].
|
|
9302
9379
|
#
|
|
9303
9380
|
# You can add to or subtract from the number of instantiations of a task
|
|
9304
9381
|
# definition in a service by specifying the cluster that the service is
|
|
@@ -9347,12 +9424,12 @@ module Aws::ECS
|
|
|
9347
9424
|
# the four older tasks (provided that the cluster resources required
|
|
9348
9425
|
# to do this are available).
|
|
9349
9426
|
#
|
|
9350
|
-
# When UpdateService stops a task during a deployment, the
|
|
9351
|
-
# `docker stop` is issued to the containers running in the
|
|
9352
|
-
# results in a `SIGTERM` and a 30-second timeout. After this,
|
|
9353
|
-
# is sent and the containers are forcibly stopped. If the
|
|
9354
|
-
# handles the `SIGTERM` gracefully and exits within 30 seconds
|
|
9355
|
-
# receiving it, no `SIGKILL` is sent.
|
|
9427
|
+
# When [UpdateService][4] stops a task during a deployment, the
|
|
9428
|
+
# equivalent of `docker stop` is issued to the containers running in the
|
|
9429
|
+
# task. This results in a `SIGTERM` and a 30-second timeout. After this,
|
|
9430
|
+
# `SIGKILL` is sent and the containers are forcibly stopped. If the
|
|
9431
|
+
# container handles the `SIGTERM` gracefully and exits within 30 seconds
|
|
9432
|
+
# from receiving it, no `SIGKILL` is sent.
|
|
9356
9433
|
#
|
|
9357
9434
|
# When the service scheduler launches new tasks, it determines task
|
|
9358
9435
|
# placement in your cluster with the following logic.
|
|
@@ -9398,7 +9475,7 @@ module Aws::ECS
|
|
|
9398
9475
|
# * `serviceRegistries`
|
|
9399
9476
|
#
|
|
9400
9477
|
# For more information about the role see the `CreateService` request
|
|
9401
|
-
# parameter [ `role` ][
|
|
9478
|
+
# parameter [ `role` ][5].
|
|
9402
9479
|
#
|
|
9403
9480
|
# </note>
|
|
9404
9481
|
#
|
|
@@ -9406,7 +9483,9 @@ module Aws::ECS
|
|
|
9406
9483
|
#
|
|
9407
9484
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types
|
|
9408
9485
|
# [2]: https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html
|
|
9409
|
-
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/
|
|
9486
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html
|
|
9487
|
+
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
|
9488
|
+
# [5]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role
|
|
9410
9489
|
#
|
|
9411
9490
|
# @option params [String] :cluster
|
|
9412
9491
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
@@ -9441,22 +9520,29 @@ module Aws::ECS
|
|
|
9441
9520
|
# A capacity provider strategy consists of one or more capacity
|
|
9442
9521
|
# providers along with the `base` and `weight` to assign to them. A
|
|
9443
9522
|
# capacity provider must be associated with the cluster to be used in a
|
|
9444
|
-
# capacity provider strategy. The PutClusterCapacityProviders API
|
|
9445
|
-
# used to associate a capacity provider with a cluster. Only capacity
|
|
9523
|
+
# capacity provider strategy. The [PutClusterCapacityProviders][1] API
|
|
9524
|
+
# is used to associate a capacity provider with a cluster. Only capacity
|
|
9446
9525
|
# providers with an `ACTIVE` or `UPDATING` status can be used.
|
|
9447
9526
|
#
|
|
9448
9527
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
|
9449
9528
|
# capacity provider must already be created. New capacity providers can
|
|
9450
|
-
# be created with the
|
|
9529
|
+
# be created with the [CreateClusterCapacityProvider][2] API operation.
|
|
9451
9530
|
#
|
|
9452
9531
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
|
9453
9532
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
|
9454
9533
|
# available to all accounts and only need to be associated with a
|
|
9455
9534
|
# cluster to be used.
|
|
9456
9535
|
#
|
|
9457
|
-
# The PutClusterCapacityProviders
|
|
9458
|
-
# list of available capacity providers for a cluster after the
|
|
9459
|
-
# is created.
|
|
9536
|
+
# The [PutClusterCapacityProviders][1]API operation is used to update
|
|
9537
|
+
# the list of available capacity providers for a cluster after the
|
|
9538
|
+
# cluster is created.
|
|
9539
|
+
#
|
|
9540
|
+
#
|
|
9541
|
+
#
|
|
9542
|
+
#
|
|
9543
|
+
#
|
|
9544
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
|
9545
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html
|
|
9460
9546
|
#
|
|
9461
9547
|
# @option params [Types::DeploymentConfiguration] :deployment_configuration
|
|
9462
9548
|
# Optional deployment parameters that control how many tasks run during
|
|
@@ -10341,14 +10427,19 @@ module Aws::ECS
|
|
|
10341
10427
|
# @api private
|
|
10342
10428
|
def build_request(operation_name, params = {})
|
|
10343
10429
|
handlers = @handlers.for(operation_name)
|
|
10430
|
+
tracer = config.telemetry_provider.tracer_provider.tracer(
|
|
10431
|
+
Aws::Telemetry.module_to_tracer_name('Aws::ECS')
|
|
10432
|
+
)
|
|
10344
10433
|
context = Seahorse::Client::RequestContext.new(
|
|
10345
10434
|
operation_name: operation_name,
|
|
10346
10435
|
operation: config.api.operation(operation_name),
|
|
10347
10436
|
client: self,
|
|
10348
10437
|
params: params,
|
|
10349
|
-
config: config
|
|
10438
|
+
config: config,
|
|
10439
|
+
tracer: tracer
|
|
10440
|
+
)
|
|
10350
10441
|
context[:gem_name] = 'aws-sdk-ecs'
|
|
10351
|
-
context[:gem_version] = '1.
|
|
10442
|
+
context[:gem_version] = '1.155.0'
|
|
10352
10443
|
Seahorse::Client::Request.new(handlers, context)
|
|
10353
10444
|
end
|
|
10354
10445
|
|