aws-sdk-ecs 1.152.0 → 1.161.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +45 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ecs/client.rb +258 -143
- data/lib/aws-sdk-ecs/client_api.rb +11 -0
- data/lib/aws-sdk-ecs/endpoints.rb +56 -224
- data/lib/aws-sdk-ecs/plugins/endpoints.rb +18 -6
- data/lib/aws-sdk-ecs/types.rb +551 -625
- data/lib/aws-sdk-ecs.rb +16 -12
- data/sig/client.rbs +7 -0
- data/sig/resource.rbs +2 -0
- data/sig/types.rbs +8 -0
- metadata +4 -4
data/lib/aws-sdk-ecs/types.rb
CHANGED
@@ -125,8 +125,13 @@ module Aws::ECS
|
|
125
125
|
end
|
126
126
|
|
127
127
|
# You can apply up to 10 custom attributes for each resource. You can
|
128
|
-
# view the attributes of a resource with ListAttributes. You can
|
129
|
-
# existing attributes on a resource with DeleteAttributes.
|
128
|
+
# view the attributes of a resource with [ListAttributes][1]. You can
|
129
|
+
# remove existing attributes on a resource with [DeleteAttributes][2].
|
130
|
+
#
|
131
|
+
#
|
132
|
+
#
|
133
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListAttributes.html
|
134
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteAttributes.html
|
130
135
|
#
|
131
136
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/AttributeLimitExceededException AWS API Documentation
|
132
137
|
#
|
@@ -237,12 +242,12 @@ module Aws::ECS
|
|
237
242
|
|
238
243
|
# An object representing the networking details for a task or service.
|
239
244
|
# For example
|
240
|
-
# `
|
245
|
+
# `awsVpcConfiguration=\{subnets=["subnet-12344321"],securityGroups=["sg-12344321"]\}`.
|
241
246
|
#
|
242
247
|
# @!attribute [rw] subnets
|
243
248
|
# The IDs of the subnets associated with the task or service. There's
|
244
249
|
# a limit of 16 subnets that can be specified per
|
245
|
-
# `
|
250
|
+
# `awsvpcConfiguration`.
|
246
251
|
#
|
247
252
|
# <note markdown="1"> All specified subnets must be from the same VPC.
|
248
253
|
#
|
@@ -253,7 +258,7 @@ module Aws::ECS
|
|
253
258
|
# The IDs of the security groups associated with the task or service.
|
254
259
|
# If you don't specify a security group, the default security group
|
255
260
|
# for the VPC is used. There's a limit of 5 security groups that can
|
256
|
-
# be specified per `
|
261
|
+
# be specified per `awsvpcConfiguration`.
|
257
262
|
#
|
258
263
|
# <note markdown="1"> All specified security groups must be from the same VPC.
|
259
264
|
#
|
@@ -377,19 +382,19 @@ module Aws::ECS
|
|
377
382
|
end
|
378
383
|
|
379
384
|
# The details of a capacity provider strategy. A capacity provider
|
380
|
-
# strategy can be set when using the RunTask
|
381
|
-
# the default capacity provider strategy for a cluster with
|
382
|
-
# CreateCluster API.
|
385
|
+
# strategy can be set when using the [RunTask][1]or [CreateCluster][2]
|
386
|
+
# APIs or as the default capacity provider strategy for a cluster with
|
387
|
+
# the `CreateCluster` API.
|
383
388
|
#
|
384
389
|
# Only capacity providers that are already associated with a cluster and
|
385
390
|
# have an `ACTIVE` or `UPDATING` status can be used in a capacity
|
386
|
-
# provider strategy. The PutClusterCapacityProviders API is used to
|
391
|
+
# provider strategy. The [PutClusterCapacityProviders][3] API is used to
|
387
392
|
# associate a capacity provider with a cluster.
|
388
393
|
#
|
389
394
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
390
395
|
# capacity provider must already be created. New Auto Scaling group
|
391
|
-
# capacity providers can be created with the
|
392
|
-
# operation.
|
396
|
+
# capacity providers can be created with the
|
397
|
+
# [CreateClusterCapacityProvider][4] API operation.
|
393
398
|
#
|
394
399
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
395
400
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
@@ -406,6 +411,13 @@ module Aws::ECS
|
|
406
411
|
# A capacity provider strategy may contain a maximum of 6 capacity
|
407
412
|
# providers.
|
408
413
|
#
|
414
|
+
#
|
415
|
+
#
|
416
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html
|
417
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html
|
418
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
419
|
+
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html
|
420
|
+
#
|
409
421
|
# @!attribute [rw] capacity_provider
|
410
422
|
# The short name of the capacity provider.
|
411
423
|
# @return [String]
|
@@ -456,6 +468,19 @@ module Aws::ECS
|
|
456
468
|
# have permissions to use the action or resource. Or, it might be
|
457
469
|
# specifying an identifier that isn't valid.
|
458
470
|
#
|
471
|
+
# The following list includes additional causes for the error:
|
472
|
+
#
|
473
|
+
# * The `RunTask` could not be processed because you use managed scaling
|
474
|
+
# and there is a capacity error because the quota of tasks in the
|
475
|
+
# `PROVISIONING` per cluster has been reached. For information about
|
476
|
+
# the service quotas, see [Amazon ECS service quotas][1].
|
477
|
+
#
|
478
|
+
# ^
|
479
|
+
#
|
480
|
+
#
|
481
|
+
#
|
482
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html
|
483
|
+
#
|
459
484
|
# @!attribute [rw] message
|
460
485
|
# Message that describes the cause of the exception.
|
461
486
|
# @return [String]
|
@@ -540,7 +565,11 @@ module Aws::ECS
|
|
540
565
|
#
|
541
566
|
# @!attribute [rw] active_services_count
|
542
567
|
# The number of services that are running on the cluster in an
|
543
|
-
# `ACTIVE` state. You can view these services with
|
568
|
+
# `ACTIVE` state. You can view these services with [PListServices][1].
|
569
|
+
#
|
570
|
+
#
|
571
|
+
#
|
572
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html
|
544
573
|
# @return [Integer]
|
545
574
|
#
|
546
575
|
# @!attribute [rw] statistics
|
@@ -702,7 +731,11 @@ module Aws::ECS
|
|
702
731
|
|
703
732
|
# You can't delete a cluster that has registered container instances.
|
704
733
|
# First, deregister the container instances before you can delete the
|
705
|
-
# cluster. For more information, see DeregisterContainerInstance.
|
734
|
+
# cluster. For more information, see [DeregisterContainerInstance][1].
|
735
|
+
#
|
736
|
+
#
|
737
|
+
#
|
738
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterContainerInstance.html
|
706
739
|
#
|
707
740
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ClusterContainsContainerInstancesException AWS API Documentation
|
708
741
|
#
|
@@ -710,7 +743,13 @@ module Aws::ECS
|
|
710
743
|
|
711
744
|
# You can't delete a cluster that contains services. First, update the
|
712
745
|
# service to reduce its desired task count to 0, and then delete the
|
713
|
-
# service. For more information, see UpdateService and
|
746
|
+
# service. For more information, see [UpdateService][1] and
|
747
|
+
# [DeleteService][2].
|
748
|
+
#
|
749
|
+
#
|
750
|
+
#
|
751
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
752
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteService.html
|
714
753
|
#
|
715
754
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ClusterContainsServicesException AWS API Documentation
|
716
755
|
#
|
@@ -723,7 +762,12 @@ module Aws::ECS
|
|
723
762
|
class ClusterContainsTasksException < Aws::EmptyStructure; end
|
724
763
|
|
725
764
|
# The specified cluster wasn't found. You can view your available
|
726
|
-
# clusters with ListClusters. Amazon ECS clusters are Region
|
765
|
+
# clusters with [ListClusters][1]. Amazon ECS clusters are Region
|
766
|
+
# specific.
|
767
|
+
#
|
768
|
+
#
|
769
|
+
#
|
770
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html
|
727
771
|
#
|
728
772
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ClusterNotFoundException AWS API Documentation
|
729
773
|
#
|
@@ -991,14 +1035,8 @@ module Aws::ECS
|
|
991
1035
|
# entered in the `links` of another container to connect the
|
992
1036
|
# containers. Up to 255 letters (uppercase and lowercase), numbers,
|
993
1037
|
# underscores, and hyphens are allowed. This parameter maps to `name`
|
994
|
-
# in the
|
995
|
-
#
|
996
|
-
#
|
997
|
-
#
|
998
|
-
#
|
999
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1000
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1001
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1038
|
+
# in the docker container create command and the `--name` option to
|
1039
|
+
# docker run.
|
1002
1040
|
# @return [String]
|
1003
1041
|
#
|
1004
1042
|
# @!attribute [rw] image
|
@@ -1008,9 +1046,8 @@ module Aws::ECS
|
|
1008
1046
|
# repository-url/image:tag ` or ` repository-url/image@digest `. Up to
|
1009
1047
|
# 255 letters (uppercase and lowercase), numbers, hyphens,
|
1010
1048
|
# underscores, colons, periods, forward slashes, and number signs are
|
1011
|
-
# allowed. This parameter maps to `Image` in the
|
1012
|
-
#
|
1013
|
-
# parameter of [docker run][3].
|
1049
|
+
# allowed. This parameter maps to `Image` in the docker container
|
1050
|
+
# create command and the `IMAGE` parameter of docker run.
|
1014
1051
|
#
|
1015
1052
|
# * When a new task starts, the Amazon ECS container agent pulls the
|
1016
1053
|
# latest version of the specified image and tag for the container to
|
@@ -1032,12 +1069,6 @@ module Aws::ECS
|
|
1032
1069
|
#
|
1033
1070
|
# * Images in other online repositories are qualified further by a
|
1034
1071
|
# domain name (for example, `quay.io/assemblyline/ubuntu`).
|
1035
|
-
#
|
1036
|
-
#
|
1037
|
-
#
|
1038
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1039
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1040
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1041
1072
|
# @return [String]
|
1042
1073
|
#
|
1043
1074
|
# @!attribute [rw] repository_credentials
|
@@ -1046,9 +1077,8 @@ module Aws::ECS
|
|
1046
1077
|
#
|
1047
1078
|
# @!attribute [rw] cpu
|
1048
1079
|
# The number of `cpu` units reserved for the container. This parameter
|
1049
|
-
# maps to `CpuShares` in the
|
1050
|
-
#
|
1051
|
-
# run][3].
|
1080
|
+
# maps to `CpuShares` in the docker container create commandand the
|
1081
|
+
# `--cpu-shares` option to docker run.
|
1052
1082
|
#
|
1053
1083
|
# This field is optional for tasks using the Fargate launch type, and
|
1054
1084
|
# the only requirement is that the total amount of CPU reserved for
|
@@ -1057,7 +1087,7 @@ module Aws::ECS
|
|
1057
1087
|
#
|
1058
1088
|
# <note markdown="1"> You can determine the number of CPU units that are available per EC2
|
1059
1089
|
# instance type by multiplying the vCPUs listed for that instance type
|
1060
|
-
# on the [Amazon EC2 Instances][
|
1090
|
+
# on the [Amazon EC2 Instances][1] detail page by 1,024.
|
1061
1091
|
#
|
1062
1092
|
# </note>
|
1063
1093
|
#
|
@@ -1076,13 +1106,13 @@ module Aws::ECS
|
|
1076
1106
|
#
|
1077
1107
|
# On Linux container instances, the Docker daemon on the container
|
1078
1108
|
# instance uses the CPU value to calculate the relative CPU share
|
1079
|
-
# ratios for running containers.
|
1080
|
-
#
|
1081
|
-
#
|
1082
|
-
# parameter isn't required, and you can use CPU values below 2
|
1083
|
-
# your container definitions. For CPU values below 2
|
1084
|
-
# the behavior varies based on your
|
1085
|
-
# version:
|
1109
|
+
# ratios for running containers. The minimum valid CPU share value
|
1110
|
+
# that the Linux kernel allows is 2, and the maximum valid CPU share
|
1111
|
+
# value that the Linux kernel allows is 262144. However, the CPU
|
1112
|
+
# parameter isn't required, and you can use CPU values below 2 or
|
1113
|
+
# above 262144 in your container definitions. For CPU values below 2
|
1114
|
+
# (including null) or above 262144, the behavior varies based on your
|
1115
|
+
# Amazon ECS container agent version:
|
1086
1116
|
#
|
1087
1117
|
# * **Agent versions less than or equal to 1.1.0:** Null and zero CPU
|
1088
1118
|
# values are passed to Docker as 0, which Docker then converts to
|
@@ -1092,6 +1122,10 @@ module Aws::ECS
|
|
1092
1122
|
# * **Agent versions greater than or equal to 1.2.0:** Null, zero, and
|
1093
1123
|
# CPU values of 1 are passed to Docker as 2.
|
1094
1124
|
#
|
1125
|
+
# * **Agent versions greater than or equal to 1.84.0:** CPU values
|
1126
|
+
# greater than 256 vCPU are passed to Docker as 256, which is
|
1127
|
+
# equivalent to 262144 CPU shares.
|
1128
|
+
#
|
1095
1129
|
# On Windows container instances, the CPU limit is enforced as an
|
1096
1130
|
# absolute limit, or a quota. Windows containers only have access to
|
1097
1131
|
# the specified amount of CPU that's described in the task
|
@@ -1100,11 +1134,7 @@ module Aws::ECS
|
|
1100
1134
|
#
|
1101
1135
|
#
|
1102
1136
|
#
|
1103
|
-
# [1]:
|
1104
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1105
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1106
|
-
# [4]: http://aws.amazon.com/ec2/instance-types/
|
1107
|
-
# [5]: https://docs.docker.com/engine/reference/run/#cpu-share-constraint
|
1137
|
+
# [1]: http://aws.amazon.com/ec2/instance-types/
|
1108
1138
|
# @return [Integer]
|
1109
1139
|
#
|
1110
1140
|
# @!attribute [rw] memory
|
@@ -1112,9 +1142,8 @@ module Aws::ECS
|
|
1112
1142
|
# container attempts to exceed the memory specified here, the
|
1113
1143
|
# container is killed. The total amount of memory reserved for all
|
1114
1144
|
# containers within a task must be lower than the task `memory` value,
|
1115
|
-
# if one is specified. This parameter maps to `Memory` in the
|
1116
|
-
#
|
1117
|
-
# `--memory` option to [docker run][3].
|
1145
|
+
# if one is specified. This parameter maps to `Memory` in the docker
|
1146
|
+
# container create command and the `--memory` option to docker run.
|
1118
1147
|
#
|
1119
1148
|
# If using the Fargate launch type, this parameter is optional.
|
1120
1149
|
#
|
@@ -1133,12 +1162,6 @@ module Aws::ECS
|
|
1133
1162
|
# The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB
|
1134
1163
|
# of memory for a container. So, don't specify less than 4 MiB of
|
1135
1164
|
# memory for your containers.
|
1136
|
-
#
|
1137
|
-
#
|
1138
|
-
#
|
1139
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1140
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1141
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1142
1165
|
# @return [Integer]
|
1143
1166
|
#
|
1144
1167
|
# @!attribute [rw] memory_reservation
|
@@ -1148,9 +1171,8 @@ module Aws::ECS
|
|
1148
1171
|
# consume more memory when it needs to, up to either the hard limit
|
1149
1172
|
# specified with the `memory` parameter (if applicable), or all of the
|
1150
1173
|
# available memory on the container instance, whichever comes first.
|
1151
|
-
# This parameter maps to `MemoryReservation` in the
|
1152
|
-
#
|
1153
|
-
# `--memory-reservation` option to [docker run][3].
|
1174
|
+
# This parameter maps to `MemoryReservation` in the docker container
|
1175
|
+
# create command and the `--memory-reservation` option to docker run.
|
1154
1176
|
#
|
1155
1177
|
# If a task-level memory value is not specified, you must specify a
|
1156
1178
|
# non-zero integer for one or both of `memory` or `memoryReservation`
|
@@ -1175,12 +1197,6 @@ module Aws::ECS
|
|
1175
1197
|
# The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB
|
1176
1198
|
# of memory for a container. So, don't specify less than 4 MiB of
|
1177
1199
|
# memory for your containers.
|
1178
|
-
#
|
1179
|
-
#
|
1180
|
-
#
|
1181
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1182
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1183
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1184
1200
|
# @return [Integer]
|
1185
1201
|
#
|
1186
1202
|
# @!attribute [rw] links
|
@@ -1189,11 +1205,9 @@ module Aws::ECS
|
|
1189
1205
|
# supported if the network mode of a task definition is `bridge`. The
|
1190
1206
|
# `name:internalName` construct is analogous to `name:alias` in Docker
|
1191
1207
|
# links. Up to 255 letters (uppercase and lowercase), numbers,
|
1192
|
-
# underscores, and hyphens are allowed
|
1193
|
-
#
|
1194
|
-
#
|
1195
|
-
# a container][2] section of the [Docker Remote API][3] and the
|
1196
|
-
# `--link` option to [docker run][4].
|
1208
|
+
# underscores, and hyphens are allowed.. This parameter maps to
|
1209
|
+
# `Links` in the docker container create command and the `--link`
|
1210
|
+
# option to docker run.
|
1197
1211
|
#
|
1198
1212
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
1199
1213
|
#
|
@@ -1203,13 +1217,6 @@ module Aws::ECS
|
|
1203
1217
|
# able to communicate with each other without requiring links or host
|
1204
1218
|
# port mappings. Network isolation is achieved on the container
|
1205
1219
|
# instance using security groups and VPC settings.
|
1206
|
-
#
|
1207
|
-
#
|
1208
|
-
#
|
1209
|
-
# [1]: https://docs.docker.com/network/links/
|
1210
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1211
|
-
# [3]: https://docs.docker.com/engine/api/v1.35/
|
1212
|
-
# [4]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1213
1220
|
# @return [Array<String>]
|
1214
1221
|
#
|
1215
1222
|
# @!attribute [rw] port_mappings
|
@@ -1226,27 +1233,24 @@ module Aws::ECS
|
|
1226
1233
|
# so you can't access a container's mapped port from the host
|
1227
1234
|
# itself.
|
1228
1235
|
#
|
1229
|
-
# This parameter maps to `PortBindings` in the
|
1230
|
-
#
|
1231
|
-
#
|
1232
|
-
#
|
1233
|
-
#
|
1234
|
-
#
|
1235
|
-
# mapping.
|
1236
|
+
# This parameter maps to `PortBindings` in the the docker container
|
1237
|
+
# create command and the `--publish` option to docker run. If the
|
1238
|
+
# network mode of a task definition is set to `none`, then you can't
|
1239
|
+
# specify port mappings. If the network mode of a task definition is
|
1240
|
+
# set to `host`, then host ports must either be undefined or they must
|
1241
|
+
# match the container port in the port mapping.
|
1236
1242
|
#
|
1237
1243
|
# <note markdown="1"> After a task reaches the `RUNNING` status, manual and automatic host
|
1238
1244
|
# and container port assignments are visible in the **Network
|
1239
1245
|
# Bindings** section of a container description for a selected task in
|
1240
1246
|
# the Amazon ECS console. The assignments are also visible in the
|
1241
|
-
# `networkBindings` section DescribeTasks responses.
|
1247
|
+
# `networkBindings` section [DescribeTasks][1] responses.
|
1242
1248
|
#
|
1243
1249
|
# </note>
|
1244
1250
|
#
|
1245
1251
|
#
|
1246
1252
|
#
|
1247
|
-
# [1]: https://docs.
|
1248
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1249
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1253
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html
|
1250
1254
|
# @return [Array<Types::PortMapping>]
|
1251
1255
|
#
|
1252
1256
|
# @!attribute [rw] essential
|
@@ -1269,6 +1273,18 @@ module Aws::ECS
|
|
1269
1273
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html
|
1270
1274
|
# @return [Boolean]
|
1271
1275
|
#
|
1276
|
+
# @!attribute [rw] restart_policy
|
1277
|
+
# The restart policy for a container. When you set up a restart
|
1278
|
+
# policy, Amazon ECS can restart the container without needing to
|
1279
|
+
# replace the task. For more information, see [Restart individual
|
1280
|
+
# containers in Amazon ECS tasks with container restart policies][1]
|
1281
|
+
# in the *Amazon Elastic Container Service Developer Guide*.
|
1282
|
+
#
|
1283
|
+
#
|
1284
|
+
#
|
1285
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-restart-policy.html
|
1286
|
+
# @return [Types::ContainerRestartPolicy]
|
1287
|
+
#
|
1272
1288
|
# @!attribute [rw] entry_point
|
1273
1289
|
# Early versions of the Amazon ECS container agent don't properly
|
1274
1290
|
# handle `entryPoint` parameters. If you have problems using
|
@@ -1276,62 +1292,35 @@ module Aws::ECS
|
|
1276
1292
|
# arguments as `command` array items instead.
|
1277
1293
|
#
|
1278
1294
|
# The entry point that's passed to the container. This parameter maps
|
1279
|
-
# to `Entrypoint` in the
|
1280
|
-
#
|
1281
|
-
# run][3]. For more information, see
|
1282
|
-
# [https://docs.docker.com/engine/reference/builder/#entrypoint][4].
|
1283
|
-
#
|
1284
|
-
#
|
1285
|
-
#
|
1286
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1287
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1288
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1289
|
-
# [4]: https://docs.docker.com/engine/reference/builder/#entrypoint
|
1295
|
+
# to `Entrypoint` in the docker container create command and the
|
1296
|
+
# `--entrypoint` option to docker run.
|
1290
1297
|
# @return [Array<String>]
|
1291
1298
|
#
|
1292
1299
|
# @!attribute [rw] command
|
1293
1300
|
# The command that's passed to the container. This parameter maps to
|
1294
|
-
# `Cmd` in the
|
1295
|
-
#
|
1296
|
-
#
|
1297
|
-
# [https://docs.docker.com/engine/reference/builder/#cmd][4]. If there
|
1298
|
-
# are multiple arguments, each argument is a separated string in the
|
1299
|
-
# array.
|
1300
|
-
#
|
1301
|
-
#
|
1302
|
-
#
|
1303
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1304
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1305
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1306
|
-
# [4]: https://docs.docker.com/engine/reference/builder/#cmd
|
1301
|
+
# `Cmd` in the docker container create command and the `COMMAND`
|
1302
|
+
# parameter to docker run. If there are multiple arguments, each
|
1303
|
+
# argument is a separated string in the array.
|
1307
1304
|
# @return [Array<String>]
|
1308
1305
|
#
|
1309
1306
|
# @!attribute [rw] environment
|
1310
1307
|
# The environment variables to pass to a container. This parameter
|
1311
|
-
# maps to `Env` in the
|
1312
|
-
#
|
1308
|
+
# maps to `Env` in the docker container create command and the `--env`
|
1309
|
+
# option to docker run.
|
1313
1310
|
#
|
1314
1311
|
# We don't recommend that you use plaintext environment variables for
|
1315
1312
|
# sensitive information, such as credential data.
|
1316
|
-
#
|
1317
|
-
#
|
1318
|
-
#
|
1319
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1320
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1321
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1322
1313
|
# @return [Array<Types::KeyValuePair>]
|
1323
1314
|
#
|
1324
1315
|
# @!attribute [rw] environment_files
|
1325
1316
|
# A list of files containing the environment variables to pass to a
|
1326
|
-
# container. This parameter maps to the `--env-file` option to
|
1327
|
-
# run
|
1317
|
+
# container. This parameter maps to the `--env-file` option to docker
|
1318
|
+
# run.
|
1328
1319
|
#
|
1329
1320
|
# You can specify up to ten environment files. The file must have a
|
1330
1321
|
# `.env` file extension. Each line in an environment file contains an
|
1331
1322
|
# environment variable in `VARIABLE=VALUE` format. Lines beginning
|
1332
|
-
# with `#` are treated as comments and are ignored.
|
1333
|
-
# information about the environment variable file syntax, see [Declare
|
1334
|
-
# default environment variables in file][2].
|
1323
|
+
# with `#` are treated as comments and are ignored.
|
1335
1324
|
#
|
1336
1325
|
# If there are environment variables specified using the `environment`
|
1337
1326
|
# parameter in a container definition, they take precedence over the
|
@@ -1339,54 +1328,43 @@ module Aws::ECS
|
|
1339
1328
|
# environment files are specified that contain the same variable,
|
1340
1329
|
# they're processed from the top down. We recommend that you use
|
1341
1330
|
# unique variable names. For more information, see [Specifying
|
1342
|
-
# Environment Variables][
|
1331
|
+
# Environment Variables][1] in the *Amazon Elastic Container Service
|
1343
1332
|
# Developer Guide*.
|
1344
1333
|
#
|
1345
1334
|
#
|
1346
1335
|
#
|
1347
|
-
# [1]: https://docs.
|
1348
|
-
# [2]: https://docs.docker.com/compose/env-file/
|
1349
|
-
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html
|
1336
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html
|
1350
1337
|
# @return [Array<Types::EnvironmentFile>]
|
1351
1338
|
#
|
1352
1339
|
# @!attribute [rw] mount_points
|
1353
1340
|
# The mount points for data volumes in your container.
|
1354
1341
|
#
|
1355
|
-
# This parameter maps to `Volumes` in the
|
1356
|
-
#
|
1357
|
-
# [docker run][3].
|
1342
|
+
# This parameter maps to `Volumes` in the docker container create
|
1343
|
+
# command and the `--volume` option to docker run.
|
1358
1344
|
#
|
1359
1345
|
# Windows containers can mount whole directories on the same drive as
|
1360
1346
|
# `$env:ProgramData`. Windows containers can't mount directories on a
|
1361
1347
|
# different drive, and mount point can't be across drives.
|
1362
|
-
#
|
1363
|
-
#
|
1364
|
-
#
|
1365
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1366
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1367
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1368
1348
|
# @return [Array<Types::MountPoint>]
|
1369
1349
|
#
|
1370
1350
|
# @!attribute [rw] volumes_from
|
1371
1351
|
# Data volumes to mount from another container. This parameter maps to
|
1372
|
-
# `VolumesFrom` in the
|
1373
|
-
#
|
1374
|
-
#
|
1375
|
-
#
|
1376
|
-
#
|
1377
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1378
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1379
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1352
|
+
# `VolumesFrom` in the docker container create command and the
|
1353
|
+
# `--volumes-from` option to docker run.
|
1380
1354
|
# @return [Array<Types::VolumeFrom>]
|
1381
1355
|
#
|
1382
1356
|
# @!attribute [rw] linux_parameters
|
1383
1357
|
# Linux-specific modifications that are applied to the container, such
|
1384
1358
|
# as Linux kernel capabilities. For more information see
|
1385
|
-
# KernelCapabilities.
|
1359
|
+
# [KernelCapabilities][1].
|
1386
1360
|
#
|
1387
1361
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
1388
1362
|
#
|
1389
1363
|
# </note>
|
1364
|
+
#
|
1365
|
+
#
|
1366
|
+
#
|
1367
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html
|
1390
1368
|
# @return [Types::LinuxParameters]
|
1391
1369
|
#
|
1392
1370
|
# @!attribute [rw] secrets
|
@@ -1469,7 +1447,7 @@ module Aws::ECS
|
|
1469
1447
|
# [Amazon ECS-optimized Linux AMI][2] in the *Amazon Elastic Container
|
1470
1448
|
# Service Developer Guide*.
|
1471
1449
|
#
|
1472
|
-
# The valid values are 2-120 seconds.
|
1450
|
+
# The valid values for Fargate are 2-120 seconds.
|
1473
1451
|
#
|
1474
1452
|
#
|
1475
1453
|
#
|
@@ -1488,8 +1466,9 @@ module Aws::ECS
|
|
1488
1466
|
#
|
1489
1467
|
# * Windows platform version `1.0.0` or later.
|
1490
1468
|
#
|
1491
|
-
#
|
1492
|
-
#
|
1469
|
+
# For tasks that use the Fargate launch type, the max stop timeout
|
1470
|
+
# value is 120 seconds and if the parameter is not specified, the
|
1471
|
+
# default value of 30 seconds is used.
|
1493
1472
|
#
|
1494
1473
|
# For tasks that use the EC2 launch type, if the `stopTimeout`
|
1495
1474
|
# parameter isn't specified, the value set for the Amazon ECS
|
@@ -1511,7 +1490,7 @@ module Aws::ECS
|
|
1511
1490
|
# ECS-optimized Linux AMI][2] in the *Amazon Elastic Container Service
|
1512
1491
|
# Developer Guide*.
|
1513
1492
|
#
|
1514
|
-
# The valid values are 2-120 seconds.
|
1493
|
+
# The valid values for Fargate are 2-120 seconds.
|
1515
1494
|
#
|
1516
1495
|
#
|
1517
1496
|
#
|
@@ -1521,25 +1500,19 @@ module Aws::ECS
|
|
1521
1500
|
#
|
1522
1501
|
# @!attribute [rw] hostname
|
1523
1502
|
# The hostname to use for your container. This parameter maps to
|
1524
|
-
# `Hostname` in the
|
1525
|
-
#
|
1503
|
+
# `Hostname` in the docker container create command and the
|
1504
|
+
# `--hostname` option to docker run.
|
1526
1505
|
#
|
1527
1506
|
# <note markdown="1"> The `hostname` parameter is not supported if you're using the
|
1528
1507
|
# `awsvpc` network mode.
|
1529
1508
|
#
|
1530
1509
|
# </note>
|
1531
|
-
#
|
1532
|
-
#
|
1533
|
-
#
|
1534
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1535
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1536
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1537
1510
|
# @return [String]
|
1538
1511
|
#
|
1539
1512
|
# @!attribute [rw] user
|
1540
1513
|
# The user to use inside the container. This parameter maps to `User`
|
1541
|
-
# in the
|
1542
|
-
#
|
1514
|
+
# in the docker container create command and the `--user` option to
|
1515
|
+
# docker run.
|
1543
1516
|
#
|
1544
1517
|
# When running tasks using the `host` network mode, don't run
|
1545
1518
|
# containers using the root user (UID 0). We recommend using a
|
@@ -1563,135 +1536,83 @@ module Aws::ECS
|
|
1563
1536
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
1564
1537
|
#
|
1565
1538
|
# </note>
|
1566
|
-
#
|
1567
|
-
#
|
1568
|
-
#
|
1569
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1570
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1571
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1572
1539
|
# @return [String]
|
1573
1540
|
#
|
1574
1541
|
# @!attribute [rw] working_directory
|
1575
1542
|
# The working directory to run commands inside the container in. This
|
1576
|
-
# parameter maps to `WorkingDir` in the
|
1577
|
-
#
|
1578
|
-
# [docker run][3].
|
1579
|
-
#
|
1580
|
-
#
|
1581
|
-
#
|
1582
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1583
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1584
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1543
|
+
# parameter maps to `WorkingDir` in the docker container create
|
1544
|
+
# command and the `--workdir` option to docker run.
|
1585
1545
|
# @return [String]
|
1586
1546
|
#
|
1587
1547
|
# @!attribute [rw] disable_networking
|
1588
1548
|
# When this parameter is true, networking is off within the container.
|
1589
|
-
# This parameter maps to `NetworkDisabled` in the
|
1590
|
-
#
|
1549
|
+
# This parameter maps to `NetworkDisabled` in the docker container
|
1550
|
+
# create command.
|
1591
1551
|
#
|
1592
1552
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
1593
1553
|
#
|
1594
1554
|
# </note>
|
1595
|
-
#
|
1596
|
-
#
|
1597
|
-
#
|
1598
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1599
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1600
1555
|
# @return [Boolean]
|
1601
1556
|
#
|
1602
1557
|
# @!attribute [rw] privileged
|
1603
1558
|
# When this parameter is true, the container is given elevated
|
1604
1559
|
# privileges on the host container instance (similar to the `root`
|
1605
|
-
# user). This parameter maps to `Privileged` in the
|
1606
|
-
#
|
1607
|
-
# `--privileged` option to [docker run][3].
|
1560
|
+
# user). This parameter maps to `Privileged` in the docker container
|
1561
|
+
# create command and the `--privileged` option to docker run
|
1608
1562
|
#
|
1609
1563
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
1610
1564
|
# on Fargate.
|
1611
1565
|
#
|
1612
1566
|
# </note>
|
1613
|
-
#
|
1614
|
-
#
|
1615
|
-
#
|
1616
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1617
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1618
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1619
1567
|
# @return [Boolean]
|
1620
1568
|
#
|
1621
1569
|
# @!attribute [rw] readonly_root_filesystem
|
1622
1570
|
# When this parameter is true, the container is given read-only access
|
1623
1571
|
# to its root file system. This parameter maps to `ReadonlyRootfs` in
|
1624
|
-
# the
|
1625
|
-
#
|
1572
|
+
# the docker container create command and the `--read-only` option to
|
1573
|
+
# docker run.
|
1626
1574
|
#
|
1627
1575
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
1628
1576
|
#
|
1629
1577
|
# </note>
|
1630
|
-
#
|
1631
|
-
#
|
1632
|
-
#
|
1633
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1634
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1635
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1636
1578
|
# @return [Boolean]
|
1637
1579
|
#
|
1638
1580
|
# @!attribute [rw] dns_servers
|
1639
1581
|
# A list of DNS servers that are presented to the container. This
|
1640
|
-
# parameter maps to `Dns` in the
|
1641
|
-
# the
|
1642
|
-
# run][3].
|
1582
|
+
# parameter maps to `Dns` in the docker container create command and
|
1583
|
+
# the `--dns` option to docker run.
|
1643
1584
|
#
|
1644
1585
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
1645
1586
|
#
|
1646
1587
|
# </note>
|
1647
|
-
#
|
1648
|
-
#
|
1649
|
-
#
|
1650
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1651
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1652
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1653
1588
|
# @return [Array<String>]
|
1654
1589
|
#
|
1655
1590
|
# @!attribute [rw] dns_search_domains
|
1656
1591
|
# A list of DNS search domains that are presented to the container.
|
1657
|
-
# This parameter maps to `DnsSearch` in the
|
1658
|
-
#
|
1659
|
-
# to [docker run][3].
|
1592
|
+
# This parameter maps to `DnsSearch` in the docker container create
|
1593
|
+
# command and the `--dns-search` option to docker run.
|
1660
1594
|
#
|
1661
1595
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
1662
1596
|
#
|
1663
1597
|
# </note>
|
1664
|
-
#
|
1665
|
-
#
|
1666
|
-
#
|
1667
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1668
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1669
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1670
1598
|
# @return [Array<String>]
|
1671
1599
|
#
|
1672
1600
|
# @!attribute [rw] extra_hosts
|
1673
1601
|
# A list of hostnames and IP address mappings to append to the
|
1674
1602
|
# `/etc/hosts` file on the container. This parameter maps to
|
1675
|
-
# `ExtraHosts` in the
|
1676
|
-
#
|
1603
|
+
# `ExtraHosts` in the docker container create command and the
|
1604
|
+
# `--add-host` option to docker run.
|
1677
1605
|
#
|
1678
1606
|
# <note markdown="1"> This parameter isn't supported for Windows containers or tasks that
|
1679
1607
|
# use the `awsvpc` network mode.
|
1680
1608
|
#
|
1681
1609
|
# </note>
|
1682
|
-
#
|
1683
|
-
#
|
1684
|
-
#
|
1685
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1686
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1687
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1688
1610
|
# @return [Array<Types::HostEntry>]
|
1689
1611
|
#
|
1690
1612
|
# @!attribute [rw] docker_security_options
|
1691
1613
|
# A list of strings to provide custom configuration for multiple
|
1692
|
-
# security systems.
|
1693
|
-
#
|
1694
|
-
# containers in tasks using the Fargate launch type.
|
1614
|
+
# security systems. This field isn't valid for containers in tasks
|
1615
|
+
# using the Fargate launch type.
|
1695
1616
|
#
|
1696
1617
|
# For Linux tasks on EC2, this parameter can be used to reference
|
1697
1618
|
# custom labels for SELinux and AppArmor multi-level security systems.
|
@@ -1699,95 +1620,67 @@ module Aws::ECS
|
|
1699
1620
|
# For any tasks on EC2, this parameter can be used to reference a
|
1700
1621
|
# credential spec file that configures a container for Active
|
1701
1622
|
# Directory authentication. For more information, see [Using gMSAs for
|
1702
|
-
# Windows Containers][
|
1623
|
+
# Windows Containers][1] and [Using gMSAs for Linux Containers][2] in
|
1703
1624
|
# the *Amazon Elastic Container Service Developer Guide*.
|
1704
1625
|
#
|
1705
|
-
# This parameter maps to `SecurityOpt` in the
|
1706
|
-
#
|
1707
|
-
# option to [docker run][1].
|
1626
|
+
# This parameter maps to `SecurityOpt` in the docker container create
|
1627
|
+
# command and the `--security-opt` option to docker run.
|
1708
1628
|
#
|
1709
1629
|
# <note markdown="1"> The Amazon ECS container agent running on a container instance must
|
1710
1630
|
# register with the `ECS_SELINUX_CAPABLE=true` or
|
1711
1631
|
# `ECS_APPARMOR_CAPABLE=true` environment variables before containers
|
1712
1632
|
# placed on that instance can use these security options. For more
|
1713
|
-
# information, see [Amazon ECS Container Agent Configuration][
|
1633
|
+
# information, see [Amazon ECS Container Agent Configuration][3] in
|
1714
1634
|
# the *Amazon Elastic Container Service Developer Guide*.
|
1715
1635
|
#
|
1716
1636
|
# </note>
|
1717
1637
|
#
|
1718
|
-
# For more information about valid values, see [Docker Run Security
|
1719
|
-
# Configuration][1].
|
1720
|
-
#
|
1721
1638
|
# Valid values: "no-new-privileges" \| "apparmor:PROFILE" \|
|
1722
1639
|
# "label:value" \| "credentialspec:CredentialSpecFilePath"
|
1723
1640
|
#
|
1724
1641
|
#
|
1725
1642
|
#
|
1726
|
-
# [1]: https://docs.
|
1727
|
-
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
1728
|
-
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
1729
|
-
# [4]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1730
|
-
# [5]: https://docs.docker.com/engine/api/v1.35/
|
1731
|
-
# [6]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html
|
1643
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html
|
1644
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html
|
1645
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html
|
1732
1646
|
# @return [Array<String>]
|
1733
1647
|
#
|
1734
1648
|
# @!attribute [rw] interactive
|
1735
1649
|
# When this parameter is `true`, you can deploy containerized
|
1736
1650
|
# applications that require `stdin` or a `tty` to be allocated. This
|
1737
|
-
# parameter maps to `OpenStdin` in the
|
1738
|
-
#
|
1739
|
-
# [docker run][3].
|
1740
|
-
#
|
1741
|
-
#
|
1742
|
-
#
|
1743
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1744
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1745
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1651
|
+
# parameter maps to `OpenStdin` in the docker container create command
|
1652
|
+
# and the `--interactive` option to docker run.
|
1746
1653
|
# @return [Boolean]
|
1747
1654
|
#
|
1748
1655
|
# @!attribute [rw] pseudo_terminal
|
1749
1656
|
# When this parameter is `true`, a TTY is allocated. This parameter
|
1750
|
-
# maps to `Tty` in the
|
1751
|
-
#
|
1752
|
-
#
|
1753
|
-
#
|
1754
|
-
#
|
1755
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1756
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1757
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1657
|
+
# maps to `Tty` in the docker container create command and the `--tty`
|
1658
|
+
# option to docker run.
|
1758
1659
|
# @return [Boolean]
|
1759
1660
|
#
|
1760
1661
|
# @!attribute [rw] docker_labels
|
1761
1662
|
# A key/value map of labels to add to the container. This parameter
|
1762
|
-
# maps to `Labels` in the
|
1763
|
-
#
|
1764
|
-
#
|
1765
|
-
#
|
1766
|
-
#
|
1767
|
-
#
|
1768
|
-
# --format '\{\{.Server.APIVersion\}\}'`
|
1769
|
-
#
|
1770
|
-
#
|
1771
|
-
#
|
1772
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1773
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1774
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1663
|
+
# maps to `Labels` in the docker container create command and the
|
1664
|
+
# `--label` option to docker run. This parameter requires version 1.18
|
1665
|
+
# of the Docker Remote API or greater on your container instance. To
|
1666
|
+
# check the Docker Remote API version on your container instance, log
|
1667
|
+
# in to your container instance and run the following command: `sudo
|
1668
|
+
# docker version --format '\{\{.Server.APIVersion\}\}'`
|
1775
1669
|
# @return [Hash<String,String>]
|
1776
1670
|
#
|
1777
1671
|
# @!attribute [rw] ulimits
|
1778
1672
|
# A list of `ulimits` to set in the container. If a `ulimit` value is
|
1779
1673
|
# specified in a task definition, it overrides the default values set
|
1780
|
-
# by Docker. This parameter maps to `Ulimits` in the
|
1781
|
-
#
|
1782
|
-
#
|
1783
|
-
# displayed in the Ulimit data type.
|
1674
|
+
# by Docker. This parameter maps to `Ulimits` in the docker container
|
1675
|
+
# create command and the `--ulimit` option to docker run. Valid naming
|
1676
|
+
# values are displayed in the [Ulimit][1] data type.
|
1784
1677
|
#
|
1785
1678
|
# Amazon ECS tasks hosted on Fargate use the default resource limit
|
1786
1679
|
# values set by the operating system with the exception of the
|
1787
1680
|
# `nofile` resource limit parameter which Fargate overrides. The
|
1788
1681
|
# `nofile` resource limit sets a restriction on the number of open
|
1789
|
-
# files that a container can use. The default `nofile` soft limit is
|
1790
|
-
# `
|
1682
|
+
# files that a container can use. The default `nofile` soft limit is `
|
1683
|
+
# 65535` and the default hard limit is `65535`.
|
1791
1684
|
#
|
1792
1685
|
# This parameter requires version 1.18 of the Docker Remote API or
|
1793
1686
|
# greater on your container instance. To check the Docker Remote API
|
@@ -1801,30 +1694,26 @@ module Aws::ECS
|
|
1801
1694
|
#
|
1802
1695
|
#
|
1803
1696
|
#
|
1804
|
-
# [1]: https://docs.
|
1805
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1806
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1697
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html
|
1807
1698
|
# @return [Array<Types::Ulimit>]
|
1808
1699
|
#
|
1809
1700
|
# @!attribute [rw] log_configuration
|
1810
1701
|
# The log configuration specification for the container.
|
1811
1702
|
#
|
1812
|
-
# This parameter maps to `LogConfig` in the
|
1813
|
-
#
|
1814
|
-
#
|
1815
|
-
#
|
1816
|
-
#
|
1817
|
-
#
|
1818
|
-
#
|
1819
|
-
#
|
1820
|
-
#
|
1821
|
-
# options for different supported log drivers, see [Configure logging
|
1822
|
-
# drivers][4] in the Docker documentation.
|
1703
|
+
# This parameter maps to `LogConfig` in the docker container create
|
1704
|
+
# command and the `--log-driver` option to docker run. By default,
|
1705
|
+
# containers use the same logging driver that the Docker daemon uses.
|
1706
|
+
# However the container can use a different logging driver than the
|
1707
|
+
# Docker daemon by specifying a log driver with this parameter in the
|
1708
|
+
# container definition. To use a different logging driver for a
|
1709
|
+
# container, the log system must be configured properly on the
|
1710
|
+
# container instance (or on a different log server for remote logging
|
1711
|
+
# options).
|
1823
1712
|
#
|
1824
1713
|
# <note markdown="1"> Amazon ECS currently supports a subset of the logging drivers
|
1825
|
-
# available to the Docker daemon (shown in the LogConfiguration
|
1826
|
-
# type). Additional log drivers may be available in future
|
1827
|
-
# the Amazon ECS container agent.
|
1714
|
+
# available to the Docker daemon (shown in the [LogConfiguration][1]
|
1715
|
+
# data type). Additional log drivers may be available in future
|
1716
|
+
# releases of the Amazon ECS container agent.
|
1828
1717
|
#
|
1829
1718
|
# </note>
|
1830
1719
|
#
|
@@ -1839,46 +1728,30 @@ module Aws::ECS
|
|
1839
1728
|
# `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before
|
1840
1729
|
# containers placed on that instance can use these log configuration
|
1841
1730
|
# options. For more information, see [Amazon ECS Container Agent
|
1842
|
-
# Configuration][
|
1731
|
+
# Configuration][2] in the *Amazon Elastic Container Service Developer
|
1843
1732
|
# Guide*.
|
1844
1733
|
#
|
1845
1734
|
# </note>
|
1846
1735
|
#
|
1847
1736
|
#
|
1848
1737
|
#
|
1849
|
-
# [1]: https://docs.
|
1850
|
-
# [2]: https://docs.
|
1851
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1852
|
-
# [4]: https://docs.docker.com/engine/admin/logging/overview/
|
1853
|
-
# [5]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html
|
1738
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html
|
1739
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html
|
1854
1740
|
# @return [Types::LogConfiguration]
|
1855
1741
|
#
|
1856
1742
|
# @!attribute [rw] health_check
|
1857
1743
|
# The container health check command and associated configuration
|
1858
1744
|
# parameters for the container. This parameter maps to `HealthCheck`
|
1859
|
-
# in the
|
1860
|
-
#
|
1861
|
-
#
|
1862
|
-
#
|
1863
|
-
#
|
1864
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1865
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1866
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1745
|
+
# in the docker container create command and the `HEALTHCHECK`
|
1746
|
+
# parameter of docker run.
|
1867
1747
|
# @return [Types::HealthCheck]
|
1868
1748
|
#
|
1869
1749
|
# @!attribute [rw] system_controls
|
1870
1750
|
# A list of namespaced kernel parameters to set in the container. This
|
1871
|
-
# parameter maps to `Sysctls` in the
|
1872
|
-
#
|
1873
|
-
#
|
1874
|
-
#
|
1875
|
-
# connections.
|
1876
|
-
#
|
1877
|
-
#
|
1878
|
-
#
|
1879
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
1880
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
1881
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
1751
|
+
# parameter maps to `Sysctls` in the docker container create command
|
1752
|
+
# and the `--sysctl` option to docker run. For example, you can
|
1753
|
+
# configure `net.ipv4.tcp_keepalive_time` setting to maintain longer
|
1754
|
+
# lived connections.
|
1882
1755
|
# @return [Array<Types::SystemControl>]
|
1883
1756
|
#
|
1884
1757
|
# @!attribute [rw] resource_requirements
|
@@ -1955,6 +1828,7 @@ module Aws::ECS
|
|
1955
1828
|
:links,
|
1956
1829
|
:port_mappings,
|
1957
1830
|
:essential,
|
1831
|
+
:restart_policy,
|
1958
1832
|
:entry_point,
|
1959
1833
|
:command,
|
1960
1834
|
:environment,
|
@@ -2185,7 +2059,11 @@ module Aws::ECS
|
|
2185
2059
|
# @!attribute [rw] attributes
|
2186
2060
|
# The attributes set for the container instance, either by the Amazon
|
2187
2061
|
# ECS container agent at instance registration or manually with the
|
2188
|
-
# PutAttributes operation.
|
2062
|
+
# [PutAttributes][1] operation.
|
2063
|
+
#
|
2064
|
+
#
|
2065
|
+
#
|
2066
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAttributes.html
|
2189
2067
|
# @return [Array<Types::Attribute>]
|
2190
2068
|
#
|
2191
2069
|
# @!attribute [rw] registered_at
|
@@ -2357,6 +2235,48 @@ module Aws::ECS
|
|
2357
2235
|
include Aws::Structure
|
2358
2236
|
end
|
2359
2237
|
|
2238
|
+
# You can enable a restart policy for each container defined in your
|
2239
|
+
# task definition, to overcome transient failures faster and maintain
|
2240
|
+
# task availability. When you enable a restart policy for a container,
|
2241
|
+
# Amazon ECS can restart the container if it exits, without needing to
|
2242
|
+
# replace the task. For more information, see [Restart individual
|
2243
|
+
# containers in Amazon ECS tasks with container restart policies][1] in
|
2244
|
+
# the *Amazon Elastic Container Service Developer Guide*.
|
2245
|
+
#
|
2246
|
+
#
|
2247
|
+
#
|
2248
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-restart-policy.html
|
2249
|
+
#
|
2250
|
+
# @!attribute [rw] enabled
|
2251
|
+
# Specifies whether a restart policy is enabled for the container.
|
2252
|
+
# @return [Boolean]
|
2253
|
+
#
|
2254
|
+
# @!attribute [rw] ignored_exit_codes
|
2255
|
+
# A list of exit codes that Amazon ECS will ignore and not attempt a
|
2256
|
+
# restart on. You can specify a maximum of 50 container exit codes. By
|
2257
|
+
# default, Amazon ECS does not ignore any exit codes.
|
2258
|
+
# @return [Array<Integer>]
|
2259
|
+
#
|
2260
|
+
# @!attribute [rw] restart_attempt_period
|
2261
|
+
# A period of time (in seconds) that the container must run for before
|
2262
|
+
# a restart can be attempted. A container can be restarted only once
|
2263
|
+
# every `restartAttemptPeriod` seconds. If a container isn't able to
|
2264
|
+
# run for this time period and exits early, it will not be restarted.
|
2265
|
+
# You can set a minimum `restartAttemptPeriod` of 60 seconds and a
|
2266
|
+
# maximum `restartAttemptPeriod` of 1800 seconds. By default, a
|
2267
|
+
# container must run for 300 seconds before it can be restarted.
|
2268
|
+
# @return [Integer]
|
2269
|
+
#
|
2270
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerRestartPolicy AWS API Documentation
|
2271
|
+
#
|
2272
|
+
class ContainerRestartPolicy < Struct.new(
|
2273
|
+
:enabled,
|
2274
|
+
:ignored_exit_codes,
|
2275
|
+
:restart_attempt_period)
|
2276
|
+
SENSITIVE = []
|
2277
|
+
include Aws::Structure
|
2278
|
+
end
|
2279
|
+
|
2360
2280
|
# An object that represents a change in state for a container.
|
2361
2281
|
#
|
2362
2282
|
# @!attribute [rw] container_name
|
@@ -2508,7 +2428,12 @@ module Aws::ECS
|
|
2508
2428
|
# The setting to use when creating a cluster. This parameter is used
|
2509
2429
|
# to turn on CloudWatch Container Insights for a cluster. If this
|
2510
2430
|
# value is specified, it overrides the `containerInsights` value set
|
2511
|
-
# with PutAccountSetting or PutAccountSettingDefault.
|
2431
|
+
# with [PutAccountSetting][1] or [PutAccountSettingDefault][2].
|
2432
|
+
#
|
2433
|
+
#
|
2434
|
+
#
|
2435
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html
|
2436
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html
|
2512
2437
|
# @return [Array<Types::ClusterSetting>]
|
2513
2438
|
#
|
2514
2439
|
# @!attribute [rw] configuration
|
@@ -2553,12 +2478,13 @@ module Aws::ECS
|
|
2553
2478
|
#
|
2554
2479
|
# If a default capacity provider strategy isn't defined for a cluster
|
2555
2480
|
# when it was created, it can be defined later with the
|
2556
|
-
# PutClusterCapacityProviders API operation.
|
2481
|
+
# [PutClusterCapacityProviders][3] API operation.
|
2557
2482
|
#
|
2558
2483
|
#
|
2559
2484
|
#
|
2560
2485
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html
|
2561
2486
|
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html
|
2487
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
2562
2488
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
2563
2489
|
#
|
2564
2490
|
# @!attribute [rw] service_connect_defaults
|
@@ -3124,9 +3050,10 @@ module Aws::ECS
|
|
3124
3050
|
# A capacity provider strategy consists of one or more capacity
|
3125
3051
|
# providers along with the `base` and `weight` to assign to them. A
|
3126
3052
|
# capacity provider must be associated with the cluster to be used in
|
3127
|
-
# a capacity provider strategy. The PutClusterCapacityProviders
|
3128
|
-
# used to associate a capacity provider with a cluster. Only
|
3129
|
-
# providers with an `ACTIVE` or `UPDATING` status can be
|
3053
|
+
# a capacity provider strategy. The [PutClusterCapacityProviders][1]
|
3054
|
+
# API is used to associate a capacity provider with a cluster. Only
|
3055
|
+
# capacity providers with an `ACTIVE` or `UPDATING` status can be
|
3056
|
+
# used.
|
3130
3057
|
#
|
3131
3058
|
# If a `capacityProviderStrategy` is specified, the `launchType`
|
3132
3059
|
# parameter must be omitted. If no `capacityProviderStrategy` or
|
@@ -3135,17 +3062,22 @@ module Aws::ECS
|
|
3135
3062
|
#
|
3136
3063
|
# If specifying a capacity provider that uses an Auto Scaling group,
|
3137
3064
|
# the capacity provider must already be created. New capacity
|
3138
|
-
# providers can be created with the
|
3139
|
-
# operation.
|
3065
|
+
# providers can be created with the
|
3066
|
+
# [CreateCapacityProviderProvider][2]API operation.
|
3140
3067
|
#
|
3141
3068
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
3142
3069
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
3143
3070
|
# are available to all accounts and only need to be associated with a
|
3144
3071
|
# cluster to be used.
|
3145
3072
|
#
|
3146
|
-
# The PutClusterCapacityProviders API operation is used to update
|
3147
|
-
# list of available capacity providers for a cluster after the
|
3148
|
-
# is created.
|
3073
|
+
# The [PutClusterCapacityProviders][1] API operation is used to update
|
3074
|
+
# the list of available capacity providers for a cluster after the
|
3075
|
+
# cluster is created.
|
3076
|
+
#
|
3077
|
+
#
|
3078
|
+
#
|
3079
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
3080
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProviderProvider.html
|
3149
3081
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
3150
3082
|
#
|
3151
3083
|
# @!attribute [rw] platform_version
|
@@ -3593,7 +3525,11 @@ module Aws::ECS
|
|
3593
3525
|
# state. If the service fails to reach a steady state and circuit
|
3594
3526
|
# breaker is turned on, the deployment transitions to a `FAILED`
|
3595
3527
|
# state. A deployment in `FAILED` state doesn't launch any new tasks.
|
3596
|
-
# For more information, see DeploymentCircuitBreaker.
|
3528
|
+
# For more information, see [DeploymentCircuitBreaker][1].
|
3529
|
+
#
|
3530
|
+
#
|
3531
|
+
#
|
3532
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeploymentCircuitBreaker.html
|
3597
3533
|
# @return [String]
|
3598
3534
|
#
|
3599
3535
|
# @!attribute [rw] rollout_state_reason
|
@@ -3796,13 +3732,22 @@ module Aws::ECS
|
|
3796
3732
|
# using the `REPLICA` service scheduler is 200%.
|
3797
3733
|
#
|
3798
3734
|
# If a service is using either the blue/green (`CODE_DEPLOY`) or
|
3799
|
-
# `EXTERNAL` deployment types and tasks
|
3800
|
-
# the **maximum percent** value is set to the default
|
3801
|
-
#
|
3802
|
-
#
|
3803
|
-
#
|
3804
|
-
#
|
3805
|
-
#
|
3735
|
+
# `EXTERNAL` deployment types, and tasks in the service use the EC2
|
3736
|
+
# launch type, the **maximum percent** value is set to the default
|
3737
|
+
# value. The **maximum percent** value is used to define the upper
|
3738
|
+
# limit on the number of the tasks in the service that remain in the
|
3739
|
+
# `RUNNING` state while the container instances are in the `DRAINING`
|
3740
|
+
# state.
|
3741
|
+
#
|
3742
|
+
# <note markdown="1"> You can't specify a custom `maximumPercent` value for a service
|
3743
|
+
# that uses either the blue/green (`CODE_DEPLOY`) or `EXTERNAL`
|
3744
|
+
# deployment types and has tasks that use the EC2 launch type.
|
3745
|
+
#
|
3746
|
+
# </note>
|
3747
|
+
#
|
3748
|
+
# If the tasks in the service use the Fargate launch type, the maximum
|
3749
|
+
# percent value is not used, although it is returned when describing
|
3750
|
+
# your service.
|
3806
3751
|
# @return [Integer]
|
3807
3752
|
#
|
3808
3753
|
# @!attribute [rw] minimum_healthy_percent
|
@@ -3863,13 +3808,22 @@ module Aws::ECS
|
|
3863
3808
|
# If a service is using either the blue/green (`CODE_DEPLOY`) or
|
3864
3809
|
# `EXTERNAL` deployment types and is running tasks that use the EC2
|
3865
3810
|
# launch type, the **minimum healthy percent** value is set to the
|
3866
|
-
# default value
|
3867
|
-
# the
|
3868
|
-
#
|
3869
|
-
#
|
3870
|
-
#
|
3871
|
-
#
|
3872
|
-
#
|
3811
|
+
# default value. The **minimum healthy percent** value is used to
|
3812
|
+
# define the lower limit on the number of the tasks in the service
|
3813
|
+
# that remain in the `RUNNING` state while the container instances are
|
3814
|
+
# in the `DRAINING` state.
|
3815
|
+
#
|
3816
|
+
# <note markdown="1"> You can't specify a custom `minimumHealthyPercent` value for a
|
3817
|
+
# service that uses either the blue/green (`CODE_DEPLOY`) or
|
3818
|
+
# `EXTERNAL` deployment types and has tasks that use the EC2 launch
|
3819
|
+
# type.
|
3820
|
+
#
|
3821
|
+
# </note>
|
3822
|
+
#
|
3823
|
+
# If a service is using either the blue/green (`CODE_DEPLOY`) or
|
3824
|
+
# `EXTERNAL` deployment types and is running tasks that use the
|
3825
|
+
# Fargate launch type, the minimum healthy percent value is not used,
|
3826
|
+
# although it is returned when describing your service.
|
3873
3827
|
# @return [Integer]
|
3874
3828
|
#
|
3875
3829
|
# @!attribute [rw] alarms
|
@@ -3907,7 +3861,8 @@ module Aws::ECS
|
|
3907
3861
|
# The number of containers Amazon ECS adds or removes from the
|
3908
3862
|
# service during a rolling update is controlled by adjusting the
|
3909
3863
|
# minimum and maximum number of healthy tasks allowed during a
|
3910
|
-
# service deployment, as specified in the
|
3864
|
+
# service deployment, as specified in the
|
3865
|
+
# [DeploymentConfiguration][1].
|
3911
3866
|
#
|
3912
3867
|
# CODE\_DEPLOY
|
3913
3868
|
#
|
@@ -3921,6 +3876,10 @@ module Aws::ECS
|
|
3921
3876
|
# : The external (`EXTERNAL`) deployment type enables you to use any
|
3922
3877
|
# third-party deployment controller for full control over the
|
3923
3878
|
# deployment process for an Amazon ECS service.
|
3879
|
+
#
|
3880
|
+
#
|
3881
|
+
#
|
3882
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeploymentConfiguration.html
|
3924
3883
|
# @return [String]
|
3925
3884
|
#
|
3926
3885
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeploymentController AWS API Documentation
|
@@ -4518,43 +4477,21 @@ module Aws::ECS
|
|
4518
4477
|
# placement. If the driver was installed using the Docker plugin CLI,
|
4519
4478
|
# use `docker plugin ls` to retrieve the driver name from your
|
4520
4479
|
# container instance. If the driver was installed using another
|
4521
|
-
# method, use Docker plugin discovery to retrieve the driver name.
|
4522
|
-
#
|
4523
|
-
#
|
4524
|
-
# Remote API][3] and the `xxdriver` option to [docker volume
|
4525
|
-
# create][4].
|
4526
|
-
#
|
4527
|
-
#
|
4528
|
-
#
|
4529
|
-
# [1]: https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery
|
4530
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate
|
4531
|
-
# [3]: https://docs.docker.com/engine/api/v1.35/
|
4532
|
-
# [4]: https://docs.docker.com/engine/reference/commandline/volume_create/
|
4480
|
+
# method, use Docker plugin discovery to retrieve the driver name.
|
4481
|
+
# This parameter maps to `Driver` in the docker container create
|
4482
|
+
# command and the `xxdriver` option to docker volume create.
|
4533
4483
|
# @return [String]
|
4534
4484
|
#
|
4535
4485
|
# @!attribute [rw] driver_opts
|
4536
4486
|
# A map of Docker driver-specific options passed through. This
|
4537
|
-
# parameter maps to `DriverOpts` in the
|
4538
|
-
#
|
4539
|
-
# volume create][3].
|
4540
|
-
#
|
4541
|
-
#
|
4542
|
-
#
|
4543
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate
|
4544
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
4545
|
-
# [3]: https://docs.docker.com/engine/reference/commandline/volume_create/
|
4487
|
+
# parameter maps to `DriverOpts` in the docker create-volume command
|
4488
|
+
# and the `xxopt` option to docker volume create.
|
4546
4489
|
# @return [Hash<String,String>]
|
4547
4490
|
#
|
4548
4491
|
# @!attribute [rw] labels
|
4549
4492
|
# Custom metadata to add to your Docker volume. This parameter maps to
|
4550
|
-
# `Labels` in the
|
4551
|
-
#
|
4552
|
-
#
|
4553
|
-
#
|
4554
|
-
#
|
4555
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate
|
4556
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
4557
|
-
# [3]: https://docs.docker.com/engine/reference/commandline/volume_create/
|
4493
|
+
# `Labels` in the docker container create command and the `xxlabel`
|
4494
|
+
# option to docker volume create.
|
4558
4495
|
# @return [Hash<String,String>]
|
4559
4496
|
#
|
4560
4497
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DockerVolumeConfiguration AWS API Documentation
|
@@ -5151,7 +5088,7 @@ module Aws::ECS
|
|
5151
5088
|
# parameters that are specified in a container definition override any
|
5152
5089
|
# Docker health checks that exist in the container image (such as those
|
5153
5090
|
# specified in a parent image or from the image's Dockerfile). This
|
5154
|
-
# configuration maps to the `HEALTHCHECK` parameter of
|
5091
|
+
# configuration maps to the `HEALTHCHECK` parameter of docker run.
|
5155
5092
|
#
|
5156
5093
|
# <note markdown="1"> The Amazon ECS container agent only monitors and reports on the health
|
5157
5094
|
# checks specified in the task definition. Amazon ECS does not monitor
|
@@ -5250,20 +5187,19 @@ module Aws::ECS
|
|
5250
5187
|
#
|
5251
5188
|
# * Container health checks require version `1.17.0` or greater of the
|
5252
5189
|
# Amazon ECS container agent. For more information, see [Updating the
|
5253
|
-
# Amazon ECS container agent][
|
5190
|
+
# Amazon ECS container agent][1].
|
5254
5191
|
#
|
5255
5192
|
# * Container health checks are supported for Fargate tasks if you're
|
5256
5193
|
# using platform version `1.1.0` or greater. For more information, see
|
5257
|
-
# [Fargate platform versions][
|
5194
|
+
# [Fargate platform versions][2].
|
5258
5195
|
#
|
5259
5196
|
# * Container health checks aren't supported for tasks that are part of
|
5260
5197
|
# a service that's configured to use a Classic Load Balancer.
|
5261
5198
|
#
|
5262
5199
|
#
|
5263
5200
|
#
|
5264
|
-
# [1]: https://docs.
|
5265
|
-
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
5266
|
-
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
5201
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html
|
5202
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
5267
5203
|
#
|
5268
5204
|
# @!attribute [rw] command
|
5269
5205
|
# A string array representing the command that the container runs to
|
@@ -5284,12 +5220,7 @@ module Aws::ECS
|
|
5284
5220
|
#
|
5285
5221
|
# An exit code of 0 indicates success, and non-zero exit code
|
5286
5222
|
# indicates failure. For more information, see `HealthCheck` in the
|
5287
|
-
#
|
5288
|
-
#
|
5289
|
-
#
|
5290
|
-
#
|
5291
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
5292
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
5223
|
+
# docker container create command
|
5293
5224
|
# @return [Array<String>]
|
5294
5225
|
#
|
5295
5226
|
# @!attribute [rw] interval
|
@@ -5337,7 +5268,11 @@ module Aws::ECS
|
|
5337
5268
|
|
5338
5269
|
# Hostnames and IP address entries that are added to the `/etc/hosts`
|
5339
5270
|
# file of a container via the `extraHosts` parameter of its
|
5340
|
-
# ContainerDefinition.
|
5271
|
+
# [ContainerDefinition][1].
|
5272
|
+
#
|
5273
|
+
#
|
5274
|
+
#
|
5275
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html
|
5341
5276
|
#
|
5342
5277
|
# @!attribute [rw] hostname
|
5343
5278
|
# The hostname to use in the `/etc/hosts` entry.
|
@@ -5482,22 +5417,18 @@ module Aws::ECS
|
|
5482
5417
|
|
5483
5418
|
# The Linux capabilities to add or remove from the default Docker
|
5484
5419
|
# configuration for a container defined in the task definition. For more
|
5485
|
-
# information about
|
5486
|
-
#
|
5487
|
-
# capabilities][1] in the *Docker run reference*. For more detailed
|
5488
|
-
# information about these Linux capabilities, see the
|
5489
|
-
# [capabilities(7)][2] Linux manual page.
|
5420
|
+
# detailed information about these Linux capabilities, see the
|
5421
|
+
# [capabilities(7)][1] Linux manual page.
|
5490
5422
|
#
|
5491
5423
|
#
|
5492
5424
|
#
|
5493
|
-
# [1]:
|
5494
|
-
# [2]: http://man7.org/linux/man-pages/man7/capabilities.7.html
|
5425
|
+
# [1]: http://man7.org/linux/man-pages/man7/capabilities.7.html
|
5495
5426
|
#
|
5496
5427
|
# @!attribute [rw] add
|
5497
5428
|
# The Linux capabilities for the container that have been added to the
|
5498
5429
|
# default configuration provided by Docker. This parameter maps to
|
5499
|
-
# `CapAdd` in the
|
5500
|
-
#
|
5430
|
+
# `CapAdd` in the docker container create command and the `--cap-add`
|
5431
|
+
# option to docker run.
|
5501
5432
|
#
|
5502
5433
|
# <note markdown="1"> Tasks launched on Fargate only support adding the `SYS_PTRACE`
|
5503
5434
|
# kernel capability.
|
@@ -5513,19 +5444,13 @@ module Aws::ECS
|
|
5513
5444
|
# "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT"
|
5514
5445
|
# | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" |
|
5515
5446
|
# "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"`
|
5516
|
-
#
|
5517
|
-
#
|
5518
|
-
#
|
5519
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
5520
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
5521
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
5522
5447
|
# @return [Array<String>]
|
5523
5448
|
#
|
5524
5449
|
# @!attribute [rw] drop
|
5525
5450
|
# The Linux capabilities for the container that have been removed from
|
5526
5451
|
# the default configuration provided by Docker. This parameter maps to
|
5527
|
-
# `CapDrop` in the
|
5528
|
-
#
|
5452
|
+
# `CapDrop` in the docker container create command and the
|
5453
|
+
# `--cap-drop` option to docker run.
|
5529
5454
|
#
|
5530
5455
|
# Valid values: `"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" |
|
5531
5456
|
# "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" |
|
@@ -5536,12 +5461,6 @@ module Aws::ECS
|
|
5536
5461
|
# "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT"
|
5537
5462
|
# | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" |
|
5538
5463
|
# "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"`
|
5539
|
-
#
|
5540
|
-
#
|
5541
|
-
#
|
5542
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
5543
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
5544
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
5545
5464
|
# @return [Array<String>]
|
5546
5465
|
#
|
5547
5466
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/KernelCapabilities AWS API Documentation
|
@@ -5600,69 +5519,50 @@ module Aws::ECS
|
|
5600
5519
|
#
|
5601
5520
|
# @!attribute [rw] devices
|
5602
5521
|
# Any host devices to expose to the container. This parameter maps to
|
5603
|
-
# `Devices` in the
|
5604
|
-
#
|
5522
|
+
# `Devices` in the docker container create command and the `--device`
|
5523
|
+
# option to docker run.
|
5605
5524
|
#
|
5606
5525
|
# <note markdown="1"> If you're using tasks that use the Fargate launch type, the
|
5607
5526
|
# `devices` parameter isn't supported.
|
5608
5527
|
#
|
5609
5528
|
# </note>
|
5610
|
-
#
|
5611
|
-
#
|
5612
|
-
#
|
5613
|
-
# [1]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
5614
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
5615
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
5616
5529
|
# @return [Array<Types::Device>]
|
5617
5530
|
#
|
5618
5531
|
# @!attribute [rw] init_process_enabled
|
5619
5532
|
# Run an `init` process inside the container that forwards signals and
|
5620
5533
|
# reaps processes. This parameter maps to the `--init` option to
|
5621
|
-
#
|
5534
|
+
# docker run. This parameter requires version 1.25 of the Docker
|
5622
5535
|
# Remote API or greater on your container instance. To check the
|
5623
5536
|
# Docker Remote API version on your container instance, log in to your
|
5624
5537
|
# container instance and run the following command: `sudo docker
|
5625
5538
|
# version --format '\{\{.Server.APIVersion\}\}'`
|
5626
|
-
#
|
5627
|
-
#
|
5628
|
-
#
|
5629
|
-
# [1]: https://docs.docker.com/engine/reference/run/#security-configuration
|
5630
5539
|
# @return [Boolean]
|
5631
5540
|
#
|
5632
5541
|
# @!attribute [rw] shared_memory_size
|
5633
5542
|
# The value for the size (in MiB) of the `/dev/shm` volume. This
|
5634
|
-
# parameter maps to the `--shm-size` option to
|
5543
|
+
# parameter maps to the `--shm-size` option to docker run.
|
5635
5544
|
#
|
5636
5545
|
# <note markdown="1"> If you are using tasks that use the Fargate launch type, the
|
5637
5546
|
# `sharedMemorySize` parameter is not supported.
|
5638
5547
|
#
|
5639
5548
|
# </note>
|
5640
|
-
#
|
5641
|
-
#
|
5642
|
-
#
|
5643
|
-
# [1]: https://docs.docker.com/engine/reference/run/#security-configuration
|
5644
5549
|
# @return [Integer]
|
5645
5550
|
#
|
5646
5551
|
# @!attribute [rw] tmpfs
|
5647
5552
|
# The container path, mount options, and size (in MiB) of the tmpfs
|
5648
|
-
# mount. This parameter maps to the `--tmpfs` option to
|
5649
|
-
# run][1].
|
5553
|
+
# mount. This parameter maps to the `--tmpfs` option to docker run.
|
5650
5554
|
#
|
5651
5555
|
# <note markdown="1"> If you're using tasks that use the Fargate launch type, the `tmpfs`
|
5652
5556
|
# parameter isn't supported.
|
5653
5557
|
#
|
5654
5558
|
# </note>
|
5655
|
-
#
|
5656
|
-
#
|
5657
|
-
#
|
5658
|
-
# [1]: https://docs.docker.com/engine/reference/run/#security-configuration
|
5659
5559
|
# @return [Array<Types::Tmpfs>]
|
5660
5560
|
#
|
5661
5561
|
# @!attribute [rw] max_swap
|
5662
5562
|
# The total amount of swap memory (in MiB) a container can use. This
|
5663
|
-
# parameter will be translated to the `--memory-swap` option to
|
5664
|
-
#
|
5665
|
-
#
|
5563
|
+
# parameter will be translated to the `--memory-swap` option to docker
|
5564
|
+
# run where the value would be the sum of the container memory plus
|
5565
|
+
# the `maxSwap` value.
|
5666
5566
|
#
|
5667
5567
|
# If a `maxSwap` value of `0` is specified, the container will not use
|
5668
5568
|
# swap. Accepted values are `0` or any positive integer. If the
|
@@ -5678,10 +5578,6 @@ module Aws::ECS
|
|
5678
5578
|
# parameter isn't supported.
|
5679
5579
|
#
|
5680
5580
|
# </note>
|
5681
|
-
#
|
5682
|
-
#
|
5683
|
-
#
|
5684
|
-
# [1]: https://docs.docker.com/engine/reference/run/#security-configuration
|
5685
5581
|
# @return [Integer]
|
5686
5582
|
#
|
5687
5583
|
# @!attribute [rw] swappiness
|
@@ -5692,8 +5588,7 @@ module Aws::ECS
|
|
5692
5588
|
# between `0` and `100`. If the `swappiness` parameter is not
|
5693
5589
|
# specified, a default value of `60` is used. If a value is not
|
5694
5590
|
# specified for `maxSwap` then this parameter is ignored. This
|
5695
|
-
# parameter maps to the `--memory-swappiness` option to
|
5696
|
-
# run][1].
|
5591
|
+
# parameter maps to the `--memory-swappiness` option to docker run.
|
5697
5592
|
#
|
5698
5593
|
# <note markdown="1"> If you're using tasks that use the Fargate launch type, the
|
5699
5594
|
# `swappiness` parameter isn't supported.
|
@@ -5702,10 +5597,6 @@ module Aws::ECS
|
|
5702
5597
|
# parameter isn't supported.
|
5703
5598
|
#
|
5704
5599
|
# </note>
|
5705
|
-
#
|
5706
|
-
#
|
5707
|
-
#
|
5708
|
-
# [1]: https://docs.docker.com/engine/reference/run/#security-configuration
|
5709
5600
|
# @return [Integer]
|
5710
5601
|
#
|
5711
5602
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/LinuxParameters AWS API Documentation
|
@@ -5986,9 +5877,13 @@ module Aws::ECS
|
|
5986
5877
|
# Filters the container instances by status. For example, if you
|
5987
5878
|
# specify the `DRAINING` status, the results include only container
|
5988
5879
|
# instances that have been set to `DRAINING` using
|
5989
|
-
# UpdateContainerInstancesState. If you don't specify this
|
5990
|
-
# the default is to include container instances set to all
|
5991
|
-
# other than `INACTIVE`.
|
5880
|
+
# [UpdateContainerInstancesState][1]. If you don't specify this
|
5881
|
+
# parameter, the default is to include container instances set to all
|
5882
|
+
# states other than `INACTIVE`.
|
5883
|
+
#
|
5884
|
+
#
|
5885
|
+
#
|
5886
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateContainerInstancesState.html
|
5992
5887
|
# @return [String]
|
5993
5888
|
#
|
5994
5889
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListContainerInstancesRequest AWS API Documentation
|
@@ -6555,15 +6450,13 @@ module Aws::ECS
|
|
6555
6450
|
end
|
6556
6451
|
|
6557
6452
|
# The log configuration for the container. This parameter maps to
|
6558
|
-
# `LogConfig` in the
|
6559
|
-
#
|
6453
|
+
# `LogConfig` in the docker container create command and the
|
6454
|
+
# `--log-driver` option to docker run.
|
6560
6455
|
#
|
6561
6456
|
# By default, containers use the same logging driver that the Docker
|
6562
6457
|
# daemon uses. However, the container might use a different logging
|
6563
6458
|
# driver than the Docker daemon by specifying a log driver configuration
|
6564
|
-
# in the container definition.
|
6565
|
-
# for different supported log drivers, see [Configure logging
|
6566
|
-
# drivers][4] in the Docker documentation.
|
6459
|
+
# in the container definition.
|
6567
6460
|
#
|
6568
6461
|
# Understand the following when specifying a log configuration for your
|
6569
6462
|
# containers.
|
@@ -6576,8 +6469,8 @@ module Aws::ECS
|
|
6576
6469
|
# `splunk`, and `awsfirelens`.
|
6577
6470
|
#
|
6578
6471
|
# For tasks hosted on Amazon EC2 instances, the supported log drivers
|
6579
|
-
# are `awslogs`, `fluentd`, `gelf`, `json-file`, `journald`,
|
6580
|
-
# `
|
6472
|
+
# are `awslogs`, `fluentd`, `gelf`, `json-file`, `journald`,`syslog`,
|
6473
|
+
# `splunk`, and `awsfirelens`.
|
6581
6474
|
#
|
6582
6475
|
# * This parameter requires version 1.18 of the Docker Remote API or
|
6583
6476
|
# greater on your container instance.
|
@@ -6587,7 +6480,7 @@ module Aws::ECS
|
|
6587
6480
|
# `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before
|
6588
6481
|
# containers placed on that instance can use these log configuration
|
6589
6482
|
# options. For more information, see [Amazon ECS container agent
|
6590
|
-
# configuration][
|
6483
|
+
# configuration][1] in the *Amazon Elastic Container Service Developer
|
6591
6484
|
# Guide*.
|
6592
6485
|
#
|
6593
6486
|
# * For tasks that are on Fargate, because you don't have access to the
|
@@ -6598,11 +6491,7 @@ module Aws::ECS
|
|
6598
6491
|
#
|
6599
6492
|
#
|
6600
6493
|
#
|
6601
|
-
# [1]: https://docs.
|
6602
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
6603
|
-
# [3]: https://docs.docker.com/engine/reference/commandline/run/
|
6604
|
-
# [4]: https://docs.docker.com/engine/admin/logging/overview/
|
6605
|
-
# [5]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html
|
6494
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html
|
6606
6495
|
#
|
6607
6496
|
# @!attribute [rw] log_driver
|
6608
6497
|
# The log driver to use for the container.
|
@@ -6611,16 +6500,16 @@ module Aws::ECS
|
|
6611
6500
|
# `splunk`, and `awsfirelens`.
|
6612
6501
|
#
|
6613
6502
|
# For tasks hosted on Amazon EC2 instances, the supported log drivers
|
6614
|
-
# are `awslogs`, `fluentd`, `gelf`, `json-file`, `journald`,
|
6615
|
-
# `
|
6503
|
+
# are `awslogs`, `fluentd`, `gelf`, `json-file`, `journald`, `syslog`,
|
6504
|
+
# `splunk`, and `awsfirelens`.
|
6616
6505
|
#
|
6617
|
-
# For more information about using the `awslogs` log driver, see
|
6618
|
-
#
|
6506
|
+
# For more information about using the `awslogs` log driver, see [Send
|
6507
|
+
# Amazon ECS logs to CloudWatch][1] in the *Amazon Elastic Container
|
6619
6508
|
# Service Developer Guide*.
|
6620
6509
|
#
|
6621
6510
|
# For more information about using the `awsfirelens` log driver, see
|
6622
|
-
# [
|
6623
|
-
#
|
6511
|
+
# [Send Amazon ECS logs to an Amazon Web Services service or Amazon
|
6512
|
+
# Web Services Partner][2].
|
6624
6513
|
#
|
6625
6514
|
# <note markdown="1"> If you have a custom driver that isn't listed, you can fork the
|
6626
6515
|
# Amazon ECS container agent project that's [available on GitHub][3]
|
@@ -6777,9 +6666,8 @@ module Aws::ECS
|
|
6777
6666
|
#
|
6778
6667
|
# @!attribute [rw] maximum_scaling_step_size
|
6779
6668
|
# The maximum number of Amazon EC2 instances that Amazon ECS will
|
6780
|
-
# scale out at one time.
|
6781
|
-
#
|
6782
|
-
# `10000` is used.
|
6669
|
+
# scale out at one time. If this parameter is omitted, the default
|
6670
|
+
# value of `10000` is used.
|
6783
6671
|
# @return [Integer]
|
6784
6672
|
#
|
6785
6673
|
# @!attribute [rw] instance_warmup_period
|
@@ -6869,7 +6757,11 @@ module Aws::ECS
|
|
6869
6757
|
# Details on the network bindings between a container and its host
|
6870
6758
|
# container instance. After a task reaches the `RUNNING` status, manual
|
6871
6759
|
# and automatic host and container port assignments are visible in the
|
6872
|
-
# `networkBindings` section of DescribeTasks API responses.
|
6760
|
+
# `networkBindings` section of [DescribeTasks][1] API responses.
|
6761
|
+
#
|
6762
|
+
#
|
6763
|
+
#
|
6764
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html
|
6873
6765
|
#
|
6874
6766
|
# @!attribute [rw] bind_ip
|
6875
6767
|
# The IP address that the container is bound to on the container
|
@@ -7147,11 +7039,10 @@ module Aws::ECS
|
|
7147
7039
|
# can be left blank or it must be the same value as the `containerPort`.
|
7148
7040
|
#
|
7149
7041
|
# Most fields of this parameter (`containerPort`, `hostPort`,
|
7150
|
-
# `protocol`) maps to `PortBindings` in the
|
7151
|
-
#
|
7152
|
-
#
|
7153
|
-
#
|
7154
|
-
# port in the port mapping.
|
7042
|
+
# `protocol`) maps to `PortBindings` in the docker container create
|
7043
|
+
# command and the `--publish` option to `docker run`. If the network
|
7044
|
+
# mode of a task definition is set to `host`, host ports must either be
|
7045
|
+
# undefined or match the container port in the port mapping.
|
7155
7046
|
#
|
7156
7047
|
# <note markdown="1"> You can't expose the same container port for multiple protocols. If
|
7157
7048
|
# you attempt this, an error is returned.
|
@@ -7160,13 +7051,11 @@ module Aws::ECS
|
|
7160
7051
|
#
|
7161
7052
|
# After a task reaches the `RUNNING` status, manual and automatic host
|
7162
7053
|
# and container port assignments are visible in the `networkBindings`
|
7163
|
-
# section of DescribeTasks API responses.
|
7054
|
+
# section of [DescribeTasks][1] API responses.
|
7164
7055
|
#
|
7165
7056
|
#
|
7166
7057
|
#
|
7167
|
-
# [1]: https://docs.
|
7168
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
7169
|
-
# [3]: https://docs.docker.com/engine/reference/commandline/run/
|
7058
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html
|
7170
7059
|
#
|
7171
7060
|
# @!attribute [rw] container_port
|
7172
7061
|
# The port number on the container that's bound to the user-specified
|
@@ -7363,8 +7252,13 @@ module Aws::ECS
|
|
7363
7252
|
end
|
7364
7253
|
|
7365
7254
|
# An object representing the protection status details for a task. You
|
7366
|
-
# can set the protection status with the UpdateTaskProtection API
|
7367
|
-
# get the status of tasks with the GetTaskProtection API.
|
7255
|
+
# can set the protection status with the [UpdateTaskProtection][1] API
|
7256
|
+
# and get the status of tasks with the [GetTaskProtection][2] API.
|
7257
|
+
#
|
7258
|
+
#
|
7259
|
+
#
|
7260
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateTaskProtection.html
|
7261
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_GetTaskProtection.html
|
7368
7262
|
#
|
7369
7263
|
# @!attribute [rw] task_arn
|
7370
7264
|
# The task ARN.
|
@@ -7644,9 +7538,6 @@ module Aws::ECS
|
|
7644
7538
|
# mode][3]. For more information on using IPv6 with tasks launched
|
7645
7539
|
# on Fargate, see [Using a VPC in dual-stack mode][4].
|
7646
7540
|
#
|
7647
|
-
# * `fargateFIPSMode` - If you specify `fargateFIPSMode`, Fargate FIPS
|
7648
|
-
# 140 compliance is affected.
|
7649
|
-
#
|
7650
7541
|
# * `fargateTaskRetirementWaitPeriod` - When Amazon Web Services
|
7651
7542
|
# determines that a security or infrastructure update is needed for
|
7652
7543
|
# an Amazon ECS task hosted on Fargate, the tasks need to be stopped
|
@@ -7784,13 +7675,17 @@ module Aws::ECS
|
|
7784
7675
|
#
|
7785
7676
|
# If specifying a capacity provider that uses an Auto Scaling group,
|
7786
7677
|
# the capacity provider must already be created. New capacity
|
7787
|
-
# providers can be created with the CreateCapacityProvider API
|
7678
|
+
# providers can be created with the [CreateCapacityProvider][1] API
|
7788
7679
|
# operation.
|
7789
7680
|
#
|
7790
7681
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
7791
7682
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
7792
7683
|
# are available to all accounts and only need to be associated with a
|
7793
7684
|
# cluster to be used.
|
7685
|
+
#
|
7686
|
+
#
|
7687
|
+
#
|
7688
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html
|
7794
7689
|
# @return [Array<String>]
|
7795
7690
|
#
|
7796
7691
|
# @!attribute [rw] default_capacity_provider_strategy
|
@@ -7803,19 +7698,25 @@ module Aws::ECS
|
|
7803
7698
|
# A capacity provider strategy consists of one or more capacity
|
7804
7699
|
# providers along with the `base` and `weight` to assign to them. A
|
7805
7700
|
# capacity provider must be associated with the cluster to be used in
|
7806
|
-
# a capacity provider strategy. The PutClusterCapacityProviders
|
7807
|
-
# used to associate a capacity provider with a cluster. Only
|
7808
|
-
# providers with an `ACTIVE` or `UPDATING` status can be
|
7701
|
+
# a capacity provider strategy. The [PutClusterCapacityProviders][1]
|
7702
|
+
# API is used to associate a capacity provider with a cluster. Only
|
7703
|
+
# capacity providers with an `ACTIVE` or `UPDATING` status can be
|
7704
|
+
# used.
|
7809
7705
|
#
|
7810
7706
|
# If specifying a capacity provider that uses an Auto Scaling group,
|
7811
7707
|
# the capacity provider must already be created. New capacity
|
7812
|
-
# providers can be created with the CreateCapacityProvider API
|
7708
|
+
# providers can be created with the [CreateCapacityProvider][2] API
|
7813
7709
|
# operation.
|
7814
7710
|
#
|
7815
7711
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
7816
7712
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
7817
7713
|
# are available to all accounts and only need to be associated with a
|
7818
7714
|
# cluster to be used.
|
7715
|
+
#
|
7716
|
+
#
|
7717
|
+
#
|
7718
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
7719
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html
|
7819
7720
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
7820
7721
|
#
|
7821
7722
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutClusterCapacityProvidersRequest AWS API Documentation
|
@@ -7965,14 +7866,13 @@ module Aws::ECS
|
|
7965
7866
|
# @!attribute [rw] execution_role_arn
|
7966
7867
|
# The Amazon Resource Name (ARN) of the task execution role that
|
7967
7868
|
# grants the Amazon ECS container agent permission to make Amazon Web
|
7968
|
-
# Services API calls on your behalf.
|
7969
|
-
#
|
7970
|
-
# information, see [Amazon ECS task execution IAM role][1] in the
|
7869
|
+
# Services API calls on your behalf. For informationabout the required
|
7870
|
+
# IAM roles for Amazon ECS, see [IAM roles for Amazon ECS][1] in the
|
7971
7871
|
# *Amazon Elastic Container Service Developer Guide*.
|
7972
7872
|
#
|
7973
7873
|
#
|
7974
7874
|
#
|
7975
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
7875
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html
|
7976
7876
|
# @return [String]
|
7977
7877
|
#
|
7978
7878
|
# @!attribute [rw] network_mode
|
@@ -8002,22 +7902,19 @@ module Aws::ECS
|
|
8002
7902
|
# non-root user.
|
8003
7903
|
#
|
8004
7904
|
# If the network mode is `awsvpc`, the task is allocated an elastic
|
8005
|
-
# network interface, and you must specify a NetworkConfiguration
|
8006
|
-
# when you create a service or run a task with the task
|
8007
|
-
# For more information, see [Task Networking][
|
8008
|
-
# Elastic Container Service Developer Guide*.
|
7905
|
+
# network interface, and you must specify a [NetworkConfiguration][1]
|
7906
|
+
# value when you create a service or run a task with the task
|
7907
|
+
# definition. For more information, see [Task Networking][2] in the
|
7908
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
8009
7909
|
#
|
8010
7910
|
# If the network mode is `host`, you cannot run multiple
|
8011
7911
|
# instantiations of the same task on a single container instance when
|
8012
7912
|
# port mappings are used.
|
8013
7913
|
#
|
8014
|
-
# For more information, see [Network settings][2] in the *Docker run
|
8015
|
-
# reference*.
|
8016
|
-
#
|
8017
7914
|
#
|
8018
7915
|
#
|
8019
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/
|
8020
|
-
# [2]: https://docs.
|
7916
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html
|
7917
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
8021
7918
|
# @return [String]
|
8022
7919
|
#
|
8023
7920
|
# @!attribute [rw] container_definitions
|
@@ -8190,12 +8087,10 @@ module Aws::ECS
|
|
8190
8087
|
# share the same process namespace.
|
8191
8088
|
#
|
8192
8089
|
# If no value is specified, the default is a private namespace for
|
8193
|
-
# each container.
|
8194
|
-
# *Docker run reference*.
|
8090
|
+
# each container.
|
8195
8091
|
#
|
8196
8092
|
# If the `host` PID mode is used, there's a heightened risk of
|
8197
|
-
# undesired process namespace exposure.
|
8198
|
-
# [Docker security][2].
|
8093
|
+
# undesired process namespace exposure.
|
8199
8094
|
#
|
8200
8095
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
8201
8096
|
#
|
@@ -8206,11 +8101,6 @@ module Aws::ECS
|
|
8206
8101
|
# (Linux). This isn't supported for Windows containers on Fargate.
|
8207
8102
|
#
|
8208
8103
|
# </note>
|
8209
|
-
#
|
8210
|
-
#
|
8211
|
-
#
|
8212
|
-
# [1]: https://docs.docker.com/engine/reference/run/#pid-settings---pid
|
8213
|
-
# [2]: https://docs.docker.com/engine/security/security/
|
8214
8104
|
# @return [String]
|
8215
8105
|
#
|
8216
8106
|
# @!attribute [rw] ipc_mode
|
@@ -8224,17 +8114,15 @@ module Aws::ECS
|
|
8224
8114
|
# containers of a task are private and not shared with other
|
8225
8115
|
# containers in a task or on the container instance. If no value is
|
8226
8116
|
# specified, then the IPC resource namespace sharing depends on the
|
8227
|
-
# Docker daemon setting on the container instance.
|
8228
|
-
# information, see [IPC settings][1] in the *Docker run reference*.
|
8117
|
+
# Docker daemon setting on the container instance.
|
8229
8118
|
#
|
8230
8119
|
# If the `host` IPC mode is used, be aware that there is a heightened
|
8231
|
-
# risk of undesired IPC namespace expose.
|
8232
|
-
# [Docker security][2].
|
8120
|
+
# risk of undesired IPC namespace expose.
|
8233
8121
|
#
|
8234
8122
|
# If you are setting namespaced kernel parameters using
|
8235
8123
|
# `systemControls` for the containers in the task, the following will
|
8236
8124
|
# apply to your IPC resource namespace. For more information, see
|
8237
|
-
# [System Controls][
|
8125
|
+
# [System Controls][1] in the *Amazon Elastic Container Service
|
8238
8126
|
# Developer Guide*.
|
8239
8127
|
#
|
8240
8128
|
# * For tasks that use the `host` IPC mode, IPC namespace related
|
@@ -8250,9 +8138,7 @@ module Aws::ECS
|
|
8250
8138
|
#
|
8251
8139
|
#
|
8252
8140
|
#
|
8253
|
-
# [1]: https://docs.
|
8254
|
-
# [2]: https://docs.docker.com/engine/security/security/
|
8255
|
-
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html
|
8141
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html
|
8256
8142
|
# @return [String]
|
8257
8143
|
#
|
8258
8144
|
# @!attribute [rw] proxy_configuration
|
@@ -8603,12 +8489,17 @@ module Aws::ECS
|
|
8603
8489
|
# Specifies whether to propagate the tags from the task definition to
|
8604
8490
|
# the task. If no value is specified, the tags aren't propagated.
|
8605
8491
|
# Tags can only be propagated to the task during task creation. To add
|
8606
|
-
# tags to a task after task creation, use the
|
8492
|
+
# tags to a task after task creation, use the[TagResource][1] API
|
8493
|
+
# action.
|
8607
8494
|
#
|
8608
8495
|
# <note markdown="1"> An error will be received if you specify the `SERVICE` option when
|
8609
8496
|
# running a task.
|
8610
8497
|
#
|
8611
8498
|
# </note>
|
8499
|
+
#
|
8500
|
+
#
|
8501
|
+
#
|
8502
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html
|
8612
8503
|
# @return [String]
|
8613
8504
|
#
|
8614
8505
|
# @!attribute [rw] reference_id
|
@@ -8621,12 +8512,17 @@ module Aws::ECS
|
|
8621
8512
|
# you automatically trigger a task to run a batch process job, you
|
8622
8513
|
# could apply a unique identifier for that job to your task with the
|
8623
8514
|
# `startedBy` parameter. You can then identify which tasks belong to
|
8624
|
-
# that job by filtering the results of a ListTasks call with the
|
8515
|
+
# that job by filtering the results of a [ListTasks][1] call with the
|
8625
8516
|
# `startedBy` value. Up to 128 letters (uppercase and lowercase),
|
8626
|
-
# numbers, hyphens (-), and underscores (\_) are
|
8517
|
+
# numbers, hyphens (-), forward slash (/), and underscores (\_) are
|
8518
|
+
# allowed.
|
8627
8519
|
#
|
8628
8520
|
# If a task is started by an Amazon ECS service, then the `startedBy`
|
8629
8521
|
# parameter contains the deployment ID of the service that starts it.
|
8522
|
+
#
|
8523
|
+
#
|
8524
|
+
#
|
8525
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html
|
8630
8526
|
# @return [String]
|
8631
8527
|
#
|
8632
8528
|
# @!attribute [rw] tags
|
@@ -8934,8 +8830,13 @@ module Aws::ECS
|
|
8934
8830
|
# @!attribute [rw] desired_count
|
8935
8831
|
# The desired number of instantiations of the task definition to keep
|
8936
8832
|
# running on the service. This value is specified when the service is
|
8937
|
-
# created with CreateService, and it can be modified with
|
8938
|
-
# UpdateService.
|
8833
|
+
# created with [CreateService][1] , and it can be modified with
|
8834
|
+
# [UpdateService][2].
|
8835
|
+
#
|
8836
|
+
#
|
8837
|
+
#
|
8838
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html
|
8839
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
8939
8840
|
# @return [Integer]
|
8940
8841
|
#
|
8941
8842
|
# @!attribute [rw] running_count
|
@@ -8981,8 +8882,13 @@ module Aws::ECS
|
|
8981
8882
|
#
|
8982
8883
|
# @!attribute [rw] task_definition
|
8983
8884
|
# The task definition to use for tasks in the service. This value is
|
8984
|
-
# specified when the service is created with CreateService, and
|
8985
|
-
# be modified with UpdateService.
|
8885
|
+
# specified when the service is created with [CreateService][1], and
|
8886
|
+
# it can be modified with [UpdateService][2].
|
8887
|
+
#
|
8888
|
+
#
|
8889
|
+
#
|
8890
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html
|
8891
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
8986
8892
|
# @return [String]
|
8987
8893
|
#
|
8988
8894
|
# @!attribute [rw] deployment_configuration
|
@@ -9283,15 +9189,13 @@ module Aws::ECS
|
|
9283
9189
|
#
|
9284
9190
|
# @!attribute [rw] log_configuration
|
9285
9191
|
# The log configuration for the container. This parameter maps to
|
9286
|
-
# `LogConfig` in the
|
9287
|
-
#
|
9192
|
+
# `LogConfig` in the docker container create command and the
|
9193
|
+
# `--log-driver` option to docker run.
|
9288
9194
|
#
|
9289
9195
|
# By default, containers use the same logging driver that the Docker
|
9290
9196
|
# daemon uses. However, the container might use a different logging
|
9291
9197
|
# driver than the Docker daemon by specifying a log driver
|
9292
|
-
# configuration in the container definition.
|
9293
|
-
# about the options for different supported log drivers, see
|
9294
|
-
# [Configure logging drivers][4] in the Docker documentation.
|
9198
|
+
# configuration in the container definition.
|
9295
9199
|
#
|
9296
9200
|
# Understand the following when specifying a log configuration for
|
9297
9201
|
# your containers.
|
@@ -9304,8 +9208,8 @@ module Aws::ECS
|
|
9304
9208
|
# `splunk`, and `awsfirelens`.
|
9305
9209
|
#
|
9306
9210
|
# For tasks hosted on Amazon EC2 instances, the supported log
|
9307
|
-
# drivers are `awslogs`, `fluentd`, `gelf`, `json-file`,
|
9308
|
-
# `
|
9211
|
+
# drivers are `awslogs`, `fluentd`, `gelf`, `json-file`,
|
9212
|
+
# `journald`,`syslog`, `splunk`, and `awsfirelens`.
|
9309
9213
|
#
|
9310
9214
|
# * This parameter requires version 1.18 of the Docker Remote API or
|
9311
9215
|
# greater on your container instance.
|
@@ -9315,7 +9219,7 @@ module Aws::ECS
|
|
9315
9219
|
# the `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before
|
9316
9220
|
# containers placed on that instance can use these log configuration
|
9317
9221
|
# options. For more information, see [Amazon ECS container agent
|
9318
|
-
# configuration][
|
9222
|
+
# configuration][1] in the *Amazon Elastic Container Service
|
9319
9223
|
# Developer Guide*.
|
9320
9224
|
#
|
9321
9225
|
# * For tasks that are on Fargate, because you don't have access to
|
@@ -9326,11 +9230,7 @@ module Aws::ECS
|
|
9326
9230
|
#
|
9327
9231
|
#
|
9328
9232
|
#
|
9329
|
-
# [1]: https://docs.
|
9330
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
9331
|
-
# [3]: https://docs.docker.com/engine/reference/commandline/run/
|
9332
|
-
# [4]: https://docs.docker.com/engine/admin/logging/overview/
|
9333
|
-
# [5]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html
|
9233
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html
|
9334
9234
|
# @return [Types::LogConfiguration]
|
9335
9235
|
#
|
9336
9236
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceConnectConfiguration AWS API Documentation
|
@@ -9723,15 +9623,23 @@ module Aws::ECS
|
|
9723
9623
|
|
9724
9624
|
# The specified service isn't active. You can't update a service
|
9725
9625
|
# that's inactive. If you have previously deleted a service, you can
|
9726
|
-
# re-create it with CreateService.
|
9626
|
+
# re-create it with [CreateService][1].
|
9627
|
+
#
|
9628
|
+
#
|
9629
|
+
#
|
9630
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html
|
9727
9631
|
#
|
9728
9632
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceNotActiveException AWS API Documentation
|
9729
9633
|
#
|
9730
9634
|
class ServiceNotActiveException < Aws::EmptyStructure; end
|
9731
9635
|
|
9732
9636
|
# The specified service wasn't found. You can view your available
|
9733
|
-
# services with ListServices. Amazon ECS services are cluster
|
9734
|
-
# and Region specific.
|
9637
|
+
# services with [ListServices][1]. Amazon ECS services are cluster
|
9638
|
+
# specific and Region specific.
|
9639
|
+
#
|
9640
|
+
#
|
9641
|
+
#
|
9642
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html
|
9735
9643
|
#
|
9736
9644
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceNotFoundException AWS API Documentation
|
9737
9645
|
#
|
@@ -9958,12 +9866,17 @@ module Aws::ECS
|
|
9958
9866
|
# you automatically trigger a task to run a batch process job, you
|
9959
9867
|
# could apply a unique identifier for that job to your task with the
|
9960
9868
|
# `startedBy` parameter. You can then identify which tasks belong to
|
9961
|
-
# that job by filtering the results of a ListTasks call with the
|
9869
|
+
# that job by filtering the results of a [ListTasks][1] call with the
|
9962
9870
|
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
9963
|
-
# numbers, hyphens (-), and underscores (\_) are
|
9871
|
+
# numbers, hyphens (-), forward slash (/), and underscores (\_) are
|
9872
|
+
# allowed.
|
9964
9873
|
#
|
9965
9874
|
# If a task is started by an Amazon ECS service, the `startedBy`
|
9966
9875
|
# parameter contains the deployment ID of the service that starts it.
|
9876
|
+
#
|
9877
|
+
#
|
9878
|
+
#
|
9879
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html
|
9967
9880
|
# @return [String]
|
9968
9881
|
#
|
9969
9882
|
# @!attribute [rw] tags
|
@@ -10066,7 +9979,12 @@ module Aws::ECS
|
|
10066
9979
|
# An optional message specified when a task is stopped. For example,
|
10067
9980
|
# if you're using a custom scheduler, you can use this parameter to
|
10068
9981
|
# specify the reason for stopping the task here, and the message
|
10069
|
-
# appears in subsequent DescribeTasks API operations on this
|
9982
|
+
# appears in subsequent [DescribeTasks][1]> API operations on this
|
9983
|
+
# task.
|
9984
|
+
#
|
9985
|
+
#
|
9986
|
+
#
|
9987
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html
|
10070
9988
|
# @return [String]
|
10071
9989
|
#
|
10072
9990
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StopTaskRequest AWS API Documentation
|
@@ -10254,10 +10172,10 @@ module Aws::ECS
|
|
10254
10172
|
end
|
10255
10173
|
|
10256
10174
|
# A list of namespaced kernel parameters to set in the container. This
|
10257
|
-
# parameter maps to `Sysctls` in the
|
10258
|
-
# the
|
10259
|
-
#
|
10260
|
-
#
|
10175
|
+
# parameter maps to `Sysctls` in the docker container create command and
|
10176
|
+
# the `--sysctl` option to docker run. For example, you can configure
|
10177
|
+
# `net.ipv4.tcp_keepalive_time` setting to maintain longer lived
|
10178
|
+
# connections.
|
10261
10179
|
#
|
10262
10180
|
# We don't recommend that you specify network-related `systemControls`
|
10263
10181
|
# parameters for multiple containers in a single task that also uses
|
@@ -10275,7 +10193,7 @@ module Aws::ECS
|
|
10275
10193
|
#
|
10276
10194
|
# If you're setting an IPC resource namespace to use for the containers
|
10277
10195
|
# in the task, the following conditions apply to your system controls.
|
10278
|
-
# For more information, see [IPC mode][
|
10196
|
+
# For more information, see [IPC mode][1].
|
10279
10197
|
#
|
10280
10198
|
# * For tasks that use the `host` IPC mode, IPC namespace
|
10281
10199
|
# `systemControls` aren't supported.
|
@@ -10295,10 +10213,7 @@ module Aws::ECS
|
|
10295
10213
|
#
|
10296
10214
|
#
|
10297
10215
|
#
|
10298
|
-
# [1]: https://docs.
|
10299
|
-
# [2]: https://docs.docker.com/engine/api/v1.35/
|
10300
|
-
# [3]: https://docs.docker.com/engine/reference/run/#security-configuration
|
10301
|
-
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_definition_ipcmode
|
10216
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_definition_ipcmode
|
10302
10217
|
#
|
10303
10218
|
# @!attribute [rw] namespace
|
10304
10219
|
# The namespaced kernel parameter to set a `value` for.
|
@@ -10448,8 +10363,12 @@ module Aws::ECS
|
|
10448
10363
|
class TargetNotConnectedException < Aws::EmptyStructure; end
|
10449
10364
|
|
10450
10365
|
# The specified target wasn't found. You can view your available
|
10451
|
-
# container instances with ListContainerInstances. Amazon ECS
|
10452
|
-
# instances are cluster-specific and Region-specific.
|
10366
|
+
# container instances with [ListContainerInstances][1]. Amazon ECS
|
10367
|
+
# container instances are cluster-specific and Region-specific.
|
10368
|
+
#
|
10369
|
+
#
|
10370
|
+
#
|
10371
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html
|
10453
10372
|
#
|
10454
10373
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TargetNotFoundException AWS API Documentation
|
10455
10374
|
#
|
@@ -10861,33 +10780,26 @@ module Aws::ECS
|
|
10861
10780
|
# @!attribute [rw] task_role_arn
|
10862
10781
|
# The short name or full Amazon Resource Name (ARN) of the Identity
|
10863
10782
|
# and Access Management role that grants containers in the task
|
10864
|
-
# permission to call Amazon Web Services APIs on your behalf. For
|
10865
|
-
#
|
10866
|
-
# Container Service
|
10867
|
-
#
|
10868
|
-
# IAM roles for tasks on Windows require that the `-EnableTaskIAMRole`
|
10869
|
-
# option is set when you launch the Amazon ECS-optimized Windows AMI.
|
10870
|
-
# Your containers must also run some configuration code to use the
|
10871
|
-
# feature. For more information, see [Windows IAM roles for tasks][2]
|
10872
|
-
# in the *Amazon Elastic Container Service Developer Guide*.
|
10783
|
+
# permission to call Amazon Web Services APIs on your behalf. For
|
10784
|
+
# informationabout the required IAM roles for Amazon ECS, see [IAM
|
10785
|
+
# roles for Amazon ECS][1] in the *Amazon Elastic Container Service
|
10786
|
+
# Developer Guide*.
|
10873
10787
|
#
|
10874
10788
|
#
|
10875
10789
|
#
|
10876
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
10877
|
-
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html
|
10790
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html
|
10878
10791
|
# @return [String]
|
10879
10792
|
#
|
10880
10793
|
# @!attribute [rw] execution_role_arn
|
10881
10794
|
# The Amazon Resource Name (ARN) of the task execution role that
|
10882
10795
|
# grants the Amazon ECS container agent permission to make Amazon Web
|
10883
|
-
# Services API calls on your behalf.
|
10884
|
-
#
|
10885
|
-
# information, see [Amazon ECS task execution IAM role][1] in the
|
10796
|
+
# Services API calls on your behalf. For informationabout the required
|
10797
|
+
# IAM roles for Amazon ECS, see [IAM roles for Amazon ECS][1] in the
|
10886
10798
|
# *Amazon Elastic Container Service Developer Guide*.
|
10887
10799
|
#
|
10888
10800
|
#
|
10889
10801
|
#
|
10890
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
10802
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html
|
10891
10803
|
# @return [String]
|
10892
10804
|
#
|
10893
10805
|
# @!attribute [rw] network_mode
|
@@ -10917,22 +10829,19 @@ module Aws::ECS
|
|
10917
10829
|
# non-root user.
|
10918
10830
|
#
|
10919
10831
|
# If the network mode is `awsvpc`, the task is allocated an elastic
|
10920
|
-
# network interface, and you must specify a NetworkConfiguration
|
10921
|
-
# when you create a service or run a task with the task
|
10922
|
-
# For more information, see [Task Networking][
|
10923
|
-
# Elastic Container Service Developer Guide*.
|
10832
|
+
# network interface, and you must specify a [NetworkConfiguration][1]
|
10833
|
+
# value when you create a service or run a task with the task
|
10834
|
+
# definition. For more information, see [Task Networking][2] in the
|
10835
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
10924
10836
|
#
|
10925
10837
|
# If the network mode is `host`, you cannot run multiple
|
10926
10838
|
# instantiations of the same task on a single container instance when
|
10927
10839
|
# port mappings are used.
|
10928
10840
|
#
|
10929
|
-
# For more information, see [Network settings][2] in the *Docker run
|
10930
|
-
# reference*.
|
10931
10841
|
#
|
10932
10842
|
#
|
10933
|
-
#
|
10934
|
-
# [
|
10935
|
-
# [2]: https://docs.docker.com/engine/reference/run/#network-settings
|
10843
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html
|
10844
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
10936
10845
|
# @return [String]
|
10937
10846
|
#
|
10938
10847
|
# @!attribute [rw] revision
|
@@ -10968,10 +10877,11 @@ module Aws::ECS
|
|
10968
10877
|
# Amazon EC2 instance is registered to your cluster, the Amazon ECS
|
10969
10878
|
# container agent assigns some standard attributes to the instance.
|
10970
10879
|
# You can apply custom attributes. These are specified as key-value
|
10971
|
-
# pairs using the Amazon ECS console or the PutAttributes API.
|
10972
|
-
# attributes are used when determining task placement for tasks
|
10973
|
-
# on Amazon EC2 instances. For more information, see
|
10974
|
-
# in the *Amazon Elastic Container Service Developer
|
10880
|
+
# pairs using the Amazon ECS console or the [PutAttributes][1] API.
|
10881
|
+
# These attributes are used when determining task placement for tasks
|
10882
|
+
# hosted on Amazon EC2 instances. For more information, see
|
10883
|
+
# [Attributes][2] in the *Amazon Elastic Container Service Developer
|
10884
|
+
# Guide*.
|
10975
10885
|
#
|
10976
10886
|
# <note markdown="1"> This parameter isn't supported for tasks run on Fargate.
|
10977
10887
|
#
|
@@ -10979,7 +10889,8 @@ module Aws::ECS
|
|
10979
10889
|
#
|
10980
10890
|
#
|
10981
10891
|
#
|
10982
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/
|
10892
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAttributes.html
|
10893
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes
|
10983
10894
|
# @return [Array<Types::Attribute>]
|
10984
10895
|
#
|
10985
10896
|
# @!attribute [rw] placement_constraints
|
@@ -10991,8 +10902,8 @@ module Aws::ECS
|
|
10991
10902
|
# @return [Array<Types::TaskDefinitionPlacementConstraint>]
|
10992
10903
|
#
|
10993
10904
|
# @!attribute [rw] compatibilities
|
10994
|
-
#
|
10995
|
-
#
|
10905
|
+
# Amazon ECS validates the task definition parameters with those
|
10906
|
+
# supported by the launch type. For more information, see [Amazon ECS
|
10996
10907
|
# launch types][1] in the *Amazon Elastic Container Service Developer
|
10997
10908
|
# Guide*.
|
10998
10909
|
#
|
@@ -11028,6 +10939,10 @@ module Aws::ECS
|
|
11028
10939
|
# one of the following values. The value that you choose determines
|
11029
10940
|
# your range of valid values for the `memory` parameter.
|
11030
10941
|
#
|
10942
|
+
# If you use the EC2 launch type, this field is optional. Supported
|
10943
|
+
# values are between `128` CPU units (`0.125` vCPUs) and `10240` CPU
|
10944
|
+
# units (`10` vCPUs).
|
10945
|
+
#
|
11031
10946
|
# The CPU units cannot be less than 1 vCPU when you use Windows
|
11032
10947
|
# containers on Fargate.
|
11033
10948
|
#
|
@@ -11121,12 +11036,10 @@ module Aws::ECS
|
|
11121
11036
|
# share the same process namespace.
|
11122
11037
|
#
|
11123
11038
|
# If no value is specified, the default is a private namespace for
|
11124
|
-
# each container.
|
11125
|
-
# *Docker run reference*.
|
11039
|
+
# each container.
|
11126
11040
|
#
|
11127
11041
|
# If the `host` PID mode is used, there's a heightened risk of
|
11128
|
-
# undesired process namespace exposure.
|
11129
|
-
# [Docker security][2].
|
11042
|
+
# undesired process namespace exposure.
|
11130
11043
|
#
|
11131
11044
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
11132
11045
|
#
|
@@ -11137,11 +11050,6 @@ module Aws::ECS
|
|
11137
11050
|
# (Linux). This isn't supported for Windows containers on Fargate.
|
11138
11051
|
#
|
11139
11052
|
# </note>
|
11140
|
-
#
|
11141
|
-
#
|
11142
|
-
#
|
11143
|
-
# [1]: https://docs.docker.com/engine/reference/run/#pid-settings---pid
|
11144
|
-
# [2]: https://docs.docker.com/engine/security/security/
|
11145
11053
|
# @return [String]
|
11146
11054
|
#
|
11147
11055
|
# @!attribute [rw] ipc_mode
|
@@ -11155,17 +11063,15 @@ module Aws::ECS
|
|
11155
11063
|
# containers of a task are private and not shared with other
|
11156
11064
|
# containers in a task or on the container instance. If no value is
|
11157
11065
|
# specified, then the IPC resource namespace sharing depends on the
|
11158
|
-
# Docker daemon setting on the container instance.
|
11159
|
-
# information, see [IPC settings][1] in the *Docker run reference*.
|
11066
|
+
# Docker daemon setting on the container instance.
|
11160
11067
|
#
|
11161
11068
|
# If the `host` IPC mode is used, be aware that there is a heightened
|
11162
|
-
# risk of undesired IPC namespace expose.
|
11163
|
-
# [Docker security][2].
|
11069
|
+
# risk of undesired IPC namespace expose.
|
11164
11070
|
#
|
11165
11071
|
# If you are setting namespaced kernel parameters using
|
11166
11072
|
# `systemControls` for the containers in the task, the following will
|
11167
11073
|
# apply to your IPC resource namespace. For more information, see
|
11168
|
-
# [System Controls][
|
11074
|
+
# [System Controls][1] in the *Amazon Elastic Container Service
|
11169
11075
|
# Developer Guide*.
|
11170
11076
|
#
|
11171
11077
|
# * For tasks that use the `host` IPC mode, IPC namespace related
|
@@ -11181,9 +11087,7 @@ module Aws::ECS
|
|
11181
11087
|
#
|
11182
11088
|
#
|
11183
11089
|
#
|
11184
|
-
# [1]: https://docs.
|
11185
|
-
# [2]: https://docs.docker.com/engine/security/security/
|
11186
|
-
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html
|
11090
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html
|
11187
11091
|
# @return [String]
|
11188
11092
|
#
|
11189
11093
|
# @!attribute [rw] proxy_configuration
|
@@ -11839,8 +11743,12 @@ module Aws::ECS
|
|
11839
11743
|
end
|
11840
11744
|
|
11841
11745
|
# The specified task set wasn't found. You can view your available task
|
11842
|
-
# sets with DescribeTaskSets. Task sets are specific to each
|
11843
|
-
# service and Region.
|
11746
|
+
# sets with [DescribeTaskSets][1]. Task sets are specific to each
|
11747
|
+
# cluster, service and Region.
|
11748
|
+
#
|
11749
|
+
#
|
11750
|
+
#
|
11751
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTaskSets.html
|
11844
11752
|
#
|
11845
11753
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TaskSetNotFoundException AWS API Documentation
|
11846
11754
|
#
|
@@ -11944,7 +11852,7 @@ module Aws::ECS
|
|
11944
11852
|
# values set by the operating system with the exception of the `nofile`
|
11945
11853
|
# resource limit parameter which Fargate overrides. The `nofile`
|
11946
11854
|
# resource limit sets a restriction on the number of open files that a
|
11947
|
-
# container can use. The default `nofile` soft limit is `
|
11855
|
+
# container can use. The default `nofile` soft limit is ` 65535` and the
|
11948
11856
|
# default hard limit is `65535`.
|
11949
11857
|
#
|
11950
11858
|
# You can specify the `ulimit` settings for a container in a task
|
@@ -11955,11 +11863,15 @@ module Aws::ECS
|
|
11955
11863
|
# @return [String]
|
11956
11864
|
#
|
11957
11865
|
# @!attribute [rw] soft_limit
|
11958
|
-
# The soft limit for the `ulimit` type.
|
11866
|
+
# The soft limit for the `ulimit` type. The value can be specified in
|
11867
|
+
# bytes, seconds, or as a count, depending on the `type` of the
|
11868
|
+
# `ulimit`.
|
11959
11869
|
# @return [Integer]
|
11960
11870
|
#
|
11961
11871
|
# @!attribute [rw] hard_limit
|
11962
|
-
# The hard limit for the `ulimit` type.
|
11872
|
+
# The hard limit for the `ulimit` type. The value can be specified in
|
11873
|
+
# bytes, seconds, or as a count, depending on the `type` of the
|
11874
|
+
# `ulimit`.
|
11963
11875
|
# @return [Integer]
|
11964
11876
|
#
|
11965
11877
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Ulimit AWS API Documentation
|
@@ -12099,7 +12011,7 @@ module Aws::ECS
|
|
12099
12011
|
# The setting to use by default for a cluster. This parameter is used
|
12100
12012
|
# to turn on CloudWatch Container Insights for a cluster. If this
|
12101
12013
|
# value is specified, it overrides the `containerInsights` value set
|
12102
|
-
# with PutAccountSetting or PutAccountSettingDefault.
|
12014
|
+
# with [PutAccountSetting][1] or [PutAccountSettingDefault][2].
|
12103
12015
|
#
|
12104
12016
|
# Currently, if you delete an existing cluster that does not have
|
12105
12017
|
# Container Insights turned on, and then create a new cluster with the
|
@@ -12107,6 +12019,11 @@ module Aws::ECS
|
|
12107
12019
|
# not actually be turned on. If you want to preserve the same name for
|
12108
12020
|
# your existing cluster and turn on Container Insights, you must wait
|
12109
12021
|
# 7 days before you can re-create it.
|
12022
|
+
#
|
12023
|
+
#
|
12024
|
+
#
|
12025
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html
|
12026
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html
|
12110
12027
|
# @return [Array<Types::ClusterSetting>]
|
12111
12028
|
#
|
12112
12029
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateClusterSettingsRequest AWS API Documentation
|
@@ -12296,23 +12213,31 @@ module Aws::ECS
|
|
12296
12213
|
# A capacity provider strategy consists of one or more capacity
|
12297
12214
|
# providers along with the `base` and `weight` to assign to them. A
|
12298
12215
|
# capacity provider must be associated with the cluster to be used in
|
12299
|
-
# a capacity provider strategy. The PutClusterCapacityProviders
|
12300
|
-
# used to associate a capacity provider with a cluster. Only
|
12301
|
-
# providers with an `ACTIVE` or `UPDATING` status can be
|
12216
|
+
# a capacity provider strategy. The [PutClusterCapacityProviders][1]
|
12217
|
+
# API is used to associate a capacity provider with a cluster. Only
|
12218
|
+
# capacity providers with an `ACTIVE` or `UPDATING` status can be
|
12219
|
+
# used.
|
12302
12220
|
#
|
12303
12221
|
# If specifying a capacity provider that uses an Auto Scaling group,
|
12304
12222
|
# the capacity provider must already be created. New capacity
|
12305
|
-
# providers can be created with the
|
12306
|
-
# operation.
|
12223
|
+
# providers can be created with the [CreateClusterCapacityProvider][2]
|
12224
|
+
# API operation.
|
12307
12225
|
#
|
12308
12226
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
12309
12227
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
12310
12228
|
# are available to all accounts and only need to be associated with a
|
12311
12229
|
# cluster to be used.
|
12312
12230
|
#
|
12313
|
-
# The PutClusterCapacityProviders
|
12314
|
-
# list of available capacity providers for a cluster after the
|
12315
|
-
# is created.
|
12231
|
+
# The [PutClusterCapacityProviders][1]API operation is used to update
|
12232
|
+
# the list of available capacity providers for a cluster after the
|
12233
|
+
# cluster is created.
|
12234
|
+
#
|
12235
|
+
#
|
12236
|
+
#
|
12237
|
+
#
|
12238
|
+
#
|
12239
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
12240
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html
|
12316
12241
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
12317
12242
|
#
|
12318
12243
|
# @!attribute [rw] deployment_configuration
|
@@ -12799,3 +12724,4 @@ module Aws::ECS
|
|
12799
12724
|
|
12800
12725
|
end
|
12801
12726
|
end
|
12727
|
+
|