aws-sdk-ecs 1.86.0 → 1.90.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +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 +1196 -987
- 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,12 @@ 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
1185
|
# The Docker daemon reserves a minimum of 4 MiB of memory for a
|
|
1186
|
-
# container,
|
|
1187
|
-
# your containers.
|
|
1186
|
+
# container. Therefore, we recommend that you specify fewer than 4 MiB
|
|
1187
|
+
# of memory for your containers.
|
|
1188
1188
|
#
|
|
1189
1189
|
#
|
|
1190
1190
|
#
|
|
@@ -1209,7 +1209,7 @@ module Aws::ECS
|
|
|
1209
1209
|
# in a container definition. If you specify both, `memory` must be
|
|
1210
1210
|
# greater than `memoryReservation`. If you specify
|
|
1211
1211
|
# `memoryReservation`, then that value is subtracted from the
|
|
1212
|
-
# available memory resources for the container instance
|
|
1212
|
+
# available memory resources for the container instance where the
|
|
1213
1213
|
# container is placed. Otherwise, the value of `memory` is used.
|
|
1214
1214
|
#
|
|
1215
1215
|
# For example, if your container normally uses 128 MiB of memory, but
|
|
@@ -1221,8 +1221,8 @@ module Aws::ECS
|
|
|
1221
1221
|
# memory resources when needed.
|
|
1222
1222
|
#
|
|
1223
1223
|
# The Docker daemon reserves a minimum of 4 MiB of memory for a
|
|
1224
|
-
# container,
|
|
1225
|
-
# your containers.
|
|
1224
|
+
# container. Therefore, we recommend that you specify fewer than 4 MiB
|
|
1225
|
+
# of memory for your containers.
|
|
1226
1226
|
#
|
|
1227
1227
|
#
|
|
1228
1228
|
#
|
|
@@ -1265,13 +1265,13 @@ module Aws::ECS
|
|
|
1265
1265
|
# containers to access ports on the host container instance to send or
|
|
1266
1266
|
# receive traffic.
|
|
1267
1267
|
#
|
|
1268
|
-
# For task definitions that use the `awsvpc` network mode,
|
|
1269
|
-
#
|
|
1270
|
-
#
|
|
1268
|
+
# For task definitions that use the `awsvpc` network mode, only
|
|
1269
|
+
# specify the `containerPort`. The `hostPort` can be left blank or it
|
|
1270
|
+
# must be the same value as the `containerPort`.
|
|
1271
1271
|
#
|
|
1272
1272
|
# Port mappings on Windows use the `NetNAT` gateway address rather
|
|
1273
|
-
# than `localhost`. There
|
|
1274
|
-
# so you
|
|
1273
|
+
# than `localhost`. There's no loopback for port mappings on Windows,
|
|
1274
|
+
# so you can't access a container's mapped port from the host
|
|
1275
1275
|
# itself.
|
|
1276
1276
|
#
|
|
1277
1277
|
# This parameter maps to `PortBindings` in the [Create a container][1]
|
|
@@ -1301,16 +1301,16 @@ module Aws::ECS
|
|
|
1301
1301
|
# If the `essential` parameter of a container is marked as `true`, and
|
|
1302
1302
|
# that container fails or stops for any reason, all other containers
|
|
1303
1303
|
# that are part of the task are stopped. If the `essential` parameter
|
|
1304
|
-
# of a container is marked as `false`,
|
|
1305
|
-
#
|
|
1306
|
-
#
|
|
1304
|
+
# of a container is marked as `false`, its failure doesn't affect the
|
|
1305
|
+
# rest of the containers in a task. If this parameter is omitted, a
|
|
1306
|
+
# container is assumed to be essential.
|
|
1307
1307
|
#
|
|
1308
1308
|
# All tasks must have at least one essential container. If you have an
|
|
1309
|
-
# application that
|
|
1310
|
-
#
|
|
1311
|
-
#
|
|
1312
|
-
#
|
|
1313
|
-
#
|
|
1309
|
+
# application that's composed of multiple containers, group
|
|
1310
|
+
# containers that are used for a common purpose into components, and
|
|
1311
|
+
# separate the different components into multiple task definitions.
|
|
1312
|
+
# For more information, see [Application Architecture][1] in the
|
|
1313
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
|
1314
1314
|
#
|
|
1315
1315
|
#
|
|
1316
1316
|
#
|
|
@@ -1318,12 +1318,12 @@ module Aws::ECS
|
|
|
1318
1318
|
# @return [Boolean]
|
|
1319
1319
|
#
|
|
1320
1320
|
# @!attribute [rw] entry_point
|
|
1321
|
-
# Early versions of the Amazon ECS container agent
|
|
1321
|
+
# Early versions of the Amazon ECS container agent don't properly
|
|
1322
1322
|
# handle `entryPoint` parameters. If you have problems using
|
|
1323
1323
|
# `entryPoint`, update your container agent or enter your commands and
|
|
1324
1324
|
# arguments as `command` array items instead.
|
|
1325
1325
|
#
|
|
1326
|
-
# The entry point that
|
|
1326
|
+
# The entry point that's passed to the container. This parameter maps
|
|
1327
1327
|
# to `Entrypoint` in the [Create a container][1] section of the
|
|
1328
1328
|
# [Docker Remote API][2] and the `--entrypoint` option to [docker
|
|
1329
1329
|
# run][3]. For more information, see
|
|
@@ -1338,13 +1338,13 @@ module Aws::ECS
|
|
|
1338
1338
|
# @return [Array<String>]
|
|
1339
1339
|
#
|
|
1340
1340
|
# @!attribute [rw] command
|
|
1341
|
-
# The command that
|
|
1341
|
+
# The command that's passed to the container. This parameter maps to
|
|
1342
1342
|
# `Cmd` in the [Create a container][1] section of the [Docker Remote
|
|
1343
1343
|
# API][2] and the `COMMAND` parameter to [docker run][3]. For more
|
|
1344
1344
|
# information, see
|
|
1345
1345
|
# [https://docs.docker.com/engine/reference/builder/#cmd][4]. If there
|
|
1346
|
-
# are multiple arguments, each argument
|
|
1347
|
-
#
|
|
1346
|
+
# are multiple arguments, each argument is a separated string in the
|
|
1347
|
+
# array.
|
|
1348
1348
|
#
|
|
1349
1349
|
#
|
|
1350
1350
|
#
|
|
@@ -1359,7 +1359,7 @@ module Aws::ECS
|
|
|
1359
1359
|
# maps to `Env` in the [Create a container][1] section of the [Docker
|
|
1360
1360
|
# Remote API][2] and the `--env` option to [docker run][3].
|
|
1361
1361
|
#
|
|
1362
|
-
# We
|
|
1362
|
+
# We don't recommend that you use plaintext environment variables for
|
|
1363
1363
|
# sensitive information, such as credential data.
|
|
1364
1364
|
#
|
|
1365
1365
|
#
|
|
@@ -1375,20 +1375,20 @@ module Aws::ECS
|
|
|
1375
1375
|
# run][1].
|
|
1376
1376
|
#
|
|
1377
1377
|
# 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
|
|
1378
|
+
# `.env` file extension. Each line in an environment file contains an
|
|
1379
|
+
# environment variable in `VARIABLE=VALUE` format. Lines beginning
|
|
1380
|
+
# with `#` are treated as comments and are ignored. For more
|
|
1381
|
+
# information about the environment variable file syntax, see [Declare
|
|
1382
1382
|
# default environment variables in file][2].
|
|
1383
1383
|
#
|
|
1384
1384
|
# If there are environment variables specified using the `environment`
|
|
1385
1385
|
# parameter in a container definition, they take precedence over the
|
|
1386
1386
|
# 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*.
|
|
1387
|
+
# environment files are specified that contain the same variable,
|
|
1388
|
+
# they're processed from the top down. We recommend that you use
|
|
1389
|
+
# unique variable names. For more information, see [Specifying
|
|
1390
|
+
# Environment Variables][3] in the *Amazon Elastic Container Service
|
|
1391
|
+
# Developer Guide*.
|
|
1392
1392
|
#
|
|
1393
1393
|
#
|
|
1394
1394
|
#
|
|
@@ -1405,8 +1405,8 @@ module Aws::ECS
|
|
|
1405
1405
|
# [docker run][3].
|
|
1406
1406
|
#
|
|
1407
1407
|
# Windows containers can mount whole directories on the same drive as
|
|
1408
|
-
# `$env:ProgramData`. Windows containers
|
|
1409
|
-
# different drive, and mount point
|
|
1408
|
+
# `$env:ProgramData`. Windows containers can't mount directories on a
|
|
1409
|
+
# different drive, and mount point can't be across drives.
|
|
1410
1410
|
#
|
|
1411
1411
|
#
|
|
1412
1412
|
#
|
|
@@ -1459,7 +1459,7 @@ module Aws::ECS
|
|
|
1459
1459
|
# version. For information about checking your agent version and
|
|
1460
1460
|
# updating to the latest version, see [Updating the Amazon ECS
|
|
1461
1461
|
# Container Agent][1] in the *Amazon Elastic Container Service
|
|
1462
|
-
# Developer Guide*. If you
|
|
1462
|
+
# Developer Guide*. If you're using an Amazon ECS-optimized Linux
|
|
1463
1463
|
# AMI, your instance needs at least version 1.26.0-1 of the `ecs-init`
|
|
1464
1464
|
# package. If your container instances are launched from version
|
|
1465
1465
|
# `20190301` or later, then they contain the required versions of the
|
|
@@ -1468,7 +1468,11 @@ module Aws::ECS
|
|
|
1468
1468
|
# Developer Guide*.
|
|
1469
1469
|
#
|
|
1470
1470
|
# For tasks using the Fargate launch type, the task or service
|
|
1471
|
-
# requires
|
|
1471
|
+
# requires the following platforms:
|
|
1472
|
+
#
|
|
1473
|
+
# * Linux platform version `1.3.0` or later.
|
|
1474
|
+
#
|
|
1475
|
+
# * Windows platform version `1.0.0` or later.
|
|
1472
1476
|
#
|
|
1473
1477
|
#
|
|
1474
1478
|
#
|
|
@@ -1481,19 +1485,23 @@ module Aws::ECS
|
|
|
1481
1485
|
# dependencies for a container. For example, you specify two
|
|
1482
1486
|
# containers in a task definition with containerA having a dependency
|
|
1483
1487
|
# on containerB reaching a `COMPLETE`, `SUCCESS`, or `HEALTHY` status.
|
|
1484
|
-
# If a `startTimeout` value is specified for containerB and it
|
|
1485
|
-
#
|
|
1486
|
-
#
|
|
1488
|
+
# If a `startTimeout` value is specified for containerB and it
|
|
1489
|
+
# doesn't reach the desired status within that time then containerA
|
|
1490
|
+
# gives up and not start. This results in the task transitioning to a
|
|
1487
1491
|
# `STOPPED` state.
|
|
1488
1492
|
#
|
|
1489
1493
|
# <note markdown="1"> When the `ECS_CONTAINER_START_TIMEOUT` container agent configuration
|
|
1490
|
-
# variable is used, it
|
|
1491
|
-
# value.
|
|
1494
|
+
# variable is used, it's enforced independently from this start
|
|
1495
|
+
# timeout value.
|
|
1492
1496
|
#
|
|
1493
1497
|
# </note>
|
|
1494
1498
|
#
|
|
1495
|
-
# For tasks using the Fargate launch type,
|
|
1496
|
-
#
|
|
1499
|
+
# For tasks using the Fargate launch type, the task or service
|
|
1500
|
+
# requires the following platforms:
|
|
1501
|
+
#
|
|
1502
|
+
# * Linux platform version `1.3.0` or later.
|
|
1503
|
+
#
|
|
1504
|
+
# * Windows platform version `1.0.0` or later.
|
|
1497
1505
|
#
|
|
1498
1506
|
# For tasks using the EC2 launch type, your container instances
|
|
1499
1507
|
# require at least version `1.26.0` of the container agent to enable a
|
|
@@ -1501,7 +1509,7 @@ module Aws::ECS
|
|
|
1501
1509
|
# latest container agent version. For information about checking your
|
|
1502
1510
|
# agent version and updating to the latest version, see [Updating the
|
|
1503
1511
|
# Amazon ECS Container Agent][1] in the *Amazon Elastic Container
|
|
1504
|
-
# Service Developer Guide*. If you
|
|
1512
|
+
# Service Developer Guide*. If you're using an Amazon ECS-optimized
|
|
1505
1513
|
# Linux AMI, your instance needs at least version `1.26.0-1` of the
|
|
1506
1514
|
# `ecs-init` package. If your container instances are launched from
|
|
1507
1515
|
# version `20190301` or later, then they contain the required versions
|
|
@@ -1520,14 +1528,19 @@ module Aws::ECS
|
|
|
1520
1528
|
# forcefully killed if it doesn't exit normally on its own.
|
|
1521
1529
|
#
|
|
1522
1530
|
# For tasks using the Fargate launch type, the task or service
|
|
1523
|
-
# requires
|
|
1524
|
-
#
|
|
1525
|
-
#
|
|
1526
|
-
#
|
|
1527
|
-
#
|
|
1528
|
-
#
|
|
1529
|
-
#
|
|
1530
|
-
# default
|
|
1531
|
+
# requires the following platforms:
|
|
1532
|
+
#
|
|
1533
|
+
# * Linux platform version `1.3.0` or later.
|
|
1534
|
+
#
|
|
1535
|
+
# * Windows platform version `1.0.0` or later.
|
|
1536
|
+
#
|
|
1537
|
+
# The max stop timeout value is 120 seconds and if the parameter is
|
|
1538
|
+
# not specified, the default value of 30 seconds is used.
|
|
1539
|
+
#
|
|
1540
|
+
# For tasks that use the EC2 launch type, if the `stopTimeout`
|
|
1541
|
+
# parameter isn't specified, the value set for the Amazon ECS
|
|
1542
|
+
# container agent configuration variable `ECS_CONTAINER_STOP_TIMEOUT`
|
|
1543
|
+
# is used. If neither the `stopTimeout` parameter or the
|
|
1531
1544
|
# `ECS_CONTAINER_STOP_TIMEOUT` agent configuration variable are set,
|
|
1532
1545
|
# then the default values of 30 seconds for Linux containers and 30
|
|
1533
1546
|
# seconds on Windows containers are used. Your container instances
|
|
@@ -1536,7 +1549,7 @@ module Aws::ECS
|
|
|
1536
1549
|
# container agent version. For information about checking your agent
|
|
1537
1550
|
# version and updating to the latest version, see [Updating the Amazon
|
|
1538
1551
|
# ECS Container Agent][1] in the *Amazon Elastic Container Service
|
|
1539
|
-
# Developer Guide*. If you
|
|
1552
|
+
# Developer Guide*. If you're using an Amazon ECS-optimized Linux
|
|
1540
1553
|
# AMI, your instance needs at least version 1.26.0-1 of the `ecs-init`
|
|
1541
1554
|
# package. If your container instances are launched from version
|
|
1542
1555
|
# `20190301` or later, then they contain the required versions of the
|
|
@@ -1555,7 +1568,7 @@ module Aws::ECS
|
|
|
1555
1568
|
# `Hostname` in the [Create a container][1] section of the [Docker
|
|
1556
1569
|
# Remote API][2] and the `--hostname` option to [docker run][3].
|
|
1557
1570
|
#
|
|
1558
|
-
# <note markdown="1"> The `hostname` parameter is not supported if you
|
|
1571
|
+
# <note markdown="1"> The `hostname` parameter is not supported if you're using the
|
|
1559
1572
|
# `awsvpc` network mode.
|
|
1560
1573
|
#
|
|
1561
1574
|
# </note>
|
|
@@ -1572,9 +1585,9 @@ module Aws::ECS
|
|
|
1572
1585
|
# in the [Create a container][1] section of the [Docker Remote API][2]
|
|
1573
1586
|
# and the `--user` option to [docker run][3].
|
|
1574
1587
|
#
|
|
1575
|
-
# When running tasks using the `host` network mode,
|
|
1576
|
-
# containers using the root user (UID 0).
|
|
1577
|
-
#
|
|
1588
|
+
# When running tasks using the `host` network mode, don't run
|
|
1589
|
+
# containers using the root user (UID 0). We recommend using a
|
|
1590
|
+
# non-root user for better security.
|
|
1578
1591
|
#
|
|
1579
1592
|
# You can specify the `user` using the following formats. If
|
|
1580
1593
|
# specifying a UID or GID, you must specify it as a positive integer.
|
|
@@ -1603,8 +1616,8 @@ module Aws::ECS
|
|
|
1603
1616
|
# @return [String]
|
|
1604
1617
|
#
|
|
1605
1618
|
# @!attribute [rw] working_directory
|
|
1606
|
-
# The working directory
|
|
1607
|
-
#
|
|
1619
|
+
# The working directory to run commands inside the container in. This
|
|
1620
|
+
# parameter maps to `WorkingDir` in the [Create a container][1]
|
|
1608
1621
|
# section of the [Docker Remote API][2] and the `--workdir` option to
|
|
1609
1622
|
# [docker run][3].
|
|
1610
1623
|
#
|
|
@@ -1706,7 +1719,7 @@ module Aws::ECS
|
|
|
1706
1719
|
# `ExtraHosts` in the [Create a container][1] section of the [Docker
|
|
1707
1720
|
# Remote API][2] and the `--add-host` option to [docker run][3].
|
|
1708
1721
|
#
|
|
1709
|
-
# <note markdown="1"> This parameter
|
|
1722
|
+
# <note markdown="1"> This parameter isn't supported for Windows containers or tasks that
|
|
1710
1723
|
# use the `awsvpc` network mode.
|
|
1711
1724
|
#
|
|
1712
1725
|
# </note>
|
|
@@ -1720,7 +1733,7 @@ module Aws::ECS
|
|
|
1720
1733
|
#
|
|
1721
1734
|
# @!attribute [rw] docker_security_options
|
|
1722
1735
|
# A list of strings to provide custom labels for SELinux and AppArmor
|
|
1723
|
-
# multi-level security systems. This field
|
|
1736
|
+
# multi-level security systems. This field isn't valid for containers
|
|
1724
1737
|
# in tasks using the Fargate launch type.
|
|
1725
1738
|
#
|
|
1726
1739
|
# With Windows containers, this parameter can be used to reference a
|
|
@@ -1758,11 +1771,11 @@ module Aws::ECS
|
|
|
1758
1771
|
# @return [Array<String>]
|
|
1759
1772
|
#
|
|
1760
1773
|
# @!attribute [rw] interactive
|
|
1761
|
-
# When this parameter is `true`,
|
|
1762
|
-
#
|
|
1763
|
-
#
|
|
1764
|
-
#
|
|
1765
|
-
#
|
|
1774
|
+
# When this parameter is `true`, you can deploy containerized
|
|
1775
|
+
# applications that require `stdin` or a `tty` to be allocated. This
|
|
1776
|
+
# parameter maps to `OpenStdin` in the [Create a container][1] section
|
|
1777
|
+
# of the [Docker Remote API][2] and the `--interactive` option to
|
|
1778
|
+
# [docker run][3].
|
|
1766
1779
|
#
|
|
1767
1780
|
#
|
|
1768
1781
|
#
|
|
@@ -1802,8 +1815,8 @@ module Aws::ECS
|
|
|
1802
1815
|
#
|
|
1803
1816
|
# @!attribute [rw] ulimits
|
|
1804
1817
|
# A list of `ulimits` to set in the container. If a ulimit value is
|
|
1805
|
-
# specified in a task definition, it
|
|
1806
|
-
#
|
|
1818
|
+
# specified in a task definition, it overrides the default values set
|
|
1819
|
+
# by Docker. This parameter maps to `Ulimits` in the [Create a
|
|
1807
1820
|
# container][1] section of the [Docker Remote API][2] and the
|
|
1808
1821
|
# `--ulimit` option to [docker run][3]. Valid naming values are
|
|
1809
1822
|
# displayed in the Ulimit data type.
|
|
@@ -1838,12 +1851,12 @@ module Aws::ECS
|
|
|
1838
1851
|
# This parameter maps to `LogConfig` in the [Create a container][1]
|
|
1839
1852
|
# section of the [Docker Remote API][2] and the `--log-driver` option
|
|
1840
1853
|
# to [docker run][3]. By default, containers use the same logging
|
|
1841
|
-
# driver that the Docker daemon uses. However the container
|
|
1854
|
+
# driver that the Docker daemon uses. However the container can use a
|
|
1842
1855
|
# different logging driver than the Docker daemon by specifying a log
|
|
1843
1856
|
# driver with this parameter in the container definition. To use a
|
|
1844
1857
|
# different logging driver for a container, the log system must be
|
|
1845
1858
|
# configured properly on the container instance (or on a different log
|
|
1846
|
-
# server for remote logging options). For more information
|
|
1859
|
+
# server for remote logging options). For more information about the
|
|
1847
1860
|
# options for different supported log drivers, see [Configure logging
|
|
1848
1861
|
# drivers][4] in the Docker documentation.
|
|
1849
1862
|
#
|
|
@@ -1898,10 +1911,10 @@ module Aws::ECS
|
|
|
1898
1911
|
# of the [Docker Remote API][2] and the `--sysctl` option to [docker
|
|
1899
1912
|
# run][3].
|
|
1900
1913
|
#
|
|
1901
|
-
# <note markdown="1">
|
|
1914
|
+
# <note markdown="1"> We don't recommended that you specify network-related
|
|
1902
1915
|
# `systemControls` parameters for multiple containers in a single task
|
|
1903
1916
|
# that also uses either the `awsvpc` or `host` network modes. For
|
|
1904
|
-
# tasks that use the `awsvpc` network mode, the container that
|
|
1917
|
+
# tasks that use the `awsvpc` network mode, the container that's
|
|
1905
1918
|
# started last determines which `systemControls` parameters take
|
|
1906
1919
|
# effect. For tasks that use the `host` network mode, it changes the
|
|
1907
1920
|
# container instance's namespaced kernel parameters as well as the
|
|
@@ -1987,7 +2000,7 @@ module Aws::ECS
|
|
|
1987
2000
|
# recommend using the latest container agent version. For information
|
|
1988
2001
|
# about checking your agent version and updating to the latest version,
|
|
1989
2002
|
# see [Updating the Amazon ECS Container Agent][1] in the *Amazon
|
|
1990
|
-
# Elastic Container Service Developer Guide*. If you
|
|
2003
|
+
# Elastic Container Service Developer Guide*. If you're using an Amazon
|
|
1991
2004
|
# ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1
|
|
1992
2005
|
# of the `ecs-init` package. If your container instances are launched
|
|
1993
2006
|
# from version `20190301` or later, then they contain the required
|
|
@@ -1995,8 +2008,12 @@ module Aws::ECS
|
|
|
1995
2008
|
# see [Amazon ECS-optimized Linux AMI][2] in the *Amazon Elastic
|
|
1996
2009
|
# Container Service Developer Guide*.
|
|
1997
2010
|
#
|
|
1998
|
-
# <note markdown="1"> For tasks
|
|
1999
|
-
# the
|
|
2011
|
+
# <note markdown="1"> For tasks that use the Fargate launch type, the task or service
|
|
2012
|
+
# requires the following platforms:
|
|
2013
|
+
#
|
|
2014
|
+
# * Linux platform version `1.3.0` or later.
|
|
2015
|
+
#
|
|
2016
|
+
# * Windows platform version `1.0.0` or later.
|
|
2000
2017
|
#
|
|
2001
2018
|
# </note>
|
|
2002
2019
|
#
|
|
@@ -2028,12 +2045,12 @@ module Aws::ECS
|
|
|
2028
2045
|
# * `COMPLETE` - This condition validates that a dependent container
|
|
2029
2046
|
# runs to completion (exits) before permitting other containers to
|
|
2030
2047
|
# start. This can be useful for nonessential containers that run a
|
|
2031
|
-
# script and then exit. This condition
|
|
2048
|
+
# script and then exit. This condition can't be set on an essential
|
|
2032
2049
|
# container.
|
|
2033
2050
|
#
|
|
2034
2051
|
# * `SUCCESS` - This condition is the same as `COMPLETE`, but it also
|
|
2035
2052
|
# requires that the container exits with a `zero` status. This
|
|
2036
|
-
# condition
|
|
2053
|
+
# condition can't be set on an essential container.
|
|
2037
2054
|
#
|
|
2038
2055
|
# * `HEALTHY` - This condition validates that the dependent container
|
|
2039
2056
|
# passes its Docker health check before permitting other containers
|
|
@@ -2051,7 +2068,7 @@ module Aws::ECS
|
|
|
2051
2068
|
include Aws::Structure
|
|
2052
2069
|
end
|
|
2053
2070
|
|
|
2054
|
-
# An EC2 instance that
|
|
2071
|
+
# An EC2 instance that's running the Amazon ECS agent and has been
|
|
2055
2072
|
# registered with a cluster.
|
|
2056
2073
|
#
|
|
2057
2074
|
# @!attribute [rw] container_instance_arn
|
|
@@ -2071,13 +2088,14 @@ module Aws::ECS
|
|
|
2071
2088
|
# @return [String]
|
|
2072
2089
|
#
|
|
2073
2090
|
# @!attribute [rw] capacity_provider_name
|
|
2074
|
-
# The capacity provider associated with the container
|
|
2091
|
+
# The capacity provider that's associated with the container
|
|
2092
|
+
# instance.
|
|
2075
2093
|
# @return [String]
|
|
2076
2094
|
#
|
|
2077
2095
|
# @!attribute [rw] version
|
|
2078
2096
|
# The version counter for the container instance. Every time a
|
|
2079
2097
|
# container instance experiences a change that triggers a CloudWatch
|
|
2080
|
-
# event, the version counter is incremented. If you
|
|
2098
|
+
# event, the version counter is incremented. If you're replicating
|
|
2081
2099
|
# your Amazon ECS container instance state with CloudWatch Events, you
|
|
2082
2100
|
# can compare the version of a container instance reported by the
|
|
2083
2101
|
# Amazon ECS APIs with the version reported in CloudWatch Events for
|
|
@@ -2092,12 +2110,12 @@ module Aws::ECS
|
|
|
2092
2110
|
#
|
|
2093
2111
|
# @!attribute [rw] remaining_resources
|
|
2094
2112
|
# For CPU and memory resource types, this parameter describes the
|
|
2095
|
-
# remaining CPU and memory that
|
|
2096
|
-
#
|
|
2097
|
-
#
|
|
2098
|
-
#
|
|
2099
|
-
#
|
|
2100
|
-
#
|
|
2113
|
+
# remaining CPU and memory that wasn't already allocated to tasks and
|
|
2114
|
+
# is therefore available for new tasks. For port resource types, this
|
|
2115
|
+
# parameter describes the ports that were reserved by the Amazon ECS
|
|
2116
|
+
# container agent (at instance registration time) and any task
|
|
2117
|
+
# containers that have reserved port mappings on the host (with the
|
|
2118
|
+
# `host` or `bridge` network mode). Any port that's not specified
|
|
2101
2119
|
# here is available for new tasks.
|
|
2102
2120
|
# @return [Array<Types::Resource>]
|
|
2103
2121
|
#
|
|
@@ -2130,7 +2148,7 @@ module Aws::ECS
|
|
|
2130
2148
|
# status.
|
|
2131
2149
|
#
|
|
2132
2150
|
# The `ACTIVE` status indicates that the container instance can accept
|
|
2133
|
-
# tasks. The `DRAINING` indicates that new tasks
|
|
2151
|
+
# tasks. The `DRAINING` indicates that new tasks aren't placed on the
|
|
2134
2152
|
# container instance and any service tasks running on the container
|
|
2135
2153
|
# instance are removed if possible. For more information, see
|
|
2136
2154
|
# [Container Instance Draining][1] in the *Amazon Elastic Container
|
|
@@ -2163,8 +2181,8 @@ module Aws::ECS
|
|
|
2163
2181
|
# @return [Integer]
|
|
2164
2182
|
#
|
|
2165
2183
|
# @!attribute [rw] agent_update_status
|
|
2166
|
-
# The status of the most recent agent update. If an update
|
|
2167
|
-
#
|
|
2184
|
+
# The status of the most recent agent update. If an update wasn't
|
|
2185
|
+
# ever requested, this value is `NULL`.
|
|
2168
2186
|
# @return [String]
|
|
2169
2187
|
#
|
|
2170
2188
|
# @!attribute [rw] attributes
|
|
@@ -2174,7 +2192,8 @@ module Aws::ECS
|
|
|
2174
2192
|
# @return [Array<Types::Attribute>]
|
|
2175
2193
|
#
|
|
2176
2194
|
# @!attribute [rw] registered_at
|
|
2177
|
-
# The Unix timestamp for when the container instance was
|
|
2195
|
+
# The Unix timestamp for the time when the container instance was
|
|
2196
|
+
# registered.
|
|
2178
2197
|
# @return [Time]
|
|
2179
2198
|
#
|
|
2180
2199
|
# @!attribute [rw] attachments
|
|
@@ -2185,7 +2204,7 @@ module Aws::ECS
|
|
|
2185
2204
|
# @!attribute [rw] tags
|
|
2186
2205
|
# The metadata that you apply to the container instance to help you
|
|
2187
2206
|
# categorize and organize them. Each tag consists of a key and an
|
|
2188
|
-
# optional value
|
|
2207
|
+
# optional value. You define both.
|
|
2189
2208
|
#
|
|
2190
2209
|
# The following basic restrictions apply to tags:
|
|
2191
2210
|
#
|
|
@@ -2213,6 +2232,10 @@ module Aws::ECS
|
|
|
2213
2232
|
# against your tags per resource limit.
|
|
2214
2233
|
# @return [Array<Types::Tag>]
|
|
2215
2234
|
#
|
|
2235
|
+
# @!attribute [rw] health_status
|
|
2236
|
+
# An object representing the health status of the container instance.
|
|
2237
|
+
# @return [Types::ContainerInstanceHealthStatus]
|
|
2238
|
+
#
|
|
2216
2239
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerInstance AWS API Documentation
|
|
2217
2240
|
#
|
|
2218
2241
|
class ContainerInstance < Struct.new(
|
|
@@ -2232,15 +2255,37 @@ module Aws::ECS
|
|
|
2232
2255
|
:attributes,
|
|
2233
2256
|
:registered_at,
|
|
2234
2257
|
:attachments,
|
|
2235
|
-
:tags
|
|
2258
|
+
:tags,
|
|
2259
|
+
:health_status)
|
|
2260
|
+
SENSITIVE = []
|
|
2261
|
+
include Aws::Structure
|
|
2262
|
+
end
|
|
2263
|
+
|
|
2264
|
+
# An object representing the health status of the container instance.
|
|
2265
|
+
#
|
|
2266
|
+
# @!attribute [rw] overall_status
|
|
2267
|
+
# The overall health status of the container instance. This is an
|
|
2268
|
+
# aggregate status of all container instance health checks.
|
|
2269
|
+
# @return [String]
|
|
2270
|
+
#
|
|
2271
|
+
# @!attribute [rw] details
|
|
2272
|
+
# An array of objects representing the details of the container
|
|
2273
|
+
# instance health status.
|
|
2274
|
+
# @return [Array<Types::InstanceHealthCheckResult>]
|
|
2275
|
+
#
|
|
2276
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerInstanceHealthStatus AWS API Documentation
|
|
2277
|
+
#
|
|
2278
|
+
class ContainerInstanceHealthStatus < Struct.new(
|
|
2279
|
+
:overall_status,
|
|
2280
|
+
:details)
|
|
2236
2281
|
SENSITIVE = []
|
|
2237
2282
|
include Aws::Structure
|
|
2238
2283
|
end
|
|
2239
2284
|
|
|
2240
|
-
# The overrides that
|
|
2285
|
+
# The overrides that are sent to a container. An empty container
|
|
2241
2286
|
# override can be passed in. An example of an empty container override
|
|
2242
|
-
#
|
|
2243
|
-
#
|
|
2287
|
+
# is `\{"containerOverrides": [ ] \}`. If a non-empty container override
|
|
2288
|
+
# is specified, the `name` parameter must be included.
|
|
2244
2289
|
#
|
|
2245
2290
|
# @note When making an API call, you may pass ContainerOverride
|
|
2246
2291
|
# data as a hash:
|
|
@@ -2335,7 +2380,7 @@ module Aws::ECS
|
|
|
2335
2380
|
include Aws::Structure
|
|
2336
2381
|
end
|
|
2337
2382
|
|
|
2338
|
-
# An object
|
|
2383
|
+
# An object that represents a change in state for a container.
|
|
2339
2384
|
#
|
|
2340
2385
|
# @note When making an API call, you may pass ContainerStateChange
|
|
2341
2386
|
# data as a hash:
|
|
@@ -2375,7 +2420,7 @@ module Aws::ECS
|
|
|
2375
2420
|
# @return [Integer]
|
|
2376
2421
|
#
|
|
2377
2422
|
# @!attribute [rw] network_bindings
|
|
2378
|
-
# Any network bindings associated with the container.
|
|
2423
|
+
# Any network bindings that are associated with the container.
|
|
2379
2424
|
# @return [Array<Types::NetworkBinding>]
|
|
2380
2425
|
#
|
|
2381
2426
|
# @!attribute [rw] reason
|
|
@@ -2425,10 +2470,10 @@ module Aws::ECS
|
|
|
2425
2470
|
# }
|
|
2426
2471
|
#
|
|
2427
2472
|
# @!attribute [rw] name
|
|
2428
|
-
# The name of the capacity provider. Up to 255 characters are allowed
|
|
2429
|
-
#
|
|
2430
|
-
# hyphens. The name
|
|
2431
|
-
# "`fargate`".
|
|
2473
|
+
# The name of the capacity provider. Up to 255 characters are allowed.
|
|
2474
|
+
# They include letters (both upper and lowercase letters), numbers,
|
|
2475
|
+
# underscores (\_), and hyphens (-). The name can't be prefixed with
|
|
2476
|
+
# "`aws`", "`ecs`", or "`fargate`".
|
|
2432
2477
|
# @return [String]
|
|
2433
2478
|
#
|
|
2434
2479
|
# @!attribute [rw] auto_scaling_group_provider
|
|
@@ -2436,9 +2481,9 @@ module Aws::ECS
|
|
|
2436
2481
|
# @return [Types::AutoScalingGroupProvider]
|
|
2437
2482
|
#
|
|
2438
2483
|
# @!attribute [rw] tags
|
|
2439
|
-
# The metadata that you apply to the capacity provider to
|
|
2440
|
-
#
|
|
2441
|
-
# optional value
|
|
2484
|
+
# The metadata that you apply to the capacity provider to categorize
|
|
2485
|
+
# and organize them more conveniently. Each tag consists of a key and
|
|
2486
|
+
# an optional value. You define both of them.
|
|
2442
2487
|
#
|
|
2443
2488
|
# The following basic restrictions apply to tags:
|
|
2444
2489
|
#
|
|
@@ -2529,16 +2574,16 @@ module Aws::ECS
|
|
|
2529
2574
|
# }
|
|
2530
2575
|
#
|
|
2531
2576
|
# @!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.
|
|
2577
|
+
# The name of your cluster. If you don't specify a name for your
|
|
2578
|
+
# cluster, you create a cluster that's named `default`. Up to 255
|
|
2579
|
+
# letters (uppercase and lowercase), numbers, underscores, and hyphens
|
|
2580
|
+
# are allowed.
|
|
2536
2581
|
# @return [String]
|
|
2537
2582
|
#
|
|
2538
2583
|
# @!attribute [rw] tags
|
|
2539
2584
|
# 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
|
-
#
|
|
2585
|
+
# and organize them. Each tag consists of a key and an optional value.
|
|
2586
|
+
# You define both.
|
|
2542
2587
|
#
|
|
2543
2588
|
# The following basic restrictions apply to tags:
|
|
2544
2589
|
#
|
|
@@ -2569,8 +2614,8 @@ module Aws::ECS
|
|
|
2569
2614
|
# @!attribute [rw] settings
|
|
2570
2615
|
# The setting to use when creating a cluster. This parameter is used
|
|
2571
2616
|
# to enable CloudWatch Container Insights for a cluster. If this value
|
|
2572
|
-
# is specified, it
|
|
2573
|
-
#
|
|
2617
|
+
# is specified, it overrides the `containerInsights` value set with
|
|
2618
|
+
# PutAccountSetting or PutAccountSettingDefault.
|
|
2574
2619
|
# @return [Array<Types::ClusterSetting>]
|
|
2575
2620
|
#
|
|
2576
2621
|
# @!attribute [rw] configuration
|
|
@@ -2585,10 +2630,9 @@ module Aws::ECS
|
|
|
2585
2630
|
# calling the CreateService or RunTask actions.
|
|
2586
2631
|
#
|
|
2587
2632
|
# If specifying a capacity provider that uses an Auto Scaling group,
|
|
2588
|
-
# the capacity provider must
|
|
2589
|
-
#
|
|
2590
|
-
#
|
|
2591
|
-
# operation.
|
|
2633
|
+
# the capacity provider must be created but not associated with
|
|
2634
|
+
# another cluster. New Auto Scaling group capacity providers can be
|
|
2635
|
+
# created with the CreateCapacityProvider API operation.
|
|
2592
2636
|
#
|
|
2593
2637
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
|
2594
2638
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
|
@@ -2602,13 +2646,13 @@ module Aws::ECS
|
|
|
2602
2646
|
#
|
|
2603
2647
|
# @!attribute [rw] default_capacity_provider_strategy
|
|
2604
2648
|
# The capacity provider strategy to set as the default for the
|
|
2605
|
-
# cluster.
|
|
2606
|
-
# cluster, when
|
|
2649
|
+
# cluster. After a default capacity provider strategy is set for a
|
|
2650
|
+
# cluster, when you call the RunTask or CreateService APIs with no
|
|
2607
2651
|
# capacity provider strategy or launch type specified, the default
|
|
2608
2652
|
# capacity provider strategy for the cluster is used.
|
|
2609
2653
|
#
|
|
2610
|
-
# If a default capacity provider strategy
|
|
2611
|
-
#
|
|
2654
|
+
# If a default capacity provider strategy isn't defined for a cluster
|
|
2655
|
+
# when it was created, it can be defined later with the
|
|
2612
2656
|
# PutClusterCapacityProviders API operation.
|
|
2613
2657
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
|
2614
2658
|
#
|
|
@@ -2716,8 +2760,8 @@ module Aws::ECS
|
|
|
2716
2760
|
# }
|
|
2717
2761
|
#
|
|
2718
2762
|
# @!attribute [rw] cluster
|
|
2719
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
2720
|
-
#
|
|
2763
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
2764
|
+
# that you run your service on. If you do not specify a cluster, the
|
|
2721
2765
|
# default cluster is assumed.
|
|
2722
2766
|
# @return [String]
|
|
2723
2767
|
#
|
|
@@ -2731,11 +2775,11 @@ module Aws::ECS
|
|
|
2731
2775
|
#
|
|
2732
2776
|
# @!attribute [rw] task_definition
|
|
2733
2777
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
|
2734
|
-
# task definition to run in your service. If a `revision`
|
|
2778
|
+
# task definition to run in your service. If a `revision` isn't
|
|
2735
2779
|
# specified, the latest `ACTIVE` revision is used.
|
|
2736
2780
|
#
|
|
2737
|
-
# A task definition must be specified if the service
|
|
2738
|
-
#
|
|
2781
|
+
# A task definition must be specified if the service uses either the
|
|
2782
|
+
# `ECS` or `CODE_DEPLOY` deployment controllers.
|
|
2739
2783
|
# @return [String]
|
|
2740
2784
|
#
|
|
2741
2785
|
# @!attribute [rw] load_balancers
|
|
@@ -2743,56 +2787,57 @@ module Aws::ECS
|
|
|
2743
2787
|
# your service. For more information, see [Service Load Balancing][1]
|
|
2744
2788
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
|
2745
2789
|
#
|
|
2746
|
-
# If the service
|
|
2747
|
-
#
|
|
2748
|
-
#
|
|
2749
|
-
#
|
|
2750
|
-
#
|
|
2751
|
-
#
|
|
2752
|
-
#
|
|
2790
|
+
# If the service uses the rolling update (`ECS`) deployment controller
|
|
2791
|
+
# and using either an Application Load Balancer or Network Load
|
|
2792
|
+
# Balancer, you must specify one or more target group ARNs to attach
|
|
2793
|
+
# to the service. The service-linked role is required for services
|
|
2794
|
+
# that use multiple target groups. For more information, see [Using
|
|
2795
|
+
# service-linked roles for Amazon ECS][2] in the *Amazon Elastic
|
|
2796
|
+
# Container Service Developer Guide*.
|
|
2753
2797
|
#
|
|
2754
|
-
# If the service
|
|
2798
|
+
# If the service uses the `CODE_DEPLOY` deployment controller, the
|
|
2755
2799
|
# service is required to use either an Application Load Balancer or
|
|
2756
2800
|
# Network Load Balancer. When creating an CodeDeploy deployment group,
|
|
2757
2801
|
# you specify two target groups (referred to as a `targetGroupPair`).
|
|
2758
2802
|
# During a deployment, CodeDeploy determines which task set in your
|
|
2759
|
-
# service has the status `PRIMARY
|
|
2760
|
-
# with it,
|
|
2803
|
+
# service has the status `PRIMARY`, and it associates one target group
|
|
2804
|
+
# with it. Then, it also associates the other target group with the
|
|
2761
2805
|
# replacement task set. The load balancer can also have up to two
|
|
2762
2806
|
# listeners: a required listener for production traffic and an
|
|
2763
|
-
# optional listener that
|
|
2807
|
+
# optional listener that you can use to perform validation tests with
|
|
2764
2808
|
# Lambda functions before routing production traffic to it.
|
|
2765
2809
|
#
|
|
2766
2810
|
# After you create a service using the `ECS` deployment controller,
|
|
2767
2811
|
# 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.
|
|
2812
|
+
# container port that's specified in the service definition are
|
|
2813
|
+
# immutable. If you use the `CODE_DEPLOY` deployment controller, these
|
|
2814
|
+
# values can be changed when updating the service.
|
|
2771
2815
|
#
|
|
2772
2816
|
# For Application Load Balancers and Network Load Balancers, this
|
|
2773
2817
|
# 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.
|
|
2818
|
+
# container name, and the container port to access from the load
|
|
2819
|
+
# balancer. The container name must be as it appears in a container
|
|
2820
|
+
# definition. The load balancer name parameter must be omitted. When a
|
|
2821
|
+
# task from this service is placed on a container instance, the
|
|
2822
|
+
# container instance and port combination is registered as a target in
|
|
2823
|
+
# the target group that's specified here.
|
|
2780
2824
|
#
|
|
2781
2825
|
# 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.
|
|
2826
|
+
# balancer name, the container name , and the container port to access
|
|
2827
|
+
# from the load balancer. The container name must be as it appears in
|
|
2828
|
+
# a container definition. The target group ARN parameter must be
|
|
2829
|
+
# omitted. When a task from this service is placed on a container
|
|
2830
|
+
# instance, the container instance is registered with the load
|
|
2831
|
+
# balancer that's specified here.
|
|
2788
2832
|
#
|
|
2789
2833
|
# Services with tasks that use the `awsvpc` network mode (for example,
|
|
2790
2834
|
# those with the Fargate launch type) only support Application Load
|
|
2791
|
-
# Balancers and Network Load Balancers. Classic Load Balancers
|
|
2835
|
+
# Balancers and Network Load Balancers. Classic Load Balancers aren't
|
|
2792
2836
|
# 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
|
|
2837
|
+
# services, you must choose `ip` as the target type, not `instance`.
|
|
2838
|
+
# This is because tasks that use the `awsvpc` network mode are
|
|
2839
|
+
# associated with an elastic network interface, not an Amazon EC2
|
|
2840
|
+
# instance.
|
|
2796
2841
|
#
|
|
2797
2842
|
#
|
|
2798
2843
|
#
|
|
@@ -2805,7 +2850,7 @@ module Aws::ECS
|
|
|
2805
2850
|
# service. For more information, see [Service discovery][1].
|
|
2806
2851
|
#
|
|
2807
2852
|
# <note markdown="1"> Each service may be associated with one service registry. Multiple
|
|
2808
|
-
# service registries
|
|
2853
|
+
# service registries for each service isn't supported.
|
|
2809
2854
|
#
|
|
2810
2855
|
# </note>
|
|
2811
2856
|
#
|
|
@@ -2818,18 +2863,19 @@ module Aws::ECS
|
|
|
2818
2863
|
# The number of instantiations of the specified task definition to
|
|
2819
2864
|
# place and keep running on your cluster.
|
|
2820
2865
|
#
|
|
2821
|
-
# This is required if `schedulingStrategy` is `REPLICA` or
|
|
2822
|
-
# specified. If `schedulingStrategy` is `DAEMON` then this
|
|
2866
|
+
# This is required if `schedulingStrategy` is `REPLICA` or isn't
|
|
2867
|
+
# specified. If `schedulingStrategy` is `DAEMON` then this isn't
|
|
2823
2868
|
# required.
|
|
2824
2869
|
# @return [Integer]
|
|
2825
2870
|
#
|
|
2826
2871
|
# @!attribute [rw] client_token
|
|
2827
|
-
#
|
|
2828
|
-
#
|
|
2872
|
+
# An identifier that you provide to ensure the idempotency of the
|
|
2873
|
+
# request. It must be unique and is case sensitive. Up to 32 ASCII
|
|
2874
|
+
# characters are allowed.
|
|
2829
2875
|
# @return [String]
|
|
2830
2876
|
#
|
|
2831
2877
|
# @!attribute [rw] launch_type
|
|
2832
|
-
# The infrastructure
|
|
2878
|
+
# The infrastructure that you run your service on. For more
|
|
2833
2879
|
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
|
2834
2880
|
# Container Service Developer Guide*.
|
|
2835
2881
|
#
|
|
@@ -2845,8 +2891,8 @@ module Aws::ECS
|
|
|
2845
2891
|
# The `EC2` launch type runs your tasks on Amazon EC2 instances
|
|
2846
2892
|
# registered to your cluster.
|
|
2847
2893
|
#
|
|
2848
|
-
# The `EXTERNAL` launch type runs your tasks on your on-
|
|
2849
|
-
# or virtual machine (VM) capacity registered to your cluster.
|
|
2894
|
+
# The `EXTERNAL` launch type runs your tasks on your on-premises
|
|
2895
|
+
# server or virtual machine (VM) capacity registered to your cluster.
|
|
2850
2896
|
#
|
|
2851
2897
|
# A service can use either a launch type or a capacity provider
|
|
2852
2898
|
# strategy. If a `launchType` is specified, the
|
|
@@ -2874,9 +2920,8 @@ module Aws::ECS
|
|
|
2874
2920
|
# The platform version that your tasks in the service are running on.
|
|
2875
2921
|
# A platform version is specified only for tasks using the Fargate
|
|
2876
2922
|
# launch type. If one isn't specified, the `LATEST` platform version
|
|
2877
|
-
# is used
|
|
2878
|
-
#
|
|
2879
|
-
# Guide*.
|
|
2923
|
+
# is used. For more information, see [Fargate platform versions][1] in
|
|
2924
|
+
# the *Amazon Elastic Container Service Developer Guide*.
|
|
2880
2925
|
#
|
|
2881
2926
|
#
|
|
2882
2927
|
#
|
|
@@ -2887,20 +2932,20 @@ module Aws::ECS
|
|
|
2887
2932
|
# The name or full Amazon Resource Name (ARN) of the IAM role that
|
|
2888
2933
|
# allows Amazon ECS to make calls to your load balancer on your
|
|
2889
2934
|
# behalf. This parameter is only permitted if you are using a load
|
|
2890
|
-
# balancer with your service and your task definition
|
|
2935
|
+
# balancer with your service and your task definition doesn't use the
|
|
2891
2936
|
# `awsvpc` network mode. If you specify the `role` parameter, you must
|
|
2892
2937
|
# also specify a load balancer object with the `loadBalancers`
|
|
2893
2938
|
# parameter.
|
|
2894
2939
|
#
|
|
2895
2940
|
# If your account has already created the Amazon ECS service-linked
|
|
2896
|
-
# role, that role is used
|
|
2897
|
-
#
|
|
2898
|
-
#
|
|
2899
|
-
#
|
|
2900
|
-
#
|
|
2901
|
-
#
|
|
2902
|
-
#
|
|
2903
|
-
#
|
|
2941
|
+
# role, that role is used for your service unless you specify a role
|
|
2942
|
+
# here. The service-linked role is required if your task definition
|
|
2943
|
+
# uses the `awsvpc` network mode or if the service is configured to
|
|
2944
|
+
# use service discovery, an external deployment controller, multiple
|
|
2945
|
+
# target groups, or Elastic Inference accelerators in which case you
|
|
2946
|
+
# don't specify a role here. For more information, see [Using
|
|
2947
|
+
# service-linked roles for Amazon ECS][1] in the *Amazon Elastic
|
|
2948
|
+
# Container Service Developer Guide*.
|
|
2904
2949
|
#
|
|
2905
2950
|
# If your specified role has a path other than `/`, then you must
|
|
2906
2951
|
# either specify the full role ARN (this is recommended) or prefix the
|
|
@@ -2923,20 +2968,20 @@ module Aws::ECS
|
|
|
2923
2968
|
#
|
|
2924
2969
|
# @!attribute [rw] placement_constraints
|
|
2925
2970
|
# 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
|
|
2971
|
+
# service. You can specify a maximum of 10 constraints for each task.
|
|
2972
|
+
# This limit includes constraints in the task definition and those
|
|
2973
|
+
# specified at runtime.
|
|
2929
2974
|
# @return [Array<Types::PlacementConstraint>]
|
|
2930
2975
|
#
|
|
2931
2976
|
# @!attribute [rw] placement_strategy
|
|
2932
2977
|
# The placement strategy objects to use for tasks in your service. You
|
|
2933
|
-
# can specify a maximum of 5 strategy rules
|
|
2978
|
+
# can specify a maximum of 5 strategy rules for each service.
|
|
2934
2979
|
# @return [Array<Types::PlacementStrategy>]
|
|
2935
2980
|
#
|
|
2936
2981
|
# @!attribute [rw] network_configuration
|
|
2937
2982
|
# The network configuration for the service. This parameter is
|
|
2938
2983
|
# required for task definitions that use the `awsvpc` network mode to
|
|
2939
|
-
# receive their own elastic network interface, and it
|
|
2984
|
+
# receive their own elastic network interface, and it isn't supported
|
|
2940
2985
|
# for other network modes. For more information, see [Task
|
|
2941
2986
|
# networking][1] in the *Amazon Elastic Container Service Developer
|
|
2942
2987
|
# Guide*.
|
|
@@ -2948,18 +2993,19 @@ module Aws::ECS
|
|
|
2948
2993
|
#
|
|
2949
2994
|
# @!attribute [rw] health_check_grace_period_seconds
|
|
2950
2995
|
# The period of time, in seconds, that the Amazon ECS service
|
|
2951
|
-
# scheduler
|
|
2952
|
-
#
|
|
2953
|
-
#
|
|
2954
|
-
#
|
|
2955
|
-
#
|
|
2996
|
+
# scheduler ignores unhealthy Elastic Load Balancing target health
|
|
2997
|
+
# checks after a task has first started. This is only used when your
|
|
2998
|
+
# service is configured to use a load balancer. If your service has a
|
|
2999
|
+
# load balancer defined and you don't specify a health check grace
|
|
3000
|
+
# period value, the default value of `0` is used.
|
|
2956
3001
|
#
|
|
2957
3002
|
# If your service's tasks take a while to start and respond to
|
|
2958
3003
|
# 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
|
|
3004
|
+
# grace period of up to 2,147,483,647 seconds (about 69 years). During
|
|
3005
|
+
# that time, the Amazon ECS service scheduler ignores health check
|
|
3006
|
+
# status. This grace period can prevent the service scheduler from
|
|
3007
|
+
# marking tasks as unhealthy and stopping them before they have time
|
|
3008
|
+
# to come up.
|
|
2963
3009
|
# @return [Integer]
|
|
2964
3010
|
#
|
|
2965
3011
|
# @!attribute [rw] scheduling_strategy
|
|
@@ -2973,14 +3019,14 @@ module Aws::ECS
|
|
|
2973
3019
|
# service scheduler spreads tasks across Availability Zones. You can
|
|
2974
3020
|
# use task placement strategies and constraints to customize task
|
|
2975
3021
|
# placement decisions. This scheduler strategy is required if the
|
|
2976
|
-
# service
|
|
2977
|
-
#
|
|
3022
|
+
# service uses the `CODE_DEPLOY` or `EXTERNAL` deployment controller
|
|
3023
|
+
# types.
|
|
2978
3024
|
#
|
|
2979
3025
|
# * `DAEMON`-The daemon scheduling strategy deploys exactly one task
|
|
2980
3026
|
# on each active container instance that meets all of the task
|
|
2981
3027
|
# placement constraints that you specify in your cluster. The
|
|
2982
3028
|
# service scheduler also evaluates the task placement constraints
|
|
2983
|
-
# for running tasks and will stop tasks that
|
|
3029
|
+
# for running tasks and will stop tasks that don't meet the
|
|
2984
3030
|
# placement constraints. When you're using this strategy, you
|
|
2985
3031
|
# don't need to specify a desired number of tasks, a task placement
|
|
2986
3032
|
# strategy, or use Service Auto Scaling policies.
|
|
@@ -3047,16 +3093,16 @@ module Aws::ECS
|
|
|
3047
3093
|
# @!attribute [rw] propagate_tags
|
|
3048
3094
|
# Specifies whether to propagate the tags from the task definition or
|
|
3049
3095
|
# the service to the tasks in the service. If no value is specified,
|
|
3050
|
-
# the tags
|
|
3096
|
+
# the tags aren't propagated. Tags can only be propagated to the
|
|
3051
3097
|
# tasks within the service during service creation. To add tags to a
|
|
3052
3098
|
# task after service creation or task creation, use the TagResource
|
|
3053
3099
|
# API action.
|
|
3054
3100
|
# @return [String]
|
|
3055
3101
|
#
|
|
3056
3102
|
# @!attribute [rw] enable_execute_command
|
|
3057
|
-
#
|
|
3058
|
-
# service. If `true`, this enables execute command functionality
|
|
3059
|
-
# all containers in the service tasks.
|
|
3103
|
+
# Determines whether the execute command functionality is enabled for
|
|
3104
|
+
# the service. If `true`, this enables execute command functionality
|
|
3105
|
+
# on all containers in the service tasks.
|
|
3060
3106
|
# @return [Boolean]
|
|
3061
3107
|
#
|
|
3062
3108
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateServiceRequest AWS API Documentation
|
|
@@ -3092,14 +3138,14 @@ module Aws::ECS
|
|
|
3092
3138
|
# The full description of your service following the create call.
|
|
3093
3139
|
#
|
|
3094
3140
|
# A service will return either a `capacityProviderStrategy` or
|
|
3095
|
-
# `launchType` parameter, but not both, depending
|
|
3096
|
-
# specified
|
|
3141
|
+
# `launchType` parameter, but not both, depending where one was
|
|
3142
|
+
# specified when it was created.
|
|
3097
3143
|
#
|
|
3098
3144
|
# If a service is using the `ECS` deployment controller, the
|
|
3099
3145
|
# `deploymentController` and `taskSets` parameters will not be
|
|
3100
3146
|
# returned.
|
|
3101
3147
|
#
|
|
3102
|
-
#
|
|
3148
|
+
# if the service uses the `CODE_DEPLOY` deployment controller, the
|
|
3103
3149
|
# `deploymentController`, `taskSets` and `deployments` parameters will
|
|
3104
3150
|
# be returned, however the `deployments` parameter will be an empty
|
|
3105
3151
|
# list.
|
|
@@ -3208,7 +3254,7 @@ module Aws::ECS
|
|
|
3208
3254
|
# @return [Array<Types::ServiceRegistry>]
|
|
3209
3255
|
#
|
|
3210
3256
|
# @!attribute [rw] launch_type
|
|
3211
|
-
# The launch type that new tasks in the task set
|
|
3257
|
+
# The launch type that new tasks in the task set uses. For more
|
|
3212
3258
|
# information, see [Amazon ECS Launch Types][1] in the *Amazon Elastic
|
|
3213
3259
|
# Container Service Developer Guide*.
|
|
3214
3260
|
#
|
|
@@ -3251,10 +3297,9 @@ module Aws::ECS
|
|
|
3251
3297
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
|
3252
3298
|
#
|
|
3253
3299
|
# @!attribute [rw] platform_version
|
|
3254
|
-
# The platform version that the tasks in the task set
|
|
3255
|
-
#
|
|
3256
|
-
#
|
|
3257
|
-
# is used by default.
|
|
3300
|
+
# The platform version that the tasks in the task set uses. A platform
|
|
3301
|
+
# version is specified only for tasks using the Fargate launch type.
|
|
3302
|
+
# If one isn't specified, the `LATEST` platform version is used.
|
|
3258
3303
|
# @return [String]
|
|
3259
3304
|
#
|
|
3260
3305
|
# @!attribute [rw] scale
|
|
@@ -3263,15 +3308,15 @@ module Aws::ECS
|
|
|
3263
3308
|
# @return [Types::Scale]
|
|
3264
3309
|
#
|
|
3265
3310
|
# @!attribute [rw] client_token
|
|
3266
|
-
#
|
|
3267
|
-
#
|
|
3311
|
+
# The identifier that you provide to ensure the idempotency of the
|
|
3312
|
+
# request. It's case sensitive and must be unique. It can be up to 32
|
|
3313
|
+
# ASCII characters are allowed.
|
|
3268
3314
|
# @return [String]
|
|
3269
3315
|
#
|
|
3270
3316
|
# @!attribute [rw] tags
|
|
3271
3317
|
# 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.
|
|
3318
|
+
# and organize them. Each tag consists of a key and an optional value.
|
|
3319
|
+
# You define both. When a service is deleted, the tags are deleted.
|
|
3275
3320
|
#
|
|
3276
3321
|
# The following basic restrictions apply to tags:
|
|
3277
3322
|
#
|
|
@@ -3343,7 +3388,7 @@ module Aws::ECS
|
|
|
3343
3388
|
# }
|
|
3344
3389
|
#
|
|
3345
3390
|
# @!attribute [rw] name
|
|
3346
|
-
# The resource name
|
|
3391
|
+
# The resource name to disable the account setting for. If
|
|
3347
3392
|
# `serviceLongArnFormat` is specified, the ARN for your Amazon ECS
|
|
3348
3393
|
# services is affected. If `taskLongArnFormat` is specified, the ARN
|
|
3349
3394
|
# and resource ID for your Amazon ECS tasks is affected. If
|
|
@@ -3354,12 +3399,12 @@ module Aws::ECS
|
|
|
3354
3399
|
# @return [String]
|
|
3355
3400
|
#
|
|
3356
3401
|
# @!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.
|
|
3402
|
+
# The Amazon Resource Name (ARN) of the principal. It can be an IAM
|
|
3403
|
+
# user, IAM role, or the root user. If you specify the root user, it
|
|
3404
|
+
# disables the account setting for all IAM users, IAM roles, and the
|
|
3405
|
+
# root user of the account unless an IAM user or role explicitly
|
|
3406
|
+
# overrides these settings. If this field is omitted, the setting is
|
|
3407
|
+
# changed only for the authenticated user.
|
|
3363
3408
|
# @return [String]
|
|
3364
3409
|
#
|
|
3365
3410
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteAccountSettingRequest AWS API Documentation
|
|
@@ -3406,8 +3451,8 @@ module Aws::ECS
|
|
|
3406
3451
|
#
|
|
3407
3452
|
# @!attribute [rw] attributes
|
|
3408
3453
|
# The attributes to delete from your resource. You can specify up to
|
|
3409
|
-
# 10 attributes
|
|
3410
|
-
# attribute name and target ID, but
|
|
3454
|
+
# 10 attributes for each request. For custom attributes, specify the
|
|
3455
|
+
# attribute name and target ID, but don't specify the value. If you
|
|
3411
3456
|
# specify the target ID using the short form, you must also specify
|
|
3412
3457
|
# the target type.
|
|
3413
3458
|
# @return [Array<Types::Attribute>]
|
|
@@ -3518,9 +3563,9 @@ module Aws::ECS
|
|
|
3518
3563
|
# @return [String]
|
|
3519
3564
|
#
|
|
3520
3565
|
# @!attribute [rw] force
|
|
3521
|
-
# If `true`, allows you to delete a service even if it
|
|
3522
|
-
#
|
|
3523
|
-
#
|
|
3566
|
+
# If `true`, allows you to delete a service even if it wasn't scaled
|
|
3567
|
+
# down to zero tasks. It's only necessary to use this if the service
|
|
3568
|
+
# uses the `REPLICA` scheduling strategy.
|
|
3524
3569
|
# @return [Boolean]
|
|
3525
3570
|
#
|
|
3526
3571
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteServiceRequest AWS API Documentation
|
|
@@ -3557,7 +3602,7 @@ module Aws::ECS
|
|
|
3557
3602
|
#
|
|
3558
3603
|
# @!attribute [rw] cluster
|
|
3559
3604
|
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
3560
|
-
# that hosts the service that the task set
|
|
3605
|
+
# that hosts the service that the task set found in to delete.
|
|
3561
3606
|
# @return [String]
|
|
3562
3607
|
#
|
|
3563
3608
|
# @!attribute [rw] service
|
|
@@ -3571,8 +3616,8 @@ module Aws::ECS
|
|
|
3571
3616
|
# @return [String]
|
|
3572
3617
|
#
|
|
3573
3618
|
# @!attribute [rw] force
|
|
3574
|
-
# If `true`,
|
|
3575
|
-
#
|
|
3619
|
+
# If `true`, you can delete a task set even if it hasn't been scaled
|
|
3620
|
+
# down to zero.
|
|
3576
3621
|
# @return [Boolean]
|
|
3577
3622
|
#
|
|
3578
3623
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteTaskSetRequest AWS API Documentation
|
|
@@ -3606,7 +3651,7 @@ module Aws::ECS
|
|
|
3606
3651
|
# @return [String]
|
|
3607
3652
|
#
|
|
3608
3653
|
# @!attribute [rw] status
|
|
3609
|
-
# The status of the deployment. The following describes each state
|
|
3654
|
+
# The status of the deployment. The following describes each state.
|
|
3610
3655
|
#
|
|
3611
3656
|
# PRIMARY
|
|
3612
3657
|
#
|
|
@@ -3656,11 +3701,13 @@ module Aws::ECS
|
|
|
3656
3701
|
# @return [Integer]
|
|
3657
3702
|
#
|
|
3658
3703
|
# @!attribute [rw] created_at
|
|
3659
|
-
# The Unix timestamp for when the service deployment was
|
|
3704
|
+
# The Unix timestamp for the time when the service deployment was
|
|
3705
|
+
# created.
|
|
3660
3706
|
# @return [Time]
|
|
3661
3707
|
#
|
|
3662
3708
|
# @!attribute [rw] updated_at
|
|
3663
|
-
# The Unix timestamp for when the service deployment was last
|
|
3709
|
+
# The Unix timestamp for the time when the service deployment was last
|
|
3710
|
+
# updated.
|
|
3664
3711
|
# @return [Time]
|
|
3665
3712
|
#
|
|
3666
3713
|
# @!attribute [rw] capacity_provider_strategy
|
|
@@ -3678,18 +3725,26 @@ module Aws::ECS
|
|
|
3678
3725
|
# @return [String]
|
|
3679
3726
|
#
|
|
3680
3727
|
# @!attribute [rw] platform_version
|
|
3681
|
-
# The platform version
|
|
3682
|
-
#
|
|
3683
|
-
# launch type. If one
|
|
3684
|
-
# is used
|
|
3685
|
-
#
|
|
3686
|
-
# Guide*.
|
|
3728
|
+
# The platform version that your tasks in the service run on. A
|
|
3729
|
+
# platform version is only specified for tasks using the Fargate
|
|
3730
|
+
# launch type. If one isn't specified, the `LATEST` platform version
|
|
3731
|
+
# is used. For more information, see [Fargate Platform Versions][1] in
|
|
3732
|
+
# the *Amazon Elastic Container Service Developer Guide*.
|
|
3687
3733
|
#
|
|
3688
3734
|
#
|
|
3689
3735
|
#
|
|
3690
3736
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
|
3691
3737
|
# @return [String]
|
|
3692
3738
|
#
|
|
3739
|
+
# @!attribute [rw] platform_family
|
|
3740
|
+
# The operating system that your tasks in the service, or tasks are
|
|
3741
|
+
# running on. A platform family is specified only for tasks using the
|
|
3742
|
+
# Fargate launch type.
|
|
3743
|
+
#
|
|
3744
|
+
# All tasks that run as part of this service must use the same
|
|
3745
|
+
# `platformFamily` value as the service, for example, ` LINUX.`.
|
|
3746
|
+
# @return [String]
|
|
3747
|
+
#
|
|
3693
3748
|
# @!attribute [rw] network_configuration
|
|
3694
3749
|
# The VPC subnet and security group configuration for tasks that
|
|
3695
3750
|
# receive their own elastic network interface by using the `awsvpc`
|
|
@@ -3698,18 +3753,18 @@ module Aws::ECS
|
|
|
3698
3753
|
#
|
|
3699
3754
|
# @!attribute [rw] rollout_state
|
|
3700
3755
|
# <note markdown="1"> The `rolloutState` of a service is only returned for services that
|
|
3701
|
-
# use the rolling update (`ECS`) deployment type that
|
|
3756
|
+
# use the rolling update (`ECS`) deployment type that aren't behind a
|
|
3702
3757
|
# Classic Load Balancer.
|
|
3703
3758
|
#
|
|
3704
3759
|
# </note>
|
|
3705
3760
|
#
|
|
3706
3761
|
# The rollout state of the deployment. When a service deployment is
|
|
3707
3762
|
# started, it begins in an `IN_PROGRESS` state. When the service
|
|
3708
|
-
# reaches a steady state, the deployment
|
|
3709
|
-
#
|
|
3710
|
-
#
|
|
3711
|
-
#
|
|
3712
|
-
#
|
|
3763
|
+
# reaches a steady state, the deployment transitions to a `COMPLETED`
|
|
3764
|
+
# state. If the service fails to reach a steady state and circuit
|
|
3765
|
+
# breaker is enabled, the deployment transitions to a `FAILED` state.
|
|
3766
|
+
# A deployment in `FAILED` state doesn't launch any new tasks. For
|
|
3767
|
+
# more information, see DeploymentCircuitBreaker.
|
|
3713
3768
|
# @return [String]
|
|
3714
3769
|
#
|
|
3715
3770
|
# @!attribute [rw] rollout_state_reason
|
|
@@ -3731,6 +3786,7 @@ module Aws::ECS
|
|
|
3731
3786
|
:capacity_provider_strategy,
|
|
3732
3787
|
:launch_type,
|
|
3733
3788
|
:platform_version,
|
|
3789
|
+
:platform_family,
|
|
3734
3790
|
:network_configuration,
|
|
3735
3791
|
:rollout_state,
|
|
3736
3792
|
:rollout_state_reason)
|
|
@@ -3739,7 +3795,7 @@ module Aws::ECS
|
|
|
3739
3795
|
end
|
|
3740
3796
|
|
|
3741
3797
|
# <note markdown="1"> The deployment circuit breaker can only be used for services using the
|
|
3742
|
-
# rolling update (`ECS`) deployment type that
|
|
3798
|
+
# rolling update (`ECS`) deployment type that aren't behind a Classic
|
|
3743
3799
|
# Load Balancer.
|
|
3744
3800
|
#
|
|
3745
3801
|
# </note>
|
|
@@ -3765,15 +3821,15 @@ module Aws::ECS
|
|
|
3765
3821
|
# }
|
|
3766
3822
|
#
|
|
3767
3823
|
# @!attribute [rw] enable
|
|
3768
|
-
#
|
|
3769
|
-
# service.
|
|
3824
|
+
# Determines whether to enable the deployment circuit breaker logic
|
|
3825
|
+
# for the service.
|
|
3770
3826
|
# @return [Boolean]
|
|
3771
3827
|
#
|
|
3772
3828
|
# @!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.
|
|
3829
|
+
# Determines whether to enable Amazon ECS to roll back the service if
|
|
3830
|
+
# a service deployment fails. If rollback is enabled, when a service
|
|
3831
|
+
# deployment fails, the service is rolled back to the last deployment
|
|
3832
|
+
# that completed successfully.
|
|
3777
3833
|
# @return [Boolean]
|
|
3778
3834
|
#
|
|
3779
3835
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeploymentCircuitBreaker AWS API Documentation
|
|
@@ -3850,10 +3906,10 @@ module Aws::ECS
|
|
|
3850
3906
|
# service has a desired number of four tasks and a minimum healthy
|
|
3851
3907
|
# percent of 50%, the scheduler may stop two existing tasks to free up
|
|
3852
3908
|
# cluster capacity before starting two new tasks. Tasks for services
|
|
3853
|
-
# that *do not* use a load balancer are considered healthy if they
|
|
3909
|
+
# that *do not* use a load balancer are considered healthy if they're
|
|
3854
3910
|
# in the `RUNNING` state; tasks for services that *do* use a load
|
|
3855
|
-
# balancer are considered healthy if they
|
|
3856
|
-
# and they
|
|
3911
|
+
# balancer are considered healthy if they're in the `RUNNING` state
|
|
3912
|
+
# and they're reported as healthy by the load balancer. The default
|
|
3857
3913
|
# value for minimum healthy percent is 100%.
|
|
3858
3914
|
#
|
|
3859
3915
|
# If a service is using the blue/green (`CODE_DEPLOY`) or `EXTERNAL`
|
|
@@ -3952,13 +4008,13 @@ module Aws::ECS
|
|
|
3952
4008
|
# @return [String]
|
|
3953
4009
|
#
|
|
3954
4010
|
# @!attribute [rw] force
|
|
3955
|
-
# Forces the
|
|
3956
|
-
#
|
|
3957
|
-
#
|
|
3958
|
-
#
|
|
3959
|
-
#
|
|
3960
|
-
#
|
|
3961
|
-
#
|
|
4011
|
+
# Forces the container instance to be deregistered. If you have tasks
|
|
4012
|
+
# running on the container instance when you deregister it with the
|
|
4013
|
+
# `force` option, these tasks remain running until you terminate the
|
|
4014
|
+
# instance or the tasks stop through some other means, but they're
|
|
4015
|
+
# orphaned (no longer monitored or accounted for by Amazon ECS). If an
|
|
4016
|
+
# orphaned task on your container instance is part of an Amazon ECS
|
|
4017
|
+
# service, then the service scheduler starts another copy of that
|
|
3962
4018
|
# task, on a different container instance if possible.
|
|
3963
4019
|
#
|
|
3964
4020
|
# Any containers in orphaned service tasks that are registered with a
|
|
@@ -4041,7 +4097,7 @@ module Aws::ECS
|
|
|
4041
4097
|
# @!attribute [rw] include
|
|
4042
4098
|
# Specifies whether or not you want to see the resource tags for the
|
|
4043
4099
|
# capacity provider. If `TAGS` is specified, the tags are included in
|
|
4044
|
-
# the response. If this field is omitted, tags
|
|
4100
|
+
# the response. If this field is omitted, tags aren't included in the
|
|
4045
4101
|
# response.
|
|
4046
4102
|
# @return [Array<String>]
|
|
4047
4103
|
#
|
|
@@ -4123,9 +4179,9 @@ module Aws::ECS
|
|
|
4123
4179
|
# @return [Array<String>]
|
|
4124
4180
|
#
|
|
4125
4181
|
# @!attribute [rw] include
|
|
4126
|
-
#
|
|
4127
|
-
# response. If this field is omitted, this information
|
|
4128
|
-
# included.
|
|
4182
|
+
# Determines whether to include additional information about the
|
|
4183
|
+
# clusters in the response. If this field is omitted, this information
|
|
4184
|
+
# isn't included.
|
|
4129
4185
|
#
|
|
4130
4186
|
# If `ATTACHMENTS` is specified, the attachments for the container
|
|
4131
4187
|
# instances or tasks within the cluster are included.
|
|
@@ -4175,7 +4231,7 @@ module Aws::ECS
|
|
|
4175
4231
|
# {
|
|
4176
4232
|
# cluster: "String",
|
|
4177
4233
|
# container_instances: ["String"], # required
|
|
4178
|
-
# include: ["TAGS"], # accepts TAGS
|
|
4234
|
+
# include: ["TAGS"], # accepts TAGS, CONTAINER_INSTANCE_HEALTH
|
|
4179
4235
|
# }
|
|
4180
4236
|
#
|
|
4181
4237
|
# @!attribute [rw] cluster
|
|
@@ -4195,8 +4251,10 @@ module Aws::ECS
|
|
|
4195
4251
|
# @!attribute [rw] include
|
|
4196
4252
|
# Specifies whether you want to see the resource tags for the
|
|
4197
4253
|
# container instance. If `TAGS` is specified, the tags are included in
|
|
4198
|
-
# the response. If
|
|
4199
|
-
# response.
|
|
4254
|
+
# the response. If `CONTAINER_INSTANCE_HEALTH` is specified, the
|
|
4255
|
+
# container instance health is included in the response. If this field
|
|
4256
|
+
# is omitted, tags and container instance health status aren't
|
|
4257
|
+
# included in the response.
|
|
4200
4258
|
# @return [Array<String>]
|
|
4201
4259
|
#
|
|
4202
4260
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeContainerInstancesRequest AWS API Documentation
|
|
@@ -4249,9 +4307,10 @@ module Aws::ECS
|
|
|
4249
4307
|
# @return [Array<String>]
|
|
4250
4308
|
#
|
|
4251
4309
|
# @!attribute [rw] include
|
|
4252
|
-
#
|
|
4253
|
-
# If `TAGS` is specified, the tags are included in the
|
|
4254
|
-
# this field is omitted, tags
|
|
4310
|
+
# Determines whether you want to see the resource tags for the
|
|
4311
|
+
# service. If `TAGS` is specified, the tags are included in the
|
|
4312
|
+
# response. If this field is omitted, tags aren't included in the
|
|
4313
|
+
# response.
|
|
4255
4314
|
# @return [Array<String>]
|
|
4256
4315
|
#
|
|
4257
4316
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServicesRequest AWS API Documentation
|
|
@@ -4297,9 +4356,9 @@ module Aws::ECS
|
|
|
4297
4356
|
# @return [String]
|
|
4298
4357
|
#
|
|
4299
4358
|
# @!attribute [rw] include
|
|
4300
|
-
#
|
|
4359
|
+
# Determines whether to see the resource tags for the task definition.
|
|
4301
4360
|
# If `TAGS` is specified, the tags are included in the response. If
|
|
4302
|
-
# this field is omitted, tags
|
|
4361
|
+
# this field is omitted, tags aren't included in the response.
|
|
4303
4362
|
# @return [Array<String>]
|
|
4304
4363
|
#
|
|
4305
4364
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskDefinitionRequest AWS API Documentation
|
|
@@ -4316,9 +4375,9 @@ module Aws::ECS
|
|
|
4316
4375
|
# @return [Types::TaskDefinition]
|
|
4317
4376
|
#
|
|
4318
4377
|
# @!attribute [rw] tags
|
|
4319
|
-
# The metadata that
|
|
4378
|
+
# The metadata that's applied to the task definition to help you
|
|
4320
4379
|
# categorize and organize them. Each tag consists of a key and an
|
|
4321
|
-
# optional value
|
|
4380
|
+
# optional value. You define both.
|
|
4322
4381
|
#
|
|
4323
4382
|
# The following basic restrictions apply to tags:
|
|
4324
4383
|
#
|
|
@@ -4382,7 +4441,7 @@ module Aws::ECS
|
|
|
4382
4441
|
# @!attribute [rw] include
|
|
4383
4442
|
# Specifies whether to see the resource tags for the task set. If
|
|
4384
4443
|
# `TAGS` is specified, the tags are included in the response. If this
|
|
4385
|
-
# field is omitted, tags
|
|
4444
|
+
# field is omitted, tags aren't included in the response.
|
|
4386
4445
|
# @return [Array<String>]
|
|
4387
4446
|
#
|
|
4388
4447
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskSetsRequest AWS API Documentation
|
|
@@ -4437,7 +4496,7 @@ module Aws::ECS
|
|
|
4437
4496
|
# @!attribute [rw] include
|
|
4438
4497
|
# Specifies whether you want to see the resource tags for the task. If
|
|
4439
4498
|
# `TAGS` is specified, the tags are included in the response. If this
|
|
4440
|
-
# field is omitted, tags
|
|
4499
|
+
# field is omitted, tags aren't included in the response.
|
|
4441
4500
|
# @return [Array<String>]
|
|
4442
4501
|
#
|
|
4443
4502
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTasksRequest AWS API Documentation
|
|
@@ -4520,8 +4579,8 @@ module Aws::ECS
|
|
|
4520
4579
|
# @return [String]
|
|
4521
4580
|
#
|
|
4522
4581
|
# @!attribute [rw] cluster
|
|
4523
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
4524
|
-
#
|
|
4582
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
4583
|
+
# that the container instance belongs to.
|
|
4525
4584
|
# @return [String]
|
|
4526
4585
|
#
|
|
4527
4586
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DiscoverPollEndpointRequest AWS API Documentation
|
|
@@ -4550,8 +4609,8 @@ module Aws::ECS
|
|
|
4550
4609
|
include Aws::Structure
|
|
4551
4610
|
end
|
|
4552
4611
|
|
|
4553
|
-
# This parameter is specified when you
|
|
4554
|
-
# volumes are only supported when you
|
|
4612
|
+
# This parameter is specified when you're using Docker volumes. Docker
|
|
4613
|
+
# volumes are only supported when you're using the EC2 launch type.
|
|
4555
4614
|
# Windows containers only support the use of the `local` driver. To use
|
|
4556
4615
|
# bind mounts, specify a `host` instead.
|
|
4557
4616
|
#
|
|
@@ -4579,7 +4638,7 @@ module Aws::ECS
|
|
|
4579
4638
|
# @return [String]
|
|
4580
4639
|
#
|
|
4581
4640
|
# @!attribute [rw] autoprovision
|
|
4582
|
-
# If this value is `true`, the Docker volume is created if it
|
|
4641
|
+
# If this value is `true`, the Docker volume is created if it doesn't
|
|
4583
4642
|
# already exist.
|
|
4584
4643
|
#
|
|
4585
4644
|
# <note markdown="1"> This field is only used if the `scope` is `shared`.
|
|
@@ -4671,12 +4730,13 @@ module Aws::ECS
|
|
|
4671
4730
|
# @return [String]
|
|
4672
4731
|
#
|
|
4673
4732
|
# @!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
|
|
4733
|
+
# Determines whether to use the Amazon ECS task IAM role defined in a
|
|
4734
|
+
# task definition when mounting the Amazon EFS file system. If
|
|
4735
|
+
# enabled, transit encryption must be enabled in the
|
|
4736
|
+
# `EFSVolumeConfiguration`. If this parameter is omitted, the default
|
|
4737
|
+
# value of `DISABLED` is used. For more information, see [Using Amazon
|
|
4738
|
+
# EFS Access Points][1] in the *Amazon Elastic Container Service
|
|
4739
|
+
# Developer Guide*.
|
|
4680
4740
|
#
|
|
4681
4741
|
#
|
|
4682
4742
|
#
|
|
@@ -4692,7 +4752,7 @@ module Aws::ECS
|
|
|
4692
4752
|
include Aws::Structure
|
|
4693
4753
|
end
|
|
4694
4754
|
|
|
4695
|
-
# This parameter is specified when you
|
|
4755
|
+
# This parameter is specified when you're using an Amazon Elastic File
|
|
4696
4756
|
# System file system for task storage. For more information, see [Amazon
|
|
4697
4757
|
# EFS Volumes][1] in the *Amazon Elastic Container Service Developer
|
|
4698
4758
|
# Guide*.
|
|
@@ -4731,12 +4791,12 @@ module Aws::ECS
|
|
|
4731
4791
|
# @return [String]
|
|
4732
4792
|
#
|
|
4733
4793
|
# @!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*.
|
|
4794
|
+
# Determines whether to enable encryption for Amazon EFS data in
|
|
4795
|
+
# transit between the Amazon ECS host and the Amazon EFS server.
|
|
4796
|
+
# Transit encryption must be enabled if Amazon EFS IAM authorization
|
|
4797
|
+
# is used. If this parameter is omitted, the default value of
|
|
4798
|
+
# `DISABLED` is used. For more information, see [Encrypting Data in
|
|
4799
|
+
# Transit][1] in the *Amazon Elastic File System User Guide*.
|
|
4740
4800
|
#
|
|
4741
4801
|
#
|
|
4742
4802
|
#
|
|
@@ -4777,20 +4837,24 @@ module Aws::ECS
|
|
|
4777
4837
|
# have a `.env` file extension. Each line in an environment file should
|
|
4778
4838
|
# contain an environment variable in `VARIABLE=VALUE` format. Lines
|
|
4779
4839
|
# beginning with `#` are treated as comments and are ignored. For more
|
|
4780
|
-
# information
|
|
4840
|
+
# information about the environment variable file syntax, see [Declare
|
|
4781
4841
|
# default environment variables in file][1].
|
|
4782
4842
|
#
|
|
4783
4843
|
# If there are environment variables specified using the `environment`
|
|
4784
4844
|
# parameter in a container definition, they take precedence over the
|
|
4785
4845
|
# variables contained within an environment file. If multiple
|
|
4786
|
-
# environment files are specified that contain the same variable,
|
|
4787
|
-
#
|
|
4846
|
+
# environment files are specified that contain the same variable,
|
|
4847
|
+
# they're processed from the top down. We recommend that you use unique
|
|
4788
4848
|
# variable names. For more information, see [Specifying environment
|
|
4789
4849
|
# variables][2] in the *Amazon Elastic Container Service Developer
|
|
4790
4850
|
# Guide*.
|
|
4791
4851
|
#
|
|
4792
|
-
# This
|
|
4793
|
-
# platform
|
|
4852
|
+
# This parameter is only supported for tasks hosted on Fargate using the
|
|
4853
|
+
# following platform versions:
|
|
4854
|
+
#
|
|
4855
|
+
# * Linux platform version `1.4.0` or later.
|
|
4856
|
+
#
|
|
4857
|
+
# * Windows platform version `1.0.0` or later.
|
|
4794
4858
|
#
|
|
4795
4859
|
#
|
|
4796
4860
|
#
|
|
@@ -4829,8 +4893,12 @@ module Aws::ECS
|
|
|
4829
4893
|
# more information, see [Fargate task storage][1] in the *Amazon ECS
|
|
4830
4894
|
# User Guide for Fargate*.
|
|
4831
4895
|
#
|
|
4832
|
-
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
|
|
4833
|
-
# platform
|
|
4896
|
+
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using the
|
|
4897
|
+
# following platform versions:
|
|
4898
|
+
#
|
|
4899
|
+
# * Linux platform version `1.4.0` or later.
|
|
4900
|
+
#
|
|
4901
|
+
# * Windows platform version `1.0.0` or later.
|
|
4834
4902
|
#
|
|
4835
4903
|
# </note>
|
|
4836
4904
|
#
|
|
@@ -4937,8 +5005,8 @@ module Aws::ECS
|
|
|
4937
5005
|
# @return [String]
|
|
4938
5006
|
#
|
|
4939
5007
|
# @!attribute [rw] cloud_watch_encryption_enabled
|
|
4940
|
-
#
|
|
4941
|
-
# specified, encryption will be disabled.
|
|
5008
|
+
# Determines whether to enable encryption on the CloudWatch logs. If
|
|
5009
|
+
# not specified, encryption will be disabled.
|
|
4942
5010
|
# @return [Boolean]
|
|
4943
5011
|
#
|
|
4944
5012
|
# @!attribute [rw] s3_bucket_name
|
|
@@ -4950,8 +5018,8 @@ module Aws::ECS
|
|
|
4950
5018
|
# @return [String]
|
|
4951
5019
|
#
|
|
4952
5020
|
# @!attribute [rw] s3_encryption_enabled
|
|
4953
|
-
#
|
|
4954
|
-
# specified, encryption
|
|
5021
|
+
# Determines whether to use encryption on the S3 logs. If not
|
|
5022
|
+
# specified, encryption is not used.
|
|
4955
5023
|
# @return [Boolean]
|
|
4956
5024
|
#
|
|
4957
5025
|
# @!attribute [rw] s3_key_prefix
|
|
@@ -5031,9 +5099,9 @@ module Aws::ECS
|
|
|
5031
5099
|
# @return [String]
|
|
5032
5100
|
#
|
|
5033
5101
|
# @!attribute [rw] interactive
|
|
5034
|
-
#
|
|
5035
|
-
# mode. Amazon ECS only supports initiating interactive
|
|
5036
|
-
# you must specify `true` for this value.
|
|
5102
|
+
# Determines whether the execute command session is running in
|
|
5103
|
+
# interactive mode. Amazon ECS only supports initiating interactive
|
|
5104
|
+
# sessions, so you must specify `true` for this value.
|
|
5037
5105
|
# @return [Boolean]
|
|
5038
5106
|
#
|
|
5039
5107
|
# @!attribute [rw] session
|
|
@@ -5106,7 +5174,7 @@ module Aws::ECS
|
|
|
5106
5174
|
include Aws::Structure
|
|
5107
5175
|
end
|
|
5108
5176
|
|
|
5109
|
-
# This parameter is specified when you
|
|
5177
|
+
# This parameter is specified when you're using [Amazon FSx for Windows
|
|
5110
5178
|
# File Server][1] file system for task storage.
|
|
5111
5179
|
#
|
|
5112
5180
|
# For more information and the input format, see [Amazon FSx for Windows
|
|
@@ -5253,7 +5321,7 @@ module Aws::ECS
|
|
|
5253
5321
|
#
|
|
5254
5322
|
# * `UNHEALTHY`-The container health check has failed.
|
|
5255
5323
|
#
|
|
5256
|
-
# * `UNKNOWN`-The container health check is being evaluated or there
|
|
5324
|
+
# * `UNKNOWN`-The container health check is being evaluated or there's
|
|
5257
5325
|
# no container health check defined.
|
|
5258
5326
|
#
|
|
5259
5327
|
# The following describes the possible `healthStatus` values for a task.
|
|
@@ -5281,12 +5349,12 @@ module Aws::ECS
|
|
|
5281
5349
|
# Amazon ECS container agent. For more information, see [Updating the
|
|
5282
5350
|
# Amazon ECS Container Agent][1].
|
|
5283
5351
|
#
|
|
5284
|
-
# * Container health checks are supported for Fargate tasks if you
|
|
5352
|
+
# * Container health checks are supported for Fargate tasks if you're
|
|
5285
5353
|
# using platform version 1.1.0 or greater. For more information, see
|
|
5286
5354
|
# [Fargate Platform Versions][2].
|
|
5287
5355
|
#
|
|
5288
|
-
# * Container health checks
|
|
5289
|
-
# a service that
|
|
5356
|
+
# * Container health checks aren't supported for tasks that are part of
|
|
5357
|
+
# a service that's configured to use a Classic Load Balancer.
|
|
5290
5358
|
#
|
|
5291
5359
|
#
|
|
5292
5360
|
#
|
|
@@ -5311,13 +5379,13 @@ module Aws::ECS
|
|
|
5311
5379
|
# command with the container's default shell.
|
|
5312
5380
|
#
|
|
5313
5381
|
# When you use the Amazon Web Services Management Console JSON panel,
|
|
5314
|
-
# the Command Line Interface, or the APIs,
|
|
5315
|
-
#
|
|
5382
|
+
# the Command Line Interface, or the APIs, enclose the list of
|
|
5383
|
+
# commands in brackets.
|
|
5316
5384
|
#
|
|
5317
5385
|
# `[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]`
|
|
5318
5386
|
#
|
|
5319
|
-
# You
|
|
5320
|
-
# Services Management
|
|
5387
|
+
# You don't need to include the brackets when you use the Amazon Web
|
|
5388
|
+
# Services Management Console.
|
|
5321
5389
|
#
|
|
5322
5390
|
# ` "CMD-SHELL", "curl -f http://localhost/ || exit 1" `
|
|
5323
5391
|
#
|
|
@@ -5350,10 +5418,10 @@ module Aws::ECS
|
|
|
5350
5418
|
# @return [Integer]
|
|
5351
5419
|
#
|
|
5352
5420
|
# @!attribute [rw] start_period
|
|
5353
|
-
# The optional grace period
|
|
5354
|
-
#
|
|
5355
|
-
#
|
|
5356
|
-
# `startPeriod` is disabled
|
|
5421
|
+
# The optional grace period to provide containers time to bootstrap
|
|
5422
|
+
# before failed health checks count towards the maximum number of
|
|
5423
|
+
# retries. You can specify between 0 and 300 seconds. By default, the
|
|
5424
|
+
# `startPeriod` is disabled.
|
|
5357
5425
|
#
|
|
5358
5426
|
# <note markdown="1"> If a health check succeeds within the `startPeriod`, then the
|
|
5359
5427
|
# container is considered healthy and any subsequent failures count
|
|
@@ -5414,16 +5482,16 @@ module Aws::ECS
|
|
|
5414
5482
|
#
|
|
5415
5483
|
# @!attribute [rw] source_path
|
|
5416
5484
|
# When the `host` parameter is used, specify a `sourcePath` to declare
|
|
5417
|
-
# the path on the host container instance that
|
|
5485
|
+
# the path on the host container instance that's presented to the
|
|
5418
5486
|
# container. If this parameter is empty, then the Docker daemon has
|
|
5419
5487
|
# assigned a host path for you. If the `host` parameter contains a
|
|
5420
5488
|
# `sourcePath` file location, then the data volume persists at the
|
|
5421
5489
|
# specified location on the host container instance until you delete
|
|
5422
|
-
# it manually. If the `sourcePath` value
|
|
5490
|
+
# it manually. If the `sourcePath` value doesn't exist on the host
|
|
5423
5491
|
# container instance, the Docker daemon creates it. If the location
|
|
5424
5492
|
# does exist, the contents of the source path folder are exported.
|
|
5425
5493
|
#
|
|
5426
|
-
# If you
|
|
5494
|
+
# If you're using the Fargate launch type, the `sourcePath` parameter
|
|
5427
5495
|
# is not supported.
|
|
5428
5496
|
# @return [String]
|
|
5429
5497
|
#
|
|
@@ -5435,7 +5503,7 @@ module Aws::ECS
|
|
|
5435
5503
|
include Aws::Structure
|
|
5436
5504
|
end
|
|
5437
5505
|
|
|
5438
|
-
# Details on
|
|
5506
|
+
# Details on an Elastic Inference accelerator. For more information, see
|
|
5439
5507
|
# [Working with Amazon Elastic Inference on Amazon ECS][1] in the
|
|
5440
5508
|
# *Amazon Elastic Container Service Developer Guide*.
|
|
5441
5509
|
#
|
|
@@ -5507,7 +5575,39 @@ module Aws::ECS
|
|
|
5507
5575
|
include Aws::Structure
|
|
5508
5576
|
end
|
|
5509
5577
|
|
|
5510
|
-
#
|
|
5578
|
+
# An object representing the result of a container instance health
|
|
5579
|
+
# status check.
|
|
5580
|
+
#
|
|
5581
|
+
# @!attribute [rw] type
|
|
5582
|
+
# The type of container instance health status that was verified.
|
|
5583
|
+
# @return [String]
|
|
5584
|
+
#
|
|
5585
|
+
# @!attribute [rw] status
|
|
5586
|
+
# The container instance health status.
|
|
5587
|
+
# @return [String]
|
|
5588
|
+
#
|
|
5589
|
+
# @!attribute [rw] last_updated
|
|
5590
|
+
# The Unix timestamp for when the container instance health status was
|
|
5591
|
+
# last updated.
|
|
5592
|
+
# @return [Time]
|
|
5593
|
+
#
|
|
5594
|
+
# @!attribute [rw] last_status_change
|
|
5595
|
+
# The Unix timestamp for when the container instance health status
|
|
5596
|
+
# last changed.
|
|
5597
|
+
# @return [Time]
|
|
5598
|
+
#
|
|
5599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/InstanceHealthCheckResult AWS API Documentation
|
|
5600
|
+
#
|
|
5601
|
+
class InstanceHealthCheckResult < Struct.new(
|
|
5602
|
+
:type,
|
|
5603
|
+
:status,
|
|
5604
|
+
:last_updated,
|
|
5605
|
+
:last_status_change)
|
|
5606
|
+
SENSITIVE = []
|
|
5607
|
+
include Aws::Structure
|
|
5608
|
+
end
|
|
5609
|
+
|
|
5610
|
+
# The specified parameter isn't valid. Review the available parameters
|
|
5511
5611
|
# for the API request.
|
|
5512
5612
|
#
|
|
5513
5613
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/InvalidParameterException AWS API Documentation
|
|
@@ -5516,10 +5616,11 @@ module Aws::ECS
|
|
|
5516
5616
|
|
|
5517
5617
|
# The Linux capabilities for the container that are added to or dropped
|
|
5518
5618
|
# 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
|
|
5619
|
+
# information about the default capabilities and the non-default
|
|
5620
|
+
# available capabilities, see [Runtime privilege and Linux
|
|
5621
|
+
# capabilities][1] in the *Docker run reference*. For more detailed
|
|
5622
|
+
# information about these Linux capabilities, see the
|
|
5623
|
+
# [capabilities(7)][2] Linux manual page.
|
|
5523
5624
|
#
|
|
5524
5625
|
#
|
|
5525
5626
|
#
|
|
@@ -5623,7 +5724,7 @@ module Aws::ECS
|
|
|
5623
5724
|
include Aws::Structure
|
|
5624
5725
|
end
|
|
5625
5726
|
|
|
5626
|
-
# The limit for the resource
|
|
5727
|
+
# The limit for the resource was exceeded.
|
|
5627
5728
|
#
|
|
5628
5729
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/LimitExceededException AWS API Documentation
|
|
5629
5730
|
#
|
|
@@ -5676,8 +5777,8 @@ module Aws::ECS
|
|
|
5676
5777
|
# `Devices` in the [Create a container][1] section of the [Docker
|
|
5677
5778
|
# Remote API][2] and the `--device` option to [docker run][3].
|
|
5678
5779
|
#
|
|
5679
|
-
# <note markdown="1"> If you
|
|
5680
|
-
# `devices` parameter
|
|
5780
|
+
# <note markdown="1"> If you're using tasks that use the Fargate launch type, the
|
|
5781
|
+
# `devices` parameter isn't supported.
|
|
5681
5782
|
#
|
|
5682
5783
|
# </note>
|
|
5683
5784
|
#
|
|
@@ -5721,8 +5822,8 @@ module Aws::ECS
|
|
|
5721
5822
|
# mount. This parameter maps to the `--tmpfs` option to [docker
|
|
5722
5823
|
# run][1].
|
|
5723
5824
|
#
|
|
5724
|
-
# <note markdown="1"> If you
|
|
5725
|
-
# parameter
|
|
5825
|
+
# <note markdown="1"> If you're using tasks that use the Fargate launch type, the `tmpfs`
|
|
5826
|
+
# parameter isn't supported.
|
|
5726
5827
|
#
|
|
5727
5828
|
# </note>
|
|
5728
5829
|
#
|
|
@@ -5744,8 +5845,8 @@ module Aws::ECS
|
|
|
5744
5845
|
# `maxSwap` value must be set for the `swappiness` parameter to be
|
|
5745
5846
|
# used.
|
|
5746
5847
|
#
|
|
5747
|
-
# <note markdown="1"> If you
|
|
5748
|
-
# `maxSwap` parameter
|
|
5848
|
+
# <note markdown="1"> If you're using tasks that use the Fargate launch type, the
|
|
5849
|
+
# `maxSwap` parameter isn't supported.
|
|
5749
5850
|
#
|
|
5750
5851
|
# </note>
|
|
5751
5852
|
#
|
|
@@ -5765,8 +5866,8 @@ module Aws::ECS
|
|
|
5765
5866
|
# parameter maps to the `--memory-swappiness` option to [docker
|
|
5766
5867
|
# run][1].
|
|
5767
5868
|
#
|
|
5768
|
-
# <note markdown="1"> If you
|
|
5769
|
-
# `swappiness` parameter
|
|
5869
|
+
# <note markdown="1"> If you're using tasks that use the Fargate launch type, the
|
|
5870
|
+
# `swappiness` parameter isn't supported.
|
|
5770
5871
|
#
|
|
5771
5872
|
# </note>
|
|
5772
5873
|
#
|
|
@@ -5806,8 +5907,8 @@ module Aws::ECS
|
|
|
5806
5907
|
# @return [String]
|
|
5807
5908
|
#
|
|
5808
5909
|
# @!attribute [rw] value
|
|
5809
|
-
# The value of the account settings
|
|
5810
|
-
#
|
|
5910
|
+
# The value of the account settings to filter results with. You must
|
|
5911
|
+
# also specify an account setting name to use this parameter.
|
|
5811
5912
|
# @return [String]
|
|
5812
5913
|
#
|
|
5813
5914
|
# @!attribute [rw] principal_arn
|
|
@@ -5822,18 +5923,18 @@ module Aws::ECS
|
|
|
5822
5923
|
# @return [String]
|
|
5823
5924
|
#
|
|
5824
5925
|
# @!attribute [rw] effective_settings
|
|
5825
|
-
#
|
|
5926
|
+
# Determines whether to return the effective settings. If `true`, the
|
|
5826
5927
|
# account settings for the root user or the default setting for the
|
|
5827
5928
|
# `principalArn` are returned. If `false`, the account settings for
|
|
5828
|
-
# the `principalArn` are returned if they
|
|
5929
|
+
# the `principalArn` are returned if they're set. Otherwise, no
|
|
5829
5930
|
# account settings are returned.
|
|
5830
5931
|
# @return [Boolean]
|
|
5831
5932
|
#
|
|
5832
5933
|
# @!attribute [rw] next_token
|
|
5833
5934
|
# The `nextToken` value returned from a `ListAccountSettings` request
|
|
5834
5935
|
# indicating that more results are available to fulfill the request
|
|
5835
|
-
# and further calls will be needed. If `maxResults` was provided,
|
|
5836
|
-
#
|
|
5936
|
+
# and further calls will be needed. If `maxResults` was provided,
|
|
5937
|
+
# it's possible the number of results to be fewer than `maxResults`.
|
|
5837
5938
|
#
|
|
5838
5939
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only
|
|
5839
5940
|
# used to retrieve the next items in a list and not for other
|
|
@@ -5849,7 +5950,7 @@ module Aws::ECS
|
|
|
5849
5950
|
# single page along with a `nextToken` response element. The remaining
|
|
5850
5951
|
# results of the initial request can be seen by sending another
|
|
5851
5952
|
# `ListAccountSettings` request with the returned `nextToken` value.
|
|
5852
|
-
# This value can be between 1 and 10. If this parameter
|
|
5953
|
+
# This value can be between 1 and 10. If this parameter isn't used,
|
|
5853
5954
|
# then `ListAccountSettings` returns up to 10 results and a
|
|
5854
5955
|
# `nextToken` value if applicable.
|
|
5855
5956
|
# @return [Integer]
|
|
@@ -5907,23 +6008,23 @@ module Aws::ECS
|
|
|
5907
6008
|
# @return [String]
|
|
5908
6009
|
#
|
|
5909
6010
|
# @!attribute [rw] target_type
|
|
5910
|
-
# The type of the target
|
|
6011
|
+
# The type of the target to list attributes with.
|
|
5911
6012
|
# @return [String]
|
|
5912
6013
|
#
|
|
5913
6014
|
# @!attribute [rw] attribute_name
|
|
5914
|
-
# The name of the attribute
|
|
6015
|
+
# The name of the attribute to filter the results with.
|
|
5915
6016
|
# @return [String]
|
|
5916
6017
|
#
|
|
5917
6018
|
# @!attribute [rw] attribute_value
|
|
5918
|
-
# The value of the attribute
|
|
5919
|
-
#
|
|
6019
|
+
# The value of the attribute to filter results with. You must also
|
|
6020
|
+
# specify an attribute name to use this parameter.
|
|
5920
6021
|
# @return [String]
|
|
5921
6022
|
#
|
|
5922
6023
|
# @!attribute [rw] next_token
|
|
5923
6024
|
# The `nextToken` value returned from a `ListAttributes` request
|
|
5924
6025
|
# indicating that more results are available to fulfill the request
|
|
5925
|
-
# and further calls
|
|
5926
|
-
#
|
|
6026
|
+
# and further calls are needed. If `maxResults` was provided, it's
|
|
6027
|
+
# possible the number of results to be fewer than `maxResults`.
|
|
5927
6028
|
#
|
|
5928
6029
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only
|
|
5929
6030
|
# used to retrieve the next items in a list and not for other
|
|
@@ -5933,13 +6034,13 @@ module Aws::ECS
|
|
|
5933
6034
|
# @return [String]
|
|
5934
6035
|
#
|
|
5935
6036
|
# @!attribute [rw] max_results
|
|
5936
|
-
# The maximum number of cluster results
|
|
6037
|
+
# The maximum number of cluster results that `ListAttributes` returned
|
|
5937
6038
|
# in paginated output. When this parameter is used, `ListAttributes`
|
|
5938
6039
|
# only returns `maxResults` results in a single page along with a
|
|
5939
6040
|
# `nextToken` response element. The remaining results of the initial
|
|
5940
6041
|
# request can be seen by sending another `ListAttributes` request with
|
|
5941
6042
|
# the returned `nextToken` value. This value can be between 1 and 100.
|
|
5942
|
-
# If this parameter
|
|
6043
|
+
# If this parameter isn't used, then `ListAttributes` returns up to
|
|
5943
6044
|
# 100 results and a `nextToken` value if applicable.
|
|
5944
6045
|
# @return [Integer]
|
|
5945
6046
|
#
|
|
@@ -5988,8 +6089,8 @@ module Aws::ECS
|
|
|
5988
6089
|
# @!attribute [rw] next_token
|
|
5989
6090
|
# The `nextToken` value returned from a `ListClusters` request
|
|
5990
6091
|
# indicating that more results are available to fulfill the request
|
|
5991
|
-
# and further calls
|
|
5992
|
-
#
|
|
6092
|
+
# and further calls are needed. If `maxResults` was provided, it's
|
|
6093
|
+
# possible the number of results to be fewer than `maxResults`.
|
|
5993
6094
|
#
|
|
5994
6095
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only
|
|
5995
6096
|
# used to retrieve the next items in a list and not for other
|
|
@@ -5999,13 +6100,13 @@ module Aws::ECS
|
|
|
5999
6100
|
# @return [String]
|
|
6000
6101
|
#
|
|
6001
6102
|
# @!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
|
|
6103
|
+
# The maximum number of cluster results that `ListClusters` returned
|
|
6104
|
+
# in paginated output. When this parameter is used, `ListClusters`
|
|
6105
|
+
# only returns `maxResults` results in a single page along with a
|
|
6005
6106
|
# `nextToken` response element. The remaining results of the initial
|
|
6006
6107
|
# request can be seen by sending another `ListClusters` request with
|
|
6007
6108
|
# the returned `nextToken` value. This value can be between 1 and 100.
|
|
6008
|
-
# If this parameter
|
|
6109
|
+
# If this parameter isn't used, then `ListClusters` returns up to 100
|
|
6009
6110
|
# results and a `nextToken` value if applicable.
|
|
6010
6111
|
# @return [Integer]
|
|
6011
6112
|
#
|
|
@@ -6020,7 +6121,7 @@ module Aws::ECS
|
|
|
6020
6121
|
|
|
6021
6122
|
# @!attribute [rw] cluster_arns
|
|
6022
6123
|
# The list of full Amazon Resource Name (ARN) entries for each cluster
|
|
6023
|
-
# associated with your account.
|
|
6124
|
+
# that's associated with your account.
|
|
6024
6125
|
# @return [Array<String>]
|
|
6025
6126
|
#
|
|
6026
6127
|
# @!attribute [rw] next_token
|
|
@@ -6070,9 +6171,8 @@ module Aws::ECS
|
|
|
6070
6171
|
# @!attribute [rw] next_token
|
|
6071
6172
|
# The `nextToken` value returned from a `ListContainerInstances`
|
|
6072
6173
|
# request indicating that more results are available to fulfill the
|
|
6073
|
-
# request and further calls
|
|
6074
|
-
#
|
|
6075
|
-
# `maxResults`.
|
|
6174
|
+
# request and further calls are needed. If `maxResults` was provided,
|
|
6175
|
+
# it's possible the number of results to be fewer than `maxResults`.
|
|
6076
6176
|
#
|
|
6077
6177
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only
|
|
6078
6178
|
# used to retrieve the next items in a list and not for other
|
|
@@ -6082,22 +6182,22 @@ module Aws::ECS
|
|
|
6082
6182
|
# @return [String]
|
|
6083
6183
|
#
|
|
6084
6184
|
# @!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.
|
|
6185
|
+
# The maximum number of container instance results that
|
|
6186
|
+
# `ListContainerInstances` returned in paginated output. When this
|
|
6187
|
+
# parameter is used, `ListContainerInstances` only returns
|
|
6188
|
+
# `maxResults` results in a single page along with a `nextToken`
|
|
6189
|
+
# response element. The remaining results of the initial request can
|
|
6190
|
+
# be seen by sending another `ListContainerInstances` request with the
|
|
6191
|
+
# returned `nextToken` value. This value can be between 1 and 100. If
|
|
6192
|
+
# this parameter isn't used, then `ListContainerInstances` returns up
|
|
6193
|
+
# to 100 results and a `nextToken` value if applicable.
|
|
6094
6194
|
# @return [Integer]
|
|
6095
6195
|
#
|
|
6096
6196
|
# @!attribute [rw] status
|
|
6097
6197
|
# Filters the container instances by status. For example, if you
|
|
6098
6198
|
# specify the `DRAINING` status, the results include only container
|
|
6099
6199
|
# instances that have been set to `DRAINING` using
|
|
6100
|
-
# UpdateContainerInstancesState. If you
|
|
6200
|
+
# UpdateContainerInstancesState. If you don't specify this parameter,
|
|
6101
6201
|
# the default is to include container instances set to all states
|
|
6102
6202
|
# other than `INACTIVE`.
|
|
6103
6203
|
# @return [String]
|
|
@@ -6167,13 +6267,13 @@ module Aws::ECS
|
|
|
6167
6267
|
# @return [String]
|
|
6168
6268
|
#
|
|
6169
6269
|
# @!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
|
|
6270
|
+
# The maximum number of service results that `ListServices` returned
|
|
6271
|
+
# in paginated output. When this parameter is used, `ListServices`
|
|
6272
|
+
# only returns `maxResults` results in a single page along with a
|
|
6173
6273
|
# `nextToken` response element. The remaining results of the initial
|
|
6174
6274
|
# request can be seen by sending another `ListServices` request with
|
|
6175
6275
|
# the returned `nextToken` value. This value can be between 1 and 100.
|
|
6176
|
-
# If this parameter
|
|
6276
|
+
# If this parameter isn't used, then `ListServices` returns up to 10
|
|
6177
6277
|
# results and a `nextToken` value if applicable.
|
|
6178
6278
|
# @return [Integer]
|
|
6179
6279
|
#
|
|
@@ -6199,8 +6299,8 @@ module Aws::ECS
|
|
|
6199
6299
|
end
|
|
6200
6300
|
|
|
6201
6301
|
# @!attribute [rw] service_arns
|
|
6202
|
-
# The list of full ARN entries for each service associated
|
|
6203
|
-
# specified cluster.
|
|
6302
|
+
# The list of full ARN entries for each service that's associated
|
|
6303
|
+
# with the specified cluster.
|
|
6204
6304
|
# @return [Array<String>]
|
|
6205
6305
|
#
|
|
6206
6306
|
# @!attribute [rw] next_token
|
|
@@ -6227,10 +6327,10 @@ module Aws::ECS
|
|
|
6227
6327
|
# }
|
|
6228
6328
|
#
|
|
6229
6329
|
# @!attribute [rw] resource_arn
|
|
6230
|
-
# The Amazon Resource Name (ARN) that identifies the resource
|
|
6231
|
-
#
|
|
6232
|
-
#
|
|
6233
|
-
#
|
|
6330
|
+
# The Amazon Resource Name (ARN) that identifies the resource to list
|
|
6331
|
+
# the tags for. Currently, the supported resources are Amazon ECS
|
|
6332
|
+
# tasks, services, task definitions, clusters, and container
|
|
6333
|
+
# instances.
|
|
6234
6334
|
# @return [String]
|
|
6235
6335
|
#
|
|
6236
6336
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTagsForResourceRequest AWS API Documentation
|
|
@@ -6264,22 +6364,22 @@ module Aws::ECS
|
|
|
6264
6364
|
# }
|
|
6265
6365
|
#
|
|
6266
6366
|
# @!attribute [rw] family_prefix
|
|
6267
|
-
# The `familyPrefix` is a string that
|
|
6367
|
+
# The `familyPrefix` is a string that's used to filter the results of
|
|
6268
6368
|
# `ListTaskDefinitionFamilies`. If you specify a `familyPrefix`, only
|
|
6269
6369
|
# task definition family names that begin with the `familyPrefix`
|
|
6270
6370
|
# string are returned.
|
|
6271
6371
|
# @return [String]
|
|
6272
6372
|
#
|
|
6273
6373
|
# @!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.
|
|
6374
|
+
# The task definition family status to filter the
|
|
6375
|
+
# `ListTaskDefinitionFamilies` results with. By default, both `ACTIVE`
|
|
6376
|
+
# and `INACTIVE` task definition families are listed. If this
|
|
6377
|
+
# parameter is set to `ACTIVE`, only task definition families that
|
|
6378
|
+
# have an `ACTIVE` task definition revision are returned. If this
|
|
6379
|
+
# parameter is set to `INACTIVE`, only task definition families that
|
|
6380
|
+
# do not have any `ACTIVE` task definition revisions are returned. If
|
|
6381
|
+
# you paginate the resulting output, be sure to keep the `status`
|
|
6382
|
+
# value constant in each subsequent request.
|
|
6283
6383
|
# @return [String]
|
|
6284
6384
|
#
|
|
6285
6385
|
# @!attribute [rw] next_token
|
|
@@ -6297,14 +6397,14 @@ module Aws::ECS
|
|
|
6297
6397
|
# @return [String]
|
|
6298
6398
|
#
|
|
6299
6399
|
# @!attribute [rw] max_results
|
|
6300
|
-
# The maximum number of task definition family results
|
|
6301
|
-
# `ListTaskDefinitionFamilies` in paginated output. When this
|
|
6400
|
+
# The maximum number of task definition family results that
|
|
6401
|
+
# `ListTaskDefinitionFamilies` returned in paginated output. When this
|
|
6302
6402
|
# parameter is used, `ListTaskDefinitions` only returns `maxResults`
|
|
6303
6403
|
# results in a single page along with a `nextToken` response element.
|
|
6304
6404
|
# The remaining results of the initial request can be seen by sending
|
|
6305
6405
|
# another `ListTaskDefinitionFamilies` request with the returned
|
|
6306
6406
|
# `nextToken` value. This value can be between 1 and 100. If this
|
|
6307
|
-
# parameter
|
|
6407
|
+
# parameter isn't used, then `ListTaskDefinitionFamilies` returns up
|
|
6308
6408
|
# to 100 results and a `nextToken` value if applicable.
|
|
6309
6409
|
# @return [Integer]
|
|
6310
6410
|
#
|
|
@@ -6353,29 +6453,28 @@ module Aws::ECS
|
|
|
6353
6453
|
# }
|
|
6354
6454
|
#
|
|
6355
6455
|
# @!attribute [rw] family_prefix
|
|
6356
|
-
# The full family name
|
|
6357
|
-
#
|
|
6358
|
-
#
|
|
6456
|
+
# The full family name to filter the `ListTaskDefinitions` results
|
|
6457
|
+
# with. Specifying a `familyPrefix` limits the listed task definitions
|
|
6458
|
+
# to task definition revisions that belong to that family.
|
|
6359
6459
|
# @return [String]
|
|
6360
6460
|
#
|
|
6361
6461
|
# @!attribute [rw] status
|
|
6362
|
-
# The task definition status
|
|
6363
|
-
#
|
|
6364
|
-
#
|
|
6365
|
-
#
|
|
6366
|
-
#
|
|
6367
|
-
#
|
|
6368
|
-
# subsequent request.
|
|
6462
|
+
# The task definition status to filter the `ListTaskDefinitions`
|
|
6463
|
+
# results with. By default, only `ACTIVE` task definitions are listed.
|
|
6464
|
+
# By setting this parameter to `INACTIVE`, you can view task
|
|
6465
|
+
# definitions that are `INACTIVE` as long as an active task or service
|
|
6466
|
+
# still references them. If you paginate the resulting output, be sure
|
|
6467
|
+
# to keep the `status` value constant in each subsequent request.
|
|
6369
6468
|
# @return [String]
|
|
6370
6469
|
#
|
|
6371
6470
|
# @!attribute [rw] sort
|
|
6372
|
-
# The order
|
|
6373
|
-
#
|
|
6374
|
-
#
|
|
6375
|
-
#
|
|
6376
|
-
#
|
|
6377
|
-
#
|
|
6378
|
-
#
|
|
6471
|
+
# The order to sort the results in. Valid values are `ASC` and `DESC`.
|
|
6472
|
+
# By default, (`ASC`) task definitions are listed lexicographically by
|
|
6473
|
+
# family name and in ascending numerical order by revision so that the
|
|
6474
|
+
# newest task definitions in a family are listed last. Setting this
|
|
6475
|
+
# parameter to `DESC` reverses the sort order on family name and
|
|
6476
|
+
# revision. This is so that the newest task definitions in a family
|
|
6477
|
+
# are listed first.
|
|
6379
6478
|
# @return [String]
|
|
6380
6479
|
#
|
|
6381
6480
|
# @!attribute [rw] next_token
|
|
@@ -6392,14 +6491,14 @@ module Aws::ECS
|
|
|
6392
6491
|
# @return [String]
|
|
6393
6492
|
#
|
|
6394
6493
|
# @!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
|
|
6494
|
+
# The maximum number of task definition results that
|
|
6495
|
+
# `ListTaskDefinitions` returned in paginated output. When this
|
|
6496
|
+
# parameter is used, `ListTaskDefinitions` only returns `maxResults`
|
|
6497
|
+
# results in a single page along with a `nextToken` response element.
|
|
6498
|
+
# The remaining results of the initial request can be seen by sending
|
|
6499
|
+
# another `ListTaskDefinitions` request with the returned `nextToken`
|
|
6500
|
+
# value. This value can be between 1 and 100. If this parameter isn't
|
|
6501
|
+
# used, then `ListTaskDefinitions` returns up to 100 results and a
|
|
6403
6502
|
# `nextToken` value if applicable.
|
|
6404
6503
|
# @return [Integer]
|
|
6405
6504
|
#
|
|
@@ -6474,7 +6573,7 @@ module Aws::ECS
|
|
|
6474
6573
|
# @!attribute [rw] next_token
|
|
6475
6574
|
# The `nextToken` value returned from a `ListTasks` request indicating
|
|
6476
6575
|
# that more results are available to fulfill the request and further
|
|
6477
|
-
# calls will be needed. If `maxResults` was provided, it
|
|
6576
|
+
# calls will be needed. If `maxResults` was provided, it's possible
|
|
6478
6577
|
# the number of results to be fewer than `maxResults`.
|
|
6479
6578
|
#
|
|
6480
6579
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only
|
|
@@ -6485,20 +6584,20 @@ module Aws::ECS
|
|
|
6485
6584
|
# @return [String]
|
|
6486
6585
|
#
|
|
6487
6586
|
# @!attribute [rw] max_results
|
|
6488
|
-
# The maximum number of task results
|
|
6587
|
+
# The maximum number of task results that `ListTasks` returned in
|
|
6489
6588
|
# paginated output. When this parameter is used, `ListTasks` only
|
|
6490
6589
|
# returns `maxResults` results in a single page along with a
|
|
6491
6590
|
# `nextToken` response element. The remaining results of the initial
|
|
6492
6591
|
# request can be seen by sending another `ListTasks` request with the
|
|
6493
6592
|
# returned `nextToken` value. This value can be between 1 and 100. If
|
|
6494
|
-
# this parameter
|
|
6593
|
+
# this parameter isn't used, then `ListTasks` returns up to 100
|
|
6495
6594
|
# results and a `nextToken` value if applicable.
|
|
6496
6595
|
# @return [Integer]
|
|
6497
6596
|
#
|
|
6498
6597
|
# @!attribute [rw] started_by
|
|
6499
|
-
# The `startedBy` value
|
|
6500
|
-
#
|
|
6501
|
-
#
|
|
6598
|
+
# The `startedBy` value to filter the task results with. Specifying a
|
|
6599
|
+
# `startedBy` value limits the results to tasks that were started with
|
|
6600
|
+
# that value.
|
|
6502
6601
|
# @return [String]
|
|
6503
6602
|
#
|
|
6504
6603
|
# @!attribute [rw] service_name
|
|
@@ -6511,13 +6610,13 @@ module Aws::ECS
|
|
|
6511
6610
|
# The task desired status to use when filtering the `ListTasks`
|
|
6512
6611
|
# results. Specifying a `desiredStatus` of `STOPPED` limits the
|
|
6513
6612
|
# results to tasks that Amazon ECS has set the desired status to
|
|
6514
|
-
# `STOPPED`. This can be useful for debugging tasks that
|
|
6613
|
+
# `STOPPED`. This can be useful for debugging tasks that aren't
|
|
6515
6614
|
# starting properly or have died or finished. The default status
|
|
6516
6615
|
# filter is `RUNNING`, which shows tasks that Amazon ECS has set the
|
|
6517
6616
|
# desired status to `RUNNING`.
|
|
6518
6617
|
#
|
|
6519
6618
|
# <note markdown="1"> Although you can filter results based on a desired status of
|
|
6520
|
-
# `PENDING`, this
|
|
6619
|
+
# `PENDING`, this doesn't return any results. Amazon ECS never sets
|
|
6521
6620
|
# the desired status of a task to that value (only a task's
|
|
6522
6621
|
# `lastStatus` may have a value of `PENDING`).
|
|
6523
6622
|
#
|
|
@@ -6585,25 +6684,25 @@ module Aws::ECS
|
|
|
6585
6684
|
# target group or groups associated with a service or task set.
|
|
6586
6685
|
#
|
|
6587
6686
|
# 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
|
|
6687
|
+
# Balancer or Network Load Balancer. If you're using a Classic Load
|
|
6688
|
+
# Balancer, omit the target group ARN.
|
|
6590
6689
|
#
|
|
6591
6690
|
# For services using the `ECS` deployment controller, you can specify
|
|
6592
6691
|
# one or multiple target groups. For more information, see
|
|
6593
6692
|
# [Registering Multiple Target Groups with a Service][1] in the
|
|
6594
6693
|
# *Amazon Elastic Container Service Developer Guide*.
|
|
6595
6694
|
#
|
|
6596
|
-
# For services using the `CODE_DEPLOY` deployment controller, you
|
|
6695
|
+
# For services using the `CODE_DEPLOY` deployment controller, you're
|
|
6597
6696
|
# required to define two target groups for the load balancer. For more
|
|
6598
6697
|
# information, see [Blue/Green Deployment with CodeDeploy][2] in the
|
|
6599
6698
|
# *Amazon Elastic Container Service Developer Guide*.
|
|
6600
6699
|
#
|
|
6601
|
-
# If your service's task definition uses the `awsvpc` network mode
|
|
6602
|
-
#
|
|
6603
|
-
#
|
|
6604
|
-
#
|
|
6605
|
-
#
|
|
6606
|
-
#
|
|
6700
|
+
# If your service's task definition uses the `awsvpc` network mode,
|
|
6701
|
+
# you must choose `ip` as the target type, not `instance`. Do this
|
|
6702
|
+
# when creating your target groups because tasks that use the `awsvpc`
|
|
6703
|
+
# network mode are associated with an elastic network interface, not
|
|
6704
|
+
# an Amazon EC2 instance. This network mode is required for the
|
|
6705
|
+
# Fargate launch type.
|
|
6607
6706
|
#
|
|
6608
6707
|
#
|
|
6609
6708
|
#
|
|
@@ -6629,7 +6728,7 @@ module Aws::ECS
|
|
|
6629
6728
|
# The port on the container to associate with the load balancer. This
|
|
6630
6729
|
# port must correspond to a `containerPort` in the task definition the
|
|
6631
6730
|
# tasks in the service are using. For tasks that use the EC2 launch
|
|
6632
|
-
# type, the container instance they
|
|
6731
|
+
# type, the container instance they're launched on must allow ingress
|
|
6633
6732
|
# traffic on the `hostPort` of the port mapping.
|
|
6634
6733
|
# @return [Integer]
|
|
6635
6734
|
#
|
|
@@ -6649,14 +6748,14 @@ module Aws::ECS
|
|
|
6649
6748
|
# Remote API][2] and the `--log-driver` option to [ `docker run` ][3].
|
|
6650
6749
|
#
|
|
6651
6750
|
# 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.
|
|
6751
|
+
# daemon uses. However, the container might use a different logging
|
|
6752
|
+
# driver than the Docker daemon by specifying a log driver configuration
|
|
6753
|
+
# in the container definition. For more information about the options
|
|
6754
|
+
# for different supported log drivers, see [Configure logging
|
|
6755
|
+
# drivers][4] in the Docker documentation.
|
|
6657
6756
|
#
|
|
6658
|
-
#
|
|
6659
|
-
#
|
|
6757
|
+
# Understand the following when specifying a log configuration for your
|
|
6758
|
+
# containers.
|
|
6660
6759
|
#
|
|
6661
6760
|
# * Amazon ECS currently supports a subset of the logging drivers
|
|
6662
6761
|
# available to the Docker daemon (shown in the valid values below).
|
|
@@ -6666,19 +6765,19 @@ module Aws::ECS
|
|
|
6666
6765
|
# * This parameter requires version 1.18 of the Docker Remote API or
|
|
6667
6766
|
# greater on your container instance.
|
|
6668
6767
|
#
|
|
6669
|
-
# * For tasks hosted on Amazon EC2 instances, the Amazon ECS
|
|
6670
|
-
# agent must register the available logging drivers with the
|
|
6768
|
+
# * For tasks that are hosted on Amazon EC2 instances, the Amazon ECS
|
|
6769
|
+
# container agent must register the available logging drivers with the
|
|
6671
6770
|
# `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before
|
|
6672
6771
|
# containers placed on that instance can use these log configuration
|
|
6673
6772
|
# options. For more information, see [Amazon ECS container agent
|
|
6674
6773
|
# configuration][5] in the *Amazon Elastic Container Service Developer
|
|
6675
6774
|
# Guide*.
|
|
6676
6775
|
#
|
|
6677
|
-
# * For tasks on Fargate, because you
|
|
6776
|
+
# * For tasks that are on Fargate, because you don't have access to the
|
|
6678
6777
|
# underlying infrastructure your tasks are hosted on, any additional
|
|
6679
|
-
# software needed
|
|
6680
|
-
#
|
|
6681
|
-
#
|
|
6778
|
+
# software needed must be installed outside of the task. For example,
|
|
6779
|
+
# the Fluentd output aggregators or a remote host running Logstash to
|
|
6780
|
+
# send Gelf logs to.
|
|
6682
6781
|
#
|
|
6683
6782
|
#
|
|
6684
6783
|
#
|
|
@@ -6722,11 +6821,11 @@ module Aws::ECS
|
|
|
6722
6821
|
# [Custom log routing][2] in the *Amazon Elastic Container Service
|
|
6723
6822
|
# Developer Guide*.
|
|
6724
6823
|
#
|
|
6725
|
-
# <note markdown="1"> If you have a custom driver that
|
|
6726
|
-
# Amazon ECS container agent project that
|
|
6824
|
+
# <note markdown="1"> If you have a custom driver that isn't listed, you can fork the
|
|
6825
|
+
# Amazon ECS container agent project that's [available on GitHub][3]
|
|
6727
6826
|
# and customize it to work with that driver. We encourage you to
|
|
6728
6827
|
# submit pull requests for changes that you would like to have
|
|
6729
|
-
# included. However, we
|
|
6828
|
+
# included. However, we don't currently provide support for running
|
|
6730
6829
|
# modified copies of this software.
|
|
6731
6830
|
#
|
|
6732
6831
|
# </note>
|
|
@@ -6770,7 +6869,8 @@ module Aws::ECS
|
|
|
6770
6869
|
# Details about the managed agent status for the container.
|
|
6771
6870
|
#
|
|
6772
6871
|
# @!attribute [rw] last_started_at
|
|
6773
|
-
# The Unix timestamp for when the managed agent was last
|
|
6872
|
+
# The Unix timestamp for the time when the managed agent was last
|
|
6873
|
+
# started.
|
|
6774
6874
|
# @return [Time]
|
|
6775
6875
|
#
|
|
6776
6876
|
# @!attribute [rw] name
|
|
@@ -6810,7 +6910,7 @@ module Aws::ECS
|
|
|
6810
6910
|
# }
|
|
6811
6911
|
#
|
|
6812
6912
|
# @!attribute [rw] container_name
|
|
6813
|
-
# The name of the container associated with the managed agent.
|
|
6913
|
+
# The name of the container that's associated with the managed agent.
|
|
6814
6914
|
# @return [String]
|
|
6815
6915
|
#
|
|
6816
6916
|
# @!attribute [rw] managed_agent_name
|
|
@@ -6841,7 +6941,7 @@ module Aws::ECS
|
|
|
6841
6941
|
#
|
|
6842
6942
|
# When managed scaling is enabled, Amazon ECS manages the scale-in and
|
|
6843
6943
|
# scale-out actions of the Auto Scaling group. Amazon ECS manages a
|
|
6844
|
-
# target tracking scaling policy using an Amazon ECS
|
|
6944
|
+
# target tracking scaling policy using an Amazon ECS managed CloudWatch
|
|
6845
6945
|
# metric with the specified `targetCapacity` value as the target value
|
|
6846
6946
|
# for the metric. For more information, see [Using Managed Scaling][1]
|
|
6847
6947
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
|
@@ -6865,26 +6965,27 @@ module Aws::ECS
|
|
|
6865
6965
|
# }
|
|
6866
6966
|
#
|
|
6867
6967
|
# @!attribute [rw] status
|
|
6868
|
-
#
|
|
6968
|
+
# Determines whether to enable managed scaling for the capacity
|
|
6969
|
+
# provider.
|
|
6869
6970
|
# @return [String]
|
|
6870
6971
|
#
|
|
6871
6972
|
# @!attribute [rw] target_capacity
|
|
6872
6973
|
# The target capacity value for the capacity provider. The specified
|
|
6873
6974
|
# value must be greater than `0` and less than or equal to `100`. A
|
|
6874
|
-
# value of `100`
|
|
6875
|
-
# Scaling group being completely
|
|
6975
|
+
# value of `100` results in the Amazon EC2 instances in your Auto
|
|
6976
|
+
# Scaling group being completely used.
|
|
6876
6977
|
# @return [Integer]
|
|
6877
6978
|
#
|
|
6878
6979
|
# @!attribute [rw] minimum_scaling_step_size
|
|
6879
|
-
# The minimum number of container instances that Amazon ECS
|
|
6880
|
-
#
|
|
6881
|
-
#
|
|
6980
|
+
# The minimum number of container instances that Amazon ECS scales in
|
|
6981
|
+
# or scales out at one time. If this parameter is omitted, the default
|
|
6982
|
+
# value of `1` is used.
|
|
6882
6983
|
# @return [Integer]
|
|
6883
6984
|
#
|
|
6884
6985
|
# @!attribute [rw] maximum_scaling_step_size
|
|
6885
|
-
# The maximum number of container instances that Amazon ECS
|
|
6886
|
-
#
|
|
6887
|
-
#
|
|
6986
|
+
# The maximum number of container instances that Amazon ECS scales in
|
|
6987
|
+
# or scales out at one time. If this parameter is omitted, the default
|
|
6988
|
+
# value of `10000` is used.
|
|
6888
6989
|
# @return [Integer]
|
|
6889
6990
|
#
|
|
6890
6991
|
# @!attribute [rw] instance_warmup_period
|
|
@@ -6906,17 +7007,17 @@ module Aws::ECS
|
|
|
6906
7007
|
include Aws::Structure
|
|
6907
7008
|
end
|
|
6908
7009
|
|
|
6909
|
-
# Amazon ECS
|
|
6910
|
-
#
|
|
7010
|
+
# Amazon ECS can't determine the current version of the Amazon ECS
|
|
7011
|
+
# container agent on the container instance and doesn't have enough
|
|
6911
7012
|
# information to proceed with an update. This could be because the agent
|
|
6912
|
-
# running on the container instance is
|
|
6913
|
-
#
|
|
7013
|
+
# running on the container instance is a previous or custom version that
|
|
7014
|
+
# doesn't use our version information.
|
|
6914
7015
|
#
|
|
6915
7016
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/MissingVersionException AWS API Documentation
|
|
6916
7017
|
#
|
|
6917
7018
|
class MissingVersionException < Aws::EmptyStructure; end
|
|
6918
7019
|
|
|
6919
|
-
# Details
|
|
7020
|
+
# Details for a volume mount point that's used in a container
|
|
6920
7021
|
# definition.
|
|
6921
7022
|
#
|
|
6922
7023
|
# @note When making an API call, you may pass MountPoint
|
|
@@ -6974,12 +7075,12 @@ module Aws::ECS
|
|
|
6974
7075
|
# @return [String]
|
|
6975
7076
|
#
|
|
6976
7077
|
# @!attribute [rw] container_port
|
|
6977
|
-
# The port number on the container that
|
|
7078
|
+
# The port number on the container that's used with the network
|
|
6978
7079
|
# binding.
|
|
6979
7080
|
# @return [Integer]
|
|
6980
7081
|
#
|
|
6981
7082
|
# @!attribute [rw] host_port
|
|
6982
|
-
# The port number on the host that
|
|
7083
|
+
# The port number on the host that's used with the network binding.
|
|
6983
7084
|
# @return [Integer]
|
|
6984
7085
|
#
|
|
6985
7086
|
# @!attribute [rw] protocol
|
|
@@ -7012,7 +7113,7 @@ module Aws::ECS
|
|
|
7012
7113
|
# }
|
|
7013
7114
|
#
|
|
7014
7115
|
# @!attribute [rw] awsvpc_configuration
|
|
7015
|
-
# The VPC subnets and security groups associated with a task.
|
|
7116
|
+
# The VPC subnets and security groups that are associated with a task.
|
|
7016
7117
|
#
|
|
7017
7118
|
# <note markdown="1"> All specified subnets and security groups must be from the same VPC.
|
|
7018
7119
|
#
|
|
@@ -7052,9 +7153,10 @@ module Aws::ECS
|
|
|
7052
7153
|
include Aws::Structure
|
|
7053
7154
|
end
|
|
7054
7155
|
|
|
7055
|
-
# There
|
|
7056
|
-
#
|
|
7057
|
-
# it
|
|
7156
|
+
# There's no update available for this Amazon ECS container agent. This
|
|
7157
|
+
# might be because the agent is already running the latest version or
|
|
7158
|
+
# because it's so old that there's no update path to the current
|
|
7159
|
+
# version.
|
|
7058
7160
|
#
|
|
7059
7161
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/NoUpdateAvailableException AWS API Documentation
|
|
7060
7162
|
#
|
|
@@ -7064,8 +7166,8 @@ module Aws::ECS
|
|
|
7064
7166
|
# information, see [Task Placement Constraints][1] in the *Amazon
|
|
7065
7167
|
# Elastic Container Service Developer Guide*.
|
|
7066
7168
|
#
|
|
7067
|
-
# <note markdown="1"> If you
|
|
7068
|
-
#
|
|
7169
|
+
# <note markdown="1"> If you're using the Fargate launch type, task placement constraints
|
|
7170
|
+
# aren't supported.
|
|
7069
7171
|
#
|
|
7070
7172
|
# </note>
|
|
7071
7173
|
#
|
|
@@ -7131,16 +7233,16 @@ module Aws::ECS
|
|
|
7131
7233
|
# placement strategy spreads placement across available candidates
|
|
7132
7234
|
# evenly based on the `field` parameter. The `binpack` strategy places
|
|
7133
7235
|
# tasks on available candidates that have the least available amount
|
|
7134
|
-
# of the resource that
|
|
7236
|
+
# of the resource that's specified with the `field` parameter. For
|
|
7135
7237
|
# example, if you binpack on memory, a task is placed on the instance
|
|
7136
|
-
# with the least amount of remaining memory
|
|
7137
|
-
# the task
|
|
7238
|
+
# with the least amount of remaining memory but still enough to run
|
|
7239
|
+
# the task.
|
|
7138
7240
|
# @return [String]
|
|
7139
7241
|
#
|
|
7140
7242
|
# @!attribute [rw] field
|
|
7141
7243
|
# The field to apply the placement strategy against. For the `spread`
|
|
7142
7244
|
# placement strategy, valid values are `instanceId` (or `host`, which
|
|
7143
|
-
# has the same effect), or any platform or custom attribute that
|
|
7245
|
+
# has the same effect), or any platform or custom attribute that's
|
|
7144
7246
|
# applied to a container instance, such as
|
|
7145
7247
|
# `attribute:ecs.availability-zone`. For the `binpack` placement
|
|
7146
7248
|
# strategy, valid values are `cpu` and `memory`. For the `random`
|
|
@@ -7168,13 +7270,13 @@ module Aws::ECS
|
|
|
7168
7270
|
# }
|
|
7169
7271
|
#
|
|
7170
7272
|
# @!attribute [rw] id
|
|
7171
|
-
# The ID for the
|
|
7172
|
-
#
|
|
7273
|
+
# The ID for the GPUs on the container instance. The available GPU IDs
|
|
7274
|
+
# can also be obtained on the container instance in the
|
|
7173
7275
|
# `/var/lib/ecs/gpu/nvidia_gpu_info.json` file.
|
|
7174
7276
|
# @return [String]
|
|
7175
7277
|
#
|
|
7176
7278
|
# @!attribute [rw] type
|
|
7177
|
-
# The type of device that
|
|
7279
|
+
# The type of device that's available on the container instance. The
|
|
7178
7280
|
# only supported value is `GPU`.
|
|
7179
7281
|
# @return [String]
|
|
7180
7282
|
#
|
|
@@ -7187,14 +7289,14 @@ module Aws::ECS
|
|
|
7187
7289
|
include Aws::Structure
|
|
7188
7290
|
end
|
|
7189
7291
|
|
|
7190
|
-
# The specified platform version
|
|
7191
|
-
#
|
|
7292
|
+
# The specified platform version doesn't satisfy the required
|
|
7293
|
+
# capabilities of the task definition.
|
|
7192
7294
|
#
|
|
7193
7295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PlatformTaskDefinitionIncompatibilityException AWS API Documentation
|
|
7194
7296
|
#
|
|
7195
7297
|
class PlatformTaskDefinitionIncompatibilityException < Aws::EmptyStructure; end
|
|
7196
7298
|
|
|
7197
|
-
# The specified platform version
|
|
7299
|
+
# The specified platform version doesn't exist.
|
|
7198
7300
|
#
|
|
7199
7301
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PlatformUnknownException AWS API Documentation
|
|
7200
7302
|
#
|
|
@@ -7204,13 +7306,12 @@ module Aws::ECS
|
|
|
7204
7306
|
# instance to send or receive traffic. Port mappings are specified as
|
|
7205
7307
|
# part of the container definition.
|
|
7206
7308
|
#
|
|
7207
|
-
# If you
|
|
7208
|
-
#
|
|
7209
|
-
#
|
|
7210
|
-
# `containerPort`.
|
|
7309
|
+
# If you use containers in a task with the `awsvpc` or `host` network
|
|
7310
|
+
# mode, specify the exposed ports using `containerPort`. The `hostPort`
|
|
7311
|
+
# can be left blank or it must be the same value as the `containerPort`.
|
|
7211
7312
|
#
|
|
7212
|
-
# <note markdown="1"> You
|
|
7213
|
-
#
|
|
7313
|
+
# <note markdown="1"> You can't expose the same container port for multiple protocols. If
|
|
7314
|
+
# you attempt this, an error is returned.
|
|
7214
7315
|
#
|
|
7215
7316
|
# </note>
|
|
7216
7317
|
#
|
|
@@ -7228,15 +7329,14 @@ module Aws::ECS
|
|
|
7228
7329
|
# }
|
|
7229
7330
|
#
|
|
7230
7331
|
# @!attribute [rw] container_port
|
|
7231
|
-
# The port number on the container that
|
|
7332
|
+
# The port number on the container that's bound to the user-specified
|
|
7232
7333
|
# or automatically assigned host port.
|
|
7233
7334
|
#
|
|
7234
|
-
# If you
|
|
7235
|
-
#
|
|
7236
|
-
# `containerPort`.
|
|
7335
|
+
# If you use containers in a task with the `awsvpc` or `host` network
|
|
7336
|
+
# mode, specify the exposed ports using `containerPort`.
|
|
7237
7337
|
#
|
|
7238
|
-
# If you
|
|
7239
|
-
#
|
|
7338
|
+
# If you use containers in a task with the `bridge` network mode and
|
|
7339
|
+
# you specify a container port and not a host port, your container
|
|
7240
7340
|
# automatically receives a host port in the ephemeral port range. For
|
|
7241
7341
|
# more information, see `hostPort`. Port mappings that are
|
|
7242
7342
|
# automatically assigned in this way do not count toward the 100
|
|
@@ -7247,14 +7347,14 @@ module Aws::ECS
|
|
|
7247
7347
|
# The port number on the container instance to reserve for your
|
|
7248
7348
|
# container.
|
|
7249
7349
|
#
|
|
7250
|
-
# If you
|
|
7251
|
-
#
|
|
7252
|
-
#
|
|
7350
|
+
# If you use containers in a task with the `awsvpc` or `host` network
|
|
7351
|
+
# mode, the `hostPort` can either be left blank or set to the same
|
|
7352
|
+
# value as the `containerPort`.
|
|
7253
7353
|
#
|
|
7254
|
-
# If you
|
|
7255
|
-
#
|
|
7256
|
-
#
|
|
7257
|
-
#
|
|
7354
|
+
# If you use containers in a task with the `bridge` network mode, you
|
|
7355
|
+
# can specify a non-reserved host port for your container port
|
|
7356
|
+
# mapping, or you can omit the `hostPort` (or set it to `0`) while
|
|
7357
|
+
# specifying a `containerPort` and your container automatically
|
|
7258
7358
|
# receives a port in the ephemeral port range for your container
|
|
7259
7359
|
# instance operating system and Docker version.
|
|
7260
7360
|
#
|
|
@@ -7275,12 +7375,12 @@ module Aws::ECS
|
|
|
7275
7375
|
# The default reserved ports are 22 for SSH, the Docker ports 2375 and
|
|
7276
7376
|
# 2376, and the Amazon ECS container agent ports 51678-51680. Any host
|
|
7277
7377
|
# 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
|
-
#
|
|
7378
|
+
# reserved while the task is running. That is, after a task stops, the
|
|
7379
|
+
# host port is released. The current reserved ports are displayed in
|
|
7380
|
+
# the `remainingResources` of DescribeContainerInstances output. A
|
|
7381
|
+
# container instance can have up to 100 reserved ports at a time. This
|
|
7382
|
+
# number includes the default reserved ports. Automatically assigned
|
|
7383
|
+
# ports aren't included in the 100 reserved ports quota.
|
|
7284
7384
|
# @return [Integer]
|
|
7285
7385
|
#
|
|
7286
7386
|
# @!attribute [rw] protocol
|
|
@@ -7300,13 +7400,13 @@ module Aws::ECS
|
|
|
7300
7400
|
|
|
7301
7401
|
# The configuration details for the App Mesh proxy.
|
|
7302
7402
|
#
|
|
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]
|
|
7403
|
+
# For tasks that use the EC2 launch type, the container instances
|
|
7404
|
+
# require at least version 1.26.0 of the container agent and at least
|
|
7405
|
+
# version 1.26.0-1 of the `ecs-init` package to enable a proxy
|
|
7406
|
+
# configuration. If your container instances are launched from the
|
|
7407
|
+
# Amazon ECS optimized AMI version `20190301` or later, then they
|
|
7408
|
+
# contain the required versions of the container agent and `ecs-init`.
|
|
7409
|
+
# For more information, see [Amazon ECS-optimized Linux AMI][1]
|
|
7310
7410
|
#
|
|
7311
7411
|
#
|
|
7312
7412
|
#
|
|
@@ -7510,8 +7610,8 @@ module Aws::ECS
|
|
|
7510
7610
|
#
|
|
7511
7611
|
# @!attribute [rw] attributes
|
|
7512
7612
|
# The attributes to apply to your resource. You can specify up to 10
|
|
7513
|
-
# custom attributes
|
|
7514
|
-
# in a single call.
|
|
7613
|
+
# custom attributes for each resource. You can specify up to 10
|
|
7614
|
+
# attributes in a single call.
|
|
7515
7615
|
# @return [Array<Types::Attribute>]
|
|
7516
7616
|
#
|
|
7517
7617
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutAttributesRequest AWS API Documentation
|
|
@@ -7552,7 +7652,7 @@ module Aws::ECS
|
|
|
7552
7652
|
#
|
|
7553
7653
|
# @!attribute [rw] cluster
|
|
7554
7654
|
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
7555
|
-
# modify the capacity provider settings for. If you
|
|
7655
|
+
# modify the capacity provider settings for. If you don't specify a
|
|
7556
7656
|
# cluster, the default cluster is assumed.
|
|
7557
7657
|
# @return [String]
|
|
7558
7658
|
#
|
|
@@ -7664,9 +7764,9 @@ module Aws::ECS
|
|
|
7664
7764
|
# }
|
|
7665
7765
|
#
|
|
7666
7766
|
# @!attribute [rw] cluster
|
|
7667
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
7668
|
-
#
|
|
7669
|
-
#
|
|
7767
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
7768
|
+
# register your container instance with. If you do not specify a
|
|
7769
|
+
# cluster, the default cluster is assumed.
|
|
7670
7770
|
# @return [String]
|
|
7671
7771
|
#
|
|
7672
7772
|
# @!attribute [rw] instance_identity_document
|
|
@@ -7689,7 +7789,7 @@ module Aws::ECS
|
|
|
7689
7789
|
#
|
|
7690
7790
|
# @!attribute [rw] version_info
|
|
7691
7791
|
# The version information for the Amazon ECS container agent and
|
|
7692
|
-
# Docker daemon
|
|
7792
|
+
# Docker daemon that runs on the container instance.
|
|
7693
7793
|
# @return [Types::VersionInfo]
|
|
7694
7794
|
#
|
|
7695
7795
|
# @!attribute [rw] container_instance_arn
|
|
@@ -7709,7 +7809,7 @@ module Aws::ECS
|
|
|
7709
7809
|
# @!attribute [rw] tags
|
|
7710
7810
|
# The metadata that you apply to the container instance to help you
|
|
7711
7811
|
# categorize and organize them. Each tag consists of a key and an
|
|
7712
|
-
# optional value
|
|
7812
|
+
# optional value. You define both.
|
|
7713
7813
|
#
|
|
7714
7814
|
# The following basic restrictions apply to tags:
|
|
7715
7815
|
#
|
|
@@ -7996,12 +8096,16 @@ module Aws::ECS
|
|
|
7996
8096
|
# ephemeral_storage: {
|
|
7997
8097
|
# size_in_gi_b: 1, # required
|
|
7998
8098
|
# },
|
|
8099
|
+
# runtime_platform: {
|
|
8100
|
+
# cpu_architecture: "X86_64", # accepts X86_64, ARM64
|
|
8101
|
+
# 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
|
|
8102
|
+
# },
|
|
7999
8103
|
# }
|
|
8000
8104
|
#
|
|
8001
8105
|
# @!attribute [rw] family
|
|
8002
|
-
# You must specify a `family` for a task definition
|
|
8003
|
-
#
|
|
8004
|
-
#
|
|
8106
|
+
# You must specify a `family` for a task definition. You can use it
|
|
8107
|
+
# track multiple versions of the same task definition. The `family` is
|
|
8108
|
+
# used as a name for your task definition. Up to 255 letters
|
|
8005
8109
|
# (uppercase and lowercase), numbers, underscores, and hyphens are
|
|
8006
8110
|
# allowed.
|
|
8007
8111
|
# @return [String]
|
|
@@ -8083,28 +8187,27 @@ module Aws::ECS
|
|
|
8083
8187
|
#
|
|
8084
8188
|
# @!attribute [rw] volumes
|
|
8085
8189
|
# A list of volume definitions in JSON format that containers in your
|
|
8086
|
-
# task
|
|
8190
|
+
# task might use.
|
|
8087
8191
|
# @return [Array<Types::Volume>]
|
|
8088
8192
|
#
|
|
8089
8193
|
# @!attribute [rw] placement_constraints
|
|
8090
8194
|
# An array of placement constraint objects to use for the task. You
|
|
8091
|
-
# can specify a maximum of 10 constraints
|
|
8195
|
+
# can specify a maximum of 10 constraints for each task. This limit
|
|
8092
8196
|
# includes constraints in the task definition and those specified at
|
|
8093
|
-
# runtime
|
|
8197
|
+
# runtime.
|
|
8094
8198
|
# @return [Array<Types::TaskDefinitionPlacementConstraint>]
|
|
8095
8199
|
#
|
|
8096
8200
|
# @!attribute [rw] requires_compatibilities
|
|
8097
|
-
# The task launch type that Amazon ECS
|
|
8098
|
-
#
|
|
8099
|
-
#
|
|
8100
|
-
#
|
|
8101
|
-
# response.
|
|
8201
|
+
# The task launch type that Amazon ECS validates the task definition
|
|
8202
|
+
# against. A client exception is returned if the task definition
|
|
8203
|
+
# doesn't validate against the compatibilities specified. If no value
|
|
8204
|
+
# is specified, the parameter is omitted from the response.
|
|
8102
8205
|
# @return [Array<String>]
|
|
8103
8206
|
#
|
|
8104
8207
|
# @!attribute [rw] cpu
|
|
8105
8208
|
# The number of CPU units used by the task. It can be expressed as an
|
|
8106
|
-
# integer using CPU units
|
|
8107
|
-
# vCPUs
|
|
8209
|
+
# integer using CPU units (for example, `1024`) or as a string using
|
|
8210
|
+
# vCPUs (for example, `1 vCPU` or `1 vcpu`) in a task definition.
|
|
8108
8211
|
# String values are converted to an integer indicating the CPU units
|
|
8109
8212
|
# when the task definition is registered.
|
|
8110
8213
|
#
|
|
@@ -8114,14 +8217,17 @@ module Aws::ECS
|
|
|
8114
8217
|
#
|
|
8115
8218
|
# </note>
|
|
8116
8219
|
#
|
|
8117
|
-
# If you
|
|
8220
|
+
# If you're using the EC2 launch type, this field is optional.
|
|
8118
8221
|
# Supported values are between `128` CPU units (`0.125` vCPUs) and
|
|
8119
8222
|
# `10240` CPU units (`10` vCPUs).
|
|
8120
8223
|
#
|
|
8121
|
-
# If you
|
|
8224
|
+
# If you're using the Fargate launch type, this field is required and
|
|
8122
8225
|
# you must use one of the following values, which determines your
|
|
8123
8226
|
# range of supported values for the `memory` parameter:
|
|
8124
8227
|
#
|
|
8228
|
+
# The CPU units cannot be less than 1 vCPU when you use Windows
|
|
8229
|
+
# containers on Fargate.
|
|
8230
|
+
#
|
|
8125
8231
|
# * 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1
|
|
8126
8232
|
# GB), 2048 (2 GB)
|
|
8127
8233
|
#
|
|
@@ -8141,9 +8247,9 @@ module Aws::ECS
|
|
|
8141
8247
|
#
|
|
8142
8248
|
# @!attribute [rw] memory
|
|
8143
8249
|
# 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
|
|
8250
|
+
# as an integer using MiB (for example ,`1024`) or as a string using
|
|
8251
|
+
# GB (for example, `1GB` or `1 GB`) in a task definition. String
|
|
8252
|
+
# values are converted to an integer indicating the MiB when the task
|
|
8147
8253
|
# definition is registered.
|
|
8148
8254
|
#
|
|
8149
8255
|
# <note markdown="1"> Task-level CPU and memory parameters are ignored for Windows
|
|
@@ -8155,8 +8261,11 @@ module Aws::ECS
|
|
|
8155
8261
|
# If using the EC2 launch type, this field is optional.
|
|
8156
8262
|
#
|
|
8157
8263
|
# 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
|
|
8264
|
+
# must use one of the following values. This determines your range of
|
|
8265
|
+
# supported values for the `cpu` parameter.
|
|
8266
|
+
#
|
|
8267
|
+
# The CPU units cannot be less than 1 vCPU when you use Windows
|
|
8268
|
+
# containers on Fargate.
|
|
8160
8269
|
#
|
|
8161
8270
|
# * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values:
|
|
8162
8271
|
# 256 (.25 vCPU)
|
|
@@ -8177,7 +8286,7 @@ module Aws::ECS
|
|
|
8177
8286
|
# @!attribute [rw] tags
|
|
8178
8287
|
# The metadata that you apply to the task definition to help you
|
|
8179
8288
|
# categorize and organize them. Each tag consists of a key and an
|
|
8180
|
-
# optional value
|
|
8289
|
+
# optional value. You define both of them.
|
|
8181
8290
|
#
|
|
8182
8291
|
# The following basic restrictions apply to tags:
|
|
8183
8292
|
#
|
|
@@ -8302,7 +8411,11 @@ module Aws::ECS
|
|
|
8302
8411
|
# ECS User Guide for Fargate*.
|
|
8303
8412
|
#
|
|
8304
8413
|
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
|
|
8305
|
-
#
|
|
8414
|
+
# the following platform versions:
|
|
8415
|
+
#
|
|
8416
|
+
# * Linux platform version `1.4.0` or later.
|
|
8417
|
+
#
|
|
8418
|
+
# * Windows platform version `1.0.0` or later.
|
|
8306
8419
|
#
|
|
8307
8420
|
# </note>
|
|
8308
8421
|
#
|
|
@@ -8311,6 +8424,14 @@ module Aws::ECS
|
|
|
8311
8424
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html
|
|
8312
8425
|
# @return [Types::EphemeralStorage]
|
|
8313
8426
|
#
|
|
8427
|
+
# @!attribute [rw] runtime_platform
|
|
8428
|
+
# The operating system that your tasks definitions run on. A platform
|
|
8429
|
+
# family is specified only for tasks using the Fargate launch type.
|
|
8430
|
+
#
|
|
8431
|
+
# When you specify a task definition in a service, this value must
|
|
8432
|
+
# match the `runtimePlatform` value of the service.
|
|
8433
|
+
# @return [Types::RuntimePlatform]
|
|
8434
|
+
#
|
|
8314
8435
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterTaskDefinitionRequest AWS API Documentation
|
|
8315
8436
|
#
|
|
8316
8437
|
class RegisterTaskDefinitionRequest < Struct.new(
|
|
@@ -8329,7 +8450,8 @@ module Aws::ECS
|
|
|
8329
8450
|
:ipc_mode,
|
|
8330
8451
|
:proxy_configuration,
|
|
8331
8452
|
:inference_accelerators,
|
|
8332
|
-
:ephemeral_storage
|
|
8453
|
+
:ephemeral_storage,
|
|
8454
|
+
:runtime_platform)
|
|
8333
8455
|
SENSITIVE = []
|
|
8334
8456
|
include Aws::Structure
|
|
8335
8457
|
end
|
|
@@ -8364,11 +8486,11 @@ module Aws::ECS
|
|
|
8364
8486
|
# The Amazon Resource Name (ARN) of the secret containing the private
|
|
8365
8487
|
# repository credentials.
|
|
8366
8488
|
#
|
|
8367
|
-
# <note markdown="1"> When you
|
|
8368
|
-
#
|
|
8369
|
-
#
|
|
8370
|
-
#
|
|
8371
|
-
#
|
|
8489
|
+
# <note markdown="1"> When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if
|
|
8490
|
+
# the secret exists in the same Region as the task that you're
|
|
8491
|
+
# launching then you can use either the full ARN or the name of the
|
|
8492
|
+
# secret. When you use the Amazon Web Services Management Console, you
|
|
8493
|
+
# must specify the full ARN of the secret.
|
|
8372
8494
|
#
|
|
8373
8495
|
# </note>
|
|
8374
8496
|
# @return [String]
|
|
@@ -8401,8 +8523,8 @@ module Aws::ECS
|
|
|
8401
8523
|
# @return [String]
|
|
8402
8524
|
#
|
|
8403
8525
|
# @!attribute [rw] type
|
|
8404
|
-
# The type of the resource
|
|
8405
|
-
# `STRINGSET`.
|
|
8526
|
+
# The type of the resource. Valid values: `INTEGER`, `DOUBLE`, `LONG`,
|
|
8527
|
+
# or `STRINGSET`.
|
|
8406
8528
|
# @return [String]
|
|
8407
8529
|
#
|
|
8408
8530
|
# @!attribute [rw] double_value
|
|
@@ -8438,13 +8560,13 @@ module Aws::ECS
|
|
|
8438
8560
|
include Aws::Structure
|
|
8439
8561
|
end
|
|
8440
8562
|
|
|
8441
|
-
# The specified resource is in-use and
|
|
8563
|
+
# The specified resource is in-use and can't be removed.
|
|
8442
8564
|
#
|
|
8443
8565
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ResourceInUseException AWS API Documentation
|
|
8444
8566
|
#
|
|
8445
8567
|
class ResourceInUseException < Aws::EmptyStructure; end
|
|
8446
8568
|
|
|
8447
|
-
# The specified resource
|
|
8569
|
+
# The specified resource wasn't found.
|
|
8448
8570
|
#
|
|
8449
8571
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ResourceNotFoundException AWS API Documentation
|
|
8450
8572
|
#
|
|
@@ -8473,13 +8595,13 @@ module Aws::ECS
|
|
|
8473
8595
|
# The value for the specified resource type.
|
|
8474
8596
|
#
|
|
8475
8597
|
# If the `GPU` type is used, the value is the number of physical
|
|
8476
|
-
# `GPUs` the Amazon ECS container agent
|
|
8477
|
-
#
|
|
8478
|
-
#
|
|
8479
|
-
#
|
|
8598
|
+
# `GPUs` the Amazon ECS container agent reserves for the container.
|
|
8599
|
+
# The number of GPUs that's reserved for all containers in a task
|
|
8600
|
+
# can't exceed the number of available GPUs on the container instance
|
|
8601
|
+
# that the task is launched on.
|
|
8480
8602
|
#
|
|
8481
|
-
# If the `InferenceAccelerator` type is used, the `value`
|
|
8482
|
-
#
|
|
8603
|
+
# If the `InferenceAccelerator` type is used, the `value` matches the
|
|
8604
|
+
# `deviceName` for an InferenceAccelerator specified in a task
|
|
8483
8605
|
# definition.
|
|
8484
8606
|
# @return [String]
|
|
8485
8607
|
#
|
|
@@ -8604,14 +8726,14 @@ module Aws::ECS
|
|
|
8604
8726
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
|
8605
8727
|
#
|
|
8606
8728
|
# @!attribute [rw] cluster
|
|
8607
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
8608
|
-
#
|
|
8729
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
8730
|
+
# run your task on. If you do not specify a cluster, the default
|
|
8609
8731
|
# cluster is assumed.
|
|
8610
8732
|
# @return [String]
|
|
8611
8733
|
#
|
|
8612
8734
|
# @!attribute [rw] count
|
|
8613
8735
|
# The number of instantiations of the specified task to place on your
|
|
8614
|
-
# cluster. You can specify up to 10 tasks
|
|
8736
|
+
# cluster. You can specify up to 10 tasks for each call.
|
|
8615
8737
|
# @return [Integer]
|
|
8616
8738
|
#
|
|
8617
8739
|
# @!attribute [rw] enable_ecs_managed_tags
|
|
@@ -8625,8 +8747,8 @@ module Aws::ECS
|
|
|
8625
8747
|
# @return [Boolean]
|
|
8626
8748
|
#
|
|
8627
8749
|
# @!attribute [rw] enable_execute_command
|
|
8628
|
-
#
|
|
8629
|
-
# containers in this task. If `true`, this enables execute command
|
|
8750
|
+
# Determines whether to enable the execute command functionality for
|
|
8751
|
+
# the containers in this task. If `true`, this enables execute command
|
|
8630
8752
|
# functionality on all containers in the task.
|
|
8631
8753
|
# @return [Boolean]
|
|
8632
8754
|
#
|
|
@@ -8637,7 +8759,7 @@ module Aws::ECS
|
|
|
8637
8759
|
# @return [String]
|
|
8638
8760
|
#
|
|
8639
8761
|
# @!attribute [rw] launch_type
|
|
8640
|
-
# The infrastructure
|
|
8762
|
+
# The infrastructure to run your standalone task on. For more
|
|
8641
8763
|
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
|
8642
8764
|
# Container Service Developer Guide*.
|
|
8643
8765
|
#
|
|
@@ -8653,8 +8775,8 @@ module Aws::ECS
|
|
|
8653
8775
|
# The `EC2` launch type runs your tasks on Amazon EC2 instances
|
|
8654
8776
|
# registered to your cluster.
|
|
8655
8777
|
#
|
|
8656
|
-
# The `EXTERNAL` launch type runs your tasks on your on-
|
|
8657
|
-
# or virtual machine (VM) capacity registered to your cluster.
|
|
8778
|
+
# The `EXTERNAL` launch type runs your tasks on your on-premises
|
|
8779
|
+
# server or virtual machine (VM) capacity registered to your cluster.
|
|
8658
8780
|
#
|
|
8659
8781
|
# A task can use either a launch type or a capacity provider strategy.
|
|
8660
8782
|
# If a `launchType` is specified, the `capacityProviderStrategy`
|
|
@@ -8672,7 +8794,7 @@ module Aws::ECS
|
|
|
8672
8794
|
# @!attribute [rw] network_configuration
|
|
8673
8795
|
# The network configuration for the task. This parameter is required
|
|
8674
8796
|
# for task definitions that use the `awsvpc` network mode to receive
|
|
8675
|
-
# their own elastic network interface, and it
|
|
8797
|
+
# their own elastic network interface, and it isn't supported for
|
|
8676
8798
|
# other network modes. For more information, see [Task networking][1]
|
|
8677
8799
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
|
8678
8800
|
#
|
|
@@ -8685,7 +8807,7 @@ module Aws::ECS
|
|
|
8685
8807
|
# A list of container overrides in JSON format that specify the name
|
|
8686
8808
|
# of a container in the specified task definition and the overrides it
|
|
8687
8809
|
# should receive. You can override the default command for a container
|
|
8688
|
-
# (that
|
|
8810
|
+
# (that's specified in the task definition or Docker image) with a
|
|
8689
8811
|
# `command` override. You can also override existing environment
|
|
8690
8812
|
# variables (that are specified in the task definition or Docker
|
|
8691
8813
|
# image) on a container or add new environment variables to it with an
|
|
@@ -8697,20 +8819,20 @@ module Aws::ECS
|
|
|
8697
8819
|
#
|
|
8698
8820
|
# @!attribute [rw] placement_constraints
|
|
8699
8821
|
# 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).
|
|
8822
|
+
# can specify up to 10 constraints for each task (including
|
|
8823
|
+
# constraints in the task definition and those specified at runtime).
|
|
8702
8824
|
# @return [Array<Types::PlacementConstraint>]
|
|
8703
8825
|
#
|
|
8704
8826
|
# @!attribute [rw] placement_strategy
|
|
8705
8827
|
# The placement strategy objects to use for the task. You can specify
|
|
8706
|
-
# a maximum of 5 strategy rules
|
|
8828
|
+
# a maximum of 5 strategy rules for each task.
|
|
8707
8829
|
# @return [Array<Types::PlacementStrategy>]
|
|
8708
8830
|
#
|
|
8709
8831
|
# @!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
|
-
#
|
|
8832
|
+
# The platform version the task uses. A platform version is only
|
|
8833
|
+
# specified for tasks hosted on Fargate. If one isn't specified, the
|
|
8834
|
+
# `LATEST` platform version is used. For more information, see
|
|
8835
|
+
# [Fargate platform versions][1] in the *Amazon Elastic Container
|
|
8714
8836
|
# Service Developer Guide*.
|
|
8715
8837
|
#
|
|
8716
8838
|
#
|
|
@@ -8720,7 +8842,7 @@ module Aws::ECS
|
|
|
8720
8842
|
#
|
|
8721
8843
|
# @!attribute [rw] propagate_tags
|
|
8722
8844
|
# Specifies whether to propagate the tags from the task definition to
|
|
8723
|
-
# the task. If no value is specified, the tags
|
|
8845
|
+
# the task. If no value is specified, the tags aren't propagated.
|
|
8724
8846
|
# Tags can only be propagated to the task during task creation. To add
|
|
8725
8847
|
# tags to a task after task creation, use the TagResource API action.
|
|
8726
8848
|
#
|
|
@@ -8742,7 +8864,7 @@ module Aws::ECS
|
|
|
8742
8864
|
# `startedBy` parameter. You can then identify which tasks belong to
|
|
8743
8865
|
# that job by filtering the results of a ListTasks call with the
|
|
8744
8866
|
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
|
8745
|
-
# numbers, hyphens, and underscores are allowed.
|
|
8867
|
+
# numbers, hyphens (-), and underscores (\_) are allowed.
|
|
8746
8868
|
#
|
|
8747
8869
|
# If a task is started by an Amazon ECS service, then the `startedBy`
|
|
8748
8870
|
# parameter contains the deployment ID of the service that starts it.
|
|
@@ -8781,10 +8903,10 @@ module Aws::ECS
|
|
|
8781
8903
|
#
|
|
8782
8904
|
# @!attribute [rw] task_definition
|
|
8783
8905
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
|
8784
|
-
# task definition to run. If a `revision`
|
|
8906
|
+
# task definition to run. If a `revision` isn't specified, the latest
|
|
8785
8907
|
# `ACTIVE` revision is used.
|
|
8786
8908
|
#
|
|
8787
|
-
# The full ARN value must match the value that you specified
|
|
8909
|
+
# The full ARN value must match the value that you specified as the
|
|
8788
8910
|
# `Resource` of the IAM principal's permissions policy. For example,
|
|
8789
8911
|
# if the `Resource` is
|
|
8790
8912
|
# arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*,
|
|
@@ -8834,6 +8956,33 @@ module Aws::ECS
|
|
|
8834
8956
|
include Aws::Structure
|
|
8835
8957
|
end
|
|
8836
8958
|
|
|
8959
|
+
# Information about the platform for the Amazon ECS service or task.
|
|
8960
|
+
#
|
|
8961
|
+
# @note When making an API call, you may pass RuntimePlatform
|
|
8962
|
+
# data as a hash:
|
|
8963
|
+
#
|
|
8964
|
+
# {
|
|
8965
|
+
# cpu_architecture: "X86_64", # accepts X86_64, ARM64
|
|
8966
|
+
# 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
|
|
8967
|
+
# }
|
|
8968
|
+
#
|
|
8969
|
+
# @!attribute [rw] cpu_architecture
|
|
8970
|
+
# The CPU architecture.
|
|
8971
|
+
# @return [String]
|
|
8972
|
+
#
|
|
8973
|
+
# @!attribute [rw] operating_system_family
|
|
8974
|
+
# The operating system.
|
|
8975
|
+
# @return [String]
|
|
8976
|
+
#
|
|
8977
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RuntimePlatform AWS API Documentation
|
|
8978
|
+
#
|
|
8979
|
+
class RuntimePlatform < Struct.new(
|
|
8980
|
+
:cpu_architecture,
|
|
8981
|
+
:operating_system_family)
|
|
8982
|
+
SENSITIVE = []
|
|
8983
|
+
include Aws::Structure
|
|
8984
|
+
end
|
|
8985
|
+
|
|
8837
8986
|
# A floating-point percentage of the desired number of tasks to place
|
|
8838
8987
|
# and keep running in the task set.
|
|
8839
8988
|
#
|
|
@@ -8898,7 +9047,7 @@ module Aws::ECS
|
|
|
8898
9047
|
# the parameter in the SSM Parameter Store.
|
|
8899
9048
|
#
|
|
8900
9049
|
# <note markdown="1"> If the SSM Parameter Store parameter exists in the same Region as
|
|
8901
|
-
# the task you
|
|
9050
|
+
# the task you're launching, then you can use either the full ARN or
|
|
8902
9051
|
# name of the parameter. If the parameter exists in a different
|
|
8903
9052
|
# Region, then the full ARN must be specified.
|
|
8904
9053
|
#
|
|
@@ -8940,9 +9089,9 @@ module Aws::ECS
|
|
|
8940
9089
|
# @!attribute [rw] service_name
|
|
8941
9090
|
# The name of your service. Up to 255 letters (uppercase and
|
|
8942
9091
|
# 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.
|
|
9092
|
+
# names must be unique within a cluster. However, you can have
|
|
9093
|
+
# similarly named services in multiple clusters within a Region or
|
|
9094
|
+
# across multiple Regions.
|
|
8946
9095
|
# @return [String]
|
|
8947
9096
|
#
|
|
8948
9097
|
# @!attribute [rw] cluster_arn
|
|
@@ -8951,14 +9100,14 @@ module Aws::ECS
|
|
|
8951
9100
|
# @return [String]
|
|
8952
9101
|
#
|
|
8953
9102
|
# @!attribute [rw] load_balancers
|
|
8954
|
-
# A list of Elastic Load Balancing load balancer objects
|
|
8955
|
-
# the load balancer name, the container name
|
|
8956
|
-
#
|
|
8957
|
-
#
|
|
9103
|
+
# A list of Elastic Load Balancing load balancer objects. It contains
|
|
9104
|
+
# the load balancer name, the container name, and the container port
|
|
9105
|
+
# to access from the load balancer. The container name is as it
|
|
9106
|
+
# appears in a container definition.
|
|
8958
9107
|
# @return [Array<Types::LoadBalancer>]
|
|
8959
9108
|
#
|
|
8960
9109
|
# @!attribute [rw] service_registries
|
|
8961
|
-
# The details
|
|
9110
|
+
# The details for the service discovery registries to assign to this
|
|
8962
9111
|
# service. For more information, see [Service Discovery][1].
|
|
8963
9112
|
#
|
|
8964
9113
|
#
|
|
@@ -8993,16 +9142,16 @@ module Aws::ECS
|
|
|
8993
9142
|
# @return [String]
|
|
8994
9143
|
#
|
|
8995
9144
|
# @!attribute [rw] capacity_provider_strategy
|
|
8996
|
-
# The capacity provider strategy the service
|
|
9145
|
+
# The capacity provider strategy the service uses. When using the
|
|
8997
9146
|
# DescribeServices API, this field is omitted if the service was
|
|
8998
9147
|
# created using a launch type.
|
|
8999
9148
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
|
9000
9149
|
#
|
|
9001
9150
|
# @!attribute [rw] platform_version
|
|
9002
|
-
# The platform version
|
|
9003
|
-
#
|
|
9004
|
-
# specified, the `LATEST` platform version is used
|
|
9005
|
-
#
|
|
9151
|
+
# The platform version to run your service on. A platform version is
|
|
9152
|
+
# only specified for tasks that are hosted on Fargate. If one isn't
|
|
9153
|
+
# specified, the `LATEST` platform version is used. For more
|
|
9154
|
+
# information, see [Fargate Platform Versions][1] in the *Amazon
|
|
9006
9155
|
# Elastic Container Service Developer Guide*.
|
|
9007
9156
|
#
|
|
9008
9157
|
#
|
|
@@ -9010,6 +9159,15 @@ module Aws::ECS
|
|
|
9010
9159
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
|
9011
9160
|
# @return [String]
|
|
9012
9161
|
#
|
|
9162
|
+
# @!attribute [rw] platform_family
|
|
9163
|
+
# The operating system that your tasks in the service run on. A
|
|
9164
|
+
# platform family is specified only for tasks using the Fargate launch
|
|
9165
|
+
# type.
|
|
9166
|
+
#
|
|
9167
|
+
# All tasks that run as part of this service must use the same
|
|
9168
|
+
# `platformFamily` value as the service (for example, `LINUX`).
|
|
9169
|
+
# @return [String]
|
|
9170
|
+
#
|
|
9013
9171
|
# @!attribute [rw] task_definition
|
|
9014
9172
|
# The task definition to use for tasks in the service. This value is
|
|
9015
9173
|
# specified when the service is created with CreateService, and it can
|
|
@@ -9034,9 +9192,9 @@ module Aws::ECS
|
|
|
9034
9192
|
# @return [Array<Types::Deployment>]
|
|
9035
9193
|
#
|
|
9036
9194
|
# @!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.
|
|
9195
|
+
# The ARN of the IAM role that's associated with the service. It
|
|
9196
|
+
# allows the Amazon ECS container agent to register container
|
|
9197
|
+
# instances with an Elastic Load Balancing load balancer.
|
|
9040
9198
|
# @return [String]
|
|
9041
9199
|
#
|
|
9042
9200
|
# @!attribute [rw] events
|
|
@@ -9045,7 +9203,7 @@ module Aws::ECS
|
|
|
9045
9203
|
# @return [Array<Types::ServiceEvent>]
|
|
9046
9204
|
#
|
|
9047
9205
|
# @!attribute [rw] created_at
|
|
9048
|
-
# The Unix timestamp for when the service was created.
|
|
9206
|
+
# The Unix timestamp for the time when the service was created.
|
|
9049
9207
|
# @return [Time]
|
|
9050
9208
|
#
|
|
9051
9209
|
# @!attribute [rw] placement_constraints
|
|
@@ -9073,7 +9231,7 @@ module Aws::ECS
|
|
|
9073
9231
|
# The scheduling strategy to use for the service. For more
|
|
9074
9232
|
# information, see [Services][1].
|
|
9075
9233
|
#
|
|
9076
|
-
# There are two service scheduler strategies available
|
|
9234
|
+
# There are two service scheduler strategies available.
|
|
9077
9235
|
#
|
|
9078
9236
|
# * `REPLICA`-The replica scheduling strategy places and maintains the
|
|
9079
9237
|
# desired number of tasks across your cluster. By default, the
|
|
@@ -9082,13 +9240,13 @@ module Aws::ECS
|
|
|
9082
9240
|
# placement decisions.
|
|
9083
9241
|
#
|
|
9084
9242
|
# * `DAEMON`-The daemon scheduling strategy deploys exactly one task
|
|
9085
|
-
# on each active container instance
|
|
9243
|
+
# on each active container instance. This taskmeets all of the task
|
|
9086
9244
|
# placement constraints that you specify in your cluster. The
|
|
9087
9245
|
# service scheduler also evaluates the task placement constraints
|
|
9088
|
-
# for running tasks
|
|
9089
|
-
#
|
|
9246
|
+
# for running tasks. It stop tasks that don't meet the placement
|
|
9247
|
+
# constraints.
|
|
9090
9248
|
#
|
|
9091
|
-
# <note markdown="1"> Fargate tasks
|
|
9249
|
+
# <note markdown="1"> Fargate tasks don't support the `DAEMON` scheduling strategy.
|
|
9092
9250
|
#
|
|
9093
9251
|
# </note>
|
|
9094
9252
|
#
|
|
@@ -9099,14 +9257,14 @@ module Aws::ECS
|
|
|
9099
9257
|
#
|
|
9100
9258
|
# @!attribute [rw] deployment_controller
|
|
9101
9259
|
# The deployment controller type the service is using. When using the
|
|
9102
|
-
# DescribeServices API, this field is omitted if the service
|
|
9103
|
-
#
|
|
9260
|
+
# DescribeServices API, this field is omitted if the service uses the
|
|
9261
|
+
# `ECS` deployment controller type.
|
|
9104
9262
|
# @return [Types::DeploymentController]
|
|
9105
9263
|
#
|
|
9106
9264
|
# @!attribute [rw] tags
|
|
9107
9265
|
# 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
|
-
#
|
|
9266
|
+
# and organize them. Each tag consists of a key and an optional value.
|
|
9267
|
+
# You define bot the key and value.
|
|
9110
9268
|
#
|
|
9111
9269
|
# The following basic restrictions apply to tags:
|
|
9112
9270
|
#
|
|
@@ -9139,8 +9297,8 @@ module Aws::ECS
|
|
|
9139
9297
|
# @return [String]
|
|
9140
9298
|
#
|
|
9141
9299
|
# @!attribute [rw] enable_ecs_managed_tags
|
|
9142
|
-
#
|
|
9143
|
-
# the service. For more information, see [Tagging Your Amazon ECS
|
|
9300
|
+
# Determines whether to enable Amazon ECS managed tags for the tasks
|
|
9301
|
+
# in the service. For more information, see [Tagging Your Amazon ECS
|
|
9144
9302
|
# Resources][1] in the *Amazon Elastic Container Service Developer
|
|
9145
9303
|
# Guide*.
|
|
9146
9304
|
#
|
|
@@ -9150,15 +9308,15 @@ module Aws::ECS
|
|
|
9150
9308
|
# @return [Boolean]
|
|
9151
9309
|
#
|
|
9152
9310
|
# @!attribute [rw] propagate_tags
|
|
9153
|
-
#
|
|
9154
|
-
# the service to the task. If no value is specified, the tags
|
|
9311
|
+
# Determines whether to propagate the tags from the task definition or
|
|
9312
|
+
# the service to the task. If no value is specified, the tags aren't
|
|
9155
9313
|
# propagated.
|
|
9156
9314
|
# @return [String]
|
|
9157
9315
|
#
|
|
9158
9316
|
# @!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.
|
|
9317
|
+
# Determines whether the execute command functionality is enabled for
|
|
9318
|
+
# the service. If `true`, the execute command functionality is enabled
|
|
9319
|
+
# for all containers in tasks as part of the service.
|
|
9162
9320
|
# @return [Boolean]
|
|
9163
9321
|
#
|
|
9164
9322
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Service AWS API Documentation
|
|
@@ -9176,6 +9334,7 @@ module Aws::ECS
|
|
|
9176
9334
|
:launch_type,
|
|
9177
9335
|
:capacity_provider_strategy,
|
|
9178
9336
|
:platform_version,
|
|
9337
|
+
:platform_family,
|
|
9179
9338
|
:task_definition,
|
|
9180
9339
|
:deployment_configuration,
|
|
9181
9340
|
:task_sets,
|
|
@@ -9198,14 +9357,14 @@ module Aws::ECS
|
|
|
9198
9357
|
include Aws::Structure
|
|
9199
9358
|
end
|
|
9200
9359
|
|
|
9201
|
-
#
|
|
9360
|
+
# The details for an event that's associated with a service.
|
|
9202
9361
|
#
|
|
9203
9362
|
# @!attribute [rw] id
|
|
9204
|
-
# The ID string
|
|
9363
|
+
# The ID string for the event.
|
|
9205
9364
|
# @return [String]
|
|
9206
9365
|
#
|
|
9207
9366
|
# @!attribute [rw] created_at
|
|
9208
|
-
# The Unix timestamp for when the event was triggered.
|
|
9367
|
+
# The Unix timestamp for the time when the event was triggered.
|
|
9209
9368
|
# @return [Time]
|
|
9210
9369
|
#
|
|
9211
9370
|
# @!attribute [rw] message
|
|
@@ -9222,23 +9381,23 @@ module Aws::ECS
|
|
|
9222
9381
|
include Aws::Structure
|
|
9223
9382
|
end
|
|
9224
9383
|
|
|
9225
|
-
# The specified service
|
|
9226
|
-
#
|
|
9384
|
+
# The specified service isn't active. You can't update a service
|
|
9385
|
+
# that's inactive. If you have previously deleted a service, you can
|
|
9227
9386
|
# re-create it with CreateService.
|
|
9228
9387
|
#
|
|
9229
9388
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceNotActiveException AWS API Documentation
|
|
9230
9389
|
#
|
|
9231
9390
|
class ServiceNotActiveException < Aws::EmptyStructure; end
|
|
9232
9391
|
|
|
9233
|
-
# The specified service
|
|
9234
|
-
# services with ListServices. Amazon ECS services are cluster
|
|
9235
|
-
# and Region
|
|
9392
|
+
# The specified service wasn't found. You can view your available
|
|
9393
|
+
# services with ListServices. Amazon ECS services are cluster specific
|
|
9394
|
+
# and Region specific.
|
|
9236
9395
|
#
|
|
9237
9396
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceNotFoundException AWS API Documentation
|
|
9238
9397
|
#
|
|
9239
9398
|
class ServiceNotFoundException < Aws::EmptyStructure; end
|
|
9240
9399
|
|
|
9241
|
-
#
|
|
9400
|
+
# The details for the service registry.
|
|
9242
9401
|
#
|
|
9243
9402
|
# @note When making an API call, you may pass ServiceRegistry
|
|
9244
9403
|
# data as a hash:
|
|
@@ -9262,31 +9421,32 @@ module Aws::ECS
|
|
|
9262
9421
|
#
|
|
9263
9422
|
# @!attribute [rw] port
|
|
9264
9423
|
# The port value used if your service discovery service specified an
|
|
9265
|
-
# SRV record. This field
|
|
9266
|
-
# and SRV records are used.
|
|
9424
|
+
# SRV record. This field might be used if both the `awsvpc` network
|
|
9425
|
+
# mode and SRV records are used.
|
|
9267
9426
|
# @return [Integer]
|
|
9268
9427
|
#
|
|
9269
9428
|
# @!attribute [rw] container_name
|
|
9270
|
-
# The container name value
|
|
9271
|
-
#
|
|
9429
|
+
# The container name value to be used for your service discovery
|
|
9430
|
+
# service. It's already specified in the task definition. If the task
|
|
9272
9431
|
# definition that your service task specifies uses the `bridge` or
|
|
9273
9432
|
# `host` network mode, you must specify a `containerName` and
|
|
9274
9433
|
# `containerPort` combination from the task definition. If the task
|
|
9275
9434
|
# definition that your service task specifies uses the `awsvpc`
|
|
9276
9435
|
# network mode and a type SRV DNS record is used, you must specify
|
|
9277
9436
|
# either a `containerName` and `containerPort` combination or a `port`
|
|
9278
|
-
# value,
|
|
9437
|
+
# value. However, you can't specify both.
|
|
9279
9438
|
# @return [String]
|
|
9280
9439
|
#
|
|
9281
9440
|
# @!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,
|
|
9441
|
+
# The port value to be used for your service discovery service. It's
|
|
9442
|
+
# already specified in the task definition. If the task definition
|
|
9443
|
+
# your service task specifies uses the `bridge` or `host` network
|
|
9444
|
+
# mode, you must specify a `containerName` and `containerPort`
|
|
9445
|
+
# combination from the task definition. If the task definition your
|
|
9446
|
+
# service task specifies uses the `awsvpc` network mode and a type SRV
|
|
9447
|
+
# DNS record is used, you must specify either a `containerName` and
|
|
9448
|
+
# `containerPort` combination or a `port` value. However, you can't
|
|
9449
|
+
# specify both.
|
|
9290
9450
|
# @return [Integer]
|
|
9291
9451
|
#
|
|
9292
9452
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceRegistry AWS API Documentation
|
|
@@ -9300,7 +9460,7 @@ module Aws::ECS
|
|
|
9300
9460
|
include Aws::Structure
|
|
9301
9461
|
end
|
|
9302
9462
|
|
|
9303
|
-
# The details
|
|
9463
|
+
# The details for the execute command session.
|
|
9304
9464
|
#
|
|
9305
9465
|
# @!attribute [rw] session_id
|
|
9306
9466
|
# The ID of the execute command session.
|
|
@@ -9314,7 +9474,7 @@ module Aws::ECS
|
|
|
9314
9474
|
#
|
|
9315
9475
|
# @!attribute [rw] token_value
|
|
9316
9476
|
# An encrypted token value containing session and caller information.
|
|
9317
|
-
#
|
|
9477
|
+
# It's used to authenticate the connection to the container.
|
|
9318
9478
|
# @return [String]
|
|
9319
9479
|
#
|
|
9320
9480
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Session AWS API Documentation
|
|
@@ -9334,12 +9494,12 @@ module Aws::ECS
|
|
|
9334
9494
|
# @return [String]
|
|
9335
9495
|
#
|
|
9336
9496
|
# @!attribute [rw] value
|
|
9337
|
-
#
|
|
9338
|
-
# resource.
|
|
9497
|
+
# Determines whether the account setting is enabled or disabled for
|
|
9498
|
+
# the specified resource.
|
|
9339
9499
|
# @return [String]
|
|
9340
9500
|
#
|
|
9341
9501
|
# @!attribute [rw] principal_arn
|
|
9342
|
-
# The ARN of the principal
|
|
9502
|
+
# The ARN of the principal. It can be an IAM user, IAM role, or the
|
|
9343
9503
|
# root user. If this field is omitted, the authenticated user is
|
|
9344
9504
|
# assumed.
|
|
9345
9505
|
# @return [String]
|
|
@@ -9425,15 +9585,15 @@ module Aws::ECS
|
|
|
9425
9585
|
# }
|
|
9426
9586
|
#
|
|
9427
9587
|
# @!attribute [rw] cluster
|
|
9428
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
9429
|
-
#
|
|
9588
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
9589
|
+
# where to start your task. If you do not specify a cluster, the
|
|
9430
9590
|
# default cluster is assumed.
|
|
9431
9591
|
# @return [String]
|
|
9432
9592
|
#
|
|
9433
9593
|
# @!attribute [rw] container_instances
|
|
9434
9594
|
# The container instance IDs or full ARN entries for the container
|
|
9435
|
-
# instances
|
|
9436
|
-
#
|
|
9595
|
+
# instances where you would like to place your task. You can specify
|
|
9596
|
+
# up to 10 container instances.
|
|
9437
9597
|
# @return [Array<String>]
|
|
9438
9598
|
#
|
|
9439
9599
|
# @!attribute [rw] enable_ecs_managed_tags
|
|
@@ -9467,8 +9627,8 @@ module Aws::ECS
|
|
|
9467
9627
|
# @!attribute [rw] overrides
|
|
9468
9628
|
# A list of container overrides in JSON format that specify the name
|
|
9469
9629
|
# of a container in the specified task definition and the overrides it
|
|
9470
|
-
#
|
|
9471
|
-
# (that
|
|
9630
|
+
# receives. You can override the default command for a container
|
|
9631
|
+
# (that's specified in the task definition or Docker image) with a
|
|
9472
9632
|
# `command` override. You can also override existing environment
|
|
9473
9633
|
# variables (that are specified in the task definition or Docker
|
|
9474
9634
|
# image) on a container or add new environment variables to it with an
|
|
@@ -9482,7 +9642,7 @@ module Aws::ECS
|
|
|
9482
9642
|
#
|
|
9483
9643
|
# @!attribute [rw] propagate_tags
|
|
9484
9644
|
# Specifies whether to propagate the tags from the task definition or
|
|
9485
|
-
# the service to the task. If no value is specified, the tags
|
|
9645
|
+
# the service to the task. If no value is specified, the tags aren't
|
|
9486
9646
|
# propagated.
|
|
9487
9647
|
# @return [String]
|
|
9488
9648
|
#
|
|
@@ -9497,9 +9657,9 @@ module Aws::ECS
|
|
|
9497
9657
|
# `startedBy` parameter. You can then identify which tasks belong to
|
|
9498
9658
|
# that job by filtering the results of a ListTasks call with the
|
|
9499
9659
|
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
|
9500
|
-
# numbers, hyphens, and underscores are allowed.
|
|
9660
|
+
# numbers, hyphens (-), and underscores (\_) are allowed.
|
|
9501
9661
|
#
|
|
9502
|
-
# If a task is started by an Amazon ECS service,
|
|
9662
|
+
# If a task is started by an Amazon ECS service, the `startedBy`
|
|
9503
9663
|
# parameter contains the deployment ID of the service that starts it.
|
|
9504
9664
|
# @return [String]
|
|
9505
9665
|
#
|
|
@@ -9536,7 +9696,7 @@ module Aws::ECS
|
|
|
9536
9696
|
#
|
|
9537
9697
|
# @!attribute [rw] task_definition
|
|
9538
9698
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
|
9539
|
-
# task definition to start. If a `revision`
|
|
9699
|
+
# task definition to start. If a `revision` isn't specified, the
|
|
9540
9700
|
# latest `ACTIVE` revision is used.
|
|
9541
9701
|
# @return [String]
|
|
9542
9702
|
#
|
|
@@ -9598,7 +9758,7 @@ module Aws::ECS
|
|
|
9598
9758
|
#
|
|
9599
9759
|
# @!attribute [rw] reason
|
|
9600
9760
|
# An optional message specified when a task is stopped. For example,
|
|
9601
|
-
# if you
|
|
9761
|
+
# if you're using a custom scheduler, you can use this parameter to
|
|
9602
9762
|
# specify the reason for stopping the task here, and the message
|
|
9603
9763
|
# appears in subsequent DescribeTasks API operations on this task. Up
|
|
9604
9764
|
# to 255 characters are allowed in this message.
|
|
@@ -9712,7 +9872,7 @@ module Aws::ECS
|
|
|
9712
9872
|
# @return [String]
|
|
9713
9873
|
#
|
|
9714
9874
|
# @!attribute [rw] exit_code
|
|
9715
|
-
# The exit code returned for the state change request.
|
|
9875
|
+
# The exit code that's returned for the state change request.
|
|
9716
9876
|
# @return [Integer]
|
|
9717
9877
|
#
|
|
9718
9878
|
# @!attribute [rw] reason
|
|
@@ -9813,7 +9973,7 @@ module Aws::ECS
|
|
|
9813
9973
|
# @return [String]
|
|
9814
9974
|
#
|
|
9815
9975
|
# @!attribute [rw] containers
|
|
9816
|
-
# Any containers associated with the state change request.
|
|
9976
|
+
# Any containers that's associated with the state change request.
|
|
9817
9977
|
# @return [Array<Types::ContainerStateChange>]
|
|
9818
9978
|
#
|
|
9819
9979
|
# @!attribute [rw] attachments
|
|
@@ -9821,19 +9981,21 @@ module Aws::ECS
|
|
|
9821
9981
|
# @return [Array<Types::AttachmentStateChange>]
|
|
9822
9982
|
#
|
|
9823
9983
|
# @!attribute [rw] managed_agents
|
|
9824
|
-
# The details for the managed agent associated with the task.
|
|
9984
|
+
# The details for the managed agent that's associated with the task.
|
|
9825
9985
|
# @return [Array<Types::ManagedAgentStateChange>]
|
|
9826
9986
|
#
|
|
9827
9987
|
# @!attribute [rw] pull_started_at
|
|
9828
|
-
# The Unix timestamp for when the container image pull
|
|
9988
|
+
# The Unix timestamp for the time when the container image pull
|
|
9989
|
+
# started.
|
|
9829
9990
|
# @return [Time]
|
|
9830
9991
|
#
|
|
9831
9992
|
# @!attribute [rw] pull_stopped_at
|
|
9832
|
-
# The Unix timestamp for when the container image pull
|
|
9993
|
+
# The Unix timestamp for the time when the container image pull
|
|
9994
|
+
# completed.
|
|
9833
9995
|
# @return [Time]
|
|
9834
9996
|
#
|
|
9835
9997
|
# @!attribute [rw] execution_stopped_at
|
|
9836
|
-
# The Unix timestamp for when the task execution stopped.
|
|
9998
|
+
# The Unix timestamp for the time when the task execution stopped.
|
|
9837
9999
|
# @return [Time]
|
|
9838
10000
|
#
|
|
9839
10001
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitTaskStateChangeRequest AWS API Documentation
|
|
@@ -9870,21 +10032,21 @@ module Aws::ECS
|
|
|
9870
10032
|
# the [Docker Remote API][2] and the `--sysctl` option to [docker
|
|
9871
10033
|
# run][3].
|
|
9872
10034
|
#
|
|
9873
|
-
#
|
|
9874
|
-
#
|
|
9875
|
-
#
|
|
9876
|
-
# following reasons
|
|
10035
|
+
# We don't recommend that you specify network-related `systemControls`
|
|
10036
|
+
# parameters for multiple containers in a single task. This task also
|
|
10037
|
+
# uses either the `awsvpc` or `host` network mode. It does it for the
|
|
10038
|
+
# following reasons.
|
|
9877
10039
|
#
|
|
9878
10040
|
# * For tasks that use the `awsvpc` network mode, if you set
|
|
9879
10041
|
# `systemControls` for any container, it applies to all containers in
|
|
9880
10042
|
# the task. If you set different `systemControls` for multiple
|
|
9881
|
-
# containers in a single task, the container that
|
|
10043
|
+
# containers in a single task, the container that's started last
|
|
9882
10044
|
# determines which `systemControls` take effect.
|
|
9883
10045
|
#
|
|
9884
10046
|
# * For tasks that use the `host` network mode, the `systemControls`
|
|
9885
|
-
# parameter applies to the container instance's kernel parameter
|
|
9886
|
-
#
|
|
9887
|
-
#
|
|
10047
|
+
# parameter applies to the container instance's kernel parameter and
|
|
10048
|
+
# that of all containers of any tasks running on that container
|
|
10049
|
+
# instance.
|
|
9888
10050
|
#
|
|
9889
10051
|
#
|
|
9890
10052
|
#
|
|
@@ -9901,11 +10063,11 @@ module Aws::ECS
|
|
|
9901
10063
|
# }
|
|
9902
10064
|
#
|
|
9903
10065
|
# @!attribute [rw] namespace
|
|
9904
|
-
# The namespaced kernel parameter
|
|
10066
|
+
# The namespaced kernel parameter to set a `value` for.
|
|
9905
10067
|
# @return [String]
|
|
9906
10068
|
#
|
|
9907
10069
|
# @!attribute [rw] value
|
|
9908
|
-
# The value for the namespaced kernel parameter specified in
|
|
10070
|
+
# The value for the namespaced kernel parameter that's specified in
|
|
9909
10071
|
# `namespace`.
|
|
9910
10072
|
# @return [String]
|
|
9911
10073
|
#
|
|
@@ -9919,8 +10081,8 @@ module Aws::ECS
|
|
|
9919
10081
|
end
|
|
9920
10082
|
|
|
9921
10083
|
# 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
|
-
#
|
|
10084
|
+
# organize them. Each tag consists of a key and an optional value. You
|
|
10085
|
+
# define them.
|
|
9924
10086
|
#
|
|
9925
10087
|
# The following basic restrictions apply to tags:
|
|
9926
10088
|
#
|
|
@@ -9989,7 +10151,7 @@ module Aws::ECS
|
|
|
9989
10151
|
# }
|
|
9990
10152
|
#
|
|
9991
10153
|
# @!attribute [rw] resource_arn
|
|
9992
|
-
# The Amazon Resource Name (ARN) of the resource to
|
|
10154
|
+
# The Amazon Resource Name (ARN) of the resource to add tags to.
|
|
9993
10155
|
# Currently, the supported resources are Amazon ECS capacity
|
|
9994
10156
|
# providers, tasks, services, task definitions, clusters, and
|
|
9995
10157
|
# container instances.
|
|
@@ -10038,14 +10200,14 @@ module Aws::ECS
|
|
|
10038
10200
|
#
|
|
10039
10201
|
class TagResourceResponse < Aws::EmptyStructure; end
|
|
10040
10202
|
|
|
10041
|
-
# The target container
|
|
10203
|
+
# The target container isn't properly configured with the execute
|
|
10042
10204
|
# command agent or the container is no longer active or running.
|
|
10043
10205
|
#
|
|
10044
10206
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TargetNotConnectedException AWS API Documentation
|
|
10045
10207
|
#
|
|
10046
10208
|
class TargetNotConnectedException < Aws::EmptyStructure; end
|
|
10047
10209
|
|
|
10048
|
-
# The specified target
|
|
10210
|
+
# The specified target wasn't found. You can view your available
|
|
10049
10211
|
# container instances with ListContainerInstances. Amazon ECS container
|
|
10050
10212
|
# instances are cluster-specific and Region-specific.
|
|
10051
10213
|
#
|
|
@@ -10056,8 +10218,8 @@ module Aws::ECS
|
|
|
10056
10218
|
# Details on a task in a cluster.
|
|
10057
10219
|
#
|
|
10058
10220
|
# @!attribute [rw] attachments
|
|
10059
|
-
# The Elastic Network Adapter associated with the task if the
|
|
10060
|
-
# uses the `awsvpc` network mode.
|
|
10221
|
+
# The Elastic Network Adapter that's associated with the task if the
|
|
10222
|
+
# task uses the `awsvpc` network mode.
|
|
10061
10223
|
# @return [Array<Types::Attachment>]
|
|
10062
10224
|
#
|
|
10063
10225
|
# @!attribute [rw] attributes
|
|
@@ -10065,11 +10227,11 @@ module Aws::ECS
|
|
|
10065
10227
|
# @return [Array<Types::Attribute>]
|
|
10066
10228
|
#
|
|
10067
10229
|
# @!attribute [rw] availability_zone
|
|
10068
|
-
# The
|
|
10230
|
+
# The Availability Zone for the task.
|
|
10069
10231
|
# @return [String]
|
|
10070
10232
|
#
|
|
10071
10233
|
# @!attribute [rw] capacity_provider_name
|
|
10072
|
-
# The capacity provider associated with the task.
|
|
10234
|
+
# The capacity provider that's associated with the task.
|
|
10073
10235
|
# @return [String]
|
|
10074
10236
|
#
|
|
10075
10237
|
# @!attribute [rw] cluster_arn
|
|
@@ -10081,8 +10243,8 @@ module Aws::ECS
|
|
|
10081
10243
|
# @return [String]
|
|
10082
10244
|
#
|
|
10083
10245
|
# @!attribute [rw] connectivity_at
|
|
10084
|
-
# The Unix timestamp for when the task last went into
|
|
10085
|
-
# status.
|
|
10246
|
+
# The Unix timestamp for the time when the task last went into
|
|
10247
|
+
# `CONNECTED` status.
|
|
10086
10248
|
# @return [Time]
|
|
10087
10249
|
#
|
|
10088
10250
|
# @!attribute [rw] container_instance_arn
|
|
@@ -10090,24 +10252,27 @@ module Aws::ECS
|
|
|
10090
10252
|
# @return [String]
|
|
10091
10253
|
#
|
|
10092
10254
|
# @!attribute [rw] containers
|
|
10093
|
-
# The containers associated with the task.
|
|
10255
|
+
# The containers that's associated with the task.
|
|
10094
10256
|
# @return [Array<Types::Container>]
|
|
10095
10257
|
#
|
|
10096
10258
|
# @!attribute [rw] cpu
|
|
10097
10259
|
# 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
|
|
10260
|
+
# definition. It can be expressed as an integer using CPU units (for
|
|
10261
|
+
# example, `1024`). It can also be expressed as a string using vCPUs
|
|
10262
|
+
# (for example, `1 vCPU` or `1 vcpu`). String values are converted to
|
|
10263
|
+
# an integer that indicates the CPU units when the task definition is
|
|
10102
10264
|
# registered.
|
|
10103
10265
|
#
|
|
10104
|
-
# If you
|
|
10105
|
-
#
|
|
10106
|
-
#
|
|
10266
|
+
# If you use the EC2 launch type, this field is optional. Supported
|
|
10267
|
+
# values are between `128` CPU units (`0.125` vCPUs) and `10240` CPU
|
|
10268
|
+
# units (`10` vCPUs).
|
|
10107
10269
|
#
|
|
10108
|
-
# If you
|
|
10109
|
-
#
|
|
10110
|
-
#
|
|
10270
|
+
# If you use the Fargate launch type, this field is required. You must
|
|
10271
|
+
# use one of the following values. These values determine the range of
|
|
10272
|
+
# supported values for the `memory` parameter:
|
|
10273
|
+
#
|
|
10274
|
+
# The CPU units cannot be less than 1 vCPU when you use Windows
|
|
10275
|
+
# containers on Fargate.
|
|
10111
10276
|
#
|
|
10112
10277
|
# * 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1
|
|
10113
10278
|
# GB), 2048 (2 GB)
|
|
@@ -10127,8 +10292,9 @@ module Aws::ECS
|
|
|
10127
10292
|
# @return [String]
|
|
10128
10293
|
#
|
|
10129
10294
|
# @!attribute [rw] created_at
|
|
10130
|
-
# The Unix timestamp for when the task was created
|
|
10131
|
-
# the `PENDING`
|
|
10295
|
+
# The Unix timestamp for the time when the task was created. More
|
|
10296
|
+
# specifically, it's for the time when the task entered the `PENDING`
|
|
10297
|
+
# state.
|
|
10132
10298
|
# @return [Time]
|
|
10133
10299
|
#
|
|
10134
10300
|
# @!attribute [rw] desired_status
|
|
@@ -10141,43 +10307,44 @@ module Aws::ECS
|
|
|
10141
10307
|
# @return [String]
|
|
10142
10308
|
#
|
|
10143
10309
|
# @!attribute [rw] enable_execute_command
|
|
10144
|
-
#
|
|
10145
|
-
# task. If `true`,
|
|
10310
|
+
# Determines whether execute command functionality is enabled for this
|
|
10311
|
+
# task. If `true`, execute command functionality is enabled on all the
|
|
10146
10312
|
# containers in the task.
|
|
10147
10313
|
# @return [Boolean]
|
|
10148
10314
|
#
|
|
10149
10315
|
# @!attribute [rw] execution_stopped_at
|
|
10150
|
-
# The Unix timestamp for when the task execution stopped.
|
|
10316
|
+
# The Unix timestamp for the time when the task execution stopped.
|
|
10151
10317
|
# @return [Time]
|
|
10152
10318
|
#
|
|
10153
10319
|
# @!attribute [rw] group
|
|
10154
|
-
# The name of the task group associated with the task.
|
|
10320
|
+
# The name of the task group that's associated with the task.
|
|
10155
10321
|
# @return [String]
|
|
10156
10322
|
#
|
|
10157
10323
|
# @!attribute [rw] health_status
|
|
10158
|
-
# The health status for the task
|
|
10324
|
+
# The health status for the task. It's determined by the health of
|
|
10159
10325
|
# 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
|
|
10326
|
+
# the task are reporting as `HEALTHY`, the task status also reports as
|
|
10327
|
+
# `HEALTHY`. If any essential containers in the task are reporting as
|
|
10328
|
+
# `UNHEALTHY` or `UNKNOWN`, the task status also reports as
|
|
10329
|
+
# `UNHEALTHY` or `UNKNOWN`.
|
|
10330
|
+
#
|
|
10331
|
+
# <note markdown="1"> The Amazon ECS container agent doesn't monitor or report on Docker
|
|
10332
|
+
# health checks that are embedded in a container image and not
|
|
10333
|
+
# specified in the container definition. For example, this includes
|
|
10334
|
+
# those specified in a parent image or from the image's Dockerfile.
|
|
10335
|
+
# Health check parameters that are specified in a container definition
|
|
10336
|
+
# override any Docker health checks that are found in the container
|
|
10337
|
+
# image.
|
|
10171
10338
|
#
|
|
10172
10339
|
# </note>
|
|
10173
10340
|
# @return [String]
|
|
10174
10341
|
#
|
|
10175
10342
|
# @!attribute [rw] inference_accelerators
|
|
10176
|
-
# The Elastic Inference accelerator associated with the task.
|
|
10343
|
+
# The Elastic Inference accelerator that's associated with the task.
|
|
10177
10344
|
# @return [Array<Types::InferenceAccelerator>]
|
|
10178
10345
|
#
|
|
10179
10346
|
# @!attribute [rw] last_status
|
|
10180
|
-
# The last known status
|
|
10347
|
+
# The last known status for the task. For more information, see [Task
|
|
10181
10348
|
# Lifecycle][1].
|
|
10182
10349
|
#
|
|
10183
10350
|
#
|
|
@@ -10186,9 +10353,9 @@ module Aws::ECS
|
|
|
10186
10353
|
# @return [String]
|
|
10187
10354
|
#
|
|
10188
10355
|
# @!attribute [rw] launch_type
|
|
10189
|
-
# The infrastructure
|
|
10190
|
-
#
|
|
10191
|
-
#
|
|
10356
|
+
# The infrastructure where your task runs on. For more information,
|
|
10357
|
+
# see [Amazon ECS launch types][1] in the *Amazon Elastic Container
|
|
10358
|
+
# Service Developer Guide*.
|
|
10192
10359
|
#
|
|
10193
10360
|
#
|
|
10194
10361
|
#
|
|
@@ -10196,17 +10363,17 @@ module Aws::ECS
|
|
|
10196
10363
|
# @return [String]
|
|
10197
10364
|
#
|
|
10198
10365
|
# @!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
|
-
#
|
|
10366
|
+
# The amount of memory (in MiB) that the task uses as expressed in a
|
|
10367
|
+
# task definition. It can be expressed as an integer using MiB (for
|
|
10368
|
+
# example, `1024`). If it's expressed as a string using GB (for
|
|
10369
|
+
# example, `1GB` or `1 GB`), it's converted to an integer indicating
|
|
10370
|
+
# the MiB when the task definition is registered.
|
|
10204
10371
|
#
|
|
10205
|
-
# If you
|
|
10372
|
+
# If you use the EC2 launch type, this field is optional.
|
|
10206
10373
|
#
|
|
10207
|
-
# If you
|
|
10208
|
-
#
|
|
10209
|
-
# range of supported values for the `cpu` parameter
|
|
10374
|
+
# If you use the Fargate launch type, this field is required. You must
|
|
10375
|
+
# use one of the following values. The value that you choose
|
|
10376
|
+
# determines the range of supported values for the `cpu` parameter.
|
|
10210
10377
|
#
|
|
10211
10378
|
# * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values:
|
|
10212
10379
|
# 256 (.25 vCPU)
|
|
@@ -10229,44 +10396,55 @@ module Aws::ECS
|
|
|
10229
10396
|
# @return [Types::TaskOverride]
|
|
10230
10397
|
#
|
|
10231
10398
|
# @!attribute [rw] platform_version
|
|
10232
|
-
# The platform version
|
|
10233
|
-
#
|
|
10234
|
-
#
|
|
10235
|
-
#
|
|
10236
|
-
#
|
|
10399
|
+
# The platform version where your task runs on. A platform version is
|
|
10400
|
+
# only specified for tasks that use the Fargate launch type. If you
|
|
10401
|
+
# didn't specify one, the `LATEST` platform version is used. For more
|
|
10402
|
+
# information, see [Fargate Platform Versions][1] in the *Amazon
|
|
10403
|
+
# Elastic Container Service Developer Guide*.
|
|
10237
10404
|
#
|
|
10238
10405
|
#
|
|
10239
10406
|
#
|
|
10240
10407
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
|
10241
10408
|
# @return [String]
|
|
10242
10409
|
#
|
|
10410
|
+
# @!attribute [rw] platform_family
|
|
10411
|
+
# The operating system that your tasks are running on. A platform
|
|
10412
|
+
# family is specified only for tasks that use the Fargate launch type.
|
|
10413
|
+
#
|
|
10414
|
+
# All tasks that run as part of this service must use the same
|
|
10415
|
+
# `platformFamily` value as the service (for example, `LINUX.`).
|
|
10416
|
+
# @return [String]
|
|
10417
|
+
#
|
|
10243
10418
|
# @!attribute [rw] pull_started_at
|
|
10244
|
-
# The Unix timestamp for when the container image pull began.
|
|
10419
|
+
# The Unix timestamp for the time when the container image pull began.
|
|
10245
10420
|
# @return [Time]
|
|
10246
10421
|
#
|
|
10247
10422
|
# @!attribute [rw] pull_stopped_at
|
|
10248
|
-
# The Unix timestamp for when the container image pull
|
|
10423
|
+
# The Unix timestamp for the time when the container image pull
|
|
10424
|
+
# completed.
|
|
10249
10425
|
# @return [Time]
|
|
10250
10426
|
#
|
|
10251
10427
|
# @!attribute [rw] started_at
|
|
10252
|
-
# The Unix timestamp for when the task started
|
|
10253
|
-
#
|
|
10428
|
+
# The Unix timestamp for the time when the task started. More
|
|
10429
|
+
# specifically, it's for the time when the task transitioned from the
|
|
10430
|
+
# `PENDING` state to the `RUNNING` state.
|
|
10254
10431
|
# @return [Time]
|
|
10255
10432
|
#
|
|
10256
10433
|
# @!attribute [rw] started_by
|
|
10257
|
-
# The tag specified when a task is started. If
|
|
10258
|
-
#
|
|
10259
|
-
#
|
|
10434
|
+
# The tag specified when a task is started. If an Amazon ECS service
|
|
10435
|
+
# started the task, the `startedBy` parameter contains the deployment
|
|
10436
|
+
# ID of that service.
|
|
10260
10437
|
# @return [String]
|
|
10261
10438
|
#
|
|
10262
10439
|
# @!attribute [rw] stop_code
|
|
10263
10440
|
# The stop code indicating why a task was stopped. The `stoppedReason`
|
|
10264
|
-
#
|
|
10441
|
+
# might contain additional details.
|
|
10265
10442
|
# @return [String]
|
|
10266
10443
|
#
|
|
10267
10444
|
# @!attribute [rw] stopped_at
|
|
10268
|
-
# The Unix timestamp for when the task was stopped
|
|
10269
|
-
#
|
|
10445
|
+
# The Unix timestamp for the time when the task was stopped. More
|
|
10446
|
+
# specifically, it's for the time when the task transitioned from the
|
|
10447
|
+
# `RUNNING` state to the `STOPPED` state.
|
|
10270
10448
|
# @return [Time]
|
|
10271
10449
|
#
|
|
10272
10450
|
# @!attribute [rw] stopped_reason
|
|
@@ -10274,14 +10452,15 @@ module Aws::ECS
|
|
|
10274
10452
|
# @return [String]
|
|
10275
10453
|
#
|
|
10276
10454
|
# @!attribute [rw] stopping_at
|
|
10277
|
-
# The Unix timestamp for when the task stops
|
|
10278
|
-
#
|
|
10455
|
+
# The Unix timestamp for the time when the task stops. More
|
|
10456
|
+
# specifically, it's for the time when the task transitions from the
|
|
10457
|
+
# `RUNNING` state to `STOPPED`.
|
|
10279
10458
|
# @return [Time]
|
|
10280
10459
|
#
|
|
10281
10460
|
# @!attribute [rw] tags
|
|
10282
10461
|
# The metadata that you apply to the task to help you categorize and
|
|
10283
|
-
# organize
|
|
10284
|
-
# both
|
|
10462
|
+
# organize the task. Each tag consists of a key and an optional value.
|
|
10463
|
+
# You define both the key and value.
|
|
10285
10464
|
#
|
|
10286
10465
|
# The following basic restrictions apply to tags:
|
|
10287
10466
|
#
|
|
@@ -10319,8 +10498,8 @@ module Aws::ECS
|
|
|
10319
10498
|
#
|
|
10320
10499
|
# @!attribute [rw] version
|
|
10321
10500
|
# The version counter for the task. Every time a task experiences a
|
|
10322
|
-
# change that
|
|
10323
|
-
# incremented. If you
|
|
10501
|
+
# change that starts a CloudWatch event, the version counter is
|
|
10502
|
+
# incremented. If you replicate your Amazon ECS task state with
|
|
10324
10503
|
# CloudWatch Events, you can compare the version of a task reported by
|
|
10325
10504
|
# the Amazon ECS API actions with the version reported in CloudWatch
|
|
10326
10505
|
# Events for the task (inside the `detail` object) to verify that the
|
|
@@ -10356,6 +10535,7 @@ module Aws::ECS
|
|
|
10356
10535
|
:memory,
|
|
10357
10536
|
:overrides,
|
|
10358
10537
|
:platform_version,
|
|
10538
|
+
:platform_family,
|
|
10359
10539
|
:pull_started_at,
|
|
10360
10540
|
:pull_stopped_at,
|
|
10361
10541
|
:started_at,
|
|
@@ -10397,8 +10577,8 @@ module Aws::ECS
|
|
|
10397
10577
|
#
|
|
10398
10578
|
# @!attribute [rw] family
|
|
10399
10579
|
# The name of a family that this task definition is registered to. Up
|
|
10400
|
-
# to 255
|
|
10401
|
-
# underscores are allowed.
|
|
10580
|
+
# to 255 characters are allowed. Letters (both uppercase and lowercase
|
|
10581
|
+
# letters), numbers, hyphens (-), and underscores (\_) are allowed.
|
|
10402
10582
|
#
|
|
10403
10583
|
# A family groups multiple versions of a task definition. Amazon ECS
|
|
10404
10584
|
# gives the first task definition that you registered to a family a
|
|
@@ -10415,10 +10595,9 @@ module Aws::ECS
|
|
|
10415
10595
|
#
|
|
10416
10596
|
# IAM roles for tasks on Windows require that the `-EnableTaskIAMRole`
|
|
10417
10597
|
# 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*.
|
|
10598
|
+
# Your containers must also run some configuration code to use the
|
|
10599
|
+
# feature. For more information, see [Windows IAM roles for tasks][2]
|
|
10600
|
+
# in the *Amazon Elastic Container Service Developer Guide*.
|
|
10422
10601
|
#
|
|
10423
10602
|
#
|
|
10424
10603
|
#
|
|
@@ -10489,8 +10668,8 @@ module Aws::ECS
|
|
|
10489
10668
|
# version number of a task definition in a family. When you register a
|
|
10490
10669
|
# task definition for the first time, the revision is `1`. Each time
|
|
10491
10670
|
# 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.
|
|
10671
|
+
# family, the revision value always increases by one. This is even if
|
|
10672
|
+
# you deregistered previous revisions in this family.
|
|
10494
10673
|
# @return [Integer]
|
|
10495
10674
|
#
|
|
10496
10675
|
# @!attribute [rw] volumes
|
|
@@ -10498,7 +10677,7 @@ module Aws::ECS
|
|
|
10498
10677
|
# information, see [Using data volumes in tasks][1] in the *Amazon
|
|
10499
10678
|
# Elastic Container Service Developer Guide*.
|
|
10500
10679
|
#
|
|
10501
|
-
# <note markdown="1"> The `host` and `sourcePath` parameters
|
|
10680
|
+
# <note markdown="1"> The `host` and `sourcePath` parameters aren't supported for tasks
|
|
10502
10681
|
# run on Fargate.
|
|
10503
10682
|
#
|
|
10504
10683
|
# </note>
|
|
@@ -10516,13 +10695,13 @@ module Aws::ECS
|
|
|
10516
10695
|
# The container instance attributes required by your task. When an
|
|
10517
10696
|
# Amazon EC2 instance is registered to your cluster, the Amazon ECS
|
|
10518
10697
|
# 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*.
|
|
10698
|
+
# You can apply custom attributes. These are specified as key-value
|
|
10699
|
+
# pairs using the Amazon ECS console or the PutAttributes API. These
|
|
10700
|
+
# attributes are used when determining task placement for tasks hosted
|
|
10701
|
+
# on Amazon EC2 instances. For more information, see [Attributes][1]
|
|
10702
|
+
# in the *Amazon Elastic Container Service Developer Guide*.
|
|
10524
10703
|
#
|
|
10525
|
-
# <note markdown="1"> This parameter
|
|
10704
|
+
# <note markdown="1"> This parameter isn't supported for tasks run on Fargate.
|
|
10526
10705
|
#
|
|
10527
10706
|
# </note>
|
|
10528
10707
|
#
|
|
@@ -10534,7 +10713,7 @@ module Aws::ECS
|
|
|
10534
10713
|
# @!attribute [rw] placement_constraints
|
|
10535
10714
|
# An array of placement constraint objects to use for tasks.
|
|
10536
10715
|
#
|
|
10537
|
-
# <note markdown="1"> This parameter
|
|
10716
|
+
# <note markdown="1"> This parameter isn't supported for tasks run on Fargate.
|
|
10538
10717
|
#
|
|
10539
10718
|
# </note>
|
|
10540
10719
|
# @return [Array<Types::TaskDefinitionPlacementConstraint>]
|
|
@@ -10550,6 +10729,15 @@ module Aws::ECS
|
|
|
10550
10729
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html
|
|
10551
10730
|
# @return [Array<String>]
|
|
10552
10731
|
#
|
|
10732
|
+
# @!attribute [rw] runtime_platform
|
|
10733
|
+
# The operating system that your task definitions are running on. A
|
|
10734
|
+
# platform family is specified only for tasks using the Fargate launch
|
|
10735
|
+
# type.
|
|
10736
|
+
#
|
|
10737
|
+
# When you specify a task in a service, this value must match the
|
|
10738
|
+
# `runtimePlatform` value of the service.
|
|
10739
|
+
# @return [Types::RuntimePlatform]
|
|
10740
|
+
#
|
|
10553
10741
|
# @!attribute [rw] requires_compatibilities
|
|
10554
10742
|
# The task launch types the task definition was validated against. To
|
|
10555
10743
|
# determine which task launch types the task definition is validated
|
|
@@ -10557,11 +10745,14 @@ module Aws::ECS
|
|
|
10557
10745
|
# @return [Array<String>]
|
|
10558
10746
|
#
|
|
10559
10747
|
# @!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
|
|
10748
|
+
# The number of `cpu` units used by the task. If you use the EC2
|
|
10749
|
+
# launch type, this field is optional. Any value can be used. If you
|
|
10750
|
+
# use the Fargate launch type, this field is required. You must use
|
|
10751
|
+
# one of the following values. The value that you choose determines
|
|
10752
|
+
# your range of valid values for the `memory` parameter.
|
|
10753
|
+
#
|
|
10754
|
+
# The CPU units cannot be less than 1 vCPU when you use Windows
|
|
10755
|
+
# containers on Fargate.
|
|
10565
10756
|
#
|
|
10566
10757
|
# * 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1
|
|
10567
10758
|
# GB), 2048 (2 GB)
|
|
@@ -10583,16 +10774,16 @@ module Aws::ECS
|
|
|
10583
10774
|
# @!attribute [rw] memory
|
|
10584
10775
|
# The amount (in MiB) of memory used by the task.
|
|
10585
10776
|
#
|
|
10586
|
-
# If your tasks
|
|
10587
|
-
#
|
|
10588
|
-
#
|
|
10589
|
-
#
|
|
10590
|
-
#
|
|
10591
|
-
#
|
|
10777
|
+
# If your tasks runs on Amazon EC2 instances, you must specify either
|
|
10778
|
+
# a task-level memory value or a container-level memory value. This
|
|
10779
|
+
# field is optional and any value can be used. If a task-level memory
|
|
10780
|
+
# value is specified, the container-level memory value is optional.
|
|
10781
|
+
# For more information regarding container-level memory and memory
|
|
10782
|
+
# reservation, see [ContainerDefinition][1].
|
|
10592
10783
|
#
|
|
10593
|
-
# If your tasks
|
|
10594
|
-
#
|
|
10595
|
-
# valid values for the `cpu` parameter
|
|
10784
|
+
# If your tasks runs on Fargate, this field is required. You must use
|
|
10785
|
+
# one of the following values. The value you choose determines your
|
|
10786
|
+
# range of valid values for the `cpu` parameter.
|
|
10596
10787
|
#
|
|
10597
10788
|
# * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values:
|
|
10598
10789
|
# 256 (.25 vCPU)
|
|
@@ -10615,7 +10806,7 @@ module Aws::ECS
|
|
|
10615
10806
|
# @return [String]
|
|
10616
10807
|
#
|
|
10617
10808
|
# @!attribute [rw] inference_accelerators
|
|
10618
|
-
# The Elastic Inference accelerator associated with the task.
|
|
10809
|
+
# The Elastic Inference accelerator that's associated with the task.
|
|
10619
10810
|
# @return [Array<Types::InferenceAccelerator>]
|
|
10620
10811
|
#
|
|
10621
10812
|
# @!attribute [rw] pid_mode
|
|
@@ -10691,9 +10882,9 @@ module Aws::ECS
|
|
|
10691
10882
|
# Your Amazon ECS container instances require at least version 1.26.0
|
|
10692
10883
|
# of the container agent and at least version 1.26.0-1 of the
|
|
10693
10884
|
# `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
|
-
#
|
|
10885
|
+
# container instances are launched from the Amazon ECS optimized AMI
|
|
10886
|
+
# version `20190301` or later, they contain the required versions of
|
|
10887
|
+
# the container agent and `ecs-init`. For more information, see
|
|
10697
10888
|
# [Amazon ECS-optimized Linux AMI][1] in the *Amazon Elastic Container
|
|
10698
10889
|
# Service Developer Guide*.
|
|
10699
10890
|
#
|
|
@@ -10703,11 +10894,13 @@ module Aws::ECS
|
|
|
10703
10894
|
# @return [Types::ProxyConfiguration]
|
|
10704
10895
|
#
|
|
10705
10896
|
# @!attribute [rw] registered_at
|
|
10706
|
-
# The Unix timestamp for when the task definition was
|
|
10897
|
+
# The Unix timestamp for the time when the task definition was
|
|
10898
|
+
# registered.
|
|
10707
10899
|
# @return [Time]
|
|
10708
10900
|
#
|
|
10709
10901
|
# @!attribute [rw] deregistered_at
|
|
10710
|
-
# The Unix timestamp for when the task definition was
|
|
10902
|
+
# The Unix timestamp for the time when the task definition was
|
|
10903
|
+
# deregistered.
|
|
10711
10904
|
# @return [Time]
|
|
10712
10905
|
#
|
|
10713
10906
|
# @!attribute [rw] registered_by
|
|
@@ -10734,6 +10927,7 @@ module Aws::ECS
|
|
|
10734
10927
|
:requires_attributes,
|
|
10735
10928
|
:placement_constraints,
|
|
10736
10929
|
:compatibilities,
|
|
10930
|
+
:runtime_platform,
|
|
10737
10931
|
:requires_compatibilities,
|
|
10738
10932
|
:cpu,
|
|
10739
10933
|
:memory,
|
|
@@ -10753,7 +10947,7 @@ module Aws::ECS
|
|
|
10753
10947
|
# definition. For more information, see [Task placement constraints][1]
|
|
10754
10948
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
|
10755
10949
|
#
|
|
10756
|
-
# <note markdown="1"> Task placement constraints
|
|
10950
|
+
# <note markdown="1"> Task placement constraints aren't supported for tasks run on Fargate.
|
|
10757
10951
|
#
|
|
10758
10952
|
# </note>
|
|
10759
10953
|
#
|
|
@@ -10793,7 +10987,7 @@ module Aws::ECS
|
|
|
10793
10987
|
include Aws::Structure
|
|
10794
10988
|
end
|
|
10795
10989
|
|
|
10796
|
-
# The overrides associated with a task.
|
|
10990
|
+
# The overrides that are associated with a task.
|
|
10797
10991
|
#
|
|
10798
10992
|
# @note When making an API call, you may pass TaskOverride
|
|
10799
10993
|
# data as a hash:
|
|
@@ -10842,7 +11036,7 @@ module Aws::ECS
|
|
|
10842
11036
|
# }
|
|
10843
11037
|
#
|
|
10844
11038
|
# @!attribute [rw] container_overrides
|
|
10845
|
-
# One or more container overrides sent to a task.
|
|
11039
|
+
# One or more container overrides that are sent to a task.
|
|
10846
11040
|
# @return [Array<Types::ContainerOverride>]
|
|
10847
11041
|
#
|
|
10848
11042
|
# @!attribute [rw] cpu
|
|
@@ -10883,8 +11077,12 @@ module Aws::ECS
|
|
|
10883
11077
|
# @!attribute [rw] ephemeral_storage
|
|
10884
11078
|
# The ephemeral storage setting override for the task.
|
|
10885
11079
|
#
|
|
10886
|
-
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate
|
|
10887
|
-
#
|
|
11080
|
+
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate that
|
|
11081
|
+
# use the following platform versions:
|
|
11082
|
+
#
|
|
11083
|
+
# * Linux platform version `1.4.0` or later.
|
|
11084
|
+
#
|
|
11085
|
+
# * Windows platform version `1.0.0` or later.
|
|
10888
11086
|
#
|
|
10889
11087
|
# </note>
|
|
10890
11088
|
# @return [Types::EphemeralStorage]
|
|
@@ -10927,17 +11125,17 @@ module Aws::ECS
|
|
|
10927
11125
|
# @return [String]
|
|
10928
11126
|
#
|
|
10929
11127
|
# @!attribute [rw] started_by
|
|
10930
|
-
# The tag specified when a task set is started. If
|
|
10931
|
-
# created
|
|
10932
|
-
# `CODE_DEPLOY`.
|
|
10933
|
-
#
|
|
11128
|
+
# The tag specified when a task set is started. If an CodeDeploy
|
|
11129
|
+
# deployment created the task set, the `startedBy` parameter is
|
|
11130
|
+
# `CODE_DEPLOY`. If an external deployment created the task set, the
|
|
11131
|
+
# startedBy field isn't used.
|
|
10934
11132
|
# @return [String]
|
|
10935
11133
|
#
|
|
10936
11134
|
# @!attribute [rw] external_id
|
|
10937
11135
|
# The external ID associated with the task set.
|
|
10938
11136
|
#
|
|
10939
|
-
# If
|
|
10940
|
-
#
|
|
11137
|
+
# If an CodeDeploy deployment created a task set, the `externalId`
|
|
11138
|
+
# parameter contains the CodeDeploy deployment ID.
|
|
10941
11139
|
#
|
|
10942
11140
|
# If a task set is created for an external deployment and is
|
|
10943
11141
|
# associated with a service discovery registry, the `externalId`
|
|
@@ -10946,7 +11144,7 @@ module Aws::ECS
|
|
|
10946
11144
|
# @return [String]
|
|
10947
11145
|
#
|
|
10948
11146
|
# @!attribute [rw] status
|
|
10949
|
-
# The status of the task set. The following describes each state
|
|
11147
|
+
# The status of the task set. The following describes each state.
|
|
10950
11148
|
#
|
|
10951
11149
|
# PRIMARY
|
|
10952
11150
|
#
|
|
@@ -10954,17 +11152,17 @@ module Aws::ECS
|
|
|
10954
11152
|
#
|
|
10955
11153
|
# ACTIVE
|
|
10956
11154
|
#
|
|
10957
|
-
# : The task set
|
|
11155
|
+
# : The task set isn't serving production traffic.
|
|
10958
11156
|
#
|
|
10959
11157
|
# DRAINING
|
|
10960
11158
|
#
|
|
10961
|
-
# : The tasks in the task set are being stopped and their
|
|
11159
|
+
# : The tasks in the task set are being stopped, and their
|
|
10962
11160
|
# corresponding targets are being deregistered from their target
|
|
10963
11161
|
# group.
|
|
10964
11162
|
# @return [String]
|
|
10965
11163
|
#
|
|
10966
11164
|
# @!attribute [rw] task_definition
|
|
10967
|
-
# The task definition the task set is using.
|
|
11165
|
+
# The task definition that the task set is using.
|
|
10968
11166
|
# @return [String]
|
|
10969
11167
|
#
|
|
10970
11168
|
# @!attribute [rw] computed_desired_count
|
|
@@ -10978,7 +11176,7 @@ module Aws::ECS
|
|
|
10978
11176
|
# The number of tasks in the task set that are in the `PENDING` status
|
|
10979
11177
|
# during a deployment. A task in the `PENDING` state is preparing to
|
|
10980
11178
|
# enter the `RUNNING` state. A task set enters the `PENDING` status
|
|
10981
|
-
# when it launches for the first time or when it
|
|
11179
|
+
# when it launches for the first time or when it's restarted after
|
|
10982
11180
|
# being in the `STOPPED` state.
|
|
10983
11181
|
# @return [Integer]
|
|
10984
11182
|
#
|
|
@@ -10989,11 +11187,11 @@ module Aws::ECS
|
|
|
10989
11187
|
# @return [Integer]
|
|
10990
11188
|
#
|
|
10991
11189
|
# @!attribute [rw] created_at
|
|
10992
|
-
# The Unix timestamp for when the task set was created.
|
|
11190
|
+
# The Unix timestamp for the time when the task set was created.
|
|
10993
11191
|
# @return [Time]
|
|
10994
11192
|
#
|
|
10995
11193
|
# @!attribute [rw] updated_at
|
|
10996
|
-
# The Unix timestamp for when the task set was last updated.
|
|
11194
|
+
# The Unix timestamp for the time when the task set was last updated.
|
|
10997
11195
|
# @return [Time]
|
|
10998
11196
|
#
|
|
10999
11197
|
# @!attribute [rw] launch_type
|
|
@@ -11007,11 +11205,12 @@ module Aws::ECS
|
|
|
11007
11205
|
# @return [String]
|
|
11008
11206
|
#
|
|
11009
11207
|
# @!attribute [rw] capacity_provider_strategy
|
|
11010
|
-
# The capacity provider strategy associated with the task
|
|
11208
|
+
# The capacity provider strategy that are associated with the task
|
|
11209
|
+
# set.
|
|
11011
11210
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
|
11012
11211
|
#
|
|
11013
11212
|
# @!attribute [rw] platform_version
|
|
11014
|
-
# The Fargate platform version
|
|
11213
|
+
# The Fargate platform version where the tasks in the task set are
|
|
11015
11214
|
# running. A platform version is only specified for tasks run on
|
|
11016
11215
|
# Fargate. For more information, see [Fargate platform versions][1] in
|
|
11017
11216
|
# the *Amazon Elastic Container Service Developer Guide*.
|
|
@@ -11021,16 +11220,24 @@ module Aws::ECS
|
|
|
11021
11220
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
|
11022
11221
|
# @return [String]
|
|
11023
11222
|
#
|
|
11223
|
+
# @!attribute [rw] platform_family
|
|
11224
|
+
# The operating system that your tasks in the set are running on. A
|
|
11225
|
+
# platform family is specified only for tasks that use the Fargate
|
|
11226
|
+
# launch type.
|
|
11227
|
+
#
|
|
11228
|
+
# All tasks in the set must have the same value.
|
|
11229
|
+
# @return [String]
|
|
11230
|
+
#
|
|
11024
11231
|
# @!attribute [rw] network_configuration
|
|
11025
11232
|
# The network configuration for the task set.
|
|
11026
11233
|
# @return [Types::NetworkConfiguration]
|
|
11027
11234
|
#
|
|
11028
11235
|
# @!attribute [rw] load_balancers
|
|
11029
|
-
# Details on a load balancer that
|
|
11236
|
+
# Details on a load balancer that are used with a task set.
|
|
11030
11237
|
# @return [Array<Types::LoadBalancer>]
|
|
11031
11238
|
#
|
|
11032
11239
|
# @!attribute [rw] service_registries
|
|
11033
|
-
# The details
|
|
11240
|
+
# The details for the service discovery registries to assign to this
|
|
11034
11241
|
# task set. For more information, see [Service discovery][1].
|
|
11035
11242
|
#
|
|
11036
11243
|
#
|
|
@@ -11039,38 +11246,38 @@ module Aws::ECS
|
|
|
11039
11246
|
# @return [Array<Types::ServiceRegistry>]
|
|
11040
11247
|
#
|
|
11041
11248
|
# @!attribute [rw] scale
|
|
11042
|
-
# A floating-point percentage of
|
|
11249
|
+
# A floating-point percentage of your desired number of tasks to place
|
|
11043
11250
|
# and keep running in the task set.
|
|
11044
11251
|
# @return [Types::Scale]
|
|
11045
11252
|
#
|
|
11046
11253
|
# @!attribute [rw] stability_status
|
|
11047
|
-
# The stability status
|
|
11254
|
+
# The stability status. This indicates whether the task set has
|
|
11048
11255
|
# reached a steady state. If the following conditions are met, the
|
|
11049
|
-
# task set
|
|
11256
|
+
# task set sre in `STEADY_STATE`\:
|
|
11050
11257
|
#
|
|
11051
11258
|
# * The task `runningCount` is equal to the `computedDesiredCount`.
|
|
11052
11259
|
#
|
|
11053
11260
|
# * The `pendingCount` is `0`.
|
|
11054
11261
|
#
|
|
11055
|
-
# * There are no tasks running on container instances in the
|
|
11262
|
+
# * There are no tasks that are running on container instances in the
|
|
11056
11263
|
# `DRAINING` status.
|
|
11057
11264
|
#
|
|
11058
11265
|
# * All tasks are reporting a healthy status from the load balancers,
|
|
11059
11266
|
# service discovery, and container health checks.
|
|
11060
11267
|
#
|
|
11061
|
-
# If any of those conditions
|
|
11268
|
+
# If any of those conditions aren't met, the stability status returns
|
|
11062
11269
|
# `STABILIZING`.
|
|
11063
11270
|
# @return [String]
|
|
11064
11271
|
#
|
|
11065
11272
|
# @!attribute [rw] stability_status_at
|
|
11066
|
-
# The Unix timestamp for when the task set stability status
|
|
11067
|
-
# retrieved.
|
|
11273
|
+
# The Unix timestamp for the time when the task set stability status
|
|
11274
|
+
# was retrieved.
|
|
11068
11275
|
# @return [Time]
|
|
11069
11276
|
#
|
|
11070
11277
|
# @!attribute [rw] tags
|
|
11071
11278
|
# 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
|
-
#
|
|
11279
|
+
# and organize them. Each tag consists of a key and an optional value.
|
|
11280
|
+
# You define both.
|
|
11074
11281
|
#
|
|
11075
11282
|
# The following basic restrictions apply to tags:
|
|
11076
11283
|
#
|
|
@@ -11117,6 +11324,7 @@ module Aws::ECS
|
|
|
11117
11324
|
:launch_type,
|
|
11118
11325
|
:capacity_provider_strategy,
|
|
11119
11326
|
:platform_version,
|
|
11327
|
+
:platform_family,
|
|
11120
11328
|
:network_configuration,
|
|
11121
11329
|
:load_balancers,
|
|
11122
11330
|
:service_registries,
|
|
@@ -11128,9 +11336,9 @@ module Aws::ECS
|
|
|
11128
11336
|
include Aws::Structure
|
|
11129
11337
|
end
|
|
11130
11338
|
|
|
11131
|
-
# The specified task set
|
|
11132
|
-
#
|
|
11133
|
-
#
|
|
11339
|
+
# The specified task set wasn't found. You can view your available task
|
|
11340
|
+
# sets with DescribeTaskSets. Task sets are specific to each cluster,
|
|
11341
|
+
# service and Region.
|
|
11134
11342
|
#
|
|
11135
11343
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TaskSetNotFoundException AWS API Documentation
|
|
11136
11344
|
#
|
|
@@ -11217,7 +11425,7 @@ module Aws::ECS
|
|
|
11217
11425
|
include Aws::Structure
|
|
11218
11426
|
end
|
|
11219
11427
|
|
|
11220
|
-
# The specified task
|
|
11428
|
+
# The specified task isn't supported in this Region.
|
|
11221
11429
|
#
|
|
11222
11430
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UnsupportedFeatureException AWS API Documentation
|
|
11223
11431
|
#
|
|
@@ -11232,8 +11440,8 @@ module Aws::ECS
|
|
|
11232
11440
|
# }
|
|
11233
11441
|
#
|
|
11234
11442
|
# @!attribute [rw] resource_arn
|
|
11235
|
-
# The Amazon Resource Name (ARN) of the resource
|
|
11236
|
-
#
|
|
11443
|
+
# The Amazon Resource Name (ARN) of the resource to delete tags from.
|
|
11444
|
+
# Currently, the supported resources are Amazon ECS capacity
|
|
11237
11445
|
# providers, tasks, services, task definitions, clusters, and
|
|
11238
11446
|
# container instances.
|
|
11239
11447
|
# @return [String]
|
|
@@ -11277,8 +11485,8 @@ module Aws::ECS
|
|
|
11277
11485
|
# @return [String]
|
|
11278
11486
|
#
|
|
11279
11487
|
# @!attribute [rw] auto_scaling_group_provider
|
|
11280
|
-
# An object
|
|
11281
|
-
# group capacity provider.
|
|
11488
|
+
# An object that represent the parameters to update for the Auto
|
|
11489
|
+
# Scaling group capacity provider.
|
|
11282
11490
|
# @return [Types::AutoScalingGroupProviderUpdate]
|
|
11283
11491
|
#
|
|
11284
11492
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateCapacityProviderRequest AWS API Documentation
|
|
@@ -11382,8 +11590,8 @@ module Aws::ECS
|
|
|
11382
11590
|
# @!attribute [rw] settings
|
|
11383
11591
|
# The setting to use by default for a cluster. This parameter is used
|
|
11384
11592
|
# to enable CloudWatch Container Insights for a cluster. If this value
|
|
11385
|
-
# is specified, it
|
|
11386
|
-
#
|
|
11593
|
+
# is specified, it overrides the `containerInsights` value set with
|
|
11594
|
+
# PutAccountSetting or PutAccountSettingDefault.
|
|
11387
11595
|
# @return [Array<Types::ClusterSetting>]
|
|
11388
11596
|
#
|
|
11389
11597
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateClusterSettingsRequest AWS API Documentation
|
|
@@ -11423,7 +11631,7 @@ module Aws::ECS
|
|
|
11423
11631
|
#
|
|
11424
11632
|
# @!attribute [rw] container_instance
|
|
11425
11633
|
# The container instance ID or full ARN entries for the container
|
|
11426
|
-
# instance
|
|
11634
|
+
# instance where you would like to update the Amazon ECS container
|
|
11427
11635
|
# agent.
|
|
11428
11636
|
# @return [String]
|
|
11429
11637
|
#
|
|
@@ -11437,7 +11645,7 @@ module Aws::ECS
|
|
|
11437
11645
|
end
|
|
11438
11646
|
|
|
11439
11647
|
# @!attribute [rw] container_instance
|
|
11440
|
-
# The container instance
|
|
11648
|
+
# The container instance that the container agent was updated for.
|
|
11441
11649
|
# @return [Types::ContainerInstance]
|
|
11442
11650
|
#
|
|
11443
11651
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerAgentResponse AWS API Documentation
|
|
@@ -11468,13 +11676,13 @@ module Aws::ECS
|
|
|
11468
11676
|
# @return [Array<String>]
|
|
11469
11677
|
#
|
|
11470
11678
|
# @!attribute [rw] status
|
|
11471
|
-
# The container instance state
|
|
11472
|
-
#
|
|
11473
|
-
#
|
|
11474
|
-
#
|
|
11475
|
-
#
|
|
11476
|
-
#
|
|
11477
|
-
#
|
|
11679
|
+
# The container instance state to update the container instance with.
|
|
11680
|
+
# The only valid values for this action are `ACTIVE` and `DRAINING`. A
|
|
11681
|
+
# container instance can only be updated to `DRAINING` status once it
|
|
11682
|
+
# has reached an `ACTIVE` state. If a container instance is in
|
|
11683
|
+
# `REGISTERING`, `DEREGISTERING`, or `REGISTRATION_FAILED` state you
|
|
11684
|
+
# can describe the container instance but can't update the container
|
|
11685
|
+
# instance state.
|
|
11478
11686
|
# @return [String]
|
|
11479
11687
|
#
|
|
11480
11688
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerInstancesStateRequest AWS API Documentation
|
|
@@ -11504,10 +11712,10 @@ module Aws::ECS
|
|
|
11504
11712
|
include Aws::Structure
|
|
11505
11713
|
end
|
|
11506
11714
|
|
|
11507
|
-
# There
|
|
11508
|
-
# progress on the
|
|
11509
|
-
# becomes disconnected while it
|
|
11510
|
-
# `PENDING` or `STAGING`, the update process can get stuck in that
|
|
11715
|
+
# There's already a current Amazon ECS container agent update in
|
|
11716
|
+
# progress on the container instance that's specified. If the container
|
|
11717
|
+
# agent becomes disconnected while it's in a transitional stage, such
|
|
11718
|
+
# as `PENDING` or `STAGING`, the update process can get stuck in that
|
|
11511
11719
|
# state. However, when the agent reconnects, it resumes where it stopped
|
|
11512
11720
|
# previously.
|
|
11513
11721
|
#
|
|
@@ -11611,8 +11819,8 @@ module Aws::ECS
|
|
|
11611
11819
|
#
|
|
11612
11820
|
# @!attribute [rw] cluster
|
|
11613
11821
|
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
11614
|
-
# that your service
|
|
11615
|
-
#
|
|
11822
|
+
# that your service runs on. If you do not specify a cluster, the
|
|
11823
|
+
# default cluster is assumed.
|
|
11616
11824
|
# @return [String]
|
|
11617
11825
|
#
|
|
11618
11826
|
# @!attribute [rw] service
|
|
@@ -11636,12 +11844,13 @@ module Aws::ECS
|
|
|
11636
11844
|
# @!attribute [rw] capacity_provider_strategy
|
|
11637
11845
|
# The capacity provider strategy to update the service to use.
|
|
11638
11846
|
#
|
|
11639
|
-
#
|
|
11640
|
-
#
|
|
11847
|
+
# if the service uses the default capacity provider strategy for the
|
|
11848
|
+
# cluster, the service can be updated to use one or more capacity
|
|
11641
11849
|
# 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
|
|
11850
|
+
# However, when a service is using a capacity provider strategy
|
|
11851
|
+
# that's not the default capacity provider strategy, the service
|
|
11852
|
+
# can't be updated to use the cluster's default capacity provider
|
|
11853
|
+
# strategy.
|
|
11645
11854
|
#
|
|
11646
11855
|
# A capacity provider strategy consists of one or more capacity
|
|
11647
11856
|
# providers along with the `base` and `weight` to assign to them. A
|
|
@@ -11683,9 +11892,9 @@ module Aws::ECS
|
|
|
11683
11892
|
# service. To remove all existing placement constraints, specify an
|
|
11684
11893
|
# empty array.
|
|
11685
11894
|
#
|
|
11686
|
-
# You can specify a maximum of 10 constraints
|
|
11687
|
-
# includes constraints in the task definition and those
|
|
11688
|
-
# runtime
|
|
11895
|
+
# You can specify a maximum of 10 constraints for each task. This
|
|
11896
|
+
# limit includes constraints in the task definition and those
|
|
11897
|
+
# specified at runtime.
|
|
11689
11898
|
# @return [Array<Types::PlacementConstraint>]
|
|
11690
11899
|
#
|
|
11691
11900
|
# @!attribute [rw] placement_strategy
|
|
@@ -11695,16 +11904,16 @@ module Aws::ECS
|
|
|
11695
11904
|
# override the existing placement strategy defined for the service. To
|
|
11696
11905
|
# remove an existing placement strategy, specify an empty object.
|
|
11697
11906
|
#
|
|
11698
|
-
# You can specify a maximum of five strategy rules
|
|
11907
|
+
# You can specify a maximum of five strategy rules for each service.
|
|
11699
11908
|
# @return [Array<Types::PlacementStrategy>]
|
|
11700
11909
|
#
|
|
11701
11910
|
# @!attribute [rw] platform_version
|
|
11702
|
-
# The platform version
|
|
11703
|
-
#
|
|
11911
|
+
# The platform version that your tasks in the service run on. A
|
|
11912
|
+
# platform version is only specified for tasks using the Fargate
|
|
11704
11913
|
# launch type. If a platform version is not specified, the `LATEST`
|
|
11705
|
-
# platform version is used
|
|
11706
|
-
#
|
|
11707
|
-
#
|
|
11914
|
+
# platform version is used. For more information, see [Fargate
|
|
11915
|
+
# Platform Versions][1] in the *Amazon Elastic Container Service
|
|
11916
|
+
# Developer Guide*.
|
|
11708
11917
|
#
|
|
11709
11918
|
#
|
|
11710
11919
|
#
|
|
@@ -11712,26 +11921,26 @@ module Aws::ECS
|
|
|
11712
11921
|
# @return [String]
|
|
11713
11922
|
#
|
|
11714
11923
|
# @!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.
|
|
11924
|
+
# Determines whether to force a new deployment of the service. By
|
|
11925
|
+
# default, deployments aren't forced. You can use this option to
|
|
11926
|
+
# start a new deployment with no service definition changes. For
|
|
11927
|
+
# example, you can update a service's tasks to use a newer Docker
|
|
11928
|
+
# image with the same image/tag combination (`my_image:latest`) or to
|
|
11929
|
+
# roll Fargate tasks onto a newer platform version.
|
|
11721
11930
|
# @return [Boolean]
|
|
11722
11931
|
#
|
|
11723
11932
|
# @!attribute [rw] health_check_grace_period_seconds
|
|
11724
11933
|
# The period of time, in seconds, that the Amazon ECS service
|
|
11725
|
-
# scheduler
|
|
11726
|
-
#
|
|
11727
|
-
#
|
|
11728
|
-
#
|
|
11729
|
-
#
|
|
11730
|
-
#
|
|
11731
|
-
#
|
|
11732
|
-
#
|
|
11733
|
-
#
|
|
11734
|
-
#
|
|
11934
|
+
# scheduler ignores unhealthy Elastic Load Balancing target health
|
|
11935
|
+
# checks after a task has first started. This is only valid if your
|
|
11936
|
+
# service is configured to use a load balancer. If your service's
|
|
11937
|
+
# tasks take a while to start and respond to Elastic Load Balancing
|
|
11938
|
+
# health checks, you can specify a health check grace period of up to
|
|
11939
|
+
# 2,147,483,647 seconds. During that time, the Amazon ECS service
|
|
11940
|
+
# scheduler ignores the Elastic Load Balancing health check status.
|
|
11941
|
+
# This grace period can prevent the ECS service scheduler from marking
|
|
11942
|
+
# tasks as unhealthy and stopping them before they have time to come
|
|
11943
|
+
# up.
|
|
11735
11944
|
# @return [Integer]
|
|
11736
11945
|
#
|
|
11737
11946
|
# @!attribute [rw] enable_execute_command
|
|
@@ -11790,12 +11999,12 @@ module Aws::ECS
|
|
|
11790
11999
|
#
|
|
11791
12000
|
# @!attribute [rw] cluster
|
|
11792
12001
|
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
11793
|
-
# that hosts the service that the task set
|
|
12002
|
+
# that hosts the service that the task set is found in.
|
|
11794
12003
|
# @return [String]
|
|
11795
12004
|
#
|
|
11796
12005
|
# @!attribute [rw] service
|
|
11797
12006
|
# The short name or full Amazon Resource Name (ARN) of the service
|
|
11798
|
-
# that the task set
|
|
12007
|
+
# that the task set is found in.
|
|
11799
12008
|
# @return [String]
|
|
11800
12009
|
#
|
|
11801
12010
|
# @!attribute [rw] task_set
|
|
@@ -11857,7 +12066,7 @@ module Aws::ECS
|
|
|
11857
12066
|
# @return [String]
|
|
11858
12067
|
#
|
|
11859
12068
|
# @!attribute [rw] docker_version
|
|
11860
|
-
# The Docker version running on the container instance.
|
|
12069
|
+
# The Docker version that's running on the container instance.
|
|
11861
12070
|
# @return [String]
|
|
11862
12071
|
#
|
|
11863
12072
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/VersionInfo AWS API Documentation
|
|
@@ -11870,14 +12079,14 @@ module Aws::ECS
|
|
|
11870
12079
|
include Aws::Structure
|
|
11871
12080
|
end
|
|
11872
12081
|
|
|
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].
|
|
12082
|
+
# A data volume that's used in a task definition. For tasks that use
|
|
12083
|
+
# the Amazon Elastic File System (Amazon EFS), specify an
|
|
12084
|
+
# `efsVolumeConfiguration`. For Windows tasks that use Amazon FSx for
|
|
12085
|
+
# Windows File Server file system, specify a
|
|
12086
|
+
# `fsxWindowsFileServerVolumeConfiguration`. For tasks that use a Docker
|
|
12087
|
+
# volume, specify a `DockerVolumeConfiguration`. For tasks that use a
|
|
12088
|
+
# bind mount host volume, specify a `host` and optional `sourcePath`.
|
|
12089
|
+
# For more information, see [Using Data Volumes in Tasks][1].
|
|
11881
12090
|
#
|
|
11882
12091
|
#
|
|
11883
12092
|
#
|
|
@@ -11930,40 +12139,40 @@ module Aws::ECS
|
|
|
11930
12139
|
# @return [String]
|
|
11931
12140
|
#
|
|
11932
12141
|
# @!attribute [rw] host
|
|
11933
|
-
# This parameter is specified when you
|
|
11934
|
-
#
|
|
11935
|
-
#
|
|
11936
|
-
#
|
|
11937
|
-
#
|
|
11938
|
-
#
|
|
11939
|
-
# with it stop running.
|
|
12142
|
+
# This parameter is specified when you use bind mount host volumes.
|
|
12143
|
+
# The contents of the `host` parameter determine whether your bind
|
|
12144
|
+
# mount host volume persists on the host container instance and where
|
|
12145
|
+
# it's stored. If the `host` parameter is empty, then the Docker
|
|
12146
|
+
# daemon assigns a host path for your data volume. However, the data
|
|
12147
|
+
# isn't guaranteed to persist after the containers that are
|
|
12148
|
+
# associated with it stop running.
|
|
11940
12149
|
#
|
|
11941
12150
|
# Windows containers can mount whole directories on the same drive as
|
|
11942
|
-
# `$env:ProgramData`. Windows containers
|
|
11943
|
-
# different drive, and mount point
|
|
12151
|
+
# `$env:ProgramData`. Windows containers can't mount directories on a
|
|
12152
|
+
# different drive, and mount point can't be across drives. For
|
|
11944
12153
|
# example, you can mount `C:\my\path:C:\my\path` and `D:\:D:`, but
|
|
11945
12154
|
# not `D:\my\path:C:\my\path` or `D:\:C:\my\path`.
|
|
11946
12155
|
# @return [Types::HostVolumeProperties]
|
|
11947
12156
|
#
|
|
11948
12157
|
# @!attribute [rw] docker_volume_configuration
|
|
11949
|
-
# This parameter is specified when you
|
|
12158
|
+
# This parameter is specified when you use Docker volumes.
|
|
11950
12159
|
#
|
|
11951
12160
|
# Windows containers only support the use of the `local` driver. To
|
|
11952
12161
|
# use bind mounts, specify the `host` parameter instead.
|
|
11953
12162
|
#
|
|
11954
|
-
# <note markdown="1"> Docker volumes
|
|
12163
|
+
# <note markdown="1"> Docker volumes aren't supported by tasks run on Fargate.
|
|
11955
12164
|
#
|
|
11956
12165
|
# </note>
|
|
11957
12166
|
# @return [Types::DockerVolumeConfiguration]
|
|
11958
12167
|
#
|
|
11959
12168
|
# @!attribute [rw] efs_volume_configuration
|
|
11960
|
-
# This parameter is specified when you
|
|
11961
|
-
#
|
|
12169
|
+
# This parameter is specified when you use an Amazon Elastic File
|
|
12170
|
+
# System file system for task storage.
|
|
11962
12171
|
# @return [Types::EFSVolumeConfiguration]
|
|
11963
12172
|
#
|
|
11964
12173
|
# @!attribute [rw] fsx_windows_file_server_volume_configuration
|
|
11965
|
-
# This parameter is specified when you
|
|
11966
|
-
#
|
|
12174
|
+
# This parameter is specified when you use Amazon FSx for Windows File
|
|
12175
|
+
# Server file system for task storage.
|
|
11967
12176
|
# @return [Types::FSxWindowsFileServerVolumeConfiguration]
|
|
11968
12177
|
#
|
|
11969
12178
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Volume AWS API Documentation
|
|
@@ -11990,8 +12199,8 @@ module Aws::ECS
|
|
|
11990
12199
|
# }
|
|
11991
12200
|
#
|
|
11992
12201
|
# @!attribute [rw] source_container
|
|
11993
|
-
# The name of another container within the same task definition
|
|
11994
|
-
#
|
|
12202
|
+
# The name of another container within the same task definition to
|
|
12203
|
+
# mount volumes from.
|
|
11995
12204
|
# @return [String]
|
|
11996
12205
|
#
|
|
11997
12206
|
# @!attribute [rw] read_only
|