aws-sdk-ecs 1.89.0 → 1.93.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ecs/client.rb +528 -472
- data/lib/aws-sdk-ecs/client_api.rb +18 -0
- data/lib/aws-sdk-ecs/types.rb +1090 -986
- data/lib/aws-sdk-ecs.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-ecs/client.rb
CHANGED
|
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
|
30
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
|
31
32
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
|
32
33
|
|
|
@@ -73,6 +74,7 @@ module Aws::ECS
|
|
|
73
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
|
74
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
|
75
76
|
add_plugin(Aws::Plugins::HttpChecksum)
|
|
77
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
|
76
78
|
add_plugin(Aws::Plugins::SignatureV4)
|
|
77
79
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
|
78
80
|
|
|
@@ -119,7 +121,9 @@ module Aws::ECS
|
|
|
119
121
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
|
120
122
|
# are very aggressive. Construct and pass an instance of
|
|
121
123
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
|
122
|
-
# enable retries and extended timeouts.
|
|
124
|
+
# enable retries and extended timeouts. Instance profile credential
|
|
125
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
|
126
|
+
# to true.
|
|
123
127
|
#
|
|
124
128
|
# @option options [required, String] :region
|
|
125
129
|
# The AWS region to connect to. The configured `:region` is
|
|
@@ -173,6 +177,10 @@ module Aws::ECS
|
|
|
173
177
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
|
174
178
|
# a clock skew correction and retry requests with skewed client clocks.
|
|
175
179
|
#
|
|
180
|
+
# @option options [String] :defaults_mode ("legacy")
|
|
181
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
|
182
|
+
# accepted modes and the configuration defaults that are included.
|
|
183
|
+
#
|
|
176
184
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
|
177
185
|
# Set to true to disable SDK automatically adding host prefix
|
|
178
186
|
# to default service endpoint when available.
|
|
@@ -305,7 +313,7 @@ module Aws::ECS
|
|
|
305
313
|
# seconds to wait when opening a HTTP session before raising a
|
|
306
314
|
# `Timeout::Error`.
|
|
307
315
|
#
|
|
308
|
-
# @option options [
|
|
316
|
+
# @option options [Float] :http_read_timeout (60) The default
|
|
309
317
|
# number of seconds to wait for response data. This value can
|
|
310
318
|
# safely be set per-request on the session.
|
|
311
319
|
#
|
|
@@ -321,6 +329,9 @@ module Aws::ECS
|
|
|
321
329
|
# disables this behaviour. This value can safely be set per
|
|
322
330
|
# request on the session.
|
|
323
331
|
#
|
|
332
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
|
333
|
+
# in seconds.
|
|
334
|
+
#
|
|
324
335
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
|
325
336
|
# HTTP debug output will be sent to the `:logger`.
|
|
326
337
|
#
|
|
@@ -350,24 +361,24 @@ module Aws::ECS
|
|
|
350
361
|
# with an Amazon ECS cluster and are used in capacity provider
|
|
351
362
|
# strategies to facilitate cluster auto scaling.
|
|
352
363
|
#
|
|
353
|
-
# Only capacity providers
|
|
364
|
+
# Only capacity providers that use an Auto Scaling group can be created.
|
|
354
365
|
# Amazon ECS tasks on Fargate use the `FARGATE` and `FARGATE_SPOT`
|
|
355
|
-
# capacity providers
|
|
356
|
-
#
|
|
366
|
+
# capacity providers. These providers are available to all accounts in
|
|
367
|
+
# the Amazon Web Services Regions that Fargate supports.
|
|
357
368
|
#
|
|
358
369
|
# @option params [required, String] :name
|
|
359
|
-
# The name of the capacity provider. Up to 255 characters are allowed
|
|
360
|
-
#
|
|
361
|
-
# hyphens. The name
|
|
362
|
-
# "`fargate`".
|
|
370
|
+
# The name of the capacity provider. Up to 255 characters are allowed.
|
|
371
|
+
# They include letters (both upper and lowercase letters), numbers,
|
|
372
|
+
# underscores (\_), and hyphens (-). The name can't be prefixed with
|
|
373
|
+
# "`aws`", "`ecs`", or "`fargate`".
|
|
363
374
|
#
|
|
364
375
|
# @option params [required, Types::AutoScalingGroupProvider] :auto_scaling_group_provider
|
|
365
376
|
# The details of the Auto Scaling group for the capacity provider.
|
|
366
377
|
#
|
|
367
378
|
# @option params [Array<Types::Tag>] :tags
|
|
368
|
-
# The metadata that you apply to the capacity provider to
|
|
369
|
-
#
|
|
370
|
-
# optional value
|
|
379
|
+
# The metadata that you apply to the capacity provider to categorize and
|
|
380
|
+
# organize them more conveniently. Each tag consists of a key and an
|
|
381
|
+
# optional value. You define both of them.
|
|
371
382
|
#
|
|
372
383
|
# The following basic restrictions apply to tags:
|
|
373
384
|
#
|
|
@@ -454,10 +465,10 @@ module Aws::ECS
|
|
|
454
465
|
# `CreateCluster` action.
|
|
455
466
|
#
|
|
456
467
|
# <note markdown="1"> When you call the CreateCluster API operation, Amazon ECS attempts to
|
|
457
|
-
# create the Amazon ECS service-linked role for your account so
|
|
458
|
-
# required resources in other Amazon Web Services
|
|
459
|
-
#
|
|
460
|
-
#
|
|
468
|
+
# create the Amazon ECS service-linked role for your account. This is so
|
|
469
|
+
# that it can manage required resources in other Amazon Web Services
|
|
470
|
+
# services on your behalf. However, if the IAM user that makes the call
|
|
471
|
+
# doesn't have permissions to create the service-linked role, it isn't
|
|
461
472
|
# created. For more information, see [Using Service-Linked Roles for
|
|
462
473
|
# Amazon ECS][1] in the *Amazon Elastic Container Service Developer
|
|
463
474
|
# Guide*.
|
|
@@ -469,15 +480,15 @@ module Aws::ECS
|
|
|
469
480
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html
|
|
470
481
|
#
|
|
471
482
|
# @option params [String] :cluster_name
|
|
472
|
-
# The name of your cluster. If you
|
|
473
|
-
# cluster, you create a cluster named `default`. Up to 255
|
|
474
|
-
# (uppercase and lowercase), numbers, underscores, and hyphens
|
|
475
|
-
# allowed.
|
|
483
|
+
# The name of your cluster. If you don't specify a name for your
|
|
484
|
+
# cluster, you create a cluster that's named `default`. Up to 255
|
|
485
|
+
# letters (uppercase and lowercase), numbers, underscores, and hyphens
|
|
486
|
+
# are allowed.
|
|
476
487
|
#
|
|
477
488
|
# @option params [Array<Types::Tag>] :tags
|
|
478
489
|
# The metadata that you apply to the cluster to help you categorize and
|
|
479
|
-
# organize them. Each tag consists of a key and an optional value
|
|
480
|
-
#
|
|
490
|
+
# organize them. Each tag consists of a key and an optional value. You
|
|
491
|
+
# define both.
|
|
481
492
|
#
|
|
482
493
|
# The following basic restrictions apply to tags:
|
|
483
494
|
#
|
|
@@ -507,7 +518,7 @@ module Aws::ECS
|
|
|
507
518
|
# @option params [Array<Types::ClusterSetting>] :settings
|
|
508
519
|
# The setting to use when creating a cluster. This parameter is used to
|
|
509
520
|
# enable CloudWatch Container Insights for a cluster. If this value is
|
|
510
|
-
# specified, it
|
|
521
|
+
# specified, it overrides the `containerInsights` value set with
|
|
511
522
|
# PutAccountSetting or PutAccountSettingDefault.
|
|
512
523
|
#
|
|
513
524
|
# @option params [Types::ClusterConfiguration] :configuration
|
|
@@ -521,9 +532,9 @@ module Aws::ECS
|
|
|
521
532
|
# the CreateService or RunTask actions.
|
|
522
533
|
#
|
|
523
534
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
|
524
|
-
# capacity provider must
|
|
525
|
-
#
|
|
526
|
-
#
|
|
535
|
+
# capacity provider must be created but not associated with another
|
|
536
|
+
# cluster. New Auto Scaling group capacity providers can be created with
|
|
537
|
+
# the CreateCapacityProvider API operation.
|
|
527
538
|
#
|
|
528
539
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
|
529
540
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
|
@@ -536,13 +547,13 @@ module Aws::ECS
|
|
|
536
547
|
#
|
|
537
548
|
# @option params [Array<Types::CapacityProviderStrategyItem>] :default_capacity_provider_strategy
|
|
538
549
|
# The capacity provider strategy to set as the default for the cluster.
|
|
539
|
-
#
|
|
540
|
-
#
|
|
550
|
+
# After a default capacity provider strategy is set for a cluster, when
|
|
551
|
+
# you call the RunTask or CreateService APIs with no capacity provider
|
|
541
552
|
# strategy or launch type specified, the default capacity provider
|
|
542
553
|
# strategy for the cluster is used.
|
|
543
554
|
#
|
|
544
|
-
# If a default capacity provider strategy
|
|
545
|
-
#
|
|
555
|
+
# If a default capacity provider strategy isn't defined for a cluster
|
|
556
|
+
# when it was created, it can be defined later with the
|
|
546
557
|
# PutClusterCapacityProviders API operation.
|
|
547
558
|
#
|
|
548
559
|
# @return [Types::CreateClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -659,7 +670,7 @@ module Aws::ECS
|
|
|
659
670
|
req.send_request(options)
|
|
660
671
|
end
|
|
661
672
|
|
|
662
|
-
# Runs and maintains
|
|
673
|
+
# Runs and maintains your desired number of tasks from a specified task
|
|
663
674
|
# definition. If the number of tasks running in a service drops below
|
|
664
675
|
# the `desiredCount`, Amazon ECS runs another copy of the task in the
|
|
665
676
|
# specified cluster. To update an existing service, see the
|
|
@@ -672,26 +683,27 @@ module Aws::ECS
|
|
|
672
683
|
# Balancing][1] in the *Amazon Elastic Container Service Developer
|
|
673
684
|
# Guide*.
|
|
674
685
|
#
|
|
675
|
-
# Tasks for services that
|
|
686
|
+
# Tasks for services that don't use a load balancer are considered
|
|
676
687
|
# healthy if they're in the `RUNNING` state. Tasks for services that
|
|
677
|
-
#
|
|
688
|
+
# use a load balancer are considered healthy if they're in the
|
|
678
689
|
# `RUNNING` state and the container instance that they're hosted on is
|
|
679
690
|
# reported as healthy by the load balancer.
|
|
680
691
|
#
|
|
681
692
|
# There are two service scheduler strategies available:
|
|
682
693
|
#
|
|
683
|
-
# * `REPLICA` - The replica scheduling strategy places and maintains
|
|
684
|
-
# desired number of tasks across your cluster. By default, the
|
|
685
|
-
# scheduler spreads tasks across Availability Zones. You can
|
|
686
|
-
# placement strategies and constraints to customize task
|
|
687
|
-
# decisions. For more information, see [Service Scheduler
|
|
688
|
-
# in the *Amazon Elastic Container Service Developer
|
|
694
|
+
# * `REPLICA` - The replica scheduling strategy places and maintains
|
|
695
|
+
# your desired number of tasks across your cluster. By default, the
|
|
696
|
+
# service scheduler spreads tasks across Availability Zones. You can
|
|
697
|
+
# use task placement strategies and constraints to customize task
|
|
698
|
+
# placement decisions. For more information, see [Service Scheduler
|
|
699
|
+
# Concepts][2] in the *Amazon Elastic Container Service Developer
|
|
700
|
+
# Guide*.
|
|
689
701
|
#
|
|
690
702
|
# * `DAEMON` - The daemon scheduling strategy deploys exactly one task
|
|
691
703
|
# on each active container instance that meets all of the task
|
|
692
704
|
# placement constraints that you specify in your cluster. The service
|
|
693
705
|
# scheduler also evaluates the task placement constraints for running
|
|
694
|
-
# tasks
|
|
706
|
+
# tasks. It also stops tasks that don't meet the placement
|
|
695
707
|
# constraints. When using this strategy, you don't need to specify a
|
|
696
708
|
# desired number of tasks, a task placement strategy, or use Service
|
|
697
709
|
# Auto Scaling policies. For more information, see [Service Scheduler
|
|
@@ -699,51 +711,53 @@ module Aws::ECS
|
|
|
699
711
|
# Guide*.
|
|
700
712
|
#
|
|
701
713
|
# You can optionally specify a deployment configuration for your
|
|
702
|
-
# service. The deployment is
|
|
703
|
-
# the
|
|
704
|
-
#
|
|
714
|
+
# service. The deployment is initiated by changing properties. For
|
|
715
|
+
# example, the deployment might be initiated by the task definition or
|
|
716
|
+
# by your desired count of a service. This is done with an UpdateService
|
|
717
|
+
# operation. The default value for a replica service for
|
|
705
718
|
# `minimumHealthyPercent` is 100%. The default value for a daemon
|
|
706
719
|
# service for `minimumHealthyPercent` is 0%.
|
|
707
720
|
#
|
|
708
|
-
# If a service
|
|
709
|
-
#
|
|
710
|
-
#
|
|
711
|
-
# as a percentage of
|
|
712
|
-
# nearest integer)
|
|
713
|
-
# `DRAINING` state if the service
|
|
714
|
-
#
|
|
715
|
-
# cluster capacity. For example, if
|
|
716
|
-
#
|
|
717
|
-
#
|
|
718
|
-
#
|
|
719
|
-
#
|
|
720
|
-
#
|
|
721
|
-
#
|
|
722
|
-
#
|
|
723
|
-
# 100%.
|
|
724
|
-
#
|
|
725
|
-
# If a service
|
|
721
|
+
# If a service uses the `ECS` deployment controller, the minimum healthy
|
|
722
|
+
# percent represents a lower limit on the number of tasks in a service
|
|
723
|
+
# that must remain in the `RUNNING` state during a deployment.
|
|
724
|
+
# Specifically, it represents it as a percentage of your desired number
|
|
725
|
+
# of tasks (rounded up to the nearest integer). This happens when any of
|
|
726
|
+
# your container instances are in the `DRAINING` state if the service
|
|
727
|
+
# contains tasks using the EC2 launch type. Using this parameter, you
|
|
728
|
+
# can deploy without using additional cluster capacity. For example, if
|
|
729
|
+
# you set your service to have desired number of four tasks and a
|
|
730
|
+
# minimum healthy percent of 50%, the scheduler might stop two existing
|
|
731
|
+
# tasks to free up cluster capacity before starting two new tasks. If
|
|
732
|
+
# they're in the `RUNNING` state, tasks for services that don't use a
|
|
733
|
+
# load balancer are considered healthy . If they're in the `RUNNING`
|
|
734
|
+
# state and reported as healthy by the load balancer, tasks for services
|
|
735
|
+
# that *do* use a load balancer are considered healthy . The default
|
|
736
|
+
# value for minimum healthy percent is 100%.
|
|
737
|
+
#
|
|
738
|
+
# If a service uses the `ECS` deployment controller, the **maximum
|
|
726
739
|
# percent** parameter represents an upper limit on the number of tasks
|
|
727
740
|
# in a service that are allowed in the `RUNNING` or `PENDING` state
|
|
728
|
-
# during a deployment, as a percentage of
|
|
729
|
-
# (rounded down to the nearest integer)
|
|
730
|
-
#
|
|
731
|
-
#
|
|
732
|
-
#
|
|
733
|
-
#
|
|
734
|
-
# scheduler may start four new tasks
|
|
735
|
-
# tasks (provided that the cluster
|
|
736
|
-
# available). The default value for
|
|
737
|
-
#
|
|
738
|
-
#
|
|
739
|
-
#
|
|
740
|
-
#
|
|
741
|
-
#
|
|
742
|
-
#
|
|
741
|
+
# during a deployment. Specifically, it represents it as a percentage of
|
|
742
|
+
# the desired number of tasks (rounded down to the nearest integer).
|
|
743
|
+
# This happens when any of your container instances are in the
|
|
744
|
+
# `DRAINING` state if the service contains tasks using the EC2 launch
|
|
745
|
+
# type. Using this parameter, you can define the deployment batch size.
|
|
746
|
+
# For example, if your service has a desired number of four tasks and a
|
|
747
|
+
# maximum percent value of 200%, the scheduler may start four new tasks
|
|
748
|
+
# before stopping the four older tasks (provided that the cluster
|
|
749
|
+
# resources required to do this are available). The default value for
|
|
750
|
+
# maximum percent is 200%.
|
|
751
|
+
#
|
|
752
|
+
# If a service uses either the `CODE_DEPLOY` or `EXTERNAL` deployment
|
|
753
|
+
# controller types and tasks that use the EC2 launch type, the **minimum
|
|
754
|
+
# healthy percent** and **maximum percent** values are used only to
|
|
755
|
+
# define the lower and upper limit on the number of the tasks in the
|
|
756
|
+
# service that remain in the `RUNNING` state. This is while the
|
|
743
757
|
# container instances are in the `DRAINING` state. If the tasks in the
|
|
744
758
|
# service use the Fargate launch type, the minimum healthy percent and
|
|
745
|
-
# maximum percent values aren't used
|
|
746
|
-
# visible when describing your service.
|
|
759
|
+
# maximum percent values aren't used. This is the case even if they're
|
|
760
|
+
# currently visible when describing your service.
|
|
747
761
|
#
|
|
748
762
|
# When creating a service that uses the `EXTERNAL` deployment
|
|
749
763
|
# controller, you can specify only parameters that aren't controlled at
|
|
@@ -756,13 +770,13 @@ module Aws::ECS
|
|
|
756
770
|
# placement in your cluster using the following logic:
|
|
757
771
|
#
|
|
758
772
|
# * Determine which of the container instances in your cluster can
|
|
759
|
-
# support
|
|
760
|
-
# required CPU, memory, ports, and container instance attributes
|
|
773
|
+
# support the task definition of your service. For example, they have
|
|
774
|
+
# the required CPU, memory, ports, and container instance attributes.
|
|
761
775
|
#
|
|
762
776
|
# * By default, the service scheduler attempts to balance tasks across
|
|
763
|
-
# Availability Zones in this manner
|
|
764
|
-
# different placement strategy
|
|
765
|
-
# parameter
|
|
777
|
+
# Availability Zones in this manner. This is the case even if you can
|
|
778
|
+
# choose a different placement strategy with the `placementStrategy`
|
|
779
|
+
# parameter.
|
|
766
780
|
#
|
|
767
781
|
# * Sort the valid container instances, giving priority to instances
|
|
768
782
|
# that have the fewest number of running tasks for this service in
|
|
@@ -772,7 +786,7 @@ module Aws::ECS
|
|
|
772
786
|
# for placement.
|
|
773
787
|
#
|
|
774
788
|
# * Place the new service task on a valid container instance in an
|
|
775
|
-
# optimal Availability Zone
|
|
789
|
+
# optimal Availability Zone based on the previous steps, favoring
|
|
776
790
|
# container instances with the fewest number of running tasks for
|
|
777
791
|
# this service.
|
|
778
792
|
#
|
|
@@ -783,9 +797,9 @@ module Aws::ECS
|
|
|
783
797
|
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html
|
|
784
798
|
#
|
|
785
799
|
# @option params [String] :cluster
|
|
786
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
787
|
-
#
|
|
788
|
-
#
|
|
800
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
801
|
+
# you run your service on. If you do not specify a cluster, the default
|
|
802
|
+
# cluster is assumed.
|
|
789
803
|
#
|
|
790
804
|
# @option params [required, String] :service_name
|
|
791
805
|
# The name of your service. Up to 255 letters (uppercase and lowercase),
|
|
@@ -795,10 +809,10 @@ module Aws::ECS
|
|
|
795
809
|
#
|
|
796
810
|
# @option params [String] :task_definition
|
|
797
811
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
|
798
|
-
# task definition to run in your service. If a `revision`
|
|
812
|
+
# task definition to run in your service. If a `revision` isn't
|
|
799
813
|
# specified, the latest `ACTIVE` revision is used.
|
|
800
814
|
#
|
|
801
|
-
# A task definition must be specified if the service
|
|
815
|
+
# A task definition must be specified if the service uses either the
|
|
802
816
|
# `ECS` or `CODE_DEPLOY` deployment controllers.
|
|
803
817
|
#
|
|
804
818
|
# @option params [Array<Types::LoadBalancer>] :load_balancers
|
|
@@ -806,54 +820,56 @@ module Aws::ECS
|
|
|
806
820
|
# your service. For more information, see [Service Load Balancing][1] in
|
|
807
821
|
# the *Amazon Elastic Container Service Developer Guide*.
|
|
808
822
|
#
|
|
809
|
-
# If the service
|
|
810
|
-
#
|
|
811
|
-
#
|
|
812
|
-
#
|
|
813
|
-
#
|
|
814
|
-
#
|
|
815
|
-
#
|
|
823
|
+
# If the service uses the rolling update (`ECS`) deployment controller
|
|
824
|
+
# and using either an Application Load Balancer or Network Load
|
|
825
|
+
# Balancer, you must specify one or more target group ARNs to attach to
|
|
826
|
+
# the service. The service-linked role is required for services that use
|
|
827
|
+
# multiple target groups. For more information, see [Using
|
|
828
|
+
# service-linked roles for Amazon ECS][2] in the *Amazon Elastic
|
|
829
|
+
# Container Service Developer Guide*.
|
|
816
830
|
#
|
|
817
|
-
# If the service
|
|
831
|
+
# If the service uses the `CODE_DEPLOY` deployment controller, the
|
|
818
832
|
# service is required to use either an Application Load Balancer or
|
|
819
833
|
# Network Load Balancer. When creating an CodeDeploy deployment group,
|
|
820
834
|
# you specify two target groups (referred to as a `targetGroupPair`).
|
|
821
835
|
# During a deployment, CodeDeploy determines which task set in your
|
|
822
|
-
# service has the status `PRIMARY
|
|
823
|
-
# it,
|
|
824
|
-
# task set. The load balancer can also have up to two
|
|
825
|
-
# required listener for production traffic and an optional
|
|
826
|
-
#
|
|
827
|
-
# routing production traffic to it.
|
|
836
|
+
# service has the status `PRIMARY`, and it associates one target group
|
|
837
|
+
# with it. Then, it also associates the other target group with the
|
|
838
|
+
# replacement task set. The load balancer can also have up to two
|
|
839
|
+
# listeners: a required listener for production traffic and an optional
|
|
840
|
+
# listener that you can use to perform validation tests with Lambda
|
|
841
|
+
# functions before routing production traffic to it.
|
|
828
842
|
#
|
|
829
843
|
# After you create a service using the `ECS` deployment controller, the
|
|
830
844
|
# load balancer name or target group ARN, container name, and container
|
|
831
|
-
# port specified in the service definition are immutable. If you
|
|
832
|
-
#
|
|
845
|
+
# port that's specified in the service definition are immutable. If you
|
|
846
|
+
# use the `CODE_DEPLOY` deployment controller, these values can be
|
|
833
847
|
# changed when updating the service.
|
|
834
848
|
#
|
|
835
849
|
# For Application Load Balancers and Network Load Balancers, this object
|
|
836
|
-
# must contain the load balancer target group ARN, the container name
|
|
837
|
-
#
|
|
838
|
-
#
|
|
839
|
-
# be omitted. When a task from this service
|
|
840
|
-
# instance, the container instance and port
|
|
841
|
-
# a target in the target group
|
|
850
|
+
# must contain the load balancer target group ARN, the container name,
|
|
851
|
+
# and the container port to access from the load balancer. The container
|
|
852
|
+
# name must be as it appears in a container definition. The load
|
|
853
|
+
# balancer name parameter must be omitted. When a task from this service
|
|
854
|
+
# is placed on a container instance, the container instance and port
|
|
855
|
+
# combination is registered as a target in the target group that's
|
|
856
|
+
# specified here.
|
|
842
857
|
#
|
|
843
858
|
# For Classic Load Balancers, this object must contain the load balancer
|
|
844
|
-
# name, the container name
|
|
845
|
-
#
|
|
846
|
-
# group ARN parameter must be omitted. When a
|
|
847
|
-
# placed on a container instance, the
|
|
848
|
-
# with the load balancer
|
|
859
|
+
# name, the container name , and the container port to access from the
|
|
860
|
+
# load balancer. The container name must be as it appears in a container
|
|
861
|
+
# definition. The target group ARN parameter must be omitted. When a
|
|
862
|
+
# task from this service is placed on a container instance, the
|
|
863
|
+
# container instance is registered with the load balancer that's
|
|
864
|
+
# specified here.
|
|
849
865
|
#
|
|
850
866
|
# Services with tasks that use the `awsvpc` network mode (for example,
|
|
851
867
|
# those with the Fargate launch type) only support Application Load
|
|
852
|
-
# Balancers and Network Load Balancers. Classic Load Balancers
|
|
868
|
+
# Balancers and Network Load Balancers. Classic Load Balancers aren't
|
|
853
869
|
# supported. Also, when you create any target groups for these services,
|
|
854
|
-
# you must choose `ip` as the target type, not `instance
|
|
855
|
-
# that use the `awsvpc` network mode are associated with
|
|
856
|
-
# network interface, not an Amazon EC2 instance.
|
|
870
|
+
# you must choose `ip` as the target type, not `instance`. This is
|
|
871
|
+
# because tasks that use the `awsvpc` network mode are associated with
|
|
872
|
+
# an elastic network interface, not an Amazon EC2 instance.
|
|
857
873
|
#
|
|
858
874
|
#
|
|
859
875
|
#
|
|
@@ -865,7 +881,7 @@ module Aws::ECS
|
|
|
865
881
|
# service. For more information, see [Service discovery][1].
|
|
866
882
|
#
|
|
867
883
|
# <note markdown="1"> Each service may be associated with one service registry. Multiple
|
|
868
|
-
# service registries
|
|
884
|
+
# service registries for each service isn't supported.
|
|
869
885
|
#
|
|
870
886
|
# </note>
|
|
871
887
|
#
|
|
@@ -877,16 +893,17 @@ module Aws::ECS
|
|
|
877
893
|
# The number of instantiations of the specified task definition to place
|
|
878
894
|
# and keep running on your cluster.
|
|
879
895
|
#
|
|
880
|
-
# This is required if `schedulingStrategy` is `REPLICA` or
|
|
881
|
-
# specified. If `schedulingStrategy` is `DAEMON` then this
|
|
896
|
+
# This is required if `schedulingStrategy` is `REPLICA` or isn't
|
|
897
|
+
# specified. If `schedulingStrategy` is `DAEMON` then this isn't
|
|
882
898
|
# required.
|
|
883
899
|
#
|
|
884
900
|
# @option params [String] :client_token
|
|
885
|
-
#
|
|
886
|
-
#
|
|
901
|
+
# An identifier that you provide to ensure the idempotency of the
|
|
902
|
+
# request. It must be unique and is case sensitive. Up to 32 ASCII
|
|
903
|
+
# characters are allowed.
|
|
887
904
|
#
|
|
888
905
|
# @option params [String] :launch_type
|
|
889
|
-
# The infrastructure
|
|
906
|
+
# The infrastructure that you run your service on. For more information,
|
|
890
907
|
# see [Amazon ECS launch types][1] in the *Amazon Elastic Container
|
|
891
908
|
# Service Developer Guide*.
|
|
892
909
|
#
|
|
@@ -902,7 +919,7 @@ module Aws::ECS
|
|
|
902
919
|
# The `EC2` launch type runs your tasks on Amazon EC2 instances
|
|
903
920
|
# registered to your cluster.
|
|
904
921
|
#
|
|
905
|
-
# The `EXTERNAL` launch type runs your tasks on your on-
|
|
922
|
+
# The `EXTERNAL` launch type runs your tasks on your on-premises server
|
|
906
923
|
# or virtual machine (VM) capacity registered to your cluster.
|
|
907
924
|
#
|
|
908
925
|
# A service can use either a launch type or a capacity provider
|
|
@@ -928,9 +945,9 @@ module Aws::ECS
|
|
|
928
945
|
# @option params [String] :platform_version
|
|
929
946
|
# The platform version that your tasks in the service are running on. A
|
|
930
947
|
# platform version is specified only for tasks using the Fargate launch
|
|
931
|
-
# type. If one isn't specified, the `LATEST` platform version is used
|
|
932
|
-
#
|
|
933
|
-
#
|
|
948
|
+
# type. If one isn't specified, the `LATEST` platform version is used.
|
|
949
|
+
# For more information, see [Fargate platform versions][1] in the
|
|
950
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
|
934
951
|
#
|
|
935
952
|
#
|
|
936
953
|
#
|
|
@@ -940,19 +957,19 @@ module Aws::ECS
|
|
|
940
957
|
# The name or full Amazon Resource Name (ARN) of the IAM role that
|
|
941
958
|
# allows Amazon ECS to make calls to your load balancer on your behalf.
|
|
942
959
|
# This parameter is only permitted if you are using a load balancer with
|
|
943
|
-
# your service and your task definition
|
|
960
|
+
# your service and your task definition doesn't use the `awsvpc`
|
|
944
961
|
# network mode. If you specify the `role` parameter, you must also
|
|
945
962
|
# specify a load balancer object with the `loadBalancers` parameter.
|
|
946
963
|
#
|
|
947
964
|
# If your account has already created the Amazon ECS service-linked
|
|
948
|
-
# role, that role is used
|
|
949
|
-
#
|
|
950
|
-
#
|
|
951
|
-
#
|
|
952
|
-
#
|
|
953
|
-
#
|
|
954
|
-
#
|
|
955
|
-
#
|
|
965
|
+
# role, that role is used for your service unless you specify a role
|
|
966
|
+
# here. The service-linked role is required if your task definition uses
|
|
967
|
+
# the `awsvpc` network mode or if the service is configured to use
|
|
968
|
+
# service discovery, an external deployment controller, multiple target
|
|
969
|
+
# groups, or Elastic Inference accelerators in which case you don't
|
|
970
|
+
# specify a role here. For more information, see [Using service-linked
|
|
971
|
+
# roles for Amazon ECS][1] in the *Amazon Elastic Container Service
|
|
972
|
+
# Developer Guide*.
|
|
956
973
|
#
|
|
957
974
|
# If your specified role has a path other than `/`, then you must either
|
|
958
975
|
# specify the full role ARN (this is recommended) or prefix the role
|
|
@@ -972,18 +989,18 @@ module Aws::ECS
|
|
|
972
989
|
#
|
|
973
990
|
# @option params [Array<Types::PlacementConstraint>] :placement_constraints
|
|
974
991
|
# An array of placement constraint objects to use for tasks in your
|
|
975
|
-
# service. You can specify a maximum of 10 constraints
|
|
976
|
-
# limit includes constraints in the task definition and those
|
|
977
|
-
# at runtime
|
|
992
|
+
# service. You can specify a maximum of 10 constraints for each task.
|
|
993
|
+
# This limit includes constraints in the task definition and those
|
|
994
|
+
# specified at runtime.
|
|
978
995
|
#
|
|
979
996
|
# @option params [Array<Types::PlacementStrategy>] :placement_strategy
|
|
980
997
|
# The placement strategy objects to use for tasks in your service. You
|
|
981
|
-
# can specify a maximum of 5 strategy rules
|
|
998
|
+
# can specify a maximum of 5 strategy rules for each service.
|
|
982
999
|
#
|
|
983
1000
|
# @option params [Types::NetworkConfiguration] :network_configuration
|
|
984
1001
|
# The network configuration for the service. This parameter is required
|
|
985
1002
|
# for task definitions that use the `awsvpc` network mode to receive
|
|
986
|
-
# their own elastic network interface, and it
|
|
1003
|
+
# their own elastic network interface, and it isn't supported for other
|
|
987
1004
|
# network modes. For more information, see [Task networking][1] in the
|
|
988
1005
|
# *Amazon Elastic Container Service Developer Guide*.
|
|
989
1006
|
#
|
|
@@ -993,18 +1010,18 @@ module Aws::ECS
|
|
|
993
1010
|
#
|
|
994
1011
|
# @option params [Integer] :health_check_grace_period_seconds
|
|
995
1012
|
# The period of time, in seconds, that the Amazon ECS service scheduler
|
|
996
|
-
#
|
|
997
|
-
#
|
|
1013
|
+
# ignores unhealthy Elastic Load Balancing target health checks after a
|
|
1014
|
+
# task has first started. This is only used when your service is
|
|
998
1015
|
# configured to use a load balancer. If your service has a load balancer
|
|
999
1016
|
# defined and you don't specify a health check grace period value, the
|
|
1000
1017
|
# default value of `0` is used.
|
|
1001
1018
|
#
|
|
1002
1019
|
# If your service's tasks take a while to start and respond to Elastic
|
|
1003
1020
|
# Load Balancing health checks, you can specify a health check grace
|
|
1004
|
-
# period of up to 2,147,483,647 seconds. During that
|
|
1005
|
-
# ECS service scheduler ignores health check status.
|
|
1006
|
-
# can prevent the service scheduler from marking tasks
|
|
1007
|
-
# stopping them before they have time to come up.
|
|
1021
|
+
# period of up to 2,147,483,647 seconds (about 69 years). During that
|
|
1022
|
+
# time, the Amazon ECS service scheduler ignores health check status.
|
|
1023
|
+
# This grace period can prevent the service scheduler from marking tasks
|
|
1024
|
+
# as unhealthy and stopping them before they have time to come up.
|
|
1008
1025
|
#
|
|
1009
1026
|
# @option params [String] :scheduling_strategy
|
|
1010
1027
|
# The scheduling strategy to use for the service. For more information,
|
|
@@ -1016,14 +1033,14 @@ module Aws::ECS
|
|
|
1016
1033
|
# desired number of tasks across your cluster. By default, the service
|
|
1017
1034
|
# scheduler spreads tasks across Availability Zones. You can use task
|
|
1018
1035
|
# placement strategies and constraints to customize task placement
|
|
1019
|
-
# decisions. This scheduler strategy is required if the service
|
|
1020
|
-
#
|
|
1036
|
+
# decisions. This scheduler strategy is required if the service uses
|
|
1037
|
+
# the `CODE_DEPLOY` or `EXTERNAL` deployment controller types.
|
|
1021
1038
|
#
|
|
1022
1039
|
# * `DAEMON`-The daemon scheduling strategy deploys exactly one task on
|
|
1023
1040
|
# each active container instance that meets all of the task placement
|
|
1024
1041
|
# constraints that you specify in your cluster. The service scheduler
|
|
1025
1042
|
# also evaluates the task placement constraints for running tasks and
|
|
1026
|
-
# will stop tasks that
|
|
1043
|
+
# will stop tasks that don't meet the placement constraints. When
|
|
1027
1044
|
# you're using this strategy, you don't need to specify a desired
|
|
1028
1045
|
# number of tasks, a task placement strategy, or use Service Auto
|
|
1029
1046
|
# Scaling policies.
|
|
@@ -1086,15 +1103,15 @@ module Aws::ECS
|
|
|
1086
1103
|
# @option params [String] :propagate_tags
|
|
1087
1104
|
# Specifies whether to propagate the tags from the task definition or
|
|
1088
1105
|
# the service to the tasks in the service. If no value is specified, the
|
|
1089
|
-
# tags
|
|
1106
|
+
# tags aren't propagated. Tags can only be propagated to the tasks
|
|
1090
1107
|
# within the service during service creation. To add tags to a task
|
|
1091
1108
|
# after service creation or task creation, use the TagResource API
|
|
1092
1109
|
# action.
|
|
1093
1110
|
#
|
|
1094
1111
|
# @option params [Boolean] :enable_execute_command
|
|
1095
|
-
#
|
|
1096
|
-
# service. If `true`, this enables execute command functionality on
|
|
1097
|
-
# containers in the service tasks.
|
|
1112
|
+
# Determines whether the execute command functionality is enabled for
|
|
1113
|
+
# the service. If `true`, this enables execute command functionality on
|
|
1114
|
+
# all containers in the service tasks.
|
|
1098
1115
|
#
|
|
1099
1116
|
# @return [Types::CreateServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1100
1117
|
#
|
|
@@ -1474,7 +1491,7 @@ module Aws::ECS
|
|
|
1474
1491
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html
|
|
1475
1492
|
#
|
|
1476
1493
|
# @option params [String] :launch_type
|
|
1477
|
-
# The launch type that new tasks in the task set
|
|
1494
|
+
# The launch type that new tasks in the task set uses. For more
|
|
1478
1495
|
# information, see [Amazon ECS Launch Types][1] in the *Amazon Elastic
|
|
1479
1496
|
# Container Service Developer Guide*.
|
|
1480
1497
|
#
|
|
@@ -1514,24 +1531,23 @@ module Aws::ECS
|
|
|
1514
1531
|
# is created.
|
|
1515
1532
|
#
|
|
1516
1533
|
# @option params [String] :platform_version
|
|
1517
|
-
# The platform version that the tasks in the task set
|
|
1518
|
-
#
|
|
1519
|
-
#
|
|
1520
|
-
# by default.
|
|
1534
|
+
# The platform version that the tasks in the task set uses. A platform
|
|
1535
|
+
# version is specified only for tasks using the Fargate launch type. If
|
|
1536
|
+
# one isn't specified, the `LATEST` platform version is used.
|
|
1521
1537
|
#
|
|
1522
1538
|
# @option params [Types::Scale] :scale
|
|
1523
1539
|
# A floating-point percentage of the desired number of tasks to place
|
|
1524
1540
|
# and keep running in the task set.
|
|
1525
1541
|
#
|
|
1526
1542
|
# @option params [String] :client_token
|
|
1527
|
-
#
|
|
1528
|
-
#
|
|
1543
|
+
# The identifier that you provide to ensure the idempotency of the
|
|
1544
|
+
# request. It's case sensitive and must be unique. It can be up to 32
|
|
1545
|
+
# ASCII characters are allowed.
|
|
1529
1546
|
#
|
|
1530
1547
|
# @option params [Array<Types::Tag>] :tags
|
|
1531
1548
|
# The metadata that you apply to the task set to help you categorize and
|
|
1532
|
-
# organize them. Each tag consists of a key and an optional value
|
|
1533
|
-
#
|
|
1534
|
-
# as well.
|
|
1549
|
+
# organize them. Each tag consists of a key and an optional value. You
|
|
1550
|
+
# define both. When a service is deleted, the tags are deleted.
|
|
1535
1551
|
#
|
|
1536
1552
|
# The following basic restrictions apply to tags:
|
|
1537
1553
|
#
|
|
@@ -1672,7 +1688,7 @@ module Aws::ECS
|
|
|
1672
1688
|
# root user for an account.
|
|
1673
1689
|
#
|
|
1674
1690
|
# @option params [required, String] :name
|
|
1675
|
-
# The resource name
|
|
1691
|
+
# The resource name to disable the account setting for. If
|
|
1676
1692
|
# `serviceLongArnFormat` is specified, the ARN for your Amazon ECS
|
|
1677
1693
|
# services is affected. If `taskLongArnFormat` is specified, the ARN and
|
|
1678
1694
|
# resource ID for your Amazon ECS tasks is affected. If
|
|
@@ -1682,12 +1698,12 @@ module Aws::ECS
|
|
|
1682
1698
|
# container instances is affected.
|
|
1683
1699
|
#
|
|
1684
1700
|
# @option params [String] :principal_arn
|
|
1685
|
-
# The ARN of the principal
|
|
1686
|
-
# root user. If you specify the root user, it
|
|
1687
|
-
# setting for all IAM users, IAM roles, and the
|
|
1688
|
-
# unless an IAM user or role explicitly
|
|
1689
|
-
# this field is omitted, the setting is
|
|
1690
|
-
# authenticated user.
|
|
1701
|
+
# The Amazon Resource Name (ARN) of the principal. It can be an IAM
|
|
1702
|
+
# user, IAM role, or the root user. If you specify the root user, it
|
|
1703
|
+
# disables the account setting for all IAM users, IAM roles, and the
|
|
1704
|
+
# root user of the account unless an IAM user or role explicitly
|
|
1705
|
+
# overrides these settings. If this field is omitted, the setting is
|
|
1706
|
+
# changed only for the authenticated user.
|
|
1691
1707
|
#
|
|
1692
1708
|
# @return [Types::DeleteAccountSettingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1693
1709
|
#
|
|
@@ -1761,9 +1777,10 @@ module Aws::ECS
|
|
|
1761
1777
|
#
|
|
1762
1778
|
# @option params [required, Array<Types::Attribute>] :attributes
|
|
1763
1779
|
# The attributes to delete from your resource. You can specify up to 10
|
|
1764
|
-
# attributes
|
|
1765
|
-
# name and target ID, but
|
|
1766
|
-
# target ID using the short form, you must also specify the
|
|
1780
|
+
# attributes for each request. For custom attributes, specify the
|
|
1781
|
+
# attribute name and target ID, but don't specify the value. If you
|
|
1782
|
+
# specify the target ID using the short form, you must also specify the
|
|
1783
|
+
# target type.
|
|
1767
1784
|
#
|
|
1768
1785
|
# @return [Types::DeleteAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1769
1786
|
#
|
|
@@ -1803,7 +1820,7 @@ module Aws::ECS
|
|
|
1803
1820
|
# Deletes the specified capacity provider.
|
|
1804
1821
|
#
|
|
1805
1822
|
# <note markdown="1"> The `FARGATE` and `FARGATE_SPOT` capacity providers are reserved and
|
|
1806
|
-
#
|
|
1823
|
+
# can't be deleted. You can disassociate them from a cluster using
|
|
1807
1824
|
# either the PutClusterCapacityProviders API or by deleting the cluster.
|
|
1808
1825
|
#
|
|
1809
1826
|
# </note>
|
|
@@ -1815,7 +1832,7 @@ module Aws::ECS
|
|
|
1815
1832
|
# `forceNewDeployment` option can be used to ensure that any tasks using
|
|
1816
1833
|
# the Amazon EC2 instance capacity provided by the capacity provider are
|
|
1817
1834
|
# transitioned to use the capacity from the remaining capacity
|
|
1818
|
-
# providers. Only capacity providers that
|
|
1835
|
+
# providers. Only capacity providers that aren't associated with a
|
|
1819
1836
|
# cluster can be deleted. To remove a capacity provider from a cluster,
|
|
1820
1837
|
# you can either use PutClusterCapacityProviders or delete the cluster.
|
|
1821
1838
|
#
|
|
@@ -1860,11 +1877,11 @@ module Aws::ECS
|
|
|
1860
1877
|
req.send_request(options)
|
|
1861
1878
|
end
|
|
1862
1879
|
|
|
1863
|
-
# Deletes the specified cluster. The cluster
|
|
1864
|
-
# `INACTIVE` state. Clusters with an `INACTIVE` status
|
|
1880
|
+
# Deletes the specified cluster. The cluster transitions to the
|
|
1881
|
+
# `INACTIVE` state. Clusters with an `INACTIVE` status might remain
|
|
1865
1882
|
# discoverable in your account for a period of time. However, this
|
|
1866
|
-
# behavior is subject to change in the future
|
|
1867
|
-
# `INACTIVE` clusters persisting.
|
|
1883
|
+
# behavior is subject to change in the future. We don't recommend that
|
|
1884
|
+
# you rely on `INACTIVE` clusters persisting.
|
|
1868
1885
|
#
|
|
1869
1886
|
# You must deregister all container instances from this cluster before
|
|
1870
1887
|
# you may delete it. You can list the container instances in a cluster
|
|
@@ -1958,7 +1975,7 @@ module Aws::ECS
|
|
|
1958
1975
|
|
|
1959
1976
|
# Deletes a specified service within a cluster. You can delete a service
|
|
1960
1977
|
# if you have no running tasks in it and the desired task count is zero.
|
|
1961
|
-
# If the service is actively maintaining tasks, you
|
|
1978
|
+
# If the service is actively maintaining tasks, you can't delete it,
|
|
1962
1979
|
# and you must update the service to a desired task count of zero. For
|
|
1963
1980
|
# more information, see UpdateService.
|
|
1964
1981
|
#
|
|
@@ -1988,9 +2005,9 @@ module Aws::ECS
|
|
|
1988
2005
|
# The name of the service to delete.
|
|
1989
2006
|
#
|
|
1990
2007
|
# @option params [Boolean] :force
|
|
1991
|
-
# If `true`, allows you to delete a service even if it
|
|
1992
|
-
#
|
|
1993
|
-
#
|
|
2008
|
+
# If `true`, allows you to delete a service even if it wasn't scaled
|
|
2009
|
+
# down to zero tasks. It's only necessary to use this if the service
|
|
2010
|
+
# uses the `REPLICA` scheduling strategy.
|
|
1994
2011
|
#
|
|
1995
2012
|
# @return [Types::DeleteServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1996
2013
|
#
|
|
@@ -2164,7 +2181,7 @@ module Aws::ECS
|
|
|
2164
2181
|
#
|
|
2165
2182
|
# @option params [required, String] :cluster
|
|
2166
2183
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
2167
|
-
# hosts the service that the task set
|
|
2184
|
+
# hosts the service that the task set found in to delete.
|
|
2168
2185
|
#
|
|
2169
2186
|
# @option params [required, String] :service
|
|
2170
2187
|
# The short name or full Amazon Resource Name (ARN) of the service that
|
|
@@ -2175,8 +2192,8 @@ module Aws::ECS
|
|
|
2175
2192
|
# delete.
|
|
2176
2193
|
#
|
|
2177
2194
|
# @option params [Boolean] :force
|
|
2178
|
-
# If `true`,
|
|
2179
|
-
#
|
|
2195
|
+
# If `true`, you can delete a task set even if it hasn't been scaled
|
|
2196
|
+
# down to zero.
|
|
2180
2197
|
#
|
|
2181
2198
|
# @return [Types::DeleteTaskSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2182
2199
|
#
|
|
@@ -2249,18 +2266,18 @@ module Aws::ECS
|
|
|
2249
2266
|
# cluster. This instance is no longer available to run tasks.
|
|
2250
2267
|
#
|
|
2251
2268
|
# If you intend to use the container instance for some other purpose
|
|
2252
|
-
# after deregistration, you
|
|
2253
|
-
# container instance before deregistration. That prevents
|
|
2254
|
-
# tasks from consuming resources.
|
|
2269
|
+
# after deregistration, we recommend that you stop all of the tasks
|
|
2270
|
+
# running on the container instance before deregistration. That prevents
|
|
2271
|
+
# any orphaned tasks from consuming resources.
|
|
2255
2272
|
#
|
|
2256
2273
|
# Deregistering a container instance removes the instance from a
|
|
2257
|
-
# cluster, but it
|
|
2274
|
+
# cluster, but it doesn't terminate the EC2 instance. If you are
|
|
2258
2275
|
# finished using the instance, be sure to terminate it in the Amazon EC2
|
|
2259
2276
|
# console to stop billing.
|
|
2260
2277
|
#
|
|
2261
2278
|
# <note markdown="1"> If you terminate a running container instance, Amazon ECS
|
|
2262
2279
|
# automatically deregisters the instance from your cluster (stopped
|
|
2263
|
-
# container instances or instances with disconnected agents
|
|
2280
|
+
# container instances or instances with disconnected agents aren't
|
|
2264
2281
|
# automatically deregistered when terminated).
|
|
2265
2282
|
#
|
|
2266
2283
|
# </note>
|
|
@@ -2279,10 +2296,10 @@ module Aws::ECS
|
|
|
2279
2296
|
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
|
2280
2297
|
#
|
|
2281
2298
|
# @option params [Boolean] :force
|
|
2282
|
-
# Forces the
|
|
2299
|
+
# Forces the container instance to be deregistered. If you have tasks
|
|
2283
2300
|
# running on the container instance when you deregister it with the
|
|
2284
2301
|
# `force` option, these tasks remain running until you terminate the
|
|
2285
|
-
# instance or the tasks stop through some other means, but they
|
|
2302
|
+
# instance or the tasks stop through some other means, but they're
|
|
2286
2303
|
# orphaned (no longer monitored or accounted for by Amazon ECS). If an
|
|
2287
2304
|
# orphaned task on your container instance is part of an Amazon ECS
|
|
2288
2305
|
# service, then the service scheduler starts another copy of that task,
|
|
@@ -2368,6 +2385,12 @@ module Aws::ECS
|
|
|
2368
2385
|
# resp.container_instance.tags #=> Array
|
|
2369
2386
|
# resp.container_instance.tags[0].key #=> String
|
|
2370
2387
|
# resp.container_instance.tags[0].value #=> String
|
|
2388
|
+
# resp.container_instance.health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
2389
|
+
# resp.container_instance.health_status.details #=> Array
|
|
2390
|
+
# resp.container_instance.health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
|
|
2391
|
+
# resp.container_instance.health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
2392
|
+
# resp.container_instance.health_status.details[0].last_updated #=> Time
|
|
2393
|
+
# resp.container_instance.health_status.details[0].last_status_change #=> Time
|
|
2371
2394
|
#
|
|
2372
2395
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterContainerInstance AWS API Documentation
|
|
2373
2396
|
#
|
|
@@ -2385,16 +2408,17 @@ module Aws::ECS
|
|
|
2385
2408
|
# an `INACTIVE` task definition can still scale up or down by modifying
|
|
2386
2409
|
# the service's desired count.
|
|
2387
2410
|
#
|
|
2388
|
-
# You
|
|
2389
|
-
# create new services, and you
|
|
2411
|
+
# You can't use an `INACTIVE` task definition to run new tasks or
|
|
2412
|
+
# create new services, and you can't update an existing service to
|
|
2390
2413
|
# reference an `INACTIVE` task definition. However, there may be up to a
|
|
2391
2414
|
# 10-minute window following deregistration where these restrictions
|
|
2392
2415
|
# have not yet taken effect.
|
|
2393
2416
|
#
|
|
2394
2417
|
# <note markdown="1"> At this time, `INACTIVE` task definitions remain discoverable in your
|
|
2395
2418
|
# account indefinitely. However, this behavior is subject to change in
|
|
2396
|
-
# the future
|
|
2397
|
-
# persisting beyond the lifecycle of any associated tasks
|
|
2419
|
+
# the future. We don't recommend that you rely on `INACTIVE` task
|
|
2420
|
+
# definitions persisting beyond the lifecycle of any associated tasks
|
|
2421
|
+
# and services.
|
|
2398
2422
|
#
|
|
2399
2423
|
# </note>
|
|
2400
2424
|
#
|
|
@@ -2593,7 +2617,7 @@ module Aws::ECS
|
|
|
2593
2617
|
# @option params [Array<String>] :include
|
|
2594
2618
|
# Specifies whether or not you want to see the resource tags for the
|
|
2595
2619
|
# capacity provider. If `TAGS` is specified, the tags are included in
|
|
2596
|
-
# the response. If this field is omitted, tags
|
|
2620
|
+
# the response. If this field is omitted, tags aren't included in the
|
|
2597
2621
|
# response.
|
|
2598
2622
|
#
|
|
2599
2623
|
# @option params [Integer] :max_results
|
|
@@ -2676,8 +2700,9 @@ module Aws::ECS
|
|
|
2676
2700
|
# assumed.
|
|
2677
2701
|
#
|
|
2678
2702
|
# @option params [Array<String>] :include
|
|
2679
|
-
#
|
|
2680
|
-
# response. If this field is omitted, this information
|
|
2703
|
+
# Determines whether to include additional information about the
|
|
2704
|
+
# clusters in the response. If this field is omitted, this information
|
|
2705
|
+
# isn't included.
|
|
2681
2706
|
#
|
|
2682
2707
|
# If `ATTACHMENTS` is specified, the attachments for the container
|
|
2683
2708
|
# instances or tasks within the cluster are included.
|
|
@@ -2800,7 +2825,9 @@ module Aws::ECS
|
|
|
2800
2825
|
# @option params [Array<String>] :include
|
|
2801
2826
|
# Specifies whether you want to see the resource tags for the container
|
|
2802
2827
|
# instance. If `TAGS` is specified, the tags are included in the
|
|
2803
|
-
# response. If
|
|
2828
|
+
# response. If `CONTAINER_INSTANCE_HEALTH` is specified, the container
|
|
2829
|
+
# instance health is included in the response. If this field is omitted,
|
|
2830
|
+
# tags and container instance health status aren't included in the
|
|
2804
2831
|
# response.
|
|
2805
2832
|
#
|
|
2806
2833
|
# @return [Types::DescribeContainerInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -2901,7 +2928,7 @@ module Aws::ECS
|
|
|
2901
2928
|
# resp = client.describe_container_instances({
|
|
2902
2929
|
# cluster: "String",
|
|
2903
2930
|
# container_instances: ["String"], # required
|
|
2904
|
-
# include: ["TAGS"], # accepts TAGS
|
|
2931
|
+
# include: ["TAGS"], # accepts TAGS, CONTAINER_INSTANCE_HEALTH
|
|
2905
2932
|
# })
|
|
2906
2933
|
#
|
|
2907
2934
|
# @example Response structure
|
|
@@ -2952,6 +2979,12 @@ module Aws::ECS
|
|
|
2952
2979
|
# resp.container_instances[0].tags #=> Array
|
|
2953
2980
|
# resp.container_instances[0].tags[0].key #=> String
|
|
2954
2981
|
# resp.container_instances[0].tags[0].value #=> String
|
|
2982
|
+
# resp.container_instances[0].health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
2983
|
+
# resp.container_instances[0].health_status.details #=> Array
|
|
2984
|
+
# resp.container_instances[0].health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
|
|
2985
|
+
# resp.container_instances[0].health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
2986
|
+
# resp.container_instances[0].health_status.details[0].last_updated #=> Time
|
|
2987
|
+
# resp.container_instances[0].health_status.details[0].last_status_change #=> Time
|
|
2955
2988
|
# resp.failures #=> Array
|
|
2956
2989
|
# resp.failures[0].arn #=> String
|
|
2957
2990
|
# resp.failures[0].reason #=> String
|
|
@@ -2980,9 +3013,9 @@ module Aws::ECS
|
|
|
2980
3013
|
# describe in a single operation.
|
|
2981
3014
|
#
|
|
2982
3015
|
# @option params [Array<String>] :include
|
|
2983
|
-
#
|
|
3016
|
+
# Determines whether you want to see the resource tags for the service.
|
|
2984
3017
|
# If `TAGS` is specified, the tags are included in the response. If this
|
|
2985
|
-
# field is omitted, tags
|
|
3018
|
+
# field is omitted, tags aren't included in the response.
|
|
2986
3019
|
#
|
|
2987
3020
|
# @return [Types::DescribeServicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2988
3021
|
#
|
|
@@ -3214,9 +3247,9 @@ module Aws::ECS
|
|
|
3214
3247
|
# Amazon Resource Name (ARN) of the task definition to describe.
|
|
3215
3248
|
#
|
|
3216
3249
|
# @option params [Array<String>] :include
|
|
3217
|
-
#
|
|
3218
|
-
# `TAGS` is specified, the tags are included in the response. If this
|
|
3219
|
-
# field is omitted, tags
|
|
3250
|
+
# Determines whether to see the resource tags for the task definition.
|
|
3251
|
+
# If `TAGS` is specified, the tags are included in the response. If this
|
|
3252
|
+
# field is omitted, tags aren't included in the response.
|
|
3220
3253
|
#
|
|
3221
3254
|
# @return [Types::DescribeTaskDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3222
3255
|
#
|
|
@@ -3489,7 +3522,7 @@ module Aws::ECS
|
|
|
3489
3522
|
# @option params [Array<String>] :include
|
|
3490
3523
|
# Specifies whether to see the resource tags for the task set. If `TAGS`
|
|
3491
3524
|
# is specified, the tags are included in the response. If this field is
|
|
3492
|
-
# omitted, tags
|
|
3525
|
+
# omitted, tags aren't included in the response.
|
|
3493
3526
|
#
|
|
3494
3527
|
# @return [Types::DescribeTaskSetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3495
3528
|
#
|
|
@@ -3579,7 +3612,7 @@ module Aws::ECS
|
|
|
3579
3612
|
# @option params [Array<String>] :include
|
|
3580
3613
|
# Specifies whether you want to see the resource tags for the task. If
|
|
3581
3614
|
# `TAGS` is specified, the tags are included in the response. If this
|
|
3582
|
-
# field is omitted, tags
|
|
3615
|
+
# field is omitted, tags aren't included in the response.
|
|
3583
3616
|
#
|
|
3584
3617
|
# @return [Types::DescribeTasksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3585
3618
|
#
|
|
@@ -3785,8 +3818,8 @@ module Aws::ECS
|
|
|
3785
3818
|
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
|
3786
3819
|
#
|
|
3787
3820
|
# @option params [String] :cluster
|
|
3788
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
3789
|
-
#
|
|
3821
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
3822
|
+
# the container instance belongs to.
|
|
3790
3823
|
#
|
|
3791
3824
|
# @return [Types::DiscoverPollEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3792
3825
|
#
|
|
@@ -3880,8 +3913,8 @@ module Aws::ECS
|
|
|
3880
3913
|
# The name of the account setting you want to list the settings for.
|
|
3881
3914
|
#
|
|
3882
3915
|
# @option params [String] :value
|
|
3883
|
-
# The value of the account settings
|
|
3884
|
-
#
|
|
3916
|
+
# The value of the account settings to filter results with. You must
|
|
3917
|
+
# also specify an account setting name to use this parameter.
|
|
3885
3918
|
#
|
|
3886
3919
|
# @option params [String] :principal_arn
|
|
3887
3920
|
# The ARN of the principal, which can be an IAM user, IAM role, or the
|
|
@@ -3894,16 +3927,16 @@ module Aws::ECS
|
|
|
3894
3927
|
# </note>
|
|
3895
3928
|
#
|
|
3896
3929
|
# @option params [Boolean] :effective_settings
|
|
3897
|
-
#
|
|
3930
|
+
# Determines whether to return the effective settings. If `true`, the
|
|
3898
3931
|
# account settings for the root user or the default setting for the
|
|
3899
3932
|
# `principalArn` are returned. If `false`, the account settings for the
|
|
3900
|
-
# `principalArn` are returned if they
|
|
3933
|
+
# `principalArn` are returned if they're set. Otherwise, no account
|
|
3901
3934
|
# settings are returned.
|
|
3902
3935
|
#
|
|
3903
3936
|
# @option params [String] :next_token
|
|
3904
3937
|
# The `nextToken` value returned from a `ListAccountSettings` request
|
|
3905
3938
|
# indicating that more results are available to fulfill the request and
|
|
3906
|
-
# further calls will be needed. If `maxResults` was provided, it
|
|
3939
|
+
# further calls will be needed. If `maxResults` was provided, it's
|
|
3907
3940
|
# possible the number of results to be fewer than `maxResults`.
|
|
3908
3941
|
#
|
|
3909
3942
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
|
@@ -3919,7 +3952,7 @@ module Aws::ECS
|
|
|
3919
3952
|
# single page along with a `nextToken` response element. The remaining
|
|
3920
3953
|
# results of the initial request can be seen by sending another
|
|
3921
3954
|
# `ListAccountSettings` request with the returned `nextToken` value.
|
|
3922
|
-
# This value can be between 1 and 10. If this parameter
|
|
3955
|
+
# This value can be between 1 and 10. If this parameter isn't used,
|
|
3923
3956
|
# then `ListAccountSettings` returns up to 10 results and a `nextToken`
|
|
3924
3957
|
# value if applicable.
|
|
3925
3958
|
#
|
|
@@ -4023,9 +4056,9 @@ module Aws::ECS
|
|
|
4023
4056
|
# `ListAttributes` returns a list of attribute objects, one for each
|
|
4024
4057
|
# attribute on each resource. You can filter the list of results to a
|
|
4025
4058
|
# single attribute name to only return results that have that name. You
|
|
4026
|
-
# can also filter the results by attribute name and value
|
|
4027
|
-
# to see which container instances in a cluster are
|
|
4028
|
-
# (`ecs.os-type=linux`).
|
|
4059
|
+
# can also filter the results by attribute name and value. You can do
|
|
4060
|
+
# this, for example, to see which container instances in a cluster are
|
|
4061
|
+
# running a Linux AMI (`ecs.os-type=linux`).
|
|
4029
4062
|
#
|
|
4030
4063
|
# @option params [String] :cluster
|
|
4031
4064
|
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
@@ -4033,20 +4066,20 @@ module Aws::ECS
|
|
|
4033
4066
|
# is assumed.
|
|
4034
4067
|
#
|
|
4035
4068
|
# @option params [required, String] :target_type
|
|
4036
|
-
# The type of the target
|
|
4069
|
+
# The type of the target to list attributes with.
|
|
4037
4070
|
#
|
|
4038
4071
|
# @option params [String] :attribute_name
|
|
4039
|
-
# The name of the attribute
|
|
4072
|
+
# The name of the attribute to filter the results with.
|
|
4040
4073
|
#
|
|
4041
4074
|
# @option params [String] :attribute_value
|
|
4042
|
-
# The value of the attribute
|
|
4075
|
+
# The value of the attribute to filter results with. You must also
|
|
4043
4076
|
# specify an attribute name to use this parameter.
|
|
4044
4077
|
#
|
|
4045
4078
|
# @option params [String] :next_token
|
|
4046
4079
|
# The `nextToken` value returned from a `ListAttributes` request
|
|
4047
4080
|
# indicating that more results are available to fulfill the request and
|
|
4048
|
-
# further calls
|
|
4049
|
-
#
|
|
4081
|
+
# further calls are needed. If `maxResults` was provided, it's possible
|
|
4082
|
+
# the number of results to be fewer than `maxResults`.
|
|
4050
4083
|
#
|
|
4051
4084
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
|
4052
4085
|
# to retrieve the next items in a list and not for other programmatic
|
|
@@ -4055,14 +4088,14 @@ module Aws::ECS
|
|
|
4055
4088
|
# </note>
|
|
4056
4089
|
#
|
|
4057
4090
|
# @option params [Integer] :max_results
|
|
4058
|
-
# The maximum number of cluster results
|
|
4059
|
-
# paginated output. When this parameter is used, `ListAttributes`
|
|
4060
|
-
# returns `maxResults` results in a single page along with a
|
|
4061
|
-
# response element. The remaining results of the initial
|
|
4062
|
-
# seen by sending another `ListAttributes` request with
|
|
4063
|
-
# `nextToken` value. This value can be between 1 and 100.
|
|
4064
|
-
# parameter
|
|
4065
|
-
# and a `nextToken` value if applicable.
|
|
4091
|
+
# The maximum number of cluster results that `ListAttributes` returned
|
|
4092
|
+
# in paginated output. When this parameter is used, `ListAttributes`
|
|
4093
|
+
# only returns `maxResults` results in a single page along with a
|
|
4094
|
+
# `nextToken` response element. The remaining results of the initial
|
|
4095
|
+
# request can be seen by sending another `ListAttributes` request with
|
|
4096
|
+
# the returned `nextToken` value. This value can be between 1 and 100.
|
|
4097
|
+
# If this parameter isn't used, then `ListAttributes` returns up to 100
|
|
4098
|
+
# results and a `nextToken` value if applicable.
|
|
4066
4099
|
#
|
|
4067
4100
|
# @return [Types::ListAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4068
4101
|
#
|
|
@@ -4105,8 +4138,8 @@ module Aws::ECS
|
|
|
4105
4138
|
# @option params [String] :next_token
|
|
4106
4139
|
# The `nextToken` value returned from a `ListClusters` request
|
|
4107
4140
|
# indicating that more results are available to fulfill the request and
|
|
4108
|
-
# further calls
|
|
4109
|
-
#
|
|
4141
|
+
# further calls are needed. If `maxResults` was provided, it's possible
|
|
4142
|
+
# the number of results to be fewer than `maxResults`.
|
|
4110
4143
|
#
|
|
4111
4144
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
|
4112
4145
|
# to retrieve the next items in a list and not for other programmatic
|
|
@@ -4115,13 +4148,13 @@ module Aws::ECS
|
|
|
4115
4148
|
# </note>
|
|
4116
4149
|
#
|
|
4117
4150
|
# @option params [Integer] :max_results
|
|
4118
|
-
# The maximum number of cluster results
|
|
4151
|
+
# The maximum number of cluster results that `ListClusters` returned in
|
|
4119
4152
|
# paginated output. When this parameter is used, `ListClusters` only
|
|
4120
4153
|
# returns `maxResults` results in a single page along with a `nextToken`
|
|
4121
4154
|
# response element. The remaining results of the initial request can be
|
|
4122
4155
|
# seen by sending another `ListClusters` request with the returned
|
|
4123
4156
|
# `nextToken` value. This value can be between 1 and 100. If this
|
|
4124
|
-
# parameter
|
|
4157
|
+
# parameter isn't used, then `ListClusters` returns up to 100 results
|
|
4125
4158
|
# and a `nextToken` value if applicable.
|
|
4126
4159
|
#
|
|
4127
4160
|
# @return [Types::ListClustersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -4197,8 +4230,8 @@ module Aws::ECS
|
|
|
4197
4230
|
# @option params [String] :next_token
|
|
4198
4231
|
# The `nextToken` value returned from a `ListContainerInstances` request
|
|
4199
4232
|
# indicating that more results are available to fulfill the request and
|
|
4200
|
-
# further calls
|
|
4201
|
-
#
|
|
4233
|
+
# further calls are needed. If `maxResults` was provided, it's possible
|
|
4234
|
+
# the number of results to be fewer than `maxResults`.
|
|
4202
4235
|
#
|
|
4203
4236
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
|
4204
4237
|
# to retrieve the next items in a list and not for other programmatic
|
|
@@ -4207,21 +4240,21 @@ module Aws::ECS
|
|
|
4207
4240
|
# </note>
|
|
4208
4241
|
#
|
|
4209
4242
|
# @option params [Integer] :max_results
|
|
4210
|
-
# The maximum number of container instance results
|
|
4211
|
-
# `ListContainerInstances` in paginated output. When this
|
|
4212
|
-
# used, `ListContainerInstances` only returns `maxResults`
|
|
4213
|
-
# single page along with a `nextToken` response element.
|
|
4214
|
-
# results of the initial request can be seen by sending
|
|
4215
|
-
# `ListContainerInstances` request with the returned `nextToken`
|
|
4216
|
-
# This value can be between 1 and 100. If this parameter
|
|
4217
|
-
# then `ListContainerInstances` returns up to 100 results and a
|
|
4243
|
+
# The maximum number of container instance results that
|
|
4244
|
+
# `ListContainerInstances` returned in paginated output. When this
|
|
4245
|
+
# parameter is used, `ListContainerInstances` only returns `maxResults`
|
|
4246
|
+
# results in a single page along with a `nextToken` response element.
|
|
4247
|
+
# The remaining results of the initial request can be seen by sending
|
|
4248
|
+
# another `ListContainerInstances` request with the returned `nextToken`
|
|
4249
|
+
# value. This value can be between 1 and 100. If this parameter isn't
|
|
4250
|
+
# used, then `ListContainerInstances` returns up to 100 results and a
|
|
4218
4251
|
# `nextToken` value if applicable.
|
|
4219
4252
|
#
|
|
4220
4253
|
# @option params [String] :status
|
|
4221
4254
|
# Filters the container instances by status. For example, if you specify
|
|
4222
4255
|
# the `DRAINING` status, the results include only container instances
|
|
4223
4256
|
# that have been set to `DRAINING` using UpdateContainerInstancesState.
|
|
4224
|
-
# If you
|
|
4257
|
+
# If you don't specify this parameter, the default is to include
|
|
4225
4258
|
# container instances set to all states other than `INACTIVE`.
|
|
4226
4259
|
#
|
|
4227
4260
|
# @return [Types::ListContainerInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -4294,13 +4327,13 @@ module Aws::ECS
|
|
|
4294
4327
|
# </note>
|
|
4295
4328
|
#
|
|
4296
4329
|
# @option params [Integer] :max_results
|
|
4297
|
-
# The maximum number of service results
|
|
4330
|
+
# The maximum number of service results that `ListServices` returned in
|
|
4298
4331
|
# paginated output. When this parameter is used, `ListServices` only
|
|
4299
4332
|
# returns `maxResults` results in a single page along with a `nextToken`
|
|
4300
4333
|
# response element. The remaining results of the initial request can be
|
|
4301
4334
|
# seen by sending another `ListServices` request with the returned
|
|
4302
4335
|
# `nextToken` value. This value can be between 1 and 100. If this
|
|
4303
|
-
# parameter
|
|
4336
|
+
# parameter isn't used, then `ListServices` returns up to 10 results
|
|
4304
4337
|
# and a `nextToken` value if applicable.
|
|
4305
4338
|
#
|
|
4306
4339
|
# @option params [String] :launch_type
|
|
@@ -4360,9 +4393,9 @@ module Aws::ECS
|
|
|
4360
4393
|
# List the tags for an Amazon ECS resource.
|
|
4361
4394
|
#
|
|
4362
4395
|
# @option params [required, String] :resource_arn
|
|
4363
|
-
# The Amazon Resource Name (ARN) that identifies the resource
|
|
4364
|
-
#
|
|
4365
|
-
#
|
|
4396
|
+
# The Amazon Resource Name (ARN) that identifies the resource to list
|
|
4397
|
+
# the tags for. Currently, the supported resources are Amazon ECS tasks,
|
|
4398
|
+
# services, task definitions, clusters, and container instances.
|
|
4366
4399
|
#
|
|
4367
4400
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4368
4401
|
#
|
|
@@ -4409,27 +4442,27 @@ module Aws::ECS
|
|
|
4409
4442
|
end
|
|
4410
4443
|
|
|
4411
4444
|
# Returns a list of task definition families that are registered to your
|
|
4412
|
-
# account
|
|
4413
|
-
# have any `ACTIVE` task definition revisions
|
|
4445
|
+
# account. This list includes task definition families that no longer
|
|
4446
|
+
# have any `ACTIVE` task definition revisions.
|
|
4414
4447
|
#
|
|
4415
|
-
# You can filter out task definition families that
|
|
4448
|
+
# You can filter out task definition families that don't contain any
|
|
4416
4449
|
# `ACTIVE` task definition revisions by setting the `status` parameter
|
|
4417
4450
|
# to `ACTIVE`. You can also filter the results with the `familyPrefix`
|
|
4418
4451
|
# parameter.
|
|
4419
4452
|
#
|
|
4420
4453
|
# @option params [String] :family_prefix
|
|
4421
|
-
# The `familyPrefix` is a string that
|
|
4454
|
+
# The `familyPrefix` is a string that's used to filter the results of
|
|
4422
4455
|
# `ListTaskDefinitionFamilies`. If you specify a `familyPrefix`, only
|
|
4423
4456
|
# task definition family names that begin with the `familyPrefix` string
|
|
4424
4457
|
# are returned.
|
|
4425
4458
|
#
|
|
4426
4459
|
# @option params [String] :status
|
|
4427
|
-
# The task definition family status
|
|
4428
|
-
# `ListTaskDefinitionFamilies` results. By default, both `ACTIVE`
|
|
4429
|
-
# `INACTIVE` task definition families are listed. If this parameter
|
|
4430
|
-
# set to `ACTIVE`, only task definition families that have an
|
|
4431
|
-
# task definition revision are returned. If this parameter is
|
|
4432
|
-
# `INACTIVE`, only task definition families that do not have any
|
|
4460
|
+
# The task definition family status to filter the
|
|
4461
|
+
# `ListTaskDefinitionFamilies` results with. By default, both `ACTIVE`
|
|
4462
|
+
# and `INACTIVE` task definition families are listed. If this parameter
|
|
4463
|
+
# is set to `ACTIVE`, only task definition families that have an
|
|
4464
|
+
# `ACTIVE` task definition revision are returned. If this parameter is
|
|
4465
|
+
# set to `INACTIVE`, only task definition families that do not have any
|
|
4433
4466
|
# `ACTIVE` task definition revisions are returned. If you paginate the
|
|
4434
4467
|
# resulting output, be sure to keep the `status` value constant in each
|
|
4435
4468
|
# subsequent request.
|
|
@@ -4448,15 +4481,15 @@ module Aws::ECS
|
|
|
4448
4481
|
# </note>
|
|
4449
4482
|
#
|
|
4450
4483
|
# @option params [Integer] :max_results
|
|
4451
|
-
# The maximum number of task definition family results
|
|
4452
|
-
# `ListTaskDefinitionFamilies` in paginated output. When this
|
|
4453
|
-
# is used, `ListTaskDefinitions` only returns `maxResults`
|
|
4454
|
-
# single page along with a `nextToken` response element.
|
|
4455
|
-
# results of the initial request can be seen by sending
|
|
4456
|
-
# `ListTaskDefinitionFamilies` request with the returned
|
|
4457
|
-
# value. This value can be between 1 and 100. If this
|
|
4458
|
-
# used, then `ListTaskDefinitionFamilies` returns up to
|
|
4459
|
-
# a `nextToken` value if applicable.
|
|
4484
|
+
# The maximum number of task definition family results that
|
|
4485
|
+
# `ListTaskDefinitionFamilies` returned in paginated output. When this
|
|
4486
|
+
# parameter is used, `ListTaskDefinitions` only returns `maxResults`
|
|
4487
|
+
# results in a single page along with a `nextToken` response element.
|
|
4488
|
+
# The remaining results of the initial request can be seen by sending
|
|
4489
|
+
# another `ListTaskDefinitionFamilies` request with the returned
|
|
4490
|
+
# `nextToken` value. This value can be between 1 and 100. If this
|
|
4491
|
+
# parameter isn't used, then `ListTaskDefinitionFamilies` returns up to
|
|
4492
|
+
# 100 results and a `nextToken` value if applicable.
|
|
4460
4493
|
#
|
|
4461
4494
|
# @return [Types::ListTaskDefinitionFamiliesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4462
4495
|
#
|
|
@@ -4528,27 +4561,26 @@ module Aws::ECS
|
|
|
4528
4561
|
# `familyPrefix` parameter or by status with the `status` parameter.
|
|
4529
4562
|
#
|
|
4530
4563
|
# @option params [String] :family_prefix
|
|
4531
|
-
# The full family name
|
|
4532
|
-
#
|
|
4533
|
-
#
|
|
4564
|
+
# The full family name to filter the `ListTaskDefinitions` results with.
|
|
4565
|
+
# Specifying a `familyPrefix` limits the listed task definitions to task
|
|
4566
|
+
# definition revisions that belong to that family.
|
|
4534
4567
|
#
|
|
4535
4568
|
# @option params [String] :status
|
|
4536
|
-
# The task definition status
|
|
4537
|
-
#
|
|
4538
|
-
#
|
|
4539
|
-
#
|
|
4540
|
-
#
|
|
4541
|
-
#
|
|
4542
|
-
# request.
|
|
4569
|
+
# The task definition status to filter the `ListTaskDefinitions` results
|
|
4570
|
+
# with. By default, only `ACTIVE` task definitions are listed. By
|
|
4571
|
+
# setting this parameter to `INACTIVE`, you can view task definitions
|
|
4572
|
+
# that are `INACTIVE` as long as an active task or service still
|
|
4573
|
+
# references them. If you paginate the resulting output, be sure to keep
|
|
4574
|
+
# the `status` value constant in each subsequent request.
|
|
4543
4575
|
#
|
|
4544
4576
|
# @option params [String] :sort
|
|
4545
|
-
# The order
|
|
4546
|
-
#
|
|
4547
|
-
#
|
|
4548
|
-
#
|
|
4549
|
-
#
|
|
4550
|
-
#
|
|
4551
|
-
#
|
|
4577
|
+
# The order to sort the results in. Valid values are `ASC` and `DESC`.
|
|
4578
|
+
# By default, (`ASC`) task definitions are listed lexicographically by
|
|
4579
|
+
# family name and in ascending numerical order by revision so that the
|
|
4580
|
+
# newest task definitions in a family are listed last. Setting this
|
|
4581
|
+
# parameter to `DESC` reverses the sort order on family name and
|
|
4582
|
+
# revision. This is so that the newest task definitions in a family are
|
|
4583
|
+
# listed first.
|
|
4552
4584
|
#
|
|
4553
4585
|
# @option params [String] :next_token
|
|
4554
4586
|
# The `nextToken` value returned from a `ListTaskDefinitions` request
|
|
@@ -4563,15 +4595,15 @@ module Aws::ECS
|
|
|
4563
4595
|
# </note>
|
|
4564
4596
|
#
|
|
4565
4597
|
# @option params [Integer] :max_results
|
|
4566
|
-
# The maximum number of task definition results
|
|
4567
|
-
# `ListTaskDefinitions` in paginated output. When this
|
|
4568
|
-
# used, `ListTaskDefinitions` only returns `maxResults`
|
|
4569
|
-
# single page along with a `nextToken` response element.
|
|
4570
|
-
# results of the initial request can be seen by sending
|
|
4571
|
-
# `ListTaskDefinitions` request with the returned `nextToken`
|
|
4572
|
-
# This value can be between 1 and 100. If this parameter
|
|
4573
|
-
# then `ListTaskDefinitions` returns up to 100 results and a
|
|
4574
|
-
# value if applicable.
|
|
4598
|
+
# The maximum number of task definition results that
|
|
4599
|
+
# `ListTaskDefinitions` returned in paginated output. When this
|
|
4600
|
+
# parameter is used, `ListTaskDefinitions` only returns `maxResults`
|
|
4601
|
+
# results in a single page along with a `nextToken` response element.
|
|
4602
|
+
# The remaining results of the initial request can be seen by sending
|
|
4603
|
+
# another `ListTaskDefinitions` request with the returned `nextToken`
|
|
4604
|
+
# value. This value can be between 1 and 100. If this parameter isn't
|
|
4605
|
+
# used, then `ListTaskDefinitions` returns up to 100 results and a
|
|
4606
|
+
# `nextToken` value if applicable.
|
|
4575
4607
|
#
|
|
4576
4608
|
# @return [Types::ListTaskDefinitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4577
4609
|
#
|
|
@@ -4670,7 +4702,7 @@ module Aws::ECS
|
|
|
4670
4702
|
# @option params [String] :next_token
|
|
4671
4703
|
# The `nextToken` value returned from a `ListTasks` request indicating
|
|
4672
4704
|
# that more results are available to fulfill the request and further
|
|
4673
|
-
# calls will be needed. If `maxResults` was provided, it
|
|
4705
|
+
# calls will be needed. If `maxResults` was provided, it's possible the
|
|
4674
4706
|
# number of results to be fewer than `maxResults`.
|
|
4675
4707
|
#
|
|
4676
4708
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
|
@@ -4680,19 +4712,19 @@ module Aws::ECS
|
|
|
4680
4712
|
# </note>
|
|
4681
4713
|
#
|
|
4682
4714
|
# @option params [Integer] :max_results
|
|
4683
|
-
# The maximum number of task results
|
|
4715
|
+
# The maximum number of task results that `ListTasks` returned in
|
|
4684
4716
|
# paginated output. When this parameter is used, `ListTasks` only
|
|
4685
4717
|
# returns `maxResults` results in a single page along with a `nextToken`
|
|
4686
4718
|
# response element. The remaining results of the initial request can be
|
|
4687
4719
|
# seen by sending another `ListTasks` request with the returned
|
|
4688
4720
|
# `nextToken` value. This value can be between 1 and 100. If this
|
|
4689
|
-
# parameter
|
|
4721
|
+
# parameter isn't used, then `ListTasks` returns up to 100 results and
|
|
4690
4722
|
# a `nextToken` value if applicable.
|
|
4691
4723
|
#
|
|
4692
4724
|
# @option params [String] :started_by
|
|
4693
|
-
# The `startedBy` value
|
|
4694
|
-
#
|
|
4695
|
-
#
|
|
4725
|
+
# The `startedBy` value to filter the task results with. Specifying a
|
|
4726
|
+
# `startedBy` value limits the results to tasks that were started with
|
|
4727
|
+
# that value.
|
|
4696
4728
|
#
|
|
4697
4729
|
# @option params [String] :service_name
|
|
4698
4730
|
# The name of the service to use when filtering the `ListTasks` results.
|
|
@@ -4703,12 +4735,12 @@ module Aws::ECS
|
|
|
4703
4735
|
# The task desired status to use when filtering the `ListTasks` results.
|
|
4704
4736
|
# Specifying a `desiredStatus` of `STOPPED` limits the results to tasks
|
|
4705
4737
|
# that Amazon ECS has set the desired status to `STOPPED`. This can be
|
|
4706
|
-
# useful for debugging tasks that
|
|
4738
|
+
# useful for debugging tasks that aren't starting properly or have died
|
|
4707
4739
|
# or finished. The default status filter is `RUNNING`, which shows tasks
|
|
4708
4740
|
# that Amazon ECS has set the desired status to `RUNNING`.
|
|
4709
4741
|
#
|
|
4710
4742
|
# <note markdown="1"> Although you can filter results based on a desired status of
|
|
4711
|
-
# `PENDING`, this
|
|
4743
|
+
# `PENDING`, this doesn't return any results. Amazon ECS never sets the
|
|
4712
4744
|
# desired status of a task to that value (only a task's `lastStatus`
|
|
4713
4745
|
# may have a value of `PENDING`).
|
|
4714
4746
|
#
|
|
@@ -4791,9 +4823,9 @@ module Aws::ECS
|
|
|
4791
4823
|
# basis.
|
|
4792
4824
|
#
|
|
4793
4825
|
# If you change the account setting for the root user, the default
|
|
4794
|
-
# settings for all of the IAM users and roles
|
|
4795
|
-
#
|
|
4796
|
-
#
|
|
4826
|
+
# settings for all of the IAM users and roles that no individual account
|
|
4827
|
+
# setting was specified are reset for. For more information, see
|
|
4828
|
+
# [Account Settings][1] in the *Amazon Elastic Container Service
|
|
4797
4829
|
# Developer Guide*.
|
|
4798
4830
|
#
|
|
4799
4831
|
# When `serviceLongArnFormat`, `taskLongArnFormat`, or
|
|
@@ -4801,10 +4833,10 @@ module Aws::ECS
|
|
|
4801
4833
|
# Name (ARN) and resource ID format of the resource type for a specified
|
|
4802
4834
|
# IAM user, IAM role, or the root user for an account is affected. The
|
|
4803
4835
|
# opt-in and opt-out account setting must be set for each Amazon ECS
|
|
4804
|
-
# resource separately. The ARN and resource ID format of a resource
|
|
4805
|
-
#
|
|
4806
|
-
#
|
|
4807
|
-
#
|
|
4836
|
+
# resource separately. The ARN and resource ID format of a resource is
|
|
4837
|
+
# defined by the opt-in status of the IAM user or role that created the
|
|
4838
|
+
# resource. You must enable this setting to use Amazon ECS features such
|
|
4839
|
+
# as resource tagging.
|
|
4808
4840
|
#
|
|
4809
4841
|
# When `awsvpcTrunking` is specified, the elastic network interface
|
|
4810
4842
|
# (ENI) limit for any new container instances that support the feature
|
|
@@ -4994,7 +5026,7 @@ module Aws::ECS
|
|
|
4994
5026
|
end
|
|
4995
5027
|
|
|
4996
5028
|
# Create or update an attribute on an Amazon ECS resource. If the
|
|
4997
|
-
# attribute
|
|
5029
|
+
# attribute doesn't exist, it's created. If the attribute exists, its
|
|
4998
5030
|
# value is replaced with the specified value. To delete an attribute,
|
|
4999
5031
|
# use DeleteAttributes. For more information, see [Attributes][1] in the
|
|
5000
5032
|
# *Amazon Elastic Container Service Developer Guide*.
|
|
@@ -5010,8 +5042,8 @@ module Aws::ECS
|
|
|
5010
5042
|
#
|
|
5011
5043
|
# @option params [required, Array<Types::Attribute>] :attributes
|
|
5012
5044
|
# The attributes to apply to your resource. You can specify up to 10
|
|
5013
|
-
# custom attributes
|
|
5014
|
-
# a single call.
|
|
5045
|
+
# custom attributes for each resource. You can specify up to 10
|
|
5046
|
+
# attributes in a single call.
|
|
5015
5047
|
#
|
|
5016
5048
|
# @return [Types::PutAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5017
5049
|
#
|
|
@@ -5055,21 +5087,21 @@ module Aws::ECS
|
|
|
5055
5087
|
# capacity provider strategy for the cluster. If the specified cluster
|
|
5056
5088
|
# has existing capacity providers associated with it, you must specify
|
|
5057
5089
|
# all existing capacity providers in addition to any new ones you want
|
|
5058
|
-
# to add. Any existing capacity providers associated with a
|
|
5059
|
-
# are omitted from a PutClusterCapacityProviders API call
|
|
5060
|
-
# disassociated with the cluster. You can only disassociate an
|
|
5061
|
-
# capacity provider from a cluster if it's not being used by
|
|
5062
|
-
# existing tasks.
|
|
5090
|
+
# to add. Any existing capacity providers that are associated with a
|
|
5091
|
+
# cluster that are omitted from a PutClusterCapacityProviders API call
|
|
5092
|
+
# will be disassociated with the cluster. You can only disassociate an
|
|
5093
|
+
# existing capacity provider from a cluster if it's not being used by
|
|
5094
|
+
# any existing tasks.
|
|
5063
5095
|
#
|
|
5064
5096
|
# When creating a service or running a task on a cluster, if no capacity
|
|
5065
5097
|
# provider or launch type is specified, then the cluster's default
|
|
5066
|
-
# capacity provider strategy is used.
|
|
5067
|
-
# default capacity provider strategy for your cluster,
|
|
5098
|
+
# capacity provider strategy is used. We recommend that you define a
|
|
5099
|
+
# default capacity provider strategy for your cluster. However, you must
|
|
5068
5100
|
# specify an empty array (`[]`) to bypass defining a default strategy.
|
|
5069
5101
|
#
|
|
5070
5102
|
# @option params [required, String] :cluster
|
|
5071
5103
|
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
5072
|
-
# modify the capacity provider settings for. If you
|
|
5104
|
+
# modify the capacity provider settings for. If you don't specify a
|
|
5073
5105
|
# cluster, the default cluster is assumed.
|
|
5074
5106
|
#
|
|
5075
5107
|
# @option params [required, Array<String>] :capacity_providers
|
|
@@ -5184,8 +5216,8 @@ module Aws::ECS
|
|
|
5184
5216
|
# becomes available to place containers on.
|
|
5185
5217
|
#
|
|
5186
5218
|
# @option params [String] :cluster
|
|
5187
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
5188
|
-
#
|
|
5219
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
5220
|
+
# register your container instance with. If you do not specify a
|
|
5189
5221
|
# cluster, the default cluster is assumed.
|
|
5190
5222
|
#
|
|
5191
5223
|
# @option params [String] :instance_identity_document
|
|
@@ -5205,7 +5237,7 @@ module Aws::ECS
|
|
|
5205
5237
|
#
|
|
5206
5238
|
# @option params [Types::VersionInfo] :version_info
|
|
5207
5239
|
# The version information for the Amazon ECS container agent and Docker
|
|
5208
|
-
# daemon
|
|
5240
|
+
# daemon that runs on the container instance.
|
|
5209
5241
|
#
|
|
5210
5242
|
# @option params [String] :container_instance_arn
|
|
5211
5243
|
# The ARN of the container instance (if it was previously registered).
|
|
@@ -5221,7 +5253,7 @@ module Aws::ECS
|
|
|
5221
5253
|
# @option params [Array<Types::Tag>] :tags
|
|
5222
5254
|
# The metadata that you apply to the container instance to help you
|
|
5223
5255
|
# categorize and organize them. Each tag consists of a key and an
|
|
5224
|
-
# optional value
|
|
5256
|
+
# optional value. You define both.
|
|
5225
5257
|
#
|
|
5226
5258
|
# The following basic restrictions apply to tags:
|
|
5227
5259
|
#
|
|
@@ -5343,6 +5375,12 @@ module Aws::ECS
|
|
|
5343
5375
|
# resp.container_instance.tags #=> Array
|
|
5344
5376
|
# resp.container_instance.tags[0].key #=> String
|
|
5345
5377
|
# resp.container_instance.tags[0].value #=> String
|
|
5378
|
+
# resp.container_instance.health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
5379
|
+
# resp.container_instance.health_status.details #=> Array
|
|
5380
|
+
# resp.container_instance.health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
|
|
5381
|
+
# resp.container_instance.health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
5382
|
+
# resp.container_instance.health_status.details[0].last_updated #=> Time
|
|
5383
|
+
# resp.container_instance.health_status.details[0].last_status_change #=> Time
|
|
5346
5384
|
#
|
|
5347
5385
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterContainerInstance AWS API Documentation
|
|
5348
5386
|
#
|
|
@@ -5364,9 +5402,9 @@ module Aws::ECS
|
|
|
5364
5402
|
# parameter. When you specify an IAM role for a task, its containers can
|
|
5365
5403
|
# then use the latest versions of the CLI or SDKs to make API requests
|
|
5366
5404
|
# to the Amazon Web Services services that are specified in the IAM
|
|
5367
|
-
# policy associated with the role. For more information, see
|
|
5368
|
-
# for Tasks][2] in the *Amazon Elastic Container Service
|
|
5369
|
-
# Guide*.
|
|
5405
|
+
# policy that's associated with the role. For more information, see
|
|
5406
|
+
# [IAM Roles for Tasks][2] in the *Amazon Elastic Container Service
|
|
5407
|
+
# Developer Guide*.
|
|
5370
5408
|
#
|
|
5371
5409
|
# You can specify a Docker networking mode for the containers in your
|
|
5372
5410
|
# task definition with the `networkMode` parameter. The available
|
|
@@ -5386,7 +5424,7 @@ module Aws::ECS
|
|
|
5386
5424
|
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
|
5387
5425
|
#
|
|
5388
5426
|
# @option params [required, String] :family
|
|
5389
|
-
# You must specify a `family` for a task definition
|
|
5427
|
+
# You must specify a `family` for a task definition. You can use it
|
|
5390
5428
|
# track multiple versions of the same task definition. The `family` is
|
|
5391
5429
|
# used as a name for your task definition. Up to 255 letters (uppercase
|
|
5392
5430
|
# and lowercase), numbers, underscores, and hyphens are allowed.
|
|
@@ -5464,23 +5502,23 @@ module Aws::ECS
|
|
|
5464
5502
|
#
|
|
5465
5503
|
# @option params [Array<Types::Volume>] :volumes
|
|
5466
5504
|
# A list of volume definitions in JSON format that containers in your
|
|
5467
|
-
# task
|
|
5505
|
+
# task might use.
|
|
5468
5506
|
#
|
|
5469
5507
|
# @option params [Array<Types::TaskDefinitionPlacementConstraint>] :placement_constraints
|
|
5470
5508
|
# An array of placement constraint objects to use for the task. You can
|
|
5471
|
-
# specify a maximum of 10 constraints
|
|
5472
|
-
# constraints in the task definition and those specified at runtime
|
|
5509
|
+
# specify a maximum of 10 constraints for each task. This limit includes
|
|
5510
|
+
# constraints in the task definition and those specified at runtime.
|
|
5473
5511
|
#
|
|
5474
5512
|
# @option params [Array<String>] :requires_compatibilities
|
|
5475
|
-
# The task launch type that Amazon ECS
|
|
5476
|
-
#
|
|
5477
|
-
#
|
|
5478
|
-
#
|
|
5513
|
+
# The task launch type that Amazon ECS validates the task definition
|
|
5514
|
+
# against. A client exception is returned if the task definition
|
|
5515
|
+
# doesn't validate against the compatibilities specified. If no value
|
|
5516
|
+
# is specified, the parameter is omitted from the response.
|
|
5479
5517
|
#
|
|
5480
5518
|
# @option params [String] :cpu
|
|
5481
5519
|
# The number of CPU units used by the task. It can be expressed as an
|
|
5482
|
-
# integer using CPU units
|
|
5483
|
-
# vCPUs
|
|
5520
|
+
# integer using CPU units (for example, `1024`) or as a string using
|
|
5521
|
+
# vCPUs (for example, `1 vCPU` or `1 vcpu`) in a task definition. String
|
|
5484
5522
|
# values are converted to an integer indicating the CPU units when the
|
|
5485
5523
|
# task definition is registered.
|
|
5486
5524
|
#
|
|
@@ -5490,14 +5528,17 @@ module Aws::ECS
|
|
|
5490
5528
|
#
|
|
5491
5529
|
# </note>
|
|
5492
5530
|
#
|
|
5493
|
-
# If you
|
|
5531
|
+
# If you're using the EC2 launch type, this field is optional.
|
|
5494
5532
|
# Supported values are between `128` CPU units (`0.125` vCPUs) and
|
|
5495
5533
|
# `10240` CPU units (`10` vCPUs).
|
|
5496
5534
|
#
|
|
5497
|
-
# If you
|
|
5535
|
+
# If you're using the Fargate launch type, this field is required and
|
|
5498
5536
|
# you must use one of the following values, which determines your range
|
|
5499
5537
|
# of supported values for the `memory` parameter:
|
|
5500
5538
|
#
|
|
5539
|
+
# The CPU units cannot be less than 1 vCPU when you use Windows
|
|
5540
|
+
# containers on Fargate.
|
|
5541
|
+
#
|
|
5501
5542
|
# * 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1
|
|
5502
5543
|
# GB), 2048 (2 GB)
|
|
5503
5544
|
#
|
|
@@ -5515,8 +5556,8 @@ module Aws::ECS
|
|
|
5515
5556
|
#
|
|
5516
5557
|
# @option params [String] :memory
|
|
5517
5558
|
# The amount of memory (in MiB) used by the task. It can be expressed as
|
|
5518
|
-
# an integer using MiB
|
|
5519
|
-
# example `1GB` or `1 GB
|
|
5559
|
+
# an integer using MiB (for example ,`1024`) or as a string using GB
|
|
5560
|
+
# (for example, `1GB` or `1 GB`) in a task definition. String values are
|
|
5520
5561
|
# converted to an integer indicating the MiB when the task definition is
|
|
5521
5562
|
# registered.
|
|
5522
5563
|
#
|
|
@@ -5529,8 +5570,11 @@ module Aws::ECS
|
|
|
5529
5570
|
# If using the EC2 launch type, this field is optional.
|
|
5530
5571
|
#
|
|
5531
5572
|
# If using the Fargate launch type, this field is required and you must
|
|
5532
|
-
# use one of the following values
|
|
5533
|
-
# supported values for the `cpu` parameter
|
|
5573
|
+
# use one of the following values. This determines your range of
|
|
5574
|
+
# supported values for the `cpu` parameter.
|
|
5575
|
+
#
|
|
5576
|
+
# The CPU units cannot be less than 1 vCPU when you use Windows
|
|
5577
|
+
# containers on Fargate.
|
|
5534
5578
|
#
|
|
5535
5579
|
# * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values: 256
|
|
5536
5580
|
# (.25 vCPU)
|
|
@@ -5550,7 +5594,7 @@ module Aws::ECS
|
|
|
5550
5594
|
# @option params [Array<Types::Tag>] :tags
|
|
5551
5595
|
# The metadata that you apply to the task definition to help you
|
|
5552
5596
|
# categorize and organize them. Each tag consists of a key and an
|
|
5553
|
-
# optional value
|
|
5597
|
+
# optional value. You define both of them.
|
|
5554
5598
|
#
|
|
5555
5599
|
# The following basic restrictions apply to tags:
|
|
5556
5600
|
#
|
|
@@ -6169,12 +6213,12 @@ module Aws::ECS
|
|
|
6169
6213
|
# Alternatively, you can use StartTask to use your own scheduler or
|
|
6170
6214
|
# place tasks manually on specific container instances.
|
|
6171
6215
|
#
|
|
6172
|
-
# The Amazon ECS API follows an eventual consistency model
|
|
6173
|
-
# distributed nature of the system supporting the API. This
|
|
6174
|
-
# the result of an API command you run that affects your
|
|
6175
|
-
# resources might not be immediately visible to all
|
|
6176
|
-
# you run. Keep this in mind when you carry out an
|
|
6177
|
-
# immediately follows a previous API command.
|
|
6216
|
+
# The Amazon ECS API follows an eventual consistency model. This is
|
|
6217
|
+
# because the distributed nature of the system supporting the API. This
|
|
6218
|
+
# means that the result of an API command you run that affects your
|
|
6219
|
+
# Amazon ECS resources might not be immediately visible to all
|
|
6220
|
+
# subsequent commands you run. Keep this in mind when you carry out an
|
|
6221
|
+
# API command that immediately follows a previous API command.
|
|
6178
6222
|
#
|
|
6179
6223
|
# To manage eventual consistency, you can do the following:
|
|
6180
6224
|
#
|
|
@@ -6210,13 +6254,13 @@ module Aws::ECS
|
|
|
6210
6254
|
# providers.
|
|
6211
6255
|
#
|
|
6212
6256
|
# @option params [String] :cluster
|
|
6213
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
6214
|
-
#
|
|
6215
|
-
#
|
|
6257
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
6258
|
+
# run your task on. If you do not specify a cluster, the default cluster
|
|
6259
|
+
# is assumed.
|
|
6216
6260
|
#
|
|
6217
6261
|
# @option params [Integer] :count
|
|
6218
6262
|
# The number of instantiations of the specified task to place on your
|
|
6219
|
-
# cluster. You can specify up to 10 tasks
|
|
6263
|
+
# cluster. You can specify up to 10 tasks for each call.
|
|
6220
6264
|
#
|
|
6221
6265
|
# @option params [Boolean] :enable_ecs_managed_tags
|
|
6222
6266
|
# Specifies whether to enable Amazon ECS managed tags for the task. For
|
|
@@ -6228,7 +6272,7 @@ module Aws::ECS
|
|
|
6228
6272
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
|
6229
6273
|
#
|
|
6230
6274
|
# @option params [Boolean] :enable_execute_command
|
|
6231
|
-
#
|
|
6275
|
+
# Determines whether to enable the execute command functionality for the
|
|
6232
6276
|
# containers in this task. If `true`, this enables execute command
|
|
6233
6277
|
# functionality on all containers in the task.
|
|
6234
6278
|
#
|
|
@@ -6238,7 +6282,7 @@ module Aws::ECS
|
|
|
6238
6282
|
# `family:my-family-name`).
|
|
6239
6283
|
#
|
|
6240
6284
|
# @option params [String] :launch_type
|
|
6241
|
-
# The infrastructure
|
|
6285
|
+
# The infrastructure to run your standalone task on. For more
|
|
6242
6286
|
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
|
6243
6287
|
# Container Service Developer Guide*.
|
|
6244
6288
|
#
|
|
@@ -6254,7 +6298,7 @@ module Aws::ECS
|
|
|
6254
6298
|
# The `EC2` launch type runs your tasks on Amazon EC2 instances
|
|
6255
6299
|
# registered to your cluster.
|
|
6256
6300
|
#
|
|
6257
|
-
# The `EXTERNAL` launch type runs your tasks on your on-
|
|
6301
|
+
# The `EXTERNAL` launch type runs your tasks on your on-premises server
|
|
6258
6302
|
# or virtual machine (VM) capacity registered to your cluster.
|
|
6259
6303
|
#
|
|
6260
6304
|
# A task can use either a launch type or a capacity provider strategy.
|
|
@@ -6272,7 +6316,7 @@ module Aws::ECS
|
|
|
6272
6316
|
# @option params [Types::NetworkConfiguration] :network_configuration
|
|
6273
6317
|
# The network configuration for the task. This parameter is required for
|
|
6274
6318
|
# task definitions that use the `awsvpc` network mode to receive their
|
|
6275
|
-
# own elastic network interface, and it
|
|
6319
|
+
# own elastic network interface, and it isn't supported for other
|
|
6276
6320
|
# network modes. For more information, see [Task networking][1] in the
|
|
6277
6321
|
# *Amazon Elastic Container Service Developer Guide*.
|
|
6278
6322
|
#
|
|
@@ -6284,7 +6328,7 @@ module Aws::ECS
|
|
|
6284
6328
|
# A list of container overrides in JSON format that specify the name of
|
|
6285
6329
|
# a container in the specified task definition and the overrides it
|
|
6286
6330
|
# should receive. You can override the default command for a container
|
|
6287
|
-
# (that
|
|
6331
|
+
# (that's specified in the task definition or Docker image) with a
|
|
6288
6332
|
# `command` override. You can also override existing environment
|
|
6289
6333
|
# variables (that are specified in the task definition or Docker image)
|
|
6290
6334
|
# on a container or add new environment variables to it with an
|
|
@@ -6295,19 +6339,19 @@ module Aws::ECS
|
|
|
6295
6339
|
#
|
|
6296
6340
|
# @option params [Array<Types::PlacementConstraint>] :placement_constraints
|
|
6297
6341
|
# An array of placement constraint objects to use for the task. You can
|
|
6298
|
-
# specify up to 10 constraints
|
|
6299
|
-
# task definition and those specified at runtime).
|
|
6342
|
+
# specify up to 10 constraints for each task (including constraints in
|
|
6343
|
+
# the task definition and those specified at runtime).
|
|
6300
6344
|
#
|
|
6301
6345
|
# @option params [Array<Types::PlacementStrategy>] :placement_strategy
|
|
6302
6346
|
# The placement strategy objects to use for the task. You can specify a
|
|
6303
|
-
# maximum of 5 strategy rules
|
|
6347
|
+
# maximum of 5 strategy rules for each task.
|
|
6304
6348
|
#
|
|
6305
6349
|
# @option params [String] :platform_version
|
|
6306
|
-
# The platform version the task
|
|
6307
|
-
# specified for tasks hosted on Fargate. If one
|
|
6308
|
-
# `LATEST` platform version is used
|
|
6309
|
-
#
|
|
6310
|
-
#
|
|
6350
|
+
# The platform version the task uses. A platform version is only
|
|
6351
|
+
# specified for tasks hosted on Fargate. If one isn't specified, the
|
|
6352
|
+
# `LATEST` platform version is used. For more information, see [Fargate
|
|
6353
|
+
# platform versions][1] in the *Amazon Elastic Container Service
|
|
6354
|
+
# Developer Guide*.
|
|
6311
6355
|
#
|
|
6312
6356
|
#
|
|
6313
6357
|
#
|
|
@@ -6315,7 +6359,7 @@ module Aws::ECS
|
|
|
6315
6359
|
#
|
|
6316
6360
|
# @option params [String] :propagate_tags
|
|
6317
6361
|
# Specifies whether to propagate the tags from the task definition to
|
|
6318
|
-
# the task. If no value is specified, the tags
|
|
6362
|
+
# the task. If no value is specified, the tags aren't propagated. Tags
|
|
6319
6363
|
# can only be propagated to the task during task creation. To add tags
|
|
6320
6364
|
# to a task after task creation, use the TagResource API action.
|
|
6321
6365
|
#
|
|
@@ -6335,7 +6379,7 @@ module Aws::ECS
|
|
|
6335
6379
|
# `startedBy` parameter. You can then identify which tasks belong to
|
|
6336
6380
|
# that job by filtering the results of a ListTasks call with the
|
|
6337
6381
|
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
|
6338
|
-
# numbers, hyphens, and underscores are allowed.
|
|
6382
|
+
# numbers, hyphens (-), and underscores (\_) are allowed.
|
|
6339
6383
|
#
|
|
6340
6384
|
# If a task is started by an Amazon ECS service, then the `startedBy`
|
|
6341
6385
|
# parameter contains the deployment ID of the service that starts it.
|
|
@@ -6372,10 +6416,10 @@ module Aws::ECS
|
|
|
6372
6416
|
#
|
|
6373
6417
|
# @option params [required, String] :task_definition
|
|
6374
6418
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
|
6375
|
-
# task definition to run. If a `revision`
|
|
6419
|
+
# task definition to run. If a `revision` isn't specified, the latest
|
|
6376
6420
|
# `ACTIVE` revision is used.
|
|
6377
6421
|
#
|
|
6378
|
-
# The full ARN value must match the value that you specified
|
|
6422
|
+
# The full ARN value must match the value that you specified as the
|
|
6379
6423
|
# `Resource` of the IAM principal's permissions policy. For example, if
|
|
6380
6424
|
# the `Resource` is
|
|
6381
6425
|
# arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*,
|
|
@@ -6646,14 +6690,14 @@ module Aws::ECS
|
|
|
6646
6690
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html
|
|
6647
6691
|
#
|
|
6648
6692
|
# @option params [String] :cluster
|
|
6649
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
6650
|
-
#
|
|
6693
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster where
|
|
6694
|
+
# to start your task. If you do not specify a cluster, the default
|
|
6651
6695
|
# cluster is assumed.
|
|
6652
6696
|
#
|
|
6653
6697
|
# @option params [required, Array<String>] :container_instances
|
|
6654
6698
|
# The container instance IDs or full ARN entries for the container
|
|
6655
|
-
# instances
|
|
6656
|
-
#
|
|
6699
|
+
# instances where you would like to place your task. You can specify up
|
|
6700
|
+
# to 10 container instances.
|
|
6657
6701
|
#
|
|
6658
6702
|
# @option params [Boolean] :enable_ecs_managed_tags
|
|
6659
6703
|
# Specifies whether to enable Amazon ECS managed tags for the task. For
|
|
@@ -6682,8 +6726,8 @@ module Aws::ECS
|
|
|
6682
6726
|
# @option params [Types::TaskOverride] :overrides
|
|
6683
6727
|
# A list of container overrides in JSON format that specify the name of
|
|
6684
6728
|
# a container in the specified task definition and the overrides it
|
|
6685
|
-
#
|
|
6686
|
-
# (that
|
|
6729
|
+
# receives. You can override the default command for a container
|
|
6730
|
+
# (that's specified in the task definition or Docker image) with a
|
|
6687
6731
|
# `command` override. You can also override existing environment
|
|
6688
6732
|
# variables (that are specified in the task definition or Docker image)
|
|
6689
6733
|
# on a container or add new environment variables to it with an
|
|
@@ -6696,7 +6740,7 @@ module Aws::ECS
|
|
|
6696
6740
|
#
|
|
6697
6741
|
# @option params [String] :propagate_tags
|
|
6698
6742
|
# Specifies whether to propagate the tags from the task definition or
|
|
6699
|
-
# the service to the task. If no value is specified, the tags
|
|
6743
|
+
# the service to the task. If no value is specified, the tags aren't
|
|
6700
6744
|
# propagated.
|
|
6701
6745
|
#
|
|
6702
6746
|
# @option params [String] :reference_id
|
|
@@ -6709,9 +6753,9 @@ module Aws::ECS
|
|
|
6709
6753
|
# `startedBy` parameter. You can then identify which tasks belong to
|
|
6710
6754
|
# that job by filtering the results of a ListTasks call with the
|
|
6711
6755
|
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
|
6712
|
-
# numbers, hyphens, and underscores are allowed.
|
|
6756
|
+
# numbers, hyphens (-), and underscores (\_) are allowed.
|
|
6713
6757
|
#
|
|
6714
|
-
# If a task is started by an Amazon ECS service,
|
|
6758
|
+
# If a task is started by an Amazon ECS service, the `startedBy`
|
|
6715
6759
|
# parameter contains the deployment ID of the service that starts it.
|
|
6716
6760
|
#
|
|
6717
6761
|
# @option params [Array<Types::Tag>] :tags
|
|
@@ -6746,7 +6790,7 @@ module Aws::ECS
|
|
|
6746
6790
|
#
|
|
6747
6791
|
# @option params [required, String] :task_definition
|
|
6748
6792
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
|
6749
|
-
# task definition to start. If a `revision`
|
|
6793
|
+
# task definition to start. If a `revision` isn't specified, the latest
|
|
6750
6794
|
# `ACTIVE` revision is used.
|
|
6751
6795
|
#
|
|
6752
6796
|
# @return [Types::StartTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -6973,7 +7017,7 @@ module Aws::ECS
|
|
|
6973
7017
|
#
|
|
6974
7018
|
# @option params [String] :reason
|
|
6975
7019
|
# An optional message specified when a task is stopped. For example, if
|
|
6976
|
-
# you
|
|
7020
|
+
# you're using a custom scheduler, you can use this parameter to
|
|
6977
7021
|
# specify the reason for stopping the task here, and the message appears
|
|
6978
7022
|
# in subsequent DescribeTasks API operations on this task. Up to 255
|
|
6979
7023
|
# characters are allowed in this message.
|
|
@@ -7171,7 +7215,7 @@ module Aws::ECS
|
|
|
7171
7215
|
# The status of the state change request.
|
|
7172
7216
|
#
|
|
7173
7217
|
# @option params [Integer] :exit_code
|
|
7174
|
-
# The exit code returned for the state change request.
|
|
7218
|
+
# The exit code that's returned for the state change request.
|
|
7175
7219
|
#
|
|
7176
7220
|
# @option params [String] :reason
|
|
7177
7221
|
# The reason for the state change request.
|
|
@@ -7237,22 +7281,23 @@ module Aws::ECS
|
|
|
7237
7281
|
# The reason for the state change request.
|
|
7238
7282
|
#
|
|
7239
7283
|
# @option params [Array<Types::ContainerStateChange>] :containers
|
|
7240
|
-
# Any containers associated with the state change request.
|
|
7284
|
+
# Any containers that's associated with the state change request.
|
|
7241
7285
|
#
|
|
7242
7286
|
# @option params [Array<Types::AttachmentStateChange>] :attachments
|
|
7243
7287
|
# Any attachments associated with the state change request.
|
|
7244
7288
|
#
|
|
7245
7289
|
# @option params [Array<Types::ManagedAgentStateChange>] :managed_agents
|
|
7246
|
-
# The details for the managed agent associated with the task.
|
|
7290
|
+
# The details for the managed agent that's associated with the task.
|
|
7247
7291
|
#
|
|
7248
7292
|
# @option params [Time,DateTime,Date,Integer,String] :pull_started_at
|
|
7249
|
-
# The Unix timestamp for when the container image pull
|
|
7293
|
+
# The Unix timestamp for the time when the container image pull started.
|
|
7250
7294
|
#
|
|
7251
7295
|
# @option params [Time,DateTime,Date,Integer,String] :pull_stopped_at
|
|
7252
|
-
# The Unix timestamp for when the container image pull
|
|
7296
|
+
# The Unix timestamp for the time when the container image pull
|
|
7297
|
+
# completed.
|
|
7253
7298
|
#
|
|
7254
7299
|
# @option params [Time,DateTime,Date,Integer,String] :execution_stopped_at
|
|
7255
|
-
# The Unix timestamp for when the task execution stopped.
|
|
7300
|
+
# The Unix timestamp for the time when the task execution stopped.
|
|
7256
7301
|
#
|
|
7257
7302
|
# @return [Types::SubmitTaskStateChangeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7258
7303
|
#
|
|
@@ -7316,12 +7361,12 @@ module Aws::ECS
|
|
|
7316
7361
|
end
|
|
7317
7362
|
|
|
7318
7363
|
# Associates the specified tags to a resource with the specified
|
|
7319
|
-
# `resourceArn`. If existing tags on a resource
|
|
7320
|
-
# request parameters, they
|
|
7321
|
-
# the tags associated with that resource are deleted as well.
|
|
7364
|
+
# `resourceArn`. If existing tags on a resource aren't specified in the
|
|
7365
|
+
# request parameters, they aren't changed. When a resource is deleted,
|
|
7366
|
+
# the tags that are associated with that resource are deleted as well.
|
|
7322
7367
|
#
|
|
7323
7368
|
# @option params [required, String] :resource_arn
|
|
7324
|
-
# The Amazon Resource Name (ARN) of the resource to
|
|
7369
|
+
# The Amazon Resource Name (ARN) of the resource to add tags to.
|
|
7325
7370
|
# Currently, the supported resources are Amazon ECS capacity providers,
|
|
7326
7371
|
# tasks, services, task definitions, clusters, and container instances.
|
|
7327
7372
|
#
|
|
@@ -7398,10 +7443,9 @@ module Aws::ECS
|
|
|
7398
7443
|
# Deletes specified tags from a resource.
|
|
7399
7444
|
#
|
|
7400
7445
|
# @option params [required, String] :resource_arn
|
|
7401
|
-
# The Amazon Resource Name (ARN) of the resource
|
|
7402
|
-
#
|
|
7403
|
-
#
|
|
7404
|
-
# instances.
|
|
7446
|
+
# The Amazon Resource Name (ARN) of the resource to delete tags from.
|
|
7447
|
+
# Currently, the supported resources are Amazon ECS capacity providers,
|
|
7448
|
+
# tasks, services, task definitions, clusters, and container instances.
|
|
7405
7449
|
#
|
|
7406
7450
|
# @option params [required, Array<String>] :tag_keys
|
|
7407
7451
|
# The keys of the tags to be removed.
|
|
@@ -7446,7 +7490,7 @@ module Aws::ECS
|
|
|
7446
7490
|
# The name of the capacity provider to update.
|
|
7447
7491
|
#
|
|
7448
7492
|
# @option params [required, Types::AutoScalingGroupProviderUpdate] :auto_scaling_group_provider
|
|
7449
|
-
# An object
|
|
7493
|
+
# An object that represent the parameters to update for the Auto Scaling
|
|
7450
7494
|
# group capacity provider.
|
|
7451
7495
|
#
|
|
7452
7496
|
# @return [Types::UpdateCapacityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -7593,7 +7637,7 @@ module Aws::ECS
|
|
|
7593
7637
|
# @option params [required, Array<Types::ClusterSetting>] :settings
|
|
7594
7638
|
# The setting to use by default for a cluster. This parameter is used to
|
|
7595
7639
|
# enable CloudWatch Container Insights for a cluster. If this value is
|
|
7596
|
-
# specified, it
|
|
7640
|
+
# specified, it overrides the `containerInsights` value set with
|
|
7597
7641
|
# PutAccountSetting or PutAccountSettingDefault.
|
|
7598
7642
|
#
|
|
7599
7643
|
# @return [Types::UpdateClusterSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -7662,7 +7706,7 @@ module Aws::ECS
|
|
|
7662
7706
|
end
|
|
7663
7707
|
|
|
7664
7708
|
# Updates the Amazon ECS container agent on a specified container
|
|
7665
|
-
# instance. Updating the Amazon ECS container agent
|
|
7709
|
+
# instance. Updating the Amazon ECS container agent doesn't interrupt
|
|
7666
7710
|
# running tasks or services on the container instance. The process for
|
|
7667
7711
|
# updating the agent differs depending on whether your container
|
|
7668
7712
|
# instance was launched with the Amazon ECS-optimized AMI or another
|
|
@@ -7670,10 +7714,10 @@ module Aws::ECS
|
|
|
7670
7714
|
#
|
|
7671
7715
|
# <note markdown="1"> The `UpdateContainerAgent` API isn't supported for container
|
|
7672
7716
|
# instances using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI.
|
|
7673
|
-
# To update the container agent, you can update the `ecs-init` package
|
|
7674
|
-
#
|
|
7675
|
-
#
|
|
7676
|
-
#
|
|
7717
|
+
# To update the container agent, you can update the `ecs-init` package.
|
|
7718
|
+
# This updates the agent. For more information, see [Updating the Amazon
|
|
7719
|
+
# ECS container agent][1] in the *Amazon Elastic Container Service
|
|
7720
|
+
# Developer Guide*.
|
|
7677
7721
|
#
|
|
7678
7722
|
# </note>
|
|
7679
7723
|
#
|
|
@@ -7695,7 +7739,7 @@ module Aws::ECS
|
|
|
7695
7739
|
#
|
|
7696
7740
|
# @option params [required, String] :container_instance
|
|
7697
7741
|
# The container instance ID or full ARN entries for the container
|
|
7698
|
-
# instance
|
|
7742
|
+
# instance where you would like to update the Amazon ECS container
|
|
7699
7743
|
# agent.
|
|
7700
7744
|
#
|
|
7701
7745
|
# @return [Types::UpdateContainerAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -7756,6 +7800,12 @@ module Aws::ECS
|
|
|
7756
7800
|
# resp.container_instance.tags #=> Array
|
|
7757
7801
|
# resp.container_instance.tags[0].key #=> String
|
|
7758
7802
|
# resp.container_instance.tags[0].value #=> String
|
|
7803
|
+
# resp.container_instance.health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
7804
|
+
# resp.container_instance.health_status.details #=> Array
|
|
7805
|
+
# resp.container_instance.health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
|
|
7806
|
+
# resp.container_instance.health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
7807
|
+
# resp.container_instance.health_status.details[0].last_updated #=> Time
|
|
7808
|
+
# resp.container_instance.health_status.details[0].last_status_change #=> Time
|
|
7759
7809
|
#
|
|
7760
7810
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerAgent AWS API Documentation
|
|
7761
7811
|
#
|
|
@@ -7773,7 +7823,7 @@ module Aws::ECS
|
|
|
7773
7823
|
# remove an instance from a cluster, for example to perform system
|
|
7774
7824
|
# updates, update the Docker daemon, or scale down the cluster size.
|
|
7775
7825
|
#
|
|
7776
|
-
# A container instance
|
|
7826
|
+
# A container instance can't be changed to `DRAINING` until it has
|
|
7777
7827
|
# reached an `ACTIVE` status. If the instance is in any other status, an
|
|
7778
7828
|
# error will be received.
|
|
7779
7829
|
#
|
|
@@ -7797,22 +7847,23 @@ module Aws::ECS
|
|
|
7797
7847
|
# minimum is 100%, the service scheduler can't remove existing tasks
|
|
7798
7848
|
# until the replacement tasks are considered healthy. Tasks for
|
|
7799
7849
|
# services that do not use a load balancer are considered healthy if
|
|
7800
|
-
# they
|
|
7801
|
-
# balancer are considered healthy if they
|
|
7802
|
-
# and the container instance they
|
|
7850
|
+
# they're in the `RUNNING` state. Tasks for services that use a load
|
|
7851
|
+
# balancer are considered healthy if they're in the `RUNNING` state
|
|
7852
|
+
# and the container instance they're hosted on is reported as healthy
|
|
7803
7853
|
# by the load balancer.
|
|
7804
7854
|
#
|
|
7805
7855
|
# * The `maximumPercent` parameter represents an upper limit on the
|
|
7806
|
-
# number of running tasks during task replacement
|
|
7807
|
-
#
|
|
7808
|
-
#
|
|
7809
|
-
#
|
|
7810
|
-
#
|
|
7811
|
-
#
|
|
7856
|
+
# number of running tasks during task replacement. You can use this to
|
|
7857
|
+
# define the replacement batch size. For example, if `desiredCount` is
|
|
7858
|
+
# four tasks, a maximum of 200% starts four new tasks before stopping
|
|
7859
|
+
# the four tasks to be drained, provided that the cluster resources
|
|
7860
|
+
# required to do this are available. If the maximum is 100%, then
|
|
7861
|
+
# replacement tasks can't start until the draining tasks have
|
|
7812
7862
|
# stopped.
|
|
7813
7863
|
#
|
|
7814
|
-
# Any `PENDING` or `RUNNING` tasks that do not belong to a service
|
|
7815
|
-
#
|
|
7864
|
+
# Any `PENDING` or `RUNNING` tasks that do not belong to a service
|
|
7865
|
+
# aren't affected. You must wait for them to finish or stop them
|
|
7866
|
+
# manually.
|
|
7816
7867
|
#
|
|
7817
7868
|
# A container instance has completed draining when it has no more
|
|
7818
7869
|
# `RUNNING` tasks. You can verify this using ListTasks.
|
|
@@ -7830,13 +7881,13 @@ module Aws::ECS
|
|
|
7830
7881
|
# A list of container instance IDs or full ARN entries.
|
|
7831
7882
|
#
|
|
7832
7883
|
# @option params [required, String] :status
|
|
7833
|
-
# The container instance state
|
|
7834
|
-
#
|
|
7835
|
-
#
|
|
7836
|
-
#
|
|
7837
|
-
#
|
|
7838
|
-
#
|
|
7839
|
-
#
|
|
7884
|
+
# The container instance state to update the container instance with.
|
|
7885
|
+
# The only valid values for this action are `ACTIVE` and `DRAINING`. A
|
|
7886
|
+
# container instance can only be updated to `DRAINING` status once it
|
|
7887
|
+
# has reached an `ACTIVE` state. If a container instance is in
|
|
7888
|
+
# `REGISTERING`, `DEREGISTERING`, or `REGISTRATION_FAILED` state you can
|
|
7889
|
+
# describe the container instance but can't update the container
|
|
7890
|
+
# instance state.
|
|
7840
7891
|
#
|
|
7841
7892
|
# @return [Types::UpdateContainerInstancesStateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7842
7893
|
#
|
|
@@ -7899,6 +7950,12 @@ module Aws::ECS
|
|
|
7899
7950
|
# resp.container_instances[0].tags #=> Array
|
|
7900
7951
|
# resp.container_instances[0].tags[0].key #=> String
|
|
7901
7952
|
# resp.container_instances[0].tags[0].value #=> String
|
|
7953
|
+
# resp.container_instances[0].health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
7954
|
+
# resp.container_instances[0].health_status.details #=> Array
|
|
7955
|
+
# resp.container_instances[0].health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
|
|
7956
|
+
# resp.container_instances[0].health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
7957
|
+
# resp.container_instances[0].health_status.details[0].last_updated #=> Time
|
|
7958
|
+
# resp.container_instances[0].health_status.details[0].last_status_change #=> Time
|
|
7902
7959
|
# resp.failures #=> Array
|
|
7903
7960
|
# resp.failures[0].arn #=> String
|
|
7904
7961
|
# resp.failures[0].reason #=> String
|
|
@@ -7931,15 +7988,15 @@ module Aws::ECS
|
|
|
7931
7988
|
# placement constraints and strategies, and health check grace period
|
|
7932
7989
|
# can be updated using this API. If the network configuration, platform
|
|
7933
7990
|
# version, or task definition need to be updated, a new CodeDeploy
|
|
7934
|
-
# deployment
|
|
7935
|
-
#
|
|
7991
|
+
# deployment is created. For more information, see [CreateDeployment][2]
|
|
7992
|
+
# in the *CodeDeploy API Reference*.
|
|
7936
7993
|
#
|
|
7937
7994
|
# For services using an external deployment controller, you can update
|
|
7938
7995
|
# only the desired count, task placement constraints and strategies, and
|
|
7939
7996
|
# health check grace period using this API. If the launch type, load
|
|
7940
7997
|
# balancer, network configuration, platform version, or task definition
|
|
7941
|
-
# need to be updated,
|
|
7942
|
-
#
|
|
7998
|
+
# need to be updated, create a new task set. For more information, see
|
|
7999
|
+
# CreateTaskSet.
|
|
7943
8000
|
#
|
|
7944
8001
|
# You can add to or subtract from the number of instantiations of a task
|
|
7945
8002
|
# definition in a service by specifying the cluster that the service is
|
|
@@ -7953,7 +8010,7 @@ module Aws::ECS
|
|
|
7953
8010
|
#
|
|
7954
8011
|
# <note markdown="1"> If your updated Docker image uses the same tag as what is in the
|
|
7955
8012
|
# existing task definition for your service (for example,
|
|
7956
|
-
# `my_image:latest`), you
|
|
8013
|
+
# `my_image:latest`), you don't need to create a new revision of your
|
|
7957
8014
|
# task definition. You can update the service using the
|
|
7958
8015
|
# `forceNewDeployment` option. The new tasks launched by the deployment
|
|
7959
8016
|
# pull the current image/tag combination from your repository when they
|
|
@@ -7971,14 +8028,14 @@ module Aws::ECS
|
|
|
7971
8028
|
# `desiredCount` temporarily during a deployment. For example, if
|
|
7972
8029
|
# `desiredCount` is four tasks, a minimum of 50% allows the scheduler
|
|
7973
8030
|
# to stop two existing tasks before starting two new tasks. Tasks for
|
|
7974
|
-
# services that
|
|
7975
|
-
# they
|
|
7976
|
-
# balancer are considered healthy if they
|
|
7977
|
-
# and the container instance they
|
|
8031
|
+
# services that don't use a load balancer are considered healthy if
|
|
8032
|
+
# they're in the `RUNNING` state. Tasks for services that use a load
|
|
8033
|
+
# balancer are considered healthy if they're in the `RUNNING` state
|
|
8034
|
+
# and the container instance they're hosted on is reported as healthy
|
|
7978
8035
|
# by the load balancer.
|
|
7979
8036
|
#
|
|
7980
8037
|
# * The `maximumPercent` parameter represents an upper limit on the
|
|
7981
|
-
# number of running tasks during a deployment
|
|
8038
|
+
# number of running tasks during a deployment. You can use it to
|
|
7982
8039
|
# define the deployment batch size. For example, if `desiredCount` is
|
|
7983
8040
|
# four tasks, a maximum of 200% starts four new tasks before stopping
|
|
7984
8041
|
# the four older tasks (provided that the cluster resources required
|
|
@@ -7986,21 +8043,21 @@ module Aws::ECS
|
|
|
7986
8043
|
#
|
|
7987
8044
|
# When UpdateService stops a task during a deployment, the equivalent of
|
|
7988
8045
|
# `docker stop` is issued to the containers running in the task. This
|
|
7989
|
-
# results in a `SIGTERM` and a 30-second timeout
|
|
8046
|
+
# results in a `SIGTERM` and a 30-second timeout. After this, `SIGKILL`
|
|
7990
8047
|
# is sent and the containers are forcibly stopped. If the container
|
|
7991
8048
|
# handles the `SIGTERM` gracefully and exits within 30 seconds from
|
|
7992
8049
|
# receiving it, no `SIGKILL` is sent.
|
|
7993
8050
|
#
|
|
7994
8051
|
# When the service scheduler launches new tasks, it determines task
|
|
7995
|
-
# placement in your cluster with the following logic
|
|
8052
|
+
# placement in your cluster with the following logic.
|
|
7996
8053
|
#
|
|
7997
8054
|
# * Determine which of the container instances in your cluster can
|
|
7998
|
-
# support your service's task definition
|
|
7999
|
-
# required CPU, memory, ports, and container instance attributes
|
|
8055
|
+
# support your service's task definition. For example, they have the
|
|
8056
|
+
# required CPU, memory, ports, and container instance attributes.
|
|
8000
8057
|
#
|
|
8001
8058
|
# * By default, the service scheduler attempts to balance tasks across
|
|
8002
|
-
# Availability Zones in this manner
|
|
8003
|
-
# different placement strategy
|
|
8059
|
+
# Availability Zones in this manner even though you can choose a
|
|
8060
|
+
# different placement strategy.
|
|
8004
8061
|
#
|
|
8005
8062
|
# * Sort the valid container instances by the fewest number of running
|
|
8006
8063
|
# tasks for this service in the same Availability Zone as the
|
|
@@ -8034,8 +8091,8 @@ module Aws::ECS
|
|
|
8034
8091
|
#
|
|
8035
8092
|
# @option params [String] :cluster
|
|
8036
8093
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
8037
|
-
# your service
|
|
8038
|
-
#
|
|
8094
|
+
# your service runs on. If you do not specify a cluster, the default
|
|
8095
|
+
# cluster is assumed.
|
|
8039
8096
|
#
|
|
8040
8097
|
# @option params [required, String] :service
|
|
8041
8098
|
# The name of the service to update.
|
|
@@ -8055,11 +8112,11 @@ module Aws::ECS
|
|
|
8055
8112
|
# @option params [Array<Types::CapacityProviderStrategyItem>] :capacity_provider_strategy
|
|
8056
8113
|
# The capacity provider strategy to update the service to use.
|
|
8057
8114
|
#
|
|
8058
|
-
#
|
|
8115
|
+
# if the service uses the default capacity provider strategy for the
|
|
8059
8116
|
# cluster, the service can be updated to use one or more capacity
|
|
8060
8117
|
# providers as opposed to the default capacity provider strategy.
|
|
8061
|
-
# However, when a service is using a capacity provider strategy that
|
|
8062
|
-
# not the default capacity provider strategy, the service
|
|
8118
|
+
# However, when a service is using a capacity provider strategy that's
|
|
8119
|
+
# not the default capacity provider strategy, the service can't be
|
|
8063
8120
|
# updated to use the cluster's default capacity provider strategy.
|
|
8064
8121
|
#
|
|
8065
8122
|
# A capacity provider strategy consists of one or more capacity
|
|
@@ -8096,9 +8153,9 @@ module Aws::ECS
|
|
|
8096
8153
|
# override any existing placement constraints defined for the service.
|
|
8097
8154
|
# To remove all existing placement constraints, specify an empty array.
|
|
8098
8155
|
#
|
|
8099
|
-
# You can specify a maximum of 10 constraints
|
|
8156
|
+
# You can specify a maximum of 10 constraints for each task. This limit
|
|
8100
8157
|
# includes constraints in the task definition and those specified at
|
|
8101
|
-
# runtime
|
|
8158
|
+
# runtime.
|
|
8102
8159
|
#
|
|
8103
8160
|
# @option params [Array<Types::PlacementStrategy>] :placement_strategy
|
|
8104
8161
|
# The task placement strategy objects to update the service to use. If
|
|
@@ -8107,32 +8164,31 @@ module Aws::ECS
|
|
|
8107
8164
|
# the existing placement strategy defined for the service. To remove an
|
|
8108
8165
|
# existing placement strategy, specify an empty object.
|
|
8109
8166
|
#
|
|
8110
|
-
# You can specify a maximum of five strategy rules
|
|
8167
|
+
# You can specify a maximum of five strategy rules for each service.
|
|
8111
8168
|
#
|
|
8112
8169
|
# @option params [String] :platform_version
|
|
8113
|
-
# The platform version
|
|
8114
|
-
#
|
|
8115
|
-
#
|
|
8116
|
-
#
|
|
8117
|
-
#
|
|
8118
|
-
# Developer Guide*.
|
|
8170
|
+
# The platform version that your tasks in the service run on. A platform
|
|
8171
|
+
# version is only specified for tasks using the Fargate launch type. If
|
|
8172
|
+
# a platform version is not specified, the `LATEST` platform version is
|
|
8173
|
+
# used. For more information, see [Fargate Platform Versions][1] in the
|
|
8174
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
|
8119
8175
|
#
|
|
8120
8176
|
#
|
|
8121
8177
|
#
|
|
8122
8178
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
|
8123
8179
|
#
|
|
8124
8180
|
# @option params [Boolean] :force_new_deployment
|
|
8125
|
-
#
|
|
8126
|
-
#
|
|
8127
|
-
# with no service definition changes. For example, you
|
|
8128
|
-
# service's tasks to use a newer Docker image with the
|
|
8129
|
-
# combination (`my_image:latest`) or to roll Fargate
|
|
8130
|
-
# platform version.
|
|
8181
|
+
# Determines whether to force a new deployment of the service. By
|
|
8182
|
+
# default, deployments aren't forced. You can use this option to start
|
|
8183
|
+
# a new deployment with no service definition changes. For example, you
|
|
8184
|
+
# can update a service's tasks to use a newer Docker image with the
|
|
8185
|
+
# same image/tag combination (`my_image:latest`) or to roll Fargate
|
|
8186
|
+
# tasks onto a newer platform version.
|
|
8131
8187
|
#
|
|
8132
8188
|
# @option params [Integer] :health_check_grace_period_seconds
|
|
8133
8189
|
# The period of time, in seconds, that the Amazon ECS service scheduler
|
|
8134
|
-
#
|
|
8135
|
-
#
|
|
8190
|
+
# ignores unhealthy Elastic Load Balancing target health checks after a
|
|
8191
|
+
# task has first started. This is only valid if your service is
|
|
8136
8192
|
# configured to use a load balancer. If your service's tasks take a
|
|
8137
8193
|
# while to start and respond to Elastic Load Balancing health checks,
|
|
8138
8194
|
# you can specify a health check grace period of up to 2,147,483,647
|
|
@@ -8461,11 +8517,11 @@ module Aws::ECS
|
|
|
8461
8517
|
#
|
|
8462
8518
|
# @option params [required, String] :cluster
|
|
8463
8519
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
8464
|
-
# hosts the service that the task set
|
|
8520
|
+
# hosts the service that the task set is found in.
|
|
8465
8521
|
#
|
|
8466
8522
|
# @option params [required, String] :service
|
|
8467
8523
|
# The short name or full Amazon Resource Name (ARN) of the service that
|
|
8468
|
-
# the task set
|
|
8524
|
+
# the task set is found in.
|
|
8469
8525
|
#
|
|
8470
8526
|
# @option params [required, String] :task_set
|
|
8471
8527
|
# The short name or full Amazon Resource Name (ARN) of the task set to
|
|
@@ -8558,7 +8614,7 @@ module Aws::ECS
|
|
|
8558
8614
|
params: params,
|
|
8559
8615
|
config: config)
|
|
8560
8616
|
context[:gem_name] = 'aws-sdk-ecs'
|
|
8561
|
-
context[:gem_version] = '1.
|
|
8617
|
+
context[:gem_version] = '1.93.0'
|
|
8562
8618
|
Seahorse::Client::Request.new(handlers, context)
|
|
8563
8619
|
end
|
|
8564
8620
|
|