aws-sdk-ecs 1.153.0 → 1.154.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ecs/client.rb +167 -93
- data/lib/aws-sdk-ecs/types.rb +279 -141
- data/lib/aws-sdk-ecs.rb +1 -1
- metadata +2 -2
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
|
#
|
@@ -242,7 +247,7 @@ module Aws::ECS
|
|
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]
|
@@ -553,7 +565,11 @@ module Aws::ECS
|
|
553
565
|
#
|
554
566
|
# @!attribute [rw] active_services_count
|
555
567
|
# The number of services that are running on the cluster in an
|
556
|
-
# `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
|
557
573
|
# @return [Integer]
|
558
574
|
#
|
559
575
|
# @!attribute [rw] statistics
|
@@ -715,7 +731,11 @@ module Aws::ECS
|
|
715
731
|
|
716
732
|
# You can't delete a cluster that has registered container instances.
|
717
733
|
# First, deregister the container instances before you can delete the
|
718
|
-
# 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
|
719
739
|
#
|
720
740
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ClusterContainsContainerInstancesException AWS API Documentation
|
721
741
|
#
|
@@ -723,7 +743,13 @@ module Aws::ECS
|
|
723
743
|
|
724
744
|
# You can't delete a cluster that contains services. First, update the
|
725
745
|
# service to reduce its desired task count to 0, and then delete the
|
726
|
-
# 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
|
727
753
|
#
|
728
754
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ClusterContainsServicesException AWS API Documentation
|
729
755
|
#
|
@@ -736,7 +762,12 @@ module Aws::ECS
|
|
736
762
|
class ClusterContainsTasksException < Aws::EmptyStructure; end
|
737
763
|
|
738
764
|
# The specified cluster wasn't found. You can view your available
|
739
|
-
# 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
|
740
771
|
#
|
741
772
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ClusterNotFoundException AWS API Documentation
|
742
773
|
#
|
@@ -1004,7 +1035,7 @@ module Aws::ECS
|
|
1004
1035
|
# entered in the `links` of another container to connect the
|
1005
1036
|
# containers. Up to 255 letters (uppercase and lowercase), numbers,
|
1006
1037
|
# underscores, and hyphens are allowed. This parameter maps to `name`
|
1007
|
-
# in tthe docker create
|
1038
|
+
# in tthe docker conainer create command and the `--name` option to
|
1008
1039
|
# docker run.
|
1009
1040
|
# @return [String]
|
1010
1041
|
#
|
@@ -1015,8 +1046,8 @@ module Aws::ECS
|
|
1015
1046
|
# repository-url/image:tag ` or ` repository-url/image@digest `. Up to
|
1016
1047
|
# 255 letters (uppercase and lowercase), numbers, hyphens,
|
1017
1048
|
# underscores, colons, periods, forward slashes, and number signs are
|
1018
|
-
# allowed. This parameter maps to `Image` in the docker
|
1019
|
-
# create
|
1049
|
+
# allowed. This parameter maps to `Image` in the docker conainer
|
1050
|
+
# create command and the `IMAGE` parameter of docker run.
|
1020
1051
|
#
|
1021
1052
|
# * When a new task starts, the Amazon ECS container agent pulls the
|
1022
1053
|
# latest version of the specified image and tag for the container to
|
@@ -1046,7 +1077,7 @@ 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 docker create
|
1080
|
+
# maps to `CpuShares` in the docker conainer create commandand the
|
1050
1081
|
# `--cpu-shares` option to docker run.
|
1051
1082
|
#
|
1052
1083
|
# This field is optional for tasks using the Fargate launch type, and
|
@@ -1112,7 +1143,7 @@ module Aws::ECS
|
|
1112
1143
|
# container is killed. The total amount of memory reserved for all
|
1113
1144
|
# containers within a task must be lower than the task `memory` value,
|
1114
1145
|
# if one is specified. This parameter maps to `Memory` in thethe
|
1115
|
-
# docker create
|
1146
|
+
# docker conainer create command and the `--memory` option to docker
|
1116
1147
|
# run.
|
1117
1148
|
#
|
1118
1149
|
# If using the Fargate launch type, this parameter is optional.
|
@@ -1142,7 +1173,7 @@ module Aws::ECS
|
|
1142
1173
|
# specified with the `memory` parameter (if applicable), or all of the
|
1143
1174
|
# available memory on the container instance, whichever comes first.
|
1144
1175
|
# This parameter maps to `MemoryReservation` in the the docker
|
1145
|
-
# create
|
1176
|
+
# conainer create command and the `--memory-reservation` option to
|
1146
1177
|
# docker run.
|
1147
1178
|
#
|
1148
1179
|
# If a task-level memory value is not specified, you must specify a
|
@@ -1177,7 +1208,7 @@ module Aws::ECS
|
|
1177
1208
|
# `name:internalName` construct is analogous to `name:alias` in Docker
|
1178
1209
|
# links. Up to 255 letters (uppercase and lowercase), numbers,
|
1179
1210
|
# underscores, and hyphens are allowed.. This parameter maps to
|
1180
|
-
# `Links` in the docker create
|
1211
|
+
# `Links` in the docker conainer create command and the `--link`
|
1181
1212
|
# option to docker run.
|
1182
1213
|
#
|
1183
1214
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
@@ -1204,20 +1235,24 @@ module Aws::ECS
|
|
1204
1235
|
# so you can't access a container's mapped port from the host
|
1205
1236
|
# itself.
|
1206
1237
|
#
|
1207
|
-
# This parameter maps to `PortBindings` in the the docker
|
1208
|
-
# create
|
1209
|
-
#
|
1210
|
-
#
|
1211
|
-
#
|
1212
|
-
#
|
1238
|
+
# This parameter maps to `PortBindings` in the the docker conainer
|
1239
|
+
# create command and the `--publish` option to docker run. If the
|
1240
|
+
# network mode of a task definition is set to `none`, then you can't
|
1241
|
+
# specify port mappings. If the network mode of a task definition is
|
1242
|
+
# set to `host`, then host ports must either be undefined or they must
|
1243
|
+
# match the container port in the port mapping.
|
1213
1244
|
#
|
1214
1245
|
# <note markdown="1"> After a task reaches the `RUNNING` status, manual and automatic host
|
1215
1246
|
# and container port assignments are visible in the **Network
|
1216
1247
|
# Bindings** section of a container description for a selected task in
|
1217
1248
|
# the Amazon ECS console. The assignments are also visible in the
|
1218
|
-
# `networkBindings` section DescribeTasks responses.
|
1249
|
+
# `networkBindings` section [DescribeTasks][1] responses.
|
1219
1250
|
#
|
1220
1251
|
# </note>
|
1252
|
+
#
|
1253
|
+
#
|
1254
|
+
#
|
1255
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html
|
1221
1256
|
# @return [Array<Types::PortMapping>]
|
1222
1257
|
#
|
1223
1258
|
# @!attribute [rw] essential
|
@@ -1259,20 +1294,20 @@ module Aws::ECS
|
|
1259
1294
|
# arguments as `command` array items instead.
|
1260
1295
|
#
|
1261
1296
|
# The entry point that's passed to the container. This parameter maps
|
1262
|
-
# to `Entrypoint` in tthe docker create
|
1297
|
+
# to `Entrypoint` in tthe docker conainer create command and the
|
1263
1298
|
# `--entrypoint` option to docker run.
|
1264
1299
|
# @return [Array<String>]
|
1265
1300
|
#
|
1266
1301
|
# @!attribute [rw] command
|
1267
1302
|
# The command that's passed to the container. This parameter maps to
|
1268
|
-
# `Cmd` in the docker create
|
1303
|
+
# `Cmd` in the docker conainer create command and the `COMMAND`
|
1269
1304
|
# parameter to docker run. If there are multiple arguments, each
|
1270
1305
|
# argument is a separated string in the array.
|
1271
1306
|
# @return [Array<String>]
|
1272
1307
|
#
|
1273
1308
|
# @!attribute [rw] environment
|
1274
1309
|
# The environment variables to pass to a container. This parameter
|
1275
|
-
# maps to `Env` in the docker create
|
1310
|
+
# maps to `Env` in the docker conainer create command and the `--env`
|
1276
1311
|
# option to docker run.
|
1277
1312
|
#
|
1278
1313
|
# We don't recommend that you use plaintext environment variables for
|
@@ -1306,7 +1341,7 @@ module Aws::ECS
|
|
1306
1341
|
# @!attribute [rw] mount_points
|
1307
1342
|
# The mount points for data volumes in your container.
|
1308
1343
|
#
|
1309
|
-
# This parameter maps to `Volumes` in the the docker create
|
1344
|
+
# This parameter maps to `Volumes` in the the docker conainer create
|
1310
1345
|
# command and the `--volume` option to docker run.
|
1311
1346
|
#
|
1312
1347
|
# Windows containers can mount whole directories on the same drive as
|
@@ -1316,18 +1351,22 @@ module Aws::ECS
|
|
1316
1351
|
#
|
1317
1352
|
# @!attribute [rw] volumes_from
|
1318
1353
|
# Data volumes to mount from another container. This parameter maps to
|
1319
|
-
# `VolumesFrom` in tthe docker create
|
1354
|
+
# `VolumesFrom` in tthe docker conainer create command and the
|
1320
1355
|
# `--volumes-from` option to docker run.
|
1321
1356
|
# @return [Array<Types::VolumeFrom>]
|
1322
1357
|
#
|
1323
1358
|
# @!attribute [rw] linux_parameters
|
1324
1359
|
# Linux-specific modifications that are applied to the container, such
|
1325
1360
|
# as Linux kernel capabilities. For more information see
|
1326
|
-
# KernelCapabilities.
|
1361
|
+
# [KernelCapabilities][1].
|
1327
1362
|
#
|
1328
1363
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
1329
1364
|
#
|
1330
1365
|
# </note>
|
1366
|
+
#
|
1367
|
+
#
|
1368
|
+
#
|
1369
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html
|
1331
1370
|
# @return [Types::LinuxParameters]
|
1332
1371
|
#
|
1333
1372
|
# @!attribute [rw] secrets
|
@@ -1462,7 +1501,7 @@ module Aws::ECS
|
|
1462
1501
|
#
|
1463
1502
|
# @!attribute [rw] hostname
|
1464
1503
|
# The hostname to use for your container. This parameter maps to
|
1465
|
-
# `Hostname` in thethe docker create
|
1504
|
+
# `Hostname` in thethe docker conainer create command and the
|
1466
1505
|
# `--hostname` option to docker run.
|
1467
1506
|
#
|
1468
1507
|
# <note markdown="1"> The `hostname` parameter is not supported if you're using the
|
@@ -1473,7 +1512,7 @@ module Aws::ECS
|
|
1473
1512
|
#
|
1474
1513
|
# @!attribute [rw] user
|
1475
1514
|
# The user to use inside the container. This parameter maps to `User`
|
1476
|
-
# in the docker create
|
1515
|
+
# in the docker conainer create command and the `--user` option to
|
1477
1516
|
# docker run.
|
1478
1517
|
#
|
1479
1518
|
# When running tasks using the `host` network mode, don't run
|
@@ -1502,14 +1541,14 @@ module Aws::ECS
|
|
1502
1541
|
#
|
1503
1542
|
# @!attribute [rw] working_directory
|
1504
1543
|
# The working directory to run commands inside the container in. This
|
1505
|
-
# parameter maps to `WorkingDir` in the docker create
|
1506
|
-
#
|
1544
|
+
# parameter maps to `WorkingDir` in the docker conainer create command
|
1545
|
+
# and the `--workdir` option to docker run.
|
1507
1546
|
# @return [String]
|
1508
1547
|
#
|
1509
1548
|
# @!attribute [rw] disable_networking
|
1510
1549
|
# When this parameter is true, networking is off within the container.
|
1511
|
-
# This parameter maps to `NetworkDisabled` in the docker
|
1512
|
-
# create
|
1550
|
+
# This parameter maps to `NetworkDisabled` in the docker conainer
|
1551
|
+
# create command.
|
1513
1552
|
#
|
1514
1553
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
1515
1554
|
#
|
@@ -1520,7 +1559,7 @@ module Aws::ECS
|
|
1520
1559
|
# When this parameter is true, the container is given elevated
|
1521
1560
|
# privileges on the host container instance (similar to the `root`
|
1522
1561
|
# user). This parameter maps to `Privileged` in the the docker
|
1523
|
-
# create
|
1562
|
+
# conainer create command and the `--privileged` option to docker run
|
1524
1563
|
#
|
1525
1564
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
1526
1565
|
# on Fargate.
|
@@ -1531,7 +1570,7 @@ module Aws::ECS
|
|
1531
1570
|
# @!attribute [rw] readonly_root_filesystem
|
1532
1571
|
# When this parameter is true, the container is given read-only access
|
1533
1572
|
# to its root file system. This parameter maps to `ReadonlyRootfs` in
|
1534
|
-
# the docker create
|
1573
|
+
# the docker conainer create command and the `--read-only` option to
|
1535
1574
|
# docker run.
|
1536
1575
|
#
|
1537
1576
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
@@ -1541,7 +1580,7 @@ module Aws::ECS
|
|
1541
1580
|
#
|
1542
1581
|
# @!attribute [rw] dns_servers
|
1543
1582
|
# A list of DNS servers that are presented to the container. This
|
1544
|
-
# parameter maps to `Dns` in the the docker create
|
1583
|
+
# parameter maps to `Dns` in the the docker conainer create command
|
1545
1584
|
# and the `--dns` option to docker run.
|
1546
1585
|
#
|
1547
1586
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
@@ -1551,7 +1590,7 @@ module Aws::ECS
|
|
1551
1590
|
#
|
1552
1591
|
# @!attribute [rw] dns_search_domains
|
1553
1592
|
# A list of DNS search domains that are presented to the container.
|
1554
|
-
# This parameter maps to `DnsSearch` in the docker create
|
1593
|
+
# This parameter maps to `DnsSearch` in the docker conainer create
|
1555
1594
|
# command and the `--dns-search` option to docker run.
|
1556
1595
|
#
|
1557
1596
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
@@ -1562,7 +1601,7 @@ module Aws::ECS
|
|
1562
1601
|
# @!attribute [rw] extra_hosts
|
1563
1602
|
# A list of hostnames and IP address mappings to append to the
|
1564
1603
|
# `/etc/hosts` file on the container. This parameter maps to
|
1565
|
-
# `ExtraHosts` in the docker create
|
1604
|
+
# `ExtraHosts` in the docker conainer create command and the
|
1566
1605
|
# `--add-host` option to docker run.
|
1567
1606
|
#
|
1568
1607
|
# <note markdown="1"> This parameter isn't supported for Windows containers or tasks that
|
@@ -1585,7 +1624,7 @@ module Aws::ECS
|
|
1585
1624
|
# Windows Containers][1] and [Using gMSAs for Linux Containers][2] in
|
1586
1625
|
# the *Amazon Elastic Container Service Developer Guide*.
|
1587
1626
|
#
|
1588
|
-
# This parameter maps to `SecurityOpt` in the docker create
|
1627
|
+
# This parameter maps to `SecurityOpt` in the docker conainer create
|
1589
1628
|
# command and the `--security-opt` option to docker run.
|
1590
1629
|
#
|
1591
1630
|
# <note markdown="1"> The Amazon ECS container agent running on a container instance must
|
@@ -1610,19 +1649,19 @@ module Aws::ECS
|
|
1610
1649
|
# @!attribute [rw] interactive
|
1611
1650
|
# When this parameter is `true`, you can deploy containerized
|
1612
1651
|
# applications that require `stdin` or a `tty` to be allocated. This
|
1613
|
-
# parameter maps to `OpenStdin` in the docker create
|
1652
|
+
# parameter maps to `OpenStdin` in the docker conainer create command
|
1614
1653
|
# and the `--interactive` option to docker run.
|
1615
1654
|
# @return [Boolean]
|
1616
1655
|
#
|
1617
1656
|
# @!attribute [rw] pseudo_terminal
|
1618
1657
|
# When this parameter is `true`, a TTY is allocated. This parameter
|
1619
|
-
# maps to `Tty` in tthe docker create
|
1620
|
-
#
|
1658
|
+
# maps to `Tty` in tthe docker conainer create command and the `--tty`
|
1659
|
+
# option to docker run.
|
1621
1660
|
# @return [Boolean]
|
1622
1661
|
#
|
1623
1662
|
# @!attribute [rw] docker_labels
|
1624
1663
|
# A key/value map of labels to add to the container. This parameter
|
1625
|
-
# maps to `Labels` in the docker create
|
1664
|
+
# maps to `Labels` in the docker conainer create command and the
|
1626
1665
|
# `--label` option to docker run. This parameter requires version 1.18
|
1627
1666
|
# of the Docker Remote API or greater on your container instance. To
|
1628
1667
|
# check the Docker Remote API version on your container instance, log
|
@@ -1633,9 +1672,9 @@ module Aws::ECS
|
|
1633
1672
|
# @!attribute [rw] ulimits
|
1634
1673
|
# A list of `ulimits` to set in the container. If a `ulimit` value is
|
1635
1674
|
# specified in a task definition, it overrides the default values set
|
1636
|
-
# by Docker. This parameter maps to `Ulimits` in tthe docker
|
1637
|
-
# create
|
1638
|
-
#
|
1675
|
+
# by Docker. This parameter maps to `Ulimits` in tthe docker conainer
|
1676
|
+
# create command and the `--ulimit` option to docker run. Valid naming
|
1677
|
+
# values are displayed in the [Ulimit][1] data type.
|
1639
1678
|
#
|
1640
1679
|
# Amazon ECS tasks hosted on Fargate use the default resource limit
|
1641
1680
|
# values set by the operating system with the exception of the
|
@@ -1653,12 +1692,16 @@ module Aws::ECS
|
|
1653
1692
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
1654
1693
|
#
|
1655
1694
|
# </note>
|
1695
|
+
#
|
1696
|
+
#
|
1697
|
+
#
|
1698
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html
|
1656
1699
|
# @return [Array<Types::Ulimit>]
|
1657
1700
|
#
|
1658
1701
|
# @!attribute [rw] log_configuration
|
1659
1702
|
# The log configuration specification for the container.
|
1660
1703
|
#
|
1661
|
-
# This parameter maps to `LogConfig` in the docker create
|
1704
|
+
# This parameter maps to `LogConfig` in the docker conainer create
|
1662
1705
|
# command and the `--log-driver` option to docker run. By default,
|
1663
1706
|
# containers use the same logging driver that the Docker daemon uses.
|
1664
1707
|
# However the container can use a different logging driver than the
|
@@ -1669,9 +1712,9 @@ module Aws::ECS
|
|
1669
1712
|
# options).
|
1670
1713
|
#
|
1671
1714
|
# <note markdown="1"> Amazon ECS currently supports a subset of the logging drivers
|
1672
|
-
# available to the Docker daemon (shown in the LogConfiguration
|
1673
|
-
# type). Additional log drivers may be available in future
|
1674
|
-
# the Amazon ECS container agent.
|
1715
|
+
# available to the Docker daemon (shown in the [LogConfiguration][1]
|
1716
|
+
# data type). Additional log drivers may be available in future
|
1717
|
+
# releases of the Amazon ECS container agent.
|
1675
1718
|
#
|
1676
1719
|
# </note>
|
1677
1720
|
#
|
@@ -1686,26 +1729,27 @@ module Aws::ECS
|
|
1686
1729
|
# `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before
|
1687
1730
|
# containers placed on that instance can use these log configuration
|
1688
1731
|
# options. For more information, see [Amazon ECS Container Agent
|
1689
|
-
# Configuration][
|
1732
|
+
# Configuration][2] in the *Amazon Elastic Container Service Developer
|
1690
1733
|
# Guide*.
|
1691
1734
|
#
|
1692
1735
|
# </note>
|
1693
1736
|
#
|
1694
1737
|
#
|
1695
1738
|
#
|
1696
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/
|
1739
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html
|
1740
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html
|
1697
1741
|
# @return [Types::LogConfiguration]
|
1698
1742
|
#
|
1699
1743
|
# @!attribute [rw] health_check
|
1700
1744
|
# The container health check command and associated configuration
|
1701
1745
|
# parameters for the container. This parameter maps to `HealthCheck`
|
1702
|
-
# in the docker create
|
1746
|
+
# in the docker conainer create command and the `HEALTHCHECK`
|
1703
1747
|
# parameter of docker run.
|
1704
1748
|
# @return [Types::HealthCheck]
|
1705
1749
|
#
|
1706
1750
|
# @!attribute [rw] system_controls
|
1707
1751
|
# A list of namespaced kernel parameters to set in the container. This
|
1708
|
-
# parameter maps to `Sysctls` in tthe docker create
|
1752
|
+
# parameter maps to `Sysctls` in tthe docker conainer create command
|
1709
1753
|
# and the `--sysctl` option to docker run. For example, you can
|
1710
1754
|
# configure `net.ipv4.tcp_keepalive_time` setting to maintain longer
|
1711
1755
|
# lived connections.
|
@@ -2016,7 +2060,11 @@ module Aws::ECS
|
|
2016
2060
|
# @!attribute [rw] attributes
|
2017
2061
|
# The attributes set for the container instance, either by the Amazon
|
2018
2062
|
# ECS container agent at instance registration or manually with the
|
2019
|
-
# PutAttributes operation.
|
2063
|
+
# [PutAttributes][1] operation.
|
2064
|
+
#
|
2065
|
+
#
|
2066
|
+
#
|
2067
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAttributes.html
|
2020
2068
|
# @return [Array<Types::Attribute>]
|
2021
2069
|
#
|
2022
2070
|
# @!attribute [rw] registered_at
|
@@ -2381,7 +2429,12 @@ module Aws::ECS
|
|
2381
2429
|
# The setting to use when creating a cluster. This parameter is used
|
2382
2430
|
# to turn on CloudWatch Container Insights for a cluster. If this
|
2383
2431
|
# value is specified, it overrides the `containerInsights` value set
|
2384
|
-
# with PutAccountSetting or PutAccountSettingDefault.
|
2432
|
+
# with [PutAccountSetting][1] or [PutAccountSettingDefault][2].
|
2433
|
+
#
|
2434
|
+
#
|
2435
|
+
#
|
2436
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html
|
2437
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html
|
2385
2438
|
# @return [Array<Types::ClusterSetting>]
|
2386
2439
|
#
|
2387
2440
|
# @!attribute [rw] configuration
|
@@ -2426,12 +2479,13 @@ module Aws::ECS
|
|
2426
2479
|
#
|
2427
2480
|
# If a default capacity provider strategy isn't defined for a cluster
|
2428
2481
|
# when it was created, it can be defined later with the
|
2429
|
-
# PutClusterCapacityProviders API operation.
|
2482
|
+
# [PutClusterCapacityProviders][3] API operation.
|
2430
2483
|
#
|
2431
2484
|
#
|
2432
2485
|
#
|
2433
2486
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html
|
2434
2487
|
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html
|
2488
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
2435
2489
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
2436
2490
|
#
|
2437
2491
|
# @!attribute [rw] service_connect_defaults
|
@@ -2997,9 +3051,10 @@ module Aws::ECS
|
|
2997
3051
|
# A capacity provider strategy consists of one or more capacity
|
2998
3052
|
# providers along with the `base` and `weight` to assign to them. A
|
2999
3053
|
# capacity provider must be associated with the cluster to be used in
|
3000
|
-
# a capacity provider strategy. The PutClusterCapacityProviders
|
3001
|
-
# used to associate a capacity provider with a cluster. Only
|
3002
|
-
# providers with an `ACTIVE` or `UPDATING` status can be
|
3054
|
+
# a capacity provider strategy. The [PutClusterCapacityProviders][1]
|
3055
|
+
# API is used to associate a capacity provider with a cluster. Only
|
3056
|
+
# capacity providers with an `ACTIVE` or `UPDATING` status can be
|
3057
|
+
# used.
|
3003
3058
|
#
|
3004
3059
|
# If a `capacityProviderStrategy` is specified, the `launchType`
|
3005
3060
|
# parameter must be omitted. If no `capacityProviderStrategy` or
|
@@ -3008,17 +3063,22 @@ module Aws::ECS
|
|
3008
3063
|
#
|
3009
3064
|
# If specifying a capacity provider that uses an Auto Scaling group,
|
3010
3065
|
# the capacity provider must already be created. New capacity
|
3011
|
-
# providers can be created with the
|
3012
|
-
# operation.
|
3066
|
+
# providers can be created with the
|
3067
|
+
# [CreateCapacityProviderProvider][2]API operation.
|
3013
3068
|
#
|
3014
3069
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
3015
3070
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
3016
3071
|
# are available to all accounts and only need to be associated with a
|
3017
3072
|
# cluster to be used.
|
3018
3073
|
#
|
3019
|
-
# The PutClusterCapacityProviders API operation is used to update
|
3020
|
-
# list of available capacity providers for a cluster after the
|
3021
|
-
# is created.
|
3074
|
+
# The [PutClusterCapacityProviders][1] API operation is used to update
|
3075
|
+
# the list of available capacity providers for a cluster after the
|
3076
|
+
# cluster is created.
|
3077
|
+
#
|
3078
|
+
#
|
3079
|
+
#
|
3080
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
3081
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProviderProvider.html
|
3022
3082
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
3023
3083
|
#
|
3024
3084
|
# @!attribute [rw] platform_version
|
@@ -3466,7 +3526,11 @@ module Aws::ECS
|
|
3466
3526
|
# state. If the service fails to reach a steady state and circuit
|
3467
3527
|
# breaker is turned on, the deployment transitions to a `FAILED`
|
3468
3528
|
# state. A deployment in `FAILED` state doesn't launch any new tasks.
|
3469
|
-
# For more information, see DeploymentCircuitBreaker.
|
3529
|
+
# For more information, see [DeploymentCircuitBreaker][1].
|
3530
|
+
#
|
3531
|
+
#
|
3532
|
+
#
|
3533
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeploymentCircuitBreaker.html
|
3470
3534
|
# @return [String]
|
3471
3535
|
#
|
3472
3536
|
# @!attribute [rw] rollout_state_reason
|
@@ -3780,7 +3844,8 @@ module Aws::ECS
|
|
3780
3844
|
# The number of containers Amazon ECS adds or removes from the
|
3781
3845
|
# service during a rolling update is controlled by adjusting the
|
3782
3846
|
# minimum and maximum number of healthy tasks allowed during a
|
3783
|
-
# service deployment, as specified in the
|
3847
|
+
# service deployment, as specified in the
|
3848
|
+
# [DeploymentConfiguration][1].
|
3784
3849
|
#
|
3785
3850
|
# CODE\_DEPLOY
|
3786
3851
|
#
|
@@ -3794,6 +3859,10 @@ module Aws::ECS
|
|
3794
3859
|
# : The external (`EXTERNAL`) deployment type enables you to use any
|
3795
3860
|
# third-party deployment controller for full control over the
|
3796
3861
|
# deployment process for an Amazon ECS service.
|
3862
|
+
#
|
3863
|
+
#
|
3864
|
+
#
|
3865
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeploymentConfiguration.html
|
3797
3866
|
# @return [String]
|
3798
3867
|
#
|
3799
3868
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeploymentController AWS API Documentation
|
@@ -4392,7 +4461,7 @@ module Aws::ECS
|
|
4392
4461
|
# use `docker plugin ls` to retrieve the driver name from your
|
4393
4462
|
# container instance. If the driver was installed using another
|
4394
4463
|
# method, use Docker plugin discovery to retrieve the driver name.
|
4395
|
-
# This parameter maps to `Driver` in the docker create
|
4464
|
+
# This parameter maps to `Driver` in the docker conainer create
|
4396
4465
|
# command and the `xxdriver` option to docker volume create.
|
4397
4466
|
# @return [String]
|
4398
4467
|
#
|
@@ -4404,7 +4473,7 @@ module Aws::ECS
|
|
4404
4473
|
#
|
4405
4474
|
# @!attribute [rw] labels
|
4406
4475
|
# Custom metadata to add to your Docker volume. This parameter maps to
|
4407
|
-
# `Labels` in the docker create
|
4476
|
+
# `Labels` in the docker conainer create command and the `xxlabel`
|
4408
4477
|
# option to docker volume create.
|
4409
4478
|
# @return [Hash<String,String>]
|
4410
4479
|
#
|
@@ -5134,7 +5203,7 @@ module Aws::ECS
|
|
5134
5203
|
#
|
5135
5204
|
# An exit code of 0 indicates success, and non-zero exit code
|
5136
5205
|
# indicates failure. For more information, see `HealthCheck` in tthe
|
5137
|
-
# docker create
|
5206
|
+
# docker conainer create command
|
5138
5207
|
# @return [Array<String>]
|
5139
5208
|
#
|
5140
5209
|
# @!attribute [rw] interval
|
@@ -5182,7 +5251,11 @@ module Aws::ECS
|
|
5182
5251
|
|
5183
5252
|
# Hostnames and IP address entries that are added to the `/etc/hosts`
|
5184
5253
|
# file of a container via the `extraHosts` parameter of its
|
5185
|
-
# ContainerDefinition.
|
5254
|
+
# [ContainerDefinition][1].
|
5255
|
+
#
|
5256
|
+
#
|
5257
|
+
#
|
5258
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html
|
5186
5259
|
#
|
5187
5260
|
# @!attribute [rw] hostname
|
5188
5261
|
# The hostname to use in the `/etc/hosts` entry.
|
@@ -5337,7 +5410,7 @@ module Aws::ECS
|
|
5337
5410
|
# @!attribute [rw] add
|
5338
5411
|
# The Linux capabilities for the container that have been added to the
|
5339
5412
|
# default configuration provided by Docker. This parameter maps to
|
5340
|
-
# `CapAdd` in the docker create
|
5413
|
+
# `CapAdd` in the docker conainer create command and the `--cap-add`
|
5341
5414
|
# option to docker run.
|
5342
5415
|
#
|
5343
5416
|
# <note markdown="1"> Tasks launched on Fargate only support adding the `SYS_PTRACE`
|
@@ -5359,8 +5432,8 @@ module Aws::ECS
|
|
5359
5432
|
# @!attribute [rw] drop
|
5360
5433
|
# The Linux capabilities for the container that have been removed from
|
5361
5434
|
# the default configuration provided by Docker. This parameter maps to
|
5362
|
-
# `CapDrop` in the docker create
|
5363
|
-
#
|
5435
|
+
# `CapDrop` in the docker conainer create command and the `--cap-drop`
|
5436
|
+
# option to docker run.
|
5364
5437
|
#
|
5365
5438
|
# Valid values: `"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" |
|
5366
5439
|
# "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" |
|
@@ -5429,7 +5502,7 @@ module Aws::ECS
|
|
5429
5502
|
#
|
5430
5503
|
# @!attribute [rw] devices
|
5431
5504
|
# Any host devices to expose to the container. This parameter maps to
|
5432
|
-
# `Devices` in tthe docker create
|
5505
|
+
# `Devices` in tthe docker conainer create command and the `--device`
|
5433
5506
|
# option to docker run.
|
5434
5507
|
#
|
5435
5508
|
# <note markdown="1"> If you're using tasks that use the Fargate launch type, the
|
@@ -5441,15 +5514,11 @@ module Aws::ECS
|
|
5441
5514
|
# @!attribute [rw] init_process_enabled
|
5442
5515
|
# Run an `init` process inside the container that forwards signals and
|
5443
5516
|
# reaps processes. This parameter maps to the `--init` option to
|
5444
|
-
#
|
5517
|
+
# docker run. This parameter requires version 1.25 of the Docker
|
5445
5518
|
# Remote API or greater on your container instance. To check the
|
5446
5519
|
# Docker Remote API version on your container instance, log in to your
|
5447
5520
|
# container instance and run the following command: `sudo docker
|
5448
5521
|
# version --format '\{\{.Server.APIVersion\}\}'`
|
5449
|
-
#
|
5450
|
-
#
|
5451
|
-
#
|
5452
|
-
# [1]: https://docs.docker.com/engine/reference/run/#security-configuration
|
5453
5522
|
# @return [Boolean]
|
5454
5523
|
#
|
5455
5524
|
# @!attribute [rw] shared_memory_size
|
@@ -5474,9 +5543,9 @@ module Aws::ECS
|
|
5474
5543
|
#
|
5475
5544
|
# @!attribute [rw] max_swap
|
5476
5545
|
# The total amount of swap memory (in MiB) a container can use. This
|
5477
|
-
# parameter will be translated to the `--memory-swap` option to
|
5478
|
-
#
|
5479
|
-
#
|
5546
|
+
# parameter will be translated to the `--memory-swap` option to docker
|
5547
|
+
# run where the value would be the sum of the container memory plus
|
5548
|
+
# the `maxSwap` value.
|
5480
5549
|
#
|
5481
5550
|
# If a `maxSwap` value of `0` is specified, the container will not use
|
5482
5551
|
# swap. Accepted values are `0` or any positive integer. If the
|
@@ -5492,10 +5561,6 @@ module Aws::ECS
|
|
5492
5561
|
# parameter isn't supported.
|
5493
5562
|
#
|
5494
5563
|
# </note>
|
5495
|
-
#
|
5496
|
-
#
|
5497
|
-
#
|
5498
|
-
# [1]: https://docs.docker.com/engine/reference/run/#security-configuration
|
5499
5564
|
# @return [Integer]
|
5500
5565
|
#
|
5501
5566
|
# @!attribute [rw] swappiness
|
@@ -5795,9 +5860,13 @@ module Aws::ECS
|
|
5795
5860
|
# Filters the container instances by status. For example, if you
|
5796
5861
|
# specify the `DRAINING` status, the results include only container
|
5797
5862
|
# instances that have been set to `DRAINING` using
|
5798
|
-
# UpdateContainerInstancesState. If you don't specify this
|
5799
|
-
# the default is to include container instances set to all
|
5800
|
-
# other than `INACTIVE`.
|
5863
|
+
# [UpdateContainerInstancesState][1]. If you don't specify this
|
5864
|
+
# parameter, the default is to include container instances set to all
|
5865
|
+
# states other than `INACTIVE`.
|
5866
|
+
#
|
5867
|
+
#
|
5868
|
+
#
|
5869
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateContainerInstancesState.html
|
5801
5870
|
# @return [String]
|
5802
5871
|
#
|
5803
5872
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListContainerInstancesRequest AWS API Documentation
|
@@ -6364,7 +6433,7 @@ module Aws::ECS
|
|
6364
6433
|
end
|
6365
6434
|
|
6366
6435
|
# The log configuration for the container. This parameter maps to
|
6367
|
-
# `LogConfig` in the docker create
|
6436
|
+
# `LogConfig` in the docker conainer create command and the
|
6368
6437
|
# `--log-driver` option to docker run.
|
6369
6438
|
#
|
6370
6439
|
# By default, containers use the same logging driver that the Docker
|
@@ -6580,9 +6649,8 @@ module Aws::ECS
|
|
6580
6649
|
#
|
6581
6650
|
# @!attribute [rw] maximum_scaling_step_size
|
6582
6651
|
# The maximum number of Amazon EC2 instances that Amazon ECS will
|
6583
|
-
# scale out at one time.
|
6584
|
-
#
|
6585
|
-
# `10000` is used.
|
6652
|
+
# scale out at one time. If this parameter is omitted, the default
|
6653
|
+
# value of `10000` is used.
|
6586
6654
|
# @return [Integer]
|
6587
6655
|
#
|
6588
6656
|
# @!attribute [rw] instance_warmup_period
|
@@ -6672,7 +6740,11 @@ module Aws::ECS
|
|
6672
6740
|
# Details on the network bindings between a container and its host
|
6673
6741
|
# container instance. After a task reaches the `RUNNING` status, manual
|
6674
6742
|
# and automatic host and container port assignments are visible in the
|
6675
|
-
# `networkBindings` section of DescribeTasks API responses.
|
6743
|
+
# `networkBindings` section of [DescribeTasks][1] API responses.
|
6744
|
+
#
|
6745
|
+
#
|
6746
|
+
#
|
6747
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html
|
6676
6748
|
#
|
6677
6749
|
# @!attribute [rw] bind_ip
|
6678
6750
|
# The IP address that the container is bound to on the container
|
@@ -6950,7 +7022,7 @@ module Aws::ECS
|
|
6950
7022
|
# can be left blank or it must be the same value as the `containerPort`.
|
6951
7023
|
#
|
6952
7024
|
# Most fields of this parameter (`containerPort`, `hostPort`,
|
6953
|
-
# `protocol`) maps to `PortBindings` in the docker create
|
7025
|
+
# `protocol`) maps to `PortBindings` in the docker conainer create
|
6954
7026
|
# command and the `--publish` option to `docker run`. If the network
|
6955
7027
|
# mode of a task definition is set to `host`, host ports must either be
|
6956
7028
|
# undefined or match the container port in the port mapping.
|
@@ -6962,7 +7034,11 @@ module Aws::ECS
|
|
6962
7034
|
#
|
6963
7035
|
# After a task reaches the `RUNNING` status, manual and automatic host
|
6964
7036
|
# and container port assignments are visible in the `networkBindings`
|
6965
|
-
# section of DescribeTasks API responses.
|
7037
|
+
# section of [DescribeTasks][1] API responses.
|
7038
|
+
#
|
7039
|
+
#
|
7040
|
+
#
|
7041
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html
|
6966
7042
|
#
|
6967
7043
|
# @!attribute [rw] container_port
|
6968
7044
|
# The port number on the container that's bound to the user-specified
|
@@ -7159,8 +7235,13 @@ module Aws::ECS
|
|
7159
7235
|
end
|
7160
7236
|
|
7161
7237
|
# An object representing the protection status details for a task. You
|
7162
|
-
# can set the protection status with the UpdateTaskProtection API
|
7163
|
-
# get the status of tasks with the GetTaskProtection API.
|
7238
|
+
# can set the protection status with the [UpdateTaskProtection][1] API
|
7239
|
+
# and get the status of tasks with the [GetTaskProtection][2] API.
|
7240
|
+
#
|
7241
|
+
#
|
7242
|
+
#
|
7243
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateTaskProtection.html
|
7244
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_GetTaskProtection.html
|
7164
7245
|
#
|
7165
7246
|
# @!attribute [rw] task_arn
|
7166
7247
|
# The task ARN.
|
@@ -7580,13 +7661,17 @@ module Aws::ECS
|
|
7580
7661
|
#
|
7581
7662
|
# If specifying a capacity provider that uses an Auto Scaling group,
|
7582
7663
|
# the capacity provider must already be created. New capacity
|
7583
|
-
# providers can be created with the CreateCapacityProvider API
|
7664
|
+
# providers can be created with the [CreateCapacityProvider][1] API
|
7584
7665
|
# operation.
|
7585
7666
|
#
|
7586
7667
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
7587
7668
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
7588
7669
|
# are available to all accounts and only need to be associated with a
|
7589
7670
|
# cluster to be used.
|
7671
|
+
#
|
7672
|
+
#
|
7673
|
+
#
|
7674
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html
|
7590
7675
|
# @return [Array<String>]
|
7591
7676
|
#
|
7592
7677
|
# @!attribute [rw] default_capacity_provider_strategy
|
@@ -7599,19 +7684,25 @@ module Aws::ECS
|
|
7599
7684
|
# A capacity provider strategy consists of one or more capacity
|
7600
7685
|
# providers along with the `base` and `weight` to assign to them. A
|
7601
7686
|
# capacity provider must be associated with the cluster to be used in
|
7602
|
-
# a capacity provider strategy. The PutClusterCapacityProviders
|
7603
|
-
# used to associate a capacity provider with a cluster. Only
|
7604
|
-
# providers with an `ACTIVE` or `UPDATING` status can be
|
7687
|
+
# a capacity provider strategy. The [PutClusterCapacityProviders][1]
|
7688
|
+
# API is used to associate a capacity provider with a cluster. Only
|
7689
|
+
# capacity providers with an `ACTIVE` or `UPDATING` status can be
|
7690
|
+
# used.
|
7605
7691
|
#
|
7606
7692
|
# If specifying a capacity provider that uses an Auto Scaling group,
|
7607
7693
|
# the capacity provider must already be created. New capacity
|
7608
|
-
# providers can be created with the CreateCapacityProvider API
|
7694
|
+
# providers can be created with the [CreateCapacityProvider][2] API
|
7609
7695
|
# operation.
|
7610
7696
|
#
|
7611
7697
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
7612
7698
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
7613
7699
|
# are available to all accounts and only need to be associated with a
|
7614
7700
|
# cluster to be used.
|
7701
|
+
#
|
7702
|
+
#
|
7703
|
+
#
|
7704
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
7705
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html
|
7615
7706
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
7616
7707
|
#
|
7617
7708
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutClusterCapacityProvidersRequest AWS API Documentation
|
@@ -8384,12 +8475,17 @@ module Aws::ECS
|
|
8384
8475
|
# Specifies whether to propagate the tags from the task definition to
|
8385
8476
|
# the task. If no value is specified, the tags aren't propagated.
|
8386
8477
|
# Tags can only be propagated to the task during task creation. To add
|
8387
|
-
# tags to a task after task creation, use the
|
8478
|
+
# tags to a task after task creation, use the[TagResource][1] API
|
8479
|
+
# action.
|
8388
8480
|
#
|
8389
8481
|
# <note markdown="1"> An error will be received if you specify the `SERVICE` option when
|
8390
8482
|
# running a task.
|
8391
8483
|
#
|
8392
8484
|
# </note>
|
8485
|
+
#
|
8486
|
+
#
|
8487
|
+
#
|
8488
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html
|
8393
8489
|
# @return [String]
|
8394
8490
|
#
|
8395
8491
|
# @!attribute [rw] reference_id
|
@@ -8720,8 +8816,13 @@ module Aws::ECS
|
|
8720
8816
|
# @!attribute [rw] desired_count
|
8721
8817
|
# The desired number of instantiations of the task definition to keep
|
8722
8818
|
# running on the service. This value is specified when the service is
|
8723
|
-
# created with CreateService, and it can be modified with
|
8724
|
-
# UpdateService.
|
8819
|
+
# created with [CreateService][1] , and it can be modified with
|
8820
|
+
# [UpdateService][2].
|
8821
|
+
#
|
8822
|
+
#
|
8823
|
+
#
|
8824
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html
|
8825
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
8725
8826
|
# @return [Integer]
|
8726
8827
|
#
|
8727
8828
|
# @!attribute [rw] running_count
|
@@ -8767,8 +8868,13 @@ module Aws::ECS
|
|
8767
8868
|
#
|
8768
8869
|
# @!attribute [rw] task_definition
|
8769
8870
|
# The task definition to use for tasks in the service. This value is
|
8770
|
-
# specified when the service is created with CreateService, and
|
8771
|
-
# be modified with UpdateService.
|
8871
|
+
# specified when the service is created with [CreateService][1], and
|
8872
|
+
# it can be modified with [UpdateService][2].
|
8873
|
+
#
|
8874
|
+
#
|
8875
|
+
#
|
8876
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html
|
8877
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
8772
8878
|
# @return [String]
|
8773
8879
|
#
|
8774
8880
|
# @!attribute [rw] deployment_configuration
|
@@ -9069,7 +9175,7 @@ module Aws::ECS
|
|
9069
9175
|
#
|
9070
9176
|
# @!attribute [rw] log_configuration
|
9071
9177
|
# The log configuration for the container. This parameter maps to
|
9072
|
-
# `LogConfig` in the docker create
|
9178
|
+
# `LogConfig` in the docker conainer create command and the
|
9073
9179
|
# `--log-driver` option to docker run.
|
9074
9180
|
#
|
9075
9181
|
# By default, containers use the same logging driver that the Docker
|
@@ -9503,15 +9609,23 @@ module Aws::ECS
|
|
9503
9609
|
|
9504
9610
|
# The specified service isn't active. You can't update a service
|
9505
9611
|
# that's inactive. If you have previously deleted a service, you can
|
9506
|
-
# re-create it with CreateService.
|
9612
|
+
# re-create it with [CreateService][1].
|
9613
|
+
#
|
9614
|
+
#
|
9615
|
+
#
|
9616
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html
|
9507
9617
|
#
|
9508
9618
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceNotActiveException AWS API Documentation
|
9509
9619
|
#
|
9510
9620
|
class ServiceNotActiveException < Aws::EmptyStructure; end
|
9511
9621
|
|
9512
9622
|
# The specified service wasn't found. You can view your available
|
9513
|
-
# services with ListServices. Amazon ECS services are cluster
|
9514
|
-
# and Region specific.
|
9623
|
+
# services with [ListServices][1]. Amazon ECS services are cluster
|
9624
|
+
# specific and Region specific.
|
9625
|
+
#
|
9626
|
+
#
|
9627
|
+
#
|
9628
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html
|
9515
9629
|
#
|
9516
9630
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceNotFoundException AWS API Documentation
|
9517
9631
|
#
|
@@ -9851,7 +9965,12 @@ module Aws::ECS
|
|
9851
9965
|
# An optional message specified when a task is stopped. For example,
|
9852
9966
|
# if you're using a custom scheduler, you can use this parameter to
|
9853
9967
|
# specify the reason for stopping the task here, and the message
|
9854
|
-
# appears in subsequent DescribeTasks API operations on this
|
9968
|
+
# appears in subsequent [DescribeTasks][1]> API operations on this
|
9969
|
+
# task.
|
9970
|
+
#
|
9971
|
+
#
|
9972
|
+
#
|
9973
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html
|
9855
9974
|
# @return [String]
|
9856
9975
|
#
|
9857
9976
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StopTaskRequest AWS API Documentation
|
@@ -10039,10 +10158,10 @@ module Aws::ECS
|
|
10039
10158
|
end
|
10040
10159
|
|
10041
10160
|
# A list of namespaced kernel parameters to set in the container. This
|
10042
|
-
# parameter maps to `Sysctls` in tthe docker create
|
10043
|
-
#
|
10044
|
-
#
|
10045
|
-
#
|
10161
|
+
# parameter maps to `Sysctls` in tthe docker conainer create command and
|
10162
|
+
# the `--sysctl` option to docker run. For example, you can configure
|
10163
|
+
# `net.ipv4.tcp_keepalive_time` setting to maintain longer lived
|
10164
|
+
# connections.
|
10046
10165
|
#
|
10047
10166
|
# We don't recommend that you specify network-related `systemControls`
|
10048
10167
|
# parameters for multiple containers in a single task that also uses
|
@@ -10744,10 +10863,11 @@ module Aws::ECS
|
|
10744
10863
|
# Amazon EC2 instance is registered to your cluster, the Amazon ECS
|
10745
10864
|
# container agent assigns some standard attributes to the instance.
|
10746
10865
|
# You can apply custom attributes. These are specified as key-value
|
10747
|
-
# pairs using the Amazon ECS console or the PutAttributes API.
|
10748
|
-
# attributes are used when determining task placement for tasks
|
10749
|
-
# on Amazon EC2 instances. For more information, see
|
10750
|
-
# in the *Amazon Elastic Container Service Developer
|
10866
|
+
# pairs using the Amazon ECS console or the [PutAttributes][1] API.
|
10867
|
+
# These attributes are used when determining task placement for tasks
|
10868
|
+
# hosted on Amazon EC2 instances. For more information, see
|
10869
|
+
# [Attributes][2] in the *Amazon Elastic Container Service Developer
|
10870
|
+
# Guide*.
|
10751
10871
|
#
|
10752
10872
|
# <note markdown="1"> This parameter isn't supported for tasks run on Fargate.
|
10753
10873
|
#
|
@@ -10755,7 +10875,8 @@ module Aws::ECS
|
|
10755
10875
|
#
|
10756
10876
|
#
|
10757
10877
|
#
|
10758
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/
|
10878
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAttributes.html
|
10879
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes
|
10759
10880
|
# @return [Array<Types::Attribute>]
|
10760
10881
|
#
|
10761
10882
|
# @!attribute [rw] placement_constraints
|
@@ -11608,8 +11729,12 @@ module Aws::ECS
|
|
11608
11729
|
end
|
11609
11730
|
|
11610
11731
|
# The specified task set wasn't found. You can view your available task
|
11611
|
-
# sets with DescribeTaskSets. Task sets are specific to each
|
11612
|
-
# service and Region.
|
11732
|
+
# sets with [DescribeTaskSets][1]. Task sets are specific to each
|
11733
|
+
# cluster, service and Region.
|
11734
|
+
#
|
11735
|
+
#
|
11736
|
+
#
|
11737
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTaskSets.html
|
11613
11738
|
#
|
11614
11739
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TaskSetNotFoundException AWS API Documentation
|
11615
11740
|
#
|
@@ -11868,7 +11993,7 @@ module Aws::ECS
|
|
11868
11993
|
# The setting to use by default for a cluster. This parameter is used
|
11869
11994
|
# to turn on CloudWatch Container Insights for a cluster. If this
|
11870
11995
|
# value is specified, it overrides the `containerInsights` value set
|
11871
|
-
# with PutAccountSetting or PutAccountSettingDefault.
|
11996
|
+
# with [PutAccountSetting][1] or [PutAccountSettingDefault][2].
|
11872
11997
|
#
|
11873
11998
|
# Currently, if you delete an existing cluster that does not have
|
11874
11999
|
# Container Insights turned on, and then create a new cluster with the
|
@@ -11876,6 +12001,11 @@ module Aws::ECS
|
|
11876
12001
|
# not actually be turned on. If you want to preserve the same name for
|
11877
12002
|
# your existing cluster and turn on Container Insights, you must wait
|
11878
12003
|
# 7 days before you can re-create it.
|
12004
|
+
#
|
12005
|
+
#
|
12006
|
+
#
|
12007
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html
|
12008
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html
|
11879
12009
|
# @return [Array<Types::ClusterSetting>]
|
11880
12010
|
#
|
11881
12011
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateClusterSettingsRequest AWS API Documentation
|
@@ -12065,23 +12195,31 @@ module Aws::ECS
|
|
12065
12195
|
# A capacity provider strategy consists of one or more capacity
|
12066
12196
|
# providers along with the `base` and `weight` to assign to them. A
|
12067
12197
|
# capacity provider must be associated with the cluster to be used in
|
12068
|
-
# a capacity provider strategy. The PutClusterCapacityProviders
|
12069
|
-
# used to associate a capacity provider with a cluster. Only
|
12070
|
-
# providers with an `ACTIVE` or `UPDATING` status can be
|
12198
|
+
# a capacity provider strategy. The [PutClusterCapacityProviders][1]
|
12199
|
+
# API is used to associate a capacity provider with a cluster. Only
|
12200
|
+
# capacity providers with an `ACTIVE` or `UPDATING` status can be
|
12201
|
+
# used.
|
12071
12202
|
#
|
12072
12203
|
# If specifying a capacity provider that uses an Auto Scaling group,
|
12073
12204
|
# the capacity provider must already be created. New capacity
|
12074
|
-
# providers can be created with the
|
12075
|
-
# operation.
|
12205
|
+
# providers can be created with the [CreateClusterCapacityProvider][2]
|
12206
|
+
# API operation.
|
12076
12207
|
#
|
12077
12208
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
12078
12209
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
12079
12210
|
# are available to all accounts and only need to be associated with a
|
12080
12211
|
# cluster to be used.
|
12081
12212
|
#
|
12082
|
-
# The PutClusterCapacityProviders
|
12083
|
-
# list of available capacity providers for a cluster after the
|
12084
|
-
# is created.
|
12213
|
+
# The [PutClusterCapacityProviders][1]API operation is used to update
|
12214
|
+
# the list of available capacity providers for a cluster after the
|
12215
|
+
# cluster is created.
|
12216
|
+
#
|
12217
|
+
#
|
12218
|
+
#
|
12219
|
+
#
|
12220
|
+
#
|
12221
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
12222
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html
|
12085
12223
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
12086
12224
|
#
|
12087
12225
|
# @!attribute [rw] deployment_configuration
|