aws-sdk-ecs 1.87.0 → 1.91.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ecs/client.rb +568 -472
- data/lib/aws-sdk-ecs/client_api.rb +31 -0
- data/lib/aws-sdk-ecs/types.rb +1213 -988
- data/lib/aws-sdk-ecs.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-ecs/types.rb
CHANGED
@@ -10,7 +10,7 @@
|
|
10
10
|
module Aws::ECS
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# You
|
13
|
+
# You don't have authorization to perform the requested action.
|
14
14
|
#
|
15
15
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/AccessDeniedException AWS API Documentation
|
16
16
|
#
|
@@ -76,9 +76,9 @@ module Aws::ECS
|
|
76
76
|
include Aws::Structure
|
77
77
|
end
|
78
78
|
|
79
|
-
# An attribute is a name-value pair associated with an Amazon
|
80
|
-
# object. Attributes enable you to extend the Amazon ECS data model
|
81
|
-
# adding custom metadata to your resources. For more information, see
|
79
|
+
# An attribute is a name-value pair that's associated with an Amazon
|
80
|
+
# ECS object. Attributes enable you to extend the Amazon ECS data model
|
81
|
+
# by adding custom metadata to your resources. For more information, see
|
82
82
|
# [Attributes][1] in the *Amazon Elastic Container Service Developer
|
83
83
|
# Guide*.
|
84
84
|
#
|
@@ -98,23 +98,23 @@ module Aws::ECS
|
|
98
98
|
#
|
99
99
|
# @!attribute [rw] name
|
100
100
|
# The name of the attribute. The `name` must contain between 1 and 128
|
101
|
-
# characters
|
102
|
-
# numbers, hyphens, underscores, forward slashes, back
|
103
|
-
# periods.
|
101
|
+
# characters. The name may contain letters (uppercase and lowercase),
|
102
|
+
# numbers, hyphens (-), underscores (\_), forward slashes (/), back
|
103
|
+
# slashes (\\), or periods (.).
|
104
104
|
# @return [String]
|
105
105
|
#
|
106
106
|
# @!attribute [rw] value
|
107
107
|
# The value of the attribute. The `value` must contain between 1 and
|
108
|
-
# 128 characters
|
109
|
-
# numbers, hyphens, underscores, periods, at signs (@),
|
110
|
-
# slashes, back slashes, colons, or spaces. The
|
111
|
-
#
|
108
|
+
# 128 characters. It can contain letters (uppercase and lowercase),
|
109
|
+
# numbers, hyphens (-), underscores (\_), periods (.), at signs (@),
|
110
|
+
# forward slashes (/), back slashes (\\), colons (:), or spaces. The
|
111
|
+
# value can't can't start or end with a space.
|
112
112
|
# @return [String]
|
113
113
|
#
|
114
114
|
# @!attribute [rw] target_type
|
115
|
-
# The type of the target
|
116
|
-
#
|
117
|
-
#
|
115
|
+
# The type of the target to attach the attribute with. This parameter
|
116
|
+
# is required if you use the short form ID for a resource instead of
|
117
|
+
# the full ARN.
|
118
118
|
# @return [String]
|
119
119
|
#
|
120
120
|
# @!attribute [rw] target_id
|
@@ -133,8 +133,8 @@ module Aws::ECS
|
|
133
133
|
include Aws::Structure
|
134
134
|
end
|
135
135
|
|
136
|
-
# You can apply up to 10 custom attributes
|
137
|
-
# the attributes of a resource with ListAttributes. You can remove
|
136
|
+
# You can apply up to 10 custom attributes for each resource. You can
|
137
|
+
# view the attributes of a resource with ListAttributes. You can remove
|
138
138
|
# existing attributes on a resource with DeleteAttributes.
|
139
139
|
#
|
140
140
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/AttributeLimitExceededException AWS API Documentation
|
@@ -174,7 +174,7 @@ module Aws::ECS
|
|
174
174
|
# Scaling group has managed termination protection.
|
175
175
|
#
|
176
176
|
# When using managed termination protection, managed scaling must also
|
177
|
-
# be used otherwise managed termination protection
|
177
|
+
# be used otherwise managed termination protection doesn't work.
|
178
178
|
#
|
179
179
|
# When managed termination protection is enabled, Amazon ECS prevents
|
180
180
|
# the Amazon EC2 instances in an Auto Scaling group that contain tasks
|
@@ -185,7 +185,7 @@ module Aws::ECS
|
|
185
185
|
# Guide*.
|
186
186
|
#
|
187
187
|
# When managed termination protection is disabled, your Amazon EC2
|
188
|
-
# instances
|
188
|
+
# instances aren't protected from termination when the Auto Scaling
|
189
189
|
# group scales in.
|
190
190
|
#
|
191
191
|
#
|
@@ -230,18 +230,17 @@ module Aws::ECS
|
|
230
230
|
# Scaling group has managed termination protection.
|
231
231
|
#
|
232
232
|
# When using managed termination protection, managed scaling must also
|
233
|
-
# be used otherwise managed termination protection
|
233
|
+
# be used otherwise managed termination protection doesn't work.
|
234
234
|
#
|
235
235
|
# When managed termination protection is enabled, Amazon ECS prevents
|
236
236
|
# the Amazon EC2 instances in an Auto Scaling group that contain tasks
|
237
237
|
# from being terminated during a scale-in action. The Auto Scaling
|
238
238
|
# group and each instance in the Auto Scaling group must have instance
|
239
|
-
# protection from scale-in actions enabled
|
240
|
-
#
|
241
|
-
# Guide*.
|
239
|
+
# protection from scale-in actions enabled. For more information, see
|
240
|
+
# [Instance Protection][1] in the *Auto Scaling User Guide*.
|
242
241
|
#
|
243
242
|
# When managed termination protection is disabled, your Amazon EC2
|
244
|
-
# instances
|
243
|
+
# instances aren't protected from termination when the Auto Scaling
|
245
244
|
# group scales in.
|
246
245
|
#
|
247
246
|
#
|
@@ -270,7 +269,7 @@ module Aws::ECS
|
|
270
269
|
# }
|
271
270
|
#
|
272
271
|
# @!attribute [rw] subnets
|
273
|
-
# The IDs of the subnets associated with the task or service. There
|
272
|
+
# The IDs of the subnets associated with the task or service. There's
|
274
273
|
# a limit of 16 subnets that can be specified per
|
275
274
|
# `AwsVpcConfiguration`.
|
276
275
|
#
|
@@ -281,8 +280,8 @@ module Aws::ECS
|
|
281
280
|
#
|
282
281
|
# @!attribute [rw] security_groups
|
283
282
|
# The IDs of the security groups associated with the task or service.
|
284
|
-
# If you
|
285
|
-
# for the VPC is used. There
|
283
|
+
# If you don't specify a security group, the default security group
|
284
|
+
# for the VPC is used. There's a limit of 5 security groups that can
|
286
285
|
# be specified per `AwsVpcConfiguration`.
|
287
286
|
#
|
288
287
|
# <note markdown="1"> All specified security groups must be from the same VPC.
|
@@ -305,8 +304,8 @@ module Aws::ECS
|
|
305
304
|
include Aws::Structure
|
306
305
|
end
|
307
306
|
|
308
|
-
# Your Amazon Web Services account
|
309
|
-
#
|
307
|
+
# Your Amazon Web Services account was blocked. For more information,
|
308
|
+
# contact [ Amazon Web Services Support][1].
|
310
309
|
#
|
311
310
|
#
|
312
311
|
#
|
@@ -316,7 +315,7 @@ module Aws::ECS
|
|
316
315
|
#
|
317
316
|
class BlockedException < Aws::EmptyStructure; end
|
318
317
|
|
319
|
-
# The details
|
318
|
+
# The details for a capacity provider.
|
320
319
|
#
|
321
320
|
# @!attribute [rw] capacity_provider_arn
|
322
321
|
# The Amazon Resource Name (ARN) that identifies the capacity
|
@@ -330,7 +329,7 @@ module Aws::ECS
|
|
330
329
|
# @!attribute [rw] status
|
331
330
|
# The current status of the capacity provider. Only capacity providers
|
332
331
|
# in an `ACTIVE` state can be used in a cluster. When a capacity
|
333
|
-
# provider is successfully deleted, it
|
332
|
+
# provider is successfully deleted, it has an `INACTIVE` status.
|
334
333
|
# @return [String]
|
335
334
|
#
|
336
335
|
# @!attribute [rw] auto_scaling_group_provider
|
@@ -339,7 +338,7 @@ module Aws::ECS
|
|
339
338
|
#
|
340
339
|
# @!attribute [rw] update_status
|
341
340
|
# The update status of the capacity provider. The following are the
|
342
|
-
# possible states that
|
341
|
+
# possible states that is returned.
|
343
342
|
#
|
344
343
|
# DELETE\_IN\_PROGRESS
|
345
344
|
#
|
@@ -347,13 +346,13 @@ module Aws::ECS
|
|
347
346
|
#
|
348
347
|
# DELETE\_COMPLETE
|
349
348
|
#
|
350
|
-
# : The capacity provider
|
351
|
-
#
|
349
|
+
# : The capacity provider was successfully deleted and has an
|
350
|
+
# `INACTIVE` status.
|
352
351
|
#
|
353
352
|
# DELETE\_FAILED
|
354
353
|
#
|
355
|
-
# : The capacity provider
|
356
|
-
#
|
354
|
+
# : The capacity provider can't be deleted. The update status reason
|
355
|
+
# provides further details about why the delete failed.
|
357
356
|
# @return [String]
|
358
357
|
#
|
359
358
|
# @!attribute [rw] update_status_reason
|
@@ -364,7 +363,7 @@ module Aws::ECS
|
|
364
363
|
# @!attribute [rw] tags
|
365
364
|
# The metadata that you apply to the capacity provider to help you
|
366
365
|
# categorize and organize it. Each tag consists of a key and an
|
367
|
-
# optional value
|
366
|
+
# optional value. You define both.
|
368
367
|
#
|
369
368
|
# The following basic restrictions apply to tags:
|
370
369
|
#
|
@@ -452,17 +451,17 @@ module Aws::ECS
|
|
452
451
|
# When multiple capacity providers are specified within a capacity
|
453
452
|
# provider strategy, at least one of the capacity providers must have
|
454
453
|
# a weight value greater than zero and any capacity providers with a
|
455
|
-
# weight of `0`
|
456
|
-
#
|
457
|
-
# `
|
458
|
-
#
|
454
|
+
# weight of `0` can't be used to place tasks. If you specify multiple
|
455
|
+
# capacity providers in a strategy that all have a weight of `0`, any
|
456
|
+
# `RunTask` or `CreateService` actions using the capacity provider
|
457
|
+
# strategy will fail.
|
459
458
|
#
|
460
459
|
# An example scenario for using weights is defining a strategy that
|
461
460
|
# contains two capacity providers and both have a weight of `1`, then
|
462
461
|
# when the `base` is satisfied, the tasks will be split evenly across
|
463
462
|
# the two capacity providers. Using that same logic, if you specify a
|
464
463
|
# weight of `1` for *capacityProviderA* and a weight of `4` for
|
465
|
-
# *capacityProviderB*, then for every one task that
|
464
|
+
# *capacityProviderB*, then for every one task that's run using
|
466
465
|
# *capacityProviderA*, four tasks would use *capacityProviderB*.
|
467
466
|
# @return [Integer]
|
468
467
|
#
|
@@ -483,10 +482,10 @@ module Aws::ECS
|
|
483
482
|
include Aws::Structure
|
484
483
|
end
|
485
484
|
|
486
|
-
# These errors are usually caused by a client action
|
487
|
-
# action or resource on behalf of a user that doesn't
|
488
|
-
# to use the action or resource,
|
489
|
-
# valid.
|
485
|
+
# These errors are usually caused by a client action. This client action
|
486
|
+
# might be using an action or resource on behalf of a user that doesn't
|
487
|
+
# have permissions to use the action or resource,. Or, it might be
|
488
|
+
# specifying an identifier that isn't valid.
|
490
489
|
#
|
491
490
|
# @!attribute [rw] message
|
492
491
|
# @return [String]
|
@@ -499,10 +498,10 @@ module Aws::ECS
|
|
499
498
|
include Aws::Structure
|
500
499
|
end
|
501
500
|
|
502
|
-
# A regional grouping of one or more container instances
|
503
|
-
#
|
504
|
-
#
|
505
|
-
#
|
501
|
+
# A regional grouping of one or more container instances where you can
|
502
|
+
# run task requests. Each account receives a default cluster the first
|
503
|
+
# time you use the Amazon ECS service, but you may also create other
|
504
|
+
# clusters. Clusters may contain more than one instance type
|
506
505
|
# simultaneously.
|
507
506
|
#
|
508
507
|
# @!attribute [rw] cluster_arn
|
@@ -523,7 +522,7 @@ module Aws::ECS
|
|
523
522
|
#
|
524
523
|
# @!attribute [rw] status
|
525
524
|
# The status of the cluster. The following are the possible states
|
526
|
-
# that
|
525
|
+
# that are returned.
|
527
526
|
#
|
528
527
|
# ACTIVE
|
529
528
|
#
|
@@ -532,25 +531,26 @@ module Aws::ECS
|
|
532
531
|
#
|
533
532
|
# PROVISIONING
|
534
533
|
#
|
535
|
-
# : The cluster has capacity providers associated with it and
|
536
|
-
# resources needed for the capacity provider are being created.
|
534
|
+
# : The cluster has capacity providers that are associated with it and
|
535
|
+
# the resources needed for the capacity provider are being created.
|
537
536
|
#
|
538
537
|
# DEPROVISIONING
|
539
538
|
#
|
540
|
-
# : The cluster has capacity providers associated with it and
|
541
|
-
# resources needed for the capacity provider are being deleted.
|
539
|
+
# : The cluster has capacity providers that are associated with it and
|
540
|
+
# the resources needed for the capacity provider are being deleted.
|
542
541
|
#
|
543
542
|
# FAILED
|
544
543
|
#
|
545
|
-
# : The cluster has capacity providers associated with it and
|
546
|
-
# resources needed for the capacity provider have failed to
|
544
|
+
# : The cluster has capacity providers that are associated with it and
|
545
|
+
# the resources needed for the capacity provider have failed to
|
546
|
+
# create.
|
547
547
|
#
|
548
548
|
# INACTIVE
|
549
549
|
#
|
550
550
|
# : The cluster has been deleted. Clusters with an `INACTIVE` status
|
551
551
|
# may remain discoverable in your account for a period of time.
|
552
|
-
# However, this behavior is subject to change in the future
|
553
|
-
#
|
552
|
+
# However, this behavior is subject to change in the future. We
|
553
|
+
# don't recommend that you rely on `INACTIVE` clusters persisting.
|
554
554
|
# @return [String]
|
555
555
|
#
|
556
556
|
# @!attribute [rw] registered_container_instances_count
|
@@ -573,7 +573,7 @@ module Aws::ECS
|
|
573
573
|
#
|
574
574
|
# @!attribute [rw] statistics
|
575
575
|
# Additional information about your clusters that are separated by
|
576
|
-
# launch type
|
576
|
+
# launch type. They include the following:
|
577
577
|
#
|
578
578
|
# * runningEC2TasksCount
|
579
579
|
#
|
@@ -594,8 +594,8 @@ module Aws::ECS
|
|
594
594
|
#
|
595
595
|
# @!attribute [rw] tags
|
596
596
|
# The metadata that you apply to the cluster to help you categorize
|
597
|
-
# and organize them. Each tag consists of a key and an optional value
|
598
|
-
#
|
597
|
+
# and organize them. Each tag consists of a key and an optional value.
|
598
|
+
# You define both.
|
599
599
|
#
|
600
600
|
# The following basic restrictions apply to tags:
|
601
601
|
#
|
@@ -641,13 +641,13 @@ module Aws::ECS
|
|
641
641
|
#
|
642
642
|
# @!attribute [rw] attachments
|
643
643
|
# The resources attached to a cluster. When using a capacity provider
|
644
|
-
# with a cluster, the Auto Scaling plan that is
|
645
|
-
#
|
644
|
+
# with a cluster, the Auto Scaling plan that's created is returned as
|
645
|
+
# a cluster attachment.
|
646
646
|
# @return [Array<Types::Attachment>]
|
647
647
|
#
|
648
648
|
# @!attribute [rw] attachments_status
|
649
649
|
# The status of the capacity providers associated with the cluster.
|
650
|
-
# The following are the states that
|
650
|
+
# The following are the states that are returned.
|
651
651
|
#
|
652
652
|
# UPDATE\_IN\_PROGRESS
|
653
653
|
#
|
@@ -717,7 +717,7 @@ module Aws::ECS
|
|
717
717
|
include Aws::Structure
|
718
718
|
end
|
719
719
|
|
720
|
-
# You
|
720
|
+
# You can't delete a cluster that has registered container instances.
|
721
721
|
# First, deregister the container instances before you can delete the
|
722
722
|
# cluster. For more information, see DeregisterContainerInstance.
|
723
723
|
#
|
@@ -725,22 +725,22 @@ module Aws::ECS
|
|
725
725
|
#
|
726
726
|
class ClusterContainsContainerInstancesException < Aws::EmptyStructure; end
|
727
727
|
|
728
|
-
# You
|
729
|
-
# service to reduce its desired task count to 0 and then delete the
|
728
|
+
# You can't delete a cluster that contains services. First, update the
|
729
|
+
# service to reduce its desired task count to 0, and then delete the
|
730
730
|
# service. For more information, see UpdateService and DeleteService.
|
731
731
|
#
|
732
732
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ClusterContainsServicesException AWS API Documentation
|
733
733
|
#
|
734
734
|
class ClusterContainsServicesException < Aws::EmptyStructure; end
|
735
735
|
|
736
|
-
# You
|
736
|
+
# You can't delete a cluster that has active tasks.
|
737
737
|
#
|
738
738
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ClusterContainsTasksException AWS API Documentation
|
739
739
|
#
|
740
740
|
class ClusterContainsTasksException < Aws::EmptyStructure; end
|
741
741
|
|
742
|
-
# The specified cluster
|
743
|
-
# clusters with ListClusters. Amazon ECS clusters are Region
|
742
|
+
# The specified cluster wasn't found. You can view your available
|
743
|
+
# clusters with ListClusters. Amazon ECS clusters are Region specific.
|
744
744
|
#
|
745
745
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ClusterNotFoundException AWS API Documentation
|
746
746
|
#
|
@@ -781,7 +781,7 @@ module Aws::ECS
|
|
781
781
|
include Aws::Structure
|
782
782
|
end
|
783
783
|
|
784
|
-
# A Docker container that
|
784
|
+
# A Docker container that's part of a task.
|
785
785
|
#
|
786
786
|
# @!attribute [rw] container_arn
|
787
787
|
# The Amazon Resource Name (ARN) of the container.
|
@@ -834,7 +834,7 @@ module Aws::ECS
|
|
834
834
|
# @return [Array<Types::NetworkInterface>]
|
835
835
|
#
|
836
836
|
# @!attribute [rw] health_status
|
837
|
-
# The health status of the container. If health checks
|
837
|
+
# The health status of the container. If health checks aren't
|
838
838
|
# configured for this container in its task definition, then it
|
839
839
|
# reports the health status as `UNKNOWN`.
|
840
840
|
# @return [String]
|
@@ -845,8 +845,8 @@ module Aws::ECS
|
|
845
845
|
# @return [Array<Types::ManagedAgent>]
|
846
846
|
#
|
847
847
|
# @!attribute [rw] cpu
|
848
|
-
# The number of CPU units set for the container. The value
|
849
|
-
#
|
848
|
+
# The number of CPU units set for the container. The value is `0` if
|
849
|
+
# no value was specified in the container definition when the task
|
850
850
|
# definition was registered.
|
851
851
|
# @return [String]
|
852
852
|
#
|
@@ -1042,7 +1042,7 @@ module Aws::ECS
|
|
1042
1042
|
# }
|
1043
1043
|
#
|
1044
1044
|
# @!attribute [rw] name
|
1045
|
-
# The name of a container. If you
|
1045
|
+
# The name of a container. If you're linking multiple containers
|
1046
1046
|
# together in a task definition, the `name` of one container can be
|
1047
1047
|
# entered in the `links` of another container to connect the
|
1048
1048
|
# containers. Up to 255 letters (uppercase and lowercase), numbers,
|
@@ -1059,8 +1059,8 @@ module Aws::ECS
|
|
1059
1059
|
#
|
1060
1060
|
# @!attribute [rw] image
|
1061
1061
|
# The image used to start a container. This string is passed directly
|
1062
|
-
# to the Docker daemon.
|
1063
|
-
# available
|
1062
|
+
# to the Docker daemon. By default, images in the Docker Hub registry
|
1063
|
+
# are available. Other repositories are specified with either `
|
1064
1064
|
# repository-url/image:tag ` or ` repository-url/image@digest `. Up to
|
1065
1065
|
# 255 letters (uppercase and lowercase), numbers, hyphens,
|
1066
1066
|
# underscores, colons, periods, forward slashes, and number signs are
|
@@ -1070,7 +1070,7 @@ module Aws::ECS
|
|
1070
1070
|
#
|
1071
1071
|
# * When a new task starts, the Amazon ECS container agent pulls the
|
1072
1072
|
# latest version of the specified image and tag for the container to
|
1073
|
-
# use. However, subsequent updates to a repository image
|
1073
|
+
# use. However, subsequent updates to a repository image aren't
|
1074
1074
|
# propagated to already running tasks.
|
1075
1075
|
#
|
1076
1076
|
# * Images in Amazon ECR repositories can be specified by either using
|
@@ -1121,21 +1121,21 @@ module Aws::ECS
|
|
1121
1121
|
# on the container instance with the same ratio as their allocated
|
1122
1122
|
# amount. For example, if you run a single-container task on a
|
1123
1123
|
# single-core instance type with 512 CPU units specified for that
|
1124
|
-
# container, and that
|
1124
|
+
# container, and that's the only task running on the container
|
1125
1125
|
# instance, that container could use the full 1,024 CPU unit share at
|
1126
1126
|
# any given time. However, if you launched another copy of the same
|
1127
|
-
# task on that container instance, each task
|
1128
|
-
#
|
1129
|
-
# to higher CPU usage if the other container was not using it
|
1130
|
-
#
|
1131
|
-
#
|
1127
|
+
# task on that container instance, each task is guaranteed a minimum
|
1128
|
+
# of 512 CPU units when needed. Moreover, each container could float
|
1129
|
+
# to higher CPU usage if the other container was not using it. If both
|
1130
|
+
# tasks were 100% active all of the time, they would be limited to 512
|
1131
|
+
# CPU units.
|
1132
1132
|
#
|
1133
1133
|
# On Linux container instances, the Docker daemon on the container
|
1134
1134
|
# instance uses the CPU value to calculate the relative CPU share
|
1135
1135
|
# ratios for running containers. For more information, see [CPU share
|
1136
1136
|
# constraint][5] in the Docker documentation. The minimum valid CPU
|
1137
1137
|
# share value that the Linux kernel allows is 2. However, the CPU
|
1138
|
-
# parameter
|
1138
|
+
# parameter isn't required, and you can use CPU values below 2 in
|
1139
1139
|
# your container definitions. For CPU values below 2 (including null),
|
1140
1140
|
# the behavior varies based on your Amazon ECS container agent
|
1141
1141
|
# version:
|
@@ -1150,7 +1150,7 @@ module Aws::ECS
|
|
1150
1150
|
#
|
1151
1151
|
# On Windows container instances, the CPU limit is enforced as an
|
1152
1152
|
# absolute limit, or a quota. Windows containers only have access to
|
1153
|
-
# the specified amount of CPU that
|
1153
|
+
# the specified amount of CPU that's described in the task
|
1154
1154
|
# definition. A null or zero CPU value is passed to Docker as `0`,
|
1155
1155
|
# which Windows interprets as 1% of one CPU.
|
1156
1156
|
#
|
@@ -1179,12 +1179,16 @@ module Aws::ECS
|
|
1179
1179
|
# a container-level `memory` and `memoryReservation` value, `memory`
|
1180
1180
|
# must be greater than `memoryReservation`. If you specify
|
1181
1181
|
# `memoryReservation`, then that value is subtracted from the
|
1182
|
-
# available memory resources for the container instance
|
1182
|
+
# available memory resources for the container instance where the
|
1183
1183
|
# container is placed. Otherwise, the value of `memory` is used.
|
1184
1184
|
#
|
1185
|
-
# The Docker daemon reserves a minimum of
|
1186
|
-
# container, so you should not specify fewer than
|
1187
|
-
# your containers.
|
1185
|
+
# The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of
|
1186
|
+
# memory for a container, so you should not specify fewer than 6 MiB
|
1187
|
+
# of memory for your containers.
|
1188
|
+
#
|
1189
|
+
# The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB
|
1190
|
+
# of memory for a container, so you should not specify fewer than 4
|
1191
|
+
# MiB of memory for your containers.
|
1188
1192
|
#
|
1189
1193
|
#
|
1190
1194
|
#
|
@@ -1209,7 +1213,7 @@ module Aws::ECS
|
|
1209
1213
|
# in a container definition. If you specify both, `memory` must be
|
1210
1214
|
# greater than `memoryReservation`. If you specify
|
1211
1215
|
# `memoryReservation`, then that value is subtracted from the
|
1212
|
-
# available memory resources for the container instance
|
1216
|
+
# available memory resources for the container instance where the
|
1213
1217
|
# container is placed. Otherwise, the value of `memory` is used.
|
1214
1218
|
#
|
1215
1219
|
# For example, if your container normally uses 128 MiB of memory, but
|
@@ -1221,8 +1225,8 @@ module Aws::ECS
|
|
1221
1225
|
# memory resources when needed.
|
1222
1226
|
#
|
1223
1227
|
# The Docker daemon reserves a minimum of 4 MiB of memory for a
|
1224
|
-
# container,
|
1225
|
-
# your containers.
|
1228
|
+
# container. Therefore, we recommend that you specify fewer than 4 MiB
|
1229
|
+
# of memory for your containers.
|
1226
1230
|
#
|
1227
1231
|
#
|
1228
1232
|
#
|
@@ -1265,13 +1269,13 @@ module Aws::ECS
|
|
1265
1269
|
# containers to access ports on the host container instance to send or
|
1266
1270
|
# receive traffic.
|
1267
1271
|
#
|
1268
|
-
# For task definitions that use the `awsvpc` network mode,
|
1269
|
-
#
|
1270
|
-
#
|
1272
|
+
# For task definitions that use the `awsvpc` network mode, only
|
1273
|
+
# specify the `containerPort`. The `hostPort` can be left blank or it
|
1274
|
+
# must be the same value as the `containerPort`.
|
1271
1275
|
#
|
1272
1276
|
# Port mappings on Windows use the `NetNAT` gateway address rather
|
1273
|
-
# than `localhost`. There
|
1274
|
-
# so you
|
1277
|
+
# than `localhost`. There's no loopback for port mappings on Windows,
|
1278
|
+
# so you can't access a container's mapped port from the host
|
1275
1279
|
# itself.
|
1276
1280
|
#
|
1277
1281
|
# This parameter maps to `PortBindings` in the [Create a container][1]
|
@@ -1301,16 +1305,16 @@ module Aws::ECS
|
|
1301
1305
|
# If the `essential` parameter of a container is marked as `true`, and
|
1302
1306
|
# that container fails or stops for any reason, all other containers
|
1303
1307
|
# that are part of the task are stopped. If the `essential` parameter
|
1304
|
-
# of a container is marked as `false`,
|
1305
|
-
#
|
1306
|
-
#
|
1308
|
+
# of a container is marked as `false`, its failure doesn't affect the
|
1309
|
+
# rest of the containers in a task. If this parameter is omitted, a
|
1310
|
+
# container is assumed to be essential.
|
1307
1311
|
#
|
1308
1312
|
# All tasks must have at least one essential container. If you have an
|
1309
|
-
# application that
|
1310
|
-
#
|
1311
|
-
#
|
1312
|
-
#
|
1313
|
-
#
|
1313
|
+
# application that's composed of multiple containers, group
|
1314
|
+
# containers that are used for a common purpose into components, and
|
1315
|
+
# separate the different components into multiple task definitions.
|
1316
|
+
# For more information, see [Application Architecture][1] in the
|
1317
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
1314
1318
|
#
|
1315
1319
|
#
|
1316
1320
|
#
|
@@ -1318,12 +1322,12 @@ module Aws::ECS
|
|
1318
1322
|
# @return [Boolean]
|
1319
1323
|
#
|
1320
1324
|
# @!attribute [rw] entry_point
|
1321
|
-
# Early versions of the Amazon ECS container agent
|
1325
|
+
# Early versions of the Amazon ECS container agent don't properly
|
1322
1326
|
# handle `entryPoint` parameters. If you have problems using
|
1323
1327
|
# `entryPoint`, update your container agent or enter your commands and
|
1324
1328
|
# arguments as `command` array items instead.
|
1325
1329
|
#
|
1326
|
-
# The entry point that
|
1330
|
+
# The entry point that's passed to the container. This parameter maps
|
1327
1331
|
# to `Entrypoint` in the [Create a container][1] section of the
|
1328
1332
|
# [Docker Remote API][2] and the `--entrypoint` option to [docker
|
1329
1333
|
# run][3]. For more information, see
|
@@ -1338,13 +1342,13 @@ module Aws::ECS
|
|
1338
1342
|
# @return [Array<String>]
|
1339
1343
|
#
|
1340
1344
|
# @!attribute [rw] command
|
1341
|
-
# The command that
|
1345
|
+
# The command that's passed to the container. This parameter maps to
|
1342
1346
|
# `Cmd` in the [Create a container][1] section of the [Docker Remote
|
1343
1347
|
# API][2] and the `COMMAND` parameter to [docker run][3]. For more
|
1344
1348
|
# information, see
|
1345
1349
|
# [https://docs.docker.com/engine/reference/builder/#cmd][4]. If there
|
1346
|
-
# are multiple arguments, each argument
|
1347
|
-
#
|
1350
|
+
# are multiple arguments, each argument is a separated string in the
|
1351
|
+
# array.
|
1348
1352
|
#
|
1349
1353
|
#
|
1350
1354
|
#
|
@@ -1359,7 +1363,7 @@ module Aws::ECS
|
|
1359
1363
|
# maps to `Env` in the [Create a container][1] section of the [Docker
|
1360
1364
|
# Remote API][2] and the `--env` option to [docker run][3].
|
1361
1365
|
#
|
1362
|
-
# We
|
1366
|
+
# We don't recommend that you use plaintext environment variables for
|
1363
1367
|
# sensitive information, such as credential data.
|
1364
1368
|
#
|
1365
1369
|
#
|
@@ -1375,20 +1379,20 @@ module Aws::ECS
|
|
1375
1379
|
# run][1].
|
1376
1380
|
#
|
1377
1381
|
# You can specify up to ten environment files. The file must have a
|
1378
|
-
# `.env` file extension. Each line in an environment file
|
1379
|
-
#
|
1380
|
-
#
|
1381
|
-
# information
|
1382
|
+
# `.env` file extension. Each line in an environment file contains an
|
1383
|
+
# environment variable in `VARIABLE=VALUE` format. Lines beginning
|
1384
|
+
# with `#` are treated as comments and are ignored. For more
|
1385
|
+
# information about the environment variable file syntax, see [Declare
|
1382
1386
|
# default environment variables in file][2].
|
1383
1387
|
#
|
1384
1388
|
# If there are environment variables specified using the `environment`
|
1385
1389
|
# parameter in a container definition, they take precedence over the
|
1386
1390
|
# variables contained within an environment file. If multiple
|
1387
|
-
# environment files are specified that contain the same variable,
|
1388
|
-
#
|
1389
|
-
# variable names. For more information, see [Specifying
|
1390
|
-
# Variables][3] in the *Amazon Elastic Container Service
|
1391
|
-
# Guide*.
|
1391
|
+
# environment files are specified that contain the same variable,
|
1392
|
+
# they're processed from the top down. We recommend that you use
|
1393
|
+
# unique variable names. For more information, see [Specifying
|
1394
|
+
# Environment Variables][3] in the *Amazon Elastic Container Service
|
1395
|
+
# Developer Guide*.
|
1392
1396
|
#
|
1393
1397
|
#
|
1394
1398
|
#
|
@@ -1405,8 +1409,8 @@ module Aws::ECS
|
|
1405
1409
|
# [docker run][3].
|
1406
1410
|
#
|
1407
1411
|
# Windows containers can mount whole directories on the same drive as
|
1408
|
-
# `$env:ProgramData`. Windows containers
|
1409
|
-
# different drive, and mount point
|
1412
|
+
# `$env:ProgramData`. Windows containers can't mount directories on a
|
1413
|
+
# different drive, and mount point can't be across drives.
|
1410
1414
|
#
|
1411
1415
|
#
|
1412
1416
|
#
|
@@ -1459,7 +1463,7 @@ module Aws::ECS
|
|
1459
1463
|
# version. For information about checking your agent version and
|
1460
1464
|
# updating to the latest version, see [Updating the Amazon ECS
|
1461
1465
|
# Container Agent][1] in the *Amazon Elastic Container Service
|
1462
|
-
# Developer Guide*. If you
|
1466
|
+
# Developer Guide*. If you're using an Amazon ECS-optimized Linux
|
1463
1467
|
# AMI, your instance needs at least version 1.26.0-1 of the `ecs-init`
|
1464
1468
|
# package. If your container instances are launched from version
|
1465
1469
|
# `20190301` or later, then they contain the required versions of the
|
@@ -1468,7 +1472,11 @@ module Aws::ECS
|
|
1468
1472
|
# Developer Guide*.
|
1469
1473
|
#
|
1470
1474
|
# For tasks using the Fargate launch type, the task or service
|
1471
|
-
# requires
|
1475
|
+
# requires the following platforms:
|
1476
|
+
#
|
1477
|
+
# * Linux platform version `1.3.0` or later.
|
1478
|
+
#
|
1479
|
+
# * Windows platform version `1.0.0` or later.
|
1472
1480
|
#
|
1473
1481
|
#
|
1474
1482
|
#
|
@@ -1481,19 +1489,23 @@ module Aws::ECS
|
|
1481
1489
|
# dependencies for a container. For example, you specify two
|
1482
1490
|
# containers in a task definition with containerA having a dependency
|
1483
1491
|
# on containerB reaching a `COMPLETE`, `SUCCESS`, or `HEALTHY` status.
|
1484
|
-
# If a `startTimeout` value is specified for containerB and it
|
1485
|
-
#
|
1486
|
-
#
|
1492
|
+
# If a `startTimeout` value is specified for containerB and it
|
1493
|
+
# doesn't reach the desired status within that time then containerA
|
1494
|
+
# gives up and not start. This results in the task transitioning to a
|
1487
1495
|
# `STOPPED` state.
|
1488
1496
|
#
|
1489
1497
|
# <note markdown="1"> When the `ECS_CONTAINER_START_TIMEOUT` container agent configuration
|
1490
|
-
# variable is used, it
|
1491
|
-
# value.
|
1498
|
+
# variable is used, it's enforced independently from this start
|
1499
|
+
# timeout value.
|
1492
1500
|
#
|
1493
1501
|
# </note>
|
1494
1502
|
#
|
1495
|
-
# For tasks using the Fargate launch type,
|
1496
|
-
#
|
1503
|
+
# For tasks using the Fargate launch type, the task or service
|
1504
|
+
# requires the following platforms:
|
1505
|
+
#
|
1506
|
+
# * Linux platform version `1.3.0` or later.
|
1507
|
+
#
|
1508
|
+
# * Windows platform version `1.0.0` or later.
|
1497
1509
|
#
|
1498
1510
|
# For tasks using the EC2 launch type, your container instances
|
1499
1511
|
# require at least version `1.26.0` of the container agent to enable a
|
@@ -1501,7 +1513,7 @@ module Aws::ECS
|
|
1501
1513
|
# latest container agent version. For information about checking your
|
1502
1514
|
# agent version and updating to the latest version, see [Updating the
|
1503
1515
|
# Amazon ECS Container Agent][1] in the *Amazon Elastic Container
|
1504
|
-
# Service Developer Guide*. If you
|
1516
|
+
# Service Developer Guide*. If you're using an Amazon ECS-optimized
|
1505
1517
|
# Linux AMI, your instance needs at least version `1.26.0-1` of the
|
1506
1518
|
# `ecs-init` package. If your container instances are launched from
|
1507
1519
|
# version `20190301` or later, then they contain the required versions
|
@@ -1520,14 +1532,19 @@ module Aws::ECS
|
|
1520
1532
|
# forcefully killed if it doesn't exit normally on its own.
|
1521
1533
|
#
|
1522
1534
|
# For tasks using the Fargate launch type, the task or service
|
1523
|
-
# requires
|
1524
|
-
#
|
1525
|
-
#
|
1526
|
-
#
|
1527
|
-
#
|
1528
|
-
#
|
1529
|
-
#
|
1530
|
-
# default
|
1535
|
+
# requires the following platforms:
|
1536
|
+
#
|
1537
|
+
# * Linux platform version `1.3.0` or later.
|
1538
|
+
#
|
1539
|
+
# * Windows platform version `1.0.0` or later.
|
1540
|
+
#
|
1541
|
+
# The max stop timeout value is 120 seconds and if the parameter is
|
1542
|
+
# not specified, the default value of 30 seconds is used.
|
1543
|
+
#
|
1544
|
+
# For tasks that use the EC2 launch type, if the `stopTimeout`
|
1545
|
+
# parameter isn't specified, the value set for the Amazon ECS
|
1546
|
+
# container agent configuration variable `ECS_CONTAINER_STOP_TIMEOUT`
|
1547
|
+
# is used. If neither the `stopTimeout` parameter or the
|
1531
1548
|
# `ECS_CONTAINER_STOP_TIMEOUT` agent configuration variable are set,
|
1532
1549
|
# then the default values of 30 seconds for Linux containers and 30
|
1533
1550
|
# seconds on Windows containers are used. Your container instances
|
@@ -1536,7 +1553,7 @@ module Aws::ECS
|
|
1536
1553
|
# container agent version. For information about checking your agent
|
1537
1554
|
# version and updating to the latest version, see [Updating the Amazon
|
1538
1555
|
# ECS Container Agent][1] in the *Amazon Elastic Container Service
|
1539
|
-
# Developer Guide*. If you
|
1556
|
+
# Developer Guide*. If you're using an Amazon ECS-optimized Linux
|
1540
1557
|
# AMI, your instance needs at least version 1.26.0-1 of the `ecs-init`
|
1541
1558
|
# package. If your container instances are launched from version
|
1542
1559
|
# `20190301` or later, then they contain the required versions of the
|
@@ -1555,7 +1572,7 @@ module Aws::ECS
|
|
1555
1572
|
# `Hostname` in the [Create a container][1] section of the [Docker
|
1556
1573
|
# Remote API][2] and the `--hostname` option to [docker run][3].
|
1557
1574
|
#
|
1558
|
-
# <note markdown="1"> The `hostname` parameter is not supported if you
|
1575
|
+
# <note markdown="1"> The `hostname` parameter is not supported if you're using the
|
1559
1576
|
# `awsvpc` network mode.
|
1560
1577
|
#
|
1561
1578
|
# </note>
|
@@ -1572,9 +1589,9 @@ module Aws::ECS
|
|
1572
1589
|
# in the [Create a container][1] section of the [Docker Remote API][2]
|
1573
1590
|
# and the `--user` option to [docker run][3].
|
1574
1591
|
#
|
1575
|
-
# When running tasks using the `host` network mode,
|
1576
|
-
# containers using the root user (UID 0).
|
1577
|
-
#
|
1592
|
+
# When running tasks using the `host` network mode, don't run
|
1593
|
+
# containers using the root user (UID 0). We recommend using a
|
1594
|
+
# non-root user for better security.
|
1578
1595
|
#
|
1579
1596
|
# You can specify the `user` using the following formats. If
|
1580
1597
|
# specifying a UID or GID, you must specify it as a positive integer.
|
@@ -1603,8 +1620,8 @@ module Aws::ECS
|
|
1603
1620
|
# @return [String]
|
1604
1621
|
#
|
1605
1622
|
# @!attribute [rw] working_directory
|
1606
|
-
# The working directory
|
1607
|
-
#
|
1623
|
+
# The working directory to run commands inside the container in. This
|
1624
|
+
# parameter maps to `WorkingDir` in the [Create a container][1]
|
1608
1625
|
# section of the [Docker Remote API][2] and the `--workdir` option to
|
1609
1626
|
# [docker run][3].
|
1610
1627
|
#
|
@@ -1706,7 +1723,7 @@ module Aws::ECS
|
|
1706
1723
|
# `ExtraHosts` in the [Create a container][1] section of the [Docker
|
1707
1724
|
# Remote API][2] and the `--add-host` option to [docker run][3].
|
1708
1725
|
#
|
1709
|
-
# <note markdown="1"> This parameter
|
1726
|
+
# <note markdown="1"> This parameter isn't supported for Windows containers or tasks that
|
1710
1727
|
# use the `awsvpc` network mode.
|
1711
1728
|
#
|
1712
1729
|
# </note>
|
@@ -1720,7 +1737,7 @@ module Aws::ECS
|
|
1720
1737
|
#
|
1721
1738
|
# @!attribute [rw] docker_security_options
|
1722
1739
|
# A list of strings to provide custom labels for SELinux and AppArmor
|
1723
|
-
# multi-level security systems. This field
|
1740
|
+
# multi-level security systems. This field isn't valid for containers
|
1724
1741
|
# in tasks using the Fargate launch type.
|
1725
1742
|
#
|
1726
1743
|
# With Windows containers, this parameter can be used to reference a
|
@@ -1758,11 +1775,11 @@ module Aws::ECS
|
|
1758
1775
|
# @return [Array<String>]
|
1759
1776
|
#
|
1760
1777
|
# @!attribute [rw] interactive
|
1761
|
-
# When this parameter is `true`,
|
1762
|
-
#
|
1763
|
-
#
|
1764
|
-
#
|
1765
|
-
#
|
1778
|
+
# When this parameter is `true`, you can deploy containerized
|
1779
|
+
# applications that require `stdin` or a `tty` to be allocated. This
|
1780
|
+
# parameter maps to `OpenStdin` in the [Create a container][1] section
|
1781
|
+
# of the [Docker Remote API][2] and the `--interactive` option to
|
1782
|
+
# [docker run][3].
|
1766
1783
|
#
|
1767
1784
|
#
|
1768
1785
|
#
|
@@ -1802,8 +1819,8 @@ module Aws::ECS
|
|
1802
1819
|
#
|
1803
1820
|
# @!attribute [rw] ulimits
|
1804
1821
|
# A list of `ulimits` to set in the container. If a ulimit value is
|
1805
|
-
# specified in a task definition, it
|
1806
|
-
#
|
1822
|
+
# specified in a task definition, it overrides the default values set
|
1823
|
+
# by Docker. This parameter maps to `Ulimits` in the [Create a
|
1807
1824
|
# container][1] section of the [Docker Remote API][2] and the
|
1808
1825
|
# `--ulimit` option to [docker run][3]. Valid naming values are
|
1809
1826
|
# displayed in the Ulimit data type.
|
@@ -1838,12 +1855,12 @@ module Aws::ECS
|
|
1838
1855
|
# This parameter maps to `LogConfig` in the [Create a container][1]
|
1839
1856
|
# section of the [Docker Remote API][2] and the `--log-driver` option
|
1840
1857
|
# to [docker run][3]. By default, containers use the same logging
|
1841
|
-
# driver that the Docker daemon uses. However the container
|
1858
|
+
# driver that the Docker daemon uses. However the container can use a
|
1842
1859
|
# different logging driver than the Docker daemon by specifying a log
|
1843
1860
|
# driver with this parameter in the container definition. To use a
|
1844
1861
|
# different logging driver for a container, the log system must be
|
1845
1862
|
# configured properly on the container instance (or on a different log
|
1846
|
-
# server for remote logging options). For more information
|
1863
|
+
# server for remote logging options). For more information about the
|
1847
1864
|
# options for different supported log drivers, see [Configure logging
|
1848
1865
|
# drivers][4] in the Docker documentation.
|
1849
1866
|
#
|
@@ -1898,10 +1915,10 @@ module Aws::ECS
|
|
1898
1915
|
# of the [Docker Remote API][2] and the `--sysctl` option to [docker
|
1899
1916
|
# run][3].
|
1900
1917
|
#
|
1901
|
-
# <note markdown="1">
|
1918
|
+
# <note markdown="1"> We don't recommended that you specify network-related
|
1902
1919
|
# `systemControls` parameters for multiple containers in a single task
|
1903
1920
|
# that also uses either the `awsvpc` or `host` network modes. For
|
1904
|
-
# tasks that use the `awsvpc` network mode, the container that
|
1921
|
+
# tasks that use the `awsvpc` network mode, the container that's
|
1905
1922
|
# started last determines which `systemControls` parameters take
|
1906
1923
|
# effect. For tasks that use the `host` network mode, it changes the
|
1907
1924
|
# container instance's namespaced kernel parameters as well as the
|
@@ -1987,7 +2004,7 @@ module Aws::ECS
|
|
1987
2004
|
# recommend using the latest container agent version. For information
|
1988
2005
|
# about checking your agent version and updating to the latest version,
|
1989
2006
|
# see [Updating the Amazon ECS Container Agent][1] in the *Amazon
|
1990
|
-
# Elastic Container Service Developer Guide*. If you
|
2007
|
+
# Elastic Container Service Developer Guide*. If you're using an Amazon
|
1991
2008
|
# ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1
|
1992
2009
|
# of the `ecs-init` package. If your container instances are launched
|
1993
2010
|
# from version `20190301` or later, then they contain the required
|
@@ -1995,8 +2012,12 @@ module Aws::ECS
|
|
1995
2012
|
# see [Amazon ECS-optimized Linux AMI][2] in the *Amazon Elastic
|
1996
2013
|
# Container Service Developer Guide*.
|
1997
2014
|
#
|
1998
|
-
# <note markdown="1"> For tasks
|
1999
|
-
# the
|
2015
|
+
# <note markdown="1"> For tasks that use the Fargate launch type, the task or service
|
2016
|
+
# requires the following platforms:
|
2017
|
+
#
|
2018
|
+
# * Linux platform version `1.3.0` or later.
|
2019
|
+
#
|
2020
|
+
# * Windows platform version `1.0.0` or later.
|
2000
2021
|
#
|
2001
2022
|
# </note>
|
2002
2023
|
#
|
@@ -2028,12 +2049,12 @@ module Aws::ECS
|
|
2028
2049
|
# * `COMPLETE` - This condition validates that a dependent container
|
2029
2050
|
# runs to completion (exits) before permitting other containers to
|
2030
2051
|
# start. This can be useful for nonessential containers that run a
|
2031
|
-
# script and then exit. This condition
|
2052
|
+
# script and then exit. This condition can't be set on an essential
|
2032
2053
|
# container.
|
2033
2054
|
#
|
2034
2055
|
# * `SUCCESS` - This condition is the same as `COMPLETE`, but it also
|
2035
2056
|
# requires that the container exits with a `zero` status. This
|
2036
|
-
# condition
|
2057
|
+
# condition can't be set on an essential container.
|
2037
2058
|
#
|
2038
2059
|
# * `HEALTHY` - This condition validates that the dependent container
|
2039
2060
|
# passes its Docker health check before permitting other containers
|
@@ -2051,7 +2072,7 @@ module Aws::ECS
|
|
2051
2072
|
include Aws::Structure
|
2052
2073
|
end
|
2053
2074
|
|
2054
|
-
# An EC2 instance that
|
2075
|
+
# An EC2 instance that's running the Amazon ECS agent and has been
|
2055
2076
|
# registered with a cluster.
|
2056
2077
|
#
|
2057
2078
|
# @!attribute [rw] container_instance_arn
|
@@ -2071,13 +2092,14 @@ module Aws::ECS
|
|
2071
2092
|
# @return [String]
|
2072
2093
|
#
|
2073
2094
|
# @!attribute [rw] capacity_provider_name
|
2074
|
-
# The capacity provider associated with the container
|
2095
|
+
# The capacity provider that's associated with the container
|
2096
|
+
# instance.
|
2075
2097
|
# @return [String]
|
2076
2098
|
#
|
2077
2099
|
# @!attribute [rw] version
|
2078
2100
|
# The version counter for the container instance. Every time a
|
2079
2101
|
# container instance experiences a change that triggers a CloudWatch
|
2080
|
-
# event, the version counter is incremented. If you
|
2102
|
+
# event, the version counter is incremented. If you're replicating
|
2081
2103
|
# your Amazon ECS container instance state with CloudWatch Events, you
|
2082
2104
|
# can compare the version of a container instance reported by the
|
2083
2105
|
# Amazon ECS APIs with the version reported in CloudWatch Events for
|
@@ -2092,12 +2114,12 @@ module Aws::ECS
|
|
2092
2114
|
#
|
2093
2115
|
# @!attribute [rw] remaining_resources
|
2094
2116
|
# For CPU and memory resource types, this parameter describes the
|
2095
|
-
# remaining CPU and memory that
|
2096
|
-
#
|
2097
|
-
#
|
2098
|
-
#
|
2099
|
-
#
|
2100
|
-
#
|
2117
|
+
# remaining CPU and memory that wasn't already allocated to tasks and
|
2118
|
+
# is therefore available for new tasks. For port resource types, this
|
2119
|
+
# parameter describes the ports that were reserved by the Amazon ECS
|
2120
|
+
# container agent (at instance registration time) and any task
|
2121
|
+
# containers that have reserved port mappings on the host (with the
|
2122
|
+
# `host` or `bridge` network mode). Any port that's not specified
|
2101
2123
|
# here is available for new tasks.
|
2102
2124
|
# @return [Array<Types::Resource>]
|
2103
2125
|
#
|
@@ -2130,7 +2152,7 @@ module Aws::ECS
|
|
2130
2152
|
# status.
|
2131
2153
|
#
|
2132
2154
|
# The `ACTIVE` status indicates that the container instance can accept
|
2133
|
-
# tasks. The `DRAINING` indicates that new tasks
|
2155
|
+
# tasks. The `DRAINING` indicates that new tasks aren't placed on the
|
2134
2156
|
# container instance and any service tasks running on the container
|
2135
2157
|
# instance are removed if possible. For more information, see
|
2136
2158
|
# [Container Instance Draining][1] in the *Amazon Elastic Container
|
@@ -2163,8 +2185,8 @@ module Aws::ECS
|
|
2163
2185
|
# @return [Integer]
|
2164
2186
|
#
|
2165
2187
|
# @!attribute [rw] agent_update_status
|
2166
|
-
# The status of the most recent agent update. If an update
|
2167
|
-
#
|
2188
|
+
# The status of the most recent agent update. If an update wasn't
|
2189
|
+
# ever requested, this value is `NULL`.
|
2168
2190
|
# @return [String]
|
2169
2191
|
#
|
2170
2192
|
# @!attribute [rw] attributes
|
@@ -2174,7 +2196,8 @@ module Aws::ECS
|
|
2174
2196
|
# @return [Array<Types::Attribute>]
|
2175
2197
|
#
|
2176
2198
|
# @!attribute [rw] registered_at
|
2177
|
-
# The Unix timestamp for when the container instance was
|
2199
|
+
# The Unix timestamp for the time when the container instance was
|
2200
|
+
# registered.
|
2178
2201
|
# @return [Time]
|
2179
2202
|
#
|
2180
2203
|
# @!attribute [rw] attachments
|
@@ -2185,7 +2208,7 @@ module Aws::ECS
|
|
2185
2208
|
# @!attribute [rw] tags
|
2186
2209
|
# The metadata that you apply to the container instance to help you
|
2187
2210
|
# categorize and organize them. Each tag consists of a key and an
|
2188
|
-
# optional value
|
2211
|
+
# optional value. You define both.
|
2189
2212
|
#
|
2190
2213
|
# The following basic restrictions apply to tags:
|
2191
2214
|
#
|
@@ -2213,6 +2236,10 @@ module Aws::ECS
|
|
2213
2236
|
# against your tags per resource limit.
|
2214
2237
|
# @return [Array<Types::Tag>]
|
2215
2238
|
#
|
2239
|
+
# @!attribute [rw] health_status
|
2240
|
+
# An object representing the health status of the container instance.
|
2241
|
+
# @return [Types::ContainerInstanceHealthStatus]
|
2242
|
+
#
|
2216
2243
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerInstance AWS API Documentation
|
2217
2244
|
#
|
2218
2245
|
class ContainerInstance < Struct.new(
|
@@ -2232,15 +2259,37 @@ module Aws::ECS
|
|
2232
2259
|
:attributes,
|
2233
2260
|
:registered_at,
|
2234
2261
|
:attachments,
|
2235
|
-
:tags
|
2262
|
+
:tags,
|
2263
|
+
:health_status)
|
2236
2264
|
SENSITIVE = []
|
2237
2265
|
include Aws::Structure
|
2238
2266
|
end
|
2239
2267
|
|
2240
|
-
#
|
2268
|
+
# An object representing the health status of the container instance.
|
2269
|
+
#
|
2270
|
+
# @!attribute [rw] overall_status
|
2271
|
+
# The overall health status of the container instance. This is an
|
2272
|
+
# aggregate status of all container instance health checks.
|
2273
|
+
# @return [String]
|
2274
|
+
#
|
2275
|
+
# @!attribute [rw] details
|
2276
|
+
# An array of objects representing the details of the container
|
2277
|
+
# instance health status.
|
2278
|
+
# @return [Array<Types::InstanceHealthCheckResult>]
|
2279
|
+
#
|
2280
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerInstanceHealthStatus AWS API Documentation
|
2281
|
+
#
|
2282
|
+
class ContainerInstanceHealthStatus < Struct.new(
|
2283
|
+
:overall_status,
|
2284
|
+
:details)
|
2285
|
+
SENSITIVE = []
|
2286
|
+
include Aws::Structure
|
2287
|
+
end
|
2288
|
+
|
2289
|
+
# The overrides that are sent to a container. An empty container
|
2241
2290
|
# override can be passed in. An example of an empty container override
|
2242
|
-
#
|
2243
|
-
#
|
2291
|
+
# is `\{"containerOverrides": [ ] \}`. If a non-empty container override
|
2292
|
+
# is specified, the `name` parameter must be included.
|
2244
2293
|
#
|
2245
2294
|
# @note When making an API call, you may pass ContainerOverride
|
2246
2295
|
# data as a hash:
|
@@ -2335,7 +2384,7 @@ module Aws::ECS
|
|
2335
2384
|
include Aws::Structure
|
2336
2385
|
end
|
2337
2386
|
|
2338
|
-
# An object
|
2387
|
+
# An object that represents a change in state for a container.
|
2339
2388
|
#
|
2340
2389
|
# @note When making an API call, you may pass ContainerStateChange
|
2341
2390
|
# data as a hash:
|
@@ -2375,7 +2424,7 @@ module Aws::ECS
|
|
2375
2424
|
# @return [Integer]
|
2376
2425
|
#
|
2377
2426
|
# @!attribute [rw] network_bindings
|
2378
|
-
# Any network bindings associated with the container.
|
2427
|
+
# Any network bindings that are associated with the container.
|
2379
2428
|
# @return [Array<Types::NetworkBinding>]
|
2380
2429
|
#
|
2381
2430
|
# @!attribute [rw] reason
|
@@ -2425,10 +2474,10 @@ module Aws::ECS
|
|
2425
2474
|
# }
|
2426
2475
|
#
|
2427
2476
|
# @!attribute [rw] name
|
2428
|
-
# The name of the capacity provider. Up to 255 characters are allowed
|
2429
|
-
#
|
2430
|
-
# hyphens. The name
|
2431
|
-
# "`fargate`".
|
2477
|
+
# The name of the capacity provider. Up to 255 characters are allowed.
|
2478
|
+
# They include letters (both upper and lowercase letters), numbers,
|
2479
|
+
# underscores (\_), and hyphens (-). The name can't be prefixed with
|
2480
|
+
# "`aws`", "`ecs`", or "`fargate`".
|
2432
2481
|
# @return [String]
|
2433
2482
|
#
|
2434
2483
|
# @!attribute [rw] auto_scaling_group_provider
|
@@ -2436,9 +2485,9 @@ module Aws::ECS
|
|
2436
2485
|
# @return [Types::AutoScalingGroupProvider]
|
2437
2486
|
#
|
2438
2487
|
# @!attribute [rw] tags
|
2439
|
-
# The metadata that you apply to the capacity provider to
|
2440
|
-
#
|
2441
|
-
# optional value
|
2488
|
+
# The metadata that you apply to the capacity provider to categorize
|
2489
|
+
# and organize them more conveniently. Each tag consists of a key and
|
2490
|
+
# an optional value. You define both of them.
|
2442
2491
|
#
|
2443
2492
|
# The following basic restrictions apply to tags:
|
2444
2493
|
#
|
@@ -2529,16 +2578,16 @@ module Aws::ECS
|
|
2529
2578
|
# }
|
2530
2579
|
#
|
2531
2580
|
# @!attribute [rw] cluster_name
|
2532
|
-
# The name of your cluster. If you
|
2533
|
-
# cluster, you create a cluster named `default`. Up to 255
|
2534
|
-
# (uppercase and lowercase), numbers, underscores, and hyphens
|
2535
|
-
# allowed.
|
2581
|
+
# The name of your cluster. If you don't specify a name for your
|
2582
|
+
# cluster, you create a cluster that's named `default`. Up to 255
|
2583
|
+
# letters (uppercase and lowercase), numbers, underscores, and hyphens
|
2584
|
+
# are allowed.
|
2536
2585
|
# @return [String]
|
2537
2586
|
#
|
2538
2587
|
# @!attribute [rw] tags
|
2539
2588
|
# The metadata that you apply to the cluster to help you categorize
|
2540
|
-
# and organize them. Each tag consists of a key and an optional value
|
2541
|
-
#
|
2589
|
+
# and organize them. Each tag consists of a key and an optional value.
|
2590
|
+
# You define both.
|
2542
2591
|
#
|
2543
2592
|
# The following basic restrictions apply to tags:
|
2544
2593
|
#
|
@@ -2569,8 +2618,8 @@ module Aws::ECS
|
|
2569
2618
|
# @!attribute [rw] settings
|
2570
2619
|
# The setting to use when creating a cluster. This parameter is used
|
2571
2620
|
# to enable CloudWatch Container Insights for a cluster. If this value
|
2572
|
-
# is specified, it
|
2573
|
-
#
|
2621
|
+
# is specified, it overrides the `containerInsights` value set with
|
2622
|
+
# PutAccountSetting or PutAccountSettingDefault.
|
2574
2623
|
# @return [Array<Types::ClusterSetting>]
|
2575
2624
|
#
|
2576
2625
|
# @!attribute [rw] configuration
|
@@ -2585,10 +2634,9 @@ module Aws::ECS
|
|
2585
2634
|
# calling the CreateService or RunTask actions.
|
2586
2635
|
#
|
2587
2636
|
# If specifying a capacity provider that uses an Auto Scaling group,
|
2588
|
-
# the capacity provider must
|
2589
|
-
#
|
2590
|
-
#
|
2591
|
-
# operation.
|
2637
|
+
# the capacity provider must be created but not associated with
|
2638
|
+
# another cluster. New Auto Scaling group capacity providers can be
|
2639
|
+
# created with the CreateCapacityProvider API operation.
|
2592
2640
|
#
|
2593
2641
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
2594
2642
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
@@ -2602,13 +2650,13 @@ module Aws::ECS
|
|
2602
2650
|
#
|
2603
2651
|
# @!attribute [rw] default_capacity_provider_strategy
|
2604
2652
|
# The capacity provider strategy to set as the default for the
|
2605
|
-
# cluster.
|
2606
|
-
# cluster, when
|
2653
|
+
# cluster. After a default capacity provider strategy is set for a
|
2654
|
+
# cluster, when you call the RunTask or CreateService APIs with no
|
2607
2655
|
# capacity provider strategy or launch type specified, the default
|
2608
2656
|
# capacity provider strategy for the cluster is used.
|
2609
2657
|
#
|
2610
|
-
# If a default capacity provider strategy
|
2611
|
-
#
|
2658
|
+
# If a default capacity provider strategy isn't defined for a cluster
|
2659
|
+
# when it was created, it can be defined later with the
|
2612
2660
|
# PutClusterCapacityProviders API operation.
|
2613
2661
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
2614
2662
|
#
|
@@ -2716,8 +2764,8 @@ module Aws::ECS
|
|
2716
2764
|
# }
|
2717
2765
|
#
|
2718
2766
|
# @!attribute [rw] cluster
|
2719
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
2720
|
-
#
|
2767
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster
|
2768
|
+
# that you run your service on. If you do not specify a cluster, the
|
2721
2769
|
# default cluster is assumed.
|
2722
2770
|
# @return [String]
|
2723
2771
|
#
|
@@ -2731,11 +2779,11 @@ module Aws::ECS
|
|
2731
2779
|
#
|
2732
2780
|
# @!attribute [rw] task_definition
|
2733
2781
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
2734
|
-
# task definition to run in your service. If a `revision`
|
2782
|
+
# task definition to run in your service. If a `revision` isn't
|
2735
2783
|
# specified, the latest `ACTIVE` revision is used.
|
2736
2784
|
#
|
2737
|
-
# A task definition must be specified if the service
|
2738
|
-
#
|
2785
|
+
# A task definition must be specified if the service uses either the
|
2786
|
+
# `ECS` or `CODE_DEPLOY` deployment controllers.
|
2739
2787
|
# @return [String]
|
2740
2788
|
#
|
2741
2789
|
# @!attribute [rw] load_balancers
|
@@ -2743,56 +2791,57 @@ module Aws::ECS
|
|
2743
2791
|
# your service. For more information, see [Service Load Balancing][1]
|
2744
2792
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
2745
2793
|
#
|
2746
|
-
# If the service
|
2747
|
-
#
|
2748
|
-
#
|
2749
|
-
#
|
2750
|
-
#
|
2751
|
-
#
|
2752
|
-
#
|
2794
|
+
# If the service uses the rolling update (`ECS`) deployment controller
|
2795
|
+
# and using either an Application Load Balancer or Network Load
|
2796
|
+
# Balancer, you must specify one or more target group ARNs to attach
|
2797
|
+
# to the service. The service-linked role is required for services
|
2798
|
+
# that use multiple target groups. For more information, see [Using
|
2799
|
+
# service-linked roles for Amazon ECS][2] in the *Amazon Elastic
|
2800
|
+
# Container Service Developer Guide*.
|
2753
2801
|
#
|
2754
|
-
# If the service
|
2802
|
+
# If the service uses the `CODE_DEPLOY` deployment controller, the
|
2755
2803
|
# service is required to use either an Application Load Balancer or
|
2756
2804
|
# Network Load Balancer. When creating an CodeDeploy deployment group,
|
2757
2805
|
# you specify two target groups (referred to as a `targetGroupPair`).
|
2758
2806
|
# During a deployment, CodeDeploy determines which task set in your
|
2759
|
-
# service has the status `PRIMARY
|
2760
|
-
# with it,
|
2807
|
+
# service has the status `PRIMARY`, and it associates one target group
|
2808
|
+
# with it. Then, it also associates the other target group with the
|
2761
2809
|
# replacement task set. The load balancer can also have up to two
|
2762
2810
|
# listeners: a required listener for production traffic and an
|
2763
|
-
# optional listener that
|
2811
|
+
# optional listener that you can use to perform validation tests with
|
2764
2812
|
# Lambda functions before routing production traffic to it.
|
2765
2813
|
#
|
2766
2814
|
# After you create a service using the `ECS` deployment controller,
|
2767
2815
|
# the load balancer name or target group ARN, container name, and
|
2768
|
-
# container port specified in the service definition are
|
2769
|
-
# you
|
2770
|
-
# can be changed when updating the service.
|
2816
|
+
# container port that's specified in the service definition are
|
2817
|
+
# immutable. If you use the `CODE_DEPLOY` deployment controller, these
|
2818
|
+
# values can be changed when updating the service.
|
2771
2819
|
#
|
2772
2820
|
# For Application Load Balancers and Network Load Balancers, this
|
2773
2821
|
# object must contain the load balancer target group ARN, the
|
2774
|
-
# container name
|
2775
|
-
# container
|
2776
|
-
# name parameter must be omitted. When a
|
2777
|
-
# placed on a container instance, the
|
2778
|
-
# combination is registered as a target in
|
2779
|
-
# here.
|
2822
|
+
# container name, and the container port to access from the load
|
2823
|
+
# balancer. The container name must be as it appears in a container
|
2824
|
+
# definition. The load balancer name parameter must be omitted. When a
|
2825
|
+
# task from this service is placed on a container instance, the
|
2826
|
+
# container instance and port combination is registered as a target in
|
2827
|
+
# the target group that's specified here.
|
2780
2828
|
#
|
2781
2829
|
# For Classic Load Balancers, this object must contain the load
|
2782
|
-
# balancer name, the container name
|
2783
|
-
#
|
2784
|
-
#
|
2785
|
-
# task from this service is placed on a container
|
2786
|
-
# container instance is registered with the load
|
2787
|
-
# here.
|
2830
|
+
# balancer name, the container name , and the container port to access
|
2831
|
+
# from the load balancer. The container name must be as it appears in
|
2832
|
+
# a container definition. The target group ARN parameter must be
|
2833
|
+
# omitted. When a task from this service is placed on a container
|
2834
|
+
# instance, the container instance is registered with the load
|
2835
|
+
# balancer that's specified here.
|
2788
2836
|
#
|
2789
2837
|
# Services with tasks that use the `awsvpc` network mode (for example,
|
2790
2838
|
# those with the Fargate launch type) only support Application Load
|
2791
|
-
# Balancers and Network Load Balancers. Classic Load Balancers
|
2839
|
+
# Balancers and Network Load Balancers. Classic Load Balancers aren't
|
2792
2840
|
# supported. Also, when you create any target groups for these
|
2793
|
-
# services, you must choose `ip` as the target type, not `instance
|
2794
|
-
# because tasks that use the `awsvpc` network mode are
|
2795
|
-
# an elastic network interface, not an Amazon EC2
|
2841
|
+
# services, you must choose `ip` as the target type, not `instance`.
|
2842
|
+
# This is because tasks that use the `awsvpc` network mode are
|
2843
|
+
# associated with an elastic network interface, not an Amazon EC2
|
2844
|
+
# instance.
|
2796
2845
|
#
|
2797
2846
|
#
|
2798
2847
|
#
|
@@ -2805,7 +2854,7 @@ module Aws::ECS
|
|
2805
2854
|
# service. For more information, see [Service discovery][1].
|
2806
2855
|
#
|
2807
2856
|
# <note markdown="1"> Each service may be associated with one service registry. Multiple
|
2808
|
-
# service registries
|
2857
|
+
# service registries for each service isn't supported.
|
2809
2858
|
#
|
2810
2859
|
# </note>
|
2811
2860
|
#
|
@@ -2818,18 +2867,19 @@ module Aws::ECS
|
|
2818
2867
|
# The number of instantiations of the specified task definition to
|
2819
2868
|
# place and keep running on your cluster.
|
2820
2869
|
#
|
2821
|
-
# This is required if `schedulingStrategy` is `REPLICA` or
|
2822
|
-
# specified. If `schedulingStrategy` is `DAEMON` then this
|
2870
|
+
# This is required if `schedulingStrategy` is `REPLICA` or isn't
|
2871
|
+
# specified. If `schedulingStrategy` is `DAEMON` then this isn't
|
2823
2872
|
# required.
|
2824
2873
|
# @return [Integer]
|
2825
2874
|
#
|
2826
2875
|
# @!attribute [rw] client_token
|
2827
|
-
#
|
2828
|
-
#
|
2876
|
+
# An identifier that you provide to ensure the idempotency of the
|
2877
|
+
# request. It must be unique and is case sensitive. Up to 32 ASCII
|
2878
|
+
# characters are allowed.
|
2829
2879
|
# @return [String]
|
2830
2880
|
#
|
2831
2881
|
# @!attribute [rw] launch_type
|
2832
|
-
# The infrastructure
|
2882
|
+
# The infrastructure that you run your service on. For more
|
2833
2883
|
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
2834
2884
|
# Container Service Developer Guide*.
|
2835
2885
|
#
|
@@ -2845,8 +2895,8 @@ module Aws::ECS
|
|
2845
2895
|
# The `EC2` launch type runs your tasks on Amazon EC2 instances
|
2846
2896
|
# registered to your cluster.
|
2847
2897
|
#
|
2848
|
-
# The `EXTERNAL` launch type runs your tasks on your on-
|
2849
|
-
# or virtual machine (VM) capacity registered to your cluster.
|
2898
|
+
# The `EXTERNAL` launch type runs your tasks on your on-premises
|
2899
|
+
# server or virtual machine (VM) capacity registered to your cluster.
|
2850
2900
|
#
|
2851
2901
|
# A service can use either a launch type or a capacity provider
|
2852
2902
|
# strategy. If a `launchType` is specified, the
|
@@ -2874,9 +2924,8 @@ module Aws::ECS
|
|
2874
2924
|
# The platform version that your tasks in the service are running on.
|
2875
2925
|
# A platform version is specified only for tasks using the Fargate
|
2876
2926
|
# launch type. If one isn't specified, the `LATEST` platform version
|
2877
|
-
# is used
|
2878
|
-
#
|
2879
|
-
# Guide*.
|
2927
|
+
# is used. For more information, see [Fargate platform versions][1] in
|
2928
|
+
# the *Amazon Elastic Container Service Developer Guide*.
|
2880
2929
|
#
|
2881
2930
|
#
|
2882
2931
|
#
|
@@ -2887,20 +2936,20 @@ module Aws::ECS
|
|
2887
2936
|
# The name or full Amazon Resource Name (ARN) of the IAM role that
|
2888
2937
|
# allows Amazon ECS to make calls to your load balancer on your
|
2889
2938
|
# behalf. This parameter is only permitted if you are using a load
|
2890
|
-
# balancer with your service and your task definition
|
2939
|
+
# balancer with your service and your task definition doesn't use the
|
2891
2940
|
# `awsvpc` network mode. If you specify the `role` parameter, you must
|
2892
2941
|
# also specify a load balancer object with the `loadBalancers`
|
2893
2942
|
# parameter.
|
2894
2943
|
#
|
2895
2944
|
# If your account has already created the Amazon ECS service-linked
|
2896
|
-
# role, that role is used
|
2897
|
-
#
|
2898
|
-
#
|
2899
|
-
#
|
2900
|
-
#
|
2901
|
-
#
|
2902
|
-
#
|
2903
|
-
#
|
2945
|
+
# role, that role is used for your service unless you specify a role
|
2946
|
+
# here. The service-linked role is required if your task definition
|
2947
|
+
# uses the `awsvpc` network mode or if the service is configured to
|
2948
|
+
# use service discovery, an external deployment controller, multiple
|
2949
|
+
# target groups, or Elastic Inference accelerators in which case you
|
2950
|
+
# don't specify a role here. For more information, see [Using
|
2951
|
+
# service-linked roles for Amazon ECS][1] in the *Amazon Elastic
|
2952
|
+
# Container Service Developer Guide*.
|
2904
2953
|
#
|
2905
2954
|
# If your specified role has a path other than `/`, then you must
|
2906
2955
|
# either specify the full role ARN (this is recommended) or prefix the
|
@@ -2923,20 +2972,20 @@ module Aws::ECS
|
|
2923
2972
|
#
|
2924
2973
|
# @!attribute [rw] placement_constraints
|
2925
2974
|
# An array of placement constraint objects to use for tasks in your
|
2926
|
-
# service. You can specify a maximum of 10 constraints
|
2927
|
-
# limit includes constraints in the task definition and those
|
2928
|
-
# specified at runtime
|
2975
|
+
# service. You can specify a maximum of 10 constraints for each task.
|
2976
|
+
# This limit includes constraints in the task definition and those
|
2977
|
+
# specified at runtime.
|
2929
2978
|
# @return [Array<Types::PlacementConstraint>]
|
2930
2979
|
#
|
2931
2980
|
# @!attribute [rw] placement_strategy
|
2932
2981
|
# The placement strategy objects to use for tasks in your service. You
|
2933
|
-
# can specify a maximum of 5 strategy rules
|
2982
|
+
# can specify a maximum of 5 strategy rules for each service.
|
2934
2983
|
# @return [Array<Types::PlacementStrategy>]
|
2935
2984
|
#
|
2936
2985
|
# @!attribute [rw] network_configuration
|
2937
2986
|
# The network configuration for the service. This parameter is
|
2938
2987
|
# required for task definitions that use the `awsvpc` network mode to
|
2939
|
-
# receive their own elastic network interface, and it
|
2988
|
+
# receive their own elastic network interface, and it isn't supported
|
2940
2989
|
# for other network modes. For more information, see [Task
|
2941
2990
|
# networking][1] in the *Amazon Elastic Container Service Developer
|
2942
2991
|
# Guide*.
|
@@ -2948,18 +2997,19 @@ module Aws::ECS
|
|
2948
2997
|
#
|
2949
2998
|
# @!attribute [rw] health_check_grace_period_seconds
|
2950
2999
|
# The period of time, in seconds, that the Amazon ECS service
|
2951
|
-
# scheduler
|
2952
|
-
#
|
2953
|
-
#
|
2954
|
-
#
|
2955
|
-
#
|
3000
|
+
# scheduler ignores unhealthy Elastic Load Balancing target health
|
3001
|
+
# checks after a task has first started. This is only used when your
|
3002
|
+
# service is configured to use a load balancer. If your service has a
|
3003
|
+
# load balancer defined and you don't specify a health check grace
|
3004
|
+
# period value, the default value of `0` is used.
|
2956
3005
|
#
|
2957
3006
|
# If your service's tasks take a while to start and respond to
|
2958
3007
|
# Elastic Load Balancing health checks, you can specify a health check
|
2959
|
-
# grace period of up to 2,147,483,647 seconds
|
2960
|
-
# Amazon ECS service scheduler ignores health check
|
2961
|
-
# period can prevent the service scheduler from
|
2962
|
-
# unhealthy and stopping them before they have time
|
3008
|
+
# grace period of up to 2,147,483,647 seconds (about 69 years). During
|
3009
|
+
# that time, the Amazon ECS service scheduler ignores health check
|
3010
|
+
# status. This grace period can prevent the service scheduler from
|
3011
|
+
# marking tasks as unhealthy and stopping them before they have time
|
3012
|
+
# to come up.
|
2963
3013
|
# @return [Integer]
|
2964
3014
|
#
|
2965
3015
|
# @!attribute [rw] scheduling_strategy
|
@@ -2973,14 +3023,14 @@ module Aws::ECS
|
|
2973
3023
|
# service scheduler spreads tasks across Availability Zones. You can
|
2974
3024
|
# use task placement strategies and constraints to customize task
|
2975
3025
|
# placement decisions. This scheduler strategy is required if the
|
2976
|
-
# service
|
2977
|
-
#
|
3026
|
+
# service uses the `CODE_DEPLOY` or `EXTERNAL` deployment controller
|
3027
|
+
# types.
|
2978
3028
|
#
|
2979
3029
|
# * `DAEMON`-The daemon scheduling strategy deploys exactly one task
|
2980
3030
|
# on each active container instance that meets all of the task
|
2981
3031
|
# placement constraints that you specify in your cluster. The
|
2982
3032
|
# service scheduler also evaluates the task placement constraints
|
2983
|
-
# for running tasks and will stop tasks that
|
3033
|
+
# for running tasks and will stop tasks that don't meet the
|
2984
3034
|
# placement constraints. When you're using this strategy, you
|
2985
3035
|
# don't need to specify a desired number of tasks, a task placement
|
2986
3036
|
# strategy, or use Service Auto Scaling policies.
|
@@ -3047,16 +3097,16 @@ module Aws::ECS
|
|
3047
3097
|
# @!attribute [rw] propagate_tags
|
3048
3098
|
# Specifies whether to propagate the tags from the task definition or
|
3049
3099
|
# the service to the tasks in the service. If no value is specified,
|
3050
|
-
# the tags
|
3100
|
+
# the tags aren't propagated. Tags can only be propagated to the
|
3051
3101
|
# tasks within the service during service creation. To add tags to a
|
3052
3102
|
# task after service creation or task creation, use the TagResource
|
3053
3103
|
# API action.
|
3054
3104
|
# @return [String]
|
3055
3105
|
#
|
3056
3106
|
# @!attribute [rw] enable_execute_command
|
3057
|
-
#
|
3058
|
-
# service. If `true`, this enables execute command functionality
|
3059
|
-
# all containers in the service tasks.
|
3107
|
+
# Determines whether the execute command functionality is enabled for
|
3108
|
+
# the service. If `true`, this enables execute command functionality
|
3109
|
+
# on all containers in the service tasks.
|
3060
3110
|
# @return [Boolean]
|
3061
3111
|
#
|
3062
3112
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateServiceRequest AWS API Documentation
|
@@ -3092,14 +3142,14 @@ module Aws::ECS
|
|
3092
3142
|
# The full description of your service following the create call.
|
3093
3143
|
#
|
3094
3144
|
# A service will return either a `capacityProviderStrategy` or
|
3095
|
-
# `launchType` parameter, but not both, depending
|
3096
|
-
# specified
|
3145
|
+
# `launchType` parameter, but not both, depending where one was
|
3146
|
+
# specified when it was created.
|
3097
3147
|
#
|
3098
3148
|
# If a service is using the `ECS` deployment controller, the
|
3099
3149
|
# `deploymentController` and `taskSets` parameters will not be
|
3100
3150
|
# returned.
|
3101
3151
|
#
|
3102
|
-
#
|
3152
|
+
# if the service uses the `CODE_DEPLOY` deployment controller, the
|
3103
3153
|
# `deploymentController`, `taskSets` and `deployments` parameters will
|
3104
3154
|
# be returned, however the `deployments` parameter will be an empty
|
3105
3155
|
# list.
|
@@ -3208,7 +3258,7 @@ module Aws::ECS
|
|
3208
3258
|
# @return [Array<Types::ServiceRegistry>]
|
3209
3259
|
#
|
3210
3260
|
# @!attribute [rw] launch_type
|
3211
|
-
# The launch type that new tasks in the task set
|
3261
|
+
# The launch type that new tasks in the task set uses. For more
|
3212
3262
|
# information, see [Amazon ECS Launch Types][1] in the *Amazon Elastic
|
3213
3263
|
# Container Service Developer Guide*.
|
3214
3264
|
#
|
@@ -3251,10 +3301,9 @@ module Aws::ECS
|
|
3251
3301
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
3252
3302
|
#
|
3253
3303
|
# @!attribute [rw] platform_version
|
3254
|
-
# The platform version that the tasks in the task set
|
3255
|
-
#
|
3256
|
-
#
|
3257
|
-
# is used by default.
|
3304
|
+
# The platform version that the tasks in the task set uses. A platform
|
3305
|
+
# version is specified only for tasks using the Fargate launch type.
|
3306
|
+
# If one isn't specified, the `LATEST` platform version is used.
|
3258
3307
|
# @return [String]
|
3259
3308
|
#
|
3260
3309
|
# @!attribute [rw] scale
|
@@ -3263,15 +3312,15 @@ module Aws::ECS
|
|
3263
3312
|
# @return [Types::Scale]
|
3264
3313
|
#
|
3265
3314
|
# @!attribute [rw] client_token
|
3266
|
-
#
|
3267
|
-
#
|
3315
|
+
# The identifier that you provide to ensure the idempotency of the
|
3316
|
+
# request. It's case sensitive and must be unique. It can be up to 32
|
3317
|
+
# ASCII characters are allowed.
|
3268
3318
|
# @return [String]
|
3269
3319
|
#
|
3270
3320
|
# @!attribute [rw] tags
|
3271
3321
|
# The metadata that you apply to the task set to help you categorize
|
3272
|
-
# and organize them. Each tag consists of a key and an optional value
|
3273
|
-
#
|
3274
|
-
# deleted as well.
|
3322
|
+
# and organize them. Each tag consists of a key and an optional value.
|
3323
|
+
# You define both. When a service is deleted, the tags are deleted.
|
3275
3324
|
#
|
3276
3325
|
# The following basic restrictions apply to tags:
|
3277
3326
|
#
|
@@ -3343,7 +3392,7 @@ module Aws::ECS
|
|
3343
3392
|
# }
|
3344
3393
|
#
|
3345
3394
|
# @!attribute [rw] name
|
3346
|
-
# The resource name
|
3395
|
+
# The resource name to disable the account setting for. If
|
3347
3396
|
# `serviceLongArnFormat` is specified, the ARN for your Amazon ECS
|
3348
3397
|
# services is affected. If `taskLongArnFormat` is specified, the ARN
|
3349
3398
|
# and resource ID for your Amazon ECS tasks is affected. If
|
@@ -3354,12 +3403,12 @@ module Aws::ECS
|
|
3354
3403
|
# @return [String]
|
3355
3404
|
#
|
3356
3405
|
# @!attribute [rw] principal_arn
|
3357
|
-
# The ARN of the principal
|
3358
|
-
# root user. If you specify the root user, it
|
3359
|
-
# setting for all IAM users, IAM roles, and the
|
3360
|
-
# account unless an IAM user or role explicitly
|
3361
|
-
# settings. If this field is omitted, the setting is
|
3362
|
-
# the authenticated user.
|
3406
|
+
# The Amazon Resource Name (ARN) of the principal. It can be an IAM
|
3407
|
+
# user, IAM role, or the root user. If you specify the root user, it
|
3408
|
+
# disables the account setting for all IAM users, IAM roles, and the
|
3409
|
+
# root user of the account unless an IAM user or role explicitly
|
3410
|
+
# overrides these settings. If this field is omitted, the setting is
|
3411
|
+
# changed only for the authenticated user.
|
3363
3412
|
# @return [String]
|
3364
3413
|
#
|
3365
3414
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteAccountSettingRequest AWS API Documentation
|
@@ -3406,8 +3455,8 @@ module Aws::ECS
|
|
3406
3455
|
#
|
3407
3456
|
# @!attribute [rw] attributes
|
3408
3457
|
# The attributes to delete from your resource. You can specify up to
|
3409
|
-
# 10 attributes
|
3410
|
-
# attribute name and target ID, but
|
3458
|
+
# 10 attributes for each request. For custom attributes, specify the
|
3459
|
+
# attribute name and target ID, but don't specify the value. If you
|
3411
3460
|
# specify the target ID using the short form, you must also specify
|
3412
3461
|
# the target type.
|
3413
3462
|
# @return [Array<Types::Attribute>]
|
@@ -3518,9 +3567,9 @@ module Aws::ECS
|
|
3518
3567
|
# @return [String]
|
3519
3568
|
#
|
3520
3569
|
# @!attribute [rw] force
|
3521
|
-
# If `true`, allows you to delete a service even if it
|
3522
|
-
#
|
3523
|
-
#
|
3570
|
+
# If `true`, allows you to delete a service even if it wasn't scaled
|
3571
|
+
# down to zero tasks. It's only necessary to use this if the service
|
3572
|
+
# uses the `REPLICA` scheduling strategy.
|
3524
3573
|
# @return [Boolean]
|
3525
3574
|
#
|
3526
3575
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteServiceRequest AWS API Documentation
|
@@ -3557,7 +3606,7 @@ module Aws::ECS
|
|
3557
3606
|
#
|
3558
3607
|
# @!attribute [rw] cluster
|
3559
3608
|
# The short name or full Amazon Resource Name (ARN) of the cluster
|
3560
|
-
# that hosts the service that the task set
|
3609
|
+
# that hosts the service that the task set found in to delete.
|
3561
3610
|
# @return [String]
|
3562
3611
|
#
|
3563
3612
|
# @!attribute [rw] service
|
@@ -3571,8 +3620,8 @@ module Aws::ECS
|
|
3571
3620
|
# @return [String]
|
3572
3621
|
#
|
3573
3622
|
# @!attribute [rw] force
|
3574
|
-
# If `true`,
|
3575
|
-
#
|
3623
|
+
# If `true`, you can delete a task set even if it hasn't been scaled
|
3624
|
+
# down to zero.
|
3576
3625
|
# @return [Boolean]
|
3577
3626
|
#
|
3578
3627
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteTaskSetRequest AWS API Documentation
|
@@ -3606,7 +3655,7 @@ module Aws::ECS
|
|
3606
3655
|
# @return [String]
|
3607
3656
|
#
|
3608
3657
|
# @!attribute [rw] status
|
3609
|
-
# The status of the deployment. The following describes each state
|
3658
|
+
# The status of the deployment. The following describes each state.
|
3610
3659
|
#
|
3611
3660
|
# PRIMARY
|
3612
3661
|
#
|
@@ -3656,11 +3705,13 @@ module Aws::ECS
|
|
3656
3705
|
# @return [Integer]
|
3657
3706
|
#
|
3658
3707
|
# @!attribute [rw] created_at
|
3659
|
-
# The Unix timestamp for when the service deployment was
|
3708
|
+
# The Unix timestamp for the time when the service deployment was
|
3709
|
+
# created.
|
3660
3710
|
# @return [Time]
|
3661
3711
|
#
|
3662
3712
|
# @!attribute [rw] updated_at
|
3663
|
-
# The Unix timestamp for when the service deployment was last
|
3713
|
+
# The Unix timestamp for the time when the service deployment was last
|
3714
|
+
# updated.
|
3664
3715
|
# @return [Time]
|
3665
3716
|
#
|
3666
3717
|
# @!attribute [rw] capacity_provider_strategy
|
@@ -3678,18 +3729,26 @@ module Aws::ECS
|
|
3678
3729
|
# @return [String]
|
3679
3730
|
#
|
3680
3731
|
# @!attribute [rw] platform_version
|
3681
|
-
# The platform version
|
3682
|
-
#
|
3683
|
-
# launch type. If one
|
3684
|
-
# is used
|
3685
|
-
#
|
3686
|
-
# Guide*.
|
3732
|
+
# The platform version that your tasks in the service run on. A
|
3733
|
+
# platform version is only specified for tasks using the Fargate
|
3734
|
+
# launch type. If one isn't specified, the `LATEST` platform version
|
3735
|
+
# is used. For more information, see [Fargate Platform Versions][1] in
|
3736
|
+
# the *Amazon Elastic Container Service Developer Guide*.
|
3687
3737
|
#
|
3688
3738
|
#
|
3689
3739
|
#
|
3690
3740
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
3691
3741
|
# @return [String]
|
3692
3742
|
#
|
3743
|
+
# @!attribute [rw] platform_family
|
3744
|
+
# The operating system that your tasks in the service, or tasks are
|
3745
|
+
# running on. A platform family is specified only for tasks using the
|
3746
|
+
# Fargate launch type.
|
3747
|
+
#
|
3748
|
+
# All tasks that run as part of this service must use the same
|
3749
|
+
# `platformFamily` value as the service, for example, ` LINUX.`.
|
3750
|
+
# @return [String]
|
3751
|
+
#
|
3693
3752
|
# @!attribute [rw] network_configuration
|
3694
3753
|
# The VPC subnet and security group configuration for tasks that
|
3695
3754
|
# receive their own elastic network interface by using the `awsvpc`
|
@@ -3698,18 +3757,18 @@ module Aws::ECS
|
|
3698
3757
|
#
|
3699
3758
|
# @!attribute [rw] rollout_state
|
3700
3759
|
# <note markdown="1"> The `rolloutState` of a service is only returned for services that
|
3701
|
-
# use the rolling update (`ECS`) deployment type that
|
3760
|
+
# use the rolling update (`ECS`) deployment type that aren't behind a
|
3702
3761
|
# Classic Load Balancer.
|
3703
3762
|
#
|
3704
3763
|
# </note>
|
3705
3764
|
#
|
3706
3765
|
# The rollout state of the deployment. When a service deployment is
|
3707
3766
|
# started, it begins in an `IN_PROGRESS` state. When the service
|
3708
|
-
# reaches a steady state, the deployment
|
3709
|
-
#
|
3710
|
-
#
|
3711
|
-
#
|
3712
|
-
#
|
3767
|
+
# reaches a steady state, the deployment transitions to a `COMPLETED`
|
3768
|
+
# state. If the service fails to reach a steady state and circuit
|
3769
|
+
# breaker is enabled, the deployment transitions to a `FAILED` state.
|
3770
|
+
# A deployment in `FAILED` state doesn't launch any new tasks. For
|
3771
|
+
# more information, see DeploymentCircuitBreaker.
|
3713
3772
|
# @return [String]
|
3714
3773
|
#
|
3715
3774
|
# @!attribute [rw] rollout_state_reason
|
@@ -3731,6 +3790,7 @@ module Aws::ECS
|
|
3731
3790
|
:capacity_provider_strategy,
|
3732
3791
|
:launch_type,
|
3733
3792
|
:platform_version,
|
3793
|
+
:platform_family,
|
3734
3794
|
:network_configuration,
|
3735
3795
|
:rollout_state,
|
3736
3796
|
:rollout_state_reason)
|
@@ -3739,7 +3799,7 @@ module Aws::ECS
|
|
3739
3799
|
end
|
3740
3800
|
|
3741
3801
|
# <note markdown="1"> The deployment circuit breaker can only be used for services using the
|
3742
|
-
# rolling update (`ECS`) deployment type that
|
3802
|
+
# rolling update (`ECS`) deployment type that aren't behind a Classic
|
3743
3803
|
# Load Balancer.
|
3744
3804
|
#
|
3745
3805
|
# </note>
|
@@ -3765,15 +3825,15 @@ module Aws::ECS
|
|
3765
3825
|
# }
|
3766
3826
|
#
|
3767
3827
|
# @!attribute [rw] enable
|
3768
|
-
#
|
3769
|
-
# service.
|
3828
|
+
# Determines whether to enable the deployment circuit breaker logic
|
3829
|
+
# for the service.
|
3770
3830
|
# @return [Boolean]
|
3771
3831
|
#
|
3772
3832
|
# @!attribute [rw] rollback
|
3773
|
-
#
|
3774
|
-
# deployment fails. If rollback is enabled, when a service
|
3775
|
-
# fails, the service is rolled back to the last deployment
|
3776
|
-
# completed successfully.
|
3833
|
+
# Determines whether to enable Amazon ECS to roll back the service if
|
3834
|
+
# a service deployment fails. If rollback is enabled, when a service
|
3835
|
+
# deployment fails, the service is rolled back to the last deployment
|
3836
|
+
# that completed successfully.
|
3777
3837
|
# @return [Boolean]
|
3778
3838
|
#
|
3779
3839
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeploymentCircuitBreaker AWS API Documentation
|
@@ -3850,10 +3910,10 @@ module Aws::ECS
|
|
3850
3910
|
# service has a desired number of four tasks and a minimum healthy
|
3851
3911
|
# percent of 50%, the scheduler may stop two existing tasks to free up
|
3852
3912
|
# cluster capacity before starting two new tasks. Tasks for services
|
3853
|
-
# that *do not* use a load balancer are considered healthy if they
|
3913
|
+
# that *do not* use a load balancer are considered healthy if they're
|
3854
3914
|
# in the `RUNNING` state; tasks for services that *do* use a load
|
3855
|
-
# balancer are considered healthy if they
|
3856
|
-
# and they
|
3915
|
+
# balancer are considered healthy if they're in the `RUNNING` state
|
3916
|
+
# and they're reported as healthy by the load balancer. The default
|
3857
3917
|
# value for minimum healthy percent is 100%.
|
3858
3918
|
#
|
3859
3919
|
# If a service is using the blue/green (`CODE_DEPLOY`) or `EXTERNAL`
|
@@ -3952,13 +4012,13 @@ module Aws::ECS
|
|
3952
4012
|
# @return [String]
|
3953
4013
|
#
|
3954
4014
|
# @!attribute [rw] force
|
3955
|
-
# Forces the
|
3956
|
-
#
|
3957
|
-
#
|
3958
|
-
#
|
3959
|
-
#
|
3960
|
-
#
|
3961
|
-
#
|
4015
|
+
# Forces the container instance to be deregistered. If you have tasks
|
4016
|
+
# running on the container instance when you deregister it with the
|
4017
|
+
# `force` option, these tasks remain running until you terminate the
|
4018
|
+
# instance or the tasks stop through some other means, but they're
|
4019
|
+
# orphaned (no longer monitored or accounted for by Amazon ECS). If an
|
4020
|
+
# orphaned task on your container instance is part of an Amazon ECS
|
4021
|
+
# service, then the service scheduler starts another copy of that
|
3962
4022
|
# task, on a different container instance if possible.
|
3963
4023
|
#
|
3964
4024
|
# Any containers in orphaned service tasks that are registered with a
|
@@ -4041,7 +4101,7 @@ module Aws::ECS
|
|
4041
4101
|
# @!attribute [rw] include
|
4042
4102
|
# Specifies whether or not you want to see the resource tags for the
|
4043
4103
|
# capacity provider. If `TAGS` is specified, the tags are included in
|
4044
|
-
# the response. If this field is omitted, tags
|
4104
|
+
# the response. If this field is omitted, tags aren't included in the
|
4045
4105
|
# response.
|
4046
4106
|
# @return [Array<String>]
|
4047
4107
|
#
|
@@ -4123,9 +4183,9 @@ module Aws::ECS
|
|
4123
4183
|
# @return [Array<String>]
|
4124
4184
|
#
|
4125
4185
|
# @!attribute [rw] include
|
4126
|
-
#
|
4127
|
-
# response. If this field is omitted, this information
|
4128
|
-
# included.
|
4186
|
+
# Determines whether to include additional information about the
|
4187
|
+
# clusters in the response. If this field is omitted, this information
|
4188
|
+
# isn't included.
|
4129
4189
|
#
|
4130
4190
|
# If `ATTACHMENTS` is specified, the attachments for the container
|
4131
4191
|
# instances or tasks within the cluster are included.
|
@@ -4175,7 +4235,7 @@ module Aws::ECS
|
|
4175
4235
|
# {
|
4176
4236
|
# cluster: "String",
|
4177
4237
|
# container_instances: ["String"], # required
|
4178
|
-
# include: ["TAGS"], # accepts TAGS
|
4238
|
+
# include: ["TAGS"], # accepts TAGS, CONTAINER_INSTANCE_HEALTH
|
4179
4239
|
# }
|
4180
4240
|
#
|
4181
4241
|
# @!attribute [rw] cluster
|
@@ -4195,8 +4255,10 @@ module Aws::ECS
|
|
4195
4255
|
# @!attribute [rw] include
|
4196
4256
|
# Specifies whether you want to see the resource tags for the
|
4197
4257
|
# container instance. If `TAGS` is specified, the tags are included in
|
4198
|
-
# the response. If
|
4199
|
-
# response.
|
4258
|
+
# the response. If `CONTAINER_INSTANCE_HEALTH` is specified, the
|
4259
|
+
# container instance health is included in the response. If this field
|
4260
|
+
# is omitted, tags and container instance health status aren't
|
4261
|
+
# included in the response.
|
4200
4262
|
# @return [Array<String>]
|
4201
4263
|
#
|
4202
4264
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeContainerInstancesRequest AWS API Documentation
|
@@ -4249,9 +4311,10 @@ module Aws::ECS
|
|
4249
4311
|
# @return [Array<String>]
|
4250
4312
|
#
|
4251
4313
|
# @!attribute [rw] include
|
4252
|
-
#
|
4253
|
-
# If `TAGS` is specified, the tags are included in the
|
4254
|
-
# this field is omitted, tags
|
4314
|
+
# Determines whether you want to see the resource tags for the
|
4315
|
+
# service. If `TAGS` is specified, the tags are included in the
|
4316
|
+
# response. If this field is omitted, tags aren't included in the
|
4317
|
+
# response.
|
4255
4318
|
# @return [Array<String>]
|
4256
4319
|
#
|
4257
4320
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServicesRequest AWS API Documentation
|
@@ -4297,9 +4360,9 @@ module Aws::ECS
|
|
4297
4360
|
# @return [String]
|
4298
4361
|
#
|
4299
4362
|
# @!attribute [rw] include
|
4300
|
-
#
|
4363
|
+
# Determines whether to see the resource tags for the task definition.
|
4301
4364
|
# If `TAGS` is specified, the tags are included in the response. If
|
4302
|
-
# this field is omitted, tags
|
4365
|
+
# this field is omitted, tags aren't included in the response.
|
4303
4366
|
# @return [Array<String>]
|
4304
4367
|
#
|
4305
4368
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskDefinitionRequest AWS API Documentation
|
@@ -4316,9 +4379,9 @@ module Aws::ECS
|
|
4316
4379
|
# @return [Types::TaskDefinition]
|
4317
4380
|
#
|
4318
4381
|
# @!attribute [rw] tags
|
4319
|
-
# The metadata that
|
4382
|
+
# The metadata that's applied to the task definition to help you
|
4320
4383
|
# categorize and organize them. Each tag consists of a key and an
|
4321
|
-
# optional value
|
4384
|
+
# optional value. You define both.
|
4322
4385
|
#
|
4323
4386
|
# The following basic restrictions apply to tags:
|
4324
4387
|
#
|
@@ -4382,7 +4445,7 @@ module Aws::ECS
|
|
4382
4445
|
# @!attribute [rw] include
|
4383
4446
|
# Specifies whether to see the resource tags for the task set. If
|
4384
4447
|
# `TAGS` is specified, the tags are included in the response. If this
|
4385
|
-
# field is omitted, tags
|
4448
|
+
# field is omitted, tags aren't included in the response.
|
4386
4449
|
# @return [Array<String>]
|
4387
4450
|
#
|
4388
4451
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskSetsRequest AWS API Documentation
|
@@ -4437,7 +4500,7 @@ module Aws::ECS
|
|
4437
4500
|
# @!attribute [rw] include
|
4438
4501
|
# Specifies whether you want to see the resource tags for the task. If
|
4439
4502
|
# `TAGS` is specified, the tags are included in the response. If this
|
4440
|
-
# field is omitted, tags
|
4503
|
+
# field is omitted, tags aren't included in the response.
|
4441
4504
|
# @return [Array<String>]
|
4442
4505
|
#
|
4443
4506
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTasksRequest AWS API Documentation
|
@@ -4520,8 +4583,8 @@ module Aws::ECS
|
|
4520
4583
|
# @return [String]
|
4521
4584
|
#
|
4522
4585
|
# @!attribute [rw] cluster
|
4523
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
4524
|
-
#
|
4586
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster
|
4587
|
+
# that the container instance belongs to.
|
4525
4588
|
# @return [String]
|
4526
4589
|
#
|
4527
4590
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DiscoverPollEndpointRequest AWS API Documentation
|
@@ -4550,8 +4613,8 @@ module Aws::ECS
|
|
4550
4613
|
include Aws::Structure
|
4551
4614
|
end
|
4552
4615
|
|
4553
|
-
# This parameter is specified when you
|
4554
|
-
# volumes are only supported when you
|
4616
|
+
# This parameter is specified when you're using Docker volumes. Docker
|
4617
|
+
# volumes are only supported when you're using the EC2 launch type.
|
4555
4618
|
# Windows containers only support the use of the `local` driver. To use
|
4556
4619
|
# bind mounts, specify a `host` instead.
|
4557
4620
|
#
|
@@ -4579,7 +4642,7 @@ module Aws::ECS
|
|
4579
4642
|
# @return [String]
|
4580
4643
|
#
|
4581
4644
|
# @!attribute [rw] autoprovision
|
4582
|
-
# If this value is `true`, the Docker volume is created if it
|
4645
|
+
# If this value is `true`, the Docker volume is created if it doesn't
|
4583
4646
|
# already exist.
|
4584
4647
|
#
|
4585
4648
|
# <note markdown="1"> This field is only used if the `scope` is `shared`.
|
@@ -4671,12 +4734,13 @@ module Aws::ECS
|
|
4671
4734
|
# @return [String]
|
4672
4735
|
#
|
4673
4736
|
# @!attribute [rw] iam
|
4674
|
-
#
|
4675
|
-
# definition when mounting the Amazon EFS file system. If
|
4676
|
-
# transit encryption must be enabled in the
|
4677
|
-
# If this parameter is omitted, the default
|
4678
|
-
# used. For more information, see [Using Amazon
|
4679
|
-
# in the *Amazon Elastic Container Service
|
4737
|
+
# Determines whether to use the Amazon ECS task IAM role defined in a
|
4738
|
+
# task definition when mounting the Amazon EFS file system. If
|
4739
|
+
# enabled, transit encryption must be enabled in the
|
4740
|
+
# `EFSVolumeConfiguration`. If this parameter is omitted, the default
|
4741
|
+
# value of `DISABLED` is used. For more information, see [Using Amazon
|
4742
|
+
# EFS Access Points][1] in the *Amazon Elastic Container Service
|
4743
|
+
# Developer Guide*.
|
4680
4744
|
#
|
4681
4745
|
#
|
4682
4746
|
#
|
@@ -4692,7 +4756,7 @@ module Aws::ECS
|
|
4692
4756
|
include Aws::Structure
|
4693
4757
|
end
|
4694
4758
|
|
4695
|
-
# This parameter is specified when you
|
4759
|
+
# This parameter is specified when you're using an Amazon Elastic File
|
4696
4760
|
# System file system for task storage. For more information, see [Amazon
|
4697
4761
|
# EFS Volumes][1] in the *Amazon Elastic Container Service Developer
|
4698
4762
|
# Guide*.
|
@@ -4731,12 +4795,12 @@ module Aws::ECS
|
|
4731
4795
|
# @return [String]
|
4732
4796
|
#
|
4733
4797
|
# @!attribute [rw] transit_encryption
|
4734
|
-
#
|
4735
|
-
# between the Amazon ECS host and the Amazon EFS server.
|
4736
|
-
# encryption must be enabled if Amazon EFS IAM authorization
|
4737
|
-
# If this parameter is omitted, the default value of
|
4738
|
-
# used. For more information, see [Encrypting Data in
|
4739
|
-
# the *Amazon Elastic File System User Guide*.
|
4798
|
+
# Determines whether to enable encryption for Amazon EFS data in
|
4799
|
+
# transit between the Amazon ECS host and the Amazon EFS server.
|
4800
|
+
# Transit encryption must be enabled if Amazon EFS IAM authorization
|
4801
|
+
# is used. If this parameter is omitted, the default value of
|
4802
|
+
# `DISABLED` is used. For more information, see [Encrypting Data in
|
4803
|
+
# Transit][1] in the *Amazon Elastic File System User Guide*.
|
4740
4804
|
#
|
4741
4805
|
#
|
4742
4806
|
#
|
@@ -4777,20 +4841,24 @@ module Aws::ECS
|
|
4777
4841
|
# have a `.env` file extension. Each line in an environment file should
|
4778
4842
|
# contain an environment variable in `VARIABLE=VALUE` format. Lines
|
4779
4843
|
# beginning with `#` are treated as comments and are ignored. For more
|
4780
|
-
# information
|
4844
|
+
# information about the environment variable file syntax, see [Declare
|
4781
4845
|
# default environment variables in file][1].
|
4782
4846
|
#
|
4783
4847
|
# If there are environment variables specified using the `environment`
|
4784
4848
|
# parameter in a container definition, they take precedence over the
|
4785
4849
|
# variables contained within an environment file. If multiple
|
4786
|
-
# environment files are specified that contain the same variable,
|
4787
|
-
#
|
4850
|
+
# environment files are specified that contain the same variable,
|
4851
|
+
# they're processed from the top down. We recommend that you use unique
|
4788
4852
|
# variable names. For more information, see [Specifying environment
|
4789
4853
|
# variables][2] in the *Amazon Elastic Container Service Developer
|
4790
4854
|
# Guide*.
|
4791
4855
|
#
|
4792
|
-
# This
|
4793
|
-
# platform
|
4856
|
+
# This parameter is only supported for tasks hosted on Fargate using the
|
4857
|
+
# following platform versions:
|
4858
|
+
#
|
4859
|
+
# * Linux platform version `1.4.0` or later.
|
4860
|
+
#
|
4861
|
+
# * Windows platform version `1.0.0` or later.
|
4794
4862
|
#
|
4795
4863
|
#
|
4796
4864
|
#
|
@@ -4829,8 +4897,12 @@ module Aws::ECS
|
|
4829
4897
|
# more information, see [Fargate task storage][1] in the *Amazon ECS
|
4830
4898
|
# User Guide for Fargate*.
|
4831
4899
|
#
|
4832
|
-
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
|
4833
|
-
# platform
|
4900
|
+
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using the
|
4901
|
+
# following platform versions:
|
4902
|
+
#
|
4903
|
+
# * Linux platform version `1.4.0` or later.
|
4904
|
+
#
|
4905
|
+
# * Windows platform version `1.0.0` or later.
|
4834
4906
|
#
|
4835
4907
|
# </note>
|
4836
4908
|
#
|
@@ -4937,8 +5009,8 @@ module Aws::ECS
|
|
4937
5009
|
# @return [String]
|
4938
5010
|
#
|
4939
5011
|
# @!attribute [rw] cloud_watch_encryption_enabled
|
4940
|
-
#
|
4941
|
-
# specified, encryption will be disabled.
|
5012
|
+
# Determines whether to enable encryption on the CloudWatch logs. If
|
5013
|
+
# not specified, encryption will be disabled.
|
4942
5014
|
# @return [Boolean]
|
4943
5015
|
#
|
4944
5016
|
# @!attribute [rw] s3_bucket_name
|
@@ -4950,8 +5022,8 @@ module Aws::ECS
|
|
4950
5022
|
# @return [String]
|
4951
5023
|
#
|
4952
5024
|
# @!attribute [rw] s3_encryption_enabled
|
4953
|
-
#
|
4954
|
-
# specified, encryption
|
5025
|
+
# Determines whether to use encryption on the S3 logs. If not
|
5026
|
+
# specified, encryption is not used.
|
4955
5027
|
# @return [Boolean]
|
4956
5028
|
#
|
4957
5029
|
# @!attribute [rw] s3_key_prefix
|
@@ -5031,9 +5103,9 @@ module Aws::ECS
|
|
5031
5103
|
# @return [String]
|
5032
5104
|
#
|
5033
5105
|
# @!attribute [rw] interactive
|
5034
|
-
#
|
5035
|
-
# mode. Amazon ECS only supports initiating interactive
|
5036
|
-
# you must specify `true` for this value.
|
5106
|
+
# Determines whether the execute command session is running in
|
5107
|
+
# interactive mode. Amazon ECS only supports initiating interactive
|
5108
|
+
# sessions, so you must specify `true` for this value.
|
5037
5109
|
# @return [Boolean]
|
5038
5110
|
#
|
5039
5111
|
# @!attribute [rw] session
|
@@ -5106,7 +5178,7 @@ module Aws::ECS
|
|
5106
5178
|
include Aws::Structure
|
5107
5179
|
end
|
5108
5180
|
|
5109
|
-
# This parameter is specified when you
|
5181
|
+
# This parameter is specified when you're using [Amazon FSx for Windows
|
5110
5182
|
# File Server][1] file system for task storage.
|
5111
5183
|
#
|
5112
5184
|
# For more information and the input format, see [Amazon FSx for Windows
|
@@ -5253,7 +5325,7 @@ module Aws::ECS
|
|
5253
5325
|
#
|
5254
5326
|
# * `UNHEALTHY`-The container health check has failed.
|
5255
5327
|
#
|
5256
|
-
# * `UNKNOWN`-The container health check is being evaluated or there
|
5328
|
+
# * `UNKNOWN`-The container health check is being evaluated or there's
|
5257
5329
|
# no container health check defined.
|
5258
5330
|
#
|
5259
5331
|
# The following describes the possible `healthStatus` values for a task.
|
@@ -5281,12 +5353,12 @@ module Aws::ECS
|
|
5281
5353
|
# Amazon ECS container agent. For more information, see [Updating the
|
5282
5354
|
# Amazon ECS Container Agent][1].
|
5283
5355
|
#
|
5284
|
-
# * Container health checks are supported for Fargate tasks if you
|
5356
|
+
# * Container health checks are supported for Fargate tasks if you're
|
5285
5357
|
# using platform version 1.1.0 or greater. For more information, see
|
5286
5358
|
# [Fargate Platform Versions][2].
|
5287
5359
|
#
|
5288
|
-
# * Container health checks
|
5289
|
-
# a service that
|
5360
|
+
# * Container health checks aren't supported for tasks that are part of
|
5361
|
+
# a service that's configured to use a Classic Load Balancer.
|
5290
5362
|
#
|
5291
5363
|
#
|
5292
5364
|
#
|
@@ -5311,13 +5383,13 @@ module Aws::ECS
|
|
5311
5383
|
# command with the container's default shell.
|
5312
5384
|
#
|
5313
5385
|
# When you use the Amazon Web Services Management Console JSON panel,
|
5314
|
-
# the Command Line Interface, or the APIs,
|
5315
|
-
#
|
5386
|
+
# the Command Line Interface, or the APIs, enclose the list of
|
5387
|
+
# commands in brackets.
|
5316
5388
|
#
|
5317
5389
|
# `[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]`
|
5318
5390
|
#
|
5319
|
-
# You
|
5320
|
-
# Services Management
|
5391
|
+
# You don't need to include the brackets when you use the Amazon Web
|
5392
|
+
# Services Management Console.
|
5321
5393
|
#
|
5322
5394
|
# ` "CMD-SHELL", "curl -f http://localhost/ || exit 1" `
|
5323
5395
|
#
|
@@ -5350,10 +5422,10 @@ module Aws::ECS
|
|
5350
5422
|
# @return [Integer]
|
5351
5423
|
#
|
5352
5424
|
# @!attribute [rw] start_period
|
5353
|
-
# The optional grace period
|
5354
|
-
#
|
5355
|
-
#
|
5356
|
-
# `startPeriod` is disabled
|
5425
|
+
# The optional grace period to provide containers time to bootstrap
|
5426
|
+
# before failed health checks count towards the maximum number of
|
5427
|
+
# retries. You can specify between 0 and 300 seconds. By default, the
|
5428
|
+
# `startPeriod` is disabled.
|
5357
5429
|
#
|
5358
5430
|
# <note markdown="1"> If a health check succeeds within the `startPeriod`, then the
|
5359
5431
|
# container is considered healthy and any subsequent failures count
|
@@ -5414,16 +5486,16 @@ module Aws::ECS
|
|
5414
5486
|
#
|
5415
5487
|
# @!attribute [rw] source_path
|
5416
5488
|
# When the `host` parameter is used, specify a `sourcePath` to declare
|
5417
|
-
# the path on the host container instance that
|
5489
|
+
# the path on the host container instance that's presented to the
|
5418
5490
|
# container. If this parameter is empty, then the Docker daemon has
|
5419
5491
|
# assigned a host path for you. If the `host` parameter contains a
|
5420
5492
|
# `sourcePath` file location, then the data volume persists at the
|
5421
5493
|
# specified location on the host container instance until you delete
|
5422
|
-
# it manually. If the `sourcePath` value
|
5494
|
+
# it manually. If the `sourcePath` value doesn't exist on the host
|
5423
5495
|
# container instance, the Docker daemon creates it. If the location
|
5424
5496
|
# does exist, the contents of the source path folder are exported.
|
5425
5497
|
#
|
5426
|
-
# If you
|
5498
|
+
# If you're using the Fargate launch type, the `sourcePath` parameter
|
5427
5499
|
# is not supported.
|
5428
5500
|
# @return [String]
|
5429
5501
|
#
|
@@ -5435,7 +5507,7 @@ module Aws::ECS
|
|
5435
5507
|
include Aws::Structure
|
5436
5508
|
end
|
5437
5509
|
|
5438
|
-
# Details on
|
5510
|
+
# Details on an Elastic Inference accelerator. For more information, see
|
5439
5511
|
# [Working with Amazon Elastic Inference on Amazon ECS][1] in the
|
5440
5512
|
# *Amazon Elastic Container Service Developer Guide*.
|
5441
5513
|
#
|
@@ -5507,7 +5579,39 @@ module Aws::ECS
|
|
5507
5579
|
include Aws::Structure
|
5508
5580
|
end
|
5509
5581
|
|
5510
|
-
#
|
5582
|
+
# An object representing the result of a container instance health
|
5583
|
+
# status check.
|
5584
|
+
#
|
5585
|
+
# @!attribute [rw] type
|
5586
|
+
# The type of container instance health status that was verified.
|
5587
|
+
# @return [String]
|
5588
|
+
#
|
5589
|
+
# @!attribute [rw] status
|
5590
|
+
# The container instance health status.
|
5591
|
+
# @return [String]
|
5592
|
+
#
|
5593
|
+
# @!attribute [rw] last_updated
|
5594
|
+
# The Unix timestamp for when the container instance health status was
|
5595
|
+
# last updated.
|
5596
|
+
# @return [Time]
|
5597
|
+
#
|
5598
|
+
# @!attribute [rw] last_status_change
|
5599
|
+
# The Unix timestamp for when the container instance health status
|
5600
|
+
# last changed.
|
5601
|
+
# @return [Time]
|
5602
|
+
#
|
5603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/InstanceHealthCheckResult AWS API Documentation
|
5604
|
+
#
|
5605
|
+
class InstanceHealthCheckResult < Struct.new(
|
5606
|
+
:type,
|
5607
|
+
:status,
|
5608
|
+
:last_updated,
|
5609
|
+
:last_status_change)
|
5610
|
+
SENSITIVE = []
|
5611
|
+
include Aws::Structure
|
5612
|
+
end
|
5613
|
+
|
5614
|
+
# The specified parameter isn't valid. Review the available parameters
|
5511
5615
|
# for the API request.
|
5512
5616
|
#
|
5513
5617
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/InvalidParameterException AWS API Documentation
|
@@ -5516,10 +5620,11 @@ module Aws::ECS
|
|
5516
5620
|
|
5517
5621
|
# The Linux capabilities for the container that are added to or dropped
|
5518
5622
|
# from the default configuration provided by Docker. For more
|
5519
|
-
# information
|
5520
|
-
# capabilities, see [Runtime privilege and Linux
|
5521
|
-
# *Docker run reference*. For more detailed
|
5522
|
-
# capabilities, see the
|
5623
|
+
# information about the default capabilities and the non-default
|
5624
|
+
# available capabilities, see [Runtime privilege and Linux
|
5625
|
+
# capabilities][1] in the *Docker run reference*. For more detailed
|
5626
|
+
# information about these Linux capabilities, see the
|
5627
|
+
# [capabilities(7)][2] Linux manual page.
|
5523
5628
|
#
|
5524
5629
|
#
|
5525
5630
|
#
|
@@ -5623,7 +5728,7 @@ module Aws::ECS
|
|
5623
5728
|
include Aws::Structure
|
5624
5729
|
end
|
5625
5730
|
|
5626
|
-
# The limit for the resource
|
5731
|
+
# The limit for the resource was exceeded.
|
5627
5732
|
#
|
5628
5733
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/LimitExceededException AWS API Documentation
|
5629
5734
|
#
|
@@ -5676,8 +5781,8 @@ module Aws::ECS
|
|
5676
5781
|
# `Devices` in the [Create a container][1] section of the [Docker
|
5677
5782
|
# Remote API][2] and the `--device` option to [docker run][3].
|
5678
5783
|
#
|
5679
|
-
# <note markdown="1"> If you
|
5680
|
-
# `devices` parameter
|
5784
|
+
# <note markdown="1"> If you're using tasks that use the Fargate launch type, the
|
5785
|
+
# `devices` parameter isn't supported.
|
5681
5786
|
#
|
5682
5787
|
# </note>
|
5683
5788
|
#
|
@@ -5721,8 +5826,8 @@ module Aws::ECS
|
|
5721
5826
|
# mount. This parameter maps to the `--tmpfs` option to [docker
|
5722
5827
|
# run][1].
|
5723
5828
|
#
|
5724
|
-
# <note markdown="1"> If you
|
5725
|
-
# parameter
|
5829
|
+
# <note markdown="1"> If you're using tasks that use the Fargate launch type, the `tmpfs`
|
5830
|
+
# parameter isn't supported.
|
5726
5831
|
#
|
5727
5832
|
# </note>
|
5728
5833
|
#
|
@@ -5744,8 +5849,8 @@ module Aws::ECS
|
|
5744
5849
|
# `maxSwap` value must be set for the `swappiness` parameter to be
|
5745
5850
|
# used.
|
5746
5851
|
#
|
5747
|
-
# <note markdown="1"> If you
|
5748
|
-
# `maxSwap` parameter
|
5852
|
+
# <note markdown="1"> If you're using tasks that use the Fargate launch type, the
|
5853
|
+
# `maxSwap` parameter isn't supported.
|
5749
5854
|
#
|
5750
5855
|
# </note>
|
5751
5856
|
#
|
@@ -5765,8 +5870,8 @@ module Aws::ECS
|
|
5765
5870
|
# parameter maps to the `--memory-swappiness` option to [docker
|
5766
5871
|
# run][1].
|
5767
5872
|
#
|
5768
|
-
# <note markdown="1"> If you
|
5769
|
-
# `swappiness` parameter
|
5873
|
+
# <note markdown="1"> If you're using tasks that use the Fargate launch type, the
|
5874
|
+
# `swappiness` parameter isn't supported.
|
5770
5875
|
#
|
5771
5876
|
# </note>
|
5772
5877
|
#
|
@@ -5806,8 +5911,8 @@ module Aws::ECS
|
|
5806
5911
|
# @return [String]
|
5807
5912
|
#
|
5808
5913
|
# @!attribute [rw] value
|
5809
|
-
# The value of the account settings
|
5810
|
-
#
|
5914
|
+
# The value of the account settings to filter results with. You must
|
5915
|
+
# also specify an account setting name to use this parameter.
|
5811
5916
|
# @return [String]
|
5812
5917
|
#
|
5813
5918
|
# @!attribute [rw] principal_arn
|
@@ -5822,18 +5927,18 @@ module Aws::ECS
|
|
5822
5927
|
# @return [String]
|
5823
5928
|
#
|
5824
5929
|
# @!attribute [rw] effective_settings
|
5825
|
-
#
|
5930
|
+
# Determines whether to return the effective settings. If `true`, the
|
5826
5931
|
# account settings for the root user or the default setting for the
|
5827
5932
|
# `principalArn` are returned. If `false`, the account settings for
|
5828
|
-
# the `principalArn` are returned if they
|
5933
|
+
# the `principalArn` are returned if they're set. Otherwise, no
|
5829
5934
|
# account settings are returned.
|
5830
5935
|
# @return [Boolean]
|
5831
5936
|
#
|
5832
5937
|
# @!attribute [rw] next_token
|
5833
5938
|
# The `nextToken` value returned from a `ListAccountSettings` request
|
5834
5939
|
# indicating that more results are available to fulfill the request
|
5835
|
-
# and further calls will be needed. If `maxResults` was provided,
|
5836
|
-
#
|
5940
|
+
# and further calls will be needed. If `maxResults` was provided,
|
5941
|
+
# it's possible the number of results to be fewer than `maxResults`.
|
5837
5942
|
#
|
5838
5943
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only
|
5839
5944
|
# used to retrieve the next items in a list and not for other
|
@@ -5849,7 +5954,7 @@ module Aws::ECS
|
|
5849
5954
|
# single page along with a `nextToken` response element. The remaining
|
5850
5955
|
# results of the initial request can be seen by sending another
|
5851
5956
|
# `ListAccountSettings` request with the returned `nextToken` value.
|
5852
|
-
# This value can be between 1 and 10. If this parameter
|
5957
|
+
# This value can be between 1 and 10. If this parameter isn't used,
|
5853
5958
|
# then `ListAccountSettings` returns up to 10 results and a
|
5854
5959
|
# `nextToken` value if applicable.
|
5855
5960
|
# @return [Integer]
|
@@ -5907,23 +6012,23 @@ module Aws::ECS
|
|
5907
6012
|
# @return [String]
|
5908
6013
|
#
|
5909
6014
|
# @!attribute [rw] target_type
|
5910
|
-
# The type of the target
|
6015
|
+
# The type of the target to list attributes with.
|
5911
6016
|
# @return [String]
|
5912
6017
|
#
|
5913
6018
|
# @!attribute [rw] attribute_name
|
5914
|
-
# The name of the attribute
|
6019
|
+
# The name of the attribute to filter the results with.
|
5915
6020
|
# @return [String]
|
5916
6021
|
#
|
5917
6022
|
# @!attribute [rw] attribute_value
|
5918
|
-
# The value of the attribute
|
5919
|
-
#
|
6023
|
+
# The value of the attribute to filter results with. You must also
|
6024
|
+
# specify an attribute name to use this parameter.
|
5920
6025
|
# @return [String]
|
5921
6026
|
#
|
5922
6027
|
# @!attribute [rw] next_token
|
5923
6028
|
# The `nextToken` value returned from a `ListAttributes` request
|
5924
6029
|
# indicating that more results are available to fulfill the request
|
5925
|
-
# and further calls
|
5926
|
-
#
|
6030
|
+
# and further calls are needed. If `maxResults` was provided, it's
|
6031
|
+
# possible the number of results to be fewer than `maxResults`.
|
5927
6032
|
#
|
5928
6033
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only
|
5929
6034
|
# used to retrieve the next items in a list and not for other
|
@@ -5933,13 +6038,13 @@ module Aws::ECS
|
|
5933
6038
|
# @return [String]
|
5934
6039
|
#
|
5935
6040
|
# @!attribute [rw] max_results
|
5936
|
-
# The maximum number of cluster results
|
6041
|
+
# The maximum number of cluster results that `ListAttributes` returned
|
5937
6042
|
# in paginated output. When this parameter is used, `ListAttributes`
|
5938
6043
|
# only returns `maxResults` results in a single page along with a
|
5939
6044
|
# `nextToken` response element. The remaining results of the initial
|
5940
6045
|
# request can be seen by sending another `ListAttributes` request with
|
5941
6046
|
# the returned `nextToken` value. This value can be between 1 and 100.
|
5942
|
-
# If this parameter
|
6047
|
+
# If this parameter isn't used, then `ListAttributes` returns up to
|
5943
6048
|
# 100 results and a `nextToken` value if applicable.
|
5944
6049
|
# @return [Integer]
|
5945
6050
|
#
|
@@ -5988,8 +6093,8 @@ module Aws::ECS
|
|
5988
6093
|
# @!attribute [rw] next_token
|
5989
6094
|
# The `nextToken` value returned from a `ListClusters` request
|
5990
6095
|
# indicating that more results are available to fulfill the request
|
5991
|
-
# and further calls
|
5992
|
-
#
|
6096
|
+
# and further calls are needed. If `maxResults` was provided, it's
|
6097
|
+
# possible the number of results to be fewer than `maxResults`.
|
5993
6098
|
#
|
5994
6099
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only
|
5995
6100
|
# used to retrieve the next items in a list and not for other
|
@@ -5999,13 +6104,13 @@ module Aws::ECS
|
|
5999
6104
|
# @return [String]
|
6000
6105
|
#
|
6001
6106
|
# @!attribute [rw] max_results
|
6002
|
-
# The maximum number of cluster results
|
6003
|
-
# paginated output. When this parameter is used, `ListClusters`
|
6004
|
-
# returns `maxResults` results in a single page along with a
|
6107
|
+
# The maximum number of cluster results that `ListClusters` returned
|
6108
|
+
# in paginated output. When this parameter is used, `ListClusters`
|
6109
|
+
# only returns `maxResults` results in a single page along with a
|
6005
6110
|
# `nextToken` response element. The remaining results of the initial
|
6006
6111
|
# request can be seen by sending another `ListClusters` request with
|
6007
6112
|
# the returned `nextToken` value. This value can be between 1 and 100.
|
6008
|
-
# If this parameter
|
6113
|
+
# If this parameter isn't used, then `ListClusters` returns up to 100
|
6009
6114
|
# results and a `nextToken` value if applicable.
|
6010
6115
|
# @return [Integer]
|
6011
6116
|
#
|
@@ -6020,7 +6125,7 @@ module Aws::ECS
|
|
6020
6125
|
|
6021
6126
|
# @!attribute [rw] cluster_arns
|
6022
6127
|
# The list of full Amazon Resource Name (ARN) entries for each cluster
|
6023
|
-
# associated with your account.
|
6128
|
+
# that's associated with your account.
|
6024
6129
|
# @return [Array<String>]
|
6025
6130
|
#
|
6026
6131
|
# @!attribute [rw] next_token
|
@@ -6070,9 +6175,8 @@ module Aws::ECS
|
|
6070
6175
|
# @!attribute [rw] next_token
|
6071
6176
|
# The `nextToken` value returned from a `ListContainerInstances`
|
6072
6177
|
# request indicating that more results are available to fulfill the
|
6073
|
-
# request and further calls
|
6074
|
-
#
|
6075
|
-
# `maxResults`.
|
6178
|
+
# request and further calls are needed. If `maxResults` was provided,
|
6179
|
+
# it's possible the number of results to be fewer than `maxResults`.
|
6076
6180
|
#
|
6077
6181
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only
|
6078
6182
|
# used to retrieve the next items in a list and not for other
|
@@ -6082,22 +6186,22 @@ module Aws::ECS
|
|
6082
6186
|
# @return [String]
|
6083
6187
|
#
|
6084
6188
|
# @!attribute [rw] max_results
|
6085
|
-
# The maximum number of container instance results
|
6086
|
-
# `ListContainerInstances` in paginated output. When this
|
6087
|
-
# used, `ListContainerInstances` only returns
|
6088
|
-
# a single page along with a `nextToken`
|
6089
|
-
# remaining results of the initial request can
|
6090
|
-
# another `ListContainerInstances` request with the
|
6091
|
-
# `nextToken` value. This value can be between 1 and 100. If
|
6092
|
-
# parameter
|
6093
|
-
# 100 results and a `nextToken` value if applicable.
|
6189
|
+
# The maximum number of container instance results that
|
6190
|
+
# `ListContainerInstances` returned in paginated output. When this
|
6191
|
+
# parameter is used, `ListContainerInstances` only returns
|
6192
|
+
# `maxResults` results in a single page along with a `nextToken`
|
6193
|
+
# response element. The remaining results of the initial request can
|
6194
|
+
# be seen by sending another `ListContainerInstances` request with the
|
6195
|
+
# returned `nextToken` value. This value can be between 1 and 100. If
|
6196
|
+
# this parameter isn't used, then `ListContainerInstances` returns up
|
6197
|
+
# to 100 results and a `nextToken` value if applicable.
|
6094
6198
|
# @return [Integer]
|
6095
6199
|
#
|
6096
6200
|
# @!attribute [rw] status
|
6097
6201
|
# Filters the container instances by status. For example, if you
|
6098
6202
|
# specify the `DRAINING` status, the results include only container
|
6099
6203
|
# instances that have been set to `DRAINING` using
|
6100
|
-
# UpdateContainerInstancesState. If you
|
6204
|
+
# UpdateContainerInstancesState. If you don't specify this parameter,
|
6101
6205
|
# the default is to include container instances set to all states
|
6102
6206
|
# other than `INACTIVE`.
|
6103
6207
|
# @return [String]
|
@@ -6167,13 +6271,13 @@ module Aws::ECS
|
|
6167
6271
|
# @return [String]
|
6168
6272
|
#
|
6169
6273
|
# @!attribute [rw] max_results
|
6170
|
-
# The maximum number of service results
|
6171
|
-
# paginated output. When this parameter is used, `ListServices`
|
6172
|
-
# returns `maxResults` results in a single page along with a
|
6274
|
+
# The maximum number of service results that `ListServices` returned
|
6275
|
+
# in paginated output. When this parameter is used, `ListServices`
|
6276
|
+
# only returns `maxResults` results in a single page along with a
|
6173
6277
|
# `nextToken` response element. The remaining results of the initial
|
6174
6278
|
# request can be seen by sending another `ListServices` request with
|
6175
6279
|
# the returned `nextToken` value. This value can be between 1 and 100.
|
6176
|
-
# If this parameter
|
6280
|
+
# If this parameter isn't used, then `ListServices` returns up to 10
|
6177
6281
|
# results and a `nextToken` value if applicable.
|
6178
6282
|
# @return [Integer]
|
6179
6283
|
#
|
@@ -6199,8 +6303,8 @@ module Aws::ECS
|
|
6199
6303
|
end
|
6200
6304
|
|
6201
6305
|
# @!attribute [rw] service_arns
|
6202
|
-
# The list of full ARN entries for each service associated
|
6203
|
-
# specified cluster.
|
6306
|
+
# The list of full ARN entries for each service that's associated
|
6307
|
+
# with the specified cluster.
|
6204
6308
|
# @return [Array<String>]
|
6205
6309
|
#
|
6206
6310
|
# @!attribute [rw] next_token
|
@@ -6227,10 +6331,10 @@ module Aws::ECS
|
|
6227
6331
|
# }
|
6228
6332
|
#
|
6229
6333
|
# @!attribute [rw] resource_arn
|
6230
|
-
# The Amazon Resource Name (ARN) that identifies the resource
|
6231
|
-
#
|
6232
|
-
#
|
6233
|
-
#
|
6334
|
+
# The Amazon Resource Name (ARN) that identifies the resource to list
|
6335
|
+
# the tags for. Currently, the supported resources are Amazon ECS
|
6336
|
+
# tasks, services, task definitions, clusters, and container
|
6337
|
+
# instances.
|
6234
6338
|
# @return [String]
|
6235
6339
|
#
|
6236
6340
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTagsForResourceRequest AWS API Documentation
|
@@ -6264,22 +6368,22 @@ module Aws::ECS
|
|
6264
6368
|
# }
|
6265
6369
|
#
|
6266
6370
|
# @!attribute [rw] family_prefix
|
6267
|
-
# The `familyPrefix` is a string that
|
6371
|
+
# The `familyPrefix` is a string that's used to filter the results of
|
6268
6372
|
# `ListTaskDefinitionFamilies`. If you specify a `familyPrefix`, only
|
6269
6373
|
# task definition family names that begin with the `familyPrefix`
|
6270
6374
|
# string are returned.
|
6271
6375
|
# @return [String]
|
6272
6376
|
#
|
6273
6377
|
# @!attribute [rw] status
|
6274
|
-
# The task definition family status
|
6275
|
-
# `ListTaskDefinitionFamilies` results. By default, both `ACTIVE`
|
6276
|
-
# `INACTIVE` task definition families are listed. If this
|
6277
|
-
# set to `ACTIVE`, only task definition families that
|
6278
|
-
# task definition revision are returned. If this
|
6279
|
-
# `INACTIVE`, only task definition families that
|
6280
|
-
# `ACTIVE` task definition revisions are returned. If
|
6281
|
-
# resulting output, be sure to keep the `status`
|
6282
|
-
# each subsequent request.
|
6378
|
+
# The task definition family status to filter the
|
6379
|
+
# `ListTaskDefinitionFamilies` results with. By default, both `ACTIVE`
|
6380
|
+
# and `INACTIVE` task definition families are listed. If this
|
6381
|
+
# parameter is set to `ACTIVE`, only task definition families that
|
6382
|
+
# have an `ACTIVE` task definition revision are returned. If this
|
6383
|
+
# parameter is set to `INACTIVE`, only task definition families that
|
6384
|
+
# do not have any `ACTIVE` task definition revisions are returned. If
|
6385
|
+
# you paginate the resulting output, be sure to keep the `status`
|
6386
|
+
# value constant in each subsequent request.
|
6283
6387
|
# @return [String]
|
6284
6388
|
#
|
6285
6389
|
# @!attribute [rw] next_token
|
@@ -6297,14 +6401,14 @@ module Aws::ECS
|
|
6297
6401
|
# @return [String]
|
6298
6402
|
#
|
6299
6403
|
# @!attribute [rw] max_results
|
6300
|
-
# The maximum number of task definition family results
|
6301
|
-
# `ListTaskDefinitionFamilies` in paginated output. When this
|
6404
|
+
# The maximum number of task definition family results that
|
6405
|
+
# `ListTaskDefinitionFamilies` returned in paginated output. When this
|
6302
6406
|
# parameter is used, `ListTaskDefinitions` only returns `maxResults`
|
6303
6407
|
# results in a single page along with a `nextToken` response element.
|
6304
6408
|
# The remaining results of the initial request can be seen by sending
|
6305
6409
|
# another `ListTaskDefinitionFamilies` request with the returned
|
6306
6410
|
# `nextToken` value. This value can be between 1 and 100. If this
|
6307
|
-
# parameter
|
6411
|
+
# parameter isn't used, then `ListTaskDefinitionFamilies` returns up
|
6308
6412
|
# to 100 results and a `nextToken` value if applicable.
|
6309
6413
|
# @return [Integer]
|
6310
6414
|
#
|
@@ -6353,29 +6457,28 @@ module Aws::ECS
|
|
6353
6457
|
# }
|
6354
6458
|
#
|
6355
6459
|
# @!attribute [rw] family_prefix
|
6356
|
-
# The full family name
|
6357
|
-
#
|
6358
|
-
#
|
6460
|
+
# The full family name to filter the `ListTaskDefinitions` results
|
6461
|
+
# with. Specifying a `familyPrefix` limits the listed task definitions
|
6462
|
+
# to task definition revisions that belong to that family.
|
6359
6463
|
# @return [String]
|
6360
6464
|
#
|
6361
6465
|
# @!attribute [rw] status
|
6362
|
-
# The task definition status
|
6363
|
-
#
|
6364
|
-
#
|
6365
|
-
#
|
6366
|
-
#
|
6367
|
-
#
|
6368
|
-
# subsequent request.
|
6466
|
+
# The task definition status to filter the `ListTaskDefinitions`
|
6467
|
+
# results with. By default, only `ACTIVE` task definitions are listed.
|
6468
|
+
# By setting this parameter to `INACTIVE`, you can view task
|
6469
|
+
# definitions that are `INACTIVE` as long as an active task or service
|
6470
|
+
# still references them. If you paginate the resulting output, be sure
|
6471
|
+
# to keep the `status` value constant in each subsequent request.
|
6369
6472
|
# @return [String]
|
6370
6473
|
#
|
6371
6474
|
# @!attribute [rw] sort
|
6372
|
-
# The order
|
6373
|
-
#
|
6374
|
-
#
|
6375
|
-
#
|
6376
|
-
#
|
6377
|
-
#
|
6378
|
-
#
|
6475
|
+
# The order to sort the results in. Valid values are `ASC` and `DESC`.
|
6476
|
+
# By default, (`ASC`) task definitions are listed lexicographically by
|
6477
|
+
# family name and in ascending numerical order by revision so that the
|
6478
|
+
# newest task definitions in a family are listed last. Setting this
|
6479
|
+
# parameter to `DESC` reverses the sort order on family name and
|
6480
|
+
# revision. This is so that the newest task definitions in a family
|
6481
|
+
# are listed first.
|
6379
6482
|
# @return [String]
|
6380
6483
|
#
|
6381
6484
|
# @!attribute [rw] next_token
|
@@ -6392,14 +6495,14 @@ module Aws::ECS
|
|
6392
6495
|
# @return [String]
|
6393
6496
|
#
|
6394
6497
|
# @!attribute [rw] max_results
|
6395
|
-
# The maximum number of task definition results
|
6396
|
-
# `ListTaskDefinitions` in paginated output. When this
|
6397
|
-
# used, `ListTaskDefinitions` only returns `maxResults`
|
6398
|
-
# single page along with a `nextToken` response element.
|
6399
|
-
# results of the initial request can be seen by sending
|
6400
|
-
# `ListTaskDefinitions` request with the returned `nextToken`
|
6401
|
-
# This value can be between 1 and 100. If this parameter
|
6402
|
-
# then `ListTaskDefinitions` returns up to 100 results and a
|
6498
|
+
# The maximum number of task definition results that
|
6499
|
+
# `ListTaskDefinitions` returned in paginated output. When this
|
6500
|
+
# parameter is used, `ListTaskDefinitions` only returns `maxResults`
|
6501
|
+
# results in a single page along with a `nextToken` response element.
|
6502
|
+
# The remaining results of the initial request can be seen by sending
|
6503
|
+
# another `ListTaskDefinitions` request with the returned `nextToken`
|
6504
|
+
# value. This value can be between 1 and 100. If this parameter isn't
|
6505
|
+
# used, then `ListTaskDefinitions` returns up to 100 results and a
|
6403
6506
|
# `nextToken` value if applicable.
|
6404
6507
|
# @return [Integer]
|
6405
6508
|
#
|
@@ -6474,7 +6577,7 @@ module Aws::ECS
|
|
6474
6577
|
# @!attribute [rw] next_token
|
6475
6578
|
# The `nextToken` value returned from a `ListTasks` request indicating
|
6476
6579
|
# that more results are available to fulfill the request and further
|
6477
|
-
# calls will be needed. If `maxResults` was provided, it
|
6580
|
+
# calls will be needed. If `maxResults` was provided, it's possible
|
6478
6581
|
# the number of results to be fewer than `maxResults`.
|
6479
6582
|
#
|
6480
6583
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only
|
@@ -6485,20 +6588,20 @@ module Aws::ECS
|
|
6485
6588
|
# @return [String]
|
6486
6589
|
#
|
6487
6590
|
# @!attribute [rw] max_results
|
6488
|
-
# The maximum number of task results
|
6591
|
+
# The maximum number of task results that `ListTasks` returned in
|
6489
6592
|
# paginated output. When this parameter is used, `ListTasks` only
|
6490
6593
|
# returns `maxResults` results in a single page along with a
|
6491
6594
|
# `nextToken` response element. The remaining results of the initial
|
6492
6595
|
# request can be seen by sending another `ListTasks` request with the
|
6493
6596
|
# returned `nextToken` value. This value can be between 1 and 100. If
|
6494
|
-
# this parameter
|
6597
|
+
# this parameter isn't used, then `ListTasks` returns up to 100
|
6495
6598
|
# results and a `nextToken` value if applicable.
|
6496
6599
|
# @return [Integer]
|
6497
6600
|
#
|
6498
6601
|
# @!attribute [rw] started_by
|
6499
|
-
# The `startedBy` value
|
6500
|
-
#
|
6501
|
-
#
|
6602
|
+
# The `startedBy` value to filter the task results with. Specifying a
|
6603
|
+
# `startedBy` value limits the results to tasks that were started with
|
6604
|
+
# that value.
|
6502
6605
|
# @return [String]
|
6503
6606
|
#
|
6504
6607
|
# @!attribute [rw] service_name
|
@@ -6511,13 +6614,13 @@ module Aws::ECS
|
|
6511
6614
|
# The task desired status to use when filtering the `ListTasks`
|
6512
6615
|
# results. Specifying a `desiredStatus` of `STOPPED` limits the
|
6513
6616
|
# results to tasks that Amazon ECS has set the desired status to
|
6514
|
-
# `STOPPED`. This can be useful for debugging tasks that
|
6617
|
+
# `STOPPED`. This can be useful for debugging tasks that aren't
|
6515
6618
|
# starting properly or have died or finished. The default status
|
6516
6619
|
# filter is `RUNNING`, which shows tasks that Amazon ECS has set the
|
6517
6620
|
# desired status to `RUNNING`.
|
6518
6621
|
#
|
6519
6622
|
# <note markdown="1"> Although you can filter results based on a desired status of
|
6520
|
-
# `PENDING`, this
|
6623
|
+
# `PENDING`, this doesn't return any results. Amazon ECS never sets
|
6521
6624
|
# the desired status of a task to that value (only a task's
|
6522
6625
|
# `lastStatus` may have a value of `PENDING`).
|
6523
6626
|
#
|
@@ -6585,25 +6688,25 @@ module Aws::ECS
|
|
6585
6688
|
# target group or groups associated with a service or task set.
|
6586
6689
|
#
|
6587
6690
|
# A target group ARN is only specified when using an Application Load
|
6588
|
-
# Balancer or Network Load Balancer. If you
|
6589
|
-
# Balancer the target group ARN
|
6691
|
+
# Balancer or Network Load Balancer. If you're using a Classic Load
|
6692
|
+
# Balancer, omit the target group ARN.
|
6590
6693
|
#
|
6591
6694
|
# For services using the `ECS` deployment controller, you can specify
|
6592
6695
|
# one or multiple target groups. For more information, see
|
6593
6696
|
# [Registering Multiple Target Groups with a Service][1] in the
|
6594
6697
|
# *Amazon Elastic Container Service Developer Guide*.
|
6595
6698
|
#
|
6596
|
-
# For services using the `CODE_DEPLOY` deployment controller, you
|
6699
|
+
# For services using the `CODE_DEPLOY` deployment controller, you're
|
6597
6700
|
# required to define two target groups for the load balancer. For more
|
6598
6701
|
# information, see [Blue/Green Deployment with CodeDeploy][2] in the
|
6599
6702
|
# *Amazon Elastic Container Service Developer Guide*.
|
6600
6703
|
#
|
6601
|
-
# If your service's task definition uses the `awsvpc` network mode
|
6602
|
-
#
|
6603
|
-
#
|
6604
|
-
#
|
6605
|
-
#
|
6606
|
-
#
|
6704
|
+
# If your service's task definition uses the `awsvpc` network mode,
|
6705
|
+
# you must choose `ip` as the target type, not `instance`. Do this
|
6706
|
+
# when creating your target groups because tasks that use the `awsvpc`
|
6707
|
+
# network mode are associated with an elastic network interface, not
|
6708
|
+
# an Amazon EC2 instance. This network mode is required for the
|
6709
|
+
# Fargate launch type.
|
6607
6710
|
#
|
6608
6711
|
#
|
6609
6712
|
#
|
@@ -6629,7 +6732,7 @@ module Aws::ECS
|
|
6629
6732
|
# The port on the container to associate with the load balancer. This
|
6630
6733
|
# port must correspond to a `containerPort` in the task definition the
|
6631
6734
|
# tasks in the service are using. For tasks that use the EC2 launch
|
6632
|
-
# type, the container instance they
|
6735
|
+
# type, the container instance they're launched on must allow ingress
|
6633
6736
|
# traffic on the `hostPort` of the port mapping.
|
6634
6737
|
# @return [Integer]
|
6635
6738
|
#
|
@@ -6649,14 +6752,14 @@ module Aws::ECS
|
|
6649
6752
|
# Remote API][2] and the `--log-driver` option to [ `docker run` ][3].
|
6650
6753
|
#
|
6651
6754
|
# By default, containers use the same logging driver that the Docker
|
6652
|
-
# daemon uses
|
6653
|
-
# than the Docker daemon by specifying a log driver configuration
|
6654
|
-
# container definition. For more information
|
6655
|
-
# different supported log drivers, see [Configure logging
|
6656
|
-
# the Docker documentation.
|
6755
|
+
# daemon uses. However, the container might use a different logging
|
6756
|
+
# driver than the Docker daemon by specifying a log driver configuration
|
6757
|
+
# in the container definition. For more information about the options
|
6758
|
+
# for different supported log drivers, see [Configure logging
|
6759
|
+
# drivers][4] in the Docker documentation.
|
6657
6760
|
#
|
6658
|
-
#
|
6659
|
-
#
|
6761
|
+
# Understand the following when specifying a log configuration for your
|
6762
|
+
# containers.
|
6660
6763
|
#
|
6661
6764
|
# * Amazon ECS currently supports a subset of the logging drivers
|
6662
6765
|
# available to the Docker daemon (shown in the valid values below).
|
@@ -6666,19 +6769,19 @@ module Aws::ECS
|
|
6666
6769
|
# * This parameter requires version 1.18 of the Docker Remote API or
|
6667
6770
|
# greater on your container instance.
|
6668
6771
|
#
|
6669
|
-
# * For tasks hosted on Amazon EC2 instances, the Amazon ECS
|
6670
|
-
# agent must register the available logging drivers with the
|
6772
|
+
# * For tasks that are hosted on Amazon EC2 instances, the Amazon ECS
|
6773
|
+
# container agent must register the available logging drivers with the
|
6671
6774
|
# `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before
|
6672
6775
|
# containers placed on that instance can use these log configuration
|
6673
6776
|
# options. For more information, see [Amazon ECS container agent
|
6674
6777
|
# configuration][5] in the *Amazon Elastic Container Service Developer
|
6675
6778
|
# Guide*.
|
6676
6779
|
#
|
6677
|
-
# * For tasks on Fargate, because you
|
6780
|
+
# * For tasks that are on Fargate, because you don't have access to the
|
6678
6781
|
# underlying infrastructure your tasks are hosted on, any additional
|
6679
|
-
# software needed
|
6680
|
-
#
|
6681
|
-
#
|
6782
|
+
# software needed must be installed outside of the task. For example,
|
6783
|
+
# the Fluentd output aggregators or a remote host running Logstash to
|
6784
|
+
# send Gelf logs to.
|
6682
6785
|
#
|
6683
6786
|
#
|
6684
6787
|
#
|
@@ -6722,11 +6825,11 @@ module Aws::ECS
|
|
6722
6825
|
# [Custom log routing][2] in the *Amazon Elastic Container Service
|
6723
6826
|
# Developer Guide*.
|
6724
6827
|
#
|
6725
|
-
# <note markdown="1"> If you have a custom driver that
|
6726
|
-
# Amazon ECS container agent project that
|
6828
|
+
# <note markdown="1"> If you have a custom driver that isn't listed, you can fork the
|
6829
|
+
# Amazon ECS container agent project that's [available on GitHub][3]
|
6727
6830
|
# and customize it to work with that driver. We encourage you to
|
6728
6831
|
# submit pull requests for changes that you would like to have
|
6729
|
-
# included. However, we
|
6832
|
+
# included. However, we don't currently provide support for running
|
6730
6833
|
# modified copies of this software.
|
6731
6834
|
#
|
6732
6835
|
# </note>
|
@@ -6770,7 +6873,8 @@ module Aws::ECS
|
|
6770
6873
|
# Details about the managed agent status for the container.
|
6771
6874
|
#
|
6772
6875
|
# @!attribute [rw] last_started_at
|
6773
|
-
# The Unix timestamp for when the managed agent was last
|
6876
|
+
# The Unix timestamp for the time when the managed agent was last
|
6877
|
+
# started.
|
6774
6878
|
# @return [Time]
|
6775
6879
|
#
|
6776
6880
|
# @!attribute [rw] name
|
@@ -6810,7 +6914,7 @@ module Aws::ECS
|
|
6810
6914
|
# }
|
6811
6915
|
#
|
6812
6916
|
# @!attribute [rw] container_name
|
6813
|
-
# The name of the container associated with the managed agent.
|
6917
|
+
# The name of the container that's associated with the managed agent.
|
6814
6918
|
# @return [String]
|
6815
6919
|
#
|
6816
6920
|
# @!attribute [rw] managed_agent_name
|
@@ -6841,7 +6945,7 @@ module Aws::ECS
|
|
6841
6945
|
#
|
6842
6946
|
# When managed scaling is enabled, Amazon ECS manages the scale-in and
|
6843
6947
|
# scale-out actions of the Auto Scaling group. Amazon ECS manages a
|
6844
|
-
# target tracking scaling policy using an Amazon ECS
|
6948
|
+
# target tracking scaling policy using an Amazon ECS managed CloudWatch
|
6845
6949
|
# metric with the specified `targetCapacity` value as the target value
|
6846
6950
|
# for the metric. For more information, see [Using Managed Scaling][1]
|
6847
6951
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
@@ -6865,26 +6969,27 @@ module Aws::ECS
|
|
6865
6969
|
# }
|
6866
6970
|
#
|
6867
6971
|
# @!attribute [rw] status
|
6868
|
-
#
|
6972
|
+
# Determines whether to enable managed scaling for the capacity
|
6973
|
+
# provider.
|
6869
6974
|
# @return [String]
|
6870
6975
|
#
|
6871
6976
|
# @!attribute [rw] target_capacity
|
6872
6977
|
# The target capacity value for the capacity provider. The specified
|
6873
6978
|
# value must be greater than `0` and less than or equal to `100`. A
|
6874
|
-
# value of `100`
|
6875
|
-
# Scaling group being completely
|
6979
|
+
# value of `100` results in the Amazon EC2 instances in your Auto
|
6980
|
+
# Scaling group being completely used.
|
6876
6981
|
# @return [Integer]
|
6877
6982
|
#
|
6878
6983
|
# @!attribute [rw] minimum_scaling_step_size
|
6879
|
-
# The minimum number of container instances that Amazon ECS
|
6880
|
-
#
|
6881
|
-
#
|
6984
|
+
# The minimum number of container instances that Amazon ECS scales in
|
6985
|
+
# or scales out at one time. If this parameter is omitted, the default
|
6986
|
+
# value of `1` is used.
|
6882
6987
|
# @return [Integer]
|
6883
6988
|
#
|
6884
6989
|
# @!attribute [rw] maximum_scaling_step_size
|
6885
|
-
# The maximum number of container instances that Amazon ECS
|
6886
|
-
#
|
6887
|
-
#
|
6990
|
+
# The maximum number of container instances that Amazon ECS scales in
|
6991
|
+
# or scales out at one time. If this parameter is omitted, the default
|
6992
|
+
# value of `10000` is used.
|
6888
6993
|
# @return [Integer]
|
6889
6994
|
#
|
6890
6995
|
# @!attribute [rw] instance_warmup_period
|
@@ -6906,17 +7011,17 @@ module Aws::ECS
|
|
6906
7011
|
include Aws::Structure
|
6907
7012
|
end
|
6908
7013
|
|
6909
|
-
# Amazon ECS
|
6910
|
-
#
|
7014
|
+
# Amazon ECS can't determine the current version of the Amazon ECS
|
7015
|
+
# container agent on the container instance and doesn't have enough
|
6911
7016
|
# information to proceed with an update. This could be because the agent
|
6912
|
-
# running on the container instance is
|
6913
|
-
#
|
7017
|
+
# running on the container instance is a previous or custom version that
|
7018
|
+
# doesn't use our version information.
|
6914
7019
|
#
|
6915
7020
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/MissingVersionException AWS API Documentation
|
6916
7021
|
#
|
6917
7022
|
class MissingVersionException < Aws::EmptyStructure; end
|
6918
7023
|
|
6919
|
-
# Details
|
7024
|
+
# Details for a volume mount point that's used in a container
|
6920
7025
|
# definition.
|
6921
7026
|
#
|
6922
7027
|
# @note When making an API call, you may pass MountPoint
|
@@ -6974,12 +7079,12 @@ module Aws::ECS
|
|
6974
7079
|
# @return [String]
|
6975
7080
|
#
|
6976
7081
|
# @!attribute [rw] container_port
|
6977
|
-
# The port number on the container that
|
7082
|
+
# The port number on the container that's used with the network
|
6978
7083
|
# binding.
|
6979
7084
|
# @return [Integer]
|
6980
7085
|
#
|
6981
7086
|
# @!attribute [rw] host_port
|
6982
|
-
# The port number on the host that
|
7087
|
+
# The port number on the host that's used with the network binding.
|
6983
7088
|
# @return [Integer]
|
6984
7089
|
#
|
6985
7090
|
# @!attribute [rw] protocol
|
@@ -7012,7 +7117,7 @@ module Aws::ECS
|
|
7012
7117
|
# }
|
7013
7118
|
#
|
7014
7119
|
# @!attribute [rw] awsvpc_configuration
|
7015
|
-
# The VPC subnets and security groups associated with a task.
|
7120
|
+
# The VPC subnets and security groups that are associated with a task.
|
7016
7121
|
#
|
7017
7122
|
# <note markdown="1"> All specified subnets and security groups must be from the same VPC.
|
7018
7123
|
#
|
@@ -7052,9 +7157,10 @@ module Aws::ECS
|
|
7052
7157
|
include Aws::Structure
|
7053
7158
|
end
|
7054
7159
|
|
7055
|
-
# There
|
7056
|
-
#
|
7057
|
-
# it
|
7160
|
+
# There's no update available for this Amazon ECS container agent. This
|
7161
|
+
# might be because the agent is already running the latest version or
|
7162
|
+
# because it's so old that there's no update path to the current
|
7163
|
+
# version.
|
7058
7164
|
#
|
7059
7165
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/NoUpdateAvailableException AWS API Documentation
|
7060
7166
|
#
|
@@ -7064,8 +7170,8 @@ module Aws::ECS
|
|
7064
7170
|
# information, see [Task Placement Constraints][1] in the *Amazon
|
7065
7171
|
# Elastic Container Service Developer Guide*.
|
7066
7172
|
#
|
7067
|
-
# <note markdown="1"> If you
|
7068
|
-
#
|
7173
|
+
# <note markdown="1"> If you're using the Fargate launch type, task placement constraints
|
7174
|
+
# aren't supported.
|
7069
7175
|
#
|
7070
7176
|
# </note>
|
7071
7177
|
#
|
@@ -7131,16 +7237,16 @@ module Aws::ECS
|
|
7131
7237
|
# placement strategy spreads placement across available candidates
|
7132
7238
|
# evenly based on the `field` parameter. The `binpack` strategy places
|
7133
7239
|
# tasks on available candidates that have the least available amount
|
7134
|
-
# of the resource that
|
7240
|
+
# of the resource that's specified with the `field` parameter. For
|
7135
7241
|
# example, if you binpack on memory, a task is placed on the instance
|
7136
|
-
# with the least amount of remaining memory
|
7137
|
-
# the task
|
7242
|
+
# with the least amount of remaining memory but still enough to run
|
7243
|
+
# the task.
|
7138
7244
|
# @return [String]
|
7139
7245
|
#
|
7140
7246
|
# @!attribute [rw] field
|
7141
7247
|
# The field to apply the placement strategy against. For the `spread`
|
7142
7248
|
# placement strategy, valid values are `instanceId` (or `host`, which
|
7143
|
-
# has the same effect), or any platform or custom attribute that
|
7249
|
+
# has the same effect), or any platform or custom attribute that's
|
7144
7250
|
# applied to a container instance, such as
|
7145
7251
|
# `attribute:ecs.availability-zone`. For the `binpack` placement
|
7146
7252
|
# strategy, valid values are `cpu` and `memory`. For the `random`
|
@@ -7168,13 +7274,13 @@ module Aws::ECS
|
|
7168
7274
|
# }
|
7169
7275
|
#
|
7170
7276
|
# @!attribute [rw] id
|
7171
|
-
# The ID for the
|
7172
|
-
#
|
7277
|
+
# The ID for the GPUs on the container instance. The available GPU IDs
|
7278
|
+
# can also be obtained on the container instance in the
|
7173
7279
|
# `/var/lib/ecs/gpu/nvidia_gpu_info.json` file.
|
7174
7280
|
# @return [String]
|
7175
7281
|
#
|
7176
7282
|
# @!attribute [rw] type
|
7177
|
-
# The type of device that
|
7283
|
+
# The type of device that's available on the container instance. The
|
7178
7284
|
# only supported value is `GPU`.
|
7179
7285
|
# @return [String]
|
7180
7286
|
#
|
@@ -7187,14 +7293,14 @@ module Aws::ECS
|
|
7187
7293
|
include Aws::Structure
|
7188
7294
|
end
|
7189
7295
|
|
7190
|
-
# The specified platform version
|
7191
|
-
#
|
7296
|
+
# The specified platform version doesn't satisfy the required
|
7297
|
+
# capabilities of the task definition.
|
7192
7298
|
#
|
7193
7299
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PlatformTaskDefinitionIncompatibilityException AWS API Documentation
|
7194
7300
|
#
|
7195
7301
|
class PlatformTaskDefinitionIncompatibilityException < Aws::EmptyStructure; end
|
7196
7302
|
|
7197
|
-
# The specified platform version
|
7303
|
+
# The specified platform version doesn't exist.
|
7198
7304
|
#
|
7199
7305
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PlatformUnknownException AWS API Documentation
|
7200
7306
|
#
|
@@ -7204,13 +7310,12 @@ module Aws::ECS
|
|
7204
7310
|
# instance to send or receive traffic. Port mappings are specified as
|
7205
7311
|
# part of the container definition.
|
7206
7312
|
#
|
7207
|
-
# If you
|
7208
|
-
#
|
7209
|
-
#
|
7210
|
-
# `containerPort`.
|
7313
|
+
# If you use containers in a task with the `awsvpc` or `host` network
|
7314
|
+
# mode, specify the exposed ports using `containerPort`. The `hostPort`
|
7315
|
+
# can be left blank or it must be the same value as the `containerPort`.
|
7211
7316
|
#
|
7212
|
-
# <note markdown="1"> You
|
7213
|
-
#
|
7317
|
+
# <note markdown="1"> You can't expose the same container port for multiple protocols. If
|
7318
|
+
# you attempt this, an error is returned.
|
7214
7319
|
#
|
7215
7320
|
# </note>
|
7216
7321
|
#
|
@@ -7228,15 +7333,14 @@ module Aws::ECS
|
|
7228
7333
|
# }
|
7229
7334
|
#
|
7230
7335
|
# @!attribute [rw] container_port
|
7231
|
-
# The port number on the container that
|
7336
|
+
# The port number on the container that's bound to the user-specified
|
7232
7337
|
# or automatically assigned host port.
|
7233
7338
|
#
|
7234
|
-
# If you
|
7235
|
-
#
|
7236
|
-
# `containerPort`.
|
7339
|
+
# If you use containers in a task with the `awsvpc` or `host` network
|
7340
|
+
# mode, specify the exposed ports using `containerPort`.
|
7237
7341
|
#
|
7238
|
-
# If you
|
7239
|
-
#
|
7342
|
+
# If you use containers in a task with the `bridge` network mode and
|
7343
|
+
# you specify a container port and not a host port, your container
|
7240
7344
|
# automatically receives a host port in the ephemeral port range. For
|
7241
7345
|
# more information, see `hostPort`. Port mappings that are
|
7242
7346
|
# automatically assigned in this way do not count toward the 100
|
@@ -7247,14 +7351,14 @@ module Aws::ECS
|
|
7247
7351
|
# The port number on the container instance to reserve for your
|
7248
7352
|
# container.
|
7249
7353
|
#
|
7250
|
-
# If you
|
7251
|
-
#
|
7252
|
-
#
|
7354
|
+
# If you use containers in a task with the `awsvpc` or `host` network
|
7355
|
+
# mode, the `hostPort` can either be left blank or set to the same
|
7356
|
+
# value as the `containerPort`.
|
7253
7357
|
#
|
7254
|
-
# If you
|
7255
|
-
#
|
7256
|
-
#
|
7257
|
-
#
|
7358
|
+
# If you use containers in a task with the `bridge` network mode, you
|
7359
|
+
# can specify a non-reserved host port for your container port
|
7360
|
+
# mapping, or you can omit the `hostPort` (or set it to `0`) while
|
7361
|
+
# specifying a `containerPort` and your container automatically
|
7258
7362
|
# receives a port in the ephemeral port range for your container
|
7259
7363
|
# instance operating system and Docker version.
|
7260
7364
|
#
|
@@ -7275,12 +7379,12 @@ module Aws::ECS
|
|
7275
7379
|
# The default reserved ports are 22 for SSH, the Docker ports 2375 and
|
7276
7380
|
# 2376, and the Amazon ECS container agent ports 51678-51680. Any host
|
7277
7381
|
# port that was previously specified in a running task is also
|
7278
|
-
# reserved while the task is running
|
7279
|
-
# port is released
|
7280
|
-
# `remainingResources` of DescribeContainerInstances output. A
|
7281
|
-
# container instance can have up to 100 reserved ports at a time
|
7282
|
-
#
|
7283
|
-
#
|
7382
|
+
# reserved while the task is running. That is, after a task stops, the
|
7383
|
+
# host port is released. The current reserved ports are displayed in
|
7384
|
+
# the `remainingResources` of DescribeContainerInstances output. A
|
7385
|
+
# container instance can have up to 100 reserved ports at a time. This
|
7386
|
+
# number includes the default reserved ports. Automatically assigned
|
7387
|
+
# ports aren't included in the 100 reserved ports quota.
|
7284
7388
|
# @return [Integer]
|
7285
7389
|
#
|
7286
7390
|
# @!attribute [rw] protocol
|
@@ -7300,13 +7404,13 @@ module Aws::ECS
|
|
7300
7404
|
|
7301
7405
|
# The configuration details for the App Mesh proxy.
|
7302
7406
|
#
|
7303
|
-
# For tasks
|
7304
|
-
# at least version 1.26.0 of the container agent and at least
|
7305
|
-
# 1.26.0-1 of the `ecs-init` package to enable a proxy
|
7306
|
-
# your container instances are launched from the
|
7307
|
-
# AMI version `20190301` or later, then they
|
7308
|
-
# versions of the container agent and `ecs-init`.
|
7309
|
-
# see [Amazon ECS-optimized Linux AMI][1]
|
7407
|
+
# For tasks that use the EC2 launch type, the container instances
|
7408
|
+
# require at least version 1.26.0 of the container agent and at least
|
7409
|
+
# version 1.26.0-1 of the `ecs-init` package to enable a proxy
|
7410
|
+
# configuration. If your container instances are launched from the
|
7411
|
+
# Amazon ECS optimized AMI version `20190301` or later, then they
|
7412
|
+
# contain the required versions of the container agent and `ecs-init`.
|
7413
|
+
# For more information, see [Amazon ECS-optimized Linux AMI][1]
|
7310
7414
|
#
|
7311
7415
|
#
|
7312
7416
|
#
|
@@ -7510,8 +7614,8 @@ module Aws::ECS
|
|
7510
7614
|
#
|
7511
7615
|
# @!attribute [rw] attributes
|
7512
7616
|
# The attributes to apply to your resource. You can specify up to 10
|
7513
|
-
# custom attributes
|
7514
|
-
# in a single call.
|
7617
|
+
# custom attributes for each resource. You can specify up to 10
|
7618
|
+
# attributes in a single call.
|
7515
7619
|
# @return [Array<Types::Attribute>]
|
7516
7620
|
#
|
7517
7621
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutAttributesRequest AWS API Documentation
|
@@ -7552,7 +7656,7 @@ module Aws::ECS
|
|
7552
7656
|
#
|
7553
7657
|
# @!attribute [rw] cluster
|
7554
7658
|
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
7555
|
-
# modify the capacity provider settings for. If you
|
7659
|
+
# modify the capacity provider settings for. If you don't specify a
|
7556
7660
|
# cluster, the default cluster is assumed.
|
7557
7661
|
# @return [String]
|
7558
7662
|
#
|
@@ -7664,9 +7768,9 @@ module Aws::ECS
|
|
7664
7768
|
# }
|
7665
7769
|
#
|
7666
7770
|
# @!attribute [rw] cluster
|
7667
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
7668
|
-
#
|
7669
|
-
#
|
7771
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
7772
|
+
# register your container instance with. If you do not specify a
|
7773
|
+
# cluster, the default cluster is assumed.
|
7670
7774
|
# @return [String]
|
7671
7775
|
#
|
7672
7776
|
# @!attribute [rw] instance_identity_document
|
@@ -7689,7 +7793,7 @@ module Aws::ECS
|
|
7689
7793
|
#
|
7690
7794
|
# @!attribute [rw] version_info
|
7691
7795
|
# The version information for the Amazon ECS container agent and
|
7692
|
-
# Docker daemon
|
7796
|
+
# Docker daemon that runs on the container instance.
|
7693
7797
|
# @return [Types::VersionInfo]
|
7694
7798
|
#
|
7695
7799
|
# @!attribute [rw] container_instance_arn
|
@@ -7709,7 +7813,7 @@ module Aws::ECS
|
|
7709
7813
|
# @!attribute [rw] tags
|
7710
7814
|
# The metadata that you apply to the container instance to help you
|
7711
7815
|
# categorize and organize them. Each tag consists of a key and an
|
7712
|
-
# optional value
|
7816
|
+
# optional value. You define both.
|
7713
7817
|
#
|
7714
7818
|
# The following basic restrictions apply to tags:
|
7715
7819
|
#
|
@@ -7996,12 +8100,16 @@ module Aws::ECS
|
|
7996
8100
|
# ephemeral_storage: {
|
7997
8101
|
# size_in_gi_b: 1, # required
|
7998
8102
|
# },
|
8103
|
+
# runtime_platform: {
|
8104
|
+
# cpu_architecture: "X86_64", # accepts X86_64, ARM64
|
8105
|
+
# operating_system_family: "WINDOWS_SERVER_2019_FULL", # accepts WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2016_FULL, WINDOWS_SERVER_2004_CORE, WINDOWS_SERVER_2022_CORE, WINDOWS_SERVER_2022_FULL, WINDOWS_SERVER_20H2_CORE, LINUX
|
8106
|
+
# },
|
7999
8107
|
# }
|
8000
8108
|
#
|
8001
8109
|
# @!attribute [rw] family
|
8002
|
-
# You must specify a `family` for a task definition
|
8003
|
-
#
|
8004
|
-
#
|
8110
|
+
# You must specify a `family` for a task definition. You can use it
|
8111
|
+
# track multiple versions of the same task definition. The `family` is
|
8112
|
+
# used as a name for your task definition. Up to 255 letters
|
8005
8113
|
# (uppercase and lowercase), numbers, underscores, and hyphens are
|
8006
8114
|
# allowed.
|
8007
8115
|
# @return [String]
|
@@ -8083,28 +8191,27 @@ module Aws::ECS
|
|
8083
8191
|
#
|
8084
8192
|
# @!attribute [rw] volumes
|
8085
8193
|
# A list of volume definitions in JSON format that containers in your
|
8086
|
-
# task
|
8194
|
+
# task might use.
|
8087
8195
|
# @return [Array<Types::Volume>]
|
8088
8196
|
#
|
8089
8197
|
# @!attribute [rw] placement_constraints
|
8090
8198
|
# An array of placement constraint objects to use for the task. You
|
8091
|
-
# can specify a maximum of 10 constraints
|
8199
|
+
# can specify a maximum of 10 constraints for each task. This limit
|
8092
8200
|
# includes constraints in the task definition and those specified at
|
8093
|
-
# runtime
|
8201
|
+
# runtime.
|
8094
8202
|
# @return [Array<Types::TaskDefinitionPlacementConstraint>]
|
8095
8203
|
#
|
8096
8204
|
# @!attribute [rw] requires_compatibilities
|
8097
|
-
# The task launch type that Amazon ECS
|
8098
|
-
#
|
8099
|
-
#
|
8100
|
-
#
|
8101
|
-
# response.
|
8205
|
+
# The task launch type that Amazon ECS validates the task definition
|
8206
|
+
# against. A client exception is returned if the task definition
|
8207
|
+
# doesn't validate against the compatibilities specified. If no value
|
8208
|
+
# is specified, the parameter is omitted from the response.
|
8102
8209
|
# @return [Array<String>]
|
8103
8210
|
#
|
8104
8211
|
# @!attribute [rw] cpu
|
8105
8212
|
# The number of CPU units used by the task. It can be expressed as an
|
8106
|
-
# integer using CPU units
|
8107
|
-
# vCPUs
|
8213
|
+
# integer using CPU units (for example, `1024`) or as a string using
|
8214
|
+
# vCPUs (for example, `1 vCPU` or `1 vcpu`) in a task definition.
|
8108
8215
|
# String values are converted to an integer indicating the CPU units
|
8109
8216
|
# when the task definition is registered.
|
8110
8217
|
#
|
@@ -8114,14 +8221,17 @@ module Aws::ECS
|
|
8114
8221
|
#
|
8115
8222
|
# </note>
|
8116
8223
|
#
|
8117
|
-
# If you
|
8224
|
+
# If you're using the EC2 launch type, this field is optional.
|
8118
8225
|
# Supported values are between `128` CPU units (`0.125` vCPUs) and
|
8119
8226
|
# `10240` CPU units (`10` vCPUs).
|
8120
8227
|
#
|
8121
|
-
# If you
|
8228
|
+
# If you're using the Fargate launch type, this field is required and
|
8122
8229
|
# you must use one of the following values, which determines your
|
8123
8230
|
# range of supported values for the `memory` parameter:
|
8124
8231
|
#
|
8232
|
+
# The CPU units cannot be less than 1 vCPU when you use Windows
|
8233
|
+
# containers on Fargate.
|
8234
|
+
#
|
8125
8235
|
# * 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1
|
8126
8236
|
# GB), 2048 (2 GB)
|
8127
8237
|
#
|
@@ -8141,9 +8251,9 @@ module Aws::ECS
|
|
8141
8251
|
#
|
8142
8252
|
# @!attribute [rw] memory
|
8143
8253
|
# The amount of memory (in MiB) used by the task. It can be expressed
|
8144
|
-
# as an integer using MiB
|
8145
|
-
# GB
|
8146
|
-
# are converted to an integer indicating the MiB when the task
|
8254
|
+
# as an integer using MiB (for example ,`1024`) or as a string using
|
8255
|
+
# GB (for example, `1GB` or `1 GB`) in a task definition. String
|
8256
|
+
# values are converted to an integer indicating the MiB when the task
|
8147
8257
|
# definition is registered.
|
8148
8258
|
#
|
8149
8259
|
# <note markdown="1"> Task-level CPU and memory parameters are ignored for Windows
|
@@ -8155,8 +8265,11 @@ module Aws::ECS
|
|
8155
8265
|
# If using the EC2 launch type, this field is optional.
|
8156
8266
|
#
|
8157
8267
|
# If using the Fargate launch type, this field is required and you
|
8158
|
-
# must use one of the following values
|
8159
|
-
# supported values for the `cpu` parameter
|
8268
|
+
# must use one of the following values. This determines your range of
|
8269
|
+
# supported values for the `cpu` parameter.
|
8270
|
+
#
|
8271
|
+
# The CPU units cannot be less than 1 vCPU when you use Windows
|
8272
|
+
# containers on Fargate.
|
8160
8273
|
#
|
8161
8274
|
# * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values:
|
8162
8275
|
# 256 (.25 vCPU)
|
@@ -8177,7 +8290,7 @@ module Aws::ECS
|
|
8177
8290
|
# @!attribute [rw] tags
|
8178
8291
|
# The metadata that you apply to the task definition to help you
|
8179
8292
|
# categorize and organize them. Each tag consists of a key and an
|
8180
|
-
# optional value
|
8293
|
+
# optional value. You define both of them.
|
8181
8294
|
#
|
8182
8295
|
# The following basic restrictions apply to tags:
|
8183
8296
|
#
|
@@ -8302,7 +8415,11 @@ module Aws::ECS
|
|
8302
8415
|
# ECS User Guide for Fargate*.
|
8303
8416
|
#
|
8304
8417
|
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
|
8305
|
-
#
|
8418
|
+
# the following platform versions:
|
8419
|
+
#
|
8420
|
+
# * Linux platform version `1.4.0` or later.
|
8421
|
+
#
|
8422
|
+
# * Windows platform version `1.0.0` or later.
|
8306
8423
|
#
|
8307
8424
|
# </note>
|
8308
8425
|
#
|
@@ -8311,6 +8428,14 @@ module Aws::ECS
|
|
8311
8428
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html
|
8312
8429
|
# @return [Types::EphemeralStorage]
|
8313
8430
|
#
|
8431
|
+
# @!attribute [rw] runtime_platform
|
8432
|
+
# The operating system that your tasks definitions run on. A platform
|
8433
|
+
# family is specified only for tasks using the Fargate launch type.
|
8434
|
+
#
|
8435
|
+
# When you specify a task definition in a service, this value must
|
8436
|
+
# match the `runtimePlatform` value of the service.
|
8437
|
+
# @return [Types::RuntimePlatform]
|
8438
|
+
#
|
8314
8439
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterTaskDefinitionRequest AWS API Documentation
|
8315
8440
|
#
|
8316
8441
|
class RegisterTaskDefinitionRequest < Struct.new(
|
@@ -8329,7 +8454,8 @@ module Aws::ECS
|
|
8329
8454
|
:ipc_mode,
|
8330
8455
|
:proxy_configuration,
|
8331
8456
|
:inference_accelerators,
|
8332
|
-
:ephemeral_storage
|
8457
|
+
:ephemeral_storage,
|
8458
|
+
:runtime_platform)
|
8333
8459
|
SENSITIVE = []
|
8334
8460
|
include Aws::Structure
|
8335
8461
|
end
|
@@ -8364,11 +8490,11 @@ module Aws::ECS
|
|
8364
8490
|
# The Amazon Resource Name (ARN) of the secret containing the private
|
8365
8491
|
# repository credentials.
|
8366
8492
|
#
|
8367
|
-
# <note markdown="1"> When you
|
8368
|
-
#
|
8369
|
-
#
|
8370
|
-
#
|
8371
|
-
#
|
8493
|
+
# <note markdown="1"> When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if
|
8494
|
+
# the secret exists in the same Region as the task that you're
|
8495
|
+
# launching then you can use either the full ARN or the name of the
|
8496
|
+
# secret. When you use the Amazon Web Services Management Console, you
|
8497
|
+
# must specify the full ARN of the secret.
|
8372
8498
|
#
|
8373
8499
|
# </note>
|
8374
8500
|
# @return [String]
|
@@ -8401,8 +8527,8 @@ module Aws::ECS
|
|
8401
8527
|
# @return [String]
|
8402
8528
|
#
|
8403
8529
|
# @!attribute [rw] type
|
8404
|
-
# The type of the resource
|
8405
|
-
# `STRINGSET`.
|
8530
|
+
# The type of the resource. Valid values: `INTEGER`, `DOUBLE`, `LONG`,
|
8531
|
+
# or `STRINGSET`.
|
8406
8532
|
# @return [String]
|
8407
8533
|
#
|
8408
8534
|
# @!attribute [rw] double_value
|
@@ -8438,13 +8564,13 @@ module Aws::ECS
|
|
8438
8564
|
include Aws::Structure
|
8439
8565
|
end
|
8440
8566
|
|
8441
|
-
# The specified resource is in-use and
|
8567
|
+
# The specified resource is in-use and can't be removed.
|
8442
8568
|
#
|
8443
8569
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ResourceInUseException AWS API Documentation
|
8444
8570
|
#
|
8445
8571
|
class ResourceInUseException < Aws::EmptyStructure; end
|
8446
8572
|
|
8447
|
-
# The specified resource
|
8573
|
+
# The specified resource wasn't found.
|
8448
8574
|
#
|
8449
8575
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ResourceNotFoundException AWS API Documentation
|
8450
8576
|
#
|
@@ -8473,13 +8599,13 @@ module Aws::ECS
|
|
8473
8599
|
# The value for the specified resource type.
|
8474
8600
|
#
|
8475
8601
|
# If the `GPU` type is used, the value is the number of physical
|
8476
|
-
# `GPUs` the Amazon ECS container agent
|
8477
|
-
#
|
8478
|
-
#
|
8479
|
-
#
|
8602
|
+
# `GPUs` the Amazon ECS container agent reserves for the container.
|
8603
|
+
# The number of GPUs that's reserved for all containers in a task
|
8604
|
+
# can't exceed the number of available GPUs on the container instance
|
8605
|
+
# that the task is launched on.
|
8480
8606
|
#
|
8481
|
-
# If the `InferenceAccelerator` type is used, the `value`
|
8482
|
-
#
|
8607
|
+
# If the `InferenceAccelerator` type is used, the `value` matches the
|
8608
|
+
# `deviceName` for an InferenceAccelerator specified in a task
|
8483
8609
|
# definition.
|
8484
8610
|
# @return [String]
|
8485
8611
|
#
|
@@ -8604,14 +8730,14 @@ module Aws::ECS
|
|
8604
8730
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
8605
8731
|
#
|
8606
8732
|
# @!attribute [rw] cluster
|
8607
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
8608
|
-
#
|
8733
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
8734
|
+
# run your task on. If you do not specify a cluster, the default
|
8609
8735
|
# cluster is assumed.
|
8610
8736
|
# @return [String]
|
8611
8737
|
#
|
8612
8738
|
# @!attribute [rw] count
|
8613
8739
|
# The number of instantiations of the specified task to place on your
|
8614
|
-
# cluster. You can specify up to 10 tasks
|
8740
|
+
# cluster. You can specify up to 10 tasks for each call.
|
8615
8741
|
# @return [Integer]
|
8616
8742
|
#
|
8617
8743
|
# @!attribute [rw] enable_ecs_managed_tags
|
@@ -8625,8 +8751,8 @@ module Aws::ECS
|
|
8625
8751
|
# @return [Boolean]
|
8626
8752
|
#
|
8627
8753
|
# @!attribute [rw] enable_execute_command
|
8628
|
-
#
|
8629
|
-
# containers in this task. If `true`, this enables execute command
|
8754
|
+
# Determines whether to enable the execute command functionality for
|
8755
|
+
# the containers in this task. If `true`, this enables execute command
|
8630
8756
|
# functionality on all containers in the task.
|
8631
8757
|
# @return [Boolean]
|
8632
8758
|
#
|
@@ -8637,7 +8763,7 @@ module Aws::ECS
|
|
8637
8763
|
# @return [String]
|
8638
8764
|
#
|
8639
8765
|
# @!attribute [rw] launch_type
|
8640
|
-
# The infrastructure
|
8766
|
+
# The infrastructure to run your standalone task on. For more
|
8641
8767
|
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
8642
8768
|
# Container Service Developer Guide*.
|
8643
8769
|
#
|
@@ -8653,8 +8779,8 @@ module Aws::ECS
|
|
8653
8779
|
# The `EC2` launch type runs your tasks on Amazon EC2 instances
|
8654
8780
|
# registered to your cluster.
|
8655
8781
|
#
|
8656
|
-
# The `EXTERNAL` launch type runs your tasks on your on-
|
8657
|
-
# or virtual machine (VM) capacity registered to your cluster.
|
8782
|
+
# The `EXTERNAL` launch type runs your tasks on your on-premises
|
8783
|
+
# server or virtual machine (VM) capacity registered to your cluster.
|
8658
8784
|
#
|
8659
8785
|
# A task can use either a launch type or a capacity provider strategy.
|
8660
8786
|
# If a `launchType` is specified, the `capacityProviderStrategy`
|
@@ -8672,7 +8798,7 @@ module Aws::ECS
|
|
8672
8798
|
# @!attribute [rw] network_configuration
|
8673
8799
|
# The network configuration for the task. This parameter is required
|
8674
8800
|
# for task definitions that use the `awsvpc` network mode to receive
|
8675
|
-
# their own elastic network interface, and it
|
8801
|
+
# their own elastic network interface, and it isn't supported for
|
8676
8802
|
# other network modes. For more information, see [Task networking][1]
|
8677
8803
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
8678
8804
|
#
|
@@ -8685,7 +8811,7 @@ module Aws::ECS
|
|
8685
8811
|
# A list of container overrides in JSON format that specify the name
|
8686
8812
|
# of a container in the specified task definition and the overrides it
|
8687
8813
|
# should receive. You can override the default command for a container
|
8688
|
-
# (that
|
8814
|
+
# (that's specified in the task definition or Docker image) with a
|
8689
8815
|
# `command` override. You can also override existing environment
|
8690
8816
|
# variables (that are specified in the task definition or Docker
|
8691
8817
|
# image) on a container or add new environment variables to it with an
|
@@ -8697,20 +8823,20 @@ module Aws::ECS
|
|
8697
8823
|
#
|
8698
8824
|
# @!attribute [rw] placement_constraints
|
8699
8825
|
# An array of placement constraint objects to use for the task. You
|
8700
|
-
# can specify up to 10 constraints
|
8701
|
-
# the task definition and those specified at runtime).
|
8826
|
+
# can specify up to 10 constraints for each task (including
|
8827
|
+
# constraints in the task definition and those specified at runtime).
|
8702
8828
|
# @return [Array<Types::PlacementConstraint>]
|
8703
8829
|
#
|
8704
8830
|
# @!attribute [rw] placement_strategy
|
8705
8831
|
# The placement strategy objects to use for the task. You can specify
|
8706
|
-
# a maximum of 5 strategy rules
|
8832
|
+
# a maximum of 5 strategy rules for each task.
|
8707
8833
|
# @return [Array<Types::PlacementStrategy>]
|
8708
8834
|
#
|
8709
8835
|
# @!attribute [rw] platform_version
|
8710
|
-
# The platform version the task
|
8711
|
-
# specified for tasks hosted on Fargate. If one
|
8712
|
-
# `LATEST` platform version is used
|
8713
|
-
#
|
8836
|
+
# The platform version the task uses. A platform version is only
|
8837
|
+
# specified for tasks hosted on Fargate. If one isn't specified, the
|
8838
|
+
# `LATEST` platform version is used. For more information, see
|
8839
|
+
# [Fargate platform versions][1] in the *Amazon Elastic Container
|
8714
8840
|
# Service Developer Guide*.
|
8715
8841
|
#
|
8716
8842
|
#
|
@@ -8720,7 +8846,7 @@ module Aws::ECS
|
|
8720
8846
|
#
|
8721
8847
|
# @!attribute [rw] propagate_tags
|
8722
8848
|
# Specifies whether to propagate the tags from the task definition to
|
8723
|
-
# the task. If no value is specified, the tags
|
8849
|
+
# the task. If no value is specified, the tags aren't propagated.
|
8724
8850
|
# Tags can only be propagated to the task during task creation. To add
|
8725
8851
|
# tags to a task after task creation, use the TagResource API action.
|
8726
8852
|
#
|
@@ -8742,7 +8868,7 @@ module Aws::ECS
|
|
8742
8868
|
# `startedBy` parameter. You can then identify which tasks belong to
|
8743
8869
|
# that job by filtering the results of a ListTasks call with the
|
8744
8870
|
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
8745
|
-
# numbers, hyphens, and underscores are allowed.
|
8871
|
+
# numbers, hyphens (-), and underscores (\_) are allowed.
|
8746
8872
|
#
|
8747
8873
|
# If a task is started by an Amazon ECS service, then the `startedBy`
|
8748
8874
|
# parameter contains the deployment ID of the service that starts it.
|
@@ -8781,10 +8907,10 @@ module Aws::ECS
|
|
8781
8907
|
#
|
8782
8908
|
# @!attribute [rw] task_definition
|
8783
8909
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
8784
|
-
# task definition to run. If a `revision`
|
8910
|
+
# task definition to run. If a `revision` isn't specified, the latest
|
8785
8911
|
# `ACTIVE` revision is used.
|
8786
8912
|
#
|
8787
|
-
# The full ARN value must match the value that you specified
|
8913
|
+
# The full ARN value must match the value that you specified as the
|
8788
8914
|
# `Resource` of the IAM principal's permissions policy. For example,
|
8789
8915
|
# if the `Resource` is
|
8790
8916
|
# arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*,
|
@@ -8834,6 +8960,45 @@ module Aws::ECS
|
|
8834
8960
|
include Aws::Structure
|
8835
8961
|
end
|
8836
8962
|
|
8963
|
+
# Information about the platform for the Amazon ECS service or task.
|
8964
|
+
#
|
8965
|
+
# For more informataion about `RuntimePlatform`, see
|
8966
|
+
# [RuntimePlatform][1] in the *Amazon Elastic Container Service
|
8967
|
+
# Developer Guide*.
|
8968
|
+
#
|
8969
|
+
#
|
8970
|
+
#
|
8971
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform
|
8972
|
+
#
|
8973
|
+
# @note When making an API call, you may pass RuntimePlatform
|
8974
|
+
# data as a hash:
|
8975
|
+
#
|
8976
|
+
# {
|
8977
|
+
# cpu_architecture: "X86_64", # accepts X86_64, ARM64
|
8978
|
+
# operating_system_family: "WINDOWS_SERVER_2019_FULL", # accepts WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2016_FULL, WINDOWS_SERVER_2004_CORE, WINDOWS_SERVER_2022_CORE, WINDOWS_SERVER_2022_FULL, WINDOWS_SERVER_20H2_CORE, LINUX
|
8979
|
+
# }
|
8980
|
+
#
|
8981
|
+
# @!attribute [rw] cpu_architecture
|
8982
|
+
# The CPU architecture.
|
8983
|
+
#
|
8984
|
+
# You can run your Linux tasks on an ARM-based platform by setting the
|
8985
|
+
# value to `ARM64`. This option is avaiable for tasks that run on
|
8986
|
+
# Linuc Amazon EC2 instance or Linux containers on Fargate.
|
8987
|
+
# @return [String]
|
8988
|
+
#
|
8989
|
+
# @!attribute [rw] operating_system_family
|
8990
|
+
# The operating system.
|
8991
|
+
# @return [String]
|
8992
|
+
#
|
8993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RuntimePlatform AWS API Documentation
|
8994
|
+
#
|
8995
|
+
class RuntimePlatform < Struct.new(
|
8996
|
+
:cpu_architecture,
|
8997
|
+
:operating_system_family)
|
8998
|
+
SENSITIVE = []
|
8999
|
+
include Aws::Structure
|
9000
|
+
end
|
9001
|
+
|
8837
9002
|
# A floating-point percentage of the desired number of tasks to place
|
8838
9003
|
# and keep running in the task set.
|
8839
9004
|
#
|
@@ -8898,7 +9063,7 @@ module Aws::ECS
|
|
8898
9063
|
# the parameter in the SSM Parameter Store.
|
8899
9064
|
#
|
8900
9065
|
# <note markdown="1"> If the SSM Parameter Store parameter exists in the same Region as
|
8901
|
-
# the task you
|
9066
|
+
# the task you're launching, then you can use either the full ARN or
|
8902
9067
|
# name of the parameter. If the parameter exists in a different
|
8903
9068
|
# Region, then the full ARN must be specified.
|
8904
9069
|
#
|
@@ -8940,9 +9105,9 @@ module Aws::ECS
|
|
8940
9105
|
# @!attribute [rw] service_name
|
8941
9106
|
# The name of your service. Up to 255 letters (uppercase and
|
8942
9107
|
# lowercase), numbers, underscores, and hyphens are allowed. Service
|
8943
|
-
# names must be unique within a cluster,
|
8944
|
-
# named services in multiple clusters within a Region or
|
8945
|
-
# multiple Regions.
|
9108
|
+
# names must be unique within a cluster. However, you can have
|
9109
|
+
# similarly named services in multiple clusters within a Region or
|
9110
|
+
# across multiple Regions.
|
8946
9111
|
# @return [String]
|
8947
9112
|
#
|
8948
9113
|
# @!attribute [rw] cluster_arn
|
@@ -8951,14 +9116,14 @@ module Aws::ECS
|
|
8951
9116
|
# @return [String]
|
8952
9117
|
#
|
8953
9118
|
# @!attribute [rw] load_balancers
|
8954
|
-
# A list of Elastic Load Balancing load balancer objects
|
8955
|
-
# the load balancer name, the container name
|
8956
|
-
#
|
8957
|
-
#
|
9119
|
+
# A list of Elastic Load Balancing load balancer objects. It contains
|
9120
|
+
# the load balancer name, the container name, and the container port
|
9121
|
+
# to access from the load balancer. The container name is as it
|
9122
|
+
# appears in a container definition.
|
8958
9123
|
# @return [Array<Types::LoadBalancer>]
|
8959
9124
|
#
|
8960
9125
|
# @!attribute [rw] service_registries
|
8961
|
-
# The details
|
9126
|
+
# The details for the service discovery registries to assign to this
|
8962
9127
|
# service. For more information, see [Service Discovery][1].
|
8963
9128
|
#
|
8964
9129
|
#
|
@@ -8993,16 +9158,16 @@ module Aws::ECS
|
|
8993
9158
|
# @return [String]
|
8994
9159
|
#
|
8995
9160
|
# @!attribute [rw] capacity_provider_strategy
|
8996
|
-
# The capacity provider strategy the service
|
9161
|
+
# The capacity provider strategy the service uses. When using the
|
8997
9162
|
# DescribeServices API, this field is omitted if the service was
|
8998
9163
|
# created using a launch type.
|
8999
9164
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
9000
9165
|
#
|
9001
9166
|
# @!attribute [rw] platform_version
|
9002
|
-
# The platform version
|
9003
|
-
#
|
9004
|
-
# specified, the `LATEST` platform version is used
|
9005
|
-
#
|
9167
|
+
# The platform version to run your service on. A platform version is
|
9168
|
+
# only specified for tasks that are hosted on Fargate. If one isn't
|
9169
|
+
# specified, the `LATEST` platform version is used. For more
|
9170
|
+
# information, see [Fargate Platform Versions][1] in the *Amazon
|
9006
9171
|
# Elastic Container Service Developer Guide*.
|
9007
9172
|
#
|
9008
9173
|
#
|
@@ -9010,6 +9175,15 @@ module Aws::ECS
|
|
9010
9175
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
9011
9176
|
# @return [String]
|
9012
9177
|
#
|
9178
|
+
# @!attribute [rw] platform_family
|
9179
|
+
# The operating system that your tasks in the service run on. A
|
9180
|
+
# platform family is specified only for tasks using the Fargate launch
|
9181
|
+
# type.
|
9182
|
+
#
|
9183
|
+
# All tasks that run as part of this service must use the same
|
9184
|
+
# `platformFamily` value as the service (for example, `LINUX`).
|
9185
|
+
# @return [String]
|
9186
|
+
#
|
9013
9187
|
# @!attribute [rw] task_definition
|
9014
9188
|
# The task definition to use for tasks in the service. This value is
|
9015
9189
|
# specified when the service is created with CreateService, and it can
|
@@ -9034,9 +9208,9 @@ module Aws::ECS
|
|
9034
9208
|
# @return [Array<Types::Deployment>]
|
9035
9209
|
#
|
9036
9210
|
# @!attribute [rw] role_arn
|
9037
|
-
# The ARN of the IAM role associated with the service
|
9038
|
-
# Amazon ECS container agent to register container
|
9039
|
-
# Elastic Load Balancing load balancer.
|
9211
|
+
# The ARN of the IAM role that's associated with the service. It
|
9212
|
+
# allows the Amazon ECS container agent to register container
|
9213
|
+
# instances with an Elastic Load Balancing load balancer.
|
9040
9214
|
# @return [String]
|
9041
9215
|
#
|
9042
9216
|
# @!attribute [rw] events
|
@@ -9045,7 +9219,7 @@ module Aws::ECS
|
|
9045
9219
|
# @return [Array<Types::ServiceEvent>]
|
9046
9220
|
#
|
9047
9221
|
# @!attribute [rw] created_at
|
9048
|
-
# The Unix timestamp for when the service was created.
|
9222
|
+
# The Unix timestamp for the time when the service was created.
|
9049
9223
|
# @return [Time]
|
9050
9224
|
#
|
9051
9225
|
# @!attribute [rw] placement_constraints
|
@@ -9073,7 +9247,7 @@ module Aws::ECS
|
|
9073
9247
|
# The scheduling strategy to use for the service. For more
|
9074
9248
|
# information, see [Services][1].
|
9075
9249
|
#
|
9076
|
-
# There are two service scheduler strategies available
|
9250
|
+
# There are two service scheduler strategies available.
|
9077
9251
|
#
|
9078
9252
|
# * `REPLICA`-The replica scheduling strategy places and maintains the
|
9079
9253
|
# desired number of tasks across your cluster. By default, the
|
@@ -9082,13 +9256,13 @@ module Aws::ECS
|
|
9082
9256
|
# placement decisions.
|
9083
9257
|
#
|
9084
9258
|
# * `DAEMON`-The daemon scheduling strategy deploys exactly one task
|
9085
|
-
# on each active container instance
|
9259
|
+
# on each active container instance. This taskmeets all of the task
|
9086
9260
|
# placement constraints that you specify in your cluster. The
|
9087
9261
|
# service scheduler also evaluates the task placement constraints
|
9088
|
-
# for running tasks
|
9089
|
-
#
|
9262
|
+
# for running tasks. It stop tasks that don't meet the placement
|
9263
|
+
# constraints.
|
9090
9264
|
#
|
9091
|
-
# <note markdown="1"> Fargate tasks
|
9265
|
+
# <note markdown="1"> Fargate tasks don't support the `DAEMON` scheduling strategy.
|
9092
9266
|
#
|
9093
9267
|
# </note>
|
9094
9268
|
#
|
@@ -9099,14 +9273,14 @@ module Aws::ECS
|
|
9099
9273
|
#
|
9100
9274
|
# @!attribute [rw] deployment_controller
|
9101
9275
|
# The deployment controller type the service is using. When using the
|
9102
|
-
# DescribeServices API, this field is omitted if the service
|
9103
|
-
#
|
9276
|
+
# DescribeServices API, this field is omitted if the service uses the
|
9277
|
+
# `ECS` deployment controller type.
|
9104
9278
|
# @return [Types::DeploymentController]
|
9105
9279
|
#
|
9106
9280
|
# @!attribute [rw] tags
|
9107
9281
|
# The metadata that you apply to the service to help you categorize
|
9108
|
-
# and organize them. Each tag consists of a key and an optional value
|
9109
|
-
#
|
9282
|
+
# and organize them. Each tag consists of a key and an optional value.
|
9283
|
+
# You define bot the key and value.
|
9110
9284
|
#
|
9111
9285
|
# The following basic restrictions apply to tags:
|
9112
9286
|
#
|
@@ -9139,8 +9313,8 @@ module Aws::ECS
|
|
9139
9313
|
# @return [String]
|
9140
9314
|
#
|
9141
9315
|
# @!attribute [rw] enable_ecs_managed_tags
|
9142
|
-
#
|
9143
|
-
# the service. For more information, see [Tagging Your Amazon ECS
|
9316
|
+
# Determines whether to enable Amazon ECS managed tags for the tasks
|
9317
|
+
# in the service. For more information, see [Tagging Your Amazon ECS
|
9144
9318
|
# Resources][1] in the *Amazon Elastic Container Service Developer
|
9145
9319
|
# Guide*.
|
9146
9320
|
#
|
@@ -9150,15 +9324,15 @@ module Aws::ECS
|
|
9150
9324
|
# @return [Boolean]
|
9151
9325
|
#
|
9152
9326
|
# @!attribute [rw] propagate_tags
|
9153
|
-
#
|
9154
|
-
# the service to the task. If no value is specified, the tags
|
9327
|
+
# Determines whether to propagate the tags from the task definition or
|
9328
|
+
# the service to the task. If no value is specified, the tags aren't
|
9155
9329
|
# propagated.
|
9156
9330
|
# @return [String]
|
9157
9331
|
#
|
9158
9332
|
# @!attribute [rw] enable_execute_command
|
9159
|
-
#
|
9160
|
-
# service. If `true`, the execute command functionality is enabled
|
9161
|
-
# all containers in tasks as part of the service.
|
9333
|
+
# Determines whether the execute command functionality is enabled for
|
9334
|
+
# the service. If `true`, the execute command functionality is enabled
|
9335
|
+
# for all containers in tasks as part of the service.
|
9162
9336
|
# @return [Boolean]
|
9163
9337
|
#
|
9164
9338
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Service AWS API Documentation
|
@@ -9176,6 +9350,7 @@ module Aws::ECS
|
|
9176
9350
|
:launch_type,
|
9177
9351
|
:capacity_provider_strategy,
|
9178
9352
|
:platform_version,
|
9353
|
+
:platform_family,
|
9179
9354
|
:task_definition,
|
9180
9355
|
:deployment_configuration,
|
9181
9356
|
:task_sets,
|
@@ -9198,14 +9373,14 @@ module Aws::ECS
|
|
9198
9373
|
include Aws::Structure
|
9199
9374
|
end
|
9200
9375
|
|
9201
|
-
#
|
9376
|
+
# The details for an event that's associated with a service.
|
9202
9377
|
#
|
9203
9378
|
# @!attribute [rw] id
|
9204
|
-
# The ID string
|
9379
|
+
# The ID string for the event.
|
9205
9380
|
# @return [String]
|
9206
9381
|
#
|
9207
9382
|
# @!attribute [rw] created_at
|
9208
|
-
# The Unix timestamp for when the event was triggered.
|
9383
|
+
# The Unix timestamp for the time when the event was triggered.
|
9209
9384
|
# @return [Time]
|
9210
9385
|
#
|
9211
9386
|
# @!attribute [rw] message
|
@@ -9222,23 +9397,23 @@ module Aws::ECS
|
|
9222
9397
|
include Aws::Structure
|
9223
9398
|
end
|
9224
9399
|
|
9225
|
-
# The specified service
|
9226
|
-
#
|
9400
|
+
# The specified service isn't active. You can't update a service
|
9401
|
+
# that's inactive. If you have previously deleted a service, you can
|
9227
9402
|
# re-create it with CreateService.
|
9228
9403
|
#
|
9229
9404
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceNotActiveException AWS API Documentation
|
9230
9405
|
#
|
9231
9406
|
class ServiceNotActiveException < Aws::EmptyStructure; end
|
9232
9407
|
|
9233
|
-
# The specified service
|
9234
|
-
# services with ListServices. Amazon ECS services are cluster
|
9235
|
-
# and Region
|
9408
|
+
# The specified service wasn't found. You can view your available
|
9409
|
+
# services with ListServices. Amazon ECS services are cluster specific
|
9410
|
+
# and Region specific.
|
9236
9411
|
#
|
9237
9412
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceNotFoundException AWS API Documentation
|
9238
9413
|
#
|
9239
9414
|
class ServiceNotFoundException < Aws::EmptyStructure; end
|
9240
9415
|
|
9241
|
-
#
|
9416
|
+
# The details for the service registry.
|
9242
9417
|
#
|
9243
9418
|
# @note When making an API call, you may pass ServiceRegistry
|
9244
9419
|
# data as a hash:
|
@@ -9262,31 +9437,32 @@ module Aws::ECS
|
|
9262
9437
|
#
|
9263
9438
|
# @!attribute [rw] port
|
9264
9439
|
# The port value used if your service discovery service specified an
|
9265
|
-
# SRV record. This field
|
9266
|
-
# and SRV records are used.
|
9440
|
+
# SRV record. This field might be used if both the `awsvpc` network
|
9441
|
+
# mode and SRV records are used.
|
9267
9442
|
# @return [Integer]
|
9268
9443
|
#
|
9269
9444
|
# @!attribute [rw] container_name
|
9270
|
-
# The container name value
|
9271
|
-
#
|
9445
|
+
# The container name value to be used for your service discovery
|
9446
|
+
# service. It's already specified in the task definition. If the task
|
9272
9447
|
# definition that your service task specifies uses the `bridge` or
|
9273
9448
|
# `host` network mode, you must specify a `containerName` and
|
9274
9449
|
# `containerPort` combination from the task definition. If the task
|
9275
9450
|
# definition that your service task specifies uses the `awsvpc`
|
9276
9451
|
# network mode and a type SRV DNS record is used, you must specify
|
9277
9452
|
# either a `containerName` and `containerPort` combination or a `port`
|
9278
|
-
# value,
|
9453
|
+
# value. However, you can't specify both.
|
9279
9454
|
# @return [String]
|
9280
9455
|
#
|
9281
9456
|
# @!attribute [rw] container_port
|
9282
|
-
# The port value
|
9283
|
-
#
|
9284
|
-
# service task specifies uses the `bridge` or `host` network
|
9285
|
-
# must specify a `containerName` and `containerPort`
|
9286
|
-
# the task definition. If the task definition your
|
9287
|
-
# specifies uses the `awsvpc` network mode and a type SRV
|
9288
|
-
# is used, you must specify either a `containerName` and
|
9289
|
-
# `containerPort` combination or a `port` value,
|
9457
|
+
# The port value to be used for your service discovery service. It's
|
9458
|
+
# already specified in the task definition. If the task definition
|
9459
|
+
# your service task specifies uses the `bridge` or `host` network
|
9460
|
+
# mode, you must specify a `containerName` and `containerPort`
|
9461
|
+
# combination from the task definition. If the task definition your
|
9462
|
+
# service task specifies uses the `awsvpc` network mode and a type SRV
|
9463
|
+
# DNS record is used, you must specify either a `containerName` and
|
9464
|
+
# `containerPort` combination or a `port` value. However, you can't
|
9465
|
+
# specify both.
|
9290
9466
|
# @return [Integer]
|
9291
9467
|
#
|
9292
9468
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceRegistry AWS API Documentation
|
@@ -9300,7 +9476,7 @@ module Aws::ECS
|
|
9300
9476
|
include Aws::Structure
|
9301
9477
|
end
|
9302
9478
|
|
9303
|
-
# The details
|
9479
|
+
# The details for the execute command session.
|
9304
9480
|
#
|
9305
9481
|
# @!attribute [rw] session_id
|
9306
9482
|
# The ID of the execute command session.
|
@@ -9314,7 +9490,7 @@ module Aws::ECS
|
|
9314
9490
|
#
|
9315
9491
|
# @!attribute [rw] token_value
|
9316
9492
|
# An encrypted token value containing session and caller information.
|
9317
|
-
#
|
9493
|
+
# It's used to authenticate the connection to the container.
|
9318
9494
|
# @return [String]
|
9319
9495
|
#
|
9320
9496
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Session AWS API Documentation
|
@@ -9334,12 +9510,12 @@ module Aws::ECS
|
|
9334
9510
|
# @return [String]
|
9335
9511
|
#
|
9336
9512
|
# @!attribute [rw] value
|
9337
|
-
#
|
9338
|
-
# resource.
|
9513
|
+
# Determines whether the account setting is enabled or disabled for
|
9514
|
+
# the specified resource.
|
9339
9515
|
# @return [String]
|
9340
9516
|
#
|
9341
9517
|
# @!attribute [rw] principal_arn
|
9342
|
-
# The ARN of the principal
|
9518
|
+
# The ARN of the principal. It can be an IAM user, IAM role, or the
|
9343
9519
|
# root user. If this field is omitted, the authenticated user is
|
9344
9520
|
# assumed.
|
9345
9521
|
# @return [String]
|
@@ -9425,15 +9601,15 @@ module Aws::ECS
|
|
9425
9601
|
# }
|
9426
9602
|
#
|
9427
9603
|
# @!attribute [rw] cluster
|
9428
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
9429
|
-
#
|
9604
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster
|
9605
|
+
# where to start your task. If you do not specify a cluster, the
|
9430
9606
|
# default cluster is assumed.
|
9431
9607
|
# @return [String]
|
9432
9608
|
#
|
9433
9609
|
# @!attribute [rw] container_instances
|
9434
9610
|
# The container instance IDs or full ARN entries for the container
|
9435
|
-
# instances
|
9436
|
-
#
|
9611
|
+
# instances where you would like to place your task. You can specify
|
9612
|
+
# up to 10 container instances.
|
9437
9613
|
# @return [Array<String>]
|
9438
9614
|
#
|
9439
9615
|
# @!attribute [rw] enable_ecs_managed_tags
|
@@ -9467,8 +9643,8 @@ module Aws::ECS
|
|
9467
9643
|
# @!attribute [rw] overrides
|
9468
9644
|
# A list of container overrides in JSON format that specify the name
|
9469
9645
|
# of a container in the specified task definition and the overrides it
|
9470
|
-
#
|
9471
|
-
# (that
|
9646
|
+
# receives. You can override the default command for a container
|
9647
|
+
# (that's specified in the task definition or Docker image) with a
|
9472
9648
|
# `command` override. You can also override existing environment
|
9473
9649
|
# variables (that are specified in the task definition or Docker
|
9474
9650
|
# image) on a container or add new environment variables to it with an
|
@@ -9482,7 +9658,7 @@ module Aws::ECS
|
|
9482
9658
|
#
|
9483
9659
|
# @!attribute [rw] propagate_tags
|
9484
9660
|
# Specifies whether to propagate the tags from the task definition or
|
9485
|
-
# the service to the task. If no value is specified, the tags
|
9661
|
+
# the service to the task. If no value is specified, the tags aren't
|
9486
9662
|
# propagated.
|
9487
9663
|
# @return [String]
|
9488
9664
|
#
|
@@ -9497,9 +9673,9 @@ module Aws::ECS
|
|
9497
9673
|
# `startedBy` parameter. You can then identify which tasks belong to
|
9498
9674
|
# that job by filtering the results of a ListTasks call with the
|
9499
9675
|
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
9500
|
-
# numbers, hyphens, and underscores are allowed.
|
9676
|
+
# numbers, hyphens (-), and underscores (\_) are allowed.
|
9501
9677
|
#
|
9502
|
-
# If a task is started by an Amazon ECS service,
|
9678
|
+
# If a task is started by an Amazon ECS service, the `startedBy`
|
9503
9679
|
# parameter contains the deployment ID of the service that starts it.
|
9504
9680
|
# @return [String]
|
9505
9681
|
#
|
@@ -9536,7 +9712,7 @@ module Aws::ECS
|
|
9536
9712
|
#
|
9537
9713
|
# @!attribute [rw] task_definition
|
9538
9714
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
9539
|
-
# task definition to start. If a `revision`
|
9715
|
+
# task definition to start. If a `revision` isn't specified, the
|
9540
9716
|
# latest `ACTIVE` revision is used.
|
9541
9717
|
# @return [String]
|
9542
9718
|
#
|
@@ -9598,7 +9774,7 @@ module Aws::ECS
|
|
9598
9774
|
#
|
9599
9775
|
# @!attribute [rw] reason
|
9600
9776
|
# An optional message specified when a task is stopped. For example,
|
9601
|
-
# if you
|
9777
|
+
# if you're using a custom scheduler, you can use this parameter to
|
9602
9778
|
# specify the reason for stopping the task here, and the message
|
9603
9779
|
# appears in subsequent DescribeTasks API operations on this task. Up
|
9604
9780
|
# to 255 characters are allowed in this message.
|
@@ -9712,7 +9888,7 @@ module Aws::ECS
|
|
9712
9888
|
# @return [String]
|
9713
9889
|
#
|
9714
9890
|
# @!attribute [rw] exit_code
|
9715
|
-
# The exit code returned for the state change request.
|
9891
|
+
# The exit code that's returned for the state change request.
|
9716
9892
|
# @return [Integer]
|
9717
9893
|
#
|
9718
9894
|
# @!attribute [rw] reason
|
@@ -9813,7 +9989,7 @@ module Aws::ECS
|
|
9813
9989
|
# @return [String]
|
9814
9990
|
#
|
9815
9991
|
# @!attribute [rw] containers
|
9816
|
-
# Any containers associated with the state change request.
|
9992
|
+
# Any containers that's associated with the state change request.
|
9817
9993
|
# @return [Array<Types::ContainerStateChange>]
|
9818
9994
|
#
|
9819
9995
|
# @!attribute [rw] attachments
|
@@ -9821,19 +9997,21 @@ module Aws::ECS
|
|
9821
9997
|
# @return [Array<Types::AttachmentStateChange>]
|
9822
9998
|
#
|
9823
9999
|
# @!attribute [rw] managed_agents
|
9824
|
-
# The details for the managed agent associated with the task.
|
10000
|
+
# The details for the managed agent that's associated with the task.
|
9825
10001
|
# @return [Array<Types::ManagedAgentStateChange>]
|
9826
10002
|
#
|
9827
10003
|
# @!attribute [rw] pull_started_at
|
9828
|
-
# The Unix timestamp for when the container image pull
|
10004
|
+
# The Unix timestamp for the time when the container image pull
|
10005
|
+
# started.
|
9829
10006
|
# @return [Time]
|
9830
10007
|
#
|
9831
10008
|
# @!attribute [rw] pull_stopped_at
|
9832
|
-
# The Unix timestamp for when the container image pull
|
10009
|
+
# The Unix timestamp for the time when the container image pull
|
10010
|
+
# completed.
|
9833
10011
|
# @return [Time]
|
9834
10012
|
#
|
9835
10013
|
# @!attribute [rw] execution_stopped_at
|
9836
|
-
# The Unix timestamp for when the task execution stopped.
|
10014
|
+
# The Unix timestamp for the time when the task execution stopped.
|
9837
10015
|
# @return [Time]
|
9838
10016
|
#
|
9839
10017
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitTaskStateChangeRequest AWS API Documentation
|
@@ -9870,21 +10048,21 @@ module Aws::ECS
|
|
9870
10048
|
# the [Docker Remote API][2] and the `--sysctl` option to [docker
|
9871
10049
|
# run][3].
|
9872
10050
|
#
|
9873
|
-
#
|
9874
|
-
#
|
9875
|
-
#
|
9876
|
-
# following reasons
|
10051
|
+
# We don't recommend that you specify network-related `systemControls`
|
10052
|
+
# parameters for multiple containers in a single task. This task also
|
10053
|
+
# uses either the `awsvpc` or `host` network mode. It does it for the
|
10054
|
+
# following reasons.
|
9877
10055
|
#
|
9878
10056
|
# * For tasks that use the `awsvpc` network mode, if you set
|
9879
10057
|
# `systemControls` for any container, it applies to all containers in
|
9880
10058
|
# the task. If you set different `systemControls` for multiple
|
9881
|
-
# containers in a single task, the container that
|
10059
|
+
# containers in a single task, the container that's started last
|
9882
10060
|
# determines which `systemControls` take effect.
|
9883
10061
|
#
|
9884
10062
|
# * For tasks that use the `host` network mode, the `systemControls`
|
9885
|
-
# parameter applies to the container instance's kernel parameter
|
9886
|
-
#
|
9887
|
-
#
|
10063
|
+
# parameter applies to the container instance's kernel parameter and
|
10064
|
+
# that of all containers of any tasks running on that container
|
10065
|
+
# instance.
|
9888
10066
|
#
|
9889
10067
|
#
|
9890
10068
|
#
|
@@ -9901,11 +10079,11 @@ module Aws::ECS
|
|
9901
10079
|
# }
|
9902
10080
|
#
|
9903
10081
|
# @!attribute [rw] namespace
|
9904
|
-
# The namespaced kernel parameter
|
10082
|
+
# The namespaced kernel parameter to set a `value` for.
|
9905
10083
|
# @return [String]
|
9906
10084
|
#
|
9907
10085
|
# @!attribute [rw] value
|
9908
|
-
# The value for the namespaced kernel parameter specified in
|
10086
|
+
# The value for the namespaced kernel parameter that's specified in
|
9909
10087
|
# `namespace`.
|
9910
10088
|
# @return [String]
|
9911
10089
|
#
|
@@ -9919,8 +10097,8 @@ module Aws::ECS
|
|
9919
10097
|
end
|
9920
10098
|
|
9921
10099
|
# The metadata that you apply to a resource to help you categorize and
|
9922
|
-
# organize them. Each tag consists of a key and an optional value
|
9923
|
-
#
|
10100
|
+
# organize them. Each tag consists of a key and an optional value. You
|
10101
|
+
# define them.
|
9924
10102
|
#
|
9925
10103
|
# The following basic restrictions apply to tags:
|
9926
10104
|
#
|
@@ -9989,7 +10167,7 @@ module Aws::ECS
|
|
9989
10167
|
# }
|
9990
10168
|
#
|
9991
10169
|
# @!attribute [rw] resource_arn
|
9992
|
-
# The Amazon Resource Name (ARN) of the resource to
|
10170
|
+
# The Amazon Resource Name (ARN) of the resource to add tags to.
|
9993
10171
|
# Currently, the supported resources are Amazon ECS capacity
|
9994
10172
|
# providers, tasks, services, task definitions, clusters, and
|
9995
10173
|
# container instances.
|
@@ -10038,14 +10216,14 @@ module Aws::ECS
|
|
10038
10216
|
#
|
10039
10217
|
class TagResourceResponse < Aws::EmptyStructure; end
|
10040
10218
|
|
10041
|
-
# The target container
|
10219
|
+
# The target container isn't properly configured with the execute
|
10042
10220
|
# command agent or the container is no longer active or running.
|
10043
10221
|
#
|
10044
10222
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TargetNotConnectedException AWS API Documentation
|
10045
10223
|
#
|
10046
10224
|
class TargetNotConnectedException < Aws::EmptyStructure; end
|
10047
10225
|
|
10048
|
-
# The specified target
|
10226
|
+
# The specified target wasn't found. You can view your available
|
10049
10227
|
# container instances with ListContainerInstances. Amazon ECS container
|
10050
10228
|
# instances are cluster-specific and Region-specific.
|
10051
10229
|
#
|
@@ -10056,8 +10234,8 @@ module Aws::ECS
|
|
10056
10234
|
# Details on a task in a cluster.
|
10057
10235
|
#
|
10058
10236
|
# @!attribute [rw] attachments
|
10059
|
-
# The Elastic Network Adapter associated with the task if the
|
10060
|
-
# uses the `awsvpc` network mode.
|
10237
|
+
# The Elastic Network Adapter that's associated with the task if the
|
10238
|
+
# task uses the `awsvpc` network mode.
|
10061
10239
|
# @return [Array<Types::Attachment>]
|
10062
10240
|
#
|
10063
10241
|
# @!attribute [rw] attributes
|
@@ -10065,11 +10243,11 @@ module Aws::ECS
|
|
10065
10243
|
# @return [Array<Types::Attribute>]
|
10066
10244
|
#
|
10067
10245
|
# @!attribute [rw] availability_zone
|
10068
|
-
# The
|
10246
|
+
# The Availability Zone for the task.
|
10069
10247
|
# @return [String]
|
10070
10248
|
#
|
10071
10249
|
# @!attribute [rw] capacity_provider_name
|
10072
|
-
# The capacity provider associated with the task.
|
10250
|
+
# The capacity provider that's associated with the task.
|
10073
10251
|
# @return [String]
|
10074
10252
|
#
|
10075
10253
|
# @!attribute [rw] cluster_arn
|
@@ -10081,8 +10259,8 @@ module Aws::ECS
|
|
10081
10259
|
# @return [String]
|
10082
10260
|
#
|
10083
10261
|
# @!attribute [rw] connectivity_at
|
10084
|
-
# The Unix timestamp for when the task last went into
|
10085
|
-
# status.
|
10262
|
+
# The Unix timestamp for the time when the task last went into
|
10263
|
+
# `CONNECTED` status.
|
10086
10264
|
# @return [Time]
|
10087
10265
|
#
|
10088
10266
|
# @!attribute [rw] container_instance_arn
|
@@ -10090,24 +10268,27 @@ module Aws::ECS
|
|
10090
10268
|
# @return [String]
|
10091
10269
|
#
|
10092
10270
|
# @!attribute [rw] containers
|
10093
|
-
# The containers associated with the task.
|
10271
|
+
# The containers that's associated with the task.
|
10094
10272
|
# @return [Array<Types::Container>]
|
10095
10273
|
#
|
10096
10274
|
# @!attribute [rw] cpu
|
10097
10275
|
# The number of CPU units used by the task as expressed in a task
|
10098
|
-
# definition. It can be expressed as an integer using CPU units
|
10099
|
-
# example `1024
|
10100
|
-
# for example `1 vCPU` or `1 vcpu
|
10101
|
-
# integer
|
10276
|
+
# definition. It can be expressed as an integer using CPU units (for
|
10277
|
+
# example, `1024`). It can also be expressed as a string using vCPUs
|
10278
|
+
# (for example, `1 vCPU` or `1 vcpu`). String values are converted to
|
10279
|
+
# an integer that indicates the CPU units when the task definition is
|
10102
10280
|
# registered.
|
10103
10281
|
#
|
10104
|
-
# If you
|
10105
|
-
#
|
10106
|
-
#
|
10282
|
+
# If you use the EC2 launch type, this field is optional. Supported
|
10283
|
+
# values are between `128` CPU units (`0.125` vCPUs) and `10240` CPU
|
10284
|
+
# units (`10` vCPUs).
|
10107
10285
|
#
|
10108
|
-
# If you
|
10109
|
-
#
|
10110
|
-
#
|
10286
|
+
# If you use the Fargate launch type, this field is required. You must
|
10287
|
+
# use one of the following values. These values determine the range of
|
10288
|
+
# supported values for the `memory` parameter:
|
10289
|
+
#
|
10290
|
+
# The CPU units cannot be less than 1 vCPU when you use Windows
|
10291
|
+
# containers on Fargate.
|
10111
10292
|
#
|
10112
10293
|
# * 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1
|
10113
10294
|
# GB), 2048 (2 GB)
|
@@ -10127,8 +10308,9 @@ module Aws::ECS
|
|
10127
10308
|
# @return [String]
|
10128
10309
|
#
|
10129
10310
|
# @!attribute [rw] created_at
|
10130
|
-
# The Unix timestamp for when the task was created
|
10131
|
-
# the `PENDING`
|
10311
|
+
# The Unix timestamp for the time when the task was created. More
|
10312
|
+
# specifically, it's for the time when the task entered the `PENDING`
|
10313
|
+
# state.
|
10132
10314
|
# @return [Time]
|
10133
10315
|
#
|
10134
10316
|
# @!attribute [rw] desired_status
|
@@ -10141,43 +10323,44 @@ module Aws::ECS
|
|
10141
10323
|
# @return [String]
|
10142
10324
|
#
|
10143
10325
|
# @!attribute [rw] enable_execute_command
|
10144
|
-
#
|
10145
|
-
# task. If `true`,
|
10326
|
+
# Determines whether execute command functionality is enabled for this
|
10327
|
+
# task. If `true`, execute command functionality is enabled on all the
|
10146
10328
|
# containers in the task.
|
10147
10329
|
# @return [Boolean]
|
10148
10330
|
#
|
10149
10331
|
# @!attribute [rw] execution_stopped_at
|
10150
|
-
# The Unix timestamp for when the task execution stopped.
|
10332
|
+
# The Unix timestamp for the time when the task execution stopped.
|
10151
10333
|
# @return [Time]
|
10152
10334
|
#
|
10153
10335
|
# @!attribute [rw] group
|
10154
|
-
# The name of the task group associated with the task.
|
10336
|
+
# The name of the task group that's associated with the task.
|
10155
10337
|
# @return [String]
|
10156
10338
|
#
|
10157
10339
|
# @!attribute [rw] health_status
|
10158
|
-
# The health status for the task
|
10340
|
+
# The health status for the task. It's determined by the health of
|
10159
10341
|
# the essential containers in the task. If all essential containers in
|
10160
|
-
# the task are reporting as `HEALTHY`,
|
10161
|
-
#
|
10162
|
-
#
|
10163
|
-
#
|
10164
|
-
#
|
10165
|
-
# <note markdown="1"> The Amazon ECS container agent
|
10166
|
-
# health checks that are embedded in a container image
|
10167
|
-
# specified in
|
10168
|
-
# specified in
|
10169
|
-
# are specified in a container definition
|
10170
|
-
# checks that
|
10342
|
+
# the task are reporting as `HEALTHY`, the task status also reports as
|
10343
|
+
# `HEALTHY`. If any essential containers in the task are reporting as
|
10344
|
+
# `UNHEALTHY` or `UNKNOWN`, the task status also reports as
|
10345
|
+
# `UNHEALTHY` or `UNKNOWN`.
|
10346
|
+
#
|
10347
|
+
# <note markdown="1"> The Amazon ECS container agent doesn't monitor or report on Docker
|
10348
|
+
# health checks that are embedded in a container image and not
|
10349
|
+
# specified in the container definition. For example, this includes
|
10350
|
+
# those specified in a parent image or from the image's Dockerfile.
|
10351
|
+
# Health check parameters that are specified in a container definition
|
10352
|
+
# override any Docker health checks that are found in the container
|
10353
|
+
# image.
|
10171
10354
|
#
|
10172
10355
|
# </note>
|
10173
10356
|
# @return [String]
|
10174
10357
|
#
|
10175
10358
|
# @!attribute [rw] inference_accelerators
|
10176
|
-
# The Elastic Inference accelerator associated with the task.
|
10359
|
+
# The Elastic Inference accelerator that's associated with the task.
|
10177
10360
|
# @return [Array<Types::InferenceAccelerator>]
|
10178
10361
|
#
|
10179
10362
|
# @!attribute [rw] last_status
|
10180
|
-
# The last known status
|
10363
|
+
# The last known status for the task. For more information, see [Task
|
10181
10364
|
# Lifecycle][1].
|
10182
10365
|
#
|
10183
10366
|
#
|
@@ -10186,9 +10369,9 @@ module Aws::ECS
|
|
10186
10369
|
# @return [String]
|
10187
10370
|
#
|
10188
10371
|
# @!attribute [rw] launch_type
|
10189
|
-
# The infrastructure
|
10190
|
-
#
|
10191
|
-
#
|
10372
|
+
# The infrastructure where your task runs on. For more information,
|
10373
|
+
# see [Amazon ECS launch types][1] in the *Amazon Elastic Container
|
10374
|
+
# Service Developer Guide*.
|
10192
10375
|
#
|
10193
10376
|
#
|
10194
10377
|
#
|
@@ -10196,17 +10379,17 @@ module Aws::ECS
|
|
10196
10379
|
# @return [String]
|
10197
10380
|
#
|
10198
10381
|
# @!attribute [rw] memory
|
10199
|
-
# The amount of memory (in MiB)
|
10200
|
-
# task definition. It can be expressed as an integer using MiB
|
10201
|
-
# example `1024
|
10202
|
-
# example `1GB` or `1 GB
|
10203
|
-
#
|
10382
|
+
# The amount of memory (in MiB) that the task uses as expressed in a
|
10383
|
+
# task definition. It can be expressed as an integer using MiB (for
|
10384
|
+
# example, `1024`). If it's expressed as a string using GB (for
|
10385
|
+
# example, `1GB` or `1 GB`), it's converted to an integer indicating
|
10386
|
+
# the MiB when the task definition is registered.
|
10204
10387
|
#
|
10205
|
-
# If you
|
10388
|
+
# If you use the EC2 launch type, this field is optional.
|
10206
10389
|
#
|
10207
|
-
# If you
|
10208
|
-
#
|
10209
|
-
# range of supported values for the `cpu` parameter
|
10390
|
+
# If you use the Fargate launch type, this field is required. You must
|
10391
|
+
# use one of the following values. The value that you choose
|
10392
|
+
# determines the range of supported values for the `cpu` parameter.
|
10210
10393
|
#
|
10211
10394
|
# * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values:
|
10212
10395
|
# 256 (.25 vCPU)
|
@@ -10229,44 +10412,55 @@ module Aws::ECS
|
|
10229
10412
|
# @return [Types::TaskOverride]
|
10230
10413
|
#
|
10231
10414
|
# @!attribute [rw] platform_version
|
10232
|
-
# The platform version
|
10233
|
-
#
|
10234
|
-
#
|
10235
|
-
#
|
10236
|
-
#
|
10415
|
+
# The platform version where your task runs on. A platform version is
|
10416
|
+
# only specified for tasks that use the Fargate launch type. If you
|
10417
|
+
# didn't specify one, the `LATEST` platform version is used. For more
|
10418
|
+
# information, see [Fargate Platform Versions][1] in the *Amazon
|
10419
|
+
# Elastic Container Service Developer Guide*.
|
10237
10420
|
#
|
10238
10421
|
#
|
10239
10422
|
#
|
10240
10423
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
10241
10424
|
# @return [String]
|
10242
10425
|
#
|
10426
|
+
# @!attribute [rw] platform_family
|
10427
|
+
# The operating system that your tasks are running on. A platform
|
10428
|
+
# family is specified only for tasks that use the Fargate launch type.
|
10429
|
+
#
|
10430
|
+
# All tasks that run as part of this service must use the same
|
10431
|
+
# `platformFamily` value as the service (for example, `LINUX.`).
|
10432
|
+
# @return [String]
|
10433
|
+
#
|
10243
10434
|
# @!attribute [rw] pull_started_at
|
10244
|
-
# The Unix timestamp for when the container image pull began.
|
10435
|
+
# The Unix timestamp for the time when the container image pull began.
|
10245
10436
|
# @return [Time]
|
10246
10437
|
#
|
10247
10438
|
# @!attribute [rw] pull_stopped_at
|
10248
|
-
# The Unix timestamp for when the container image pull
|
10439
|
+
# The Unix timestamp for the time when the container image pull
|
10440
|
+
# completed.
|
10249
10441
|
# @return [Time]
|
10250
10442
|
#
|
10251
10443
|
# @!attribute [rw] started_at
|
10252
|
-
# The Unix timestamp for when the task started
|
10253
|
-
#
|
10444
|
+
# The Unix timestamp for the time when the task started. More
|
10445
|
+
# specifically, it's for the time when the task transitioned from the
|
10446
|
+
# `PENDING` state to the `RUNNING` state.
|
10254
10447
|
# @return [Time]
|
10255
10448
|
#
|
10256
10449
|
# @!attribute [rw] started_by
|
10257
|
-
# The tag specified when a task is started. If
|
10258
|
-
#
|
10259
|
-
#
|
10450
|
+
# The tag specified when a task is started. If an Amazon ECS service
|
10451
|
+
# started the task, the `startedBy` parameter contains the deployment
|
10452
|
+
# ID of that service.
|
10260
10453
|
# @return [String]
|
10261
10454
|
#
|
10262
10455
|
# @!attribute [rw] stop_code
|
10263
10456
|
# The stop code indicating why a task was stopped. The `stoppedReason`
|
10264
|
-
#
|
10457
|
+
# might contain additional details.
|
10265
10458
|
# @return [String]
|
10266
10459
|
#
|
10267
10460
|
# @!attribute [rw] stopped_at
|
10268
|
-
# The Unix timestamp for when the task was stopped
|
10269
|
-
#
|
10461
|
+
# The Unix timestamp for the time when the task was stopped. More
|
10462
|
+
# specifically, it's for the time when the task transitioned from the
|
10463
|
+
# `RUNNING` state to the `STOPPED` state.
|
10270
10464
|
# @return [Time]
|
10271
10465
|
#
|
10272
10466
|
# @!attribute [rw] stopped_reason
|
@@ -10274,14 +10468,15 @@ module Aws::ECS
|
|
10274
10468
|
# @return [String]
|
10275
10469
|
#
|
10276
10470
|
# @!attribute [rw] stopping_at
|
10277
|
-
# The Unix timestamp for when the task stops
|
10278
|
-
#
|
10471
|
+
# The Unix timestamp for the time when the task stops. More
|
10472
|
+
# specifically, it's for the time when the task transitions from the
|
10473
|
+
# `RUNNING` state to `STOPPED`.
|
10279
10474
|
# @return [Time]
|
10280
10475
|
#
|
10281
10476
|
# @!attribute [rw] tags
|
10282
10477
|
# The metadata that you apply to the task to help you categorize and
|
10283
|
-
# organize
|
10284
|
-
# both
|
10478
|
+
# organize the task. Each tag consists of a key and an optional value.
|
10479
|
+
# You define both the key and value.
|
10285
10480
|
#
|
10286
10481
|
# The following basic restrictions apply to tags:
|
10287
10482
|
#
|
@@ -10319,8 +10514,8 @@ module Aws::ECS
|
|
10319
10514
|
#
|
10320
10515
|
# @!attribute [rw] version
|
10321
10516
|
# The version counter for the task. Every time a task experiences a
|
10322
|
-
# change that
|
10323
|
-
# incremented. If you
|
10517
|
+
# change that starts a CloudWatch event, the version counter is
|
10518
|
+
# incremented. If you replicate your Amazon ECS task state with
|
10324
10519
|
# CloudWatch Events, you can compare the version of a task reported by
|
10325
10520
|
# the Amazon ECS API actions with the version reported in CloudWatch
|
10326
10521
|
# Events for the task (inside the `detail` object) to verify that the
|
@@ -10356,6 +10551,7 @@ module Aws::ECS
|
|
10356
10551
|
:memory,
|
10357
10552
|
:overrides,
|
10358
10553
|
:platform_version,
|
10554
|
+
:platform_family,
|
10359
10555
|
:pull_started_at,
|
10360
10556
|
:pull_stopped_at,
|
10361
10557
|
:started_at,
|
@@ -10397,8 +10593,8 @@ module Aws::ECS
|
|
10397
10593
|
#
|
10398
10594
|
# @!attribute [rw] family
|
10399
10595
|
# The name of a family that this task definition is registered to. Up
|
10400
|
-
# to 255
|
10401
|
-
# underscores are allowed.
|
10596
|
+
# to 255 characters are allowed. Letters (both uppercase and lowercase
|
10597
|
+
# letters), numbers, hyphens (-), and underscores (\_) are allowed.
|
10402
10598
|
#
|
10403
10599
|
# A family groups multiple versions of a task definition. Amazon ECS
|
10404
10600
|
# gives the first task definition that you registered to a family a
|
@@ -10415,10 +10611,9 @@ module Aws::ECS
|
|
10415
10611
|
#
|
10416
10612
|
# IAM roles for tasks on Windows require that the `-EnableTaskIAMRole`
|
10417
10613
|
# option is set when you launch the Amazon ECS-optimized Windows AMI.
|
10418
|
-
# Your containers must also run some configuration code
|
10419
|
-
#
|
10420
|
-
#
|
10421
|
-
# Developer Guide*.
|
10614
|
+
# Your containers must also run some configuration code to use the
|
10615
|
+
# feature. For more information, see [Windows IAM roles for tasks][2]
|
10616
|
+
# in the *Amazon Elastic Container Service Developer Guide*.
|
10422
10617
|
#
|
10423
10618
|
#
|
10424
10619
|
#
|
@@ -10489,8 +10684,8 @@ module Aws::ECS
|
|
10489
10684
|
# version number of a task definition in a family. When you register a
|
10490
10685
|
# task definition for the first time, the revision is `1`. Each time
|
10491
10686
|
# that you register a new revision of a task definition in the same
|
10492
|
-
# family, the revision value always increases by one
|
10493
|
-
# deregistered previous revisions in this family.
|
10687
|
+
# family, the revision value always increases by one. This is even if
|
10688
|
+
# you deregistered previous revisions in this family.
|
10494
10689
|
# @return [Integer]
|
10495
10690
|
#
|
10496
10691
|
# @!attribute [rw] volumes
|
@@ -10498,7 +10693,7 @@ module Aws::ECS
|
|
10498
10693
|
# information, see [Using data volumes in tasks][1] in the *Amazon
|
10499
10694
|
# Elastic Container Service Developer Guide*.
|
10500
10695
|
#
|
10501
|
-
# <note markdown="1"> The `host` and `sourcePath` parameters
|
10696
|
+
# <note markdown="1"> The `host` and `sourcePath` parameters aren't supported for tasks
|
10502
10697
|
# run on Fargate.
|
10503
10698
|
#
|
10504
10699
|
# </note>
|
@@ -10516,13 +10711,13 @@ module Aws::ECS
|
|
10516
10711
|
# The container instance attributes required by your task. When an
|
10517
10712
|
# Amazon EC2 instance is registered to your cluster, the Amazon ECS
|
10518
10713
|
# container agent assigns some standard attributes to the instance.
|
10519
|
-
# You can apply custom attributes
|
10520
|
-
# the Amazon ECS console or the PutAttributes API. These
|
10521
|
-
# are used when
|
10522
|
-
# EC2 instances. For more information, see [Attributes][1]
|
10523
|
-
# *Amazon Elastic Container Service Developer Guide*.
|
10714
|
+
# You can apply custom attributes. These are specified as key-value
|
10715
|
+
# pairs using the Amazon ECS console or the PutAttributes API. These
|
10716
|
+
# attributes are used when determining task placement for tasks hosted
|
10717
|
+
# on Amazon EC2 instances. For more information, see [Attributes][1]
|
10718
|
+
# in the *Amazon Elastic Container Service Developer Guide*.
|
10524
10719
|
#
|
10525
|
-
# <note markdown="1"> This parameter
|
10720
|
+
# <note markdown="1"> This parameter isn't supported for tasks run on Fargate.
|
10526
10721
|
#
|
10527
10722
|
# </note>
|
10528
10723
|
#
|
@@ -10534,7 +10729,7 @@ module Aws::ECS
|
|
10534
10729
|
# @!attribute [rw] placement_constraints
|
10535
10730
|
# An array of placement constraint objects to use for tasks.
|
10536
10731
|
#
|
10537
|
-
# <note markdown="1"> This parameter
|
10732
|
+
# <note markdown="1"> This parameter isn't supported for tasks run on Fargate.
|
10538
10733
|
#
|
10539
10734
|
# </note>
|
10540
10735
|
# @return [Array<Types::TaskDefinitionPlacementConstraint>]
|
@@ -10550,6 +10745,15 @@ module Aws::ECS
|
|
10550
10745
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html
|
10551
10746
|
# @return [Array<String>]
|
10552
10747
|
#
|
10748
|
+
# @!attribute [rw] runtime_platform
|
10749
|
+
# The operating system that your task definitions are running on. A
|
10750
|
+
# platform family is specified only for tasks using the Fargate launch
|
10751
|
+
# type.
|
10752
|
+
#
|
10753
|
+
# When you specify a task in a service, this value must match the
|
10754
|
+
# `runtimePlatform` value of the service.
|
10755
|
+
# @return [Types::RuntimePlatform]
|
10756
|
+
#
|
10553
10757
|
# @!attribute [rw] requires_compatibilities
|
10554
10758
|
# The task launch types the task definition was validated against. To
|
10555
10759
|
# determine which task launch types the task definition is validated
|
@@ -10557,11 +10761,14 @@ module Aws::ECS
|
|
10557
10761
|
# @return [Array<String>]
|
10558
10762
|
#
|
10559
10763
|
# @!attribute [rw] cpu
|
10560
|
-
# The number of `cpu` units used by the task. If you
|
10561
|
-
# launch type, this field is optional
|
10562
|
-
#
|
10563
|
-
#
|
10564
|
-
# range of valid values for the `memory` parameter
|
10764
|
+
# The number of `cpu` units used by the task. If you use the EC2
|
10765
|
+
# launch type, this field is optional. Any value can be used. If you
|
10766
|
+
# use the Fargate launch type, this field is required. You must use
|
10767
|
+
# one of the following values. The value that you choose determines
|
10768
|
+
# your range of valid values for the `memory` parameter.
|
10769
|
+
#
|
10770
|
+
# The CPU units cannot be less than 1 vCPU when you use Windows
|
10771
|
+
# containers on Fargate.
|
10565
10772
|
#
|
10566
10773
|
# * 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1
|
10567
10774
|
# GB), 2048 (2 GB)
|
@@ -10583,16 +10790,16 @@ module Aws::ECS
|
|
10583
10790
|
# @!attribute [rw] memory
|
10584
10791
|
# The amount (in MiB) of memory used by the task.
|
10585
10792
|
#
|
10586
|
-
# If your tasks
|
10587
|
-
#
|
10588
|
-
#
|
10589
|
-
#
|
10590
|
-
#
|
10591
|
-
#
|
10793
|
+
# If your tasks runs on Amazon EC2 instances, you must specify either
|
10794
|
+
# a task-level memory value or a container-level memory value. This
|
10795
|
+
# field is optional and any value can be used. If a task-level memory
|
10796
|
+
# value is specified, the container-level memory value is optional.
|
10797
|
+
# For more information regarding container-level memory and memory
|
10798
|
+
# reservation, see [ContainerDefinition][1].
|
10592
10799
|
#
|
10593
|
-
# If your tasks
|
10594
|
-
#
|
10595
|
-
# valid values for the `cpu` parameter
|
10800
|
+
# If your tasks runs on Fargate, this field is required. You must use
|
10801
|
+
# one of the following values. The value you choose determines your
|
10802
|
+
# range of valid values for the `cpu` parameter.
|
10596
10803
|
#
|
10597
10804
|
# * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values:
|
10598
10805
|
# 256 (.25 vCPU)
|
@@ -10615,7 +10822,7 @@ module Aws::ECS
|
|
10615
10822
|
# @return [String]
|
10616
10823
|
#
|
10617
10824
|
# @!attribute [rw] inference_accelerators
|
10618
|
-
# The Elastic Inference accelerator associated with the task.
|
10825
|
+
# The Elastic Inference accelerator that's associated with the task.
|
10619
10826
|
# @return [Array<Types::InferenceAccelerator>]
|
10620
10827
|
#
|
10621
10828
|
# @!attribute [rw] pid_mode
|
@@ -10691,9 +10898,9 @@ module Aws::ECS
|
|
10691
10898
|
# Your Amazon ECS container instances require at least version 1.26.0
|
10692
10899
|
# of the container agent and at least version 1.26.0-1 of the
|
10693
10900
|
# `ecs-init` package to enable a proxy configuration. If your
|
10694
|
-
# container instances are launched from the Amazon ECS
|
10695
|
-
# version `20190301` or later,
|
10696
|
-
#
|
10901
|
+
# container instances are launched from the Amazon ECS optimized AMI
|
10902
|
+
# version `20190301` or later, they contain the required versions of
|
10903
|
+
# the container agent and `ecs-init`. For more information, see
|
10697
10904
|
# [Amazon ECS-optimized Linux AMI][1] in the *Amazon Elastic Container
|
10698
10905
|
# Service Developer Guide*.
|
10699
10906
|
#
|
@@ -10703,11 +10910,13 @@ module Aws::ECS
|
|
10703
10910
|
# @return [Types::ProxyConfiguration]
|
10704
10911
|
#
|
10705
10912
|
# @!attribute [rw] registered_at
|
10706
|
-
# The Unix timestamp for when the task definition was
|
10913
|
+
# The Unix timestamp for the time when the task definition was
|
10914
|
+
# registered.
|
10707
10915
|
# @return [Time]
|
10708
10916
|
#
|
10709
10917
|
# @!attribute [rw] deregistered_at
|
10710
|
-
# The Unix timestamp for when the task definition was
|
10918
|
+
# The Unix timestamp for the time when the task definition was
|
10919
|
+
# deregistered.
|
10711
10920
|
# @return [Time]
|
10712
10921
|
#
|
10713
10922
|
# @!attribute [rw] registered_by
|
@@ -10734,6 +10943,7 @@ module Aws::ECS
|
|
10734
10943
|
:requires_attributes,
|
10735
10944
|
:placement_constraints,
|
10736
10945
|
:compatibilities,
|
10946
|
+
:runtime_platform,
|
10737
10947
|
:requires_compatibilities,
|
10738
10948
|
:cpu,
|
10739
10949
|
:memory,
|
@@ -10753,7 +10963,7 @@ module Aws::ECS
|
|
10753
10963
|
# definition. For more information, see [Task placement constraints][1]
|
10754
10964
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
10755
10965
|
#
|
10756
|
-
# <note markdown="1"> Task placement constraints
|
10966
|
+
# <note markdown="1"> Task placement constraints aren't supported for tasks run on Fargate.
|
10757
10967
|
#
|
10758
10968
|
# </note>
|
10759
10969
|
#
|
@@ -10793,7 +11003,7 @@ module Aws::ECS
|
|
10793
11003
|
include Aws::Structure
|
10794
11004
|
end
|
10795
11005
|
|
10796
|
-
# The overrides associated with a task.
|
11006
|
+
# The overrides that are associated with a task.
|
10797
11007
|
#
|
10798
11008
|
# @note When making an API call, you may pass TaskOverride
|
10799
11009
|
# data as a hash:
|
@@ -10842,7 +11052,7 @@ module Aws::ECS
|
|
10842
11052
|
# }
|
10843
11053
|
#
|
10844
11054
|
# @!attribute [rw] container_overrides
|
10845
|
-
# One or more container overrides sent to a task.
|
11055
|
+
# One or more container overrides that are sent to a task.
|
10846
11056
|
# @return [Array<Types::ContainerOverride>]
|
10847
11057
|
#
|
10848
11058
|
# @!attribute [rw] cpu
|
@@ -10883,8 +11093,12 @@ module Aws::ECS
|
|
10883
11093
|
# @!attribute [rw] ephemeral_storage
|
10884
11094
|
# The ephemeral storage setting override for the task.
|
10885
11095
|
#
|
10886
|
-
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate
|
10887
|
-
#
|
11096
|
+
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate that
|
11097
|
+
# use the following platform versions:
|
11098
|
+
#
|
11099
|
+
# * Linux platform version `1.4.0` or later.
|
11100
|
+
#
|
11101
|
+
# * Windows platform version `1.0.0` or later.
|
10888
11102
|
#
|
10889
11103
|
# </note>
|
10890
11104
|
# @return [Types::EphemeralStorage]
|
@@ -10927,17 +11141,17 @@ module Aws::ECS
|
|
10927
11141
|
# @return [String]
|
10928
11142
|
#
|
10929
11143
|
# @!attribute [rw] started_by
|
10930
|
-
# The tag specified when a task set is started. If
|
10931
|
-
# created
|
10932
|
-
# `CODE_DEPLOY`.
|
10933
|
-
#
|
11144
|
+
# The tag specified when a task set is started. If an CodeDeploy
|
11145
|
+
# deployment created the task set, the `startedBy` parameter is
|
11146
|
+
# `CODE_DEPLOY`. If an external deployment created the task set, the
|
11147
|
+
# startedBy field isn't used.
|
10934
11148
|
# @return [String]
|
10935
11149
|
#
|
10936
11150
|
# @!attribute [rw] external_id
|
10937
11151
|
# The external ID associated with the task set.
|
10938
11152
|
#
|
10939
|
-
# If
|
10940
|
-
#
|
11153
|
+
# If an CodeDeploy deployment created a task set, the `externalId`
|
11154
|
+
# parameter contains the CodeDeploy deployment ID.
|
10941
11155
|
#
|
10942
11156
|
# If a task set is created for an external deployment and is
|
10943
11157
|
# associated with a service discovery registry, the `externalId`
|
@@ -10946,7 +11160,7 @@ module Aws::ECS
|
|
10946
11160
|
# @return [String]
|
10947
11161
|
#
|
10948
11162
|
# @!attribute [rw] status
|
10949
|
-
# The status of the task set. The following describes each state
|
11163
|
+
# The status of the task set. The following describes each state.
|
10950
11164
|
#
|
10951
11165
|
# PRIMARY
|
10952
11166
|
#
|
@@ -10954,17 +11168,17 @@ module Aws::ECS
|
|
10954
11168
|
#
|
10955
11169
|
# ACTIVE
|
10956
11170
|
#
|
10957
|
-
# : The task set
|
11171
|
+
# : The task set isn't serving production traffic.
|
10958
11172
|
#
|
10959
11173
|
# DRAINING
|
10960
11174
|
#
|
10961
|
-
# : The tasks in the task set are being stopped and their
|
11175
|
+
# : The tasks in the task set are being stopped, and their
|
10962
11176
|
# corresponding targets are being deregistered from their target
|
10963
11177
|
# group.
|
10964
11178
|
# @return [String]
|
10965
11179
|
#
|
10966
11180
|
# @!attribute [rw] task_definition
|
10967
|
-
# The task definition the task set is using.
|
11181
|
+
# The task definition that the task set is using.
|
10968
11182
|
# @return [String]
|
10969
11183
|
#
|
10970
11184
|
# @!attribute [rw] computed_desired_count
|
@@ -10978,7 +11192,7 @@ module Aws::ECS
|
|
10978
11192
|
# The number of tasks in the task set that are in the `PENDING` status
|
10979
11193
|
# during a deployment. A task in the `PENDING` state is preparing to
|
10980
11194
|
# enter the `RUNNING` state. A task set enters the `PENDING` status
|
10981
|
-
# when it launches for the first time or when it
|
11195
|
+
# when it launches for the first time or when it's restarted after
|
10982
11196
|
# being in the `STOPPED` state.
|
10983
11197
|
# @return [Integer]
|
10984
11198
|
#
|
@@ -10989,11 +11203,11 @@ module Aws::ECS
|
|
10989
11203
|
# @return [Integer]
|
10990
11204
|
#
|
10991
11205
|
# @!attribute [rw] created_at
|
10992
|
-
# The Unix timestamp for when the task set was created.
|
11206
|
+
# The Unix timestamp for the time when the task set was created.
|
10993
11207
|
# @return [Time]
|
10994
11208
|
#
|
10995
11209
|
# @!attribute [rw] updated_at
|
10996
|
-
# The Unix timestamp for when the task set was last updated.
|
11210
|
+
# The Unix timestamp for the time when the task set was last updated.
|
10997
11211
|
# @return [Time]
|
10998
11212
|
#
|
10999
11213
|
# @!attribute [rw] launch_type
|
@@ -11007,11 +11221,12 @@ module Aws::ECS
|
|
11007
11221
|
# @return [String]
|
11008
11222
|
#
|
11009
11223
|
# @!attribute [rw] capacity_provider_strategy
|
11010
|
-
# The capacity provider strategy associated with the task
|
11224
|
+
# The capacity provider strategy that are associated with the task
|
11225
|
+
# set.
|
11011
11226
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
11012
11227
|
#
|
11013
11228
|
# @!attribute [rw] platform_version
|
11014
|
-
# The Fargate platform version
|
11229
|
+
# The Fargate platform version where the tasks in the task set are
|
11015
11230
|
# running. A platform version is only specified for tasks run on
|
11016
11231
|
# Fargate. For more information, see [Fargate platform versions][1] in
|
11017
11232
|
# the *Amazon Elastic Container Service Developer Guide*.
|
@@ -11021,16 +11236,24 @@ module Aws::ECS
|
|
11021
11236
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
11022
11237
|
# @return [String]
|
11023
11238
|
#
|
11239
|
+
# @!attribute [rw] platform_family
|
11240
|
+
# The operating system that your tasks in the set are running on. A
|
11241
|
+
# platform family is specified only for tasks that use the Fargate
|
11242
|
+
# launch type.
|
11243
|
+
#
|
11244
|
+
# All tasks in the set must have the same value.
|
11245
|
+
# @return [String]
|
11246
|
+
#
|
11024
11247
|
# @!attribute [rw] network_configuration
|
11025
11248
|
# The network configuration for the task set.
|
11026
11249
|
# @return [Types::NetworkConfiguration]
|
11027
11250
|
#
|
11028
11251
|
# @!attribute [rw] load_balancers
|
11029
|
-
# Details on a load balancer that
|
11252
|
+
# Details on a load balancer that are used with a task set.
|
11030
11253
|
# @return [Array<Types::LoadBalancer>]
|
11031
11254
|
#
|
11032
11255
|
# @!attribute [rw] service_registries
|
11033
|
-
# The details
|
11256
|
+
# The details for the service discovery registries to assign to this
|
11034
11257
|
# task set. For more information, see [Service discovery][1].
|
11035
11258
|
#
|
11036
11259
|
#
|
@@ -11039,38 +11262,38 @@ module Aws::ECS
|
|
11039
11262
|
# @return [Array<Types::ServiceRegistry>]
|
11040
11263
|
#
|
11041
11264
|
# @!attribute [rw] scale
|
11042
|
-
# A floating-point percentage of
|
11265
|
+
# A floating-point percentage of your desired number of tasks to place
|
11043
11266
|
# and keep running in the task set.
|
11044
11267
|
# @return [Types::Scale]
|
11045
11268
|
#
|
11046
11269
|
# @!attribute [rw] stability_status
|
11047
|
-
# The stability status
|
11270
|
+
# The stability status. This indicates whether the task set has
|
11048
11271
|
# reached a steady state. If the following conditions are met, the
|
11049
|
-
# task set
|
11272
|
+
# task set sre in `STEADY_STATE`\:
|
11050
11273
|
#
|
11051
11274
|
# * The task `runningCount` is equal to the `computedDesiredCount`.
|
11052
11275
|
#
|
11053
11276
|
# * The `pendingCount` is `0`.
|
11054
11277
|
#
|
11055
|
-
# * There are no tasks running on container instances in the
|
11278
|
+
# * There are no tasks that are running on container instances in the
|
11056
11279
|
# `DRAINING` status.
|
11057
11280
|
#
|
11058
11281
|
# * All tasks are reporting a healthy status from the load balancers,
|
11059
11282
|
# service discovery, and container health checks.
|
11060
11283
|
#
|
11061
|
-
# If any of those conditions
|
11284
|
+
# If any of those conditions aren't met, the stability status returns
|
11062
11285
|
# `STABILIZING`.
|
11063
11286
|
# @return [String]
|
11064
11287
|
#
|
11065
11288
|
# @!attribute [rw] stability_status_at
|
11066
|
-
# The Unix timestamp for when the task set stability status
|
11067
|
-
# retrieved.
|
11289
|
+
# The Unix timestamp for the time when the task set stability status
|
11290
|
+
# was retrieved.
|
11068
11291
|
# @return [Time]
|
11069
11292
|
#
|
11070
11293
|
# @!attribute [rw] tags
|
11071
11294
|
# The metadata that you apply to the task set to help you categorize
|
11072
|
-
# and organize them. Each tag consists of a key and an optional value
|
11073
|
-
#
|
11295
|
+
# and organize them. Each tag consists of a key and an optional value.
|
11296
|
+
# You define both.
|
11074
11297
|
#
|
11075
11298
|
# The following basic restrictions apply to tags:
|
11076
11299
|
#
|
@@ -11117,6 +11340,7 @@ module Aws::ECS
|
|
11117
11340
|
:launch_type,
|
11118
11341
|
:capacity_provider_strategy,
|
11119
11342
|
:platform_version,
|
11343
|
+
:platform_family,
|
11120
11344
|
:network_configuration,
|
11121
11345
|
:load_balancers,
|
11122
11346
|
:service_registries,
|
@@ -11128,9 +11352,9 @@ module Aws::ECS
|
|
11128
11352
|
include Aws::Structure
|
11129
11353
|
end
|
11130
11354
|
|
11131
|
-
# The specified task set
|
11132
|
-
#
|
11133
|
-
#
|
11355
|
+
# The specified task set wasn't found. You can view your available task
|
11356
|
+
# sets with DescribeTaskSets. Task sets are specific to each cluster,
|
11357
|
+
# service and Region.
|
11134
11358
|
#
|
11135
11359
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TaskSetNotFoundException AWS API Documentation
|
11136
11360
|
#
|
@@ -11217,7 +11441,7 @@ module Aws::ECS
|
|
11217
11441
|
include Aws::Structure
|
11218
11442
|
end
|
11219
11443
|
|
11220
|
-
# The specified task
|
11444
|
+
# The specified task isn't supported in this Region.
|
11221
11445
|
#
|
11222
11446
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UnsupportedFeatureException AWS API Documentation
|
11223
11447
|
#
|
@@ -11232,8 +11456,8 @@ module Aws::ECS
|
|
11232
11456
|
# }
|
11233
11457
|
#
|
11234
11458
|
# @!attribute [rw] resource_arn
|
11235
|
-
# The Amazon Resource Name (ARN) of the resource
|
11236
|
-
#
|
11459
|
+
# The Amazon Resource Name (ARN) of the resource to delete tags from.
|
11460
|
+
# Currently, the supported resources are Amazon ECS capacity
|
11237
11461
|
# providers, tasks, services, task definitions, clusters, and
|
11238
11462
|
# container instances.
|
11239
11463
|
# @return [String]
|
@@ -11277,8 +11501,8 @@ module Aws::ECS
|
|
11277
11501
|
# @return [String]
|
11278
11502
|
#
|
11279
11503
|
# @!attribute [rw] auto_scaling_group_provider
|
11280
|
-
# An object
|
11281
|
-
# group capacity provider.
|
11504
|
+
# An object that represent the parameters to update for the Auto
|
11505
|
+
# Scaling group capacity provider.
|
11282
11506
|
# @return [Types::AutoScalingGroupProviderUpdate]
|
11283
11507
|
#
|
11284
11508
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateCapacityProviderRequest AWS API Documentation
|
@@ -11382,8 +11606,8 @@ module Aws::ECS
|
|
11382
11606
|
# @!attribute [rw] settings
|
11383
11607
|
# The setting to use by default for a cluster. This parameter is used
|
11384
11608
|
# to enable CloudWatch Container Insights for a cluster. If this value
|
11385
|
-
# is specified, it
|
11386
|
-
#
|
11609
|
+
# is specified, it overrides the `containerInsights` value set with
|
11610
|
+
# PutAccountSetting or PutAccountSettingDefault.
|
11387
11611
|
# @return [Array<Types::ClusterSetting>]
|
11388
11612
|
#
|
11389
11613
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateClusterSettingsRequest AWS API Documentation
|
@@ -11423,7 +11647,7 @@ module Aws::ECS
|
|
11423
11647
|
#
|
11424
11648
|
# @!attribute [rw] container_instance
|
11425
11649
|
# The container instance ID or full ARN entries for the container
|
11426
|
-
# instance
|
11650
|
+
# instance where you would like to update the Amazon ECS container
|
11427
11651
|
# agent.
|
11428
11652
|
# @return [String]
|
11429
11653
|
#
|
@@ -11437,7 +11661,7 @@ module Aws::ECS
|
|
11437
11661
|
end
|
11438
11662
|
|
11439
11663
|
# @!attribute [rw] container_instance
|
11440
|
-
# The container instance
|
11664
|
+
# The container instance that the container agent was updated for.
|
11441
11665
|
# @return [Types::ContainerInstance]
|
11442
11666
|
#
|
11443
11667
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerAgentResponse AWS API Documentation
|
@@ -11468,13 +11692,13 @@ module Aws::ECS
|
|
11468
11692
|
# @return [Array<String>]
|
11469
11693
|
#
|
11470
11694
|
# @!attribute [rw] status
|
11471
|
-
# The container instance state
|
11472
|
-
#
|
11473
|
-
#
|
11474
|
-
#
|
11475
|
-
#
|
11476
|
-
#
|
11477
|
-
#
|
11695
|
+
# The container instance state to update the container instance with.
|
11696
|
+
# The only valid values for this action are `ACTIVE` and `DRAINING`. A
|
11697
|
+
# container instance can only be updated to `DRAINING` status once it
|
11698
|
+
# has reached an `ACTIVE` state. If a container instance is in
|
11699
|
+
# `REGISTERING`, `DEREGISTERING`, or `REGISTRATION_FAILED` state you
|
11700
|
+
# can describe the container instance but can't update the container
|
11701
|
+
# instance state.
|
11478
11702
|
# @return [String]
|
11479
11703
|
#
|
11480
11704
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerInstancesStateRequest AWS API Documentation
|
@@ -11504,10 +11728,10 @@ module Aws::ECS
|
|
11504
11728
|
include Aws::Structure
|
11505
11729
|
end
|
11506
11730
|
|
11507
|
-
# There
|
11508
|
-
# progress on the
|
11509
|
-
# becomes disconnected while it
|
11510
|
-
# `PENDING` or `STAGING`, the update process can get stuck in that
|
11731
|
+
# There's already a current Amazon ECS container agent update in
|
11732
|
+
# progress on the container instance that's specified. If the container
|
11733
|
+
# agent becomes disconnected while it's in a transitional stage, such
|
11734
|
+
# as `PENDING` or `STAGING`, the update process can get stuck in that
|
11511
11735
|
# state. However, when the agent reconnects, it resumes where it stopped
|
11512
11736
|
# previously.
|
11513
11737
|
#
|
@@ -11611,8 +11835,8 @@ module Aws::ECS
|
|
11611
11835
|
#
|
11612
11836
|
# @!attribute [rw] cluster
|
11613
11837
|
# The short name or full Amazon Resource Name (ARN) of the cluster
|
11614
|
-
# that your service
|
11615
|
-
#
|
11838
|
+
# that your service runs on. If you do not specify a cluster, the
|
11839
|
+
# default cluster is assumed.
|
11616
11840
|
# @return [String]
|
11617
11841
|
#
|
11618
11842
|
# @!attribute [rw] service
|
@@ -11636,12 +11860,13 @@ module Aws::ECS
|
|
11636
11860
|
# @!attribute [rw] capacity_provider_strategy
|
11637
11861
|
# The capacity provider strategy to update the service to use.
|
11638
11862
|
#
|
11639
|
-
#
|
11640
|
-
#
|
11863
|
+
# if the service uses the default capacity provider strategy for the
|
11864
|
+
# cluster, the service can be updated to use one or more capacity
|
11641
11865
|
# providers as opposed to the default capacity provider strategy.
|
11642
|
-
# However, when a service is using a capacity provider strategy
|
11643
|
-
#
|
11644
|
-
# updated to use the cluster's default capacity provider
|
11866
|
+
# However, when a service is using a capacity provider strategy
|
11867
|
+
# that's not the default capacity provider strategy, the service
|
11868
|
+
# can't be updated to use the cluster's default capacity provider
|
11869
|
+
# strategy.
|
11645
11870
|
#
|
11646
11871
|
# A capacity provider strategy consists of one or more capacity
|
11647
11872
|
# providers along with the `base` and `weight` to assign to them. A
|
@@ -11683,9 +11908,9 @@ module Aws::ECS
|
|
11683
11908
|
# service. To remove all existing placement constraints, specify an
|
11684
11909
|
# empty array.
|
11685
11910
|
#
|
11686
|
-
# You can specify a maximum of 10 constraints
|
11687
|
-
# includes constraints in the task definition and those
|
11688
|
-
# runtime
|
11911
|
+
# You can specify a maximum of 10 constraints for each task. This
|
11912
|
+
# limit includes constraints in the task definition and those
|
11913
|
+
# specified at runtime.
|
11689
11914
|
# @return [Array<Types::PlacementConstraint>]
|
11690
11915
|
#
|
11691
11916
|
# @!attribute [rw] placement_strategy
|
@@ -11695,16 +11920,16 @@ module Aws::ECS
|
|
11695
11920
|
# override the existing placement strategy defined for the service. To
|
11696
11921
|
# remove an existing placement strategy, specify an empty object.
|
11697
11922
|
#
|
11698
|
-
# You can specify a maximum of five strategy rules
|
11923
|
+
# You can specify a maximum of five strategy rules for each service.
|
11699
11924
|
# @return [Array<Types::PlacementStrategy>]
|
11700
11925
|
#
|
11701
11926
|
# @!attribute [rw] platform_version
|
11702
|
-
# The platform version
|
11703
|
-
#
|
11927
|
+
# The platform version that your tasks in the service run on. A
|
11928
|
+
# platform version is only specified for tasks using the Fargate
|
11704
11929
|
# launch type. If a platform version is not specified, the `LATEST`
|
11705
|
-
# platform version is used
|
11706
|
-
#
|
11707
|
-
#
|
11930
|
+
# platform version is used. For more information, see [Fargate
|
11931
|
+
# Platform Versions][1] in the *Amazon Elastic Container Service
|
11932
|
+
# Developer Guide*.
|
11708
11933
|
#
|
11709
11934
|
#
|
11710
11935
|
#
|
@@ -11712,26 +11937,26 @@ module Aws::ECS
|
|
11712
11937
|
# @return [String]
|
11713
11938
|
#
|
11714
11939
|
# @!attribute [rw] force_new_deployment
|
11715
|
-
#
|
11716
|
-
#
|
11717
|
-
# deployment with no service definition changes. For
|
11718
|
-
# update a service's tasks to use a newer Docker
|
11719
|
-
# image/tag combination (`my_image:latest`) or to
|
11720
|
-
# onto a newer platform version.
|
11940
|
+
# Determines whether to force a new deployment of the service. By
|
11941
|
+
# default, deployments aren't forced. You can use this option to
|
11942
|
+
# start a new deployment with no service definition changes. For
|
11943
|
+
# example, you can update a service's tasks to use a newer Docker
|
11944
|
+
# image with the same image/tag combination (`my_image:latest`) or to
|
11945
|
+
# roll Fargate tasks onto a newer platform version.
|
11721
11946
|
# @return [Boolean]
|
11722
11947
|
#
|
11723
11948
|
# @!attribute [rw] health_check_grace_period_seconds
|
11724
11949
|
# The period of time, in seconds, that the Amazon ECS service
|
11725
|
-
# scheduler
|
11726
|
-
#
|
11727
|
-
#
|
11728
|
-
#
|
11729
|
-
#
|
11730
|
-
#
|
11731
|
-
#
|
11732
|
-
#
|
11733
|
-
#
|
11734
|
-
#
|
11950
|
+
# scheduler ignores unhealthy Elastic Load Balancing target health
|
11951
|
+
# checks after a task has first started. This is only valid if your
|
11952
|
+
# service is configured to use a load balancer. If your service's
|
11953
|
+
# tasks take a while to start and respond to Elastic Load Balancing
|
11954
|
+
# health checks, you can specify a health check grace period of up to
|
11955
|
+
# 2,147,483,647 seconds. During that time, the Amazon ECS service
|
11956
|
+
# scheduler ignores the Elastic Load Balancing health check status.
|
11957
|
+
# This grace period can prevent the ECS service scheduler from marking
|
11958
|
+
# tasks as unhealthy and stopping them before they have time to come
|
11959
|
+
# up.
|
11735
11960
|
# @return [Integer]
|
11736
11961
|
#
|
11737
11962
|
# @!attribute [rw] enable_execute_command
|
@@ -11790,12 +12015,12 @@ module Aws::ECS
|
|
11790
12015
|
#
|
11791
12016
|
# @!attribute [rw] cluster
|
11792
12017
|
# The short name or full Amazon Resource Name (ARN) of the cluster
|
11793
|
-
# that hosts the service that the task set
|
12018
|
+
# that hosts the service that the task set is found in.
|
11794
12019
|
# @return [String]
|
11795
12020
|
#
|
11796
12021
|
# @!attribute [rw] service
|
11797
12022
|
# The short name or full Amazon Resource Name (ARN) of the service
|
11798
|
-
# that the task set
|
12023
|
+
# that the task set is found in.
|
11799
12024
|
# @return [String]
|
11800
12025
|
#
|
11801
12026
|
# @!attribute [rw] task_set
|
@@ -11857,7 +12082,7 @@ module Aws::ECS
|
|
11857
12082
|
# @return [String]
|
11858
12083
|
#
|
11859
12084
|
# @!attribute [rw] docker_version
|
11860
|
-
# The Docker version running on the container instance.
|
12085
|
+
# The Docker version that's running on the container instance.
|
11861
12086
|
# @return [String]
|
11862
12087
|
#
|
11863
12088
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/VersionInfo AWS API Documentation
|
@@ -11870,14 +12095,14 @@ module Aws::ECS
|
|
11870
12095
|
include Aws::Structure
|
11871
12096
|
end
|
11872
12097
|
|
11873
|
-
# A data volume used in a task definition. For tasks that use
|
11874
|
-
# Elastic File System (Amazon EFS), specify an
|
11875
|
-
# For Windows tasks that use Amazon FSx for
|
11876
|
-
# system, specify a
|
11877
|
-
# that use a Docker
|
11878
|
-
#
|
11879
|
-
#
|
11880
|
-
# Tasks][1].
|
12098
|
+
# A data volume that's used in a task definition. For tasks that use
|
12099
|
+
# the Amazon Elastic File System (Amazon EFS), specify an
|
12100
|
+
# `efsVolumeConfiguration`. For Windows tasks that use Amazon FSx for
|
12101
|
+
# Windows File Server file system, specify a
|
12102
|
+
# `fsxWindowsFileServerVolumeConfiguration`. For tasks that use a Docker
|
12103
|
+
# volume, specify a `DockerVolumeConfiguration`. For tasks that use a
|
12104
|
+
# bind mount host volume, specify a `host` and optional `sourcePath`.
|
12105
|
+
# For more information, see [Using Data Volumes in Tasks][1].
|
11881
12106
|
#
|
11882
12107
|
#
|
11883
12108
|
#
|
@@ -11930,40 +12155,40 @@ module Aws::ECS
|
|
11930
12155
|
# @return [String]
|
11931
12156
|
#
|
11932
12157
|
# @!attribute [rw] host
|
11933
|
-
# This parameter is specified when you
|
11934
|
-
#
|
11935
|
-
#
|
11936
|
-
#
|
11937
|
-
#
|
11938
|
-
#
|
11939
|
-
# with it stop running.
|
12158
|
+
# This parameter is specified when you use bind mount host volumes.
|
12159
|
+
# The contents of the `host` parameter determine whether your bind
|
12160
|
+
# mount host volume persists on the host container instance and where
|
12161
|
+
# it's stored. If the `host` parameter is empty, then the Docker
|
12162
|
+
# daemon assigns a host path for your data volume. However, the data
|
12163
|
+
# isn't guaranteed to persist after the containers that are
|
12164
|
+
# associated with it stop running.
|
11940
12165
|
#
|
11941
12166
|
# Windows containers can mount whole directories on the same drive as
|
11942
|
-
# `$env:ProgramData`. Windows containers
|
11943
|
-
# different drive, and mount point
|
12167
|
+
# `$env:ProgramData`. Windows containers can't mount directories on a
|
12168
|
+
# different drive, and mount point can't be across drives. For
|
11944
12169
|
# example, you can mount `C:\my\path:C:\my\path` and `D:\:D:`, but
|
11945
12170
|
# not `D:\my\path:C:\my\path` or `D:\:C:\my\path`.
|
11946
12171
|
# @return [Types::HostVolumeProperties]
|
11947
12172
|
#
|
11948
12173
|
# @!attribute [rw] docker_volume_configuration
|
11949
|
-
# This parameter is specified when you
|
12174
|
+
# This parameter is specified when you use Docker volumes.
|
11950
12175
|
#
|
11951
12176
|
# Windows containers only support the use of the `local` driver. To
|
11952
12177
|
# use bind mounts, specify the `host` parameter instead.
|
11953
12178
|
#
|
11954
|
-
# <note markdown="1"> Docker volumes
|
12179
|
+
# <note markdown="1"> Docker volumes aren't supported by tasks run on Fargate.
|
11955
12180
|
#
|
11956
12181
|
# </note>
|
11957
12182
|
# @return [Types::DockerVolumeConfiguration]
|
11958
12183
|
#
|
11959
12184
|
# @!attribute [rw] efs_volume_configuration
|
11960
|
-
# This parameter is specified when you
|
11961
|
-
#
|
12185
|
+
# This parameter is specified when you use an Amazon Elastic File
|
12186
|
+
# System file system for task storage.
|
11962
12187
|
# @return [Types::EFSVolumeConfiguration]
|
11963
12188
|
#
|
11964
12189
|
# @!attribute [rw] fsx_windows_file_server_volume_configuration
|
11965
|
-
# This parameter is specified when you
|
11966
|
-
#
|
12190
|
+
# This parameter is specified when you use Amazon FSx for Windows File
|
12191
|
+
# Server file system for task storage.
|
11967
12192
|
# @return [Types::FSxWindowsFileServerVolumeConfiguration]
|
11968
12193
|
#
|
11969
12194
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Volume AWS API Documentation
|
@@ -11990,8 +12215,8 @@ module Aws::ECS
|
|
11990
12215
|
# }
|
11991
12216
|
#
|
11992
12217
|
# @!attribute [rw] source_container
|
11993
|
-
# The name of another container within the same task definition
|
11994
|
-
#
|
12218
|
+
# The name of another container within the same task definition to
|
12219
|
+
# mount volumes from.
|
11995
12220
|
# @return [String]
|
11996
12221
|
#
|
11997
12222
|
# @!attribute [rw] read_only
|