aws-sdk-ecs 1.151.0 → 1.154.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ecs/client.rb +224 -133
- data/lib/aws-sdk-ecs/client_api.rb +10 -0
- data/lib/aws-sdk-ecs/types.rb +509 -602
- data/lib/aws-sdk-ecs.rb +1 -1
- data/sig/client.rbs +5 -0
- data/sig/types.rbs +8 -0
- metadata +2 -2
data/lib/aws-sdk-ecs/client.rb
CHANGED
@@ -538,23 +538,23 @@ module Aws::ECS
|
|
538
538
|
|
539
539
|
# Creates a new Amazon ECS cluster. By default, your account receives a
|
540
540
|
# `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*.
|
541
|
+
# However, you can create your own cluster with a unique name.
|
542
|
+
#
|
543
|
+
# <note markdown="1"> When you call the [CreateCluster][1] API operation, Amazon ECS
|
544
|
+
# attempts to create the Amazon ECS service-linked role for your
|
545
|
+
# account. This is so that it can manage required resources in other
|
546
|
+
# Amazon Web Services services on your behalf. However, if the user that
|
547
|
+
# makes the call doesn't have permissions to create the service-linked
|
548
|
+
# role, it isn't created. For more information, see [Using
|
549
|
+
# service-linked roles for Amazon ECS][2] in the *Amazon Elastic
|
550
|
+
# Container Service Developer Guide*.
|
552
551
|
#
|
553
552
|
# </note>
|
554
553
|
#
|
555
554
|
#
|
556
555
|
#
|
557
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/
|
556
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html
|
557
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html
|
558
558
|
#
|
559
559
|
# @option params [String] :cluster_name
|
560
560
|
# The name of your cluster. If you don't specify a name for your
|
@@ -596,7 +596,12 @@ module Aws::ECS
|
|
596
596
|
# The setting to use when creating a cluster. This parameter is used to
|
597
597
|
# turn on CloudWatch Container Insights for a cluster. If this value is
|
598
598
|
# specified, it overrides the `containerInsights` value set with
|
599
|
-
# PutAccountSetting or PutAccountSettingDefault.
|
599
|
+
# [PutAccountSetting][1] or [PutAccountSettingDefault][2].
|
600
|
+
#
|
601
|
+
#
|
602
|
+
#
|
603
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html
|
604
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html
|
600
605
|
#
|
601
606
|
# @option params [Types::ClusterConfiguration] :configuration
|
602
607
|
# The `execute` command configuration for the cluster.
|
@@ -638,12 +643,13 @@ module Aws::ECS
|
|
638
643
|
#
|
639
644
|
# If a default capacity provider strategy isn't defined for a cluster
|
640
645
|
# when it was created, it can be defined later with the
|
641
|
-
# PutClusterCapacityProviders API operation.
|
646
|
+
# [PutClusterCapacityProviders][3] API operation.
|
642
647
|
#
|
643
648
|
#
|
644
649
|
#
|
645
650
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html
|
646
651
|
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html
|
652
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
647
653
|
#
|
648
654
|
# @option params [Types::ClusterServiceConnectDefaultsRequest] :service_connect_defaults
|
649
655
|
# Use this parameter to set a default Service Connect namespace. After
|
@@ -794,8 +800,8 @@ module Aws::ECS
|
|
794
800
|
# Runs and maintains your desired number of tasks from a specified task
|
795
801
|
# definition. If the number of tasks running in a service drops below
|
796
802
|
# the `desiredCount`, Amazon ECS runs another copy of the task in the
|
797
|
-
# specified cluster. To update an existing service,
|
798
|
-
# UpdateService
|
803
|
+
# specified cluster. To update an existing service, use
|
804
|
+
# [UpdateService][1].
|
799
805
|
#
|
800
806
|
# <note markdown="1"> On March 21, 2024, a change was made to resolve the task definition
|
801
807
|
# revision before authorization. When a task definition revision is not
|
@@ -808,13 +814,13 @@ module Aws::ECS
|
|
808
814
|
# you can optionally run your service behind one or more load balancers.
|
809
815
|
# The load balancers distribute traffic across the tasks that are
|
810
816
|
# associated with the service. For more information, see [Service load
|
811
|
-
# balancing][
|
817
|
+
# balancing][2] in the *Amazon Elastic Container Service Developer
|
812
818
|
# Guide*.
|
813
819
|
#
|
814
820
|
# You can attach Amazon EBS volumes to Amazon ECS tasks by configuring
|
815
821
|
# the volume when creating or updating a service. `volumeConfigurations`
|
816
822
|
# is only supported for REPLICA service and not DAEMON service. For more
|
817
|
-
# infomation, see [Amazon EBS volumes][
|
823
|
+
# infomation, see [Amazon EBS volumes][3] in the *Amazon Elastic
|
818
824
|
# Container Service Developer Guide*.
|
819
825
|
#
|
820
826
|
# Tasks for services that don't use a load balancer are considered
|
@@ -829,7 +835,7 @@ module Aws::ECS
|
|
829
835
|
# service scheduler spreads tasks across Availability Zones. You can
|
830
836
|
# use task placement strategies and constraints to customize task
|
831
837
|
# placement decisions. For more information, see [Service scheduler
|
832
|
-
# concepts][
|
838
|
+
# concepts][4] in the *Amazon Elastic Container Service Developer
|
833
839
|
# Guide*.
|
834
840
|
#
|
835
841
|
# * `DAEMON` - The daemon scheduling strategy deploys exactly one task
|
@@ -840,16 +846,16 @@ module Aws::ECS
|
|
840
846
|
# constraints. When using this strategy, you don't need to specify a
|
841
847
|
# desired number of tasks, a task placement strategy, or use Service
|
842
848
|
# Auto Scaling policies. For more information, see [Service scheduler
|
843
|
-
# concepts][
|
849
|
+
# concepts][4] in the *Amazon Elastic Container Service Developer
|
844
850
|
# Guide*.
|
845
851
|
#
|
846
852
|
# You can optionally specify a deployment configuration for your
|
847
853
|
# service. The deployment is initiated by changing properties. For
|
848
854
|
# example, the deployment might be initiated by the task definition or
|
849
|
-
# by your desired count of a service.
|
850
|
-
#
|
851
|
-
#
|
852
|
-
#
|
855
|
+
# by your desired count of a service. You can use [UpdateService][1].
|
856
|
+
# The default value for a replica service for `minimumHealthyPercent` is
|
857
|
+
# 100%. The default value for a daemon service for
|
858
|
+
# `minimumHealthyPercent` is 0%.
|
853
859
|
#
|
854
860
|
# If a service uses the `ECS` deployment controller, the minimum healthy
|
855
861
|
# percent represents a lower limit on the number of tasks in a service
|
@@ -895,13 +901,13 @@ module Aws::ECS
|
|
895
901
|
# When creating a service that uses the `EXTERNAL` deployment
|
896
902
|
# controller, you can specify only parameters that aren't controlled at
|
897
903
|
# 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][
|
904
|
+
# You control your services using the [CreateTaskSet][5]. For more
|
905
|
+
# information, see [Amazon ECS deployment types][6] in the *Amazon
|
900
906
|
# Elastic Container Service Developer Guide*.
|
901
907
|
#
|
902
908
|
# When the service scheduler launches new tasks, it determines task
|
903
909
|
# placement. For information about task placement and task placement
|
904
|
-
# strategies, see [Amazon ECS task placement][
|
910
|
+
# strategies, see [Amazon ECS task placement][7] in the *Amazon Elastic
|
905
911
|
# Container Service Developer Guide*
|
906
912
|
#
|
907
913
|
# Starting April 15, 2023, Amazon Web Services will not onboard new
|
@@ -915,11 +921,13 @@ module Aws::ECS
|
|
915
921
|
#
|
916
922
|
#
|
917
923
|
#
|
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/
|
924
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
925
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html
|
926
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types
|
927
|
+
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html
|
928
|
+
# [5]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html
|
929
|
+
# [6]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html
|
930
|
+
# [7]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html
|
923
931
|
#
|
924
932
|
# @option params [String] :cluster
|
925
933
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
@@ -1749,7 +1757,7 @@ module Aws::ECS
|
|
1749
1757
|
#
|
1750
1758
|
# </note>
|
1751
1759
|
#
|
1752
|
-
# For information about the maximum number of task sets and
|
1760
|
+
# For information about the maximum number of task sets and other
|
1753
1761
|
# quotas, see [Amazon ECS service quotas][2] in the *Amazon Elastic
|
1754
1762
|
# Container Service Developer Guide*.
|
1755
1763
|
#
|
@@ -1811,8 +1819,8 @@ module Aws::ECS
|
|
1811
1819
|
# A capacity provider strategy consists of one or more capacity
|
1812
1820
|
# providers along with the `base` and `weight` to assign to them. A
|
1813
1821
|
# 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
|
1822
|
+
# capacity provider strategy. The [PutClusterCapacityProviders][1] API
|
1823
|
+
# is used to associate a capacity provider with a cluster. Only capacity
|
1816
1824
|
# providers with an `ACTIVE` or `UPDATING` status can be used.
|
1817
1825
|
#
|
1818
1826
|
# If a `capacityProviderStrategy` is specified, the `launchType`
|
@@ -1822,16 +1830,21 @@ module Aws::ECS
|
|
1822
1830
|
#
|
1823
1831
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
1824
1832
|
# capacity provider must already be created. New capacity providers can
|
1825
|
-
# be created with the
|
1833
|
+
# be created with the [CreateCapacityProviderProvider][2]API operation.
|
1826
1834
|
#
|
1827
1835
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
1828
1836
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
1829
1837
|
# available to all accounts and only need to be associated with a
|
1830
1838
|
# cluster to be used.
|
1831
1839
|
#
|
1832
|
-
# The PutClusterCapacityProviders API operation is used to update
|
1833
|
-
# list of available capacity providers for a cluster after the
|
1834
|
-
# is created.
|
1840
|
+
# The [PutClusterCapacityProviders][1] API operation is used to update
|
1841
|
+
# the list of available capacity providers for a cluster after the
|
1842
|
+
# cluster is created.
|
1843
|
+
#
|
1844
|
+
#
|
1845
|
+
#
|
1846
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
1847
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProviderProvider.html
|
1835
1848
|
#
|
1836
1849
|
# @option params [String] :platform_version
|
1837
1850
|
# The platform version that the tasks in the task set uses. A platform
|
@@ -2126,20 +2139,26 @@ module Aws::ECS
|
|
2126
2139
|
#
|
2127
2140
|
# <note markdown="1"> The `FARGATE` and `FARGATE_SPOT` capacity providers are reserved and
|
2128
2141
|
# can't be deleted. You can disassociate them from a cluster using
|
2129
|
-
# either
|
2142
|
+
# either [PutCapacityProviderProviders][1] or by deleting the cluster.
|
2130
2143
|
#
|
2131
2144
|
# </note>
|
2132
2145
|
#
|
2133
2146
|
# Prior to a capacity provider being deleted, the capacity provider must
|
2134
2147
|
# 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
|
2148
|
+
# [UpdateService][2] API can be used to remove a capacity provider from
|
2149
|
+
# a service's capacity provider strategy. When updating a service, the
|
2137
2150
|
# `forceNewDeployment` option can be used to ensure that any tasks using
|
2138
2151
|
# the Amazon EC2 instance capacity provided by the capacity provider are
|
2139
2152
|
# transitioned to use the capacity from the remaining capacity
|
2140
2153
|
# providers. Only capacity providers that aren't associated with a
|
2141
2154
|
# cluster can be deleted. To remove a capacity provider from a cluster,
|
2142
|
-
# you can either use
|
2155
|
+
# you can either use [PutCapacityProviderProviders][1] or delete the
|
2156
|
+
# cluster.
|
2157
|
+
#
|
2158
|
+
#
|
2159
|
+
#
|
2160
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProviderProviders.html
|
2161
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
2143
2162
|
#
|
2144
2163
|
# @option params [required, String] :capacity_provider
|
2145
2164
|
# The short name or full Amazon Resource Name (ARN) of the capacity
|
@@ -2191,8 +2210,13 @@ module Aws::ECS
|
|
2191
2210
|
#
|
2192
2211
|
# You must deregister all container instances from this cluster before
|
2193
2212
|
# you may delete it. You can list the container instances in a cluster
|
2194
|
-
# with ListContainerInstances and deregister them with
|
2195
|
-
# DeregisterContainerInstance.
|
2213
|
+
# with [ListContainerInstances][1] and deregister them with
|
2214
|
+
# [DeregisterContainerInstance][2].
|
2215
|
+
#
|
2216
|
+
#
|
2217
|
+
#
|
2218
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html
|
2219
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html
|
2196
2220
|
#
|
2197
2221
|
# @option params [required, String] :cluster
|
2198
2222
|
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
@@ -2286,18 +2310,19 @@ module Aws::ECS
|
|
2286
2310
|
# if you have no running tasks in it and the desired task count is zero.
|
2287
2311
|
# If the service is actively maintaining tasks, you can't delete it,
|
2288
2312
|
# and you must update the service to a desired task count of zero. For
|
2289
|
-
# more information, see UpdateService.
|
2313
|
+
# more information, see [UpdateService][1].
|
2290
2314
|
#
|
2291
2315
|
# <note markdown="1"> When you delete a service, if there are still running tasks that
|
2292
2316
|
# require cleanup, the service status moves from `ACTIVE` to `DRAINING`,
|
2293
2317
|
# and the service is no longer visible in the console or in the
|
2294
|
-
# ListServices API operation. After all tasks have transitioned to
|
2318
|
+
# [ListServices][2] API operation. After all tasks have transitioned to
|
2295
2319
|
# either `STOPPING` or `STOPPED` status, the service status moves from
|
2296
2320
|
# `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
|
2321
|
+
# status can still be viewed with the [DescribeServices][3] API
|
2322
|
+
# operation. However, in the future, `INACTIVE` services may be cleaned
|
2323
|
+
# up and purged from Amazon ECS record keeping, and
|
2324
|
+
# [DescribeServices][3] calls on those services return a
|
2325
|
+
# `ServiceNotFoundException` error.
|
2301
2326
|
#
|
2302
2327
|
# </note>
|
2303
2328
|
#
|
@@ -2305,6 +2330,12 @@ module Aws::ECS
|
|
2305
2330
|
# existing service in either `ACTIVE` or `DRAINING` status, you receive
|
2306
2331
|
# an error.
|
2307
2332
|
#
|
2333
|
+
#
|
2334
|
+
#
|
2335
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
2336
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html
|
2337
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html
|
2338
|
+
#
|
2308
2339
|
# @option params [String] :cluster
|
2309
2340
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
2310
2341
|
# hosts the service to delete. If you do not specify a cluster, the
|
@@ -2596,6 +2627,10 @@ module Aws::ECS
|
|
2596
2627
|
# resp.task_definitions[0].container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
|
2597
2628
|
# resp.task_definitions[0].container_definitions[0].port_mappings[0].container_port_range #=> String
|
2598
2629
|
# resp.task_definitions[0].container_definitions[0].essential #=> Boolean
|
2630
|
+
# resp.task_definitions[0].container_definitions[0].restart_policy.enabled #=> Boolean
|
2631
|
+
# resp.task_definitions[0].container_definitions[0].restart_policy.ignored_exit_codes #=> Array
|
2632
|
+
# resp.task_definitions[0].container_definitions[0].restart_policy.ignored_exit_codes[0] #=> Integer
|
2633
|
+
# resp.task_definitions[0].container_definitions[0].restart_policy.restart_attempt_period #=> Integer
|
2599
2634
|
# resp.task_definitions[0].container_definitions[0].entry_point #=> Array
|
2600
2635
|
# resp.task_definitions[0].container_definitions[0].entry_point[0] #=> String
|
2601
2636
|
# resp.task_definitions[0].container_definitions[0].command #=> Array
|
@@ -3053,6 +3088,10 @@ module Aws::ECS
|
|
3053
3088
|
# resp.task_definition.container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
|
3054
3089
|
# resp.task_definition.container_definitions[0].port_mappings[0].container_port_range #=> String
|
3055
3090
|
# resp.task_definition.container_definitions[0].essential #=> Boolean
|
3091
|
+
# resp.task_definition.container_definitions[0].restart_policy.enabled #=> Boolean
|
3092
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes #=> Array
|
3093
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes[0] #=> Integer
|
3094
|
+
# resp.task_definition.container_definitions[0].restart_policy.restart_attempt_period #=> Integer
|
3056
3095
|
# resp.task_definition.container_definitions[0].entry_point #=> Array
|
3057
3096
|
# resp.task_definition.container_definitions[0].entry_point[0] #=> String
|
3058
3097
|
# resp.task_definition.container_definitions[0].command #=> Array
|
@@ -3999,6 +4038,10 @@ module Aws::ECS
|
|
3999
4038
|
# resp.task_definition.container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
|
4000
4039
|
# resp.task_definition.container_definitions[0].port_mappings[0].container_port_range #=> String
|
4001
4040
|
# resp.task_definition.container_definitions[0].essential #=> Boolean
|
4041
|
+
# resp.task_definition.container_definitions[0].restart_policy.enabled #=> Boolean
|
4042
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes #=> Array
|
4043
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes[0] #=> Integer
|
4044
|
+
# resp.task_definition.container_definitions[0].restart_policy.restart_attempt_period #=> Integer
|
4002
4045
|
# resp.task_definition.container_definitions[0].entry_point #=> Array
|
4003
4046
|
# resp.task_definition.container_definitions[0].entry_point[0] #=> String
|
4004
4047
|
# resp.task_definition.container_definitions[0].command #=> Array
|
@@ -5009,9 +5052,14 @@ module Aws::ECS
|
|
5009
5052
|
# @option params [String] :status
|
5010
5053
|
# Filters the container instances by status. For example, if you specify
|
5011
5054
|
# 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
|
5055
|
+
# that have been set to `DRAINING` using
|
5056
|
+
# [UpdateContainerInstancesState][1]. If you don't specify this
|
5057
|
+
# parameter, the default is to include container instances set to all
|
5058
|
+
# states other than `INACTIVE`.
|
5059
|
+
#
|
5060
|
+
#
|
5061
|
+
#
|
5062
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateContainerInstancesState.html
|
5015
5063
|
#
|
5016
5064
|
# @return [Types::ListContainerInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5017
5065
|
#
|
@@ -6024,12 +6072,13 @@ module Aws::ECS
|
|
6024
6072
|
# Create or update an attribute on an Amazon ECS resource. If the
|
6025
6073
|
# attribute doesn't exist, it's created. If the attribute exists, its
|
6026
6074
|
# 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*.
|
6075
|
+
# use [DeleteAttributes][1]. For more information, see [Attributes][2]
|
6076
|
+
# in the *Amazon Elastic Container Service Developer Guide*.
|
6029
6077
|
#
|
6030
6078
|
#
|
6031
6079
|
#
|
6032
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/
|
6080
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteAttributes.html
|
6081
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes
|
6033
6082
|
#
|
6034
6083
|
# @option params [String] :cluster
|
6035
6084
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
@@ -6084,10 +6133,10 @@ module Aws::ECS
|
|
6084
6133
|
# has existing capacity providers associated with it, you must specify
|
6085
6134
|
# all existing capacity providers in addition to any new ones you want
|
6086
6135
|
# 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.
|
6136
|
+
# cluster that are omitted from a [PutClusterCapacityProviders][1] API
|
6137
|
+
# call will be disassociated with the cluster. You can only disassociate
|
6138
|
+
# an existing capacity provider from a cluster if it's not being used
|
6139
|
+
# by any existing tasks.
|
6091
6140
|
#
|
6092
6141
|
# When creating a service or running a task on a cluster, if no capacity
|
6093
6142
|
# provider or launch type is specified, then the cluster's default
|
@@ -6095,6 +6144,10 @@ module Aws::ECS
|
|
6095
6144
|
# default capacity provider strategy for your cluster. However, you must
|
6096
6145
|
# specify an empty array (`[]`) to bypass defining a default strategy.
|
6097
6146
|
#
|
6147
|
+
#
|
6148
|
+
#
|
6149
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
6150
|
+
#
|
6098
6151
|
# @option params [required, String] :cluster
|
6099
6152
|
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
6100
6153
|
# modify the capacity provider settings for. If you don't specify a
|
@@ -6106,13 +6159,17 @@ module Aws::ECS
|
|
6106
6159
|
#
|
6107
6160
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
6108
6161
|
# capacity provider must already be created. New capacity providers can
|
6109
|
-
# be created with the CreateCapacityProvider API operation.
|
6162
|
+
# be created with the [CreateCapacityProvider][1] API operation.
|
6110
6163
|
#
|
6111
6164
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
6112
6165
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
6113
6166
|
# available to all accounts and only need to be associated with a
|
6114
6167
|
# cluster to be used.
|
6115
6168
|
#
|
6169
|
+
#
|
6170
|
+
#
|
6171
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html
|
6172
|
+
#
|
6116
6173
|
# @option params [required, Array<Types::CapacityProviderStrategyItem>] :default_capacity_provider_strategy
|
6117
6174
|
# The capacity provider strategy to use by default for the cluster.
|
6118
6175
|
#
|
@@ -6123,19 +6180,24 @@ module Aws::ECS
|
|
6123
6180
|
# A capacity provider strategy consists of one or more capacity
|
6124
6181
|
# providers along with the `base` and `weight` to assign to them. A
|
6125
6182
|
# 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
|
6183
|
+
# capacity provider strategy. The [PutClusterCapacityProviders][1] API
|
6184
|
+
# is used to associate a capacity provider with a cluster. Only capacity
|
6128
6185
|
# providers with an `ACTIVE` or `UPDATING` status can be used.
|
6129
6186
|
#
|
6130
6187
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
6131
6188
|
# capacity provider must already be created. New capacity providers can
|
6132
|
-
# be created with the CreateCapacityProvider API operation.
|
6189
|
+
# be created with the [CreateCapacityProvider][2] API operation.
|
6133
6190
|
#
|
6134
6191
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
6135
6192
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
6136
6193
|
# available to all accounts and only need to be associated with a
|
6137
6194
|
# cluster to be used.
|
6138
6195
|
#
|
6196
|
+
#
|
6197
|
+
#
|
6198
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
6199
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html
|
6200
|
+
#
|
6139
6201
|
# @return [Types::PutClusterCapacityProvidersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6140
6202
|
#
|
6141
6203
|
# * {Types::PutClusterCapacityProvidersResponse#cluster #cluster} => Types::Cluster
|
@@ -6405,20 +6467,18 @@ module Aws::ECS
|
|
6405
6467
|
# Tasks][2] in the *Amazon Elastic Container Service Developer Guide*.
|
6406
6468
|
#
|
6407
6469
|
# 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*.
|
6470
|
+
# task definition with the `networkMode` parameter. If you specify the
|
6471
|
+
# `awsvpc` network mode, the task is allocated an elastic network
|
6472
|
+
# interface, and you must specify a [NetworkConfiguration][3] when you
|
6473
|
+
# create a service or run a task with the task definition. For more
|
6474
|
+
# information, see [Task Networking][4] in the *Amazon Elastic Container
|
6475
|
+
# Service Developer Guide*.
|
6416
6476
|
#
|
6417
6477
|
#
|
6418
6478
|
#
|
6419
6479
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html
|
6420
6480
|
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html
|
6421
|
-
# [3]: https://docs.
|
6481
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html
|
6422
6482
|
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
6423
6483
|
#
|
6424
6484
|
# @option params [required, String] :family
|
@@ -6441,14 +6501,13 @@ module Aws::ECS
|
|
6441
6501
|
# @option params [String] :execution_role_arn
|
6442
6502
|
# The Amazon Resource Name (ARN) of the task execution role that grants
|
6443
6503
|
# the Amazon ECS container agent permission to make Amazon Web Services
|
6444
|
-
# API calls on your behalf.
|
6445
|
-
#
|
6446
|
-
#
|
6447
|
-
# Container Service Developer Guide*.
|
6504
|
+
# API calls on your behalf. For informationabout the required IAM roles
|
6505
|
+
# for Amazon ECS, see [IAM roles for Amazon ECS][1] in the *Amazon
|
6506
|
+
# Elastic Container Service Developer Guide*.
|
6448
6507
|
#
|
6449
6508
|
#
|
6450
6509
|
#
|
6451
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
6510
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html
|
6452
6511
|
#
|
6453
6512
|
# @option params [String] :network_mode
|
6454
6513
|
# The Docker networking mode to use for the containers in the task. The
|
@@ -6477,22 +6536,19 @@ module Aws::ECS
|
|
6477
6536
|
# non-root user.
|
6478
6537
|
#
|
6479
6538
|
# 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*.
|
6539
|
+
# network interface, and you must specify a [NetworkConfiguration][1]
|
6540
|
+
# value when you create a service or run a task with the task
|
6541
|
+
# definition. For more information, see [Task Networking][2] in the
|
6542
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
6484
6543
|
#
|
6485
6544
|
# If the network mode is `host`, you cannot run multiple instantiations
|
6486
6545
|
# of the same task on a single container instance when port mappings are
|
6487
6546
|
# used.
|
6488
6547
|
#
|
6489
|
-
# For more information, see [Network settings][2] in the *Docker run
|
6490
|
-
# reference*.
|
6491
6548
|
#
|
6492
6549
|
#
|
6493
|
-
#
|
6494
|
-
# [
|
6495
|
-
# [2]: https://docs.docker.com/engine/reference/run/#network-settings
|
6550
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html
|
6551
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
6496
6552
|
#
|
6497
6553
|
# @option params [required, Array<Types::ContainerDefinition>] :container_definitions
|
6498
6554
|
# A list of container definitions in JSON format that describe the
|
@@ -6655,12 +6711,10 @@ module Aws::ECS
|
|
6655
6711
|
# the same process namespace.
|
6656
6712
|
#
|
6657
6713
|
# If no value is specified, the default is a private namespace for each
|
6658
|
-
# container.
|
6659
|
-
# run reference*.
|
6714
|
+
# container.
|
6660
6715
|
#
|
6661
6716
|
# If the `host` PID mode is used, there's a heightened risk of
|
6662
|
-
# undesired process namespace exposure.
|
6663
|
-
# [Docker security][2].
|
6717
|
+
# undesired process namespace exposure.
|
6664
6718
|
#
|
6665
6719
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
6666
6720
|
#
|
@@ -6672,11 +6726,6 @@ module Aws::ECS
|
|
6672
6726
|
#
|
6673
6727
|
# </note>
|
6674
6728
|
#
|
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
6729
|
# @option params [String] :ipc_mode
|
6681
6730
|
# The IPC resource namespace to use for the containers in the task. The
|
6682
6731
|
# valid values are `host`, `task`, or `none`. If `host` is specified,
|
@@ -6688,16 +6737,14 @@ module Aws::ECS
|
|
6688
6737
|
# private and not shared with other containers in a task or on the
|
6689
6738
|
# container instance. If no value is specified, then the IPC resource
|
6690
6739
|
# namespace sharing depends on the Docker daemon setting on the
|
6691
|
-
# container instance.
|
6692
|
-
# *Docker run reference*.
|
6740
|
+
# container instance.
|
6693
6741
|
#
|
6694
6742
|
# 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].
|
6743
|
+
# risk of undesired IPC namespace expose.
|
6697
6744
|
#
|
6698
6745
|
# If you are setting namespaced kernel parameters using `systemControls`
|
6699
6746
|
# for the containers in the task, the following will apply to your IPC
|
6700
|
-
# resource namespace. For more information, see [System Controls][
|
6747
|
+
# resource namespace. For more information, see [System Controls][1] in
|
6701
6748
|
# the *Amazon Elastic Container Service Developer Guide*.
|
6702
6749
|
#
|
6703
6750
|
# * For tasks that use the `host` IPC mode, IPC namespace related
|
@@ -6713,9 +6760,7 @@ module Aws::ECS
|
|
6713
6760
|
#
|
6714
6761
|
#
|
6715
6762
|
#
|
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
|
6763
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html
|
6719
6764
|
#
|
6720
6765
|
# @option params [Types::ProxyConfiguration] :proxy_configuration
|
6721
6766
|
# The configuration details for the App Mesh proxy.
|
@@ -6852,6 +6897,11 @@ module Aws::ECS
|
|
6852
6897
|
# },
|
6853
6898
|
# ],
|
6854
6899
|
# essential: false,
|
6900
|
+
# restart_policy: {
|
6901
|
+
# enabled: false, # required
|
6902
|
+
# ignored_exit_codes: [1],
|
6903
|
+
# restart_attempt_period: 1,
|
6904
|
+
# },
|
6855
6905
|
# entry_point: ["String"],
|
6856
6906
|
# command: ["String"],
|
6857
6907
|
# environment: [
|
@@ -7084,6 +7134,10 @@ module Aws::ECS
|
|
7084
7134
|
# resp.task_definition.container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
|
7085
7135
|
# resp.task_definition.container_definitions[0].port_mappings[0].container_port_range #=> String
|
7086
7136
|
# resp.task_definition.container_definitions[0].essential #=> Boolean
|
7137
|
+
# resp.task_definition.container_definitions[0].restart_policy.enabled #=> Boolean
|
7138
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes #=> Array
|
7139
|
+
# resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes[0] #=> Integer
|
7140
|
+
# resp.task_definition.container_definitions[0].restart_policy.restart_attempt_period #=> Integer
|
7087
7141
|
# resp.task_definition.container_definitions[0].entry_point #=> Array
|
7088
7142
|
# resp.task_definition.container_definitions[0].entry_point[0] #=> String
|
7089
7143
|
# resp.task_definition.container_definitions[0].command #=> Array
|
@@ -7257,7 +7311,7 @@ module Aws::ECS
|
|
7257
7311
|
# strategies. For more information, see [Scheduling Tasks][1] in the
|
7258
7312
|
# *Amazon Elastic Container Service Developer Guide*.
|
7259
7313
|
#
|
7260
|
-
# Alternatively, you can use StartTask to use your own scheduler or
|
7314
|
+
# Alternatively, you can use `StartTask` to use your own scheduler or
|
7261
7315
|
# place tasks manually on specific container instances.
|
7262
7316
|
#
|
7263
7317
|
# Starting April 15, 2023, Amazon Web Services will not onboard new
|
@@ -7426,13 +7480,17 @@ module Aws::ECS
|
|
7426
7480
|
# Specifies whether to propagate the tags from the task definition to
|
7427
7481
|
# the task. If no value is specified, the tags aren't propagated. Tags
|
7428
7482
|
# can only be propagated to the task during task creation. To add tags
|
7429
|
-
# to a task after task creation, use the
|
7483
|
+
# to a task after task creation, use the[TagResource][1] API action.
|
7430
7484
|
#
|
7431
7485
|
# <note markdown="1"> An error will be received if you specify the `SERVICE` option when
|
7432
7486
|
# running a task.
|
7433
7487
|
#
|
7434
7488
|
# </note>
|
7435
7489
|
#
|
7490
|
+
#
|
7491
|
+
#
|
7492
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html
|
7493
|
+
#
|
7436
7494
|
# @option params [String] :reference_id
|
7437
7495
|
# The reference ID to use for the task. The reference ID can have a
|
7438
7496
|
# maximum length of 1024 characters.
|
@@ -7442,13 +7500,18 @@ module Aws::ECS
|
|
7442
7500
|
# automatically trigger a task to run a batch process job, you could
|
7443
7501
|
# apply a unique identifier for that job to your task with the
|
7444
7502
|
# `startedBy` parameter. You can then identify which tasks belong to
|
7445
|
-
# that job by filtering the results of a ListTasks call with the
|
7503
|
+
# that job by filtering the results of a [ListTasks][1] call with the
|
7446
7504
|
# `startedBy` value. Up to 128 letters (uppercase and lowercase),
|
7447
|
-
# numbers, hyphens (-), and underscores (\_) are
|
7505
|
+
# numbers, hyphens (-), forward slash (/), and underscores (\_) are
|
7506
|
+
# allowed.
|
7448
7507
|
#
|
7449
7508
|
# If a task is started by an Amazon ECS service, then the `startedBy`
|
7450
7509
|
# parameter contains the deployment ID of the service that starts it.
|
7451
7510
|
#
|
7511
|
+
#
|
7512
|
+
#
|
7513
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html
|
7514
|
+
#
|
7452
7515
|
# @option params [Array<Types::Tag>] :tags
|
7453
7516
|
# The metadata that you apply to the task to help you categorize and
|
7454
7517
|
# organize them. Each tag consists of a key and an optional value, both
|
@@ -7836,7 +7899,7 @@ module Aws::ECS
|
|
7836
7899
|
# at least once during the past 30-day period are considered current
|
7837
7900
|
# customers and will be able to continue using the service.
|
7838
7901
|
#
|
7839
|
-
# Alternatively, you can use
|
7902
|
+
# Alternatively, you can use`RunTask` to place tasks for you. For more
|
7840
7903
|
# information, see [Scheduling Tasks][1] in the *Amazon Elastic
|
7841
7904
|
# Container Service Developer Guide*.
|
7842
7905
|
#
|
@@ -7912,13 +7975,18 @@ module Aws::ECS
|
|
7912
7975
|
# automatically trigger a task to run a batch process job, you could
|
7913
7976
|
# apply a unique identifier for that job to your task with the
|
7914
7977
|
# `startedBy` parameter. You can then identify which tasks belong to
|
7915
|
-
# that job by filtering the results of a ListTasks call with the
|
7978
|
+
# that job by filtering the results of a [ListTasks][1] call with the
|
7916
7979
|
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
7917
|
-
# numbers, hyphens (-), and underscores (\_) are
|
7980
|
+
# numbers, hyphens (-), forward slash (/), and underscores (\_) are
|
7981
|
+
# allowed.
|
7918
7982
|
#
|
7919
7983
|
# If a task is started by an Amazon ECS service, the `startedBy`
|
7920
7984
|
# parameter contains the deployment ID of the service that starts it.
|
7921
7985
|
#
|
7986
|
+
#
|
7987
|
+
#
|
7988
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html
|
7989
|
+
#
|
7922
7990
|
# @option params [Array<Types::Tag>] :tags
|
7923
7991
|
# The metadata that you apply to the task to help you categorize and
|
7924
7992
|
# organize them. Each tag consists of a key and an optional value, both
|
@@ -8195,7 +8263,7 @@ module Aws::ECS
|
|
8195
8263
|
# Stops a running task. Any tags associated with the task will be
|
8196
8264
|
# deleted.
|
8197
8265
|
#
|
8198
|
-
# When
|
8266
|
+
# When you call `StopTask` on a task, the equivalent of `docker stop` is
|
8199
8267
|
# issued to the containers running in the task. This results in a
|
8200
8268
|
# `SIGTERM` value and a default 30-second timeout, after which the
|
8201
8269
|
# `SIGKILL` value is sent and the containers are forcibly stopped. If
|
@@ -8231,7 +8299,11 @@ module Aws::ECS
|
|
8231
8299
|
# An optional message specified when a task is stopped. For example, if
|
8232
8300
|
# you're using a custom scheduler, you can use this parameter to
|
8233
8301
|
# specify the reason for stopping the task here, and the message appears
|
8234
|
-
# in subsequent DescribeTasks API operations on this task.
|
8302
|
+
# in subsequent [DescribeTasks][1]> API operations on this task.
|
8303
|
+
#
|
8304
|
+
#
|
8305
|
+
#
|
8306
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html
|
8235
8307
|
#
|
8236
8308
|
# @return [Types::StopTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8237
8309
|
#
|
@@ -8891,7 +8963,7 @@ module Aws::ECS
|
|
8891
8963
|
# The setting to use by default for a cluster. This parameter is used to
|
8892
8964
|
# turn on CloudWatch Container Insights for a cluster. If this value is
|
8893
8965
|
# specified, it overrides the `containerInsights` value set with
|
8894
|
-
# PutAccountSetting or PutAccountSettingDefault.
|
8966
|
+
# [PutAccountSetting][1] or [PutAccountSettingDefault][2].
|
8895
8967
|
#
|
8896
8968
|
# Currently, if you delete an existing cluster that does not have
|
8897
8969
|
# Container Insights turned on, and then create a new cluster with the
|
@@ -8900,6 +8972,11 @@ module Aws::ECS
|
|
8900
8972
|
# your existing cluster and turn on Container Insights, you must wait 7
|
8901
8973
|
# days before you can re-create it.
|
8902
8974
|
#
|
8975
|
+
#
|
8976
|
+
#
|
8977
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html
|
8978
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html
|
8979
|
+
#
|
8903
8980
|
# @return [Types::UpdateClusterSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8904
8981
|
#
|
8905
8982
|
# * {Types::UpdateClusterSettingsResponse#cluster #cluster} => Types::Cluster
|
@@ -9108,7 +9185,7 @@ module Aws::ECS
|
|
9108
9185
|
# state are stopped and replaced according to the service's deployment
|
9109
9186
|
# configuration parameters, `minimumHealthyPercent` and
|
9110
9187
|
# `maximumPercent`. You can change the deployment configuration of your
|
9111
|
-
# service using UpdateService.
|
9188
|
+
# service using [UpdateService][1].
|
9112
9189
|
#
|
9113
9190
|
# * If `minimumHealthyPercent` is below 100%, the scheduler can ignore
|
9114
9191
|
# `desiredCount` temporarily during task replacement. For example,
|
@@ -9135,12 +9212,17 @@ module Aws::ECS
|
|
9135
9212
|
# manually.
|
9136
9213
|
#
|
9137
9214
|
# A container instance has completed draining when it has no more
|
9138
|
-
# `RUNNING` tasks. You can verify this using ListTasks.
|
9215
|
+
# `RUNNING` tasks. You can verify this using [ListTasks][2].
|
9139
9216
|
#
|
9140
9217
|
# When a container instance has been drained, you can set a container
|
9141
9218
|
# instance to `ACTIVE` status and once it has reached that status the
|
9142
9219
|
# Amazon ECS scheduler can begin scheduling tasks on the instance again.
|
9143
9220
|
#
|
9221
|
+
#
|
9222
|
+
#
|
9223
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
9224
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html
|
9225
|
+
#
|
9144
9226
|
# @option params [String] :cluster
|
9145
9227
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
9146
9228
|
# hosts the container instance to update. If you do not specify a
|
@@ -9281,7 +9363,7 @@ module Aws::ECS
|
|
9281
9363
|
# propagate tags option, using this API. If the launch type, load
|
9282
9364
|
# balancer, network configuration, platform version, or task definition
|
9283
9365
|
# need to be updated, create a new task set For more information, see
|
9284
|
-
# CreateTaskSet.
|
9366
|
+
# [CreateTaskSet][3].
|
9285
9367
|
#
|
9286
9368
|
# You can add to or subtract from the number of instantiations of a task
|
9287
9369
|
# definition in a service by specifying the cluster that the service is
|
@@ -9330,12 +9412,12 @@ module Aws::ECS
|
|
9330
9412
|
# the four older tasks (provided that the cluster resources required
|
9331
9413
|
# to do this are available).
|
9332
9414
|
#
|
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.
|
9415
|
+
# When [UpdateService][4] stops a task during a deployment, the
|
9416
|
+
# equivalent of `docker stop` is issued to the containers running in the
|
9417
|
+
# task. This results in a `SIGTERM` and a 30-second timeout. After this,
|
9418
|
+
# `SIGKILL` is sent and the containers are forcibly stopped. If the
|
9419
|
+
# container handles the `SIGTERM` gracefully and exits within 30 seconds
|
9420
|
+
# from receiving it, no `SIGKILL` is sent.
|
9339
9421
|
#
|
9340
9422
|
# When the service scheduler launches new tasks, it determines task
|
9341
9423
|
# placement in your cluster with the following logic.
|
@@ -9381,7 +9463,7 @@ module Aws::ECS
|
|
9381
9463
|
# * `serviceRegistries`
|
9382
9464
|
#
|
9383
9465
|
# For more information about the role see the `CreateService` request
|
9384
|
-
# parameter [ `role` ][
|
9466
|
+
# parameter [ `role` ][5].
|
9385
9467
|
#
|
9386
9468
|
# </note>
|
9387
9469
|
#
|
@@ -9389,7 +9471,9 @@ module Aws::ECS
|
|
9389
9471
|
#
|
9390
9472
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types
|
9391
9473
|
# [2]: https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html
|
9392
|
-
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/
|
9474
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html
|
9475
|
+
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
9476
|
+
# [5]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role
|
9393
9477
|
#
|
9394
9478
|
# @option params [String] :cluster
|
9395
9479
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
@@ -9424,22 +9508,29 @@ module Aws::ECS
|
|
9424
9508
|
# A capacity provider strategy consists of one or more capacity
|
9425
9509
|
# providers along with the `base` and `weight` to assign to them. A
|
9426
9510
|
# 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
|
9511
|
+
# capacity provider strategy. The [PutClusterCapacityProviders][1] API
|
9512
|
+
# is used to associate a capacity provider with a cluster. Only capacity
|
9429
9513
|
# providers with an `ACTIVE` or `UPDATING` status can be used.
|
9430
9514
|
#
|
9431
9515
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
9432
9516
|
# capacity provider must already be created. New capacity providers can
|
9433
|
-
# be created with the
|
9517
|
+
# be created with the [CreateClusterCapacityProvider][2] API operation.
|
9434
9518
|
#
|
9435
9519
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
9436
9520
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
9437
9521
|
# available to all accounts and only need to be associated with a
|
9438
9522
|
# cluster to be used.
|
9439
9523
|
#
|
9440
|
-
# The PutClusterCapacityProviders
|
9441
|
-
# list of available capacity providers for a cluster after the
|
9442
|
-
# is created.
|
9524
|
+
# The [PutClusterCapacityProviders][1]API operation is used to update
|
9525
|
+
# the list of available capacity providers for a cluster after the
|
9526
|
+
# cluster is created.
|
9527
|
+
#
|
9528
|
+
#
|
9529
|
+
#
|
9530
|
+
#
|
9531
|
+
#
|
9532
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
9533
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html
|
9443
9534
|
#
|
9444
9535
|
# @option params [Types::DeploymentConfiguration] :deployment_configuration
|
9445
9536
|
# Optional deployment parameters that control how many tasks run during
|
@@ -10331,7 +10422,7 @@ module Aws::ECS
|
|
10331
10422
|
params: params,
|
10332
10423
|
config: config)
|
10333
10424
|
context[:gem_name] = 'aws-sdk-ecs'
|
10334
|
-
context[:gem_version] = '1.
|
10425
|
+
context[:gem_version] = '1.154.0'
|
10335
10426
|
Seahorse::Client::Request.new(handlers, context)
|
10336
10427
|
end
|
10337
10428
|
|