aws-sdk-ecs 1.89.0 → 1.90.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ecs/client.rb +515 -470
- data/lib/aws-sdk-ecs/client_api.rb +18 -0
- data/lib/aws-sdk-ecs/types.rb +1073 -985
- data/lib/aws-sdk-ecs.rb +1 -1
- metadata +2 -2
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,7 @@ module Aws::ECS
|
|
1468
1468
|
# Developer Guide*.
|
1469
1469
|
#
|
1470
1470
|
# For tasks using the Fargate launch type, the task or service
|
1471
|
-
# requires the
|
1471
|
+
# requires the following platforms:
|
1472
1472
|
#
|
1473
1473
|
# * Linux platform version `1.3.0` or later.
|
1474
1474
|
#
|
@@ -1485,19 +1485,19 @@ module Aws::ECS
|
|
1485
1485
|
# dependencies for a container. For example, you specify two
|
1486
1486
|
# containers in a task definition with containerA having a dependency
|
1487
1487
|
# on containerB reaching a `COMPLETE`, `SUCCESS`, or `HEALTHY` status.
|
1488
|
-
# If a `startTimeout` value is specified for containerB and it
|
1489
|
-
#
|
1490
|
-
#
|
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
|
1491
1491
|
# `STOPPED` state.
|
1492
1492
|
#
|
1493
1493
|
# <note markdown="1"> When the `ECS_CONTAINER_START_TIMEOUT` container agent configuration
|
1494
|
-
# variable is used, it
|
1495
|
-
# value.
|
1494
|
+
# variable is used, it's enforced independently from this start
|
1495
|
+
# timeout value.
|
1496
1496
|
#
|
1497
1497
|
# </note>
|
1498
1498
|
#
|
1499
1499
|
# For tasks using the Fargate launch type, the task or service
|
1500
|
-
# requires the
|
1500
|
+
# requires the following platforms:
|
1501
1501
|
#
|
1502
1502
|
# * Linux platform version `1.3.0` or later.
|
1503
1503
|
#
|
@@ -1509,7 +1509,7 @@ module Aws::ECS
|
|
1509
1509
|
# latest container agent version. For information about checking your
|
1510
1510
|
# agent version and updating to the latest version, see [Updating the
|
1511
1511
|
# Amazon ECS Container Agent][1] in the *Amazon Elastic Container
|
1512
|
-
# Service Developer Guide*. If you
|
1512
|
+
# Service Developer Guide*. If you're using an Amazon ECS-optimized
|
1513
1513
|
# Linux AMI, your instance needs at least version `1.26.0-1` of the
|
1514
1514
|
# `ecs-init` package. If your container instances are launched from
|
1515
1515
|
# version `20190301` or later, then they contain the required versions
|
@@ -1528,7 +1528,7 @@ module Aws::ECS
|
|
1528
1528
|
# forcefully killed if it doesn't exit normally on its own.
|
1529
1529
|
#
|
1530
1530
|
# For tasks using the Fargate launch type, the task or service
|
1531
|
-
# requires the
|
1531
|
+
# requires the following platforms:
|
1532
1532
|
#
|
1533
1533
|
# * Linux platform version `1.3.0` or later.
|
1534
1534
|
#
|
@@ -1537,10 +1537,10 @@ module Aws::ECS
|
|
1537
1537
|
# The max stop timeout value is 120 seconds and if the parameter is
|
1538
1538
|
# not specified, the default value of 30 seconds is used.
|
1539
1539
|
#
|
1540
|
-
# For tasks
|
1541
|
-
#
|
1542
|
-
# configuration variable `ECS_CONTAINER_STOP_TIMEOUT`
|
1543
|
-
#
|
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
|
1544
1544
|
# `ECS_CONTAINER_STOP_TIMEOUT` agent configuration variable are set,
|
1545
1545
|
# then the default values of 30 seconds for Linux containers and 30
|
1546
1546
|
# seconds on Windows containers are used. Your container instances
|
@@ -1549,7 +1549,7 @@ module Aws::ECS
|
|
1549
1549
|
# container agent version. For information about checking your agent
|
1550
1550
|
# version and updating to the latest version, see [Updating the Amazon
|
1551
1551
|
# ECS Container Agent][1] in the *Amazon Elastic Container Service
|
1552
|
-
# Developer Guide*. If you
|
1552
|
+
# Developer Guide*. If you're using an Amazon ECS-optimized Linux
|
1553
1553
|
# AMI, your instance needs at least version 1.26.0-1 of the `ecs-init`
|
1554
1554
|
# package. If your container instances are launched from version
|
1555
1555
|
# `20190301` or later, then they contain the required versions of the
|
@@ -1568,7 +1568,7 @@ module Aws::ECS
|
|
1568
1568
|
# `Hostname` in the [Create a container][1] section of the [Docker
|
1569
1569
|
# Remote API][2] and the `--hostname` option to [docker run][3].
|
1570
1570
|
#
|
1571
|
-
# <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
|
1572
1572
|
# `awsvpc` network mode.
|
1573
1573
|
#
|
1574
1574
|
# </note>
|
@@ -1585,9 +1585,9 @@ module Aws::ECS
|
|
1585
1585
|
# in the [Create a container][1] section of the [Docker Remote API][2]
|
1586
1586
|
# and the `--user` option to [docker run][3].
|
1587
1587
|
#
|
1588
|
-
# When running tasks using the `host` network mode,
|
1589
|
-
# containers using the root user (UID 0).
|
1590
|
-
#
|
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.
|
1591
1591
|
#
|
1592
1592
|
# You can specify the `user` using the following formats. If
|
1593
1593
|
# specifying a UID or GID, you must specify it as a positive integer.
|
@@ -1616,8 +1616,8 @@ module Aws::ECS
|
|
1616
1616
|
# @return [String]
|
1617
1617
|
#
|
1618
1618
|
# @!attribute [rw] working_directory
|
1619
|
-
# The working directory
|
1620
|
-
#
|
1619
|
+
# The working directory to run commands inside the container in. This
|
1620
|
+
# parameter maps to `WorkingDir` in the [Create a container][1]
|
1621
1621
|
# section of the [Docker Remote API][2] and the `--workdir` option to
|
1622
1622
|
# [docker run][3].
|
1623
1623
|
#
|
@@ -1719,7 +1719,7 @@ module Aws::ECS
|
|
1719
1719
|
# `ExtraHosts` in the [Create a container][1] section of the [Docker
|
1720
1720
|
# Remote API][2] and the `--add-host` option to [docker run][3].
|
1721
1721
|
#
|
1722
|
-
# <note markdown="1"> This parameter
|
1722
|
+
# <note markdown="1"> This parameter isn't supported for Windows containers or tasks that
|
1723
1723
|
# use the `awsvpc` network mode.
|
1724
1724
|
#
|
1725
1725
|
# </note>
|
@@ -1733,7 +1733,7 @@ module Aws::ECS
|
|
1733
1733
|
#
|
1734
1734
|
# @!attribute [rw] docker_security_options
|
1735
1735
|
# A list of strings to provide custom labels for SELinux and AppArmor
|
1736
|
-
# multi-level security systems. This field
|
1736
|
+
# multi-level security systems. This field isn't valid for containers
|
1737
1737
|
# in tasks using the Fargate launch type.
|
1738
1738
|
#
|
1739
1739
|
# With Windows containers, this parameter can be used to reference a
|
@@ -1771,11 +1771,11 @@ module Aws::ECS
|
|
1771
1771
|
# @return [Array<String>]
|
1772
1772
|
#
|
1773
1773
|
# @!attribute [rw] interactive
|
1774
|
-
# When this parameter is `true`,
|
1775
|
-
#
|
1776
|
-
#
|
1777
|
-
#
|
1778
|
-
#
|
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].
|
1779
1779
|
#
|
1780
1780
|
#
|
1781
1781
|
#
|
@@ -1815,8 +1815,8 @@ module Aws::ECS
|
|
1815
1815
|
#
|
1816
1816
|
# @!attribute [rw] ulimits
|
1817
1817
|
# A list of `ulimits` to set in the container. If a ulimit value is
|
1818
|
-
# specified in a task definition, it
|
1819
|
-
#
|
1818
|
+
# specified in a task definition, it overrides the default values set
|
1819
|
+
# by Docker. This parameter maps to `Ulimits` in the [Create a
|
1820
1820
|
# container][1] section of the [Docker Remote API][2] and the
|
1821
1821
|
# `--ulimit` option to [docker run][3]. Valid naming values are
|
1822
1822
|
# displayed in the Ulimit data type.
|
@@ -1851,12 +1851,12 @@ module Aws::ECS
|
|
1851
1851
|
# This parameter maps to `LogConfig` in the [Create a container][1]
|
1852
1852
|
# section of the [Docker Remote API][2] and the `--log-driver` option
|
1853
1853
|
# to [docker run][3]. By default, containers use the same logging
|
1854
|
-
# driver that the Docker daemon uses. However the container
|
1854
|
+
# driver that the Docker daemon uses. However the container can use a
|
1855
1855
|
# different logging driver than the Docker daemon by specifying a log
|
1856
1856
|
# driver with this parameter in the container definition. To use a
|
1857
1857
|
# different logging driver for a container, the log system must be
|
1858
1858
|
# configured properly on the container instance (or on a different log
|
1859
|
-
# server for remote logging options). For more information
|
1859
|
+
# server for remote logging options). For more information about the
|
1860
1860
|
# options for different supported log drivers, see [Configure logging
|
1861
1861
|
# drivers][4] in the Docker documentation.
|
1862
1862
|
#
|
@@ -1911,10 +1911,10 @@ module Aws::ECS
|
|
1911
1911
|
# of the [Docker Remote API][2] and the `--sysctl` option to [docker
|
1912
1912
|
# run][3].
|
1913
1913
|
#
|
1914
|
-
# <note markdown="1">
|
1914
|
+
# <note markdown="1"> We don't recommended that you specify network-related
|
1915
1915
|
# `systemControls` parameters for multiple containers in a single task
|
1916
1916
|
# that also uses either the `awsvpc` or `host` network modes. For
|
1917
|
-
# tasks that use the `awsvpc` network mode, the container that
|
1917
|
+
# tasks that use the `awsvpc` network mode, the container that's
|
1918
1918
|
# started last determines which `systemControls` parameters take
|
1919
1919
|
# effect. For tasks that use the `host` network mode, it changes the
|
1920
1920
|
# container instance's namespaced kernel parameters as well as the
|
@@ -2000,7 +2000,7 @@ module Aws::ECS
|
|
2000
2000
|
# recommend using the latest container agent version. For information
|
2001
2001
|
# about checking your agent version and updating to the latest version,
|
2002
2002
|
# see [Updating the Amazon ECS Container Agent][1] in the *Amazon
|
2003
|
-
# Elastic Container Service Developer Guide*. If you
|
2003
|
+
# Elastic Container Service Developer Guide*. If you're using an Amazon
|
2004
2004
|
# ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1
|
2005
2005
|
# of the `ecs-init` package. If your container instances are launched
|
2006
2006
|
# from version `20190301` or later, then they contain the required
|
@@ -2008,8 +2008,8 @@ module Aws::ECS
|
|
2008
2008
|
# see [Amazon ECS-optimized Linux AMI][2] in the *Amazon Elastic
|
2009
2009
|
# Container Service Developer Guide*.
|
2010
2010
|
#
|
2011
|
-
# <note markdown="1"> For tasks
|
2012
|
-
# the
|
2011
|
+
# <note markdown="1"> For tasks that use the Fargate launch type, the task or service
|
2012
|
+
# requires the following platforms:
|
2013
2013
|
#
|
2014
2014
|
# * Linux platform version `1.3.0` or later.
|
2015
2015
|
#
|
@@ -2045,12 +2045,12 @@ module Aws::ECS
|
|
2045
2045
|
# * `COMPLETE` - This condition validates that a dependent container
|
2046
2046
|
# runs to completion (exits) before permitting other containers to
|
2047
2047
|
# start. This can be useful for nonessential containers that run a
|
2048
|
-
# script and then exit. This condition
|
2048
|
+
# script and then exit. This condition can't be set on an essential
|
2049
2049
|
# container.
|
2050
2050
|
#
|
2051
2051
|
# * `SUCCESS` - This condition is the same as `COMPLETE`, but it also
|
2052
2052
|
# requires that the container exits with a `zero` status. This
|
2053
|
-
# condition
|
2053
|
+
# condition can't be set on an essential container.
|
2054
2054
|
#
|
2055
2055
|
# * `HEALTHY` - This condition validates that the dependent container
|
2056
2056
|
# passes its Docker health check before permitting other containers
|
@@ -2068,7 +2068,7 @@ module Aws::ECS
|
|
2068
2068
|
include Aws::Structure
|
2069
2069
|
end
|
2070
2070
|
|
2071
|
-
# An EC2 instance that
|
2071
|
+
# An EC2 instance that's running the Amazon ECS agent and has been
|
2072
2072
|
# registered with a cluster.
|
2073
2073
|
#
|
2074
2074
|
# @!attribute [rw] container_instance_arn
|
@@ -2088,13 +2088,14 @@ module Aws::ECS
|
|
2088
2088
|
# @return [String]
|
2089
2089
|
#
|
2090
2090
|
# @!attribute [rw] capacity_provider_name
|
2091
|
-
# The capacity provider associated with the container
|
2091
|
+
# The capacity provider that's associated with the container
|
2092
|
+
# instance.
|
2092
2093
|
# @return [String]
|
2093
2094
|
#
|
2094
2095
|
# @!attribute [rw] version
|
2095
2096
|
# The version counter for the container instance. Every time a
|
2096
2097
|
# container instance experiences a change that triggers a CloudWatch
|
2097
|
-
# event, the version counter is incremented. If you
|
2098
|
+
# event, the version counter is incremented. If you're replicating
|
2098
2099
|
# your Amazon ECS container instance state with CloudWatch Events, you
|
2099
2100
|
# can compare the version of a container instance reported by the
|
2100
2101
|
# Amazon ECS APIs with the version reported in CloudWatch Events for
|
@@ -2109,12 +2110,12 @@ module Aws::ECS
|
|
2109
2110
|
#
|
2110
2111
|
# @!attribute [rw] remaining_resources
|
2111
2112
|
# For CPU and memory resource types, this parameter describes the
|
2112
|
-
# remaining CPU and memory that
|
2113
|
-
#
|
2114
|
-
#
|
2115
|
-
#
|
2116
|
-
#
|
2117
|
-
#
|
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
|
2118
2119
|
# here is available for new tasks.
|
2119
2120
|
# @return [Array<Types::Resource>]
|
2120
2121
|
#
|
@@ -2147,7 +2148,7 @@ module Aws::ECS
|
|
2147
2148
|
# status.
|
2148
2149
|
#
|
2149
2150
|
# The `ACTIVE` status indicates that the container instance can accept
|
2150
|
-
# tasks. The `DRAINING` indicates that new tasks
|
2151
|
+
# tasks. The `DRAINING` indicates that new tasks aren't placed on the
|
2151
2152
|
# container instance and any service tasks running on the container
|
2152
2153
|
# instance are removed if possible. For more information, see
|
2153
2154
|
# [Container Instance Draining][1] in the *Amazon Elastic Container
|
@@ -2180,8 +2181,8 @@ module Aws::ECS
|
|
2180
2181
|
# @return [Integer]
|
2181
2182
|
#
|
2182
2183
|
# @!attribute [rw] agent_update_status
|
2183
|
-
# The status of the most recent agent update. If an update
|
2184
|
-
#
|
2184
|
+
# The status of the most recent agent update. If an update wasn't
|
2185
|
+
# ever requested, this value is `NULL`.
|
2185
2186
|
# @return [String]
|
2186
2187
|
#
|
2187
2188
|
# @!attribute [rw] attributes
|
@@ -2191,7 +2192,8 @@ module Aws::ECS
|
|
2191
2192
|
# @return [Array<Types::Attribute>]
|
2192
2193
|
#
|
2193
2194
|
# @!attribute [rw] registered_at
|
2194
|
-
# The Unix timestamp for when the container instance was
|
2195
|
+
# The Unix timestamp for the time when the container instance was
|
2196
|
+
# registered.
|
2195
2197
|
# @return [Time]
|
2196
2198
|
#
|
2197
2199
|
# @!attribute [rw] attachments
|
@@ -2202,7 +2204,7 @@ module Aws::ECS
|
|
2202
2204
|
# @!attribute [rw] tags
|
2203
2205
|
# The metadata that you apply to the container instance to help you
|
2204
2206
|
# categorize and organize them. Each tag consists of a key and an
|
2205
|
-
# optional value
|
2207
|
+
# optional value. You define both.
|
2206
2208
|
#
|
2207
2209
|
# The following basic restrictions apply to tags:
|
2208
2210
|
#
|
@@ -2230,6 +2232,10 @@ module Aws::ECS
|
|
2230
2232
|
# against your tags per resource limit.
|
2231
2233
|
# @return [Array<Types::Tag>]
|
2232
2234
|
#
|
2235
|
+
# @!attribute [rw] health_status
|
2236
|
+
# An object representing the health status of the container instance.
|
2237
|
+
# @return [Types::ContainerInstanceHealthStatus]
|
2238
|
+
#
|
2233
2239
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerInstance AWS API Documentation
|
2234
2240
|
#
|
2235
2241
|
class ContainerInstance < Struct.new(
|
@@ -2249,15 +2255,37 @@ module Aws::ECS
|
|
2249
2255
|
:attributes,
|
2250
2256
|
:registered_at,
|
2251
2257
|
:attachments,
|
2252
|
-
:tags
|
2258
|
+
:tags,
|
2259
|
+
:health_status)
|
2253
2260
|
SENSITIVE = []
|
2254
2261
|
include Aws::Structure
|
2255
2262
|
end
|
2256
2263
|
|
2257
|
-
#
|
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)
|
2281
|
+
SENSITIVE = []
|
2282
|
+
include Aws::Structure
|
2283
|
+
end
|
2284
|
+
|
2285
|
+
# The overrides that are sent to a container. An empty container
|
2258
2286
|
# override can be passed in. An example of an empty container override
|
2259
|
-
#
|
2260
|
-
#
|
2287
|
+
# is `\{"containerOverrides": [ ] \}`. If a non-empty container override
|
2288
|
+
# is specified, the `name` parameter must be included.
|
2261
2289
|
#
|
2262
2290
|
# @note When making an API call, you may pass ContainerOverride
|
2263
2291
|
# data as a hash:
|
@@ -2352,7 +2380,7 @@ module Aws::ECS
|
|
2352
2380
|
include Aws::Structure
|
2353
2381
|
end
|
2354
2382
|
|
2355
|
-
# An object
|
2383
|
+
# An object that represents a change in state for a container.
|
2356
2384
|
#
|
2357
2385
|
# @note When making an API call, you may pass ContainerStateChange
|
2358
2386
|
# data as a hash:
|
@@ -2392,7 +2420,7 @@ module Aws::ECS
|
|
2392
2420
|
# @return [Integer]
|
2393
2421
|
#
|
2394
2422
|
# @!attribute [rw] network_bindings
|
2395
|
-
# Any network bindings associated with the container.
|
2423
|
+
# Any network bindings that are associated with the container.
|
2396
2424
|
# @return [Array<Types::NetworkBinding>]
|
2397
2425
|
#
|
2398
2426
|
# @!attribute [rw] reason
|
@@ -2442,10 +2470,10 @@ module Aws::ECS
|
|
2442
2470
|
# }
|
2443
2471
|
#
|
2444
2472
|
# @!attribute [rw] name
|
2445
|
-
# The name of the capacity provider. Up to 255 characters are allowed
|
2446
|
-
#
|
2447
|
-
# hyphens. The name
|
2448
|
-
# "`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`".
|
2449
2477
|
# @return [String]
|
2450
2478
|
#
|
2451
2479
|
# @!attribute [rw] auto_scaling_group_provider
|
@@ -2453,9 +2481,9 @@ module Aws::ECS
|
|
2453
2481
|
# @return [Types::AutoScalingGroupProvider]
|
2454
2482
|
#
|
2455
2483
|
# @!attribute [rw] tags
|
2456
|
-
# The metadata that you apply to the capacity provider to
|
2457
|
-
#
|
2458
|
-
# 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.
|
2459
2487
|
#
|
2460
2488
|
# The following basic restrictions apply to tags:
|
2461
2489
|
#
|
@@ -2546,16 +2574,16 @@ module Aws::ECS
|
|
2546
2574
|
# }
|
2547
2575
|
#
|
2548
2576
|
# @!attribute [rw] cluster_name
|
2549
|
-
# The name of your cluster. If you
|
2550
|
-
# cluster, you create a cluster named `default`. Up to 255
|
2551
|
-
# (uppercase and lowercase), numbers, underscores, and hyphens
|
2552
|
-
# 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.
|
2553
2581
|
# @return [String]
|
2554
2582
|
#
|
2555
2583
|
# @!attribute [rw] tags
|
2556
2584
|
# The metadata that you apply to the cluster to help you categorize
|
2557
|
-
# and organize them. Each tag consists of a key and an optional value
|
2558
|
-
#
|
2585
|
+
# and organize them. Each tag consists of a key and an optional value.
|
2586
|
+
# You define both.
|
2559
2587
|
#
|
2560
2588
|
# The following basic restrictions apply to tags:
|
2561
2589
|
#
|
@@ -2586,8 +2614,8 @@ module Aws::ECS
|
|
2586
2614
|
# @!attribute [rw] settings
|
2587
2615
|
# The setting to use when creating a cluster. This parameter is used
|
2588
2616
|
# to enable CloudWatch Container Insights for a cluster. If this value
|
2589
|
-
# is specified, it
|
2590
|
-
#
|
2617
|
+
# is specified, it overrides the `containerInsights` value set with
|
2618
|
+
# PutAccountSetting or PutAccountSettingDefault.
|
2591
2619
|
# @return [Array<Types::ClusterSetting>]
|
2592
2620
|
#
|
2593
2621
|
# @!attribute [rw] configuration
|
@@ -2602,10 +2630,9 @@ module Aws::ECS
|
|
2602
2630
|
# calling the CreateService or RunTask actions.
|
2603
2631
|
#
|
2604
2632
|
# If specifying a capacity provider that uses an Auto Scaling group,
|
2605
|
-
# the capacity provider must
|
2606
|
-
#
|
2607
|
-
#
|
2608
|
-
# 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.
|
2609
2636
|
#
|
2610
2637
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
2611
2638
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
@@ -2619,13 +2646,13 @@ module Aws::ECS
|
|
2619
2646
|
#
|
2620
2647
|
# @!attribute [rw] default_capacity_provider_strategy
|
2621
2648
|
# The capacity provider strategy to set as the default for the
|
2622
|
-
# cluster.
|
2623
|
-
# 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
|
2624
2651
|
# capacity provider strategy or launch type specified, the default
|
2625
2652
|
# capacity provider strategy for the cluster is used.
|
2626
2653
|
#
|
2627
|
-
# If a default capacity provider strategy
|
2628
|
-
#
|
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
|
2629
2656
|
# PutClusterCapacityProviders API operation.
|
2630
2657
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
2631
2658
|
#
|
@@ -2733,8 +2760,8 @@ module Aws::ECS
|
|
2733
2760
|
# }
|
2734
2761
|
#
|
2735
2762
|
# @!attribute [rw] cluster
|
2736
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
2737
|
-
#
|
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
|
2738
2765
|
# default cluster is assumed.
|
2739
2766
|
# @return [String]
|
2740
2767
|
#
|
@@ -2748,11 +2775,11 @@ module Aws::ECS
|
|
2748
2775
|
#
|
2749
2776
|
# @!attribute [rw] task_definition
|
2750
2777
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
2751
|
-
# task definition to run in your service. If a `revision`
|
2778
|
+
# task definition to run in your service. If a `revision` isn't
|
2752
2779
|
# specified, the latest `ACTIVE` revision is used.
|
2753
2780
|
#
|
2754
|
-
# A task definition must be specified if the service
|
2755
|
-
#
|
2781
|
+
# A task definition must be specified if the service uses either the
|
2782
|
+
# `ECS` or `CODE_DEPLOY` deployment controllers.
|
2756
2783
|
# @return [String]
|
2757
2784
|
#
|
2758
2785
|
# @!attribute [rw] load_balancers
|
@@ -2760,56 +2787,57 @@ module Aws::ECS
|
|
2760
2787
|
# your service. For more information, see [Service Load Balancing][1]
|
2761
2788
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
2762
2789
|
#
|
2763
|
-
# If the service
|
2764
|
-
#
|
2765
|
-
#
|
2766
|
-
#
|
2767
|
-
#
|
2768
|
-
#
|
2769
|
-
#
|
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*.
|
2770
2797
|
#
|
2771
|
-
# If the service
|
2798
|
+
# If the service uses the `CODE_DEPLOY` deployment controller, the
|
2772
2799
|
# service is required to use either an Application Load Balancer or
|
2773
2800
|
# Network Load Balancer. When creating an CodeDeploy deployment group,
|
2774
2801
|
# you specify two target groups (referred to as a `targetGroupPair`).
|
2775
2802
|
# During a deployment, CodeDeploy determines which task set in your
|
2776
|
-
# service has the status `PRIMARY
|
2777
|
-
# 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
|
2778
2805
|
# replacement task set. The load balancer can also have up to two
|
2779
2806
|
# listeners: a required listener for production traffic and an
|
2780
|
-
# optional listener that
|
2807
|
+
# optional listener that you can use to perform validation tests with
|
2781
2808
|
# Lambda functions before routing production traffic to it.
|
2782
2809
|
#
|
2783
2810
|
# After you create a service using the `ECS` deployment controller,
|
2784
2811
|
# the load balancer name or target group ARN, container name, and
|
2785
|
-
# container port specified in the service definition are
|
2786
|
-
# you
|
2787
|
-
# 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.
|
2788
2815
|
#
|
2789
2816
|
# For Application Load Balancers and Network Load Balancers, this
|
2790
2817
|
# object must contain the load balancer target group ARN, the
|
2791
|
-
# container name
|
2792
|
-
# container
|
2793
|
-
# name parameter must be omitted. When a
|
2794
|
-
# placed on a container instance, the
|
2795
|
-
# combination is registered as a target in
|
2796
|
-
# 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.
|
2797
2824
|
#
|
2798
2825
|
# For Classic Load Balancers, this object must contain the load
|
2799
|
-
# balancer name, the container name
|
2800
|
-
#
|
2801
|
-
#
|
2802
|
-
# task from this service is placed on a container
|
2803
|
-
# container instance is registered with the load
|
2804
|
-
# 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.
|
2805
2832
|
#
|
2806
2833
|
# Services with tasks that use the `awsvpc` network mode (for example,
|
2807
2834
|
# those with the Fargate launch type) only support Application Load
|
2808
|
-
# Balancers and Network Load Balancers. Classic Load Balancers
|
2835
|
+
# Balancers and Network Load Balancers. Classic Load Balancers aren't
|
2809
2836
|
# supported. Also, when you create any target groups for these
|
2810
|
-
# services, you must choose `ip` as the target type, not `instance
|
2811
|
-
# because tasks that use the `awsvpc` network mode are
|
2812
|
-
# 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.
|
2813
2841
|
#
|
2814
2842
|
#
|
2815
2843
|
#
|
@@ -2822,7 +2850,7 @@ module Aws::ECS
|
|
2822
2850
|
# service. For more information, see [Service discovery][1].
|
2823
2851
|
#
|
2824
2852
|
# <note markdown="1"> Each service may be associated with one service registry. Multiple
|
2825
|
-
# service registries
|
2853
|
+
# service registries for each service isn't supported.
|
2826
2854
|
#
|
2827
2855
|
# </note>
|
2828
2856
|
#
|
@@ -2835,18 +2863,19 @@ module Aws::ECS
|
|
2835
2863
|
# The number of instantiations of the specified task definition to
|
2836
2864
|
# place and keep running on your cluster.
|
2837
2865
|
#
|
2838
|
-
# This is required if `schedulingStrategy` is `REPLICA` or
|
2839
|
-
# 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
|
2840
2868
|
# required.
|
2841
2869
|
# @return [Integer]
|
2842
2870
|
#
|
2843
2871
|
# @!attribute [rw] client_token
|
2844
|
-
#
|
2845
|
-
#
|
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.
|
2846
2875
|
# @return [String]
|
2847
2876
|
#
|
2848
2877
|
# @!attribute [rw] launch_type
|
2849
|
-
# The infrastructure
|
2878
|
+
# The infrastructure that you run your service on. For more
|
2850
2879
|
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
2851
2880
|
# Container Service Developer Guide*.
|
2852
2881
|
#
|
@@ -2862,8 +2891,8 @@ module Aws::ECS
|
|
2862
2891
|
# The `EC2` launch type runs your tasks on Amazon EC2 instances
|
2863
2892
|
# registered to your cluster.
|
2864
2893
|
#
|
2865
|
-
# The `EXTERNAL` launch type runs your tasks on your on-
|
2866
|
-
# 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.
|
2867
2896
|
#
|
2868
2897
|
# A service can use either a launch type or a capacity provider
|
2869
2898
|
# strategy. If a `launchType` is specified, the
|
@@ -2891,9 +2920,8 @@ module Aws::ECS
|
|
2891
2920
|
# The platform version that your tasks in the service are running on.
|
2892
2921
|
# A platform version is specified only for tasks using the Fargate
|
2893
2922
|
# launch type. If one isn't specified, the `LATEST` platform version
|
2894
|
-
# is used
|
2895
|
-
#
|
2896
|
-
# Guide*.
|
2923
|
+
# is used. For more information, see [Fargate platform versions][1] in
|
2924
|
+
# the *Amazon Elastic Container Service Developer Guide*.
|
2897
2925
|
#
|
2898
2926
|
#
|
2899
2927
|
#
|
@@ -2904,20 +2932,20 @@ module Aws::ECS
|
|
2904
2932
|
# The name or full Amazon Resource Name (ARN) of the IAM role that
|
2905
2933
|
# allows Amazon ECS to make calls to your load balancer on your
|
2906
2934
|
# behalf. This parameter is only permitted if you are using a load
|
2907
|
-
# balancer with your service and your task definition
|
2935
|
+
# balancer with your service and your task definition doesn't use the
|
2908
2936
|
# `awsvpc` network mode. If you specify the `role` parameter, you must
|
2909
2937
|
# also specify a load balancer object with the `loadBalancers`
|
2910
2938
|
# parameter.
|
2911
2939
|
#
|
2912
2940
|
# If your account has already created the Amazon ECS service-linked
|
2913
|
-
# role, that role is used
|
2914
|
-
#
|
2915
|
-
#
|
2916
|
-
#
|
2917
|
-
#
|
2918
|
-
#
|
2919
|
-
#
|
2920
|
-
#
|
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*.
|
2921
2949
|
#
|
2922
2950
|
# If your specified role has a path other than `/`, then you must
|
2923
2951
|
# either specify the full role ARN (this is recommended) or prefix the
|
@@ -2940,20 +2968,20 @@ module Aws::ECS
|
|
2940
2968
|
#
|
2941
2969
|
# @!attribute [rw] placement_constraints
|
2942
2970
|
# An array of placement constraint objects to use for tasks in your
|
2943
|
-
# service. You can specify a maximum of 10 constraints
|
2944
|
-
# limit includes constraints in the task definition and those
|
2945
|
-
# 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.
|
2946
2974
|
# @return [Array<Types::PlacementConstraint>]
|
2947
2975
|
#
|
2948
2976
|
# @!attribute [rw] placement_strategy
|
2949
2977
|
# The placement strategy objects to use for tasks in your service. You
|
2950
|
-
# can specify a maximum of 5 strategy rules
|
2978
|
+
# can specify a maximum of 5 strategy rules for each service.
|
2951
2979
|
# @return [Array<Types::PlacementStrategy>]
|
2952
2980
|
#
|
2953
2981
|
# @!attribute [rw] network_configuration
|
2954
2982
|
# The network configuration for the service. This parameter is
|
2955
2983
|
# required for task definitions that use the `awsvpc` network mode to
|
2956
|
-
# receive their own elastic network interface, and it
|
2984
|
+
# receive their own elastic network interface, and it isn't supported
|
2957
2985
|
# for other network modes. For more information, see [Task
|
2958
2986
|
# networking][1] in the *Amazon Elastic Container Service Developer
|
2959
2987
|
# Guide*.
|
@@ -2965,18 +2993,19 @@ module Aws::ECS
|
|
2965
2993
|
#
|
2966
2994
|
# @!attribute [rw] health_check_grace_period_seconds
|
2967
2995
|
# The period of time, in seconds, that the Amazon ECS service
|
2968
|
-
# scheduler
|
2969
|
-
#
|
2970
|
-
#
|
2971
|
-
#
|
2972
|
-
#
|
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.
|
2973
3001
|
#
|
2974
3002
|
# If your service's tasks take a while to start and respond to
|
2975
3003
|
# Elastic Load Balancing health checks, you can specify a health check
|
2976
|
-
# grace period of up to 2,147,483,647 seconds
|
2977
|
-
# Amazon ECS service scheduler ignores health check
|
2978
|
-
# period can prevent the service scheduler from
|
2979
|
-
# 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.
|
2980
3009
|
# @return [Integer]
|
2981
3010
|
#
|
2982
3011
|
# @!attribute [rw] scheduling_strategy
|
@@ -2990,14 +3019,14 @@ module Aws::ECS
|
|
2990
3019
|
# service scheduler spreads tasks across Availability Zones. You can
|
2991
3020
|
# use task placement strategies and constraints to customize task
|
2992
3021
|
# placement decisions. This scheduler strategy is required if the
|
2993
|
-
# service
|
2994
|
-
#
|
3022
|
+
# service uses the `CODE_DEPLOY` or `EXTERNAL` deployment controller
|
3023
|
+
# types.
|
2995
3024
|
#
|
2996
3025
|
# * `DAEMON`-The daemon scheduling strategy deploys exactly one task
|
2997
3026
|
# on each active container instance that meets all of the task
|
2998
3027
|
# placement constraints that you specify in your cluster. The
|
2999
3028
|
# service scheduler also evaluates the task placement constraints
|
3000
|
-
# for running tasks and will stop tasks that
|
3029
|
+
# for running tasks and will stop tasks that don't meet the
|
3001
3030
|
# placement constraints. When you're using this strategy, you
|
3002
3031
|
# don't need to specify a desired number of tasks, a task placement
|
3003
3032
|
# strategy, or use Service Auto Scaling policies.
|
@@ -3064,16 +3093,16 @@ module Aws::ECS
|
|
3064
3093
|
# @!attribute [rw] propagate_tags
|
3065
3094
|
# Specifies whether to propagate the tags from the task definition or
|
3066
3095
|
# the service to the tasks in the service. If no value is specified,
|
3067
|
-
# the tags
|
3096
|
+
# the tags aren't propagated. Tags can only be propagated to the
|
3068
3097
|
# tasks within the service during service creation. To add tags to a
|
3069
3098
|
# task after service creation or task creation, use the TagResource
|
3070
3099
|
# API action.
|
3071
3100
|
# @return [String]
|
3072
3101
|
#
|
3073
3102
|
# @!attribute [rw] enable_execute_command
|
3074
|
-
#
|
3075
|
-
# service. If `true`, this enables execute command functionality
|
3076
|
-
# 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.
|
3077
3106
|
# @return [Boolean]
|
3078
3107
|
#
|
3079
3108
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateServiceRequest AWS API Documentation
|
@@ -3109,14 +3138,14 @@ module Aws::ECS
|
|
3109
3138
|
# The full description of your service following the create call.
|
3110
3139
|
#
|
3111
3140
|
# A service will return either a `capacityProviderStrategy` or
|
3112
|
-
# `launchType` parameter, but not both, depending
|
3113
|
-
# specified
|
3141
|
+
# `launchType` parameter, but not both, depending where one was
|
3142
|
+
# specified when it was created.
|
3114
3143
|
#
|
3115
3144
|
# If a service is using the `ECS` deployment controller, the
|
3116
3145
|
# `deploymentController` and `taskSets` parameters will not be
|
3117
3146
|
# returned.
|
3118
3147
|
#
|
3119
|
-
#
|
3148
|
+
# if the service uses the `CODE_DEPLOY` deployment controller, the
|
3120
3149
|
# `deploymentController`, `taskSets` and `deployments` parameters will
|
3121
3150
|
# be returned, however the `deployments` parameter will be an empty
|
3122
3151
|
# list.
|
@@ -3225,7 +3254,7 @@ module Aws::ECS
|
|
3225
3254
|
# @return [Array<Types::ServiceRegistry>]
|
3226
3255
|
#
|
3227
3256
|
# @!attribute [rw] launch_type
|
3228
|
-
# The launch type that new tasks in the task set
|
3257
|
+
# The launch type that new tasks in the task set uses. For more
|
3229
3258
|
# information, see [Amazon ECS Launch Types][1] in the *Amazon Elastic
|
3230
3259
|
# Container Service Developer Guide*.
|
3231
3260
|
#
|
@@ -3268,10 +3297,9 @@ module Aws::ECS
|
|
3268
3297
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
3269
3298
|
#
|
3270
3299
|
# @!attribute [rw] platform_version
|
3271
|
-
# The platform version that the tasks in the task set
|
3272
|
-
#
|
3273
|
-
#
|
3274
|
-
# 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.
|
3275
3303
|
# @return [String]
|
3276
3304
|
#
|
3277
3305
|
# @!attribute [rw] scale
|
@@ -3280,15 +3308,15 @@ module Aws::ECS
|
|
3280
3308
|
# @return [Types::Scale]
|
3281
3309
|
#
|
3282
3310
|
# @!attribute [rw] client_token
|
3283
|
-
#
|
3284
|
-
#
|
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.
|
3285
3314
|
# @return [String]
|
3286
3315
|
#
|
3287
3316
|
# @!attribute [rw] tags
|
3288
3317
|
# The metadata that you apply to the task set to help you categorize
|
3289
|
-
# and organize them. Each tag consists of a key and an optional value
|
3290
|
-
#
|
3291
|
-
# 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.
|
3292
3320
|
#
|
3293
3321
|
# The following basic restrictions apply to tags:
|
3294
3322
|
#
|
@@ -3360,7 +3388,7 @@ module Aws::ECS
|
|
3360
3388
|
# }
|
3361
3389
|
#
|
3362
3390
|
# @!attribute [rw] name
|
3363
|
-
# The resource name
|
3391
|
+
# The resource name to disable the account setting for. If
|
3364
3392
|
# `serviceLongArnFormat` is specified, the ARN for your Amazon ECS
|
3365
3393
|
# services is affected. If `taskLongArnFormat` is specified, the ARN
|
3366
3394
|
# and resource ID for your Amazon ECS tasks is affected. If
|
@@ -3371,12 +3399,12 @@ module Aws::ECS
|
|
3371
3399
|
# @return [String]
|
3372
3400
|
#
|
3373
3401
|
# @!attribute [rw] principal_arn
|
3374
|
-
# The ARN of the principal
|
3375
|
-
# root user. If you specify the root user, it
|
3376
|
-
# setting for all IAM users, IAM roles, and the
|
3377
|
-
# account unless an IAM user or role explicitly
|
3378
|
-
# settings. If this field is omitted, the setting is
|
3379
|
-
# 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.
|
3380
3408
|
# @return [String]
|
3381
3409
|
#
|
3382
3410
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteAccountSettingRequest AWS API Documentation
|
@@ -3423,8 +3451,8 @@ module Aws::ECS
|
|
3423
3451
|
#
|
3424
3452
|
# @!attribute [rw] attributes
|
3425
3453
|
# The attributes to delete from your resource. You can specify up to
|
3426
|
-
# 10 attributes
|
3427
|
-
# 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
|
3428
3456
|
# specify the target ID using the short form, you must also specify
|
3429
3457
|
# the target type.
|
3430
3458
|
# @return [Array<Types::Attribute>]
|
@@ -3535,9 +3563,9 @@ module Aws::ECS
|
|
3535
3563
|
# @return [String]
|
3536
3564
|
#
|
3537
3565
|
# @!attribute [rw] force
|
3538
|
-
# If `true`, allows you to delete a service even if it
|
3539
|
-
#
|
3540
|
-
#
|
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.
|
3541
3569
|
# @return [Boolean]
|
3542
3570
|
#
|
3543
3571
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteServiceRequest AWS API Documentation
|
@@ -3574,7 +3602,7 @@ module Aws::ECS
|
|
3574
3602
|
#
|
3575
3603
|
# @!attribute [rw] cluster
|
3576
3604
|
# The short name or full Amazon Resource Name (ARN) of the cluster
|
3577
|
-
# that hosts the service that the task set
|
3605
|
+
# that hosts the service that the task set found in to delete.
|
3578
3606
|
# @return [String]
|
3579
3607
|
#
|
3580
3608
|
# @!attribute [rw] service
|
@@ -3588,8 +3616,8 @@ module Aws::ECS
|
|
3588
3616
|
# @return [String]
|
3589
3617
|
#
|
3590
3618
|
# @!attribute [rw] force
|
3591
|
-
# If `true`,
|
3592
|
-
#
|
3619
|
+
# If `true`, you can delete a task set even if it hasn't been scaled
|
3620
|
+
# down to zero.
|
3593
3621
|
# @return [Boolean]
|
3594
3622
|
#
|
3595
3623
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteTaskSetRequest AWS API Documentation
|
@@ -3623,7 +3651,7 @@ module Aws::ECS
|
|
3623
3651
|
# @return [String]
|
3624
3652
|
#
|
3625
3653
|
# @!attribute [rw] status
|
3626
|
-
# The status of the deployment. The following describes each state
|
3654
|
+
# The status of the deployment. The following describes each state.
|
3627
3655
|
#
|
3628
3656
|
# PRIMARY
|
3629
3657
|
#
|
@@ -3673,11 +3701,13 @@ module Aws::ECS
|
|
3673
3701
|
# @return [Integer]
|
3674
3702
|
#
|
3675
3703
|
# @!attribute [rw] created_at
|
3676
|
-
# The Unix timestamp for when the service deployment was
|
3704
|
+
# The Unix timestamp for the time when the service deployment was
|
3705
|
+
# created.
|
3677
3706
|
# @return [Time]
|
3678
3707
|
#
|
3679
3708
|
# @!attribute [rw] updated_at
|
3680
|
-
# 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.
|
3681
3711
|
# @return [Time]
|
3682
3712
|
#
|
3683
3713
|
# @!attribute [rw] capacity_provider_strategy
|
@@ -3695,12 +3725,11 @@ module Aws::ECS
|
|
3695
3725
|
# @return [String]
|
3696
3726
|
#
|
3697
3727
|
# @!attribute [rw] platform_version
|
3698
|
-
# The platform version
|
3699
|
-
#
|
3700
|
-
# launch type. If one
|
3701
|
-
# is used
|
3702
|
-
#
|
3703
|
-
# 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*.
|
3704
3733
|
#
|
3705
3734
|
#
|
3706
3735
|
#
|
@@ -3724,18 +3753,18 @@ module Aws::ECS
|
|
3724
3753
|
#
|
3725
3754
|
# @!attribute [rw] rollout_state
|
3726
3755
|
# <note markdown="1"> The `rolloutState` of a service is only returned for services that
|
3727
|
-
# use the rolling update (`ECS`) deployment type that
|
3756
|
+
# use the rolling update (`ECS`) deployment type that aren't behind a
|
3728
3757
|
# Classic Load Balancer.
|
3729
3758
|
#
|
3730
3759
|
# </note>
|
3731
3760
|
#
|
3732
3761
|
# The rollout state of the deployment. When a service deployment is
|
3733
3762
|
# started, it begins in an `IN_PROGRESS` state. When the service
|
3734
|
-
# reaches a steady state, the deployment
|
3735
|
-
#
|
3736
|
-
#
|
3737
|
-
#
|
3738
|
-
#
|
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.
|
3739
3768
|
# @return [String]
|
3740
3769
|
#
|
3741
3770
|
# @!attribute [rw] rollout_state_reason
|
@@ -3766,7 +3795,7 @@ module Aws::ECS
|
|
3766
3795
|
end
|
3767
3796
|
|
3768
3797
|
# <note markdown="1"> The deployment circuit breaker can only be used for services using the
|
3769
|
-
# rolling update (`ECS`) deployment type that
|
3798
|
+
# rolling update (`ECS`) deployment type that aren't behind a Classic
|
3770
3799
|
# Load Balancer.
|
3771
3800
|
#
|
3772
3801
|
# </note>
|
@@ -3792,15 +3821,15 @@ module Aws::ECS
|
|
3792
3821
|
# }
|
3793
3822
|
#
|
3794
3823
|
# @!attribute [rw] enable
|
3795
|
-
#
|
3796
|
-
# service.
|
3824
|
+
# Determines whether to enable the deployment circuit breaker logic
|
3825
|
+
# for the service.
|
3797
3826
|
# @return [Boolean]
|
3798
3827
|
#
|
3799
3828
|
# @!attribute [rw] rollback
|
3800
|
-
#
|
3801
|
-
# deployment fails. If rollback is enabled, when a service
|
3802
|
-
# fails, the service is rolled back to the last deployment
|
3803
|
-
# 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.
|
3804
3833
|
# @return [Boolean]
|
3805
3834
|
#
|
3806
3835
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeploymentCircuitBreaker AWS API Documentation
|
@@ -3877,10 +3906,10 @@ module Aws::ECS
|
|
3877
3906
|
# service has a desired number of four tasks and a minimum healthy
|
3878
3907
|
# percent of 50%, the scheduler may stop two existing tasks to free up
|
3879
3908
|
# cluster capacity before starting two new tasks. Tasks for services
|
3880
|
-
# 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
|
3881
3910
|
# in the `RUNNING` state; tasks for services that *do* use a load
|
3882
|
-
# balancer are considered healthy if they
|
3883
|
-
# 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
|
3884
3913
|
# value for minimum healthy percent is 100%.
|
3885
3914
|
#
|
3886
3915
|
# If a service is using the blue/green (`CODE_DEPLOY`) or `EXTERNAL`
|
@@ -3979,13 +4008,13 @@ module Aws::ECS
|
|
3979
4008
|
# @return [String]
|
3980
4009
|
#
|
3981
4010
|
# @!attribute [rw] force
|
3982
|
-
# Forces the
|
3983
|
-
#
|
3984
|
-
#
|
3985
|
-
#
|
3986
|
-
#
|
3987
|
-
#
|
3988
|
-
#
|
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
|
3989
4018
|
# task, on a different container instance if possible.
|
3990
4019
|
#
|
3991
4020
|
# Any containers in orphaned service tasks that are registered with a
|
@@ -4068,7 +4097,7 @@ module Aws::ECS
|
|
4068
4097
|
# @!attribute [rw] include
|
4069
4098
|
# Specifies whether or not you want to see the resource tags for the
|
4070
4099
|
# capacity provider. If `TAGS` is specified, the tags are included in
|
4071
|
-
# the response. If this field is omitted, tags
|
4100
|
+
# the response. If this field is omitted, tags aren't included in the
|
4072
4101
|
# response.
|
4073
4102
|
# @return [Array<String>]
|
4074
4103
|
#
|
@@ -4150,9 +4179,9 @@ module Aws::ECS
|
|
4150
4179
|
# @return [Array<String>]
|
4151
4180
|
#
|
4152
4181
|
# @!attribute [rw] include
|
4153
|
-
#
|
4154
|
-
# response. If this field is omitted, this information
|
4155
|
-
# 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.
|
4156
4185
|
#
|
4157
4186
|
# If `ATTACHMENTS` is specified, the attachments for the container
|
4158
4187
|
# instances or tasks within the cluster are included.
|
@@ -4202,7 +4231,7 @@ module Aws::ECS
|
|
4202
4231
|
# {
|
4203
4232
|
# cluster: "String",
|
4204
4233
|
# container_instances: ["String"], # required
|
4205
|
-
# include: ["TAGS"], # accepts TAGS
|
4234
|
+
# include: ["TAGS"], # accepts TAGS, CONTAINER_INSTANCE_HEALTH
|
4206
4235
|
# }
|
4207
4236
|
#
|
4208
4237
|
# @!attribute [rw] cluster
|
@@ -4222,8 +4251,10 @@ module Aws::ECS
|
|
4222
4251
|
# @!attribute [rw] include
|
4223
4252
|
# Specifies whether you want to see the resource tags for the
|
4224
4253
|
# container instance. If `TAGS` is specified, the tags are included in
|
4225
|
-
# the response. If
|
4226
|
-
# 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.
|
4227
4258
|
# @return [Array<String>]
|
4228
4259
|
#
|
4229
4260
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeContainerInstancesRequest AWS API Documentation
|
@@ -4276,9 +4307,10 @@ module Aws::ECS
|
|
4276
4307
|
# @return [Array<String>]
|
4277
4308
|
#
|
4278
4309
|
# @!attribute [rw] include
|
4279
|
-
#
|
4280
|
-
# If `TAGS` is specified, the tags are included in the
|
4281
|
-
# 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.
|
4282
4314
|
# @return [Array<String>]
|
4283
4315
|
#
|
4284
4316
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServicesRequest AWS API Documentation
|
@@ -4324,9 +4356,9 @@ module Aws::ECS
|
|
4324
4356
|
# @return [String]
|
4325
4357
|
#
|
4326
4358
|
# @!attribute [rw] include
|
4327
|
-
#
|
4359
|
+
# Determines whether to see the resource tags for the task definition.
|
4328
4360
|
# If `TAGS` is specified, the tags are included in the response. If
|
4329
|
-
# this field is omitted, tags
|
4361
|
+
# this field is omitted, tags aren't included in the response.
|
4330
4362
|
# @return [Array<String>]
|
4331
4363
|
#
|
4332
4364
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskDefinitionRequest AWS API Documentation
|
@@ -4343,9 +4375,9 @@ module Aws::ECS
|
|
4343
4375
|
# @return [Types::TaskDefinition]
|
4344
4376
|
#
|
4345
4377
|
# @!attribute [rw] tags
|
4346
|
-
# The metadata that
|
4378
|
+
# The metadata that's applied to the task definition to help you
|
4347
4379
|
# categorize and organize them. Each tag consists of a key and an
|
4348
|
-
# optional value
|
4380
|
+
# optional value. You define both.
|
4349
4381
|
#
|
4350
4382
|
# The following basic restrictions apply to tags:
|
4351
4383
|
#
|
@@ -4409,7 +4441,7 @@ module Aws::ECS
|
|
4409
4441
|
# @!attribute [rw] include
|
4410
4442
|
# Specifies whether to see the resource tags for the task set. If
|
4411
4443
|
# `TAGS` is specified, the tags are included in the response. If this
|
4412
|
-
# field is omitted, tags
|
4444
|
+
# field is omitted, tags aren't included in the response.
|
4413
4445
|
# @return [Array<String>]
|
4414
4446
|
#
|
4415
4447
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskSetsRequest AWS API Documentation
|
@@ -4464,7 +4496,7 @@ module Aws::ECS
|
|
4464
4496
|
# @!attribute [rw] include
|
4465
4497
|
# Specifies whether you want to see the resource tags for the task. If
|
4466
4498
|
# `TAGS` is specified, the tags are included in the response. If this
|
4467
|
-
# field is omitted, tags
|
4499
|
+
# field is omitted, tags aren't included in the response.
|
4468
4500
|
# @return [Array<String>]
|
4469
4501
|
#
|
4470
4502
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTasksRequest AWS API Documentation
|
@@ -4547,8 +4579,8 @@ module Aws::ECS
|
|
4547
4579
|
# @return [String]
|
4548
4580
|
#
|
4549
4581
|
# @!attribute [rw] cluster
|
4550
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
4551
|
-
#
|
4582
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster
|
4583
|
+
# that the container instance belongs to.
|
4552
4584
|
# @return [String]
|
4553
4585
|
#
|
4554
4586
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DiscoverPollEndpointRequest AWS API Documentation
|
@@ -4577,8 +4609,8 @@ module Aws::ECS
|
|
4577
4609
|
include Aws::Structure
|
4578
4610
|
end
|
4579
4611
|
|
4580
|
-
# This parameter is specified when you
|
4581
|
-
# 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.
|
4582
4614
|
# Windows containers only support the use of the `local` driver. To use
|
4583
4615
|
# bind mounts, specify a `host` instead.
|
4584
4616
|
#
|
@@ -4606,7 +4638,7 @@ module Aws::ECS
|
|
4606
4638
|
# @return [String]
|
4607
4639
|
#
|
4608
4640
|
# @!attribute [rw] autoprovision
|
4609
|
-
# 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
|
4610
4642
|
# already exist.
|
4611
4643
|
#
|
4612
4644
|
# <note markdown="1"> This field is only used if the `scope` is `shared`.
|
@@ -4698,12 +4730,13 @@ module Aws::ECS
|
|
4698
4730
|
# @return [String]
|
4699
4731
|
#
|
4700
4732
|
# @!attribute [rw] iam
|
4701
|
-
#
|
4702
|
-
# definition when mounting the Amazon EFS file system. If
|
4703
|
-
# transit encryption must be enabled in the
|
4704
|
-
# If this parameter is omitted, the default
|
4705
|
-
# used. For more information, see [Using Amazon
|
4706
|
-
# 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*.
|
4707
4740
|
#
|
4708
4741
|
#
|
4709
4742
|
#
|
@@ -4719,7 +4752,7 @@ module Aws::ECS
|
|
4719
4752
|
include Aws::Structure
|
4720
4753
|
end
|
4721
4754
|
|
4722
|
-
# This parameter is specified when you
|
4755
|
+
# This parameter is specified when you're using an Amazon Elastic File
|
4723
4756
|
# System file system for task storage. For more information, see [Amazon
|
4724
4757
|
# EFS Volumes][1] in the *Amazon Elastic Container Service Developer
|
4725
4758
|
# Guide*.
|
@@ -4758,12 +4791,12 @@ module Aws::ECS
|
|
4758
4791
|
# @return [String]
|
4759
4792
|
#
|
4760
4793
|
# @!attribute [rw] transit_encryption
|
4761
|
-
#
|
4762
|
-
# between the Amazon ECS host and the Amazon EFS server.
|
4763
|
-
# encryption must be enabled if Amazon EFS IAM authorization
|
4764
|
-
# If this parameter is omitted, the default value of
|
4765
|
-
# used. For more information, see [Encrypting Data in
|
4766
|
-
# 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*.
|
4767
4800
|
#
|
4768
4801
|
#
|
4769
4802
|
#
|
@@ -4804,14 +4837,14 @@ module Aws::ECS
|
|
4804
4837
|
# have a `.env` file extension. Each line in an environment file should
|
4805
4838
|
# contain an environment variable in `VARIABLE=VALUE` format. Lines
|
4806
4839
|
# beginning with `#` are treated as comments and are ignored. For more
|
4807
|
-
# information
|
4840
|
+
# information about the environment variable file syntax, see [Declare
|
4808
4841
|
# default environment variables in file][1].
|
4809
4842
|
#
|
4810
4843
|
# If there are environment variables specified using the `environment`
|
4811
4844
|
# parameter in a container definition, they take precedence over the
|
4812
4845
|
# variables contained within an environment file. If multiple
|
4813
|
-
# environment files are specified that contain the same variable,
|
4814
|
-
#
|
4846
|
+
# environment files are specified that contain the same variable,
|
4847
|
+
# they're processed from the top down. We recommend that you use unique
|
4815
4848
|
# variable names. For more information, see [Specifying environment
|
4816
4849
|
# variables][2] in the *Amazon Elastic Container Service Developer
|
4817
4850
|
# Guide*.
|
@@ -4972,8 +5005,8 @@ module Aws::ECS
|
|
4972
5005
|
# @return [String]
|
4973
5006
|
#
|
4974
5007
|
# @!attribute [rw] cloud_watch_encryption_enabled
|
4975
|
-
#
|
4976
|
-
# specified, encryption will be disabled.
|
5008
|
+
# Determines whether to enable encryption on the CloudWatch logs. If
|
5009
|
+
# not specified, encryption will be disabled.
|
4977
5010
|
# @return [Boolean]
|
4978
5011
|
#
|
4979
5012
|
# @!attribute [rw] s3_bucket_name
|
@@ -4985,8 +5018,8 @@ module Aws::ECS
|
|
4985
5018
|
# @return [String]
|
4986
5019
|
#
|
4987
5020
|
# @!attribute [rw] s3_encryption_enabled
|
4988
|
-
#
|
4989
|
-
# encryption is not used.
|
5021
|
+
# Determines whether to use encryption on the S3 logs. If not
|
5022
|
+
# specified, encryption is not used.
|
4990
5023
|
# @return [Boolean]
|
4991
5024
|
#
|
4992
5025
|
# @!attribute [rw] s3_key_prefix
|
@@ -5066,9 +5099,9 @@ module Aws::ECS
|
|
5066
5099
|
# @return [String]
|
5067
5100
|
#
|
5068
5101
|
# @!attribute [rw] interactive
|
5069
|
-
#
|
5070
|
-
# mode. Amazon ECS only supports initiating interactive
|
5071
|
-
# 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.
|
5072
5105
|
# @return [Boolean]
|
5073
5106
|
#
|
5074
5107
|
# @!attribute [rw] session
|
@@ -5141,7 +5174,7 @@ module Aws::ECS
|
|
5141
5174
|
include Aws::Structure
|
5142
5175
|
end
|
5143
5176
|
|
5144
|
-
# This parameter is specified when you
|
5177
|
+
# This parameter is specified when you're using [Amazon FSx for Windows
|
5145
5178
|
# File Server][1] file system for task storage.
|
5146
5179
|
#
|
5147
5180
|
# For more information and the input format, see [Amazon FSx for Windows
|
@@ -5288,7 +5321,7 @@ module Aws::ECS
|
|
5288
5321
|
#
|
5289
5322
|
# * `UNHEALTHY`-The container health check has failed.
|
5290
5323
|
#
|
5291
|
-
# * `UNKNOWN`-The container health check is being evaluated or there
|
5324
|
+
# * `UNKNOWN`-The container health check is being evaluated or there's
|
5292
5325
|
# no container health check defined.
|
5293
5326
|
#
|
5294
5327
|
# The following describes the possible `healthStatus` values for a task.
|
@@ -5316,12 +5349,12 @@ module Aws::ECS
|
|
5316
5349
|
# Amazon ECS container agent. For more information, see [Updating the
|
5317
5350
|
# Amazon ECS Container Agent][1].
|
5318
5351
|
#
|
5319
|
-
# * Container health checks are supported for Fargate tasks if you
|
5352
|
+
# * Container health checks are supported for Fargate tasks if you're
|
5320
5353
|
# using platform version 1.1.0 or greater. For more information, see
|
5321
5354
|
# [Fargate Platform Versions][2].
|
5322
5355
|
#
|
5323
|
-
# * Container health checks
|
5324
|
-
# 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.
|
5325
5358
|
#
|
5326
5359
|
#
|
5327
5360
|
#
|
@@ -5346,13 +5379,13 @@ module Aws::ECS
|
|
5346
5379
|
# command with the container's default shell.
|
5347
5380
|
#
|
5348
5381
|
# When you use the Amazon Web Services Management Console JSON panel,
|
5349
|
-
# the Command Line Interface, or the APIs,
|
5350
|
-
#
|
5382
|
+
# the Command Line Interface, or the APIs, enclose the list of
|
5383
|
+
# commands in brackets.
|
5351
5384
|
#
|
5352
5385
|
# `[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]`
|
5353
5386
|
#
|
5354
|
-
# You
|
5355
|
-
# Services Management
|
5387
|
+
# You don't need to include the brackets when you use the Amazon Web
|
5388
|
+
# Services Management Console.
|
5356
5389
|
#
|
5357
5390
|
# ` "CMD-SHELL", "curl -f http://localhost/ || exit 1" `
|
5358
5391
|
#
|
@@ -5385,10 +5418,10 @@ module Aws::ECS
|
|
5385
5418
|
# @return [Integer]
|
5386
5419
|
#
|
5387
5420
|
# @!attribute [rw] start_period
|
5388
|
-
# The optional grace period
|
5389
|
-
#
|
5390
|
-
#
|
5391
|
-
# `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.
|
5392
5425
|
#
|
5393
5426
|
# <note markdown="1"> If a health check succeeds within the `startPeriod`, then the
|
5394
5427
|
# container is considered healthy and any subsequent failures count
|
@@ -5449,16 +5482,16 @@ module Aws::ECS
|
|
5449
5482
|
#
|
5450
5483
|
# @!attribute [rw] source_path
|
5451
5484
|
# When the `host` parameter is used, specify a `sourcePath` to declare
|
5452
|
-
# the path on the host container instance that
|
5485
|
+
# the path on the host container instance that's presented to the
|
5453
5486
|
# container. If this parameter is empty, then the Docker daemon has
|
5454
5487
|
# assigned a host path for you. If the `host` parameter contains a
|
5455
5488
|
# `sourcePath` file location, then the data volume persists at the
|
5456
5489
|
# specified location on the host container instance until you delete
|
5457
|
-
# it manually. If the `sourcePath` value
|
5490
|
+
# it manually. If the `sourcePath` value doesn't exist on the host
|
5458
5491
|
# container instance, the Docker daemon creates it. If the location
|
5459
5492
|
# does exist, the contents of the source path folder are exported.
|
5460
5493
|
#
|
5461
|
-
# If you
|
5494
|
+
# If you're using the Fargate launch type, the `sourcePath` parameter
|
5462
5495
|
# is not supported.
|
5463
5496
|
# @return [String]
|
5464
5497
|
#
|
@@ -5470,7 +5503,7 @@ module Aws::ECS
|
|
5470
5503
|
include Aws::Structure
|
5471
5504
|
end
|
5472
5505
|
|
5473
|
-
# Details on
|
5506
|
+
# Details on an Elastic Inference accelerator. For more information, see
|
5474
5507
|
# [Working with Amazon Elastic Inference on Amazon ECS][1] in the
|
5475
5508
|
# *Amazon Elastic Container Service Developer Guide*.
|
5476
5509
|
#
|
@@ -5542,7 +5575,39 @@ module Aws::ECS
|
|
5542
5575
|
include Aws::Structure
|
5543
5576
|
end
|
5544
5577
|
|
5545
|
-
#
|
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
|
5546
5611
|
# for the API request.
|
5547
5612
|
#
|
5548
5613
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/InvalidParameterException AWS API Documentation
|
@@ -5551,10 +5616,11 @@ module Aws::ECS
|
|
5551
5616
|
|
5552
5617
|
# The Linux capabilities for the container that are added to or dropped
|
5553
5618
|
# from the default configuration provided by Docker. For more
|
5554
|
-
# information
|
5555
|
-
# capabilities, see [Runtime privilege and Linux
|
5556
|
-
# *Docker run reference*. For more detailed
|
5557
|
-
# 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.
|
5558
5624
|
#
|
5559
5625
|
#
|
5560
5626
|
#
|
@@ -5658,7 +5724,7 @@ module Aws::ECS
|
|
5658
5724
|
include Aws::Structure
|
5659
5725
|
end
|
5660
5726
|
|
5661
|
-
# The limit for the resource
|
5727
|
+
# The limit for the resource was exceeded.
|
5662
5728
|
#
|
5663
5729
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/LimitExceededException AWS API Documentation
|
5664
5730
|
#
|
@@ -5711,8 +5777,8 @@ module Aws::ECS
|
|
5711
5777
|
# `Devices` in the [Create a container][1] section of the [Docker
|
5712
5778
|
# Remote API][2] and the `--device` option to [docker run][3].
|
5713
5779
|
#
|
5714
|
-
# <note markdown="1"> If you
|
5715
|
-
# `devices` parameter
|
5780
|
+
# <note markdown="1"> If you're using tasks that use the Fargate launch type, the
|
5781
|
+
# `devices` parameter isn't supported.
|
5716
5782
|
#
|
5717
5783
|
# </note>
|
5718
5784
|
#
|
@@ -5756,8 +5822,8 @@ module Aws::ECS
|
|
5756
5822
|
# mount. This parameter maps to the `--tmpfs` option to [docker
|
5757
5823
|
# run][1].
|
5758
5824
|
#
|
5759
|
-
# <note markdown="1"> If you
|
5760
|
-
# parameter
|
5825
|
+
# <note markdown="1"> If you're using tasks that use the Fargate launch type, the `tmpfs`
|
5826
|
+
# parameter isn't supported.
|
5761
5827
|
#
|
5762
5828
|
# </note>
|
5763
5829
|
#
|
@@ -5779,8 +5845,8 @@ module Aws::ECS
|
|
5779
5845
|
# `maxSwap` value must be set for the `swappiness` parameter to be
|
5780
5846
|
# used.
|
5781
5847
|
#
|
5782
|
-
# <note markdown="1"> If you
|
5783
|
-
# `maxSwap` parameter
|
5848
|
+
# <note markdown="1"> If you're using tasks that use the Fargate launch type, the
|
5849
|
+
# `maxSwap` parameter isn't supported.
|
5784
5850
|
#
|
5785
5851
|
# </note>
|
5786
5852
|
#
|
@@ -5800,8 +5866,8 @@ module Aws::ECS
|
|
5800
5866
|
# parameter maps to the `--memory-swappiness` option to [docker
|
5801
5867
|
# run][1].
|
5802
5868
|
#
|
5803
|
-
# <note markdown="1"> If you
|
5804
|
-
# `swappiness` parameter
|
5869
|
+
# <note markdown="1"> If you're using tasks that use the Fargate launch type, the
|
5870
|
+
# `swappiness` parameter isn't supported.
|
5805
5871
|
#
|
5806
5872
|
# </note>
|
5807
5873
|
#
|
@@ -5841,8 +5907,8 @@ module Aws::ECS
|
|
5841
5907
|
# @return [String]
|
5842
5908
|
#
|
5843
5909
|
# @!attribute [rw] value
|
5844
|
-
# The value of the account settings
|
5845
|
-
#
|
5910
|
+
# The value of the account settings to filter results with. You must
|
5911
|
+
# also specify an account setting name to use this parameter.
|
5846
5912
|
# @return [String]
|
5847
5913
|
#
|
5848
5914
|
# @!attribute [rw] principal_arn
|
@@ -5857,18 +5923,18 @@ module Aws::ECS
|
|
5857
5923
|
# @return [String]
|
5858
5924
|
#
|
5859
5925
|
# @!attribute [rw] effective_settings
|
5860
|
-
#
|
5926
|
+
# Determines whether to return the effective settings. If `true`, the
|
5861
5927
|
# account settings for the root user or the default setting for the
|
5862
5928
|
# `principalArn` are returned. If `false`, the account settings for
|
5863
|
-
# the `principalArn` are returned if they
|
5929
|
+
# the `principalArn` are returned if they're set. Otherwise, no
|
5864
5930
|
# account settings are returned.
|
5865
5931
|
# @return [Boolean]
|
5866
5932
|
#
|
5867
5933
|
# @!attribute [rw] next_token
|
5868
5934
|
# The `nextToken` value returned from a `ListAccountSettings` request
|
5869
5935
|
# indicating that more results are available to fulfill the request
|
5870
|
-
# and further calls will be needed. If `maxResults` was provided,
|
5871
|
-
#
|
5936
|
+
# and further calls will be needed. If `maxResults` was provided,
|
5937
|
+
# it's possible the number of results to be fewer than `maxResults`.
|
5872
5938
|
#
|
5873
5939
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only
|
5874
5940
|
# used to retrieve the next items in a list and not for other
|
@@ -5884,7 +5950,7 @@ module Aws::ECS
|
|
5884
5950
|
# single page along with a `nextToken` response element. The remaining
|
5885
5951
|
# results of the initial request can be seen by sending another
|
5886
5952
|
# `ListAccountSettings` request with the returned `nextToken` value.
|
5887
|
-
# 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,
|
5888
5954
|
# then `ListAccountSettings` returns up to 10 results and a
|
5889
5955
|
# `nextToken` value if applicable.
|
5890
5956
|
# @return [Integer]
|
@@ -5942,23 +6008,23 @@ module Aws::ECS
|
|
5942
6008
|
# @return [String]
|
5943
6009
|
#
|
5944
6010
|
# @!attribute [rw] target_type
|
5945
|
-
# The type of the target
|
6011
|
+
# The type of the target to list attributes with.
|
5946
6012
|
# @return [String]
|
5947
6013
|
#
|
5948
6014
|
# @!attribute [rw] attribute_name
|
5949
|
-
# The name of the attribute
|
6015
|
+
# The name of the attribute to filter the results with.
|
5950
6016
|
# @return [String]
|
5951
6017
|
#
|
5952
6018
|
# @!attribute [rw] attribute_value
|
5953
|
-
# The value of the attribute
|
5954
|
-
#
|
6019
|
+
# The value of the attribute to filter results with. You must also
|
6020
|
+
# specify an attribute name to use this parameter.
|
5955
6021
|
# @return [String]
|
5956
6022
|
#
|
5957
6023
|
# @!attribute [rw] next_token
|
5958
6024
|
# The `nextToken` value returned from a `ListAttributes` request
|
5959
6025
|
# indicating that more results are available to fulfill the request
|
5960
|
-
# and further calls
|
5961
|
-
#
|
6026
|
+
# and further calls are needed. If `maxResults` was provided, it's
|
6027
|
+
# possible the number of results to be fewer than `maxResults`.
|
5962
6028
|
#
|
5963
6029
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only
|
5964
6030
|
# used to retrieve the next items in a list and not for other
|
@@ -5968,13 +6034,13 @@ module Aws::ECS
|
|
5968
6034
|
# @return [String]
|
5969
6035
|
#
|
5970
6036
|
# @!attribute [rw] max_results
|
5971
|
-
# The maximum number of cluster results
|
6037
|
+
# The maximum number of cluster results that `ListAttributes` returned
|
5972
6038
|
# in paginated output. When this parameter is used, `ListAttributes`
|
5973
6039
|
# only returns `maxResults` results in a single page along with a
|
5974
6040
|
# `nextToken` response element. The remaining results of the initial
|
5975
6041
|
# request can be seen by sending another `ListAttributes` request with
|
5976
6042
|
# the returned `nextToken` value. This value can be between 1 and 100.
|
5977
|
-
# If this parameter
|
6043
|
+
# If this parameter isn't used, then `ListAttributes` returns up to
|
5978
6044
|
# 100 results and a `nextToken` value if applicable.
|
5979
6045
|
# @return [Integer]
|
5980
6046
|
#
|
@@ -6023,8 +6089,8 @@ module Aws::ECS
|
|
6023
6089
|
# @!attribute [rw] next_token
|
6024
6090
|
# The `nextToken` value returned from a `ListClusters` request
|
6025
6091
|
# indicating that more results are available to fulfill the request
|
6026
|
-
# and further calls
|
6027
|
-
#
|
6092
|
+
# and further calls are needed. If `maxResults` was provided, it's
|
6093
|
+
# possible the number of results to be fewer than `maxResults`.
|
6028
6094
|
#
|
6029
6095
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only
|
6030
6096
|
# used to retrieve the next items in a list and not for other
|
@@ -6034,13 +6100,13 @@ module Aws::ECS
|
|
6034
6100
|
# @return [String]
|
6035
6101
|
#
|
6036
6102
|
# @!attribute [rw] max_results
|
6037
|
-
# The maximum number of cluster results
|
6038
|
-
# paginated output. When this parameter is used, `ListClusters`
|
6039
|
-
# 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
|
6040
6106
|
# `nextToken` response element. The remaining results of the initial
|
6041
6107
|
# request can be seen by sending another `ListClusters` request with
|
6042
6108
|
# the returned `nextToken` value. This value can be between 1 and 100.
|
6043
|
-
# If this parameter
|
6109
|
+
# If this parameter isn't used, then `ListClusters` returns up to 100
|
6044
6110
|
# results and a `nextToken` value if applicable.
|
6045
6111
|
# @return [Integer]
|
6046
6112
|
#
|
@@ -6055,7 +6121,7 @@ module Aws::ECS
|
|
6055
6121
|
|
6056
6122
|
# @!attribute [rw] cluster_arns
|
6057
6123
|
# The list of full Amazon Resource Name (ARN) entries for each cluster
|
6058
|
-
# associated with your account.
|
6124
|
+
# that's associated with your account.
|
6059
6125
|
# @return [Array<String>]
|
6060
6126
|
#
|
6061
6127
|
# @!attribute [rw] next_token
|
@@ -6105,9 +6171,8 @@ module Aws::ECS
|
|
6105
6171
|
# @!attribute [rw] next_token
|
6106
6172
|
# The `nextToken` value returned from a `ListContainerInstances`
|
6107
6173
|
# request indicating that more results are available to fulfill the
|
6108
|
-
# request and further calls
|
6109
|
-
#
|
6110
|
-
# `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`.
|
6111
6176
|
#
|
6112
6177
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only
|
6113
6178
|
# used to retrieve the next items in a list and not for other
|
@@ -6117,22 +6182,22 @@ module Aws::ECS
|
|
6117
6182
|
# @return [String]
|
6118
6183
|
#
|
6119
6184
|
# @!attribute [rw] max_results
|
6120
|
-
# The maximum number of container instance results
|
6121
|
-
# `ListContainerInstances` in paginated output. When this
|
6122
|
-
# used, `ListContainerInstances` only returns
|
6123
|
-
# a single page along with a `nextToken`
|
6124
|
-
# remaining results of the initial request can
|
6125
|
-
# another `ListContainerInstances` request with the
|
6126
|
-
# `nextToken` value. This value can be between 1 and 100. If
|
6127
|
-
# parameter
|
6128
|
-
# 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.
|
6129
6194
|
# @return [Integer]
|
6130
6195
|
#
|
6131
6196
|
# @!attribute [rw] status
|
6132
6197
|
# Filters the container instances by status. For example, if you
|
6133
6198
|
# specify the `DRAINING` status, the results include only container
|
6134
6199
|
# instances that have been set to `DRAINING` using
|
6135
|
-
# UpdateContainerInstancesState. If you
|
6200
|
+
# UpdateContainerInstancesState. If you don't specify this parameter,
|
6136
6201
|
# the default is to include container instances set to all states
|
6137
6202
|
# other than `INACTIVE`.
|
6138
6203
|
# @return [String]
|
@@ -6202,13 +6267,13 @@ module Aws::ECS
|
|
6202
6267
|
# @return [String]
|
6203
6268
|
#
|
6204
6269
|
# @!attribute [rw] max_results
|
6205
|
-
# The maximum number of service results
|
6206
|
-
# paginated output. When this parameter is used, `ListServices`
|
6207
|
-
# 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
|
6208
6273
|
# `nextToken` response element. The remaining results of the initial
|
6209
6274
|
# request can be seen by sending another `ListServices` request with
|
6210
6275
|
# the returned `nextToken` value. This value can be between 1 and 100.
|
6211
|
-
# If this parameter
|
6276
|
+
# If this parameter isn't used, then `ListServices` returns up to 10
|
6212
6277
|
# results and a `nextToken` value if applicable.
|
6213
6278
|
# @return [Integer]
|
6214
6279
|
#
|
@@ -6234,8 +6299,8 @@ module Aws::ECS
|
|
6234
6299
|
end
|
6235
6300
|
|
6236
6301
|
# @!attribute [rw] service_arns
|
6237
|
-
# The list of full ARN entries for each service associated
|
6238
|
-
# specified cluster.
|
6302
|
+
# The list of full ARN entries for each service that's associated
|
6303
|
+
# with the specified cluster.
|
6239
6304
|
# @return [Array<String>]
|
6240
6305
|
#
|
6241
6306
|
# @!attribute [rw] next_token
|
@@ -6262,10 +6327,10 @@ module Aws::ECS
|
|
6262
6327
|
# }
|
6263
6328
|
#
|
6264
6329
|
# @!attribute [rw] resource_arn
|
6265
|
-
# The Amazon Resource Name (ARN) that identifies the resource
|
6266
|
-
#
|
6267
|
-
#
|
6268
|
-
#
|
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.
|
6269
6334
|
# @return [String]
|
6270
6335
|
#
|
6271
6336
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTagsForResourceRequest AWS API Documentation
|
@@ -6299,22 +6364,22 @@ module Aws::ECS
|
|
6299
6364
|
# }
|
6300
6365
|
#
|
6301
6366
|
# @!attribute [rw] family_prefix
|
6302
|
-
# The `familyPrefix` is a string that
|
6367
|
+
# The `familyPrefix` is a string that's used to filter the results of
|
6303
6368
|
# `ListTaskDefinitionFamilies`. If you specify a `familyPrefix`, only
|
6304
6369
|
# task definition family names that begin with the `familyPrefix`
|
6305
6370
|
# string are returned.
|
6306
6371
|
# @return [String]
|
6307
6372
|
#
|
6308
6373
|
# @!attribute [rw] status
|
6309
|
-
# The task definition family status
|
6310
|
-
# `ListTaskDefinitionFamilies` results. By default, both `ACTIVE`
|
6311
|
-
# `INACTIVE` task definition families are listed. If this
|
6312
|
-
# set to `ACTIVE`, only task definition families that
|
6313
|
-
# task definition revision are returned. If this
|
6314
|
-
# `INACTIVE`, only task definition families that
|
6315
|
-
# `ACTIVE` task definition revisions are returned. If
|
6316
|
-
# resulting output, be sure to keep the `status`
|
6317
|
-
# 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.
|
6318
6383
|
# @return [String]
|
6319
6384
|
#
|
6320
6385
|
# @!attribute [rw] next_token
|
@@ -6332,14 +6397,14 @@ module Aws::ECS
|
|
6332
6397
|
# @return [String]
|
6333
6398
|
#
|
6334
6399
|
# @!attribute [rw] max_results
|
6335
|
-
# The maximum number of task definition family results
|
6336
|
-
# `ListTaskDefinitionFamilies` in paginated output. When this
|
6400
|
+
# The maximum number of task definition family results that
|
6401
|
+
# `ListTaskDefinitionFamilies` returned in paginated output. When this
|
6337
6402
|
# parameter is used, `ListTaskDefinitions` only returns `maxResults`
|
6338
6403
|
# results in a single page along with a `nextToken` response element.
|
6339
6404
|
# The remaining results of the initial request can be seen by sending
|
6340
6405
|
# another `ListTaskDefinitionFamilies` request with the returned
|
6341
6406
|
# `nextToken` value. This value can be between 1 and 100. If this
|
6342
|
-
# parameter
|
6407
|
+
# parameter isn't used, then `ListTaskDefinitionFamilies` returns up
|
6343
6408
|
# to 100 results and a `nextToken` value if applicable.
|
6344
6409
|
# @return [Integer]
|
6345
6410
|
#
|
@@ -6388,29 +6453,28 @@ module Aws::ECS
|
|
6388
6453
|
# }
|
6389
6454
|
#
|
6390
6455
|
# @!attribute [rw] family_prefix
|
6391
|
-
# The full family name
|
6392
|
-
#
|
6393
|
-
#
|
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.
|
6394
6459
|
# @return [String]
|
6395
6460
|
#
|
6396
6461
|
# @!attribute [rw] status
|
6397
|
-
# The task definition status
|
6398
|
-
#
|
6399
|
-
#
|
6400
|
-
#
|
6401
|
-
#
|
6402
|
-
#
|
6403
|
-
# 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.
|
6404
6468
|
# @return [String]
|
6405
6469
|
#
|
6406
6470
|
# @!attribute [rw] sort
|
6407
|
-
# The order
|
6408
|
-
#
|
6409
|
-
#
|
6410
|
-
#
|
6411
|
-
#
|
6412
|
-
#
|
6413
|
-
#
|
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.
|
6414
6478
|
# @return [String]
|
6415
6479
|
#
|
6416
6480
|
# @!attribute [rw] next_token
|
@@ -6427,14 +6491,14 @@ module Aws::ECS
|
|
6427
6491
|
# @return [String]
|
6428
6492
|
#
|
6429
6493
|
# @!attribute [rw] max_results
|
6430
|
-
# The maximum number of task definition results
|
6431
|
-
# `ListTaskDefinitions` in paginated output. When this
|
6432
|
-
# used, `ListTaskDefinitions` only returns `maxResults`
|
6433
|
-
# single page along with a `nextToken` response element.
|
6434
|
-
# results of the initial request can be seen by sending
|
6435
|
-
# `ListTaskDefinitions` request with the returned `nextToken`
|
6436
|
-
# This value can be between 1 and 100. If this parameter
|
6437
|
-
# 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
|
6438
6502
|
# `nextToken` value if applicable.
|
6439
6503
|
# @return [Integer]
|
6440
6504
|
#
|
@@ -6509,7 +6573,7 @@ module Aws::ECS
|
|
6509
6573
|
# @!attribute [rw] next_token
|
6510
6574
|
# The `nextToken` value returned from a `ListTasks` request indicating
|
6511
6575
|
# that more results are available to fulfill the request and further
|
6512
|
-
# calls will be needed. If `maxResults` was provided, it
|
6576
|
+
# calls will be needed. If `maxResults` was provided, it's possible
|
6513
6577
|
# the number of results to be fewer than `maxResults`.
|
6514
6578
|
#
|
6515
6579
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only
|
@@ -6520,20 +6584,20 @@ module Aws::ECS
|
|
6520
6584
|
# @return [String]
|
6521
6585
|
#
|
6522
6586
|
# @!attribute [rw] max_results
|
6523
|
-
# The maximum number of task results
|
6587
|
+
# The maximum number of task results that `ListTasks` returned in
|
6524
6588
|
# paginated output. When this parameter is used, `ListTasks` only
|
6525
6589
|
# returns `maxResults` results in a single page along with a
|
6526
6590
|
# `nextToken` response element. The remaining results of the initial
|
6527
6591
|
# request can be seen by sending another `ListTasks` request with the
|
6528
6592
|
# returned `nextToken` value. This value can be between 1 and 100. If
|
6529
|
-
# this parameter
|
6593
|
+
# this parameter isn't used, then `ListTasks` returns up to 100
|
6530
6594
|
# results and a `nextToken` value if applicable.
|
6531
6595
|
# @return [Integer]
|
6532
6596
|
#
|
6533
6597
|
# @!attribute [rw] started_by
|
6534
|
-
# The `startedBy` value
|
6535
|
-
#
|
6536
|
-
#
|
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.
|
6537
6601
|
# @return [String]
|
6538
6602
|
#
|
6539
6603
|
# @!attribute [rw] service_name
|
@@ -6546,13 +6610,13 @@ module Aws::ECS
|
|
6546
6610
|
# The task desired status to use when filtering the `ListTasks`
|
6547
6611
|
# results. Specifying a `desiredStatus` of `STOPPED` limits the
|
6548
6612
|
# results to tasks that Amazon ECS has set the desired status to
|
6549
|
-
# `STOPPED`. This can be useful for debugging tasks that
|
6613
|
+
# `STOPPED`. This can be useful for debugging tasks that aren't
|
6550
6614
|
# starting properly or have died or finished. The default status
|
6551
6615
|
# filter is `RUNNING`, which shows tasks that Amazon ECS has set the
|
6552
6616
|
# desired status to `RUNNING`.
|
6553
6617
|
#
|
6554
6618
|
# <note markdown="1"> Although you can filter results based on a desired status of
|
6555
|
-
# `PENDING`, this
|
6619
|
+
# `PENDING`, this doesn't return any results. Amazon ECS never sets
|
6556
6620
|
# the desired status of a task to that value (only a task's
|
6557
6621
|
# `lastStatus` may have a value of `PENDING`).
|
6558
6622
|
#
|
@@ -6620,25 +6684,25 @@ module Aws::ECS
|
|
6620
6684
|
# target group or groups associated with a service or task set.
|
6621
6685
|
#
|
6622
6686
|
# A target group ARN is only specified when using an Application Load
|
6623
|
-
# Balancer or Network Load Balancer. If you
|
6624
|
-
# 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.
|
6625
6689
|
#
|
6626
6690
|
# For services using the `ECS` deployment controller, you can specify
|
6627
6691
|
# one or multiple target groups. For more information, see
|
6628
6692
|
# [Registering Multiple Target Groups with a Service][1] in the
|
6629
6693
|
# *Amazon Elastic Container Service Developer Guide*.
|
6630
6694
|
#
|
6631
|
-
# For services using the `CODE_DEPLOY` deployment controller, you
|
6695
|
+
# For services using the `CODE_DEPLOY` deployment controller, you're
|
6632
6696
|
# required to define two target groups for the load balancer. For more
|
6633
6697
|
# information, see [Blue/Green Deployment with CodeDeploy][2] in the
|
6634
6698
|
# *Amazon Elastic Container Service Developer Guide*.
|
6635
6699
|
#
|
6636
|
-
# If your service's task definition uses the `awsvpc` network mode
|
6637
|
-
#
|
6638
|
-
#
|
6639
|
-
#
|
6640
|
-
#
|
6641
|
-
#
|
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.
|
6642
6706
|
#
|
6643
6707
|
#
|
6644
6708
|
#
|
@@ -6664,7 +6728,7 @@ module Aws::ECS
|
|
6664
6728
|
# The port on the container to associate with the load balancer. This
|
6665
6729
|
# port must correspond to a `containerPort` in the task definition the
|
6666
6730
|
# tasks in the service are using. For tasks that use the EC2 launch
|
6667
|
-
# type, the container instance they
|
6731
|
+
# type, the container instance they're launched on must allow ingress
|
6668
6732
|
# traffic on the `hostPort` of the port mapping.
|
6669
6733
|
# @return [Integer]
|
6670
6734
|
#
|
@@ -6684,14 +6748,14 @@ module Aws::ECS
|
|
6684
6748
|
# Remote API][2] and the `--log-driver` option to [ `docker run` ][3].
|
6685
6749
|
#
|
6686
6750
|
# By default, containers use the same logging driver that the Docker
|
6687
|
-
# daemon uses
|
6688
|
-
# than the Docker daemon by specifying a log driver configuration
|
6689
|
-
# container definition. For more information
|
6690
|
-
# different supported log drivers, see [Configure logging
|
6691
|
-
# 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.
|
6692
6756
|
#
|
6693
|
-
#
|
6694
|
-
#
|
6757
|
+
# Understand the following when specifying a log configuration for your
|
6758
|
+
# containers.
|
6695
6759
|
#
|
6696
6760
|
# * Amazon ECS currently supports a subset of the logging drivers
|
6697
6761
|
# available to the Docker daemon (shown in the valid values below).
|
@@ -6701,19 +6765,19 @@ module Aws::ECS
|
|
6701
6765
|
# * This parameter requires version 1.18 of the Docker Remote API or
|
6702
6766
|
# greater on your container instance.
|
6703
6767
|
#
|
6704
|
-
# * For tasks hosted on Amazon EC2 instances, the Amazon ECS
|
6705
|
-
# 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
|
6706
6770
|
# `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before
|
6707
6771
|
# containers placed on that instance can use these log configuration
|
6708
6772
|
# options. For more information, see [Amazon ECS container agent
|
6709
6773
|
# configuration][5] in the *Amazon Elastic Container Service Developer
|
6710
6774
|
# Guide*.
|
6711
6775
|
#
|
6712
|
-
# * For tasks on Fargate, because you
|
6776
|
+
# * For tasks that are on Fargate, because you don't have access to the
|
6713
6777
|
# underlying infrastructure your tasks are hosted on, any additional
|
6714
|
-
# software needed
|
6715
|
-
#
|
6716
|
-
#
|
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.
|
6717
6781
|
#
|
6718
6782
|
#
|
6719
6783
|
#
|
@@ -6757,11 +6821,11 @@ module Aws::ECS
|
|
6757
6821
|
# [Custom log routing][2] in the *Amazon Elastic Container Service
|
6758
6822
|
# Developer Guide*.
|
6759
6823
|
#
|
6760
|
-
# <note markdown="1"> If you have a custom driver that
|
6761
|
-
# 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]
|
6762
6826
|
# and customize it to work with that driver. We encourage you to
|
6763
6827
|
# submit pull requests for changes that you would like to have
|
6764
|
-
# included. However, we
|
6828
|
+
# included. However, we don't currently provide support for running
|
6765
6829
|
# modified copies of this software.
|
6766
6830
|
#
|
6767
6831
|
# </note>
|
@@ -6805,7 +6869,8 @@ module Aws::ECS
|
|
6805
6869
|
# Details about the managed agent status for the container.
|
6806
6870
|
#
|
6807
6871
|
# @!attribute [rw] last_started_at
|
6808
|
-
# 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.
|
6809
6874
|
# @return [Time]
|
6810
6875
|
#
|
6811
6876
|
# @!attribute [rw] name
|
@@ -6845,7 +6910,7 @@ module Aws::ECS
|
|
6845
6910
|
# }
|
6846
6911
|
#
|
6847
6912
|
# @!attribute [rw] container_name
|
6848
|
-
# The name of the container associated with the managed agent.
|
6913
|
+
# The name of the container that's associated with the managed agent.
|
6849
6914
|
# @return [String]
|
6850
6915
|
#
|
6851
6916
|
# @!attribute [rw] managed_agent_name
|
@@ -6876,7 +6941,7 @@ module Aws::ECS
|
|
6876
6941
|
#
|
6877
6942
|
# When managed scaling is enabled, Amazon ECS manages the scale-in and
|
6878
6943
|
# scale-out actions of the Auto Scaling group. Amazon ECS manages a
|
6879
|
-
# target tracking scaling policy using an Amazon ECS
|
6944
|
+
# target tracking scaling policy using an Amazon ECS managed CloudWatch
|
6880
6945
|
# metric with the specified `targetCapacity` value as the target value
|
6881
6946
|
# for the metric. For more information, see [Using Managed Scaling][1]
|
6882
6947
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
@@ -6900,26 +6965,27 @@ module Aws::ECS
|
|
6900
6965
|
# }
|
6901
6966
|
#
|
6902
6967
|
# @!attribute [rw] status
|
6903
|
-
#
|
6968
|
+
# Determines whether to enable managed scaling for the capacity
|
6969
|
+
# provider.
|
6904
6970
|
# @return [String]
|
6905
6971
|
#
|
6906
6972
|
# @!attribute [rw] target_capacity
|
6907
6973
|
# The target capacity value for the capacity provider. The specified
|
6908
6974
|
# value must be greater than `0` and less than or equal to `100`. A
|
6909
|
-
# value of `100`
|
6910
|
-
# Scaling group being completely
|
6975
|
+
# value of `100` results in the Amazon EC2 instances in your Auto
|
6976
|
+
# Scaling group being completely used.
|
6911
6977
|
# @return [Integer]
|
6912
6978
|
#
|
6913
6979
|
# @!attribute [rw] minimum_scaling_step_size
|
6914
|
-
# The minimum number of container instances that Amazon ECS
|
6915
|
-
#
|
6916
|
-
#
|
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.
|
6917
6983
|
# @return [Integer]
|
6918
6984
|
#
|
6919
6985
|
# @!attribute [rw] maximum_scaling_step_size
|
6920
|
-
# The maximum number of container instances that Amazon ECS
|
6921
|
-
#
|
6922
|
-
#
|
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.
|
6923
6989
|
# @return [Integer]
|
6924
6990
|
#
|
6925
6991
|
# @!attribute [rw] instance_warmup_period
|
@@ -6941,17 +7007,17 @@ module Aws::ECS
|
|
6941
7007
|
include Aws::Structure
|
6942
7008
|
end
|
6943
7009
|
|
6944
|
-
# Amazon ECS
|
6945
|
-
#
|
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
|
6946
7012
|
# information to proceed with an update. This could be because the agent
|
6947
|
-
# running on the container instance is
|
6948
|
-
#
|
7013
|
+
# running on the container instance is a previous or custom version that
|
7014
|
+
# doesn't use our version information.
|
6949
7015
|
#
|
6950
7016
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/MissingVersionException AWS API Documentation
|
6951
7017
|
#
|
6952
7018
|
class MissingVersionException < Aws::EmptyStructure; end
|
6953
7019
|
|
6954
|
-
# Details
|
7020
|
+
# Details for a volume mount point that's used in a container
|
6955
7021
|
# definition.
|
6956
7022
|
#
|
6957
7023
|
# @note When making an API call, you may pass MountPoint
|
@@ -7009,12 +7075,12 @@ module Aws::ECS
|
|
7009
7075
|
# @return [String]
|
7010
7076
|
#
|
7011
7077
|
# @!attribute [rw] container_port
|
7012
|
-
# The port number on the container that
|
7078
|
+
# The port number on the container that's used with the network
|
7013
7079
|
# binding.
|
7014
7080
|
# @return [Integer]
|
7015
7081
|
#
|
7016
7082
|
# @!attribute [rw] host_port
|
7017
|
-
# The port number on the host that
|
7083
|
+
# The port number on the host that's used with the network binding.
|
7018
7084
|
# @return [Integer]
|
7019
7085
|
#
|
7020
7086
|
# @!attribute [rw] protocol
|
@@ -7047,7 +7113,7 @@ module Aws::ECS
|
|
7047
7113
|
# }
|
7048
7114
|
#
|
7049
7115
|
# @!attribute [rw] awsvpc_configuration
|
7050
|
-
# The VPC subnets and security groups associated with a task.
|
7116
|
+
# The VPC subnets and security groups that are associated with a task.
|
7051
7117
|
#
|
7052
7118
|
# <note markdown="1"> All specified subnets and security groups must be from the same VPC.
|
7053
7119
|
#
|
@@ -7087,9 +7153,10 @@ module Aws::ECS
|
|
7087
7153
|
include Aws::Structure
|
7088
7154
|
end
|
7089
7155
|
|
7090
|
-
# There
|
7091
|
-
#
|
7092
|
-
# 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.
|
7093
7160
|
#
|
7094
7161
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/NoUpdateAvailableException AWS API Documentation
|
7095
7162
|
#
|
@@ -7099,8 +7166,8 @@ module Aws::ECS
|
|
7099
7166
|
# information, see [Task Placement Constraints][1] in the *Amazon
|
7100
7167
|
# Elastic Container Service Developer Guide*.
|
7101
7168
|
#
|
7102
|
-
# <note markdown="1"> If you
|
7103
|
-
#
|
7169
|
+
# <note markdown="1"> If you're using the Fargate launch type, task placement constraints
|
7170
|
+
# aren't supported.
|
7104
7171
|
#
|
7105
7172
|
# </note>
|
7106
7173
|
#
|
@@ -7166,16 +7233,16 @@ module Aws::ECS
|
|
7166
7233
|
# placement strategy spreads placement across available candidates
|
7167
7234
|
# evenly based on the `field` parameter. The `binpack` strategy places
|
7168
7235
|
# tasks on available candidates that have the least available amount
|
7169
|
-
# of the resource that
|
7236
|
+
# of the resource that's specified with the `field` parameter. For
|
7170
7237
|
# example, if you binpack on memory, a task is placed on the instance
|
7171
|
-
# with the least amount of remaining memory
|
7172
|
-
# the task
|
7238
|
+
# with the least amount of remaining memory but still enough to run
|
7239
|
+
# the task.
|
7173
7240
|
# @return [String]
|
7174
7241
|
#
|
7175
7242
|
# @!attribute [rw] field
|
7176
7243
|
# The field to apply the placement strategy against. For the `spread`
|
7177
7244
|
# placement strategy, valid values are `instanceId` (or `host`, which
|
7178
|
-
# has the same effect), or any platform or custom attribute that
|
7245
|
+
# has the same effect), or any platform or custom attribute that's
|
7179
7246
|
# applied to a container instance, such as
|
7180
7247
|
# `attribute:ecs.availability-zone`. For the `binpack` placement
|
7181
7248
|
# strategy, valid values are `cpu` and `memory`. For the `random`
|
@@ -7203,13 +7270,13 @@ module Aws::ECS
|
|
7203
7270
|
# }
|
7204
7271
|
#
|
7205
7272
|
# @!attribute [rw] id
|
7206
|
-
# The ID for the
|
7207
|
-
#
|
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
|
7208
7275
|
# `/var/lib/ecs/gpu/nvidia_gpu_info.json` file.
|
7209
7276
|
# @return [String]
|
7210
7277
|
#
|
7211
7278
|
# @!attribute [rw] type
|
7212
|
-
# The type of device that
|
7279
|
+
# The type of device that's available on the container instance. The
|
7213
7280
|
# only supported value is `GPU`.
|
7214
7281
|
# @return [String]
|
7215
7282
|
#
|
@@ -7222,14 +7289,14 @@ module Aws::ECS
|
|
7222
7289
|
include Aws::Structure
|
7223
7290
|
end
|
7224
7291
|
|
7225
|
-
# The specified platform version
|
7226
|
-
#
|
7292
|
+
# The specified platform version doesn't satisfy the required
|
7293
|
+
# capabilities of the task definition.
|
7227
7294
|
#
|
7228
7295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PlatformTaskDefinitionIncompatibilityException AWS API Documentation
|
7229
7296
|
#
|
7230
7297
|
class PlatformTaskDefinitionIncompatibilityException < Aws::EmptyStructure; end
|
7231
7298
|
|
7232
|
-
# The specified platform version
|
7299
|
+
# The specified platform version doesn't exist.
|
7233
7300
|
#
|
7234
7301
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PlatformUnknownException AWS API Documentation
|
7235
7302
|
#
|
@@ -7239,13 +7306,12 @@ module Aws::ECS
|
|
7239
7306
|
# instance to send or receive traffic. Port mappings are specified as
|
7240
7307
|
# part of the container definition.
|
7241
7308
|
#
|
7242
|
-
# If you
|
7243
|
-
#
|
7244
|
-
#
|
7245
|
-
# `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`.
|
7246
7312
|
#
|
7247
|
-
# <note markdown="1"> You
|
7248
|
-
#
|
7313
|
+
# <note markdown="1"> You can't expose the same container port for multiple protocols. If
|
7314
|
+
# you attempt this, an error is returned.
|
7249
7315
|
#
|
7250
7316
|
# </note>
|
7251
7317
|
#
|
@@ -7263,15 +7329,14 @@ module Aws::ECS
|
|
7263
7329
|
# }
|
7264
7330
|
#
|
7265
7331
|
# @!attribute [rw] container_port
|
7266
|
-
# The port number on the container that
|
7332
|
+
# The port number on the container that's bound to the user-specified
|
7267
7333
|
# or automatically assigned host port.
|
7268
7334
|
#
|
7269
|
-
# If you
|
7270
|
-
#
|
7271
|
-
# `containerPort`.
|
7335
|
+
# If you use containers in a task with the `awsvpc` or `host` network
|
7336
|
+
# mode, specify the exposed ports using `containerPort`.
|
7272
7337
|
#
|
7273
|
-
# If you
|
7274
|
-
#
|
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
|
7275
7340
|
# automatically receives a host port in the ephemeral port range. For
|
7276
7341
|
# more information, see `hostPort`. Port mappings that are
|
7277
7342
|
# automatically assigned in this way do not count toward the 100
|
@@ -7282,14 +7347,14 @@ module Aws::ECS
|
|
7282
7347
|
# The port number on the container instance to reserve for your
|
7283
7348
|
# container.
|
7284
7349
|
#
|
7285
|
-
# If you
|
7286
|
-
#
|
7287
|
-
#
|
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`.
|
7288
7353
|
#
|
7289
|
-
# If you
|
7290
|
-
#
|
7291
|
-
#
|
7292
|
-
#
|
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
|
7293
7358
|
# receives a port in the ephemeral port range for your container
|
7294
7359
|
# instance operating system and Docker version.
|
7295
7360
|
#
|
@@ -7310,12 +7375,12 @@ module Aws::ECS
|
|
7310
7375
|
# The default reserved ports are 22 for SSH, the Docker ports 2375 and
|
7311
7376
|
# 2376, and the Amazon ECS container agent ports 51678-51680. Any host
|
7312
7377
|
# port that was previously specified in a running task is also
|
7313
|
-
# reserved while the task is running
|
7314
|
-
# port is released
|
7315
|
-
# `remainingResources` of DescribeContainerInstances output. A
|
7316
|
-
# container instance can have up to 100 reserved ports at a time
|
7317
|
-
#
|
7318
|
-
#
|
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.
|
7319
7384
|
# @return [Integer]
|
7320
7385
|
#
|
7321
7386
|
# @!attribute [rw] protocol
|
@@ -7335,13 +7400,13 @@ module Aws::ECS
|
|
7335
7400
|
|
7336
7401
|
# The configuration details for the App Mesh proxy.
|
7337
7402
|
#
|
7338
|
-
# For tasks
|
7339
|
-
# at least version 1.26.0 of the container agent and at least
|
7340
|
-
# 1.26.0-1 of the `ecs-init` package to enable a proxy
|
7341
|
-
# your container instances are launched from the
|
7342
|
-
# AMI version `20190301` or later, then they
|
7343
|
-
# versions of the container agent and `ecs-init`.
|
7344
|
-
# 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]
|
7345
7410
|
#
|
7346
7411
|
#
|
7347
7412
|
#
|
@@ -7545,8 +7610,8 @@ module Aws::ECS
|
|
7545
7610
|
#
|
7546
7611
|
# @!attribute [rw] attributes
|
7547
7612
|
# The attributes to apply to your resource. You can specify up to 10
|
7548
|
-
# custom attributes
|
7549
|
-
# in a single call.
|
7613
|
+
# custom attributes for each resource. You can specify up to 10
|
7614
|
+
# attributes in a single call.
|
7550
7615
|
# @return [Array<Types::Attribute>]
|
7551
7616
|
#
|
7552
7617
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutAttributesRequest AWS API Documentation
|
@@ -7587,7 +7652,7 @@ module Aws::ECS
|
|
7587
7652
|
#
|
7588
7653
|
# @!attribute [rw] cluster
|
7589
7654
|
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
7590
|
-
# modify the capacity provider settings for. If you
|
7655
|
+
# modify the capacity provider settings for. If you don't specify a
|
7591
7656
|
# cluster, the default cluster is assumed.
|
7592
7657
|
# @return [String]
|
7593
7658
|
#
|
@@ -7699,9 +7764,9 @@ module Aws::ECS
|
|
7699
7764
|
# }
|
7700
7765
|
#
|
7701
7766
|
# @!attribute [rw] cluster
|
7702
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
7703
|
-
#
|
7704
|
-
#
|
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.
|
7705
7770
|
# @return [String]
|
7706
7771
|
#
|
7707
7772
|
# @!attribute [rw] instance_identity_document
|
@@ -7724,7 +7789,7 @@ module Aws::ECS
|
|
7724
7789
|
#
|
7725
7790
|
# @!attribute [rw] version_info
|
7726
7791
|
# The version information for the Amazon ECS container agent and
|
7727
|
-
# Docker daemon
|
7792
|
+
# Docker daemon that runs on the container instance.
|
7728
7793
|
# @return [Types::VersionInfo]
|
7729
7794
|
#
|
7730
7795
|
# @!attribute [rw] container_instance_arn
|
@@ -7744,7 +7809,7 @@ module Aws::ECS
|
|
7744
7809
|
# @!attribute [rw] tags
|
7745
7810
|
# The metadata that you apply to the container instance to help you
|
7746
7811
|
# categorize and organize them. Each tag consists of a key and an
|
7747
|
-
# optional value
|
7812
|
+
# optional value. You define both.
|
7748
7813
|
#
|
7749
7814
|
# The following basic restrictions apply to tags:
|
7750
7815
|
#
|
@@ -8038,9 +8103,9 @@ module Aws::ECS
|
|
8038
8103
|
# }
|
8039
8104
|
#
|
8040
8105
|
# @!attribute [rw] family
|
8041
|
-
# You must specify a `family` for a task definition
|
8042
|
-
#
|
8043
|
-
#
|
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
|
8044
8109
|
# (uppercase and lowercase), numbers, underscores, and hyphens are
|
8045
8110
|
# allowed.
|
8046
8111
|
# @return [String]
|
@@ -8122,28 +8187,27 @@ module Aws::ECS
|
|
8122
8187
|
#
|
8123
8188
|
# @!attribute [rw] volumes
|
8124
8189
|
# A list of volume definitions in JSON format that containers in your
|
8125
|
-
# task
|
8190
|
+
# task might use.
|
8126
8191
|
# @return [Array<Types::Volume>]
|
8127
8192
|
#
|
8128
8193
|
# @!attribute [rw] placement_constraints
|
8129
8194
|
# An array of placement constraint objects to use for the task. You
|
8130
|
-
# can specify a maximum of 10 constraints
|
8195
|
+
# can specify a maximum of 10 constraints for each task. This limit
|
8131
8196
|
# includes constraints in the task definition and those specified at
|
8132
|
-
# runtime
|
8197
|
+
# runtime.
|
8133
8198
|
# @return [Array<Types::TaskDefinitionPlacementConstraint>]
|
8134
8199
|
#
|
8135
8200
|
# @!attribute [rw] requires_compatibilities
|
8136
|
-
# The task launch type that Amazon ECS
|
8137
|
-
#
|
8138
|
-
#
|
8139
|
-
#
|
8140
|
-
# 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.
|
8141
8205
|
# @return [Array<String>]
|
8142
8206
|
#
|
8143
8207
|
# @!attribute [rw] cpu
|
8144
8208
|
# The number of CPU units used by the task. It can be expressed as an
|
8145
|
-
# integer using CPU units
|
8146
|
-
# 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.
|
8147
8211
|
# String values are converted to an integer indicating the CPU units
|
8148
8212
|
# when the task definition is registered.
|
8149
8213
|
#
|
@@ -8153,14 +8217,17 @@ module Aws::ECS
|
|
8153
8217
|
#
|
8154
8218
|
# </note>
|
8155
8219
|
#
|
8156
|
-
# If you
|
8220
|
+
# If you're using the EC2 launch type, this field is optional.
|
8157
8221
|
# Supported values are between `128` CPU units (`0.125` vCPUs) and
|
8158
8222
|
# `10240` CPU units (`10` vCPUs).
|
8159
8223
|
#
|
8160
|
-
# If you
|
8224
|
+
# If you're using the Fargate launch type, this field is required and
|
8161
8225
|
# you must use one of the following values, which determines your
|
8162
8226
|
# range of supported values for the `memory` parameter:
|
8163
8227
|
#
|
8228
|
+
# The CPU units cannot be less than 1 vCPU when you use Windows
|
8229
|
+
# containers on Fargate.
|
8230
|
+
#
|
8164
8231
|
# * 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1
|
8165
8232
|
# GB), 2048 (2 GB)
|
8166
8233
|
#
|
@@ -8180,9 +8247,9 @@ module Aws::ECS
|
|
8180
8247
|
#
|
8181
8248
|
# @!attribute [rw] memory
|
8182
8249
|
# The amount of memory (in MiB) used by the task. It can be expressed
|
8183
|
-
# as an integer using MiB
|
8184
|
-
# GB
|
8185
|
-
# 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
|
8186
8253
|
# definition is registered.
|
8187
8254
|
#
|
8188
8255
|
# <note markdown="1"> Task-level CPU and memory parameters are ignored for Windows
|
@@ -8194,8 +8261,11 @@ module Aws::ECS
|
|
8194
8261
|
# If using the EC2 launch type, this field is optional.
|
8195
8262
|
#
|
8196
8263
|
# If using the Fargate launch type, this field is required and you
|
8197
|
-
# must use one of the following values
|
8198
|
-
# 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.
|
8199
8269
|
#
|
8200
8270
|
# * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values:
|
8201
8271
|
# 256 (.25 vCPU)
|
@@ -8216,7 +8286,7 @@ module Aws::ECS
|
|
8216
8286
|
# @!attribute [rw] tags
|
8217
8287
|
# The metadata that you apply to the task definition to help you
|
8218
8288
|
# categorize and organize them. Each tag consists of a key and an
|
8219
|
-
# optional value
|
8289
|
+
# optional value. You define both of them.
|
8220
8290
|
#
|
8221
8291
|
# The following basic restrictions apply to tags:
|
8222
8292
|
#
|
@@ -8416,11 +8486,11 @@ module Aws::ECS
|
|
8416
8486
|
# The Amazon Resource Name (ARN) of the secret containing the private
|
8417
8487
|
# repository credentials.
|
8418
8488
|
#
|
8419
|
-
# <note markdown="1"> When you
|
8420
|
-
#
|
8421
|
-
#
|
8422
|
-
#
|
8423
|
-
#
|
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.
|
8424
8494
|
#
|
8425
8495
|
# </note>
|
8426
8496
|
# @return [String]
|
@@ -8453,8 +8523,8 @@ module Aws::ECS
|
|
8453
8523
|
# @return [String]
|
8454
8524
|
#
|
8455
8525
|
# @!attribute [rw] type
|
8456
|
-
# The type of the resource
|
8457
|
-
# `STRINGSET`.
|
8526
|
+
# The type of the resource. Valid values: `INTEGER`, `DOUBLE`, `LONG`,
|
8527
|
+
# or `STRINGSET`.
|
8458
8528
|
# @return [String]
|
8459
8529
|
#
|
8460
8530
|
# @!attribute [rw] double_value
|
@@ -8490,13 +8560,13 @@ module Aws::ECS
|
|
8490
8560
|
include Aws::Structure
|
8491
8561
|
end
|
8492
8562
|
|
8493
|
-
# The specified resource is in-use and
|
8563
|
+
# The specified resource is in-use and can't be removed.
|
8494
8564
|
#
|
8495
8565
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ResourceInUseException AWS API Documentation
|
8496
8566
|
#
|
8497
8567
|
class ResourceInUseException < Aws::EmptyStructure; end
|
8498
8568
|
|
8499
|
-
# The specified resource
|
8569
|
+
# The specified resource wasn't found.
|
8500
8570
|
#
|
8501
8571
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ResourceNotFoundException AWS API Documentation
|
8502
8572
|
#
|
@@ -8525,13 +8595,13 @@ module Aws::ECS
|
|
8525
8595
|
# The value for the specified resource type.
|
8526
8596
|
#
|
8527
8597
|
# If the `GPU` type is used, the value is the number of physical
|
8528
|
-
# `GPUs` the Amazon ECS container agent
|
8529
|
-
#
|
8530
|
-
#
|
8531
|
-
#
|
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.
|
8532
8602
|
#
|
8533
|
-
# If the `InferenceAccelerator` type is used, the `value`
|
8534
|
-
#
|
8603
|
+
# If the `InferenceAccelerator` type is used, the `value` matches the
|
8604
|
+
# `deviceName` for an InferenceAccelerator specified in a task
|
8535
8605
|
# definition.
|
8536
8606
|
# @return [String]
|
8537
8607
|
#
|
@@ -8656,14 +8726,14 @@ module Aws::ECS
|
|
8656
8726
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
8657
8727
|
#
|
8658
8728
|
# @!attribute [rw] cluster
|
8659
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
8660
|
-
#
|
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
|
8661
8731
|
# cluster is assumed.
|
8662
8732
|
# @return [String]
|
8663
8733
|
#
|
8664
8734
|
# @!attribute [rw] count
|
8665
8735
|
# The number of instantiations of the specified task to place on your
|
8666
|
-
# cluster. You can specify up to 10 tasks
|
8736
|
+
# cluster. You can specify up to 10 tasks for each call.
|
8667
8737
|
# @return [Integer]
|
8668
8738
|
#
|
8669
8739
|
# @!attribute [rw] enable_ecs_managed_tags
|
@@ -8677,8 +8747,8 @@ module Aws::ECS
|
|
8677
8747
|
# @return [Boolean]
|
8678
8748
|
#
|
8679
8749
|
# @!attribute [rw] enable_execute_command
|
8680
|
-
#
|
8681
|
-
# 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
|
8682
8752
|
# functionality on all containers in the task.
|
8683
8753
|
# @return [Boolean]
|
8684
8754
|
#
|
@@ -8689,7 +8759,7 @@ module Aws::ECS
|
|
8689
8759
|
# @return [String]
|
8690
8760
|
#
|
8691
8761
|
# @!attribute [rw] launch_type
|
8692
|
-
# The infrastructure
|
8762
|
+
# The infrastructure to run your standalone task on. For more
|
8693
8763
|
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
8694
8764
|
# Container Service Developer Guide*.
|
8695
8765
|
#
|
@@ -8705,8 +8775,8 @@ module Aws::ECS
|
|
8705
8775
|
# The `EC2` launch type runs your tasks on Amazon EC2 instances
|
8706
8776
|
# registered to your cluster.
|
8707
8777
|
#
|
8708
|
-
# The `EXTERNAL` launch type runs your tasks on your on-
|
8709
|
-
# 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.
|
8710
8780
|
#
|
8711
8781
|
# A task can use either a launch type or a capacity provider strategy.
|
8712
8782
|
# If a `launchType` is specified, the `capacityProviderStrategy`
|
@@ -8724,7 +8794,7 @@ module Aws::ECS
|
|
8724
8794
|
# @!attribute [rw] network_configuration
|
8725
8795
|
# The network configuration for the task. This parameter is required
|
8726
8796
|
# for task definitions that use the `awsvpc` network mode to receive
|
8727
|
-
# their own elastic network interface, and it
|
8797
|
+
# their own elastic network interface, and it isn't supported for
|
8728
8798
|
# other network modes. For more information, see [Task networking][1]
|
8729
8799
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
8730
8800
|
#
|
@@ -8737,7 +8807,7 @@ module Aws::ECS
|
|
8737
8807
|
# A list of container overrides in JSON format that specify the name
|
8738
8808
|
# of a container in the specified task definition and the overrides it
|
8739
8809
|
# should receive. You can override the default command for a container
|
8740
|
-
# (that
|
8810
|
+
# (that's specified in the task definition or Docker image) with a
|
8741
8811
|
# `command` override. You can also override existing environment
|
8742
8812
|
# variables (that are specified in the task definition or Docker
|
8743
8813
|
# image) on a container or add new environment variables to it with an
|
@@ -8749,20 +8819,20 @@ module Aws::ECS
|
|
8749
8819
|
#
|
8750
8820
|
# @!attribute [rw] placement_constraints
|
8751
8821
|
# An array of placement constraint objects to use for the task. You
|
8752
|
-
# can specify up to 10 constraints
|
8753
|
-
# 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).
|
8754
8824
|
# @return [Array<Types::PlacementConstraint>]
|
8755
8825
|
#
|
8756
8826
|
# @!attribute [rw] placement_strategy
|
8757
8827
|
# The placement strategy objects to use for the task. You can specify
|
8758
|
-
# a maximum of 5 strategy rules
|
8828
|
+
# a maximum of 5 strategy rules for each task.
|
8759
8829
|
# @return [Array<Types::PlacementStrategy>]
|
8760
8830
|
#
|
8761
8831
|
# @!attribute [rw] platform_version
|
8762
|
-
# The platform version the task
|
8763
|
-
# specified for tasks hosted on Fargate. If one
|
8764
|
-
# `LATEST` platform version is used
|
8765
|
-
#
|
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
|
8766
8836
|
# Service Developer Guide*.
|
8767
8837
|
#
|
8768
8838
|
#
|
@@ -8772,7 +8842,7 @@ module Aws::ECS
|
|
8772
8842
|
#
|
8773
8843
|
# @!attribute [rw] propagate_tags
|
8774
8844
|
# Specifies whether to propagate the tags from the task definition to
|
8775
|
-
# the task. If no value is specified, the tags
|
8845
|
+
# the task. If no value is specified, the tags aren't propagated.
|
8776
8846
|
# Tags can only be propagated to the task during task creation. To add
|
8777
8847
|
# tags to a task after task creation, use the TagResource API action.
|
8778
8848
|
#
|
@@ -8794,7 +8864,7 @@ module Aws::ECS
|
|
8794
8864
|
# `startedBy` parameter. You can then identify which tasks belong to
|
8795
8865
|
# that job by filtering the results of a ListTasks call with the
|
8796
8866
|
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
8797
|
-
# numbers, hyphens, and underscores are allowed.
|
8867
|
+
# numbers, hyphens (-), and underscores (\_) are allowed.
|
8798
8868
|
#
|
8799
8869
|
# If a task is started by an Amazon ECS service, then the `startedBy`
|
8800
8870
|
# parameter contains the deployment ID of the service that starts it.
|
@@ -8833,10 +8903,10 @@ module Aws::ECS
|
|
8833
8903
|
#
|
8834
8904
|
# @!attribute [rw] task_definition
|
8835
8905
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
8836
|
-
# task definition to run. If a `revision`
|
8906
|
+
# task definition to run. If a `revision` isn't specified, the latest
|
8837
8907
|
# `ACTIVE` revision is used.
|
8838
8908
|
#
|
8839
|
-
# 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
|
8840
8910
|
# `Resource` of the IAM principal's permissions policy. For example,
|
8841
8911
|
# if the `Resource` is
|
8842
8912
|
# arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*,
|
@@ -8977,7 +9047,7 @@ module Aws::ECS
|
|
8977
9047
|
# the parameter in the SSM Parameter Store.
|
8978
9048
|
#
|
8979
9049
|
# <note markdown="1"> If the SSM Parameter Store parameter exists in the same Region as
|
8980
|
-
# the task you
|
9050
|
+
# the task you're launching, then you can use either the full ARN or
|
8981
9051
|
# name of the parameter. If the parameter exists in a different
|
8982
9052
|
# Region, then the full ARN must be specified.
|
8983
9053
|
#
|
@@ -9019,9 +9089,9 @@ module Aws::ECS
|
|
9019
9089
|
# @!attribute [rw] service_name
|
9020
9090
|
# The name of your service. Up to 255 letters (uppercase and
|
9021
9091
|
# lowercase), numbers, underscores, and hyphens are allowed. Service
|
9022
|
-
# names must be unique within a cluster,
|
9023
|
-
# named services in multiple clusters within a Region or
|
9024
|
-
# 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.
|
9025
9095
|
# @return [String]
|
9026
9096
|
#
|
9027
9097
|
# @!attribute [rw] cluster_arn
|
@@ -9030,14 +9100,14 @@ module Aws::ECS
|
|
9030
9100
|
# @return [String]
|
9031
9101
|
#
|
9032
9102
|
# @!attribute [rw] load_balancers
|
9033
|
-
# A list of Elastic Load Balancing load balancer objects
|
9034
|
-
# the load balancer name, the container name
|
9035
|
-
#
|
9036
|
-
#
|
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.
|
9037
9107
|
# @return [Array<Types::LoadBalancer>]
|
9038
9108
|
#
|
9039
9109
|
# @!attribute [rw] service_registries
|
9040
|
-
# The details
|
9110
|
+
# The details for the service discovery registries to assign to this
|
9041
9111
|
# service. For more information, see [Service Discovery][1].
|
9042
9112
|
#
|
9043
9113
|
#
|
@@ -9072,16 +9142,16 @@ module Aws::ECS
|
|
9072
9142
|
# @return [String]
|
9073
9143
|
#
|
9074
9144
|
# @!attribute [rw] capacity_provider_strategy
|
9075
|
-
# The capacity provider strategy the service
|
9145
|
+
# The capacity provider strategy the service uses. When using the
|
9076
9146
|
# DescribeServices API, this field is omitted if the service was
|
9077
9147
|
# created using a launch type.
|
9078
9148
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
9079
9149
|
#
|
9080
9150
|
# @!attribute [rw] platform_version
|
9081
|
-
# The platform version
|
9082
|
-
#
|
9083
|
-
# specified, the `LATEST` platform version is used
|
9084
|
-
#
|
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
|
9085
9155
|
# Elastic Container Service Developer Guide*.
|
9086
9156
|
#
|
9087
9157
|
#
|
@@ -9090,12 +9160,12 @@ module Aws::ECS
|
|
9090
9160
|
# @return [String]
|
9091
9161
|
#
|
9092
9162
|
# @!attribute [rw] platform_family
|
9093
|
-
# The operating system that your tasks in the service
|
9094
|
-
#
|
9095
|
-
#
|
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.
|
9096
9166
|
#
|
9097
9167
|
# All tasks that run as part of this service must use the same
|
9098
|
-
# `platformFamily` value as the service
|
9168
|
+
# `platformFamily` value as the service (for example, `LINUX`).
|
9099
9169
|
# @return [String]
|
9100
9170
|
#
|
9101
9171
|
# @!attribute [rw] task_definition
|
@@ -9122,9 +9192,9 @@ module Aws::ECS
|
|
9122
9192
|
# @return [Array<Types::Deployment>]
|
9123
9193
|
#
|
9124
9194
|
# @!attribute [rw] role_arn
|
9125
|
-
# The ARN of the IAM role associated with the service
|
9126
|
-
# Amazon ECS container agent to register container
|
9127
|
-
# 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.
|
9128
9198
|
# @return [String]
|
9129
9199
|
#
|
9130
9200
|
# @!attribute [rw] events
|
@@ -9133,7 +9203,7 @@ module Aws::ECS
|
|
9133
9203
|
# @return [Array<Types::ServiceEvent>]
|
9134
9204
|
#
|
9135
9205
|
# @!attribute [rw] created_at
|
9136
|
-
# The Unix timestamp for when the service was created.
|
9206
|
+
# The Unix timestamp for the time when the service was created.
|
9137
9207
|
# @return [Time]
|
9138
9208
|
#
|
9139
9209
|
# @!attribute [rw] placement_constraints
|
@@ -9161,7 +9231,7 @@ module Aws::ECS
|
|
9161
9231
|
# The scheduling strategy to use for the service. For more
|
9162
9232
|
# information, see [Services][1].
|
9163
9233
|
#
|
9164
|
-
# There are two service scheduler strategies available
|
9234
|
+
# There are two service scheduler strategies available.
|
9165
9235
|
#
|
9166
9236
|
# * `REPLICA`-The replica scheduling strategy places and maintains the
|
9167
9237
|
# desired number of tasks across your cluster. By default, the
|
@@ -9170,13 +9240,13 @@ module Aws::ECS
|
|
9170
9240
|
# placement decisions.
|
9171
9241
|
#
|
9172
9242
|
# * `DAEMON`-The daemon scheduling strategy deploys exactly one task
|
9173
|
-
# on each active container instance
|
9243
|
+
# on each active container instance. This taskmeets all of the task
|
9174
9244
|
# placement constraints that you specify in your cluster. The
|
9175
9245
|
# service scheduler also evaluates the task placement constraints
|
9176
|
-
# for running tasks
|
9177
|
-
#
|
9246
|
+
# for running tasks. It stop tasks that don't meet the placement
|
9247
|
+
# constraints.
|
9178
9248
|
#
|
9179
|
-
# <note markdown="1"> Fargate tasks
|
9249
|
+
# <note markdown="1"> Fargate tasks don't support the `DAEMON` scheduling strategy.
|
9180
9250
|
#
|
9181
9251
|
# </note>
|
9182
9252
|
#
|
@@ -9187,14 +9257,14 @@ module Aws::ECS
|
|
9187
9257
|
#
|
9188
9258
|
# @!attribute [rw] deployment_controller
|
9189
9259
|
# The deployment controller type the service is using. When using the
|
9190
|
-
# DescribeServices API, this field is omitted if the service
|
9191
|
-
#
|
9260
|
+
# DescribeServices API, this field is omitted if the service uses the
|
9261
|
+
# `ECS` deployment controller type.
|
9192
9262
|
# @return [Types::DeploymentController]
|
9193
9263
|
#
|
9194
9264
|
# @!attribute [rw] tags
|
9195
9265
|
# The metadata that you apply to the service to help you categorize
|
9196
|
-
# and organize them. Each tag consists of a key and an optional value
|
9197
|
-
#
|
9266
|
+
# and organize them. Each tag consists of a key and an optional value.
|
9267
|
+
# You define bot the key and value.
|
9198
9268
|
#
|
9199
9269
|
# The following basic restrictions apply to tags:
|
9200
9270
|
#
|
@@ -9227,8 +9297,8 @@ module Aws::ECS
|
|
9227
9297
|
# @return [String]
|
9228
9298
|
#
|
9229
9299
|
# @!attribute [rw] enable_ecs_managed_tags
|
9230
|
-
#
|
9231
|
-
# 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
|
9232
9302
|
# Resources][1] in the *Amazon Elastic Container Service Developer
|
9233
9303
|
# Guide*.
|
9234
9304
|
#
|
@@ -9238,15 +9308,15 @@ module Aws::ECS
|
|
9238
9308
|
# @return [Boolean]
|
9239
9309
|
#
|
9240
9310
|
# @!attribute [rw] propagate_tags
|
9241
|
-
#
|
9242
|
-
# 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
|
9243
9313
|
# propagated.
|
9244
9314
|
# @return [String]
|
9245
9315
|
#
|
9246
9316
|
# @!attribute [rw] enable_execute_command
|
9247
|
-
#
|
9248
|
-
# service. If `true`, the execute command functionality is enabled
|
9249
|
-
# 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.
|
9250
9320
|
# @return [Boolean]
|
9251
9321
|
#
|
9252
9322
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Service AWS API Documentation
|
@@ -9287,14 +9357,14 @@ module Aws::ECS
|
|
9287
9357
|
include Aws::Structure
|
9288
9358
|
end
|
9289
9359
|
|
9290
|
-
#
|
9360
|
+
# The details for an event that's associated with a service.
|
9291
9361
|
#
|
9292
9362
|
# @!attribute [rw] id
|
9293
|
-
# The ID string
|
9363
|
+
# The ID string for the event.
|
9294
9364
|
# @return [String]
|
9295
9365
|
#
|
9296
9366
|
# @!attribute [rw] created_at
|
9297
|
-
# The Unix timestamp for when the event was triggered.
|
9367
|
+
# The Unix timestamp for the time when the event was triggered.
|
9298
9368
|
# @return [Time]
|
9299
9369
|
#
|
9300
9370
|
# @!attribute [rw] message
|
@@ -9311,23 +9381,23 @@ module Aws::ECS
|
|
9311
9381
|
include Aws::Structure
|
9312
9382
|
end
|
9313
9383
|
|
9314
|
-
# The specified service
|
9315
|
-
#
|
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
|
9316
9386
|
# re-create it with CreateService.
|
9317
9387
|
#
|
9318
9388
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceNotActiveException AWS API Documentation
|
9319
9389
|
#
|
9320
9390
|
class ServiceNotActiveException < Aws::EmptyStructure; end
|
9321
9391
|
|
9322
|
-
# The specified service
|
9323
|
-
# services with ListServices. Amazon ECS services are cluster
|
9324
|
-
# 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.
|
9325
9395
|
#
|
9326
9396
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceNotFoundException AWS API Documentation
|
9327
9397
|
#
|
9328
9398
|
class ServiceNotFoundException < Aws::EmptyStructure; end
|
9329
9399
|
|
9330
|
-
#
|
9400
|
+
# The details for the service registry.
|
9331
9401
|
#
|
9332
9402
|
# @note When making an API call, you may pass ServiceRegistry
|
9333
9403
|
# data as a hash:
|
@@ -9351,31 +9421,32 @@ module Aws::ECS
|
|
9351
9421
|
#
|
9352
9422
|
# @!attribute [rw] port
|
9353
9423
|
# The port value used if your service discovery service specified an
|
9354
|
-
# SRV record. This field
|
9355
|
-
# 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.
|
9356
9426
|
# @return [Integer]
|
9357
9427
|
#
|
9358
9428
|
# @!attribute [rw] container_name
|
9359
|
-
# The container name value
|
9360
|
-
#
|
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
|
9361
9431
|
# definition that your service task specifies uses the `bridge` or
|
9362
9432
|
# `host` network mode, you must specify a `containerName` and
|
9363
9433
|
# `containerPort` combination from the task definition. If the task
|
9364
9434
|
# definition that your service task specifies uses the `awsvpc`
|
9365
9435
|
# network mode and a type SRV DNS record is used, you must specify
|
9366
9436
|
# either a `containerName` and `containerPort` combination or a `port`
|
9367
|
-
# value,
|
9437
|
+
# value. However, you can't specify both.
|
9368
9438
|
# @return [String]
|
9369
9439
|
#
|
9370
9440
|
# @!attribute [rw] container_port
|
9371
|
-
# The port value
|
9372
|
-
#
|
9373
|
-
# service task specifies uses the `bridge` or `host` network
|
9374
|
-
# must specify a `containerName` and `containerPort`
|
9375
|
-
# the task definition. If the task definition your
|
9376
|
-
# specifies uses the `awsvpc` network mode and a type SRV
|
9377
|
-
# is used, you must specify either a `containerName` and
|
9378
|
-
# `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.
|
9379
9450
|
# @return [Integer]
|
9380
9451
|
#
|
9381
9452
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceRegistry AWS API Documentation
|
@@ -9389,7 +9460,7 @@ module Aws::ECS
|
|
9389
9460
|
include Aws::Structure
|
9390
9461
|
end
|
9391
9462
|
|
9392
|
-
# The details
|
9463
|
+
# The details for the execute command session.
|
9393
9464
|
#
|
9394
9465
|
# @!attribute [rw] session_id
|
9395
9466
|
# The ID of the execute command session.
|
@@ -9403,7 +9474,7 @@ module Aws::ECS
|
|
9403
9474
|
#
|
9404
9475
|
# @!attribute [rw] token_value
|
9405
9476
|
# An encrypted token value containing session and caller information.
|
9406
|
-
#
|
9477
|
+
# It's used to authenticate the connection to the container.
|
9407
9478
|
# @return [String]
|
9408
9479
|
#
|
9409
9480
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Session AWS API Documentation
|
@@ -9423,12 +9494,12 @@ module Aws::ECS
|
|
9423
9494
|
# @return [String]
|
9424
9495
|
#
|
9425
9496
|
# @!attribute [rw] value
|
9426
|
-
#
|
9427
|
-
# resource.
|
9497
|
+
# Determines whether the account setting is enabled or disabled for
|
9498
|
+
# the specified resource.
|
9428
9499
|
# @return [String]
|
9429
9500
|
#
|
9430
9501
|
# @!attribute [rw] principal_arn
|
9431
|
-
# The ARN of the principal
|
9502
|
+
# The ARN of the principal. It can be an IAM user, IAM role, or the
|
9432
9503
|
# root user. If this field is omitted, the authenticated user is
|
9433
9504
|
# assumed.
|
9434
9505
|
# @return [String]
|
@@ -9514,15 +9585,15 @@ module Aws::ECS
|
|
9514
9585
|
# }
|
9515
9586
|
#
|
9516
9587
|
# @!attribute [rw] cluster
|
9517
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
9518
|
-
#
|
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
|
9519
9590
|
# default cluster is assumed.
|
9520
9591
|
# @return [String]
|
9521
9592
|
#
|
9522
9593
|
# @!attribute [rw] container_instances
|
9523
9594
|
# The container instance IDs or full ARN entries for the container
|
9524
|
-
# instances
|
9525
|
-
#
|
9595
|
+
# instances where you would like to place your task. You can specify
|
9596
|
+
# up to 10 container instances.
|
9526
9597
|
# @return [Array<String>]
|
9527
9598
|
#
|
9528
9599
|
# @!attribute [rw] enable_ecs_managed_tags
|
@@ -9556,8 +9627,8 @@ module Aws::ECS
|
|
9556
9627
|
# @!attribute [rw] overrides
|
9557
9628
|
# A list of container overrides in JSON format that specify the name
|
9558
9629
|
# of a container in the specified task definition and the overrides it
|
9559
|
-
#
|
9560
|
-
# (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
|
9561
9632
|
# `command` override. You can also override existing environment
|
9562
9633
|
# variables (that are specified in the task definition or Docker
|
9563
9634
|
# image) on a container or add new environment variables to it with an
|
@@ -9571,7 +9642,7 @@ module Aws::ECS
|
|
9571
9642
|
#
|
9572
9643
|
# @!attribute [rw] propagate_tags
|
9573
9644
|
# Specifies whether to propagate the tags from the task definition or
|
9574
|
-
# 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
|
9575
9646
|
# propagated.
|
9576
9647
|
# @return [String]
|
9577
9648
|
#
|
@@ -9586,9 +9657,9 @@ module Aws::ECS
|
|
9586
9657
|
# `startedBy` parameter. You can then identify which tasks belong to
|
9587
9658
|
# that job by filtering the results of a ListTasks call with the
|
9588
9659
|
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
9589
|
-
# numbers, hyphens, and underscores are allowed.
|
9660
|
+
# numbers, hyphens (-), and underscores (\_) are allowed.
|
9590
9661
|
#
|
9591
|
-
# If a task is started by an Amazon ECS service,
|
9662
|
+
# If a task is started by an Amazon ECS service, the `startedBy`
|
9592
9663
|
# parameter contains the deployment ID of the service that starts it.
|
9593
9664
|
# @return [String]
|
9594
9665
|
#
|
@@ -9625,7 +9696,7 @@ module Aws::ECS
|
|
9625
9696
|
#
|
9626
9697
|
# @!attribute [rw] task_definition
|
9627
9698
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
9628
|
-
# task definition to start. If a `revision`
|
9699
|
+
# task definition to start. If a `revision` isn't specified, the
|
9629
9700
|
# latest `ACTIVE` revision is used.
|
9630
9701
|
# @return [String]
|
9631
9702
|
#
|
@@ -9687,7 +9758,7 @@ module Aws::ECS
|
|
9687
9758
|
#
|
9688
9759
|
# @!attribute [rw] reason
|
9689
9760
|
# An optional message specified when a task is stopped. For example,
|
9690
|
-
# if you
|
9761
|
+
# if you're using a custom scheduler, you can use this parameter to
|
9691
9762
|
# specify the reason for stopping the task here, and the message
|
9692
9763
|
# appears in subsequent DescribeTasks API operations on this task. Up
|
9693
9764
|
# to 255 characters are allowed in this message.
|
@@ -9801,7 +9872,7 @@ module Aws::ECS
|
|
9801
9872
|
# @return [String]
|
9802
9873
|
#
|
9803
9874
|
# @!attribute [rw] exit_code
|
9804
|
-
# The exit code returned for the state change request.
|
9875
|
+
# The exit code that's returned for the state change request.
|
9805
9876
|
# @return [Integer]
|
9806
9877
|
#
|
9807
9878
|
# @!attribute [rw] reason
|
@@ -9902,7 +9973,7 @@ module Aws::ECS
|
|
9902
9973
|
# @return [String]
|
9903
9974
|
#
|
9904
9975
|
# @!attribute [rw] containers
|
9905
|
-
# Any containers associated with the state change request.
|
9976
|
+
# Any containers that's associated with the state change request.
|
9906
9977
|
# @return [Array<Types::ContainerStateChange>]
|
9907
9978
|
#
|
9908
9979
|
# @!attribute [rw] attachments
|
@@ -9910,19 +9981,21 @@ module Aws::ECS
|
|
9910
9981
|
# @return [Array<Types::AttachmentStateChange>]
|
9911
9982
|
#
|
9912
9983
|
# @!attribute [rw] managed_agents
|
9913
|
-
# The details for the managed agent associated with the task.
|
9984
|
+
# The details for the managed agent that's associated with the task.
|
9914
9985
|
# @return [Array<Types::ManagedAgentStateChange>]
|
9915
9986
|
#
|
9916
9987
|
# @!attribute [rw] pull_started_at
|
9917
|
-
# The Unix timestamp for when the container image pull
|
9988
|
+
# The Unix timestamp for the time when the container image pull
|
9989
|
+
# started.
|
9918
9990
|
# @return [Time]
|
9919
9991
|
#
|
9920
9992
|
# @!attribute [rw] pull_stopped_at
|
9921
|
-
# The Unix timestamp for when the container image pull
|
9993
|
+
# The Unix timestamp for the time when the container image pull
|
9994
|
+
# completed.
|
9922
9995
|
# @return [Time]
|
9923
9996
|
#
|
9924
9997
|
# @!attribute [rw] execution_stopped_at
|
9925
|
-
# The Unix timestamp for when the task execution stopped.
|
9998
|
+
# The Unix timestamp for the time when the task execution stopped.
|
9926
9999
|
# @return [Time]
|
9927
10000
|
#
|
9928
10001
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitTaskStateChangeRequest AWS API Documentation
|
@@ -9959,21 +10032,21 @@ module Aws::ECS
|
|
9959
10032
|
# the [Docker Remote API][2] and the `--sysctl` option to [docker
|
9960
10033
|
# run][3].
|
9961
10034
|
#
|
9962
|
-
#
|
9963
|
-
#
|
9964
|
-
#
|
9965
|
-
# 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.
|
9966
10039
|
#
|
9967
10040
|
# * For tasks that use the `awsvpc` network mode, if you set
|
9968
10041
|
# `systemControls` for any container, it applies to all containers in
|
9969
10042
|
# the task. If you set different `systemControls` for multiple
|
9970
|
-
# containers in a single task, the container that
|
10043
|
+
# containers in a single task, the container that's started last
|
9971
10044
|
# determines which `systemControls` take effect.
|
9972
10045
|
#
|
9973
10046
|
# * For tasks that use the `host` network mode, the `systemControls`
|
9974
|
-
# parameter applies to the container instance's kernel parameter
|
9975
|
-
#
|
9976
|
-
#
|
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.
|
9977
10050
|
#
|
9978
10051
|
#
|
9979
10052
|
#
|
@@ -9990,11 +10063,11 @@ module Aws::ECS
|
|
9990
10063
|
# }
|
9991
10064
|
#
|
9992
10065
|
# @!attribute [rw] namespace
|
9993
|
-
# The namespaced kernel parameter
|
10066
|
+
# The namespaced kernel parameter to set a `value` for.
|
9994
10067
|
# @return [String]
|
9995
10068
|
#
|
9996
10069
|
# @!attribute [rw] value
|
9997
|
-
# The value for the namespaced kernel parameter specified in
|
10070
|
+
# The value for the namespaced kernel parameter that's specified in
|
9998
10071
|
# `namespace`.
|
9999
10072
|
# @return [String]
|
10000
10073
|
#
|
@@ -10008,8 +10081,8 @@ module Aws::ECS
|
|
10008
10081
|
end
|
10009
10082
|
|
10010
10083
|
# The metadata that you apply to a resource to help you categorize and
|
10011
|
-
# organize them. Each tag consists of a key and an optional value
|
10012
|
-
#
|
10084
|
+
# organize them. Each tag consists of a key and an optional value. You
|
10085
|
+
# define them.
|
10013
10086
|
#
|
10014
10087
|
# The following basic restrictions apply to tags:
|
10015
10088
|
#
|
@@ -10078,7 +10151,7 @@ module Aws::ECS
|
|
10078
10151
|
# }
|
10079
10152
|
#
|
10080
10153
|
# @!attribute [rw] resource_arn
|
10081
|
-
# The Amazon Resource Name (ARN) of the resource to
|
10154
|
+
# The Amazon Resource Name (ARN) of the resource to add tags to.
|
10082
10155
|
# Currently, the supported resources are Amazon ECS capacity
|
10083
10156
|
# providers, tasks, services, task definitions, clusters, and
|
10084
10157
|
# container instances.
|
@@ -10127,14 +10200,14 @@ module Aws::ECS
|
|
10127
10200
|
#
|
10128
10201
|
class TagResourceResponse < Aws::EmptyStructure; end
|
10129
10202
|
|
10130
|
-
# The target container
|
10203
|
+
# The target container isn't properly configured with the execute
|
10131
10204
|
# command agent or the container is no longer active or running.
|
10132
10205
|
#
|
10133
10206
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TargetNotConnectedException AWS API Documentation
|
10134
10207
|
#
|
10135
10208
|
class TargetNotConnectedException < Aws::EmptyStructure; end
|
10136
10209
|
|
10137
|
-
# The specified target
|
10210
|
+
# The specified target wasn't found. You can view your available
|
10138
10211
|
# container instances with ListContainerInstances. Amazon ECS container
|
10139
10212
|
# instances are cluster-specific and Region-specific.
|
10140
10213
|
#
|
@@ -10145,8 +10218,8 @@ module Aws::ECS
|
|
10145
10218
|
# Details on a task in a cluster.
|
10146
10219
|
#
|
10147
10220
|
# @!attribute [rw] attachments
|
10148
|
-
# The Elastic Network Adapter associated with the task if the
|
10149
|
-
# 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.
|
10150
10223
|
# @return [Array<Types::Attachment>]
|
10151
10224
|
#
|
10152
10225
|
# @!attribute [rw] attributes
|
@@ -10154,11 +10227,11 @@ module Aws::ECS
|
|
10154
10227
|
# @return [Array<Types::Attribute>]
|
10155
10228
|
#
|
10156
10229
|
# @!attribute [rw] availability_zone
|
10157
|
-
# The
|
10230
|
+
# The Availability Zone for the task.
|
10158
10231
|
# @return [String]
|
10159
10232
|
#
|
10160
10233
|
# @!attribute [rw] capacity_provider_name
|
10161
|
-
# The capacity provider associated with the task.
|
10234
|
+
# The capacity provider that's associated with the task.
|
10162
10235
|
# @return [String]
|
10163
10236
|
#
|
10164
10237
|
# @!attribute [rw] cluster_arn
|
@@ -10170,8 +10243,8 @@ module Aws::ECS
|
|
10170
10243
|
# @return [String]
|
10171
10244
|
#
|
10172
10245
|
# @!attribute [rw] connectivity_at
|
10173
|
-
# The Unix timestamp for when the task last went into
|
10174
|
-
# status.
|
10246
|
+
# The Unix timestamp for the time when the task last went into
|
10247
|
+
# `CONNECTED` status.
|
10175
10248
|
# @return [Time]
|
10176
10249
|
#
|
10177
10250
|
# @!attribute [rw] container_instance_arn
|
@@ -10179,24 +10252,27 @@ module Aws::ECS
|
|
10179
10252
|
# @return [String]
|
10180
10253
|
#
|
10181
10254
|
# @!attribute [rw] containers
|
10182
|
-
# The containers associated with the task.
|
10255
|
+
# The containers that's associated with the task.
|
10183
10256
|
# @return [Array<Types::Container>]
|
10184
10257
|
#
|
10185
10258
|
# @!attribute [rw] cpu
|
10186
10259
|
# The number of CPU units used by the task as expressed in a task
|
10187
|
-
# definition. It can be expressed as an integer using CPU units
|
10188
|
-
# example `1024
|
10189
|
-
# for example `1 vCPU` or `1 vcpu
|
10190
|
-
# 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
|
10191
10264
|
# registered.
|
10192
10265
|
#
|
10193
|
-
# If you
|
10194
|
-
#
|
10195
|
-
#
|
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).
|
10196
10269
|
#
|
10197
|
-
# If you
|
10198
|
-
#
|
10199
|
-
#
|
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.
|
10200
10276
|
#
|
10201
10277
|
# * 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1
|
10202
10278
|
# GB), 2048 (2 GB)
|
@@ -10216,8 +10292,9 @@ module Aws::ECS
|
|
10216
10292
|
# @return [String]
|
10217
10293
|
#
|
10218
10294
|
# @!attribute [rw] created_at
|
10219
|
-
# The Unix timestamp for when the task was created
|
10220
|
-
# 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.
|
10221
10298
|
# @return [Time]
|
10222
10299
|
#
|
10223
10300
|
# @!attribute [rw] desired_status
|
@@ -10230,43 +10307,44 @@ module Aws::ECS
|
|
10230
10307
|
# @return [String]
|
10231
10308
|
#
|
10232
10309
|
# @!attribute [rw] enable_execute_command
|
10233
|
-
#
|
10234
|
-
# 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
|
10235
10312
|
# containers in the task.
|
10236
10313
|
# @return [Boolean]
|
10237
10314
|
#
|
10238
10315
|
# @!attribute [rw] execution_stopped_at
|
10239
|
-
# The Unix timestamp for when the task execution stopped.
|
10316
|
+
# The Unix timestamp for the time when the task execution stopped.
|
10240
10317
|
# @return [Time]
|
10241
10318
|
#
|
10242
10319
|
# @!attribute [rw] group
|
10243
|
-
# The name of the task group associated with the task.
|
10320
|
+
# The name of the task group that's associated with the task.
|
10244
10321
|
# @return [String]
|
10245
10322
|
#
|
10246
10323
|
# @!attribute [rw] health_status
|
10247
|
-
# The health status for the task
|
10324
|
+
# The health status for the task. It's determined by the health of
|
10248
10325
|
# the essential containers in the task. If all essential containers in
|
10249
|
-
# the task are reporting as `HEALTHY`,
|
10250
|
-
#
|
10251
|
-
#
|
10252
|
-
#
|
10253
|
-
#
|
10254
|
-
# <note markdown="1"> The Amazon ECS container agent
|
10255
|
-
# health checks that are embedded in a container image
|
10256
|
-
# specified in
|
10257
|
-
# specified in
|
10258
|
-
# are specified in a container definition
|
10259
|
-
# 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.
|
10260
10338
|
#
|
10261
10339
|
# </note>
|
10262
10340
|
# @return [String]
|
10263
10341
|
#
|
10264
10342
|
# @!attribute [rw] inference_accelerators
|
10265
|
-
# The Elastic Inference accelerator associated with the task.
|
10343
|
+
# The Elastic Inference accelerator that's associated with the task.
|
10266
10344
|
# @return [Array<Types::InferenceAccelerator>]
|
10267
10345
|
#
|
10268
10346
|
# @!attribute [rw] last_status
|
10269
|
-
# The last known status
|
10347
|
+
# The last known status for the task. For more information, see [Task
|
10270
10348
|
# Lifecycle][1].
|
10271
10349
|
#
|
10272
10350
|
#
|
@@ -10275,9 +10353,9 @@ module Aws::ECS
|
|
10275
10353
|
# @return [String]
|
10276
10354
|
#
|
10277
10355
|
# @!attribute [rw] launch_type
|
10278
|
-
# The infrastructure
|
10279
|
-
#
|
10280
|
-
#
|
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*.
|
10281
10359
|
#
|
10282
10360
|
#
|
10283
10361
|
#
|
@@ -10285,17 +10363,17 @@ module Aws::ECS
|
|
10285
10363
|
# @return [String]
|
10286
10364
|
#
|
10287
10365
|
# @!attribute [rw] memory
|
10288
|
-
# The amount of memory (in MiB)
|
10289
|
-
# task definition. It can be expressed as an integer using MiB
|
10290
|
-
# example `1024
|
10291
|
-
# example `1GB` or `1 GB
|
10292
|
-
#
|
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.
|
10293
10371
|
#
|
10294
|
-
# If you
|
10372
|
+
# If you use the EC2 launch type, this field is optional.
|
10295
10373
|
#
|
10296
|
-
# If you
|
10297
|
-
#
|
10298
|
-
# 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.
|
10299
10377
|
#
|
10300
10378
|
# * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values:
|
10301
10379
|
# 256 (.25 vCPU)
|
@@ -10318,11 +10396,11 @@ module Aws::ECS
|
|
10318
10396
|
# @return [Types::TaskOverride]
|
10319
10397
|
#
|
10320
10398
|
# @!attribute [rw] platform_version
|
10321
|
-
# The platform version
|
10322
|
-
#
|
10323
|
-
#
|
10324
|
-
#
|
10325
|
-
#
|
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*.
|
10326
10404
|
#
|
10327
10405
|
#
|
10328
10406
|
#
|
@@ -10331,39 +10409,42 @@ module Aws::ECS
|
|
10331
10409
|
#
|
10332
10410
|
# @!attribute [rw] platform_family
|
10333
10411
|
# The operating system that your tasks are running on. A platform
|
10334
|
-
# family is specified only for tasks
|
10412
|
+
# family is specified only for tasks that use the Fargate launch type.
|
10335
10413
|
#
|
10336
10414
|
# All tasks that run as part of this service must use the same
|
10337
|
-
# `platformFamily` value as the service
|
10415
|
+
# `platformFamily` value as the service (for example, `LINUX.`).
|
10338
10416
|
# @return [String]
|
10339
10417
|
#
|
10340
10418
|
# @!attribute [rw] pull_started_at
|
10341
|
-
# The Unix timestamp for when the container image pull began.
|
10419
|
+
# The Unix timestamp for the time when the container image pull began.
|
10342
10420
|
# @return [Time]
|
10343
10421
|
#
|
10344
10422
|
# @!attribute [rw] pull_stopped_at
|
10345
|
-
# The Unix timestamp for when the container image pull
|
10423
|
+
# The Unix timestamp for the time when the container image pull
|
10424
|
+
# completed.
|
10346
10425
|
# @return [Time]
|
10347
10426
|
#
|
10348
10427
|
# @!attribute [rw] started_at
|
10349
|
-
# The Unix timestamp for when the task started
|
10350
|
-
#
|
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.
|
10351
10431
|
# @return [Time]
|
10352
10432
|
#
|
10353
10433
|
# @!attribute [rw] started_by
|
10354
|
-
# The tag specified when a task is started. If
|
10355
|
-
#
|
10356
|
-
#
|
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.
|
10357
10437
|
# @return [String]
|
10358
10438
|
#
|
10359
10439
|
# @!attribute [rw] stop_code
|
10360
10440
|
# The stop code indicating why a task was stopped. The `stoppedReason`
|
10361
|
-
#
|
10441
|
+
# might contain additional details.
|
10362
10442
|
# @return [String]
|
10363
10443
|
#
|
10364
10444
|
# @!attribute [rw] stopped_at
|
10365
|
-
# The Unix timestamp for when the task was stopped
|
10366
|
-
#
|
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.
|
10367
10448
|
# @return [Time]
|
10368
10449
|
#
|
10369
10450
|
# @!attribute [rw] stopped_reason
|
@@ -10371,14 +10452,15 @@ module Aws::ECS
|
|
10371
10452
|
# @return [String]
|
10372
10453
|
#
|
10373
10454
|
# @!attribute [rw] stopping_at
|
10374
|
-
# The Unix timestamp for when the task stops
|
10375
|
-
#
|
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`.
|
10376
10458
|
# @return [Time]
|
10377
10459
|
#
|
10378
10460
|
# @!attribute [rw] tags
|
10379
10461
|
# The metadata that you apply to the task to help you categorize and
|
10380
|
-
# organize
|
10381
|
-
# both
|
10462
|
+
# organize the task. Each tag consists of a key and an optional value.
|
10463
|
+
# You define both the key and value.
|
10382
10464
|
#
|
10383
10465
|
# The following basic restrictions apply to tags:
|
10384
10466
|
#
|
@@ -10416,8 +10498,8 @@ module Aws::ECS
|
|
10416
10498
|
#
|
10417
10499
|
# @!attribute [rw] version
|
10418
10500
|
# The version counter for the task. Every time a task experiences a
|
10419
|
-
# change that
|
10420
|
-
# 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
|
10421
10503
|
# CloudWatch Events, you can compare the version of a task reported by
|
10422
10504
|
# the Amazon ECS API actions with the version reported in CloudWatch
|
10423
10505
|
# Events for the task (inside the `detail` object) to verify that the
|
@@ -10495,8 +10577,8 @@ module Aws::ECS
|
|
10495
10577
|
#
|
10496
10578
|
# @!attribute [rw] family
|
10497
10579
|
# The name of a family that this task definition is registered to. Up
|
10498
|
-
# to 255
|
10499
|
-
# underscores are allowed.
|
10580
|
+
# to 255 characters are allowed. Letters (both uppercase and lowercase
|
10581
|
+
# letters), numbers, hyphens (-), and underscores (\_) are allowed.
|
10500
10582
|
#
|
10501
10583
|
# A family groups multiple versions of a task definition. Amazon ECS
|
10502
10584
|
# gives the first task definition that you registered to a family a
|
@@ -10513,10 +10595,9 @@ module Aws::ECS
|
|
10513
10595
|
#
|
10514
10596
|
# IAM roles for tasks on Windows require that the `-EnableTaskIAMRole`
|
10515
10597
|
# option is set when you launch the Amazon ECS-optimized Windows AMI.
|
10516
|
-
# Your containers must also run some configuration code
|
10517
|
-
#
|
10518
|
-
#
|
10519
|
-
# 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*.
|
10520
10601
|
#
|
10521
10602
|
#
|
10522
10603
|
#
|
@@ -10587,8 +10668,8 @@ module Aws::ECS
|
|
10587
10668
|
# version number of a task definition in a family. When you register a
|
10588
10669
|
# task definition for the first time, the revision is `1`. Each time
|
10589
10670
|
# that you register a new revision of a task definition in the same
|
10590
|
-
# family, the revision value always increases by one
|
10591
|
-
# 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.
|
10592
10673
|
# @return [Integer]
|
10593
10674
|
#
|
10594
10675
|
# @!attribute [rw] volumes
|
@@ -10596,7 +10677,7 @@ module Aws::ECS
|
|
10596
10677
|
# information, see [Using data volumes in tasks][1] in the *Amazon
|
10597
10678
|
# Elastic Container Service Developer Guide*.
|
10598
10679
|
#
|
10599
|
-
# <note markdown="1"> The `host` and `sourcePath` parameters
|
10680
|
+
# <note markdown="1"> The `host` and `sourcePath` parameters aren't supported for tasks
|
10600
10681
|
# run on Fargate.
|
10601
10682
|
#
|
10602
10683
|
# </note>
|
@@ -10614,13 +10695,13 @@ module Aws::ECS
|
|
10614
10695
|
# The container instance attributes required by your task. When an
|
10615
10696
|
# Amazon EC2 instance is registered to your cluster, the Amazon ECS
|
10616
10697
|
# container agent assigns some standard attributes to the instance.
|
10617
|
-
# You can apply custom attributes
|
10618
|
-
# the Amazon ECS console or the PutAttributes API. These
|
10619
|
-
# are used when
|
10620
|
-
# EC2 instances. For more information, see [Attributes][1]
|
10621
|
-
# *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*.
|
10622
10703
|
#
|
10623
|
-
# <note markdown="1"> This parameter
|
10704
|
+
# <note markdown="1"> This parameter isn't supported for tasks run on Fargate.
|
10624
10705
|
#
|
10625
10706
|
# </note>
|
10626
10707
|
#
|
@@ -10632,7 +10713,7 @@ module Aws::ECS
|
|
10632
10713
|
# @!attribute [rw] placement_constraints
|
10633
10714
|
# An array of placement constraint objects to use for tasks.
|
10634
10715
|
#
|
10635
|
-
# <note markdown="1"> This parameter
|
10716
|
+
# <note markdown="1"> This parameter isn't supported for tasks run on Fargate.
|
10636
10717
|
#
|
10637
10718
|
# </note>
|
10638
10719
|
# @return [Array<Types::TaskDefinitionPlacementConstraint>]
|
@@ -10664,11 +10745,14 @@ module Aws::ECS
|
|
10664
10745
|
# @return [Array<String>]
|
10665
10746
|
#
|
10666
10747
|
# @!attribute [rw] cpu
|
10667
|
-
# The number of `cpu` units used by the task. If you
|
10668
|
-
# launch type, this field is optional
|
10669
|
-
#
|
10670
|
-
#
|
10671
|
-
# 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.
|
10672
10756
|
#
|
10673
10757
|
# * 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1
|
10674
10758
|
# GB), 2048 (2 GB)
|
@@ -10690,16 +10774,16 @@ module Aws::ECS
|
|
10690
10774
|
# @!attribute [rw] memory
|
10691
10775
|
# The amount (in MiB) of memory used by the task.
|
10692
10776
|
#
|
10693
|
-
# If your tasks
|
10694
|
-
#
|
10695
|
-
#
|
10696
|
-
#
|
10697
|
-
#
|
10698
|
-
#
|
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].
|
10699
10783
|
#
|
10700
|
-
# If your tasks
|
10701
|
-
#
|
10702
|
-
# 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.
|
10703
10787
|
#
|
10704
10788
|
# * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values:
|
10705
10789
|
# 256 (.25 vCPU)
|
@@ -10722,7 +10806,7 @@ module Aws::ECS
|
|
10722
10806
|
# @return [String]
|
10723
10807
|
#
|
10724
10808
|
# @!attribute [rw] inference_accelerators
|
10725
|
-
# The Elastic Inference accelerator associated with the task.
|
10809
|
+
# The Elastic Inference accelerator that's associated with the task.
|
10726
10810
|
# @return [Array<Types::InferenceAccelerator>]
|
10727
10811
|
#
|
10728
10812
|
# @!attribute [rw] pid_mode
|
@@ -10798,9 +10882,9 @@ module Aws::ECS
|
|
10798
10882
|
# Your Amazon ECS container instances require at least version 1.26.0
|
10799
10883
|
# of the container agent and at least version 1.26.0-1 of the
|
10800
10884
|
# `ecs-init` package to enable a proxy configuration. If your
|
10801
|
-
# container instances are launched from the Amazon ECS
|
10802
|
-
# version `20190301` or later,
|
10803
|
-
#
|
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
|
10804
10888
|
# [Amazon ECS-optimized Linux AMI][1] in the *Amazon Elastic Container
|
10805
10889
|
# Service Developer Guide*.
|
10806
10890
|
#
|
@@ -10810,11 +10894,13 @@ module Aws::ECS
|
|
10810
10894
|
# @return [Types::ProxyConfiguration]
|
10811
10895
|
#
|
10812
10896
|
# @!attribute [rw] registered_at
|
10813
|
-
# The Unix timestamp for when the task definition was
|
10897
|
+
# The Unix timestamp for the time when the task definition was
|
10898
|
+
# registered.
|
10814
10899
|
# @return [Time]
|
10815
10900
|
#
|
10816
10901
|
# @!attribute [rw] deregistered_at
|
10817
|
-
# The Unix timestamp for when the task definition was
|
10902
|
+
# The Unix timestamp for the time when the task definition was
|
10903
|
+
# deregistered.
|
10818
10904
|
# @return [Time]
|
10819
10905
|
#
|
10820
10906
|
# @!attribute [rw] registered_by
|
@@ -10861,7 +10947,7 @@ module Aws::ECS
|
|
10861
10947
|
# definition. For more information, see [Task placement constraints][1]
|
10862
10948
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
10863
10949
|
#
|
10864
|
-
# <note markdown="1"> Task placement constraints
|
10950
|
+
# <note markdown="1"> Task placement constraints aren't supported for tasks run on Fargate.
|
10865
10951
|
#
|
10866
10952
|
# </note>
|
10867
10953
|
#
|
@@ -10901,7 +10987,7 @@ module Aws::ECS
|
|
10901
10987
|
include Aws::Structure
|
10902
10988
|
end
|
10903
10989
|
|
10904
|
-
# The overrides associated with a task.
|
10990
|
+
# The overrides that are associated with a task.
|
10905
10991
|
#
|
10906
10992
|
# @note When making an API call, you may pass TaskOverride
|
10907
10993
|
# data as a hash:
|
@@ -10950,7 +11036,7 @@ module Aws::ECS
|
|
10950
11036
|
# }
|
10951
11037
|
#
|
10952
11038
|
# @!attribute [rw] container_overrides
|
10953
|
-
# One or more container overrides sent to a task.
|
11039
|
+
# One or more container overrides that are sent to a task.
|
10954
11040
|
# @return [Array<Types::ContainerOverride>]
|
10955
11041
|
#
|
10956
11042
|
# @!attribute [rw] cpu
|
@@ -10991,8 +11077,8 @@ module Aws::ECS
|
|
10991
11077
|
# @!attribute [rw] ephemeral_storage
|
10992
11078
|
# The ephemeral storage setting override for the task.
|
10993
11079
|
#
|
10994
|
-
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate
|
10995
|
-
# the following platform versions:
|
11080
|
+
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate that
|
11081
|
+
# use the following platform versions:
|
10996
11082
|
#
|
10997
11083
|
# * Linux platform version `1.4.0` or later.
|
10998
11084
|
#
|
@@ -11039,17 +11125,17 @@ module Aws::ECS
|
|
11039
11125
|
# @return [String]
|
11040
11126
|
#
|
11041
11127
|
# @!attribute [rw] started_by
|
11042
|
-
# The tag specified when a task set is started. If
|
11043
|
-
# created
|
11044
|
-
# `CODE_DEPLOY`.
|
11045
|
-
#
|
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.
|
11046
11132
|
# @return [String]
|
11047
11133
|
#
|
11048
11134
|
# @!attribute [rw] external_id
|
11049
11135
|
# The external ID associated with the task set.
|
11050
11136
|
#
|
11051
|
-
# If
|
11052
|
-
#
|
11137
|
+
# If an CodeDeploy deployment created a task set, the `externalId`
|
11138
|
+
# parameter contains the CodeDeploy deployment ID.
|
11053
11139
|
#
|
11054
11140
|
# If a task set is created for an external deployment and is
|
11055
11141
|
# associated with a service discovery registry, the `externalId`
|
@@ -11058,7 +11144,7 @@ module Aws::ECS
|
|
11058
11144
|
# @return [String]
|
11059
11145
|
#
|
11060
11146
|
# @!attribute [rw] status
|
11061
|
-
# The status of the task set. The following describes each state
|
11147
|
+
# The status of the task set. The following describes each state.
|
11062
11148
|
#
|
11063
11149
|
# PRIMARY
|
11064
11150
|
#
|
@@ -11066,17 +11152,17 @@ module Aws::ECS
|
|
11066
11152
|
#
|
11067
11153
|
# ACTIVE
|
11068
11154
|
#
|
11069
|
-
# : The task set
|
11155
|
+
# : The task set isn't serving production traffic.
|
11070
11156
|
#
|
11071
11157
|
# DRAINING
|
11072
11158
|
#
|
11073
|
-
# : The tasks in the task set are being stopped and their
|
11159
|
+
# : The tasks in the task set are being stopped, and their
|
11074
11160
|
# corresponding targets are being deregistered from their target
|
11075
11161
|
# group.
|
11076
11162
|
# @return [String]
|
11077
11163
|
#
|
11078
11164
|
# @!attribute [rw] task_definition
|
11079
|
-
# The task definition the task set is using.
|
11165
|
+
# The task definition that the task set is using.
|
11080
11166
|
# @return [String]
|
11081
11167
|
#
|
11082
11168
|
# @!attribute [rw] computed_desired_count
|
@@ -11090,7 +11176,7 @@ module Aws::ECS
|
|
11090
11176
|
# The number of tasks in the task set that are in the `PENDING` status
|
11091
11177
|
# during a deployment. A task in the `PENDING` state is preparing to
|
11092
11178
|
# enter the `RUNNING` state. A task set enters the `PENDING` status
|
11093
|
-
# when it launches for the first time or when it
|
11179
|
+
# when it launches for the first time or when it's restarted after
|
11094
11180
|
# being in the `STOPPED` state.
|
11095
11181
|
# @return [Integer]
|
11096
11182
|
#
|
@@ -11101,11 +11187,11 @@ module Aws::ECS
|
|
11101
11187
|
# @return [Integer]
|
11102
11188
|
#
|
11103
11189
|
# @!attribute [rw] created_at
|
11104
|
-
# The Unix timestamp for when the task set was created.
|
11190
|
+
# The Unix timestamp for the time when the task set was created.
|
11105
11191
|
# @return [Time]
|
11106
11192
|
#
|
11107
11193
|
# @!attribute [rw] updated_at
|
11108
|
-
# 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.
|
11109
11195
|
# @return [Time]
|
11110
11196
|
#
|
11111
11197
|
# @!attribute [rw] launch_type
|
@@ -11119,11 +11205,12 @@ module Aws::ECS
|
|
11119
11205
|
# @return [String]
|
11120
11206
|
#
|
11121
11207
|
# @!attribute [rw] capacity_provider_strategy
|
11122
|
-
# The capacity provider strategy associated with the task
|
11208
|
+
# The capacity provider strategy that are associated with the task
|
11209
|
+
# set.
|
11123
11210
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
11124
11211
|
#
|
11125
11212
|
# @!attribute [rw] platform_version
|
11126
|
-
# The Fargate platform version
|
11213
|
+
# The Fargate platform version where the tasks in the task set are
|
11127
11214
|
# running. A platform version is only specified for tasks run on
|
11128
11215
|
# Fargate. For more information, see [Fargate platform versions][1] in
|
11129
11216
|
# the *Amazon Elastic Container Service Developer Guide*.
|
@@ -11135,8 +11222,8 @@ module Aws::ECS
|
|
11135
11222
|
#
|
11136
11223
|
# @!attribute [rw] platform_family
|
11137
11224
|
# The operating system that your tasks in the set are running on. A
|
11138
|
-
# platform family is specified only for tasks
|
11139
|
-
# type.
|
11225
|
+
# platform family is specified only for tasks that use the Fargate
|
11226
|
+
# launch type.
|
11140
11227
|
#
|
11141
11228
|
# All tasks in the set must have the same value.
|
11142
11229
|
# @return [String]
|
@@ -11146,11 +11233,11 @@ module Aws::ECS
|
|
11146
11233
|
# @return [Types::NetworkConfiguration]
|
11147
11234
|
#
|
11148
11235
|
# @!attribute [rw] load_balancers
|
11149
|
-
# Details on a load balancer that
|
11236
|
+
# Details on a load balancer that are used with a task set.
|
11150
11237
|
# @return [Array<Types::LoadBalancer>]
|
11151
11238
|
#
|
11152
11239
|
# @!attribute [rw] service_registries
|
11153
|
-
# The details
|
11240
|
+
# The details for the service discovery registries to assign to this
|
11154
11241
|
# task set. For more information, see [Service discovery][1].
|
11155
11242
|
#
|
11156
11243
|
#
|
@@ -11159,38 +11246,38 @@ module Aws::ECS
|
|
11159
11246
|
# @return [Array<Types::ServiceRegistry>]
|
11160
11247
|
#
|
11161
11248
|
# @!attribute [rw] scale
|
11162
|
-
# A floating-point percentage of
|
11249
|
+
# A floating-point percentage of your desired number of tasks to place
|
11163
11250
|
# and keep running in the task set.
|
11164
11251
|
# @return [Types::Scale]
|
11165
11252
|
#
|
11166
11253
|
# @!attribute [rw] stability_status
|
11167
|
-
# The stability status
|
11254
|
+
# The stability status. This indicates whether the task set has
|
11168
11255
|
# reached a steady state. If the following conditions are met, the
|
11169
|
-
# task set
|
11256
|
+
# task set sre in `STEADY_STATE`\:
|
11170
11257
|
#
|
11171
11258
|
# * The task `runningCount` is equal to the `computedDesiredCount`.
|
11172
11259
|
#
|
11173
11260
|
# * The `pendingCount` is `0`.
|
11174
11261
|
#
|
11175
|
-
# * There are no tasks running on container instances in the
|
11262
|
+
# * There are no tasks that are running on container instances in the
|
11176
11263
|
# `DRAINING` status.
|
11177
11264
|
#
|
11178
11265
|
# * All tasks are reporting a healthy status from the load balancers,
|
11179
11266
|
# service discovery, and container health checks.
|
11180
11267
|
#
|
11181
|
-
# If any of those conditions
|
11268
|
+
# If any of those conditions aren't met, the stability status returns
|
11182
11269
|
# `STABILIZING`.
|
11183
11270
|
# @return [String]
|
11184
11271
|
#
|
11185
11272
|
# @!attribute [rw] stability_status_at
|
11186
|
-
# The Unix timestamp for when the task set stability status
|
11187
|
-
# retrieved.
|
11273
|
+
# The Unix timestamp for the time when the task set stability status
|
11274
|
+
# was retrieved.
|
11188
11275
|
# @return [Time]
|
11189
11276
|
#
|
11190
11277
|
# @!attribute [rw] tags
|
11191
11278
|
# The metadata that you apply to the task set to help you categorize
|
11192
|
-
# and organize them. Each tag consists of a key and an optional value
|
11193
|
-
#
|
11279
|
+
# and organize them. Each tag consists of a key and an optional value.
|
11280
|
+
# You define both.
|
11194
11281
|
#
|
11195
11282
|
# The following basic restrictions apply to tags:
|
11196
11283
|
#
|
@@ -11249,9 +11336,9 @@ module Aws::ECS
|
|
11249
11336
|
include Aws::Structure
|
11250
11337
|
end
|
11251
11338
|
|
11252
|
-
# The specified task set
|
11253
|
-
#
|
11254
|
-
#
|
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.
|
11255
11342
|
#
|
11256
11343
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TaskSetNotFoundException AWS API Documentation
|
11257
11344
|
#
|
@@ -11338,7 +11425,7 @@ module Aws::ECS
|
|
11338
11425
|
include Aws::Structure
|
11339
11426
|
end
|
11340
11427
|
|
11341
|
-
# The specified task
|
11428
|
+
# The specified task isn't supported in this Region.
|
11342
11429
|
#
|
11343
11430
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UnsupportedFeatureException AWS API Documentation
|
11344
11431
|
#
|
@@ -11353,8 +11440,8 @@ module Aws::ECS
|
|
11353
11440
|
# }
|
11354
11441
|
#
|
11355
11442
|
# @!attribute [rw] resource_arn
|
11356
|
-
# The Amazon Resource Name (ARN) of the resource
|
11357
|
-
#
|
11443
|
+
# The Amazon Resource Name (ARN) of the resource to delete tags from.
|
11444
|
+
# Currently, the supported resources are Amazon ECS capacity
|
11358
11445
|
# providers, tasks, services, task definitions, clusters, and
|
11359
11446
|
# container instances.
|
11360
11447
|
# @return [String]
|
@@ -11398,8 +11485,8 @@ module Aws::ECS
|
|
11398
11485
|
# @return [String]
|
11399
11486
|
#
|
11400
11487
|
# @!attribute [rw] auto_scaling_group_provider
|
11401
|
-
# An object
|
11402
|
-
# group capacity provider.
|
11488
|
+
# An object that represent the parameters to update for the Auto
|
11489
|
+
# Scaling group capacity provider.
|
11403
11490
|
# @return [Types::AutoScalingGroupProviderUpdate]
|
11404
11491
|
#
|
11405
11492
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateCapacityProviderRequest AWS API Documentation
|
@@ -11503,8 +11590,8 @@ module Aws::ECS
|
|
11503
11590
|
# @!attribute [rw] settings
|
11504
11591
|
# The setting to use by default for a cluster. This parameter is used
|
11505
11592
|
# to enable CloudWatch Container Insights for a cluster. If this value
|
11506
|
-
# is specified, it
|
11507
|
-
#
|
11593
|
+
# is specified, it overrides the `containerInsights` value set with
|
11594
|
+
# PutAccountSetting or PutAccountSettingDefault.
|
11508
11595
|
# @return [Array<Types::ClusterSetting>]
|
11509
11596
|
#
|
11510
11597
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateClusterSettingsRequest AWS API Documentation
|
@@ -11544,7 +11631,7 @@ module Aws::ECS
|
|
11544
11631
|
#
|
11545
11632
|
# @!attribute [rw] container_instance
|
11546
11633
|
# The container instance ID or full ARN entries for the container
|
11547
|
-
# instance
|
11634
|
+
# instance where you would like to update the Amazon ECS container
|
11548
11635
|
# agent.
|
11549
11636
|
# @return [String]
|
11550
11637
|
#
|
@@ -11558,7 +11645,7 @@ module Aws::ECS
|
|
11558
11645
|
end
|
11559
11646
|
|
11560
11647
|
# @!attribute [rw] container_instance
|
11561
|
-
# The container instance
|
11648
|
+
# The container instance that the container agent was updated for.
|
11562
11649
|
# @return [Types::ContainerInstance]
|
11563
11650
|
#
|
11564
11651
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerAgentResponse AWS API Documentation
|
@@ -11589,13 +11676,13 @@ module Aws::ECS
|
|
11589
11676
|
# @return [Array<String>]
|
11590
11677
|
#
|
11591
11678
|
# @!attribute [rw] status
|
11592
|
-
# The container instance state
|
11593
|
-
#
|
11594
|
-
#
|
11595
|
-
#
|
11596
|
-
#
|
11597
|
-
#
|
11598
|
-
#
|
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.
|
11599
11686
|
# @return [String]
|
11600
11687
|
#
|
11601
11688
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerInstancesStateRequest AWS API Documentation
|
@@ -11625,10 +11712,10 @@ module Aws::ECS
|
|
11625
11712
|
include Aws::Structure
|
11626
11713
|
end
|
11627
11714
|
|
11628
|
-
# There
|
11629
|
-
# progress on the
|
11630
|
-
# becomes disconnected while it
|
11631
|
-
# `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
|
11632
11719
|
# state. However, when the agent reconnects, it resumes where it stopped
|
11633
11720
|
# previously.
|
11634
11721
|
#
|
@@ -11732,8 +11819,8 @@ module Aws::ECS
|
|
11732
11819
|
#
|
11733
11820
|
# @!attribute [rw] cluster
|
11734
11821
|
# The short name or full Amazon Resource Name (ARN) of the cluster
|
11735
|
-
# that your service
|
11736
|
-
#
|
11822
|
+
# that your service runs on. If you do not specify a cluster, the
|
11823
|
+
# default cluster is assumed.
|
11737
11824
|
# @return [String]
|
11738
11825
|
#
|
11739
11826
|
# @!attribute [rw] service
|
@@ -11757,12 +11844,13 @@ module Aws::ECS
|
|
11757
11844
|
# @!attribute [rw] capacity_provider_strategy
|
11758
11845
|
# The capacity provider strategy to update the service to use.
|
11759
11846
|
#
|
11760
|
-
#
|
11761
|
-
#
|
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
|
11762
11849
|
# providers as opposed to the default capacity provider strategy.
|
11763
|
-
# However, when a service is using a capacity provider strategy
|
11764
|
-
#
|
11765
|
-
# 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.
|
11766
11854
|
#
|
11767
11855
|
# A capacity provider strategy consists of one or more capacity
|
11768
11856
|
# providers along with the `base` and `weight` to assign to them. A
|
@@ -11804,9 +11892,9 @@ module Aws::ECS
|
|
11804
11892
|
# service. To remove all existing placement constraints, specify an
|
11805
11893
|
# empty array.
|
11806
11894
|
#
|
11807
|
-
# You can specify a maximum of 10 constraints
|
11808
|
-
# includes constraints in the task definition and those
|
11809
|
-
# 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.
|
11810
11898
|
# @return [Array<Types::PlacementConstraint>]
|
11811
11899
|
#
|
11812
11900
|
# @!attribute [rw] placement_strategy
|
@@ -11816,16 +11904,16 @@ module Aws::ECS
|
|
11816
11904
|
# override the existing placement strategy defined for the service. To
|
11817
11905
|
# remove an existing placement strategy, specify an empty object.
|
11818
11906
|
#
|
11819
|
-
# You can specify a maximum of five strategy rules
|
11907
|
+
# You can specify a maximum of five strategy rules for each service.
|
11820
11908
|
# @return [Array<Types::PlacementStrategy>]
|
11821
11909
|
#
|
11822
11910
|
# @!attribute [rw] platform_version
|
11823
|
-
# The platform version
|
11824
|
-
#
|
11911
|
+
# The platform version that your tasks in the service run on. A
|
11912
|
+
# platform version is only specified for tasks using the Fargate
|
11825
11913
|
# launch type. If a platform version is not specified, the `LATEST`
|
11826
|
-
# platform version is used
|
11827
|
-
#
|
11828
|
-
#
|
11914
|
+
# platform version is used. For more information, see [Fargate
|
11915
|
+
# Platform Versions][1] in the *Amazon Elastic Container Service
|
11916
|
+
# Developer Guide*.
|
11829
11917
|
#
|
11830
11918
|
#
|
11831
11919
|
#
|
@@ -11833,26 +11921,26 @@ module Aws::ECS
|
|
11833
11921
|
# @return [String]
|
11834
11922
|
#
|
11835
11923
|
# @!attribute [rw] force_new_deployment
|
11836
|
-
#
|
11837
|
-
#
|
11838
|
-
# deployment with no service definition changes. For
|
11839
|
-
# update a service's tasks to use a newer Docker
|
11840
|
-
# image/tag combination (`my_image:latest`) or to
|
11841
|
-
# 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.
|
11842
11930
|
# @return [Boolean]
|
11843
11931
|
#
|
11844
11932
|
# @!attribute [rw] health_check_grace_period_seconds
|
11845
11933
|
# The period of time, in seconds, that the Amazon ECS service
|
11846
|
-
# scheduler
|
11847
|
-
#
|
11848
|
-
#
|
11849
|
-
#
|
11850
|
-
#
|
11851
|
-
#
|
11852
|
-
#
|
11853
|
-
#
|
11854
|
-
#
|
11855
|
-
#
|
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.
|
11856
11944
|
# @return [Integer]
|
11857
11945
|
#
|
11858
11946
|
# @!attribute [rw] enable_execute_command
|
@@ -11911,12 +11999,12 @@ module Aws::ECS
|
|
11911
11999
|
#
|
11912
12000
|
# @!attribute [rw] cluster
|
11913
12001
|
# The short name or full Amazon Resource Name (ARN) of the cluster
|
11914
|
-
# that hosts the service that the task set
|
12002
|
+
# that hosts the service that the task set is found in.
|
11915
12003
|
# @return [String]
|
11916
12004
|
#
|
11917
12005
|
# @!attribute [rw] service
|
11918
12006
|
# The short name or full Amazon Resource Name (ARN) of the service
|
11919
|
-
# that the task set
|
12007
|
+
# that the task set is found in.
|
11920
12008
|
# @return [String]
|
11921
12009
|
#
|
11922
12010
|
# @!attribute [rw] task_set
|
@@ -11978,7 +12066,7 @@ module Aws::ECS
|
|
11978
12066
|
# @return [String]
|
11979
12067
|
#
|
11980
12068
|
# @!attribute [rw] docker_version
|
11981
|
-
# The Docker version running on the container instance.
|
12069
|
+
# The Docker version that's running on the container instance.
|
11982
12070
|
# @return [String]
|
11983
12071
|
#
|
11984
12072
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/VersionInfo AWS API Documentation
|
@@ -11991,14 +12079,14 @@ module Aws::ECS
|
|
11991
12079
|
include Aws::Structure
|
11992
12080
|
end
|
11993
12081
|
|
11994
|
-
# A data volume used in a task definition. For tasks that use
|
11995
|
-
# Elastic File System (Amazon EFS), specify an
|
11996
|
-
# For Windows tasks that use Amazon FSx for
|
11997
|
-
# system, specify a
|
11998
|
-
# that use a Docker
|
11999
|
-
#
|
12000
|
-
#
|
12001
|
-
# 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].
|
12002
12090
|
#
|
12003
12091
|
#
|
12004
12092
|
#
|
@@ -12051,40 +12139,40 @@ module Aws::ECS
|
|
12051
12139
|
# @return [String]
|
12052
12140
|
#
|
12053
12141
|
# @!attribute [rw] host
|
12054
|
-
# This parameter is specified when you
|
12055
|
-
#
|
12056
|
-
#
|
12057
|
-
#
|
12058
|
-
#
|
12059
|
-
#
|
12060
|
-
# 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.
|
12061
12149
|
#
|
12062
12150
|
# Windows containers can mount whole directories on the same drive as
|
12063
|
-
# `$env:ProgramData`. Windows containers
|
12064
|
-
# 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
|
12065
12153
|
# example, you can mount `C:\my\path:C:\my\path` and `D:\:D:`, but
|
12066
12154
|
# not `D:\my\path:C:\my\path` or `D:\:C:\my\path`.
|
12067
12155
|
# @return [Types::HostVolumeProperties]
|
12068
12156
|
#
|
12069
12157
|
# @!attribute [rw] docker_volume_configuration
|
12070
|
-
# This parameter is specified when you
|
12158
|
+
# This parameter is specified when you use Docker volumes.
|
12071
12159
|
#
|
12072
12160
|
# Windows containers only support the use of the `local` driver. To
|
12073
12161
|
# use bind mounts, specify the `host` parameter instead.
|
12074
12162
|
#
|
12075
|
-
# <note markdown="1"> Docker volumes
|
12163
|
+
# <note markdown="1"> Docker volumes aren't supported by tasks run on Fargate.
|
12076
12164
|
#
|
12077
12165
|
# </note>
|
12078
12166
|
# @return [Types::DockerVolumeConfiguration]
|
12079
12167
|
#
|
12080
12168
|
# @!attribute [rw] efs_volume_configuration
|
12081
|
-
# This parameter is specified when you
|
12082
|
-
#
|
12169
|
+
# This parameter is specified when you use an Amazon Elastic File
|
12170
|
+
# System file system for task storage.
|
12083
12171
|
# @return [Types::EFSVolumeConfiguration]
|
12084
12172
|
#
|
12085
12173
|
# @!attribute [rw] fsx_windows_file_server_volume_configuration
|
12086
|
-
# This parameter is specified when you
|
12087
|
-
#
|
12174
|
+
# This parameter is specified when you use Amazon FSx for Windows File
|
12175
|
+
# Server file system for task storage.
|
12088
12176
|
# @return [Types::FSxWindowsFileServerVolumeConfiguration]
|
12089
12177
|
#
|
12090
12178
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Volume AWS API Documentation
|
@@ -12111,8 +12199,8 @@ module Aws::ECS
|
|
12111
12199
|
# }
|
12112
12200
|
#
|
12113
12201
|
# @!attribute [rw] source_container
|
12114
|
-
# The name of another container within the same task definition
|
12115
|
-
#
|
12202
|
+
# The name of another container within the same task definition to
|
12203
|
+
# mount volumes from.
|
12116
12204
|
# @return [String]
|
12117
12205
|
#
|
12118
12206
|
# @!attribute [rw] read_only
|