aws-sdk-ecs 1.151.0 → 1.157.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 +30 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ecs/client.rb +248 -134
- data/lib/aws-sdk-ecs/client_api.rb +10 -0
- data/lib/aws-sdk-ecs/endpoints.rb +56 -224
- data/lib/aws-sdk-ecs/plugins/endpoints.rb +10 -1
- data/lib/aws-sdk-ecs/types.rb +509 -602
- data/lib/aws-sdk-ecs.rb +1 -1
- data/sig/client.rbs +6 -0
- data/sig/resource.rbs +1 -0
- data/sig/types.rbs +8 -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:
|
@@ -420,6 +432,12 @@ module Aws::ECS
|
|
420
432
|
# @option options [String] :ssl_ca_store
|
421
433
|
# Sets the X509::Store to verify peer certificate.
|
422
434
|
#
|
435
|
+
# @option options [OpenSSL::X509::Certificate] :ssl_cert
|
436
|
+
# Sets a client certificate when creating http connections.
|
437
|
+
#
|
438
|
+
# @option options [OpenSSL::PKey] :ssl_key
|
439
|
+
# Sets a client key when creating http connections.
|
440
|
+
#
|
423
441
|
# @option options [Float] :ssl_timeout
|
424
442
|
# Sets the SSL timeout in seconds
|
425
443
|
#
|
@@ -538,23 +556,23 @@ module Aws::ECS
|
|
538
556
|
|
539
557
|
# Creates a new Amazon ECS cluster. By default, your account receives a
|
540
558
|
# `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*.
|
559
|
+
# However, you can create your own cluster with a unique name.
|
560
|
+
#
|
561
|
+
# <note markdown="1"> When you call the [CreateCluster][1] API operation, Amazon ECS
|
562
|
+
# attempts to create the Amazon ECS service-linked role for your
|
563
|
+
# account. This is so that it can manage required resources in other
|
564
|
+
# Amazon Web Services services on your behalf. However, if the user that
|
565
|
+
# makes the call doesn't have permissions to create the service-linked
|
566
|
+
# role, it isn't created. For more information, see [Using
|
567
|
+
# service-linked roles for Amazon ECS][2] in the *Amazon Elastic
|
568
|
+
# Container Service Developer Guide*.
|
552
569
|
#
|
553
570
|
# </note>
|
554
571
|
#
|
555
572
|
#
|
556
573
|
#
|
557
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/
|
574
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html
|
575
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html
|
558
576
|
#
|
559
577
|
# @option params [String] :cluster_name
|
560
578
|
# The name of your cluster. If you don't specify a name for your
|
@@ -596,7 +614,12 @@ module Aws::ECS
|
|
596
614
|
# The setting to use when creating a cluster. This parameter is used to
|
597
615
|
# turn on CloudWatch Container Insights for a cluster. If this value is
|
598
616
|
# specified, it overrides the `containerInsights` value set with
|
599
|
-
# PutAccountSetting or PutAccountSettingDefault.
|
617
|
+
# [PutAccountSetting][1] or [PutAccountSettingDefault][2].
|
618
|
+
#
|
619
|
+
#
|
620
|
+
#
|
621
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html
|
622
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html
|
600
623
|
#
|
601
624
|
# @option params [Types::ClusterConfiguration] :configuration
|
602
625
|
# The `execute` command configuration for the cluster.
|
@@ -638,12 +661,13 @@ module Aws::ECS
|
|
638
661
|
#
|
639
662
|
# If a default capacity provider strategy isn't defined for a cluster
|
640
663
|
# when it was created, it can be defined later with the
|
641
|
-
# PutClusterCapacityProviders API operation.
|
664
|
+
# [PutClusterCapacityProviders][3] API operation.
|
642
665
|
#
|
643
666
|
#
|
644
667
|
#
|
645
668
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html
|
646
669
|
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html
|
670
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
647
671
|
#
|
648
672
|
# @option params [Types::ClusterServiceConnectDefaultsRequest] :service_connect_defaults
|
649
673
|
# Use this parameter to set a default Service Connect namespace. After
|
@@ -794,8 +818,8 @@ module Aws::ECS
|
|
794
818
|
# Runs and maintains your desired number of tasks from a specified task
|
795
819
|
# definition. If the number of tasks running in a service drops below
|
796
820
|
# the `desiredCount`, Amazon ECS runs another copy of the task in the
|
797
|
-
# specified cluster. To update an existing service,
|
798
|
-
# UpdateService
|
821
|
+
# specified cluster. To update an existing service, use
|
822
|
+
# [UpdateService][1].
|
799
823
|
#
|
800
824
|
# <note markdown="1"> On March 21, 2024, a change was made to resolve the task definition
|
801
825
|
# revision before authorization. When a task definition revision is not
|
@@ -808,13 +832,13 @@ module Aws::ECS
|
|
808
832
|
# you can optionally run your service behind one or more load balancers.
|
809
833
|
# The load balancers distribute traffic across the tasks that are
|
810
834
|
# associated with the service. For more information, see [Service load
|
811
|
-
# balancing][
|
835
|
+
# balancing][2] in the *Amazon Elastic Container Service Developer
|
812
836
|
# Guide*.
|
813
837
|
#
|
814
838
|
# You can attach Amazon EBS volumes to Amazon ECS tasks by configuring
|
815
839
|
# the volume when creating or updating a service. `volumeConfigurations`
|
816
840
|
# is only supported for REPLICA service and not DAEMON service. For more
|
817
|
-
# infomation, see [Amazon EBS volumes][
|
841
|
+
# infomation, see [Amazon EBS volumes][3] in the *Amazon Elastic
|
818
842
|
# Container Service Developer Guide*.
|
819
843
|
#
|
820
844
|
# Tasks for services that don't use a load balancer are considered
|
@@ -829,7 +853,7 @@ module Aws::ECS
|
|
829
853
|
# service scheduler spreads tasks across Availability Zones. You can
|
830
854
|
# use task placement strategies and constraints to customize task
|
831
855
|
# placement decisions. For more information, see [Service scheduler
|
832
|
-
# concepts][
|
856
|
+
# concepts][4] in the *Amazon Elastic Container Service Developer
|
833
857
|
# Guide*.
|
834
858
|
#
|
835
859
|
# * `DAEMON` - The daemon scheduling strategy deploys exactly one task
|
@@ -840,16 +864,16 @@ module Aws::ECS
|
|
840
864
|
# constraints. When using this strategy, you don't need to specify a
|
841
865
|
# desired number of tasks, a task placement strategy, or use Service
|
842
866
|
# Auto Scaling policies. For more information, see [Service scheduler
|
843
|
-
# concepts][
|
867
|
+
# concepts][4] in the *Amazon Elastic Container Service Developer
|
844
868
|
# Guide*.
|
845
869
|
#
|
846
870
|
# You can optionally specify a deployment configuration for your
|
847
871
|
# service. The deployment is initiated by changing properties. For
|
848
872
|
# example, the deployment might be initiated by the task definition or
|
849
|
-
# by your desired count of a service.
|
850
|
-
#
|
851
|
-
#
|
852
|
-
#
|
873
|
+
# by your desired count of a service. You can use [UpdateService][1].
|
874
|
+
# The default value for a replica service for `minimumHealthyPercent` is
|
875
|
+
# 100%. The default value for a daemon service for
|
876
|
+
# `minimumHealthyPercent` is 0%.
|
853
877
|
#
|
854
878
|
# If a service uses the `ECS` deployment controller, the minimum healthy
|
855
879
|
# percent represents a lower limit on the number of tasks in a service
|
@@ -895,13 +919,13 @@ module Aws::ECS
|
|
895
919
|
# When creating a service that uses the `EXTERNAL` deployment
|
896
920
|
# controller, you can specify only parameters that aren't controlled at
|
897
921
|
# 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][
|
922
|
+
# You control your services using the [CreateTaskSet][5]. For more
|
923
|
+
# information, see [Amazon ECS deployment types][6] in the *Amazon
|
900
924
|
# Elastic Container Service Developer Guide*.
|
901
925
|
#
|
902
926
|
# When the service scheduler launches new tasks, it determines task
|
903
927
|
# placement. For information about task placement and task placement
|
904
|
-
# strategies, see [Amazon ECS task placement][
|
928
|
+
# strategies, see [Amazon ECS task placement][7] in the *Amazon Elastic
|
905
929
|
# Container Service Developer Guide*
|
906
930
|
#
|
907
931
|
# Starting April 15, 2023, Amazon Web Services will not onboard new
|
@@ -915,11 +939,13 @@ module Aws::ECS
|
|
915
939
|
#
|
916
940
|
#
|
917
941
|
#
|
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/
|
942
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
943
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html
|
944
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types
|
945
|
+
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html
|
946
|
+
# [5]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html
|
947
|
+
# [6]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html
|
948
|
+
# [7]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html
|
923
949
|
#
|
924
950
|
# @option params [String] :cluster
|
925
951
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
@@ -1749,7 +1775,7 @@ module Aws::ECS
|
|
1749
1775
|
#
|
1750
1776
|
# </note>
|
1751
1777
|
#
|
1752
|
-
# For information about the maximum number of task sets and
|
1778
|
+
# For information about the maximum number of task sets and other
|
1753
1779
|
# quotas, see [Amazon ECS service quotas][2] in the *Amazon Elastic
|
1754
1780
|
# Container Service Developer Guide*.
|
1755
1781
|
#
|
@@ -1811,8 +1837,8 @@ module Aws::ECS
|
|
1811
1837
|
# A capacity provider strategy consists of one or more capacity
|
1812
1838
|
# providers along with the `base` and `weight` to assign to them. A
|
1813
1839
|
# 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
|
1840
|
+
# capacity provider strategy. The [PutClusterCapacityProviders][1] API
|
1841
|
+
# is used to associate a capacity provider with a cluster. Only capacity
|
1816
1842
|
# providers with an `ACTIVE` or `UPDATING` status can be used.
|
1817
1843
|
#
|
1818
1844
|
# If a `capacityProviderStrategy` is specified, the `launchType`
|
@@ -1822,16 +1848,21 @@ module Aws::ECS
|
|
1822
1848
|
#
|
1823
1849
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
1824
1850
|
# capacity provider must already be created. New capacity providers can
|
1825
|
-
# be created with the
|
1851
|
+
# be created with the [CreateCapacityProviderProvider][2]API operation.
|
1826
1852
|
#
|
1827
1853
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
1828
1854
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
1829
1855
|
# available to all accounts and only need to be associated with a
|
1830
1856
|
# cluster to be used.
|
1831
1857
|
#
|
1832
|
-
# The PutClusterCapacityProviders API operation is used to update
|
1833
|
-
# list of available capacity providers for a cluster after the
|
1834
|
-
# is created.
|
1858
|
+
# The [PutClusterCapacityProviders][1] API operation is used to update
|
1859
|
+
# the list of available capacity providers for a cluster after the
|
1860
|
+
# cluster is created.
|
1861
|
+
#
|
1862
|
+
#
|
1863
|
+
#
|
1864
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
1865
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProviderProvider.html
|
1835
1866
|
#
|
1836
1867
|
# @option params [String] :platform_version
|
1837
1868
|
# The platform version that the tasks in the task set uses. A platform
|
@@ -2126,20 +2157,26 @@ module Aws::ECS
|
|
2126
2157
|
#
|
2127
2158
|
# <note markdown="1"> The `FARGATE` and `FARGATE_SPOT` capacity providers are reserved and
|
2128
2159
|
# can't be deleted. You can disassociate them from a cluster using
|
2129
|
-
# either
|
2160
|
+
# either [PutCapacityProviderProviders][1] or by deleting the cluster.
|
2130
2161
|
#
|
2131
2162
|
# </note>
|
2132
2163
|
#
|
2133
2164
|
# Prior to a capacity provider being deleted, the capacity provider must
|
2134
2165
|
# 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
|
2166
|
+
# [UpdateService][2] API can be used to remove a capacity provider from
|
2167
|
+
# a service's capacity provider strategy. When updating a service, the
|
2137
2168
|
# `forceNewDeployment` option can be used to ensure that any tasks using
|
2138
2169
|
# the Amazon EC2 instance capacity provided by the capacity provider are
|
2139
2170
|
# transitioned to use the capacity from the remaining capacity
|
2140
2171
|
# providers. Only capacity providers that aren't associated with a
|
2141
2172
|
# cluster can be deleted. To remove a capacity provider from a cluster,
|
2142
|
-
# you can either use
|
2173
|
+
# you can either use [PutCapacityProviderProviders][1] or delete the
|
2174
|
+
# cluster.
|
2175
|
+
#
|
2176
|
+
#
|
2177
|
+
#
|
2178
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProviderProviders.html
|
2179
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
2143
2180
|
#
|
2144
2181
|
# @option params [required, String] :capacity_provider
|
2145
2182
|
# The short name or full Amazon Resource Name (ARN) of the capacity
|
@@ -2191,8 +2228,13 @@ module Aws::ECS
|
|
2191
2228
|
#
|
2192
2229
|
# You must deregister all container instances from this cluster before
|
2193
2230
|
# you may delete it. You can list the container instances in a cluster
|
2194
|
-
# with ListContainerInstances and deregister them with
|
2195
|
-
# DeregisterContainerInstance.
|
2231
|
+
# with [ListContainerInstances][1] and deregister them with
|
2232
|
+
# [DeregisterContainerInstance][2].
|
2233
|
+
#
|
2234
|
+
#
|
2235
|
+
#
|
2236
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html
|
2237
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html
|
2196
2238
|
#
|
2197
2239
|
# @option params [required, String] :cluster
|
2198
2240
|
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
@@ -2286,18 +2328,19 @@ module Aws::ECS
|
|
2286
2328
|
# if you have no running tasks in it and the desired task count is zero.
|
2287
2329
|
# If the service is actively maintaining tasks, you can't delete it,
|
2288
2330
|
# and you must update the service to a desired task count of zero. For
|
2289
|
-
# more information, see UpdateService.
|
2331
|
+
# more information, see [UpdateService][1].
|
2290
2332
|
#
|
2291
2333
|
# <note markdown="1"> When you delete a service, if there are still running tasks that
|
2292
2334
|
# require cleanup, the service status moves from `ACTIVE` to `DRAINING`,
|
2293
2335
|
# and the service is no longer visible in the console or in the
|
2294
|
-
# ListServices API operation. After all tasks have transitioned to
|
2336
|
+
# [ListServices][2] API operation. After all tasks have transitioned to
|
2295
2337
|
# either `STOPPING` or `STOPPED` status, the service status moves from
|
2296
2338
|
# `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
|
2339
|
+
# status can still be viewed with the [DescribeServices][3] API
|
2340
|
+
# operation. However, in the future, `INACTIVE` services may be cleaned
|
2341
|
+
# up and purged from Amazon ECS record keeping, and
|
2342
|
+
# [DescribeServices][3] calls on those services return a
|
2343
|
+
# `ServiceNotFoundException` error.
|
2301
2344
|
#
|
2302
2345
|
# </note>
|
2303
2346
|
#
|
@@ -2305,6 +2348,12 @@ module Aws::ECS
|
|
2305
2348
|
# existing service in either `ACTIVE` or `DRAINING` status, you receive
|
2306
2349
|
# an error.
|
2307
2350
|
#
|
2351
|
+
#
|
2352
|
+
#
|
2353
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
2354
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html
|
2355
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html
|
2356
|
+
#
|
2308
2357
|
# @option params [String] :cluster
|
2309
2358
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
2310
2359
|
# hosts the service to delete. If you do not specify a cluster, the
|
@@ -2596,6 +2645,10 @@ module Aws::ECS
|
|
2596
2645
|
# resp.task_definitions[0].container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
|
2597
2646
|
# resp.task_definitions[0].container_definitions[0].port_mappings[0].container_port_range #=> String
|
2598
2647
|
# resp.task_definitions[0].container_definitions[0].essential #=> Boolean
|
2648
|
+
# resp.task_definitions[0].container_definitions[0].restart_policy.enabled #=> Boolean
|
2649
|
+
# resp.task_definitions[0].container_definitions[0].restart_policy.ignored_exit_codes #=> Array
|
2650
|
+
# resp.task_definitions[0].container_definitions[0].restart_policy.ignored_exit_codes[0] #=> Integer
|
2651
|
+
# resp.task_definitions[0].container_definitions[0].restart_policy.restart_attempt_period #=> Integer
|
2599
2652
|
# resp.task_definitions[0].container_definitions[0].entry_point #=> Array
|
2600
2653
|
# resp.task_definitions[0].container_definitions[0].entry_point[0] #=> String
|
2601
2654
|
# resp.task_definitions[0].container_definitions[0].command #=> Array
|
@@ -3053,6 +3106,10 @@ module Aws::ECS
|
|
3053
3106
|
# resp.task_definition.container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
|
3054
3107
|
# resp.task_definition.container_definitions[0].port_mappings[0].container_port_range #=> String
|
3055
3108
|
# resp.task_definition.container_definitions[0].essential #=> Boolean
|
3109
|
+
# resp.task_definition.container_definitions[0].restart_policy.enabled #=> Boolean
|
3110
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes #=> Array
|
3111
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes[0] #=> Integer
|
3112
|
+
# resp.task_definition.container_definitions[0].restart_policy.restart_attempt_period #=> Integer
|
3056
3113
|
# resp.task_definition.container_definitions[0].entry_point #=> Array
|
3057
3114
|
# resp.task_definition.container_definitions[0].entry_point[0] #=> String
|
3058
3115
|
# resp.task_definition.container_definitions[0].command #=> Array
|
@@ -3999,6 +4056,10 @@ module Aws::ECS
|
|
3999
4056
|
# resp.task_definition.container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
|
4000
4057
|
# resp.task_definition.container_definitions[0].port_mappings[0].container_port_range #=> String
|
4001
4058
|
# resp.task_definition.container_definitions[0].essential #=> Boolean
|
4059
|
+
# resp.task_definition.container_definitions[0].restart_policy.enabled #=> Boolean
|
4060
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes #=> Array
|
4061
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes[0] #=> Integer
|
4062
|
+
# resp.task_definition.container_definitions[0].restart_policy.restart_attempt_period #=> Integer
|
4002
4063
|
# resp.task_definition.container_definitions[0].entry_point #=> Array
|
4003
4064
|
# resp.task_definition.container_definitions[0].entry_point[0] #=> String
|
4004
4065
|
# resp.task_definition.container_definitions[0].command #=> Array
|
@@ -5009,9 +5070,14 @@ module Aws::ECS
|
|
5009
5070
|
# @option params [String] :status
|
5010
5071
|
# Filters the container instances by status. For example, if you specify
|
5011
5072
|
# 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
|
5073
|
+
# that have been set to `DRAINING` using
|
5074
|
+
# [UpdateContainerInstancesState][1]. If you don't specify this
|
5075
|
+
# parameter, the default is to include container instances set to all
|
5076
|
+
# states other than `INACTIVE`.
|
5077
|
+
#
|
5078
|
+
#
|
5079
|
+
#
|
5080
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateContainerInstancesState.html
|
5015
5081
|
#
|
5016
5082
|
# @return [Types::ListContainerInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5017
5083
|
#
|
@@ -6024,12 +6090,13 @@ module Aws::ECS
|
|
6024
6090
|
# Create or update an attribute on an Amazon ECS resource. If the
|
6025
6091
|
# attribute doesn't exist, it's created. If the attribute exists, its
|
6026
6092
|
# 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*.
|
6093
|
+
# use [DeleteAttributes][1]. For more information, see [Attributes][2]
|
6094
|
+
# in the *Amazon Elastic Container Service Developer Guide*.
|
6029
6095
|
#
|
6030
6096
|
#
|
6031
6097
|
#
|
6032
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/
|
6098
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteAttributes.html
|
6099
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes
|
6033
6100
|
#
|
6034
6101
|
# @option params [String] :cluster
|
6035
6102
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
@@ -6084,10 +6151,10 @@ module Aws::ECS
|
|
6084
6151
|
# has existing capacity providers associated with it, you must specify
|
6085
6152
|
# all existing capacity providers in addition to any new ones you want
|
6086
6153
|
# 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.
|
6154
|
+
# cluster that are omitted from a [PutClusterCapacityProviders][1] API
|
6155
|
+
# call will be disassociated with the cluster. You can only disassociate
|
6156
|
+
# an existing capacity provider from a cluster if it's not being used
|
6157
|
+
# by any existing tasks.
|
6091
6158
|
#
|
6092
6159
|
# When creating a service or running a task on a cluster, if no capacity
|
6093
6160
|
# provider or launch type is specified, then the cluster's default
|
@@ -6095,6 +6162,10 @@ module Aws::ECS
|
|
6095
6162
|
# default capacity provider strategy for your cluster. However, you must
|
6096
6163
|
# specify an empty array (`[]`) to bypass defining a default strategy.
|
6097
6164
|
#
|
6165
|
+
#
|
6166
|
+
#
|
6167
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
6168
|
+
#
|
6098
6169
|
# @option params [required, String] :cluster
|
6099
6170
|
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
6100
6171
|
# modify the capacity provider settings for. If you don't specify a
|
@@ -6106,13 +6177,17 @@ module Aws::ECS
|
|
6106
6177
|
#
|
6107
6178
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
6108
6179
|
# capacity provider must already be created. New capacity providers can
|
6109
|
-
# be created with the CreateCapacityProvider API operation.
|
6180
|
+
# be created with the [CreateCapacityProvider][1] API operation.
|
6110
6181
|
#
|
6111
6182
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
6112
6183
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
6113
6184
|
# available to all accounts and only need to be associated with a
|
6114
6185
|
# cluster to be used.
|
6115
6186
|
#
|
6187
|
+
#
|
6188
|
+
#
|
6189
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html
|
6190
|
+
#
|
6116
6191
|
# @option params [required, Array<Types::CapacityProviderStrategyItem>] :default_capacity_provider_strategy
|
6117
6192
|
# The capacity provider strategy to use by default for the cluster.
|
6118
6193
|
#
|
@@ -6123,19 +6198,24 @@ module Aws::ECS
|
|
6123
6198
|
# A capacity provider strategy consists of one or more capacity
|
6124
6199
|
# providers along with the `base` and `weight` to assign to them. A
|
6125
6200
|
# 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
|
6201
|
+
# capacity provider strategy. The [PutClusterCapacityProviders][1] API
|
6202
|
+
# is used to associate a capacity provider with a cluster. Only capacity
|
6128
6203
|
# providers with an `ACTIVE` or `UPDATING` status can be used.
|
6129
6204
|
#
|
6130
6205
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
6131
6206
|
# capacity provider must already be created. New capacity providers can
|
6132
|
-
# be created with the CreateCapacityProvider API operation.
|
6207
|
+
# be created with the [CreateCapacityProvider][2] API operation.
|
6133
6208
|
#
|
6134
6209
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
6135
6210
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
6136
6211
|
# available to all accounts and only need to be associated with a
|
6137
6212
|
# cluster to be used.
|
6138
6213
|
#
|
6214
|
+
#
|
6215
|
+
#
|
6216
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
6217
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html
|
6218
|
+
#
|
6139
6219
|
# @return [Types::PutClusterCapacityProvidersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6140
6220
|
#
|
6141
6221
|
# * {Types::PutClusterCapacityProvidersResponse#cluster #cluster} => Types::Cluster
|
@@ -6405,20 +6485,18 @@ module Aws::ECS
|
|
6405
6485
|
# Tasks][2] in the *Amazon Elastic Container Service Developer Guide*.
|
6406
6486
|
#
|
6407
6487
|
# 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*.
|
6488
|
+
# task definition with the `networkMode` parameter. If you specify the
|
6489
|
+
# `awsvpc` network mode, the task is allocated an elastic network
|
6490
|
+
# interface, and you must specify a [NetworkConfiguration][3] when you
|
6491
|
+
# create a service or run a task with the task definition. For more
|
6492
|
+
# information, see [Task Networking][4] in the *Amazon Elastic Container
|
6493
|
+
# Service Developer Guide*.
|
6416
6494
|
#
|
6417
6495
|
#
|
6418
6496
|
#
|
6419
6497
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html
|
6420
6498
|
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html
|
6421
|
-
# [3]: https://docs.
|
6499
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html
|
6422
6500
|
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
6423
6501
|
#
|
6424
6502
|
# @option params [required, String] :family
|
@@ -6441,14 +6519,13 @@ module Aws::ECS
|
|
6441
6519
|
# @option params [String] :execution_role_arn
|
6442
6520
|
# The Amazon Resource Name (ARN) of the task execution role that grants
|
6443
6521
|
# the Amazon ECS container agent permission to make Amazon Web Services
|
6444
|
-
# API calls on your behalf.
|
6445
|
-
#
|
6446
|
-
#
|
6447
|
-
# Container Service Developer Guide*.
|
6522
|
+
# API calls on your behalf. For informationabout the required IAM roles
|
6523
|
+
# for Amazon ECS, see [IAM roles for Amazon ECS][1] in the *Amazon
|
6524
|
+
# Elastic Container Service Developer Guide*.
|
6448
6525
|
#
|
6449
6526
|
#
|
6450
6527
|
#
|
6451
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
6528
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html
|
6452
6529
|
#
|
6453
6530
|
# @option params [String] :network_mode
|
6454
6531
|
# The Docker networking mode to use for the containers in the task. The
|
@@ -6477,22 +6554,19 @@ module Aws::ECS
|
|
6477
6554
|
# non-root user.
|
6478
6555
|
#
|
6479
6556
|
# 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*.
|
6557
|
+
# network interface, and you must specify a [NetworkConfiguration][1]
|
6558
|
+
# value when you create a service or run a task with the task
|
6559
|
+
# definition. For more information, see [Task Networking][2] in the
|
6560
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
6484
6561
|
#
|
6485
6562
|
# If the network mode is `host`, you cannot run multiple instantiations
|
6486
6563
|
# of the same task on a single container instance when port mappings are
|
6487
6564
|
# used.
|
6488
6565
|
#
|
6489
|
-
# For more information, see [Network settings][2] in the *Docker run
|
6490
|
-
# reference*.
|
6491
6566
|
#
|
6492
6567
|
#
|
6493
|
-
#
|
6494
|
-
# [
|
6495
|
-
# [2]: https://docs.docker.com/engine/reference/run/#network-settings
|
6568
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html
|
6569
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
6496
6570
|
#
|
6497
6571
|
# @option params [required, Array<Types::ContainerDefinition>] :container_definitions
|
6498
6572
|
# A list of container definitions in JSON format that describe the
|
@@ -6655,12 +6729,10 @@ module Aws::ECS
|
|
6655
6729
|
# the same process namespace.
|
6656
6730
|
#
|
6657
6731
|
# If no value is specified, the default is a private namespace for each
|
6658
|
-
# container.
|
6659
|
-
# run reference*.
|
6732
|
+
# container.
|
6660
6733
|
#
|
6661
6734
|
# If the `host` PID mode is used, there's a heightened risk of
|
6662
|
-
# undesired process namespace exposure.
|
6663
|
-
# [Docker security][2].
|
6735
|
+
# undesired process namespace exposure.
|
6664
6736
|
#
|
6665
6737
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
6666
6738
|
#
|
@@ -6672,11 +6744,6 @@ module Aws::ECS
|
|
6672
6744
|
#
|
6673
6745
|
# </note>
|
6674
6746
|
#
|
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
6747
|
# @option params [String] :ipc_mode
|
6681
6748
|
# The IPC resource namespace to use for the containers in the task. The
|
6682
6749
|
# valid values are `host`, `task`, or `none`. If `host` is specified,
|
@@ -6688,16 +6755,14 @@ module Aws::ECS
|
|
6688
6755
|
# private and not shared with other containers in a task or on the
|
6689
6756
|
# container instance. If no value is specified, then the IPC resource
|
6690
6757
|
# namespace sharing depends on the Docker daemon setting on the
|
6691
|
-
# container instance.
|
6692
|
-
# *Docker run reference*.
|
6758
|
+
# container instance.
|
6693
6759
|
#
|
6694
6760
|
# 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].
|
6761
|
+
# risk of undesired IPC namespace expose.
|
6697
6762
|
#
|
6698
6763
|
# If you are setting namespaced kernel parameters using `systemControls`
|
6699
6764
|
# for the containers in the task, the following will apply to your IPC
|
6700
|
-
# resource namespace. For more information, see [System Controls][
|
6765
|
+
# resource namespace. For more information, see [System Controls][1] in
|
6701
6766
|
# the *Amazon Elastic Container Service Developer Guide*.
|
6702
6767
|
#
|
6703
6768
|
# * For tasks that use the `host` IPC mode, IPC namespace related
|
@@ -6713,9 +6778,7 @@ module Aws::ECS
|
|
6713
6778
|
#
|
6714
6779
|
#
|
6715
6780
|
#
|
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
|
6781
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html
|
6719
6782
|
#
|
6720
6783
|
# @option params [Types::ProxyConfiguration] :proxy_configuration
|
6721
6784
|
# The configuration details for the App Mesh proxy.
|
@@ -6852,6 +6915,11 @@ module Aws::ECS
|
|
6852
6915
|
# },
|
6853
6916
|
# ],
|
6854
6917
|
# essential: false,
|
6918
|
+
# restart_policy: {
|
6919
|
+
# enabled: false, # required
|
6920
|
+
# ignored_exit_codes: [1],
|
6921
|
+
# restart_attempt_period: 1,
|
6922
|
+
# },
|
6855
6923
|
# entry_point: ["String"],
|
6856
6924
|
# command: ["String"],
|
6857
6925
|
# environment: [
|
@@ -7084,6 +7152,10 @@ module Aws::ECS
|
|
7084
7152
|
# resp.task_definition.container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
|
7085
7153
|
# resp.task_definition.container_definitions[0].port_mappings[0].container_port_range #=> String
|
7086
7154
|
# resp.task_definition.container_definitions[0].essential #=> Boolean
|
7155
|
+
# resp.task_definition.container_definitions[0].restart_policy.enabled #=> Boolean
|
7156
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes #=> Array
|
7157
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes[0] #=> Integer
|
7158
|
+
# resp.task_definition.container_definitions[0].restart_policy.restart_attempt_period #=> Integer
|
7087
7159
|
# resp.task_definition.container_definitions[0].entry_point #=> Array
|
7088
7160
|
# resp.task_definition.container_definitions[0].entry_point[0] #=> String
|
7089
7161
|
# resp.task_definition.container_definitions[0].command #=> Array
|
@@ -7257,7 +7329,7 @@ module Aws::ECS
|
|
7257
7329
|
# strategies. For more information, see [Scheduling Tasks][1] in the
|
7258
7330
|
# *Amazon Elastic Container Service Developer Guide*.
|
7259
7331
|
#
|
7260
|
-
# Alternatively, you can use StartTask to use your own scheduler or
|
7332
|
+
# Alternatively, you can use `StartTask` to use your own scheduler or
|
7261
7333
|
# place tasks manually on specific container instances.
|
7262
7334
|
#
|
7263
7335
|
# Starting April 15, 2023, Amazon Web Services will not onboard new
|
@@ -7426,13 +7498,17 @@ module Aws::ECS
|
|
7426
7498
|
# Specifies whether to propagate the tags from the task definition to
|
7427
7499
|
# the task. If no value is specified, the tags aren't propagated. Tags
|
7428
7500
|
# can only be propagated to the task during task creation. To add tags
|
7429
|
-
# to a task after task creation, use the
|
7501
|
+
# to a task after task creation, use the[TagResource][1] API action.
|
7430
7502
|
#
|
7431
7503
|
# <note markdown="1"> An error will be received if you specify the `SERVICE` option when
|
7432
7504
|
# running a task.
|
7433
7505
|
#
|
7434
7506
|
# </note>
|
7435
7507
|
#
|
7508
|
+
#
|
7509
|
+
#
|
7510
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html
|
7511
|
+
#
|
7436
7512
|
# @option params [String] :reference_id
|
7437
7513
|
# The reference ID to use for the task. The reference ID can have a
|
7438
7514
|
# maximum length of 1024 characters.
|
@@ -7442,13 +7518,18 @@ module Aws::ECS
|
|
7442
7518
|
# automatically trigger a task to run a batch process job, you could
|
7443
7519
|
# apply a unique identifier for that job to your task with the
|
7444
7520
|
# `startedBy` parameter. You can then identify which tasks belong to
|
7445
|
-
# that job by filtering the results of a ListTasks call with the
|
7521
|
+
# that job by filtering the results of a [ListTasks][1] call with the
|
7446
7522
|
# `startedBy` value. Up to 128 letters (uppercase and lowercase),
|
7447
|
-
# numbers, hyphens (-), and underscores (\_) are
|
7523
|
+
# numbers, hyphens (-), forward slash (/), and underscores (\_) are
|
7524
|
+
# allowed.
|
7448
7525
|
#
|
7449
7526
|
# If a task is started by an Amazon ECS service, then the `startedBy`
|
7450
7527
|
# parameter contains the deployment ID of the service that starts it.
|
7451
7528
|
#
|
7529
|
+
#
|
7530
|
+
#
|
7531
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html
|
7532
|
+
#
|
7452
7533
|
# @option params [Array<Types::Tag>] :tags
|
7453
7534
|
# The metadata that you apply to the task to help you categorize and
|
7454
7535
|
# organize them. Each tag consists of a key and an optional value, both
|
@@ -7836,7 +7917,7 @@ module Aws::ECS
|
|
7836
7917
|
# at least once during the past 30-day period are considered current
|
7837
7918
|
# customers and will be able to continue using the service.
|
7838
7919
|
#
|
7839
|
-
# Alternatively, you can use
|
7920
|
+
# Alternatively, you can use`RunTask` to place tasks for you. For more
|
7840
7921
|
# information, see [Scheduling Tasks][1] in the *Amazon Elastic
|
7841
7922
|
# Container Service Developer Guide*.
|
7842
7923
|
#
|
@@ -7912,13 +7993,18 @@ module Aws::ECS
|
|
7912
7993
|
# automatically trigger a task to run a batch process job, you could
|
7913
7994
|
# apply a unique identifier for that job to your task with the
|
7914
7995
|
# `startedBy` parameter. You can then identify which tasks belong to
|
7915
|
-
# that job by filtering the results of a ListTasks call with the
|
7996
|
+
# that job by filtering the results of a [ListTasks][1] call with the
|
7916
7997
|
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
7917
|
-
# numbers, hyphens (-), and underscores (\_) are
|
7998
|
+
# numbers, hyphens (-), forward slash (/), and underscores (\_) are
|
7999
|
+
# allowed.
|
7918
8000
|
#
|
7919
8001
|
# If a task is started by an Amazon ECS service, the `startedBy`
|
7920
8002
|
# parameter contains the deployment ID of the service that starts it.
|
7921
8003
|
#
|
8004
|
+
#
|
8005
|
+
#
|
8006
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html
|
8007
|
+
#
|
7922
8008
|
# @option params [Array<Types::Tag>] :tags
|
7923
8009
|
# The metadata that you apply to the task to help you categorize and
|
7924
8010
|
# organize them. Each tag consists of a key and an optional value, both
|
@@ -8195,7 +8281,7 @@ module Aws::ECS
|
|
8195
8281
|
# Stops a running task. Any tags associated with the task will be
|
8196
8282
|
# deleted.
|
8197
8283
|
#
|
8198
|
-
# When
|
8284
|
+
# When you call `StopTask` on a task, the equivalent of `docker stop` is
|
8199
8285
|
# issued to the containers running in the task. This results in a
|
8200
8286
|
# `SIGTERM` value and a default 30-second timeout, after which the
|
8201
8287
|
# `SIGKILL` value is sent and the containers are forcibly stopped. If
|
@@ -8231,7 +8317,11 @@ module Aws::ECS
|
|
8231
8317
|
# An optional message specified when a task is stopped. For example, if
|
8232
8318
|
# you're using a custom scheduler, you can use this parameter to
|
8233
8319
|
# specify the reason for stopping the task here, and the message appears
|
8234
|
-
# in subsequent DescribeTasks API operations on this task.
|
8320
|
+
# in subsequent [DescribeTasks][1]> API operations on this task.
|
8321
|
+
#
|
8322
|
+
#
|
8323
|
+
#
|
8324
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html
|
8235
8325
|
#
|
8236
8326
|
# @return [Types::StopTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8237
8327
|
#
|
@@ -8891,7 +8981,7 @@ module Aws::ECS
|
|
8891
8981
|
# The setting to use by default for a cluster. This parameter is used to
|
8892
8982
|
# turn on CloudWatch Container Insights for a cluster. If this value is
|
8893
8983
|
# specified, it overrides the `containerInsights` value set with
|
8894
|
-
# PutAccountSetting or PutAccountSettingDefault.
|
8984
|
+
# [PutAccountSetting][1] or [PutAccountSettingDefault][2].
|
8895
8985
|
#
|
8896
8986
|
# Currently, if you delete an existing cluster that does not have
|
8897
8987
|
# Container Insights turned on, and then create a new cluster with the
|
@@ -8900,6 +8990,11 @@ module Aws::ECS
|
|
8900
8990
|
# your existing cluster and turn on Container Insights, you must wait 7
|
8901
8991
|
# days before you can re-create it.
|
8902
8992
|
#
|
8993
|
+
#
|
8994
|
+
#
|
8995
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html
|
8996
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html
|
8997
|
+
#
|
8903
8998
|
# @return [Types::UpdateClusterSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8904
8999
|
#
|
8905
9000
|
# * {Types::UpdateClusterSettingsResponse#cluster #cluster} => Types::Cluster
|
@@ -9108,7 +9203,7 @@ module Aws::ECS
|
|
9108
9203
|
# state are stopped and replaced according to the service's deployment
|
9109
9204
|
# configuration parameters, `minimumHealthyPercent` and
|
9110
9205
|
# `maximumPercent`. You can change the deployment configuration of your
|
9111
|
-
# service using UpdateService.
|
9206
|
+
# service using [UpdateService][1].
|
9112
9207
|
#
|
9113
9208
|
# * If `minimumHealthyPercent` is below 100%, the scheduler can ignore
|
9114
9209
|
# `desiredCount` temporarily during task replacement. For example,
|
@@ -9135,12 +9230,17 @@ module Aws::ECS
|
|
9135
9230
|
# manually.
|
9136
9231
|
#
|
9137
9232
|
# A container instance has completed draining when it has no more
|
9138
|
-
# `RUNNING` tasks. You can verify this using ListTasks.
|
9233
|
+
# `RUNNING` tasks. You can verify this using [ListTasks][2].
|
9139
9234
|
#
|
9140
9235
|
# When a container instance has been drained, you can set a container
|
9141
9236
|
# instance to `ACTIVE` status and once it has reached that status the
|
9142
9237
|
# Amazon ECS scheduler can begin scheduling tasks on the instance again.
|
9143
9238
|
#
|
9239
|
+
#
|
9240
|
+
#
|
9241
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
9242
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html
|
9243
|
+
#
|
9144
9244
|
# @option params [String] :cluster
|
9145
9245
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
9146
9246
|
# hosts the container instance to update. If you do not specify a
|
@@ -9281,7 +9381,7 @@ module Aws::ECS
|
|
9281
9381
|
# propagate tags option, using this API. If the launch type, load
|
9282
9382
|
# balancer, network configuration, platform version, or task definition
|
9283
9383
|
# need to be updated, create a new task set For more information, see
|
9284
|
-
# CreateTaskSet.
|
9384
|
+
# [CreateTaskSet][3].
|
9285
9385
|
#
|
9286
9386
|
# You can add to or subtract from the number of instantiations of a task
|
9287
9387
|
# definition in a service by specifying the cluster that the service is
|
@@ -9330,12 +9430,12 @@ module Aws::ECS
|
|
9330
9430
|
# the four older tasks (provided that the cluster resources required
|
9331
9431
|
# to do this are available).
|
9332
9432
|
#
|
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.
|
9433
|
+
# When [UpdateService][4] stops a task during a deployment, the
|
9434
|
+
# equivalent of `docker stop` is issued to the containers running in the
|
9435
|
+
# task. This results in a `SIGTERM` and a 30-second timeout. After this,
|
9436
|
+
# `SIGKILL` is sent and the containers are forcibly stopped. If the
|
9437
|
+
# container handles the `SIGTERM` gracefully and exits within 30 seconds
|
9438
|
+
# from receiving it, no `SIGKILL` is sent.
|
9339
9439
|
#
|
9340
9440
|
# When the service scheduler launches new tasks, it determines task
|
9341
9441
|
# placement in your cluster with the following logic.
|
@@ -9381,7 +9481,7 @@ module Aws::ECS
|
|
9381
9481
|
# * `serviceRegistries`
|
9382
9482
|
#
|
9383
9483
|
# For more information about the role see the `CreateService` request
|
9384
|
-
# parameter [ `role` ][
|
9484
|
+
# parameter [ `role` ][5].
|
9385
9485
|
#
|
9386
9486
|
# </note>
|
9387
9487
|
#
|
@@ -9389,7 +9489,9 @@ module Aws::ECS
|
|
9389
9489
|
#
|
9390
9490
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types
|
9391
9491
|
# [2]: https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html
|
9392
|
-
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/
|
9492
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html
|
9493
|
+
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
9494
|
+
# [5]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role
|
9393
9495
|
#
|
9394
9496
|
# @option params [String] :cluster
|
9395
9497
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
@@ -9424,22 +9526,29 @@ module Aws::ECS
|
|
9424
9526
|
# A capacity provider strategy consists of one or more capacity
|
9425
9527
|
# providers along with the `base` and `weight` to assign to them. A
|
9426
9528
|
# 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
|
9529
|
+
# capacity provider strategy. The [PutClusterCapacityProviders][1] API
|
9530
|
+
# is used to associate a capacity provider with a cluster. Only capacity
|
9429
9531
|
# providers with an `ACTIVE` or `UPDATING` status can be used.
|
9430
9532
|
#
|
9431
9533
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
9432
9534
|
# capacity provider must already be created. New capacity providers can
|
9433
|
-
# be created with the
|
9535
|
+
# be created with the [CreateClusterCapacityProvider][2] API operation.
|
9434
9536
|
#
|
9435
9537
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
9436
9538
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
9437
9539
|
# available to all accounts and only need to be associated with a
|
9438
9540
|
# cluster to be used.
|
9439
9541
|
#
|
9440
|
-
# The PutClusterCapacityProviders
|
9441
|
-
# list of available capacity providers for a cluster after the
|
9442
|
-
# is created.
|
9542
|
+
# The [PutClusterCapacityProviders][1]API operation is used to update
|
9543
|
+
# the list of available capacity providers for a cluster after the
|
9544
|
+
# cluster is created.
|
9545
|
+
#
|
9546
|
+
#
|
9547
|
+
#
|
9548
|
+
#
|
9549
|
+
#
|
9550
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
9551
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html
|
9443
9552
|
#
|
9444
9553
|
# @option params [Types::DeploymentConfiguration] :deployment_configuration
|
9445
9554
|
# Optional deployment parameters that control how many tasks run during
|
@@ -10324,14 +10433,19 @@ module Aws::ECS
|
|
10324
10433
|
# @api private
|
10325
10434
|
def build_request(operation_name, params = {})
|
10326
10435
|
handlers = @handlers.for(operation_name)
|
10436
|
+
tracer = config.telemetry_provider.tracer_provider.tracer(
|
10437
|
+
Aws::Telemetry.module_to_tracer_name('Aws::ECS')
|
10438
|
+
)
|
10327
10439
|
context = Seahorse::Client::RequestContext.new(
|
10328
10440
|
operation_name: operation_name,
|
10329
10441
|
operation: config.api.operation(operation_name),
|
10330
10442
|
client: self,
|
10331
10443
|
params: params,
|
10332
|
-
config: config
|
10444
|
+
config: config,
|
10445
|
+
tracer: tracer
|
10446
|
+
)
|
10333
10447
|
context[:gem_name] = 'aws-sdk-ecs'
|
10334
|
-
context[:gem_version] = '1.
|
10448
|
+
context[:gem_version] = '1.157.0'
|
10335
10449
|
Seahorse::Client::Request.new(handlers, context)
|
10336
10450
|
end
|
10337
10451
|
|