aws-sdk-ecs 1.88.0 → 1.92.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 +527 -471
- 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
|
@@ -119,7 +119,9 @@ module Aws::ECS
|
|
|
119
119
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
|
120
120
|
# are very aggressive. Construct and pass an instance of
|
|
121
121
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
|
122
|
-
# enable retries and extended timeouts.
|
|
122
|
+
# enable retries and extended timeouts. Instance profile credential
|
|
123
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
|
124
|
+
# to true.
|
|
123
125
|
#
|
|
124
126
|
# @option options [required, String] :region
|
|
125
127
|
# The AWS region to connect to. The configured `:region` is
|
|
@@ -285,6 +287,15 @@ module Aws::ECS
|
|
|
285
287
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
286
288
|
# requests are made, and retries are disabled.
|
|
287
289
|
#
|
|
290
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
|
291
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
|
292
|
+
# will be used if available.
|
|
293
|
+
#
|
|
294
|
+
# @option options [Boolean] :use_fips_endpoint
|
|
295
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
|
296
|
+
# When a `fips` region is used, the region is normalized and this config
|
|
297
|
+
# is set to `true`.
|
|
298
|
+
#
|
|
288
299
|
# @option options [Boolean] :validate_params (true)
|
|
289
300
|
# When `true`, request parameters are validated before
|
|
290
301
|
# sending the request.
|
|
@@ -341,24 +352,24 @@ module Aws::ECS
|
|
|
341
352
|
# with an Amazon ECS cluster and are used in capacity provider
|
|
342
353
|
# strategies to facilitate cluster auto scaling.
|
|
343
354
|
#
|
|
344
|
-
# Only capacity providers
|
|
355
|
+
# Only capacity providers that use an Auto Scaling group can be created.
|
|
345
356
|
# Amazon ECS tasks on Fargate use the `FARGATE` and `FARGATE_SPOT`
|
|
346
|
-
# capacity providers
|
|
347
|
-
#
|
|
357
|
+
# capacity providers. These providers are available to all accounts in
|
|
358
|
+
# the Amazon Web Services Regions that Fargate supports.
|
|
348
359
|
#
|
|
349
360
|
# @option params [required, String] :name
|
|
350
|
-
# The name of the capacity provider. Up to 255 characters are allowed
|
|
351
|
-
#
|
|
352
|
-
# hyphens. The name
|
|
353
|
-
# "`fargate`".
|
|
361
|
+
# The name of the capacity provider. Up to 255 characters are allowed.
|
|
362
|
+
# They include letters (both upper and lowercase letters), numbers,
|
|
363
|
+
# underscores (\_), and hyphens (-). The name can't be prefixed with
|
|
364
|
+
# "`aws`", "`ecs`", or "`fargate`".
|
|
354
365
|
#
|
|
355
366
|
# @option params [required, Types::AutoScalingGroupProvider] :auto_scaling_group_provider
|
|
356
367
|
# The details of the Auto Scaling group for the capacity provider.
|
|
357
368
|
#
|
|
358
369
|
# @option params [Array<Types::Tag>] :tags
|
|
359
|
-
# The metadata that you apply to the capacity provider to
|
|
360
|
-
#
|
|
361
|
-
# optional value
|
|
370
|
+
# The metadata that you apply to the capacity provider to categorize and
|
|
371
|
+
# organize them more conveniently. Each tag consists of a key and an
|
|
372
|
+
# optional value. You define both of them.
|
|
362
373
|
#
|
|
363
374
|
# The following basic restrictions apply to tags:
|
|
364
375
|
#
|
|
@@ -445,10 +456,10 @@ module Aws::ECS
|
|
|
445
456
|
# `CreateCluster` action.
|
|
446
457
|
#
|
|
447
458
|
# <note markdown="1"> When you call the CreateCluster API operation, Amazon ECS attempts to
|
|
448
|
-
# create the Amazon ECS service-linked role for your account so
|
|
449
|
-
# required resources in other Amazon Web Services
|
|
450
|
-
#
|
|
451
|
-
#
|
|
459
|
+
# create the Amazon ECS service-linked role for your account. This is so
|
|
460
|
+
# that it can manage required resources in other Amazon Web Services
|
|
461
|
+
# services on your behalf. However, if the IAM user that makes the call
|
|
462
|
+
# doesn't have permissions to create the service-linked role, it isn't
|
|
452
463
|
# created. For more information, see [Using Service-Linked Roles for
|
|
453
464
|
# Amazon ECS][1] in the *Amazon Elastic Container Service Developer
|
|
454
465
|
# Guide*.
|
|
@@ -460,15 +471,15 @@ module Aws::ECS
|
|
|
460
471
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html
|
|
461
472
|
#
|
|
462
473
|
# @option params [String] :cluster_name
|
|
463
|
-
# The name of your cluster. If you
|
|
464
|
-
# cluster, you create a cluster named `default`. Up to 255
|
|
465
|
-
# (uppercase and lowercase), numbers, underscores, and hyphens
|
|
466
|
-
# allowed.
|
|
474
|
+
# The name of your cluster. If you don't specify a name for your
|
|
475
|
+
# cluster, you create a cluster that's named `default`. Up to 255
|
|
476
|
+
# letters (uppercase and lowercase), numbers, underscores, and hyphens
|
|
477
|
+
# are allowed.
|
|
467
478
|
#
|
|
468
479
|
# @option params [Array<Types::Tag>] :tags
|
|
469
480
|
# The metadata that you apply to the cluster to help you categorize and
|
|
470
|
-
# organize them. Each tag consists of a key and an optional value
|
|
471
|
-
#
|
|
481
|
+
# organize them. Each tag consists of a key and an optional value. You
|
|
482
|
+
# define both.
|
|
472
483
|
#
|
|
473
484
|
# The following basic restrictions apply to tags:
|
|
474
485
|
#
|
|
@@ -498,7 +509,7 @@ module Aws::ECS
|
|
|
498
509
|
# @option params [Array<Types::ClusterSetting>] :settings
|
|
499
510
|
# The setting to use when creating a cluster. This parameter is used to
|
|
500
511
|
# enable CloudWatch Container Insights for a cluster. If this value is
|
|
501
|
-
# specified, it
|
|
512
|
+
# specified, it overrides the `containerInsights` value set with
|
|
502
513
|
# PutAccountSetting or PutAccountSettingDefault.
|
|
503
514
|
#
|
|
504
515
|
# @option params [Types::ClusterConfiguration] :configuration
|
|
@@ -512,9 +523,9 @@ module Aws::ECS
|
|
|
512
523
|
# the CreateService or RunTask actions.
|
|
513
524
|
#
|
|
514
525
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
|
515
|
-
# capacity provider must
|
|
516
|
-
#
|
|
517
|
-
#
|
|
526
|
+
# capacity provider must be created but not associated with another
|
|
527
|
+
# cluster. New Auto Scaling group capacity providers can be created with
|
|
528
|
+
# the CreateCapacityProvider API operation.
|
|
518
529
|
#
|
|
519
530
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
|
520
531
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
|
@@ -527,13 +538,13 @@ module Aws::ECS
|
|
|
527
538
|
#
|
|
528
539
|
# @option params [Array<Types::CapacityProviderStrategyItem>] :default_capacity_provider_strategy
|
|
529
540
|
# The capacity provider strategy to set as the default for the cluster.
|
|
530
|
-
#
|
|
531
|
-
#
|
|
541
|
+
# After a default capacity provider strategy is set for a cluster, when
|
|
542
|
+
# you call the RunTask or CreateService APIs with no capacity provider
|
|
532
543
|
# strategy or launch type specified, the default capacity provider
|
|
533
544
|
# strategy for the cluster is used.
|
|
534
545
|
#
|
|
535
|
-
# If a default capacity provider strategy
|
|
536
|
-
#
|
|
546
|
+
# If a default capacity provider strategy isn't defined for a cluster
|
|
547
|
+
# when it was created, it can be defined later with the
|
|
537
548
|
# PutClusterCapacityProviders API operation.
|
|
538
549
|
#
|
|
539
550
|
# @return [Types::CreateClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -650,7 +661,7 @@ module Aws::ECS
|
|
|
650
661
|
req.send_request(options)
|
|
651
662
|
end
|
|
652
663
|
|
|
653
|
-
# Runs and maintains
|
|
664
|
+
# Runs and maintains your desired number of tasks from a specified task
|
|
654
665
|
# definition. If the number of tasks running in a service drops below
|
|
655
666
|
# the `desiredCount`, Amazon ECS runs another copy of the task in the
|
|
656
667
|
# specified cluster. To update an existing service, see the
|
|
@@ -663,26 +674,27 @@ module Aws::ECS
|
|
|
663
674
|
# Balancing][1] in the *Amazon Elastic Container Service Developer
|
|
664
675
|
# Guide*.
|
|
665
676
|
#
|
|
666
|
-
# Tasks for services that
|
|
677
|
+
# Tasks for services that don't use a load balancer are considered
|
|
667
678
|
# healthy if they're in the `RUNNING` state. Tasks for services that
|
|
668
|
-
#
|
|
679
|
+
# use a load balancer are considered healthy if they're in the
|
|
669
680
|
# `RUNNING` state and the container instance that they're hosted on is
|
|
670
681
|
# reported as healthy by the load balancer.
|
|
671
682
|
#
|
|
672
683
|
# There are two service scheduler strategies available:
|
|
673
684
|
#
|
|
674
|
-
# * `REPLICA` - The replica scheduling strategy places and maintains
|
|
675
|
-
# desired number of tasks across your cluster. By default, the
|
|
676
|
-
# scheduler spreads tasks across Availability Zones. You can
|
|
677
|
-
# placement strategies and constraints to customize task
|
|
678
|
-
# decisions. For more information, see [Service Scheduler
|
|
679
|
-
# in the *Amazon Elastic Container Service Developer
|
|
685
|
+
# * `REPLICA` - The replica scheduling strategy places and maintains
|
|
686
|
+
# your desired number of tasks across your cluster. By default, the
|
|
687
|
+
# service scheduler spreads tasks across Availability Zones. You can
|
|
688
|
+
# use task placement strategies and constraints to customize task
|
|
689
|
+
# placement decisions. For more information, see [Service Scheduler
|
|
690
|
+
# Concepts][2] in the *Amazon Elastic Container Service Developer
|
|
691
|
+
# Guide*.
|
|
680
692
|
#
|
|
681
693
|
# * `DAEMON` - The daemon scheduling strategy deploys exactly one task
|
|
682
694
|
# on each active container instance that meets all of the task
|
|
683
695
|
# placement constraints that you specify in your cluster. The service
|
|
684
696
|
# scheduler also evaluates the task placement constraints for running
|
|
685
|
-
# tasks
|
|
697
|
+
# tasks. It also stops tasks that don't meet the placement
|
|
686
698
|
# constraints. When using this strategy, you don't need to specify a
|
|
687
699
|
# desired number of tasks, a task placement strategy, or use Service
|
|
688
700
|
# Auto Scaling policies. For more information, see [Service Scheduler
|
|
@@ -690,51 +702,53 @@ module Aws::ECS
|
|
|
690
702
|
# Guide*.
|
|
691
703
|
#
|
|
692
704
|
# You can optionally specify a deployment configuration for your
|
|
693
|
-
# service. The deployment is
|
|
694
|
-
# the
|
|
695
|
-
#
|
|
705
|
+
# service. The deployment is initiated by changing properties. For
|
|
706
|
+
# example, the deployment might be initiated by the task definition or
|
|
707
|
+
# by your desired count of a service. This is done with an UpdateService
|
|
708
|
+
# operation. The default value for a replica service for
|
|
696
709
|
# `minimumHealthyPercent` is 100%. The default value for a daemon
|
|
697
710
|
# service for `minimumHealthyPercent` is 0%.
|
|
698
711
|
#
|
|
699
|
-
# If a service
|
|
700
|
-
#
|
|
701
|
-
#
|
|
702
|
-
# as a percentage of
|
|
703
|
-
# nearest integer)
|
|
704
|
-
# `DRAINING` state if the service
|
|
705
|
-
#
|
|
706
|
-
# cluster capacity. For example, if
|
|
707
|
-
#
|
|
708
|
-
#
|
|
709
|
-
#
|
|
710
|
-
#
|
|
711
|
-
#
|
|
712
|
-
#
|
|
713
|
-
#
|
|
714
|
-
# 100%.
|
|
715
|
-
#
|
|
716
|
-
# If a service
|
|
712
|
+
# If a service uses the `ECS` deployment controller, the minimum healthy
|
|
713
|
+
# percent represents a lower limit on the number of tasks in a service
|
|
714
|
+
# that must remain in the `RUNNING` state during a deployment.
|
|
715
|
+
# Specifically, it represents it as a percentage of your desired number
|
|
716
|
+
# of tasks (rounded up to the nearest integer). This happens when any of
|
|
717
|
+
# your container instances are in the `DRAINING` state if the service
|
|
718
|
+
# contains tasks using the EC2 launch type. Using this parameter, you
|
|
719
|
+
# can deploy without using additional cluster capacity. For example, if
|
|
720
|
+
# you set your service to have desired number of four tasks and a
|
|
721
|
+
# minimum healthy percent of 50%, the scheduler might stop two existing
|
|
722
|
+
# tasks to free up cluster capacity before starting two new tasks. If
|
|
723
|
+
# they're in the `RUNNING` state, tasks for services that don't use a
|
|
724
|
+
# load balancer are considered healthy . If they're in the `RUNNING`
|
|
725
|
+
# state and reported as healthy by the load balancer, tasks for services
|
|
726
|
+
# that *do* use a load balancer are considered healthy . The default
|
|
727
|
+
# value for minimum healthy percent is 100%.
|
|
728
|
+
#
|
|
729
|
+
# If a service uses the `ECS` deployment controller, the **maximum
|
|
717
730
|
# percent** parameter represents an upper limit on the number of tasks
|
|
718
731
|
# in a service that are allowed in the `RUNNING` or `PENDING` state
|
|
719
|
-
# during a deployment, as a percentage of
|
|
720
|
-
# (rounded down to the nearest integer)
|
|
721
|
-
#
|
|
722
|
-
#
|
|
723
|
-
#
|
|
724
|
-
#
|
|
725
|
-
# scheduler may start four new tasks
|
|
726
|
-
# tasks (provided that the cluster
|
|
727
|
-
# available). The default value for
|
|
728
|
-
#
|
|
729
|
-
#
|
|
730
|
-
#
|
|
731
|
-
#
|
|
732
|
-
#
|
|
733
|
-
#
|
|
732
|
+
# during a deployment. Specifically, it represents it as a percentage of
|
|
733
|
+
# the desired number of tasks (rounded down to the nearest integer).
|
|
734
|
+
# This happens when any of your container instances are in the
|
|
735
|
+
# `DRAINING` state if the service contains tasks using the EC2 launch
|
|
736
|
+
# type. Using this parameter, you can define the deployment batch size.
|
|
737
|
+
# For example, if your service has a desired number of four tasks and a
|
|
738
|
+
# maximum percent value of 200%, the scheduler may start four new tasks
|
|
739
|
+
# before stopping the four older tasks (provided that the cluster
|
|
740
|
+
# resources required to do this are available). The default value for
|
|
741
|
+
# maximum percent is 200%.
|
|
742
|
+
#
|
|
743
|
+
# If a service uses either the `CODE_DEPLOY` or `EXTERNAL` deployment
|
|
744
|
+
# controller types and tasks that use the EC2 launch type, the **minimum
|
|
745
|
+
# healthy percent** and **maximum percent** values are used only to
|
|
746
|
+
# define the lower and upper limit on the number of the tasks in the
|
|
747
|
+
# service that remain in the `RUNNING` state. This is while the
|
|
734
748
|
# container instances are in the `DRAINING` state. If the tasks in the
|
|
735
749
|
# service use the Fargate launch type, the minimum healthy percent and
|
|
736
|
-
# maximum percent values aren't used
|
|
737
|
-
# visible when describing your service.
|
|
750
|
+
# maximum percent values aren't used. This is the case even if they're
|
|
751
|
+
# currently visible when describing your service.
|
|
738
752
|
#
|
|
739
753
|
# When creating a service that uses the `EXTERNAL` deployment
|
|
740
754
|
# controller, you can specify only parameters that aren't controlled at
|
|
@@ -747,13 +761,13 @@ module Aws::ECS
|
|
|
747
761
|
# placement in your cluster using the following logic:
|
|
748
762
|
#
|
|
749
763
|
# * Determine which of the container instances in your cluster can
|
|
750
|
-
# support
|
|
751
|
-
# required CPU, memory, ports, and container instance attributes
|
|
764
|
+
# support the task definition of your service. For example, they have
|
|
765
|
+
# the required CPU, memory, ports, and container instance attributes.
|
|
752
766
|
#
|
|
753
767
|
# * By default, the service scheduler attempts to balance tasks across
|
|
754
|
-
# Availability Zones in this manner
|
|
755
|
-
# different placement strategy
|
|
756
|
-
# parameter
|
|
768
|
+
# Availability Zones in this manner. This is the case even if you can
|
|
769
|
+
# choose a different placement strategy with the `placementStrategy`
|
|
770
|
+
# parameter.
|
|
757
771
|
#
|
|
758
772
|
# * Sort the valid container instances, giving priority to instances
|
|
759
773
|
# that have the fewest number of running tasks for this service in
|
|
@@ -763,7 +777,7 @@ module Aws::ECS
|
|
|
763
777
|
# for placement.
|
|
764
778
|
#
|
|
765
779
|
# * Place the new service task on a valid container instance in an
|
|
766
|
-
# optimal Availability Zone
|
|
780
|
+
# optimal Availability Zone based on the previous steps, favoring
|
|
767
781
|
# container instances with the fewest number of running tasks for
|
|
768
782
|
# this service.
|
|
769
783
|
#
|
|
@@ -774,9 +788,9 @@ module Aws::ECS
|
|
|
774
788
|
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html
|
|
775
789
|
#
|
|
776
790
|
# @option params [String] :cluster
|
|
777
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
778
|
-
#
|
|
779
|
-
#
|
|
791
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
792
|
+
# you run your service on. If you do not specify a cluster, the default
|
|
793
|
+
# cluster is assumed.
|
|
780
794
|
#
|
|
781
795
|
# @option params [required, String] :service_name
|
|
782
796
|
# The name of your service. Up to 255 letters (uppercase and lowercase),
|
|
@@ -786,10 +800,10 @@ module Aws::ECS
|
|
|
786
800
|
#
|
|
787
801
|
# @option params [String] :task_definition
|
|
788
802
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
|
789
|
-
# task definition to run in your service. If a `revision`
|
|
803
|
+
# task definition to run in your service. If a `revision` isn't
|
|
790
804
|
# specified, the latest `ACTIVE` revision is used.
|
|
791
805
|
#
|
|
792
|
-
# A task definition must be specified if the service
|
|
806
|
+
# A task definition must be specified if the service uses either the
|
|
793
807
|
# `ECS` or `CODE_DEPLOY` deployment controllers.
|
|
794
808
|
#
|
|
795
809
|
# @option params [Array<Types::LoadBalancer>] :load_balancers
|
|
@@ -797,54 +811,56 @@ module Aws::ECS
|
|
|
797
811
|
# your service. For more information, see [Service Load Balancing][1] in
|
|
798
812
|
# the *Amazon Elastic Container Service Developer Guide*.
|
|
799
813
|
#
|
|
800
|
-
# If the service
|
|
801
|
-
#
|
|
802
|
-
#
|
|
803
|
-
#
|
|
804
|
-
#
|
|
805
|
-
#
|
|
806
|
-
#
|
|
814
|
+
# If the service uses the rolling update (`ECS`) deployment controller
|
|
815
|
+
# and using either an Application Load Balancer or Network Load
|
|
816
|
+
# Balancer, you must specify one or more target group ARNs to attach to
|
|
817
|
+
# the service. The service-linked role is required for services that use
|
|
818
|
+
# multiple target groups. For more information, see [Using
|
|
819
|
+
# service-linked roles for Amazon ECS][2] in the *Amazon Elastic
|
|
820
|
+
# Container Service Developer Guide*.
|
|
807
821
|
#
|
|
808
|
-
# If the service
|
|
822
|
+
# If the service uses the `CODE_DEPLOY` deployment controller, the
|
|
809
823
|
# service is required to use either an Application Load Balancer or
|
|
810
824
|
# Network Load Balancer. When creating an CodeDeploy deployment group,
|
|
811
825
|
# you specify two target groups (referred to as a `targetGroupPair`).
|
|
812
826
|
# During a deployment, CodeDeploy determines which task set in your
|
|
813
|
-
# service has the status `PRIMARY
|
|
814
|
-
# it,
|
|
815
|
-
# task set. The load balancer can also have up to two
|
|
816
|
-
# required listener for production traffic and an optional
|
|
817
|
-
#
|
|
818
|
-
# routing production traffic to it.
|
|
827
|
+
# service has the status `PRIMARY`, and it associates one target group
|
|
828
|
+
# with it. Then, it also associates the other target group with the
|
|
829
|
+
# replacement task set. The load balancer can also have up to two
|
|
830
|
+
# listeners: a required listener for production traffic and an optional
|
|
831
|
+
# listener that you can use to perform validation tests with Lambda
|
|
832
|
+
# functions before routing production traffic to it.
|
|
819
833
|
#
|
|
820
834
|
# After you create a service using the `ECS` deployment controller, the
|
|
821
835
|
# load balancer name or target group ARN, container name, and container
|
|
822
|
-
# port specified in the service definition are immutable. If you
|
|
823
|
-
#
|
|
836
|
+
# port that's specified in the service definition are immutable. If you
|
|
837
|
+
# use the `CODE_DEPLOY` deployment controller, these values can be
|
|
824
838
|
# changed when updating the service.
|
|
825
839
|
#
|
|
826
840
|
# For Application Load Balancers and Network Load Balancers, this object
|
|
827
|
-
# must contain the load balancer target group ARN, the container name
|
|
828
|
-
#
|
|
829
|
-
#
|
|
830
|
-
# be omitted. When a task from this service
|
|
831
|
-
# instance, the container instance and port
|
|
832
|
-
# a target in the target group
|
|
841
|
+
# must contain the load balancer target group ARN, the container name,
|
|
842
|
+
# and the container port to access from the load balancer. The container
|
|
843
|
+
# name must be as it appears in a container definition. The load
|
|
844
|
+
# balancer name parameter must be omitted. When a task from this service
|
|
845
|
+
# is placed on a container instance, the container instance and port
|
|
846
|
+
# combination is registered as a target in the target group that's
|
|
847
|
+
# specified here.
|
|
833
848
|
#
|
|
834
849
|
# For Classic Load Balancers, this object must contain the load balancer
|
|
835
|
-
# name, the container name
|
|
836
|
-
#
|
|
837
|
-
# group ARN parameter must be omitted. When a
|
|
838
|
-
# placed on a container instance, the
|
|
839
|
-
# with the load balancer
|
|
850
|
+
# name, the container name , and the container port to access from the
|
|
851
|
+
# load balancer. The container name must be as it appears in a container
|
|
852
|
+
# definition. The target group ARN parameter must be omitted. When a
|
|
853
|
+
# task from this service is placed on a container instance, the
|
|
854
|
+
# container instance is registered with the load balancer that's
|
|
855
|
+
# specified here.
|
|
840
856
|
#
|
|
841
857
|
# Services with tasks that use the `awsvpc` network mode (for example,
|
|
842
858
|
# those with the Fargate launch type) only support Application Load
|
|
843
|
-
# Balancers and Network Load Balancers. Classic Load Balancers
|
|
859
|
+
# Balancers and Network Load Balancers. Classic Load Balancers aren't
|
|
844
860
|
# supported. Also, when you create any target groups for these services,
|
|
845
|
-
# you must choose `ip` as the target type, not `instance
|
|
846
|
-
# that use the `awsvpc` network mode are associated with
|
|
847
|
-
# network interface, not an Amazon EC2 instance.
|
|
861
|
+
# you must choose `ip` as the target type, not `instance`. This is
|
|
862
|
+
# because tasks that use the `awsvpc` network mode are associated with
|
|
863
|
+
# an elastic network interface, not an Amazon EC2 instance.
|
|
848
864
|
#
|
|
849
865
|
#
|
|
850
866
|
#
|
|
@@ -856,7 +872,7 @@ module Aws::ECS
|
|
|
856
872
|
# service. For more information, see [Service discovery][1].
|
|
857
873
|
#
|
|
858
874
|
# <note markdown="1"> Each service may be associated with one service registry. Multiple
|
|
859
|
-
# service registries
|
|
875
|
+
# service registries for each service isn't supported.
|
|
860
876
|
#
|
|
861
877
|
# </note>
|
|
862
878
|
#
|
|
@@ -868,16 +884,17 @@ module Aws::ECS
|
|
|
868
884
|
# The number of instantiations of the specified task definition to place
|
|
869
885
|
# and keep running on your cluster.
|
|
870
886
|
#
|
|
871
|
-
# This is required if `schedulingStrategy` is `REPLICA` or
|
|
872
|
-
# specified. If `schedulingStrategy` is `DAEMON` then this
|
|
887
|
+
# This is required if `schedulingStrategy` is `REPLICA` or isn't
|
|
888
|
+
# specified. If `schedulingStrategy` is `DAEMON` then this isn't
|
|
873
889
|
# required.
|
|
874
890
|
#
|
|
875
891
|
# @option params [String] :client_token
|
|
876
|
-
#
|
|
877
|
-
#
|
|
892
|
+
# An identifier that you provide to ensure the idempotency of the
|
|
893
|
+
# request. It must be unique and is case sensitive. Up to 32 ASCII
|
|
894
|
+
# characters are allowed.
|
|
878
895
|
#
|
|
879
896
|
# @option params [String] :launch_type
|
|
880
|
-
# The infrastructure
|
|
897
|
+
# The infrastructure that you run your service on. For more information,
|
|
881
898
|
# see [Amazon ECS launch types][1] in the *Amazon Elastic Container
|
|
882
899
|
# Service Developer Guide*.
|
|
883
900
|
#
|
|
@@ -893,7 +910,7 @@ module Aws::ECS
|
|
|
893
910
|
# The `EC2` launch type runs your tasks on Amazon EC2 instances
|
|
894
911
|
# registered to your cluster.
|
|
895
912
|
#
|
|
896
|
-
# The `EXTERNAL` launch type runs your tasks on your on-
|
|
913
|
+
# The `EXTERNAL` launch type runs your tasks on your on-premises server
|
|
897
914
|
# or virtual machine (VM) capacity registered to your cluster.
|
|
898
915
|
#
|
|
899
916
|
# A service can use either a launch type or a capacity provider
|
|
@@ -919,9 +936,9 @@ module Aws::ECS
|
|
|
919
936
|
# @option params [String] :platform_version
|
|
920
937
|
# The platform version that your tasks in the service are running on. A
|
|
921
938
|
# platform version is specified only for tasks using the Fargate launch
|
|
922
|
-
# type. If one isn't specified, the `LATEST` platform version is used
|
|
923
|
-
#
|
|
924
|
-
#
|
|
939
|
+
# type. If one isn't specified, the `LATEST` platform version is used.
|
|
940
|
+
# For more information, see [Fargate platform versions][1] in the
|
|
941
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
|
925
942
|
#
|
|
926
943
|
#
|
|
927
944
|
#
|
|
@@ -931,19 +948,19 @@ module Aws::ECS
|
|
|
931
948
|
# The name or full Amazon Resource Name (ARN) of the IAM role that
|
|
932
949
|
# allows Amazon ECS to make calls to your load balancer on your behalf.
|
|
933
950
|
# This parameter is only permitted if you are using a load balancer with
|
|
934
|
-
# your service and your task definition
|
|
951
|
+
# your service and your task definition doesn't use the `awsvpc`
|
|
935
952
|
# network mode. If you specify the `role` parameter, you must also
|
|
936
953
|
# specify a load balancer object with the `loadBalancers` parameter.
|
|
937
954
|
#
|
|
938
955
|
# If your account has already created the Amazon ECS service-linked
|
|
939
|
-
# role, that role is used
|
|
940
|
-
#
|
|
941
|
-
#
|
|
942
|
-
#
|
|
943
|
-
#
|
|
944
|
-
#
|
|
945
|
-
#
|
|
946
|
-
#
|
|
956
|
+
# role, that role is used for your service unless you specify a role
|
|
957
|
+
# here. The service-linked role is required if your task definition uses
|
|
958
|
+
# the `awsvpc` network mode or if the service is configured to use
|
|
959
|
+
# service discovery, an external deployment controller, multiple target
|
|
960
|
+
# groups, or Elastic Inference accelerators in which case you don't
|
|
961
|
+
# specify a role here. For more information, see [Using service-linked
|
|
962
|
+
# roles for Amazon ECS][1] in the *Amazon Elastic Container Service
|
|
963
|
+
# Developer Guide*.
|
|
947
964
|
#
|
|
948
965
|
# If your specified role has a path other than `/`, then you must either
|
|
949
966
|
# specify the full role ARN (this is recommended) or prefix the role
|
|
@@ -963,18 +980,18 @@ module Aws::ECS
|
|
|
963
980
|
#
|
|
964
981
|
# @option params [Array<Types::PlacementConstraint>] :placement_constraints
|
|
965
982
|
# An array of placement constraint objects to use for tasks in your
|
|
966
|
-
# service. You can specify a maximum of 10 constraints
|
|
967
|
-
# limit includes constraints in the task definition and those
|
|
968
|
-
# at runtime
|
|
983
|
+
# service. You can specify a maximum of 10 constraints for each task.
|
|
984
|
+
# This limit includes constraints in the task definition and those
|
|
985
|
+
# specified at runtime.
|
|
969
986
|
#
|
|
970
987
|
# @option params [Array<Types::PlacementStrategy>] :placement_strategy
|
|
971
988
|
# The placement strategy objects to use for tasks in your service. You
|
|
972
|
-
# can specify a maximum of 5 strategy rules
|
|
989
|
+
# can specify a maximum of 5 strategy rules for each service.
|
|
973
990
|
#
|
|
974
991
|
# @option params [Types::NetworkConfiguration] :network_configuration
|
|
975
992
|
# The network configuration for the service. This parameter is required
|
|
976
993
|
# for task definitions that use the `awsvpc` network mode to receive
|
|
977
|
-
# their own elastic network interface, and it
|
|
994
|
+
# their own elastic network interface, and it isn't supported for other
|
|
978
995
|
# network modes. For more information, see [Task networking][1] in the
|
|
979
996
|
# *Amazon Elastic Container Service Developer Guide*.
|
|
980
997
|
#
|
|
@@ -984,18 +1001,18 @@ module Aws::ECS
|
|
|
984
1001
|
#
|
|
985
1002
|
# @option params [Integer] :health_check_grace_period_seconds
|
|
986
1003
|
# The period of time, in seconds, that the Amazon ECS service scheduler
|
|
987
|
-
#
|
|
988
|
-
#
|
|
1004
|
+
# ignores unhealthy Elastic Load Balancing target health checks after a
|
|
1005
|
+
# task has first started. This is only used when your service is
|
|
989
1006
|
# configured to use a load balancer. If your service has a load balancer
|
|
990
1007
|
# defined and you don't specify a health check grace period value, the
|
|
991
1008
|
# default value of `0` is used.
|
|
992
1009
|
#
|
|
993
1010
|
# If your service's tasks take a while to start and respond to Elastic
|
|
994
1011
|
# Load Balancing health checks, you can specify a health check grace
|
|
995
|
-
# period of up to 2,147,483,647 seconds. During that
|
|
996
|
-
# ECS service scheduler ignores health check status.
|
|
997
|
-
# can prevent the service scheduler from marking tasks
|
|
998
|
-
# stopping them before they have time to come up.
|
|
1012
|
+
# period of up to 2,147,483,647 seconds (about 69 years). During that
|
|
1013
|
+
# time, the Amazon ECS service scheduler ignores health check status.
|
|
1014
|
+
# This grace period can prevent the service scheduler from marking tasks
|
|
1015
|
+
# as unhealthy and stopping them before they have time to come up.
|
|
999
1016
|
#
|
|
1000
1017
|
# @option params [String] :scheduling_strategy
|
|
1001
1018
|
# The scheduling strategy to use for the service. For more information,
|
|
@@ -1007,14 +1024,14 @@ module Aws::ECS
|
|
|
1007
1024
|
# desired number of tasks across your cluster. By default, the service
|
|
1008
1025
|
# scheduler spreads tasks across Availability Zones. You can use task
|
|
1009
1026
|
# placement strategies and constraints to customize task placement
|
|
1010
|
-
# decisions. This scheduler strategy is required if the service
|
|
1011
|
-
#
|
|
1027
|
+
# decisions. This scheduler strategy is required if the service uses
|
|
1028
|
+
# the `CODE_DEPLOY` or `EXTERNAL` deployment controller types.
|
|
1012
1029
|
#
|
|
1013
1030
|
# * `DAEMON`-The daemon scheduling strategy deploys exactly one task on
|
|
1014
1031
|
# each active container instance that meets all of the task placement
|
|
1015
1032
|
# constraints that you specify in your cluster. The service scheduler
|
|
1016
1033
|
# also evaluates the task placement constraints for running tasks and
|
|
1017
|
-
# will stop tasks that
|
|
1034
|
+
# will stop tasks that don't meet the placement constraints. When
|
|
1018
1035
|
# you're using this strategy, you don't need to specify a desired
|
|
1019
1036
|
# number of tasks, a task placement strategy, or use Service Auto
|
|
1020
1037
|
# Scaling policies.
|
|
@@ -1077,15 +1094,15 @@ module Aws::ECS
|
|
|
1077
1094
|
# @option params [String] :propagate_tags
|
|
1078
1095
|
# Specifies whether to propagate the tags from the task definition or
|
|
1079
1096
|
# the service to the tasks in the service. If no value is specified, the
|
|
1080
|
-
# tags
|
|
1097
|
+
# tags aren't propagated. Tags can only be propagated to the tasks
|
|
1081
1098
|
# within the service during service creation. To add tags to a task
|
|
1082
1099
|
# after service creation or task creation, use the TagResource API
|
|
1083
1100
|
# action.
|
|
1084
1101
|
#
|
|
1085
1102
|
# @option params [Boolean] :enable_execute_command
|
|
1086
|
-
#
|
|
1087
|
-
# service. If `true`, this enables execute command functionality on
|
|
1088
|
-
# containers in the service tasks.
|
|
1103
|
+
# Determines whether the execute command functionality is enabled for
|
|
1104
|
+
# the service. If `true`, this enables execute command functionality on
|
|
1105
|
+
# all containers in the service tasks.
|
|
1089
1106
|
#
|
|
1090
1107
|
# @return [Types::CreateServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1091
1108
|
#
|
|
@@ -1465,7 +1482,7 @@ module Aws::ECS
|
|
|
1465
1482
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html
|
|
1466
1483
|
#
|
|
1467
1484
|
# @option params [String] :launch_type
|
|
1468
|
-
# The launch type that new tasks in the task set
|
|
1485
|
+
# The launch type that new tasks in the task set uses. For more
|
|
1469
1486
|
# information, see [Amazon ECS Launch Types][1] in the *Amazon Elastic
|
|
1470
1487
|
# Container Service Developer Guide*.
|
|
1471
1488
|
#
|
|
@@ -1505,24 +1522,23 @@ module Aws::ECS
|
|
|
1505
1522
|
# is created.
|
|
1506
1523
|
#
|
|
1507
1524
|
# @option params [String] :platform_version
|
|
1508
|
-
# The platform version that the tasks in the task set
|
|
1509
|
-
#
|
|
1510
|
-
#
|
|
1511
|
-
# by default.
|
|
1525
|
+
# The platform version that the tasks in the task set uses. A platform
|
|
1526
|
+
# version is specified only for tasks using the Fargate launch type. If
|
|
1527
|
+
# one isn't specified, the `LATEST` platform version is used.
|
|
1512
1528
|
#
|
|
1513
1529
|
# @option params [Types::Scale] :scale
|
|
1514
1530
|
# A floating-point percentage of the desired number of tasks to place
|
|
1515
1531
|
# and keep running in the task set.
|
|
1516
1532
|
#
|
|
1517
1533
|
# @option params [String] :client_token
|
|
1518
|
-
#
|
|
1519
|
-
#
|
|
1534
|
+
# The identifier that you provide to ensure the idempotency of the
|
|
1535
|
+
# request. It's case sensitive and must be unique. It can be up to 32
|
|
1536
|
+
# ASCII characters are allowed.
|
|
1520
1537
|
#
|
|
1521
1538
|
# @option params [Array<Types::Tag>] :tags
|
|
1522
1539
|
# The metadata that you apply to the task set to help you categorize and
|
|
1523
|
-
# organize them. Each tag consists of a key and an optional value
|
|
1524
|
-
#
|
|
1525
|
-
# as well.
|
|
1540
|
+
# organize them. Each tag consists of a key and an optional value. You
|
|
1541
|
+
# define both. When a service is deleted, the tags are deleted.
|
|
1526
1542
|
#
|
|
1527
1543
|
# The following basic restrictions apply to tags:
|
|
1528
1544
|
#
|
|
@@ -1663,7 +1679,7 @@ module Aws::ECS
|
|
|
1663
1679
|
# root user for an account.
|
|
1664
1680
|
#
|
|
1665
1681
|
# @option params [required, String] :name
|
|
1666
|
-
# The resource name
|
|
1682
|
+
# The resource name to disable the account setting for. If
|
|
1667
1683
|
# `serviceLongArnFormat` is specified, the ARN for your Amazon ECS
|
|
1668
1684
|
# services is affected. If `taskLongArnFormat` is specified, the ARN and
|
|
1669
1685
|
# resource ID for your Amazon ECS tasks is affected. If
|
|
@@ -1673,12 +1689,12 @@ module Aws::ECS
|
|
|
1673
1689
|
# container instances is affected.
|
|
1674
1690
|
#
|
|
1675
1691
|
# @option params [String] :principal_arn
|
|
1676
|
-
# The ARN of the principal
|
|
1677
|
-
# root user. If you specify the root user, it
|
|
1678
|
-
# setting for all IAM users, IAM roles, and the
|
|
1679
|
-
# unless an IAM user or role explicitly
|
|
1680
|
-
# this field is omitted, the setting is
|
|
1681
|
-
# authenticated user.
|
|
1692
|
+
# The Amazon Resource Name (ARN) of the principal. It can be an IAM
|
|
1693
|
+
# user, IAM role, or the root user. If you specify the root user, it
|
|
1694
|
+
# disables the account setting for all IAM users, IAM roles, and the
|
|
1695
|
+
# root user of the account unless an IAM user or role explicitly
|
|
1696
|
+
# overrides these settings. If this field is omitted, the setting is
|
|
1697
|
+
# changed only for the authenticated user.
|
|
1682
1698
|
#
|
|
1683
1699
|
# @return [Types::DeleteAccountSettingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1684
1700
|
#
|
|
@@ -1752,9 +1768,10 @@ module Aws::ECS
|
|
|
1752
1768
|
#
|
|
1753
1769
|
# @option params [required, Array<Types::Attribute>] :attributes
|
|
1754
1770
|
# The attributes to delete from your resource. You can specify up to 10
|
|
1755
|
-
# attributes
|
|
1756
|
-
# name and target ID, but
|
|
1757
|
-
# target ID using the short form, you must also specify the
|
|
1771
|
+
# attributes for each request. For custom attributes, specify the
|
|
1772
|
+
# attribute name and target ID, but don't specify the value. If you
|
|
1773
|
+
# specify the target ID using the short form, you must also specify the
|
|
1774
|
+
# target type.
|
|
1758
1775
|
#
|
|
1759
1776
|
# @return [Types::DeleteAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1760
1777
|
#
|
|
@@ -1794,7 +1811,7 @@ module Aws::ECS
|
|
|
1794
1811
|
# Deletes the specified capacity provider.
|
|
1795
1812
|
#
|
|
1796
1813
|
# <note markdown="1"> The `FARGATE` and `FARGATE_SPOT` capacity providers are reserved and
|
|
1797
|
-
#
|
|
1814
|
+
# can't be deleted. You can disassociate them from a cluster using
|
|
1798
1815
|
# either the PutClusterCapacityProviders API or by deleting the cluster.
|
|
1799
1816
|
#
|
|
1800
1817
|
# </note>
|
|
@@ -1806,7 +1823,7 @@ module Aws::ECS
|
|
|
1806
1823
|
# `forceNewDeployment` option can be used to ensure that any tasks using
|
|
1807
1824
|
# the Amazon EC2 instance capacity provided by the capacity provider are
|
|
1808
1825
|
# transitioned to use the capacity from the remaining capacity
|
|
1809
|
-
# providers. Only capacity providers that
|
|
1826
|
+
# providers. Only capacity providers that aren't associated with a
|
|
1810
1827
|
# cluster can be deleted. To remove a capacity provider from a cluster,
|
|
1811
1828
|
# you can either use PutClusterCapacityProviders or delete the cluster.
|
|
1812
1829
|
#
|
|
@@ -1851,11 +1868,11 @@ module Aws::ECS
|
|
|
1851
1868
|
req.send_request(options)
|
|
1852
1869
|
end
|
|
1853
1870
|
|
|
1854
|
-
# Deletes the specified cluster. The cluster
|
|
1855
|
-
# `INACTIVE` state. Clusters with an `INACTIVE` status
|
|
1871
|
+
# Deletes the specified cluster. The cluster transitions to the
|
|
1872
|
+
# `INACTIVE` state. Clusters with an `INACTIVE` status might remain
|
|
1856
1873
|
# discoverable in your account for a period of time. However, this
|
|
1857
|
-
# behavior is subject to change in the future
|
|
1858
|
-
# `INACTIVE` clusters persisting.
|
|
1874
|
+
# behavior is subject to change in the future. We don't recommend that
|
|
1875
|
+
# you rely on `INACTIVE` clusters persisting.
|
|
1859
1876
|
#
|
|
1860
1877
|
# You must deregister all container instances from this cluster before
|
|
1861
1878
|
# you may delete it. You can list the container instances in a cluster
|
|
@@ -1949,7 +1966,7 @@ module Aws::ECS
|
|
|
1949
1966
|
|
|
1950
1967
|
# Deletes a specified service within a cluster. You can delete a service
|
|
1951
1968
|
# if you have no running tasks in it and the desired task count is zero.
|
|
1952
|
-
# If the service is actively maintaining tasks, you
|
|
1969
|
+
# If the service is actively maintaining tasks, you can't delete it,
|
|
1953
1970
|
# and you must update the service to a desired task count of zero. For
|
|
1954
1971
|
# more information, see UpdateService.
|
|
1955
1972
|
#
|
|
@@ -1979,9 +1996,9 @@ module Aws::ECS
|
|
|
1979
1996
|
# The name of the service to delete.
|
|
1980
1997
|
#
|
|
1981
1998
|
# @option params [Boolean] :force
|
|
1982
|
-
# If `true`, allows you to delete a service even if it
|
|
1983
|
-
#
|
|
1984
|
-
#
|
|
1999
|
+
# If `true`, allows you to delete a service even if it wasn't scaled
|
|
2000
|
+
# down to zero tasks. It's only necessary to use this if the service
|
|
2001
|
+
# uses the `REPLICA` scheduling strategy.
|
|
1985
2002
|
#
|
|
1986
2003
|
# @return [Types::DeleteServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1987
2004
|
#
|
|
@@ -2155,7 +2172,7 @@ module Aws::ECS
|
|
|
2155
2172
|
#
|
|
2156
2173
|
# @option params [required, String] :cluster
|
|
2157
2174
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
2158
|
-
# hosts the service that the task set
|
|
2175
|
+
# hosts the service that the task set found in to delete.
|
|
2159
2176
|
#
|
|
2160
2177
|
# @option params [required, String] :service
|
|
2161
2178
|
# The short name or full Amazon Resource Name (ARN) of the service that
|
|
@@ -2166,8 +2183,8 @@ module Aws::ECS
|
|
|
2166
2183
|
# delete.
|
|
2167
2184
|
#
|
|
2168
2185
|
# @option params [Boolean] :force
|
|
2169
|
-
# If `true`,
|
|
2170
|
-
#
|
|
2186
|
+
# If `true`, you can delete a task set even if it hasn't been scaled
|
|
2187
|
+
# down to zero.
|
|
2171
2188
|
#
|
|
2172
2189
|
# @return [Types::DeleteTaskSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2173
2190
|
#
|
|
@@ -2240,18 +2257,18 @@ module Aws::ECS
|
|
|
2240
2257
|
# cluster. This instance is no longer available to run tasks.
|
|
2241
2258
|
#
|
|
2242
2259
|
# If you intend to use the container instance for some other purpose
|
|
2243
|
-
# after deregistration, you
|
|
2244
|
-
# container instance before deregistration. That prevents
|
|
2245
|
-
# tasks from consuming resources.
|
|
2260
|
+
# after deregistration, we recommend that you stop all of the tasks
|
|
2261
|
+
# running on the container instance before deregistration. That prevents
|
|
2262
|
+
# any orphaned tasks from consuming resources.
|
|
2246
2263
|
#
|
|
2247
2264
|
# Deregistering a container instance removes the instance from a
|
|
2248
|
-
# cluster, but it
|
|
2265
|
+
# cluster, but it doesn't terminate the EC2 instance. If you are
|
|
2249
2266
|
# finished using the instance, be sure to terminate it in the Amazon EC2
|
|
2250
2267
|
# console to stop billing.
|
|
2251
2268
|
#
|
|
2252
2269
|
# <note markdown="1"> If you terminate a running container instance, Amazon ECS
|
|
2253
2270
|
# automatically deregisters the instance from your cluster (stopped
|
|
2254
|
-
# container instances or instances with disconnected agents
|
|
2271
|
+
# container instances or instances with disconnected agents aren't
|
|
2255
2272
|
# automatically deregistered when terminated).
|
|
2256
2273
|
#
|
|
2257
2274
|
# </note>
|
|
@@ -2270,10 +2287,10 @@ module Aws::ECS
|
|
|
2270
2287
|
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
|
2271
2288
|
#
|
|
2272
2289
|
# @option params [Boolean] :force
|
|
2273
|
-
# Forces the
|
|
2290
|
+
# Forces the container instance to be deregistered. If you have tasks
|
|
2274
2291
|
# running on the container instance when you deregister it with the
|
|
2275
2292
|
# `force` option, these tasks remain running until you terminate the
|
|
2276
|
-
# instance or the tasks stop through some other means, but they
|
|
2293
|
+
# instance or the tasks stop through some other means, but they're
|
|
2277
2294
|
# orphaned (no longer monitored or accounted for by Amazon ECS). If an
|
|
2278
2295
|
# orphaned task on your container instance is part of an Amazon ECS
|
|
2279
2296
|
# service, then the service scheduler starts another copy of that task,
|
|
@@ -2359,6 +2376,12 @@ module Aws::ECS
|
|
|
2359
2376
|
# resp.container_instance.tags #=> Array
|
|
2360
2377
|
# resp.container_instance.tags[0].key #=> String
|
|
2361
2378
|
# resp.container_instance.tags[0].value #=> String
|
|
2379
|
+
# resp.container_instance.health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
2380
|
+
# resp.container_instance.health_status.details #=> Array
|
|
2381
|
+
# resp.container_instance.health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
|
|
2382
|
+
# resp.container_instance.health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
2383
|
+
# resp.container_instance.health_status.details[0].last_updated #=> Time
|
|
2384
|
+
# resp.container_instance.health_status.details[0].last_status_change #=> Time
|
|
2362
2385
|
#
|
|
2363
2386
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterContainerInstance AWS API Documentation
|
|
2364
2387
|
#
|
|
@@ -2376,16 +2399,17 @@ module Aws::ECS
|
|
|
2376
2399
|
# an `INACTIVE` task definition can still scale up or down by modifying
|
|
2377
2400
|
# the service's desired count.
|
|
2378
2401
|
#
|
|
2379
|
-
# You
|
|
2380
|
-
# create new services, and you
|
|
2402
|
+
# You can't use an `INACTIVE` task definition to run new tasks or
|
|
2403
|
+
# create new services, and you can't update an existing service to
|
|
2381
2404
|
# reference an `INACTIVE` task definition. However, there may be up to a
|
|
2382
2405
|
# 10-minute window following deregistration where these restrictions
|
|
2383
2406
|
# have not yet taken effect.
|
|
2384
2407
|
#
|
|
2385
2408
|
# <note markdown="1"> At this time, `INACTIVE` task definitions remain discoverable in your
|
|
2386
2409
|
# account indefinitely. However, this behavior is subject to change in
|
|
2387
|
-
# the future
|
|
2388
|
-
# persisting beyond the lifecycle of any associated tasks
|
|
2410
|
+
# the future. We don't recommend that you rely on `INACTIVE` task
|
|
2411
|
+
# definitions persisting beyond the lifecycle of any associated tasks
|
|
2412
|
+
# and services.
|
|
2389
2413
|
#
|
|
2390
2414
|
# </note>
|
|
2391
2415
|
#
|
|
@@ -2584,7 +2608,7 @@ module Aws::ECS
|
|
|
2584
2608
|
# @option params [Array<String>] :include
|
|
2585
2609
|
# Specifies whether or not you want to see the resource tags for the
|
|
2586
2610
|
# capacity provider. If `TAGS` is specified, the tags are included in
|
|
2587
|
-
# the response. If this field is omitted, tags
|
|
2611
|
+
# the response. If this field is omitted, tags aren't included in the
|
|
2588
2612
|
# response.
|
|
2589
2613
|
#
|
|
2590
2614
|
# @option params [Integer] :max_results
|
|
@@ -2667,8 +2691,9 @@ module Aws::ECS
|
|
|
2667
2691
|
# assumed.
|
|
2668
2692
|
#
|
|
2669
2693
|
# @option params [Array<String>] :include
|
|
2670
|
-
#
|
|
2671
|
-
# response. If this field is omitted, this information
|
|
2694
|
+
# Determines whether to include additional information about the
|
|
2695
|
+
# clusters in the response. If this field is omitted, this information
|
|
2696
|
+
# isn't included.
|
|
2672
2697
|
#
|
|
2673
2698
|
# If `ATTACHMENTS` is specified, the attachments for the container
|
|
2674
2699
|
# instances or tasks within the cluster are included.
|
|
@@ -2791,7 +2816,9 @@ module Aws::ECS
|
|
|
2791
2816
|
# @option params [Array<String>] :include
|
|
2792
2817
|
# Specifies whether you want to see the resource tags for the container
|
|
2793
2818
|
# instance. If `TAGS` is specified, the tags are included in the
|
|
2794
|
-
# response. If
|
|
2819
|
+
# response. If `CONTAINER_INSTANCE_HEALTH` is specified, the container
|
|
2820
|
+
# instance health is included in the response. If this field is omitted,
|
|
2821
|
+
# tags and container instance health status aren't included in the
|
|
2795
2822
|
# response.
|
|
2796
2823
|
#
|
|
2797
2824
|
# @return [Types::DescribeContainerInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -2892,7 +2919,7 @@ module Aws::ECS
|
|
|
2892
2919
|
# resp = client.describe_container_instances({
|
|
2893
2920
|
# cluster: "String",
|
|
2894
2921
|
# container_instances: ["String"], # required
|
|
2895
|
-
# include: ["TAGS"], # accepts TAGS
|
|
2922
|
+
# include: ["TAGS"], # accepts TAGS, CONTAINER_INSTANCE_HEALTH
|
|
2896
2923
|
# })
|
|
2897
2924
|
#
|
|
2898
2925
|
# @example Response structure
|
|
@@ -2943,6 +2970,12 @@ module Aws::ECS
|
|
|
2943
2970
|
# resp.container_instances[0].tags #=> Array
|
|
2944
2971
|
# resp.container_instances[0].tags[0].key #=> String
|
|
2945
2972
|
# resp.container_instances[0].tags[0].value #=> String
|
|
2973
|
+
# resp.container_instances[0].health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
2974
|
+
# resp.container_instances[0].health_status.details #=> Array
|
|
2975
|
+
# resp.container_instances[0].health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
|
|
2976
|
+
# resp.container_instances[0].health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
2977
|
+
# resp.container_instances[0].health_status.details[0].last_updated #=> Time
|
|
2978
|
+
# resp.container_instances[0].health_status.details[0].last_status_change #=> Time
|
|
2946
2979
|
# resp.failures #=> Array
|
|
2947
2980
|
# resp.failures[0].arn #=> String
|
|
2948
2981
|
# resp.failures[0].reason #=> String
|
|
@@ -2971,9 +3004,9 @@ module Aws::ECS
|
|
|
2971
3004
|
# describe in a single operation.
|
|
2972
3005
|
#
|
|
2973
3006
|
# @option params [Array<String>] :include
|
|
2974
|
-
#
|
|
3007
|
+
# Determines whether you want to see the resource tags for the service.
|
|
2975
3008
|
# If `TAGS` is specified, the tags are included in the response. If this
|
|
2976
|
-
# field is omitted, tags
|
|
3009
|
+
# field is omitted, tags aren't included in the response.
|
|
2977
3010
|
#
|
|
2978
3011
|
# @return [Types::DescribeServicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2979
3012
|
#
|
|
@@ -3205,9 +3238,9 @@ module Aws::ECS
|
|
|
3205
3238
|
# Amazon Resource Name (ARN) of the task definition to describe.
|
|
3206
3239
|
#
|
|
3207
3240
|
# @option params [Array<String>] :include
|
|
3208
|
-
#
|
|
3209
|
-
# `TAGS` is specified, the tags are included in the response. If this
|
|
3210
|
-
# field is omitted, tags
|
|
3241
|
+
# Determines whether to see the resource tags for the task definition.
|
|
3242
|
+
# If `TAGS` is specified, the tags are included in the response. If this
|
|
3243
|
+
# field is omitted, tags aren't included in the response.
|
|
3211
3244
|
#
|
|
3212
3245
|
# @return [Types::DescribeTaskDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3213
3246
|
#
|
|
@@ -3480,7 +3513,7 @@ module Aws::ECS
|
|
|
3480
3513
|
# @option params [Array<String>] :include
|
|
3481
3514
|
# Specifies whether to see the resource tags for the task set. If `TAGS`
|
|
3482
3515
|
# is specified, the tags are included in the response. If this field is
|
|
3483
|
-
# omitted, tags
|
|
3516
|
+
# omitted, tags aren't included in the response.
|
|
3484
3517
|
#
|
|
3485
3518
|
# @return [Types::DescribeTaskSetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3486
3519
|
#
|
|
@@ -3570,7 +3603,7 @@ module Aws::ECS
|
|
|
3570
3603
|
# @option params [Array<String>] :include
|
|
3571
3604
|
# Specifies whether you want to see the resource tags for the task. If
|
|
3572
3605
|
# `TAGS` is specified, the tags are included in the response. If this
|
|
3573
|
-
# field is omitted, tags
|
|
3606
|
+
# field is omitted, tags aren't included in the response.
|
|
3574
3607
|
#
|
|
3575
3608
|
# @return [Types::DescribeTasksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3576
3609
|
#
|
|
@@ -3776,8 +3809,8 @@ module Aws::ECS
|
|
|
3776
3809
|
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
|
3777
3810
|
#
|
|
3778
3811
|
# @option params [String] :cluster
|
|
3779
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
3780
|
-
#
|
|
3812
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
3813
|
+
# the container instance belongs to.
|
|
3781
3814
|
#
|
|
3782
3815
|
# @return [Types::DiscoverPollEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3783
3816
|
#
|
|
@@ -3871,8 +3904,8 @@ module Aws::ECS
|
|
|
3871
3904
|
# The name of the account setting you want to list the settings for.
|
|
3872
3905
|
#
|
|
3873
3906
|
# @option params [String] :value
|
|
3874
|
-
# The value of the account settings
|
|
3875
|
-
#
|
|
3907
|
+
# The value of the account settings to filter results with. You must
|
|
3908
|
+
# also specify an account setting name to use this parameter.
|
|
3876
3909
|
#
|
|
3877
3910
|
# @option params [String] :principal_arn
|
|
3878
3911
|
# The ARN of the principal, which can be an IAM user, IAM role, or the
|
|
@@ -3885,16 +3918,16 @@ module Aws::ECS
|
|
|
3885
3918
|
# </note>
|
|
3886
3919
|
#
|
|
3887
3920
|
# @option params [Boolean] :effective_settings
|
|
3888
|
-
#
|
|
3921
|
+
# Determines whether to return the effective settings. If `true`, the
|
|
3889
3922
|
# account settings for the root user or the default setting for the
|
|
3890
3923
|
# `principalArn` are returned. If `false`, the account settings for the
|
|
3891
|
-
# `principalArn` are returned if they
|
|
3924
|
+
# `principalArn` are returned if they're set. Otherwise, no account
|
|
3892
3925
|
# settings are returned.
|
|
3893
3926
|
#
|
|
3894
3927
|
# @option params [String] :next_token
|
|
3895
3928
|
# The `nextToken` value returned from a `ListAccountSettings` request
|
|
3896
3929
|
# indicating that more results are available to fulfill the request and
|
|
3897
|
-
# further calls will be needed. If `maxResults` was provided, it
|
|
3930
|
+
# further calls will be needed. If `maxResults` was provided, it's
|
|
3898
3931
|
# possible the number of results to be fewer than `maxResults`.
|
|
3899
3932
|
#
|
|
3900
3933
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
|
@@ -3910,7 +3943,7 @@ module Aws::ECS
|
|
|
3910
3943
|
# single page along with a `nextToken` response element. The remaining
|
|
3911
3944
|
# results of the initial request can be seen by sending another
|
|
3912
3945
|
# `ListAccountSettings` request with the returned `nextToken` value.
|
|
3913
|
-
# This value can be between 1 and 10. If this parameter
|
|
3946
|
+
# This value can be between 1 and 10. If this parameter isn't used,
|
|
3914
3947
|
# then `ListAccountSettings` returns up to 10 results and a `nextToken`
|
|
3915
3948
|
# value if applicable.
|
|
3916
3949
|
#
|
|
@@ -4014,9 +4047,9 @@ module Aws::ECS
|
|
|
4014
4047
|
# `ListAttributes` returns a list of attribute objects, one for each
|
|
4015
4048
|
# attribute on each resource. You can filter the list of results to a
|
|
4016
4049
|
# single attribute name to only return results that have that name. You
|
|
4017
|
-
# can also filter the results by attribute name and value
|
|
4018
|
-
# to see which container instances in a cluster are
|
|
4019
|
-
# (`ecs.os-type=linux`).
|
|
4050
|
+
# can also filter the results by attribute name and value. You can do
|
|
4051
|
+
# this, for example, to see which container instances in a cluster are
|
|
4052
|
+
# running a Linux AMI (`ecs.os-type=linux`).
|
|
4020
4053
|
#
|
|
4021
4054
|
# @option params [String] :cluster
|
|
4022
4055
|
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
@@ -4024,20 +4057,20 @@ module Aws::ECS
|
|
|
4024
4057
|
# is assumed.
|
|
4025
4058
|
#
|
|
4026
4059
|
# @option params [required, String] :target_type
|
|
4027
|
-
# The type of the target
|
|
4060
|
+
# The type of the target to list attributes with.
|
|
4028
4061
|
#
|
|
4029
4062
|
# @option params [String] :attribute_name
|
|
4030
|
-
# The name of the attribute
|
|
4063
|
+
# The name of the attribute to filter the results with.
|
|
4031
4064
|
#
|
|
4032
4065
|
# @option params [String] :attribute_value
|
|
4033
|
-
# The value of the attribute
|
|
4066
|
+
# The value of the attribute to filter results with. You must also
|
|
4034
4067
|
# specify an attribute name to use this parameter.
|
|
4035
4068
|
#
|
|
4036
4069
|
# @option params [String] :next_token
|
|
4037
4070
|
# The `nextToken` value returned from a `ListAttributes` request
|
|
4038
4071
|
# indicating that more results are available to fulfill the request and
|
|
4039
|
-
# further calls
|
|
4040
|
-
#
|
|
4072
|
+
# further calls are needed. If `maxResults` was provided, it's possible
|
|
4073
|
+
# the number of results to be fewer than `maxResults`.
|
|
4041
4074
|
#
|
|
4042
4075
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
|
4043
4076
|
# to retrieve the next items in a list and not for other programmatic
|
|
@@ -4046,14 +4079,14 @@ module Aws::ECS
|
|
|
4046
4079
|
# </note>
|
|
4047
4080
|
#
|
|
4048
4081
|
# @option params [Integer] :max_results
|
|
4049
|
-
# The maximum number of cluster results
|
|
4050
|
-
# paginated output. When this parameter is used, `ListAttributes`
|
|
4051
|
-
# returns `maxResults` results in a single page along with a
|
|
4052
|
-
# response element. The remaining results of the initial
|
|
4053
|
-
# seen by sending another `ListAttributes` request with
|
|
4054
|
-
# `nextToken` value. This value can be between 1 and 100.
|
|
4055
|
-
# parameter
|
|
4056
|
-
# and a `nextToken` value if applicable.
|
|
4082
|
+
# The maximum number of cluster results that `ListAttributes` returned
|
|
4083
|
+
# in paginated output. When this parameter is used, `ListAttributes`
|
|
4084
|
+
# only returns `maxResults` results in a single page along with a
|
|
4085
|
+
# `nextToken` response element. The remaining results of the initial
|
|
4086
|
+
# request can be seen by sending another `ListAttributes` request with
|
|
4087
|
+
# the returned `nextToken` value. This value can be between 1 and 100.
|
|
4088
|
+
# If this parameter isn't used, then `ListAttributes` returns up to 100
|
|
4089
|
+
# results and a `nextToken` value if applicable.
|
|
4057
4090
|
#
|
|
4058
4091
|
# @return [Types::ListAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4059
4092
|
#
|
|
@@ -4096,8 +4129,8 @@ module Aws::ECS
|
|
|
4096
4129
|
# @option params [String] :next_token
|
|
4097
4130
|
# The `nextToken` value returned from a `ListClusters` request
|
|
4098
4131
|
# indicating that more results are available to fulfill the request and
|
|
4099
|
-
# further calls
|
|
4100
|
-
#
|
|
4132
|
+
# further calls are needed. If `maxResults` was provided, it's possible
|
|
4133
|
+
# the number of results to be fewer than `maxResults`.
|
|
4101
4134
|
#
|
|
4102
4135
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
|
4103
4136
|
# to retrieve the next items in a list and not for other programmatic
|
|
@@ -4106,13 +4139,13 @@ module Aws::ECS
|
|
|
4106
4139
|
# </note>
|
|
4107
4140
|
#
|
|
4108
4141
|
# @option params [Integer] :max_results
|
|
4109
|
-
# The maximum number of cluster results
|
|
4142
|
+
# The maximum number of cluster results that `ListClusters` returned in
|
|
4110
4143
|
# paginated output. When this parameter is used, `ListClusters` only
|
|
4111
4144
|
# returns `maxResults` results in a single page along with a `nextToken`
|
|
4112
4145
|
# response element. The remaining results of the initial request can be
|
|
4113
4146
|
# seen by sending another `ListClusters` request with the returned
|
|
4114
4147
|
# `nextToken` value. This value can be between 1 and 100. If this
|
|
4115
|
-
# parameter
|
|
4148
|
+
# parameter isn't used, then `ListClusters` returns up to 100 results
|
|
4116
4149
|
# and a `nextToken` value if applicable.
|
|
4117
4150
|
#
|
|
4118
4151
|
# @return [Types::ListClustersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -4188,8 +4221,8 @@ module Aws::ECS
|
|
|
4188
4221
|
# @option params [String] :next_token
|
|
4189
4222
|
# The `nextToken` value returned from a `ListContainerInstances` request
|
|
4190
4223
|
# indicating that more results are available to fulfill the request and
|
|
4191
|
-
# further calls
|
|
4192
|
-
#
|
|
4224
|
+
# further calls are needed. If `maxResults` was provided, it's possible
|
|
4225
|
+
# the number of results to be fewer than `maxResults`.
|
|
4193
4226
|
#
|
|
4194
4227
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
|
4195
4228
|
# to retrieve the next items in a list and not for other programmatic
|
|
@@ -4198,21 +4231,21 @@ module Aws::ECS
|
|
|
4198
4231
|
# </note>
|
|
4199
4232
|
#
|
|
4200
4233
|
# @option params [Integer] :max_results
|
|
4201
|
-
# The maximum number of container instance results
|
|
4202
|
-
# `ListContainerInstances` in paginated output. When this
|
|
4203
|
-
# used, `ListContainerInstances` only returns `maxResults`
|
|
4204
|
-
# single page along with a `nextToken` response element.
|
|
4205
|
-
# results of the initial request can be seen by sending
|
|
4206
|
-
# `ListContainerInstances` request with the returned `nextToken`
|
|
4207
|
-
# This value can be between 1 and 100. If this parameter
|
|
4208
|
-
# then `ListContainerInstances` returns up to 100 results and a
|
|
4234
|
+
# The maximum number of container instance results that
|
|
4235
|
+
# `ListContainerInstances` returned in paginated output. When this
|
|
4236
|
+
# parameter is used, `ListContainerInstances` only returns `maxResults`
|
|
4237
|
+
# results in a single page along with a `nextToken` response element.
|
|
4238
|
+
# The remaining results of the initial request can be seen by sending
|
|
4239
|
+
# another `ListContainerInstances` request with the returned `nextToken`
|
|
4240
|
+
# value. This value can be between 1 and 100. If this parameter isn't
|
|
4241
|
+
# used, then `ListContainerInstances` returns up to 100 results and a
|
|
4209
4242
|
# `nextToken` value if applicable.
|
|
4210
4243
|
#
|
|
4211
4244
|
# @option params [String] :status
|
|
4212
4245
|
# Filters the container instances by status. For example, if you specify
|
|
4213
4246
|
# the `DRAINING` status, the results include only container instances
|
|
4214
4247
|
# that have been set to `DRAINING` using UpdateContainerInstancesState.
|
|
4215
|
-
# If you
|
|
4248
|
+
# If you don't specify this parameter, the default is to include
|
|
4216
4249
|
# container instances set to all states other than `INACTIVE`.
|
|
4217
4250
|
#
|
|
4218
4251
|
# @return [Types::ListContainerInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -4285,13 +4318,13 @@ module Aws::ECS
|
|
|
4285
4318
|
# </note>
|
|
4286
4319
|
#
|
|
4287
4320
|
# @option params [Integer] :max_results
|
|
4288
|
-
# The maximum number of service results
|
|
4321
|
+
# The maximum number of service results that `ListServices` returned in
|
|
4289
4322
|
# paginated output. When this parameter is used, `ListServices` only
|
|
4290
4323
|
# returns `maxResults` results in a single page along with a `nextToken`
|
|
4291
4324
|
# response element. The remaining results of the initial request can be
|
|
4292
4325
|
# seen by sending another `ListServices` request with the returned
|
|
4293
4326
|
# `nextToken` value. This value can be between 1 and 100. If this
|
|
4294
|
-
# parameter
|
|
4327
|
+
# parameter isn't used, then `ListServices` returns up to 10 results
|
|
4295
4328
|
# and a `nextToken` value if applicable.
|
|
4296
4329
|
#
|
|
4297
4330
|
# @option params [String] :launch_type
|
|
@@ -4351,9 +4384,9 @@ module Aws::ECS
|
|
|
4351
4384
|
# List the tags for an Amazon ECS resource.
|
|
4352
4385
|
#
|
|
4353
4386
|
# @option params [required, String] :resource_arn
|
|
4354
|
-
# The Amazon Resource Name (ARN) that identifies the resource
|
|
4355
|
-
#
|
|
4356
|
-
#
|
|
4387
|
+
# The Amazon Resource Name (ARN) that identifies the resource to list
|
|
4388
|
+
# the tags for. Currently, the supported resources are Amazon ECS tasks,
|
|
4389
|
+
# services, task definitions, clusters, and container instances.
|
|
4357
4390
|
#
|
|
4358
4391
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4359
4392
|
#
|
|
@@ -4400,27 +4433,27 @@ module Aws::ECS
|
|
|
4400
4433
|
end
|
|
4401
4434
|
|
|
4402
4435
|
# Returns a list of task definition families that are registered to your
|
|
4403
|
-
# account
|
|
4404
|
-
# have any `ACTIVE` task definition revisions
|
|
4436
|
+
# account. This list includes task definition families that no longer
|
|
4437
|
+
# have any `ACTIVE` task definition revisions.
|
|
4405
4438
|
#
|
|
4406
|
-
# You can filter out task definition families that
|
|
4439
|
+
# You can filter out task definition families that don't contain any
|
|
4407
4440
|
# `ACTIVE` task definition revisions by setting the `status` parameter
|
|
4408
4441
|
# to `ACTIVE`. You can also filter the results with the `familyPrefix`
|
|
4409
4442
|
# parameter.
|
|
4410
4443
|
#
|
|
4411
4444
|
# @option params [String] :family_prefix
|
|
4412
|
-
# The `familyPrefix` is a string that
|
|
4445
|
+
# The `familyPrefix` is a string that's used to filter the results of
|
|
4413
4446
|
# `ListTaskDefinitionFamilies`. If you specify a `familyPrefix`, only
|
|
4414
4447
|
# task definition family names that begin with the `familyPrefix` string
|
|
4415
4448
|
# are returned.
|
|
4416
4449
|
#
|
|
4417
4450
|
# @option params [String] :status
|
|
4418
|
-
# The task definition family status
|
|
4419
|
-
# `ListTaskDefinitionFamilies` results. By default, both `ACTIVE`
|
|
4420
|
-
# `INACTIVE` task definition families are listed. If this parameter
|
|
4421
|
-
# set to `ACTIVE`, only task definition families that have an
|
|
4422
|
-
# task definition revision are returned. If this parameter is
|
|
4423
|
-
# `INACTIVE`, only task definition families that do not have any
|
|
4451
|
+
# The task definition family status to filter the
|
|
4452
|
+
# `ListTaskDefinitionFamilies` results with. By default, both `ACTIVE`
|
|
4453
|
+
# and `INACTIVE` task definition families are listed. If this parameter
|
|
4454
|
+
# is set to `ACTIVE`, only task definition families that have an
|
|
4455
|
+
# `ACTIVE` task definition revision are returned. If this parameter is
|
|
4456
|
+
# set to `INACTIVE`, only task definition families that do not have any
|
|
4424
4457
|
# `ACTIVE` task definition revisions are returned. If you paginate the
|
|
4425
4458
|
# resulting output, be sure to keep the `status` value constant in each
|
|
4426
4459
|
# subsequent request.
|
|
@@ -4439,15 +4472,15 @@ module Aws::ECS
|
|
|
4439
4472
|
# </note>
|
|
4440
4473
|
#
|
|
4441
4474
|
# @option params [Integer] :max_results
|
|
4442
|
-
# The maximum number of task definition family results
|
|
4443
|
-
# `ListTaskDefinitionFamilies` in paginated output. When this
|
|
4444
|
-
# is used, `ListTaskDefinitions` only returns `maxResults`
|
|
4445
|
-
# single page along with a `nextToken` response element.
|
|
4446
|
-
# results of the initial request can be seen by sending
|
|
4447
|
-
# `ListTaskDefinitionFamilies` request with the returned
|
|
4448
|
-
# value. This value can be between 1 and 100. If this
|
|
4449
|
-
# used, then `ListTaskDefinitionFamilies` returns up to
|
|
4450
|
-
# a `nextToken` value if applicable.
|
|
4475
|
+
# The maximum number of task definition family results that
|
|
4476
|
+
# `ListTaskDefinitionFamilies` returned in paginated output. When this
|
|
4477
|
+
# parameter is used, `ListTaskDefinitions` only returns `maxResults`
|
|
4478
|
+
# results in a single page along with a `nextToken` response element.
|
|
4479
|
+
# The remaining results of the initial request can be seen by sending
|
|
4480
|
+
# another `ListTaskDefinitionFamilies` request with the returned
|
|
4481
|
+
# `nextToken` value. This value can be between 1 and 100. If this
|
|
4482
|
+
# parameter isn't used, then `ListTaskDefinitionFamilies` returns up to
|
|
4483
|
+
# 100 results and a `nextToken` value if applicable.
|
|
4451
4484
|
#
|
|
4452
4485
|
# @return [Types::ListTaskDefinitionFamiliesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4453
4486
|
#
|
|
@@ -4519,27 +4552,26 @@ module Aws::ECS
|
|
|
4519
4552
|
# `familyPrefix` parameter or by status with the `status` parameter.
|
|
4520
4553
|
#
|
|
4521
4554
|
# @option params [String] :family_prefix
|
|
4522
|
-
# The full family name
|
|
4523
|
-
#
|
|
4524
|
-
#
|
|
4555
|
+
# The full family name to filter the `ListTaskDefinitions` results with.
|
|
4556
|
+
# Specifying a `familyPrefix` limits the listed task definitions to task
|
|
4557
|
+
# definition revisions that belong to that family.
|
|
4525
4558
|
#
|
|
4526
4559
|
# @option params [String] :status
|
|
4527
|
-
# The task definition status
|
|
4528
|
-
#
|
|
4529
|
-
#
|
|
4530
|
-
#
|
|
4531
|
-
#
|
|
4532
|
-
#
|
|
4533
|
-
# request.
|
|
4560
|
+
# The task definition status to filter the `ListTaskDefinitions` results
|
|
4561
|
+
# with. By default, only `ACTIVE` task definitions are listed. By
|
|
4562
|
+
# setting this parameter to `INACTIVE`, you can view task definitions
|
|
4563
|
+
# that are `INACTIVE` as long as an active task or service still
|
|
4564
|
+
# references them. If you paginate the resulting output, be sure to keep
|
|
4565
|
+
# the `status` value constant in each subsequent request.
|
|
4534
4566
|
#
|
|
4535
4567
|
# @option params [String] :sort
|
|
4536
|
-
# The order
|
|
4537
|
-
#
|
|
4538
|
-
#
|
|
4539
|
-
#
|
|
4540
|
-
#
|
|
4541
|
-
#
|
|
4542
|
-
#
|
|
4568
|
+
# The order to sort the results in. Valid values are `ASC` and `DESC`.
|
|
4569
|
+
# By default, (`ASC`) task definitions are listed lexicographically by
|
|
4570
|
+
# family name and in ascending numerical order by revision so that the
|
|
4571
|
+
# newest task definitions in a family are listed last. Setting this
|
|
4572
|
+
# parameter to `DESC` reverses the sort order on family name and
|
|
4573
|
+
# revision. This is so that the newest task definitions in a family are
|
|
4574
|
+
# listed first.
|
|
4543
4575
|
#
|
|
4544
4576
|
# @option params [String] :next_token
|
|
4545
4577
|
# The `nextToken` value returned from a `ListTaskDefinitions` request
|
|
@@ -4554,15 +4586,15 @@ module Aws::ECS
|
|
|
4554
4586
|
# </note>
|
|
4555
4587
|
#
|
|
4556
4588
|
# @option params [Integer] :max_results
|
|
4557
|
-
# The maximum number of task definition results
|
|
4558
|
-
# `ListTaskDefinitions` in paginated output. When this
|
|
4559
|
-
# used, `ListTaskDefinitions` only returns `maxResults`
|
|
4560
|
-
# single page along with a `nextToken` response element.
|
|
4561
|
-
# results of the initial request can be seen by sending
|
|
4562
|
-
# `ListTaskDefinitions` request with the returned `nextToken`
|
|
4563
|
-
# This value can be between 1 and 100. If this parameter
|
|
4564
|
-
# then `ListTaskDefinitions` returns up to 100 results and a
|
|
4565
|
-
# value if applicable.
|
|
4589
|
+
# The maximum number of task definition results that
|
|
4590
|
+
# `ListTaskDefinitions` returned in paginated output. When this
|
|
4591
|
+
# parameter is used, `ListTaskDefinitions` only returns `maxResults`
|
|
4592
|
+
# results in a single page along with a `nextToken` response element.
|
|
4593
|
+
# The remaining results of the initial request can be seen by sending
|
|
4594
|
+
# another `ListTaskDefinitions` request with the returned `nextToken`
|
|
4595
|
+
# value. This value can be between 1 and 100. If this parameter isn't
|
|
4596
|
+
# used, then `ListTaskDefinitions` returns up to 100 results and a
|
|
4597
|
+
# `nextToken` value if applicable.
|
|
4566
4598
|
#
|
|
4567
4599
|
# @return [Types::ListTaskDefinitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4568
4600
|
#
|
|
@@ -4661,7 +4693,7 @@ module Aws::ECS
|
|
|
4661
4693
|
# @option params [String] :next_token
|
|
4662
4694
|
# The `nextToken` value returned from a `ListTasks` request indicating
|
|
4663
4695
|
# that more results are available to fulfill the request and further
|
|
4664
|
-
# calls will be needed. If `maxResults` was provided, it
|
|
4696
|
+
# calls will be needed. If `maxResults` was provided, it's possible the
|
|
4665
4697
|
# number of results to be fewer than `maxResults`.
|
|
4666
4698
|
#
|
|
4667
4699
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
|
@@ -4671,19 +4703,19 @@ module Aws::ECS
|
|
|
4671
4703
|
# </note>
|
|
4672
4704
|
#
|
|
4673
4705
|
# @option params [Integer] :max_results
|
|
4674
|
-
# The maximum number of task results
|
|
4706
|
+
# The maximum number of task results that `ListTasks` returned in
|
|
4675
4707
|
# paginated output. When this parameter is used, `ListTasks` only
|
|
4676
4708
|
# returns `maxResults` results in a single page along with a `nextToken`
|
|
4677
4709
|
# response element. The remaining results of the initial request can be
|
|
4678
4710
|
# seen by sending another `ListTasks` request with the returned
|
|
4679
4711
|
# `nextToken` value. This value can be between 1 and 100. If this
|
|
4680
|
-
# parameter
|
|
4712
|
+
# parameter isn't used, then `ListTasks` returns up to 100 results and
|
|
4681
4713
|
# a `nextToken` value if applicable.
|
|
4682
4714
|
#
|
|
4683
4715
|
# @option params [String] :started_by
|
|
4684
|
-
# The `startedBy` value
|
|
4685
|
-
#
|
|
4686
|
-
#
|
|
4716
|
+
# The `startedBy` value to filter the task results with. Specifying a
|
|
4717
|
+
# `startedBy` value limits the results to tasks that were started with
|
|
4718
|
+
# that value.
|
|
4687
4719
|
#
|
|
4688
4720
|
# @option params [String] :service_name
|
|
4689
4721
|
# The name of the service to use when filtering the `ListTasks` results.
|
|
@@ -4694,12 +4726,12 @@ module Aws::ECS
|
|
|
4694
4726
|
# The task desired status to use when filtering the `ListTasks` results.
|
|
4695
4727
|
# Specifying a `desiredStatus` of `STOPPED` limits the results to tasks
|
|
4696
4728
|
# that Amazon ECS has set the desired status to `STOPPED`. This can be
|
|
4697
|
-
# useful for debugging tasks that
|
|
4729
|
+
# useful for debugging tasks that aren't starting properly or have died
|
|
4698
4730
|
# or finished. The default status filter is `RUNNING`, which shows tasks
|
|
4699
4731
|
# that Amazon ECS has set the desired status to `RUNNING`.
|
|
4700
4732
|
#
|
|
4701
4733
|
# <note markdown="1"> Although you can filter results based on a desired status of
|
|
4702
|
-
# `PENDING`, this
|
|
4734
|
+
# `PENDING`, this doesn't return any results. Amazon ECS never sets the
|
|
4703
4735
|
# desired status of a task to that value (only a task's `lastStatus`
|
|
4704
4736
|
# may have a value of `PENDING`).
|
|
4705
4737
|
#
|
|
@@ -4782,9 +4814,9 @@ module Aws::ECS
|
|
|
4782
4814
|
# basis.
|
|
4783
4815
|
#
|
|
4784
4816
|
# If you change the account setting for the root user, the default
|
|
4785
|
-
# settings for all of the IAM users and roles
|
|
4786
|
-
#
|
|
4787
|
-
#
|
|
4817
|
+
# settings for all of the IAM users and roles that no individual account
|
|
4818
|
+
# setting was specified are reset for. For more information, see
|
|
4819
|
+
# [Account Settings][1] in the *Amazon Elastic Container Service
|
|
4788
4820
|
# Developer Guide*.
|
|
4789
4821
|
#
|
|
4790
4822
|
# When `serviceLongArnFormat`, `taskLongArnFormat`, or
|
|
@@ -4792,10 +4824,10 @@ module Aws::ECS
|
|
|
4792
4824
|
# Name (ARN) and resource ID format of the resource type for a specified
|
|
4793
4825
|
# IAM user, IAM role, or the root user for an account is affected. The
|
|
4794
4826
|
# opt-in and opt-out account setting must be set for each Amazon ECS
|
|
4795
|
-
# resource separately. The ARN and resource ID format of a resource
|
|
4796
|
-
#
|
|
4797
|
-
#
|
|
4798
|
-
#
|
|
4827
|
+
# resource separately. The ARN and resource ID format of a resource is
|
|
4828
|
+
# defined by the opt-in status of the IAM user or role that created the
|
|
4829
|
+
# resource. You must enable this setting to use Amazon ECS features such
|
|
4830
|
+
# as resource tagging.
|
|
4799
4831
|
#
|
|
4800
4832
|
# When `awsvpcTrunking` is specified, the elastic network interface
|
|
4801
4833
|
# (ENI) limit for any new container instances that support the feature
|
|
@@ -4985,7 +5017,7 @@ module Aws::ECS
|
|
|
4985
5017
|
end
|
|
4986
5018
|
|
|
4987
5019
|
# Create or update an attribute on an Amazon ECS resource. If the
|
|
4988
|
-
# attribute
|
|
5020
|
+
# attribute doesn't exist, it's created. If the attribute exists, its
|
|
4989
5021
|
# value is replaced with the specified value. To delete an attribute,
|
|
4990
5022
|
# use DeleteAttributes. For more information, see [Attributes][1] in the
|
|
4991
5023
|
# *Amazon Elastic Container Service Developer Guide*.
|
|
@@ -5001,8 +5033,8 @@ module Aws::ECS
|
|
|
5001
5033
|
#
|
|
5002
5034
|
# @option params [required, Array<Types::Attribute>] :attributes
|
|
5003
5035
|
# The attributes to apply to your resource. You can specify up to 10
|
|
5004
|
-
# custom attributes
|
|
5005
|
-
# a single call.
|
|
5036
|
+
# custom attributes for each resource. You can specify up to 10
|
|
5037
|
+
# attributes in a single call.
|
|
5006
5038
|
#
|
|
5007
5039
|
# @return [Types::PutAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5008
5040
|
#
|
|
@@ -5046,21 +5078,21 @@ module Aws::ECS
|
|
|
5046
5078
|
# capacity provider strategy for the cluster. If the specified cluster
|
|
5047
5079
|
# has existing capacity providers associated with it, you must specify
|
|
5048
5080
|
# all existing capacity providers in addition to any new ones you want
|
|
5049
|
-
# to add. Any existing capacity providers associated with a
|
|
5050
|
-
# are omitted from a PutClusterCapacityProviders API call
|
|
5051
|
-
# disassociated with the cluster. You can only disassociate an
|
|
5052
|
-
# capacity provider from a cluster if it's not being used by
|
|
5053
|
-
# existing tasks.
|
|
5081
|
+
# to add. Any existing capacity providers that are associated with a
|
|
5082
|
+
# cluster that are omitted from a PutClusterCapacityProviders API call
|
|
5083
|
+
# will be disassociated with the cluster. You can only disassociate an
|
|
5084
|
+
# existing capacity provider from a cluster if it's not being used by
|
|
5085
|
+
# any existing tasks.
|
|
5054
5086
|
#
|
|
5055
5087
|
# When creating a service or running a task on a cluster, if no capacity
|
|
5056
5088
|
# provider or launch type is specified, then the cluster's default
|
|
5057
|
-
# capacity provider strategy is used.
|
|
5058
|
-
# default capacity provider strategy for your cluster,
|
|
5089
|
+
# capacity provider strategy is used. We recommend that you define a
|
|
5090
|
+
# default capacity provider strategy for your cluster. However, you must
|
|
5059
5091
|
# specify an empty array (`[]`) to bypass defining a default strategy.
|
|
5060
5092
|
#
|
|
5061
5093
|
# @option params [required, String] :cluster
|
|
5062
5094
|
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
5063
|
-
# modify the capacity provider settings for. If you
|
|
5095
|
+
# modify the capacity provider settings for. If you don't specify a
|
|
5064
5096
|
# cluster, the default cluster is assumed.
|
|
5065
5097
|
#
|
|
5066
5098
|
# @option params [required, Array<String>] :capacity_providers
|
|
@@ -5175,8 +5207,8 @@ module Aws::ECS
|
|
|
5175
5207
|
# becomes available to place containers on.
|
|
5176
5208
|
#
|
|
5177
5209
|
# @option params [String] :cluster
|
|
5178
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
5179
|
-
#
|
|
5210
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
5211
|
+
# register your container instance with. If you do not specify a
|
|
5180
5212
|
# cluster, the default cluster is assumed.
|
|
5181
5213
|
#
|
|
5182
5214
|
# @option params [String] :instance_identity_document
|
|
@@ -5196,7 +5228,7 @@ module Aws::ECS
|
|
|
5196
5228
|
#
|
|
5197
5229
|
# @option params [Types::VersionInfo] :version_info
|
|
5198
5230
|
# The version information for the Amazon ECS container agent and Docker
|
|
5199
|
-
# daemon
|
|
5231
|
+
# daemon that runs on the container instance.
|
|
5200
5232
|
#
|
|
5201
5233
|
# @option params [String] :container_instance_arn
|
|
5202
5234
|
# The ARN of the container instance (if it was previously registered).
|
|
@@ -5212,7 +5244,7 @@ module Aws::ECS
|
|
|
5212
5244
|
# @option params [Array<Types::Tag>] :tags
|
|
5213
5245
|
# The metadata that you apply to the container instance to help you
|
|
5214
5246
|
# categorize and organize them. Each tag consists of a key and an
|
|
5215
|
-
# optional value
|
|
5247
|
+
# optional value. You define both.
|
|
5216
5248
|
#
|
|
5217
5249
|
# The following basic restrictions apply to tags:
|
|
5218
5250
|
#
|
|
@@ -5334,6 +5366,12 @@ module Aws::ECS
|
|
|
5334
5366
|
# resp.container_instance.tags #=> Array
|
|
5335
5367
|
# resp.container_instance.tags[0].key #=> String
|
|
5336
5368
|
# resp.container_instance.tags[0].value #=> String
|
|
5369
|
+
# resp.container_instance.health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
5370
|
+
# resp.container_instance.health_status.details #=> Array
|
|
5371
|
+
# resp.container_instance.health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
|
|
5372
|
+
# resp.container_instance.health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
5373
|
+
# resp.container_instance.health_status.details[0].last_updated #=> Time
|
|
5374
|
+
# resp.container_instance.health_status.details[0].last_status_change #=> Time
|
|
5337
5375
|
#
|
|
5338
5376
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterContainerInstance AWS API Documentation
|
|
5339
5377
|
#
|
|
@@ -5355,9 +5393,9 @@ module Aws::ECS
|
|
|
5355
5393
|
# parameter. When you specify an IAM role for a task, its containers can
|
|
5356
5394
|
# then use the latest versions of the CLI or SDKs to make API requests
|
|
5357
5395
|
# to the Amazon Web Services services that are specified in the IAM
|
|
5358
|
-
# policy associated with the role. For more information, see
|
|
5359
|
-
# for Tasks][2] in the *Amazon Elastic Container Service
|
|
5360
|
-
# Guide*.
|
|
5396
|
+
# policy that's associated with the role. For more information, see
|
|
5397
|
+
# [IAM Roles for Tasks][2] in the *Amazon Elastic Container Service
|
|
5398
|
+
# Developer Guide*.
|
|
5361
5399
|
#
|
|
5362
5400
|
# You can specify a Docker networking mode for the containers in your
|
|
5363
5401
|
# task definition with the `networkMode` parameter. The available
|
|
@@ -5377,7 +5415,7 @@ module Aws::ECS
|
|
|
5377
5415
|
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
|
5378
5416
|
#
|
|
5379
5417
|
# @option params [required, String] :family
|
|
5380
|
-
# You must specify a `family` for a task definition
|
|
5418
|
+
# You must specify a `family` for a task definition. You can use it
|
|
5381
5419
|
# track multiple versions of the same task definition. The `family` is
|
|
5382
5420
|
# used as a name for your task definition. Up to 255 letters (uppercase
|
|
5383
5421
|
# and lowercase), numbers, underscores, and hyphens are allowed.
|
|
@@ -5455,23 +5493,23 @@ module Aws::ECS
|
|
|
5455
5493
|
#
|
|
5456
5494
|
# @option params [Array<Types::Volume>] :volumes
|
|
5457
5495
|
# A list of volume definitions in JSON format that containers in your
|
|
5458
|
-
# task
|
|
5496
|
+
# task might use.
|
|
5459
5497
|
#
|
|
5460
5498
|
# @option params [Array<Types::TaskDefinitionPlacementConstraint>] :placement_constraints
|
|
5461
5499
|
# An array of placement constraint objects to use for the task. You can
|
|
5462
|
-
# specify a maximum of 10 constraints
|
|
5463
|
-
# constraints in the task definition and those specified at runtime
|
|
5500
|
+
# specify a maximum of 10 constraints for each task. This limit includes
|
|
5501
|
+
# constraints in the task definition and those specified at runtime.
|
|
5464
5502
|
#
|
|
5465
5503
|
# @option params [Array<String>] :requires_compatibilities
|
|
5466
|
-
# The task launch type that Amazon ECS
|
|
5467
|
-
#
|
|
5468
|
-
#
|
|
5469
|
-
#
|
|
5504
|
+
# The task launch type that Amazon ECS validates the task definition
|
|
5505
|
+
# against. A client exception is returned if the task definition
|
|
5506
|
+
# doesn't validate against the compatibilities specified. If no value
|
|
5507
|
+
# is specified, the parameter is omitted from the response.
|
|
5470
5508
|
#
|
|
5471
5509
|
# @option params [String] :cpu
|
|
5472
5510
|
# The number of CPU units used by the task. It can be expressed as an
|
|
5473
|
-
# integer using CPU units
|
|
5474
|
-
# vCPUs
|
|
5511
|
+
# integer using CPU units (for example, `1024`) or as a string using
|
|
5512
|
+
# vCPUs (for example, `1 vCPU` or `1 vcpu`) in a task definition. String
|
|
5475
5513
|
# values are converted to an integer indicating the CPU units when the
|
|
5476
5514
|
# task definition is registered.
|
|
5477
5515
|
#
|
|
@@ -5481,14 +5519,17 @@ module Aws::ECS
|
|
|
5481
5519
|
#
|
|
5482
5520
|
# </note>
|
|
5483
5521
|
#
|
|
5484
|
-
# If you
|
|
5522
|
+
# If you're using the EC2 launch type, this field is optional.
|
|
5485
5523
|
# Supported values are between `128` CPU units (`0.125` vCPUs) and
|
|
5486
5524
|
# `10240` CPU units (`10` vCPUs).
|
|
5487
5525
|
#
|
|
5488
|
-
# If you
|
|
5526
|
+
# If you're using the Fargate launch type, this field is required and
|
|
5489
5527
|
# you must use one of the following values, which determines your range
|
|
5490
5528
|
# of supported values for the `memory` parameter:
|
|
5491
5529
|
#
|
|
5530
|
+
# The CPU units cannot be less than 1 vCPU when you use Windows
|
|
5531
|
+
# containers on Fargate.
|
|
5532
|
+
#
|
|
5492
5533
|
# * 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1
|
|
5493
5534
|
# GB), 2048 (2 GB)
|
|
5494
5535
|
#
|
|
@@ -5506,8 +5547,8 @@ module Aws::ECS
|
|
|
5506
5547
|
#
|
|
5507
5548
|
# @option params [String] :memory
|
|
5508
5549
|
# The amount of memory (in MiB) used by the task. It can be expressed as
|
|
5509
|
-
# an integer using MiB
|
|
5510
|
-
# example `1GB` or `1 GB
|
|
5550
|
+
# an integer using MiB (for example ,`1024`) or as a string using GB
|
|
5551
|
+
# (for example, `1GB` or `1 GB`) in a task definition. String values are
|
|
5511
5552
|
# converted to an integer indicating the MiB when the task definition is
|
|
5512
5553
|
# registered.
|
|
5513
5554
|
#
|
|
@@ -5520,8 +5561,11 @@ module Aws::ECS
|
|
|
5520
5561
|
# If using the EC2 launch type, this field is optional.
|
|
5521
5562
|
#
|
|
5522
5563
|
# If using the Fargate launch type, this field is required and you must
|
|
5523
|
-
# use one of the following values
|
|
5524
|
-
# supported values for the `cpu` parameter
|
|
5564
|
+
# use one of the following values. This determines your range of
|
|
5565
|
+
# supported values for the `cpu` parameter.
|
|
5566
|
+
#
|
|
5567
|
+
# The CPU units cannot be less than 1 vCPU when you use Windows
|
|
5568
|
+
# containers on Fargate.
|
|
5525
5569
|
#
|
|
5526
5570
|
# * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values: 256
|
|
5527
5571
|
# (.25 vCPU)
|
|
@@ -5541,7 +5585,7 @@ module Aws::ECS
|
|
|
5541
5585
|
# @option params [Array<Types::Tag>] :tags
|
|
5542
5586
|
# The metadata that you apply to the task definition to help you
|
|
5543
5587
|
# categorize and organize them. Each tag consists of a key and an
|
|
5544
|
-
# optional value
|
|
5588
|
+
# optional value. You define both of them.
|
|
5545
5589
|
#
|
|
5546
5590
|
# The following basic restrictions apply to tags:
|
|
5547
5591
|
#
|
|
@@ -6160,12 +6204,12 @@ module Aws::ECS
|
|
|
6160
6204
|
# Alternatively, you can use StartTask to use your own scheduler or
|
|
6161
6205
|
# place tasks manually on specific container instances.
|
|
6162
6206
|
#
|
|
6163
|
-
# The Amazon ECS API follows an eventual consistency model
|
|
6164
|
-
# distributed nature of the system supporting the API. This
|
|
6165
|
-
# the result of an API command you run that affects your
|
|
6166
|
-
# resources might not be immediately visible to all
|
|
6167
|
-
# you run. Keep this in mind when you carry out an
|
|
6168
|
-
# immediately follows a previous API command.
|
|
6207
|
+
# The Amazon ECS API follows an eventual consistency model. This is
|
|
6208
|
+
# because the distributed nature of the system supporting the API. This
|
|
6209
|
+
# means that the result of an API command you run that affects your
|
|
6210
|
+
# Amazon ECS resources might not be immediately visible to all
|
|
6211
|
+
# subsequent commands you run. Keep this in mind when you carry out an
|
|
6212
|
+
# API command that immediately follows a previous API command.
|
|
6169
6213
|
#
|
|
6170
6214
|
# To manage eventual consistency, you can do the following:
|
|
6171
6215
|
#
|
|
@@ -6201,13 +6245,13 @@ module Aws::ECS
|
|
|
6201
6245
|
# providers.
|
|
6202
6246
|
#
|
|
6203
6247
|
# @option params [String] :cluster
|
|
6204
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
6205
|
-
#
|
|
6206
|
-
#
|
|
6248
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
6249
|
+
# run your task on. If you do not specify a cluster, the default cluster
|
|
6250
|
+
# is assumed.
|
|
6207
6251
|
#
|
|
6208
6252
|
# @option params [Integer] :count
|
|
6209
6253
|
# The number of instantiations of the specified task to place on your
|
|
6210
|
-
# cluster. You can specify up to 10 tasks
|
|
6254
|
+
# cluster. You can specify up to 10 tasks for each call.
|
|
6211
6255
|
#
|
|
6212
6256
|
# @option params [Boolean] :enable_ecs_managed_tags
|
|
6213
6257
|
# Specifies whether to enable Amazon ECS managed tags for the task. For
|
|
@@ -6219,7 +6263,7 @@ module Aws::ECS
|
|
|
6219
6263
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
|
6220
6264
|
#
|
|
6221
6265
|
# @option params [Boolean] :enable_execute_command
|
|
6222
|
-
#
|
|
6266
|
+
# Determines whether to enable the execute command functionality for the
|
|
6223
6267
|
# containers in this task. If `true`, this enables execute command
|
|
6224
6268
|
# functionality on all containers in the task.
|
|
6225
6269
|
#
|
|
@@ -6229,7 +6273,7 @@ module Aws::ECS
|
|
|
6229
6273
|
# `family:my-family-name`).
|
|
6230
6274
|
#
|
|
6231
6275
|
# @option params [String] :launch_type
|
|
6232
|
-
# The infrastructure
|
|
6276
|
+
# The infrastructure to run your standalone task on. For more
|
|
6233
6277
|
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
|
6234
6278
|
# Container Service Developer Guide*.
|
|
6235
6279
|
#
|
|
@@ -6245,7 +6289,7 @@ module Aws::ECS
|
|
|
6245
6289
|
# The `EC2` launch type runs your tasks on Amazon EC2 instances
|
|
6246
6290
|
# registered to your cluster.
|
|
6247
6291
|
#
|
|
6248
|
-
# The `EXTERNAL` launch type runs your tasks on your on-
|
|
6292
|
+
# The `EXTERNAL` launch type runs your tasks on your on-premises server
|
|
6249
6293
|
# or virtual machine (VM) capacity registered to your cluster.
|
|
6250
6294
|
#
|
|
6251
6295
|
# A task can use either a launch type or a capacity provider strategy.
|
|
@@ -6263,7 +6307,7 @@ module Aws::ECS
|
|
|
6263
6307
|
# @option params [Types::NetworkConfiguration] :network_configuration
|
|
6264
6308
|
# The network configuration for the task. This parameter is required for
|
|
6265
6309
|
# task definitions that use the `awsvpc` network mode to receive their
|
|
6266
|
-
# own elastic network interface, and it
|
|
6310
|
+
# own elastic network interface, and it isn't supported for other
|
|
6267
6311
|
# network modes. For more information, see [Task networking][1] in the
|
|
6268
6312
|
# *Amazon Elastic Container Service Developer Guide*.
|
|
6269
6313
|
#
|
|
@@ -6275,7 +6319,7 @@ module Aws::ECS
|
|
|
6275
6319
|
# A list of container overrides in JSON format that specify the name of
|
|
6276
6320
|
# a container in the specified task definition and the overrides it
|
|
6277
6321
|
# should receive. You can override the default command for a container
|
|
6278
|
-
# (that
|
|
6322
|
+
# (that's specified in the task definition or Docker image) with a
|
|
6279
6323
|
# `command` override. You can also override existing environment
|
|
6280
6324
|
# variables (that are specified in the task definition or Docker image)
|
|
6281
6325
|
# on a container or add new environment variables to it with an
|
|
@@ -6286,19 +6330,19 @@ module Aws::ECS
|
|
|
6286
6330
|
#
|
|
6287
6331
|
# @option params [Array<Types::PlacementConstraint>] :placement_constraints
|
|
6288
6332
|
# An array of placement constraint objects to use for the task. You can
|
|
6289
|
-
# specify up to 10 constraints
|
|
6290
|
-
# task definition and those specified at runtime).
|
|
6333
|
+
# specify up to 10 constraints for each task (including constraints in
|
|
6334
|
+
# the task definition and those specified at runtime).
|
|
6291
6335
|
#
|
|
6292
6336
|
# @option params [Array<Types::PlacementStrategy>] :placement_strategy
|
|
6293
6337
|
# The placement strategy objects to use for the task. You can specify a
|
|
6294
|
-
# maximum of 5 strategy rules
|
|
6338
|
+
# maximum of 5 strategy rules for each task.
|
|
6295
6339
|
#
|
|
6296
6340
|
# @option params [String] :platform_version
|
|
6297
|
-
# The platform version the task
|
|
6298
|
-
# specified for tasks hosted on Fargate. If one
|
|
6299
|
-
# `LATEST` platform version is used
|
|
6300
|
-
#
|
|
6301
|
-
#
|
|
6341
|
+
# The platform version the task uses. A platform version is only
|
|
6342
|
+
# specified for tasks hosted on Fargate. If one isn't specified, the
|
|
6343
|
+
# `LATEST` platform version is used. For more information, see [Fargate
|
|
6344
|
+
# platform versions][1] in the *Amazon Elastic Container Service
|
|
6345
|
+
# Developer Guide*.
|
|
6302
6346
|
#
|
|
6303
6347
|
#
|
|
6304
6348
|
#
|
|
@@ -6306,7 +6350,7 @@ module Aws::ECS
|
|
|
6306
6350
|
#
|
|
6307
6351
|
# @option params [String] :propagate_tags
|
|
6308
6352
|
# Specifies whether to propagate the tags from the task definition to
|
|
6309
|
-
# the task. If no value is specified, the tags
|
|
6353
|
+
# the task. If no value is specified, the tags aren't propagated. Tags
|
|
6310
6354
|
# can only be propagated to the task during task creation. To add tags
|
|
6311
6355
|
# to a task after task creation, use the TagResource API action.
|
|
6312
6356
|
#
|
|
@@ -6326,7 +6370,7 @@ module Aws::ECS
|
|
|
6326
6370
|
# `startedBy` parameter. You can then identify which tasks belong to
|
|
6327
6371
|
# that job by filtering the results of a ListTasks call with the
|
|
6328
6372
|
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
|
6329
|
-
# numbers, hyphens, and underscores are allowed.
|
|
6373
|
+
# numbers, hyphens (-), and underscores (\_) are allowed.
|
|
6330
6374
|
#
|
|
6331
6375
|
# If a task is started by an Amazon ECS service, then the `startedBy`
|
|
6332
6376
|
# parameter contains the deployment ID of the service that starts it.
|
|
@@ -6363,10 +6407,10 @@ module Aws::ECS
|
|
|
6363
6407
|
#
|
|
6364
6408
|
# @option params [required, String] :task_definition
|
|
6365
6409
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
|
6366
|
-
# task definition to run. If a `revision`
|
|
6410
|
+
# task definition to run. If a `revision` isn't specified, the latest
|
|
6367
6411
|
# `ACTIVE` revision is used.
|
|
6368
6412
|
#
|
|
6369
|
-
# The full ARN value must match the value that you specified
|
|
6413
|
+
# The full ARN value must match the value that you specified as the
|
|
6370
6414
|
# `Resource` of the IAM principal's permissions policy. For example, if
|
|
6371
6415
|
# the `Resource` is
|
|
6372
6416
|
# arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*,
|
|
@@ -6637,14 +6681,14 @@ module Aws::ECS
|
|
|
6637
6681
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html
|
|
6638
6682
|
#
|
|
6639
6683
|
# @option params [String] :cluster
|
|
6640
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
6641
|
-
#
|
|
6684
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster where
|
|
6685
|
+
# to start your task. If you do not specify a cluster, the default
|
|
6642
6686
|
# cluster is assumed.
|
|
6643
6687
|
#
|
|
6644
6688
|
# @option params [required, Array<String>] :container_instances
|
|
6645
6689
|
# The container instance IDs or full ARN entries for the container
|
|
6646
|
-
# instances
|
|
6647
|
-
#
|
|
6690
|
+
# instances where you would like to place your task. You can specify up
|
|
6691
|
+
# to 10 container instances.
|
|
6648
6692
|
#
|
|
6649
6693
|
# @option params [Boolean] :enable_ecs_managed_tags
|
|
6650
6694
|
# Specifies whether to enable Amazon ECS managed tags for the task. For
|
|
@@ -6673,8 +6717,8 @@ module Aws::ECS
|
|
|
6673
6717
|
# @option params [Types::TaskOverride] :overrides
|
|
6674
6718
|
# A list of container overrides in JSON format that specify the name of
|
|
6675
6719
|
# a container in the specified task definition and the overrides it
|
|
6676
|
-
#
|
|
6677
|
-
# (that
|
|
6720
|
+
# receives. You can override the default command for a container
|
|
6721
|
+
# (that's specified in the task definition or Docker image) with a
|
|
6678
6722
|
# `command` override. You can also override existing environment
|
|
6679
6723
|
# variables (that are specified in the task definition or Docker image)
|
|
6680
6724
|
# on a container or add new environment variables to it with an
|
|
@@ -6687,7 +6731,7 @@ module Aws::ECS
|
|
|
6687
6731
|
#
|
|
6688
6732
|
# @option params [String] :propagate_tags
|
|
6689
6733
|
# Specifies whether to propagate the tags from the task definition or
|
|
6690
|
-
# the service to the task. If no value is specified, the tags
|
|
6734
|
+
# the service to the task. If no value is specified, the tags aren't
|
|
6691
6735
|
# propagated.
|
|
6692
6736
|
#
|
|
6693
6737
|
# @option params [String] :reference_id
|
|
@@ -6700,9 +6744,9 @@ module Aws::ECS
|
|
|
6700
6744
|
# `startedBy` parameter. You can then identify which tasks belong to
|
|
6701
6745
|
# that job by filtering the results of a ListTasks call with the
|
|
6702
6746
|
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
|
6703
|
-
# numbers, hyphens, and underscores are allowed.
|
|
6747
|
+
# numbers, hyphens (-), and underscores (\_) are allowed.
|
|
6704
6748
|
#
|
|
6705
|
-
# If a task is started by an Amazon ECS service,
|
|
6749
|
+
# If a task is started by an Amazon ECS service, the `startedBy`
|
|
6706
6750
|
# parameter contains the deployment ID of the service that starts it.
|
|
6707
6751
|
#
|
|
6708
6752
|
# @option params [Array<Types::Tag>] :tags
|
|
@@ -6737,7 +6781,7 @@ module Aws::ECS
|
|
|
6737
6781
|
#
|
|
6738
6782
|
# @option params [required, String] :task_definition
|
|
6739
6783
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
|
6740
|
-
# task definition to start. If a `revision`
|
|
6784
|
+
# task definition to start. If a `revision` isn't specified, the latest
|
|
6741
6785
|
# `ACTIVE` revision is used.
|
|
6742
6786
|
#
|
|
6743
6787
|
# @return [Types::StartTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -6964,7 +7008,7 @@ module Aws::ECS
|
|
|
6964
7008
|
#
|
|
6965
7009
|
# @option params [String] :reason
|
|
6966
7010
|
# An optional message specified when a task is stopped. For example, if
|
|
6967
|
-
# you
|
|
7011
|
+
# you're using a custom scheduler, you can use this parameter to
|
|
6968
7012
|
# specify the reason for stopping the task here, and the message appears
|
|
6969
7013
|
# in subsequent DescribeTasks API operations on this task. Up to 255
|
|
6970
7014
|
# characters are allowed in this message.
|
|
@@ -7162,7 +7206,7 @@ module Aws::ECS
|
|
|
7162
7206
|
# The status of the state change request.
|
|
7163
7207
|
#
|
|
7164
7208
|
# @option params [Integer] :exit_code
|
|
7165
|
-
# The exit code returned for the state change request.
|
|
7209
|
+
# The exit code that's returned for the state change request.
|
|
7166
7210
|
#
|
|
7167
7211
|
# @option params [String] :reason
|
|
7168
7212
|
# The reason for the state change request.
|
|
@@ -7228,22 +7272,23 @@ module Aws::ECS
|
|
|
7228
7272
|
# The reason for the state change request.
|
|
7229
7273
|
#
|
|
7230
7274
|
# @option params [Array<Types::ContainerStateChange>] :containers
|
|
7231
|
-
# Any containers associated with the state change request.
|
|
7275
|
+
# Any containers that's associated with the state change request.
|
|
7232
7276
|
#
|
|
7233
7277
|
# @option params [Array<Types::AttachmentStateChange>] :attachments
|
|
7234
7278
|
# Any attachments associated with the state change request.
|
|
7235
7279
|
#
|
|
7236
7280
|
# @option params [Array<Types::ManagedAgentStateChange>] :managed_agents
|
|
7237
|
-
# The details for the managed agent associated with the task.
|
|
7281
|
+
# The details for the managed agent that's associated with the task.
|
|
7238
7282
|
#
|
|
7239
7283
|
# @option params [Time,DateTime,Date,Integer,String] :pull_started_at
|
|
7240
|
-
# The Unix timestamp for when the container image pull
|
|
7284
|
+
# The Unix timestamp for the time when the container image pull started.
|
|
7241
7285
|
#
|
|
7242
7286
|
# @option params [Time,DateTime,Date,Integer,String] :pull_stopped_at
|
|
7243
|
-
# The Unix timestamp for when the container image pull
|
|
7287
|
+
# The Unix timestamp for the time when the container image pull
|
|
7288
|
+
# completed.
|
|
7244
7289
|
#
|
|
7245
7290
|
# @option params [Time,DateTime,Date,Integer,String] :execution_stopped_at
|
|
7246
|
-
# The Unix timestamp for when the task execution stopped.
|
|
7291
|
+
# The Unix timestamp for the time when the task execution stopped.
|
|
7247
7292
|
#
|
|
7248
7293
|
# @return [Types::SubmitTaskStateChangeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7249
7294
|
#
|
|
@@ -7307,12 +7352,12 @@ module Aws::ECS
|
|
|
7307
7352
|
end
|
|
7308
7353
|
|
|
7309
7354
|
# Associates the specified tags to a resource with the specified
|
|
7310
|
-
# `resourceArn`. If existing tags on a resource
|
|
7311
|
-
# request parameters, they
|
|
7312
|
-
# the tags associated with that resource are deleted as well.
|
|
7355
|
+
# `resourceArn`. If existing tags on a resource aren't specified in the
|
|
7356
|
+
# request parameters, they aren't changed. When a resource is deleted,
|
|
7357
|
+
# the tags that are associated with that resource are deleted as well.
|
|
7313
7358
|
#
|
|
7314
7359
|
# @option params [required, String] :resource_arn
|
|
7315
|
-
# The Amazon Resource Name (ARN) of the resource to
|
|
7360
|
+
# The Amazon Resource Name (ARN) of the resource to add tags to.
|
|
7316
7361
|
# Currently, the supported resources are Amazon ECS capacity providers,
|
|
7317
7362
|
# tasks, services, task definitions, clusters, and container instances.
|
|
7318
7363
|
#
|
|
@@ -7389,10 +7434,9 @@ module Aws::ECS
|
|
|
7389
7434
|
# Deletes specified tags from a resource.
|
|
7390
7435
|
#
|
|
7391
7436
|
# @option params [required, String] :resource_arn
|
|
7392
|
-
# The Amazon Resource Name (ARN) of the resource
|
|
7393
|
-
#
|
|
7394
|
-
#
|
|
7395
|
-
# instances.
|
|
7437
|
+
# The Amazon Resource Name (ARN) of the resource to delete tags from.
|
|
7438
|
+
# Currently, the supported resources are Amazon ECS capacity providers,
|
|
7439
|
+
# tasks, services, task definitions, clusters, and container instances.
|
|
7396
7440
|
#
|
|
7397
7441
|
# @option params [required, Array<String>] :tag_keys
|
|
7398
7442
|
# The keys of the tags to be removed.
|
|
@@ -7437,7 +7481,7 @@ module Aws::ECS
|
|
|
7437
7481
|
# The name of the capacity provider to update.
|
|
7438
7482
|
#
|
|
7439
7483
|
# @option params [required, Types::AutoScalingGroupProviderUpdate] :auto_scaling_group_provider
|
|
7440
|
-
# An object
|
|
7484
|
+
# An object that represent the parameters to update for the Auto Scaling
|
|
7441
7485
|
# group capacity provider.
|
|
7442
7486
|
#
|
|
7443
7487
|
# @return [Types::UpdateCapacityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -7584,7 +7628,7 @@ module Aws::ECS
|
|
|
7584
7628
|
# @option params [required, Array<Types::ClusterSetting>] :settings
|
|
7585
7629
|
# The setting to use by default for a cluster. This parameter is used to
|
|
7586
7630
|
# enable CloudWatch Container Insights for a cluster. If this value is
|
|
7587
|
-
# specified, it
|
|
7631
|
+
# specified, it overrides the `containerInsights` value set with
|
|
7588
7632
|
# PutAccountSetting or PutAccountSettingDefault.
|
|
7589
7633
|
#
|
|
7590
7634
|
# @return [Types::UpdateClusterSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -7653,7 +7697,7 @@ module Aws::ECS
|
|
|
7653
7697
|
end
|
|
7654
7698
|
|
|
7655
7699
|
# Updates the Amazon ECS container agent on a specified container
|
|
7656
|
-
# instance. Updating the Amazon ECS container agent
|
|
7700
|
+
# instance. Updating the Amazon ECS container agent doesn't interrupt
|
|
7657
7701
|
# running tasks or services on the container instance. The process for
|
|
7658
7702
|
# updating the agent differs depending on whether your container
|
|
7659
7703
|
# instance was launched with the Amazon ECS-optimized AMI or another
|
|
@@ -7661,10 +7705,10 @@ module Aws::ECS
|
|
|
7661
7705
|
#
|
|
7662
7706
|
# <note markdown="1"> The `UpdateContainerAgent` API isn't supported for container
|
|
7663
7707
|
# instances using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI.
|
|
7664
|
-
# To update the container agent, you can update the `ecs-init` package
|
|
7665
|
-
#
|
|
7666
|
-
#
|
|
7667
|
-
#
|
|
7708
|
+
# To update the container agent, you can update the `ecs-init` package.
|
|
7709
|
+
# This updates the agent. For more information, see [Updating the Amazon
|
|
7710
|
+
# ECS container agent][1] in the *Amazon Elastic Container Service
|
|
7711
|
+
# Developer Guide*.
|
|
7668
7712
|
#
|
|
7669
7713
|
# </note>
|
|
7670
7714
|
#
|
|
@@ -7686,7 +7730,7 @@ module Aws::ECS
|
|
|
7686
7730
|
#
|
|
7687
7731
|
# @option params [required, String] :container_instance
|
|
7688
7732
|
# The container instance ID or full ARN entries for the container
|
|
7689
|
-
# instance
|
|
7733
|
+
# instance where you would like to update the Amazon ECS container
|
|
7690
7734
|
# agent.
|
|
7691
7735
|
#
|
|
7692
7736
|
# @return [Types::UpdateContainerAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -7747,6 +7791,12 @@ module Aws::ECS
|
|
|
7747
7791
|
# resp.container_instance.tags #=> Array
|
|
7748
7792
|
# resp.container_instance.tags[0].key #=> String
|
|
7749
7793
|
# resp.container_instance.tags[0].value #=> String
|
|
7794
|
+
# resp.container_instance.health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
7795
|
+
# resp.container_instance.health_status.details #=> Array
|
|
7796
|
+
# resp.container_instance.health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
|
|
7797
|
+
# resp.container_instance.health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
7798
|
+
# resp.container_instance.health_status.details[0].last_updated #=> Time
|
|
7799
|
+
# resp.container_instance.health_status.details[0].last_status_change #=> Time
|
|
7750
7800
|
#
|
|
7751
7801
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerAgent AWS API Documentation
|
|
7752
7802
|
#
|
|
@@ -7764,7 +7814,7 @@ module Aws::ECS
|
|
|
7764
7814
|
# remove an instance from a cluster, for example to perform system
|
|
7765
7815
|
# updates, update the Docker daemon, or scale down the cluster size.
|
|
7766
7816
|
#
|
|
7767
|
-
# A container instance
|
|
7817
|
+
# A container instance can't be changed to `DRAINING` until it has
|
|
7768
7818
|
# reached an `ACTIVE` status. If the instance is in any other status, an
|
|
7769
7819
|
# error will be received.
|
|
7770
7820
|
#
|
|
@@ -7788,22 +7838,23 @@ module Aws::ECS
|
|
|
7788
7838
|
# minimum is 100%, the service scheduler can't remove existing tasks
|
|
7789
7839
|
# until the replacement tasks are considered healthy. Tasks for
|
|
7790
7840
|
# services that do not use a load balancer are considered healthy if
|
|
7791
|
-
# they
|
|
7792
|
-
# balancer are considered healthy if they
|
|
7793
|
-
# and the container instance they
|
|
7841
|
+
# they're in the `RUNNING` state. Tasks for services that use a load
|
|
7842
|
+
# balancer are considered healthy if they're in the `RUNNING` state
|
|
7843
|
+
# and the container instance they're hosted on is reported as healthy
|
|
7794
7844
|
# by the load balancer.
|
|
7795
7845
|
#
|
|
7796
7846
|
# * The `maximumPercent` parameter represents an upper limit on the
|
|
7797
|
-
# number of running tasks during task replacement
|
|
7798
|
-
#
|
|
7799
|
-
#
|
|
7800
|
-
#
|
|
7801
|
-
#
|
|
7802
|
-
#
|
|
7847
|
+
# number of running tasks during task replacement. You can use this to
|
|
7848
|
+
# define the replacement batch size. For example, if `desiredCount` is
|
|
7849
|
+
# four tasks, a maximum of 200% starts four new tasks before stopping
|
|
7850
|
+
# the four tasks to be drained, provided that the cluster resources
|
|
7851
|
+
# required to do this are available. If the maximum is 100%, then
|
|
7852
|
+
# replacement tasks can't start until the draining tasks have
|
|
7803
7853
|
# stopped.
|
|
7804
7854
|
#
|
|
7805
|
-
# Any `PENDING` or `RUNNING` tasks that do not belong to a service
|
|
7806
|
-
#
|
|
7855
|
+
# Any `PENDING` or `RUNNING` tasks that do not belong to a service
|
|
7856
|
+
# aren't affected. You must wait for them to finish or stop them
|
|
7857
|
+
# manually.
|
|
7807
7858
|
#
|
|
7808
7859
|
# A container instance has completed draining when it has no more
|
|
7809
7860
|
# `RUNNING` tasks. You can verify this using ListTasks.
|
|
@@ -7821,13 +7872,13 @@ module Aws::ECS
|
|
|
7821
7872
|
# A list of container instance IDs or full ARN entries.
|
|
7822
7873
|
#
|
|
7823
7874
|
# @option params [required, String] :status
|
|
7824
|
-
# The container instance state
|
|
7825
|
-
#
|
|
7826
|
-
#
|
|
7827
|
-
#
|
|
7828
|
-
#
|
|
7829
|
-
#
|
|
7830
|
-
#
|
|
7875
|
+
# The container instance state to update the container instance with.
|
|
7876
|
+
# The only valid values for this action are `ACTIVE` and `DRAINING`. A
|
|
7877
|
+
# container instance can only be updated to `DRAINING` status once it
|
|
7878
|
+
# has reached an `ACTIVE` state. If a container instance is in
|
|
7879
|
+
# `REGISTERING`, `DEREGISTERING`, or `REGISTRATION_FAILED` state you can
|
|
7880
|
+
# describe the container instance but can't update the container
|
|
7881
|
+
# instance state.
|
|
7831
7882
|
#
|
|
7832
7883
|
# @return [Types::UpdateContainerInstancesStateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7833
7884
|
#
|
|
@@ -7890,6 +7941,12 @@ module Aws::ECS
|
|
|
7890
7941
|
# resp.container_instances[0].tags #=> Array
|
|
7891
7942
|
# resp.container_instances[0].tags[0].key #=> String
|
|
7892
7943
|
# resp.container_instances[0].tags[0].value #=> String
|
|
7944
|
+
# resp.container_instances[0].health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
7945
|
+
# resp.container_instances[0].health_status.details #=> Array
|
|
7946
|
+
# resp.container_instances[0].health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
|
|
7947
|
+
# resp.container_instances[0].health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
7948
|
+
# resp.container_instances[0].health_status.details[0].last_updated #=> Time
|
|
7949
|
+
# resp.container_instances[0].health_status.details[0].last_status_change #=> Time
|
|
7893
7950
|
# resp.failures #=> Array
|
|
7894
7951
|
# resp.failures[0].arn #=> String
|
|
7895
7952
|
# resp.failures[0].reason #=> String
|
|
@@ -7922,15 +7979,15 @@ module Aws::ECS
|
|
|
7922
7979
|
# placement constraints and strategies, and health check grace period
|
|
7923
7980
|
# can be updated using this API. If the network configuration, platform
|
|
7924
7981
|
# version, or task definition need to be updated, a new CodeDeploy
|
|
7925
|
-
# deployment
|
|
7926
|
-
#
|
|
7982
|
+
# deployment is created. For more information, see [CreateDeployment][2]
|
|
7983
|
+
# in the *CodeDeploy API Reference*.
|
|
7927
7984
|
#
|
|
7928
7985
|
# For services using an external deployment controller, you can update
|
|
7929
7986
|
# only the desired count, task placement constraints and strategies, and
|
|
7930
7987
|
# health check grace period using this API. If the launch type, load
|
|
7931
7988
|
# balancer, network configuration, platform version, or task definition
|
|
7932
|
-
# need to be updated,
|
|
7933
|
-
#
|
|
7989
|
+
# need to be updated, create a new task set. For more information, see
|
|
7990
|
+
# CreateTaskSet.
|
|
7934
7991
|
#
|
|
7935
7992
|
# You can add to or subtract from the number of instantiations of a task
|
|
7936
7993
|
# definition in a service by specifying the cluster that the service is
|
|
@@ -7944,7 +8001,7 @@ module Aws::ECS
|
|
|
7944
8001
|
#
|
|
7945
8002
|
# <note markdown="1"> If your updated Docker image uses the same tag as what is in the
|
|
7946
8003
|
# existing task definition for your service (for example,
|
|
7947
|
-
# `my_image:latest`), you
|
|
8004
|
+
# `my_image:latest`), you don't need to create a new revision of your
|
|
7948
8005
|
# task definition. You can update the service using the
|
|
7949
8006
|
# `forceNewDeployment` option. The new tasks launched by the deployment
|
|
7950
8007
|
# pull the current image/tag combination from your repository when they
|
|
@@ -7962,14 +8019,14 @@ module Aws::ECS
|
|
|
7962
8019
|
# `desiredCount` temporarily during a deployment. For example, if
|
|
7963
8020
|
# `desiredCount` is four tasks, a minimum of 50% allows the scheduler
|
|
7964
8021
|
# to stop two existing tasks before starting two new tasks. Tasks for
|
|
7965
|
-
# services that
|
|
7966
|
-
# they
|
|
7967
|
-
# balancer are considered healthy if they
|
|
7968
|
-
# and the container instance they
|
|
8022
|
+
# services that don't use a load balancer are considered healthy if
|
|
8023
|
+
# they're in the `RUNNING` state. Tasks for services that use a load
|
|
8024
|
+
# balancer are considered healthy if they're in the `RUNNING` state
|
|
8025
|
+
# and the container instance they're hosted on is reported as healthy
|
|
7969
8026
|
# by the load balancer.
|
|
7970
8027
|
#
|
|
7971
8028
|
# * The `maximumPercent` parameter represents an upper limit on the
|
|
7972
|
-
# number of running tasks during a deployment
|
|
8029
|
+
# number of running tasks during a deployment. You can use it to
|
|
7973
8030
|
# define the deployment batch size. For example, if `desiredCount` is
|
|
7974
8031
|
# four tasks, a maximum of 200% starts four new tasks before stopping
|
|
7975
8032
|
# the four older tasks (provided that the cluster resources required
|
|
@@ -7977,21 +8034,21 @@ module Aws::ECS
|
|
|
7977
8034
|
#
|
|
7978
8035
|
# When UpdateService stops a task during a deployment, the equivalent of
|
|
7979
8036
|
# `docker stop` is issued to the containers running in the task. This
|
|
7980
|
-
# results in a `SIGTERM` and a 30-second timeout
|
|
8037
|
+
# results in a `SIGTERM` and a 30-second timeout. After this, `SIGKILL`
|
|
7981
8038
|
# is sent and the containers are forcibly stopped. If the container
|
|
7982
8039
|
# handles the `SIGTERM` gracefully and exits within 30 seconds from
|
|
7983
8040
|
# receiving it, no `SIGKILL` is sent.
|
|
7984
8041
|
#
|
|
7985
8042
|
# When the service scheduler launches new tasks, it determines task
|
|
7986
|
-
# placement in your cluster with the following logic
|
|
8043
|
+
# placement in your cluster with the following logic.
|
|
7987
8044
|
#
|
|
7988
8045
|
# * Determine which of the container instances in your cluster can
|
|
7989
|
-
# support your service's task definition
|
|
7990
|
-
# required CPU, memory, ports, and container instance attributes
|
|
8046
|
+
# support your service's task definition. For example, they have the
|
|
8047
|
+
# required CPU, memory, ports, and container instance attributes.
|
|
7991
8048
|
#
|
|
7992
8049
|
# * By default, the service scheduler attempts to balance tasks across
|
|
7993
|
-
# Availability Zones in this manner
|
|
7994
|
-
# different placement strategy
|
|
8050
|
+
# Availability Zones in this manner even though you can choose a
|
|
8051
|
+
# different placement strategy.
|
|
7995
8052
|
#
|
|
7996
8053
|
# * Sort the valid container instances by the fewest number of running
|
|
7997
8054
|
# tasks for this service in the same Availability Zone as the
|
|
@@ -8025,8 +8082,8 @@ module Aws::ECS
|
|
|
8025
8082
|
#
|
|
8026
8083
|
# @option params [String] :cluster
|
|
8027
8084
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
8028
|
-
# your service
|
|
8029
|
-
#
|
|
8085
|
+
# your service runs on. If you do not specify a cluster, the default
|
|
8086
|
+
# cluster is assumed.
|
|
8030
8087
|
#
|
|
8031
8088
|
# @option params [required, String] :service
|
|
8032
8089
|
# The name of the service to update.
|
|
@@ -8046,11 +8103,11 @@ module Aws::ECS
|
|
|
8046
8103
|
# @option params [Array<Types::CapacityProviderStrategyItem>] :capacity_provider_strategy
|
|
8047
8104
|
# The capacity provider strategy to update the service to use.
|
|
8048
8105
|
#
|
|
8049
|
-
#
|
|
8106
|
+
# if the service uses the default capacity provider strategy for the
|
|
8050
8107
|
# cluster, the service can be updated to use one or more capacity
|
|
8051
8108
|
# providers as opposed to the default capacity provider strategy.
|
|
8052
|
-
# However, when a service is using a capacity provider strategy that
|
|
8053
|
-
# not the default capacity provider strategy, the service
|
|
8109
|
+
# However, when a service is using a capacity provider strategy that's
|
|
8110
|
+
# not the default capacity provider strategy, the service can't be
|
|
8054
8111
|
# updated to use the cluster's default capacity provider strategy.
|
|
8055
8112
|
#
|
|
8056
8113
|
# A capacity provider strategy consists of one or more capacity
|
|
@@ -8087,9 +8144,9 @@ module Aws::ECS
|
|
|
8087
8144
|
# override any existing placement constraints defined for the service.
|
|
8088
8145
|
# To remove all existing placement constraints, specify an empty array.
|
|
8089
8146
|
#
|
|
8090
|
-
# You can specify a maximum of 10 constraints
|
|
8147
|
+
# You can specify a maximum of 10 constraints for each task. This limit
|
|
8091
8148
|
# includes constraints in the task definition and those specified at
|
|
8092
|
-
# runtime
|
|
8149
|
+
# runtime.
|
|
8093
8150
|
#
|
|
8094
8151
|
# @option params [Array<Types::PlacementStrategy>] :placement_strategy
|
|
8095
8152
|
# The task placement strategy objects to update the service to use. If
|
|
@@ -8098,32 +8155,31 @@ module Aws::ECS
|
|
|
8098
8155
|
# the existing placement strategy defined for the service. To remove an
|
|
8099
8156
|
# existing placement strategy, specify an empty object.
|
|
8100
8157
|
#
|
|
8101
|
-
# You can specify a maximum of five strategy rules
|
|
8158
|
+
# You can specify a maximum of five strategy rules for each service.
|
|
8102
8159
|
#
|
|
8103
8160
|
# @option params [String] :platform_version
|
|
8104
|
-
# The platform version
|
|
8105
|
-
#
|
|
8106
|
-
#
|
|
8107
|
-
#
|
|
8108
|
-
#
|
|
8109
|
-
# Developer Guide*.
|
|
8161
|
+
# The platform version that your tasks in the service run on. A platform
|
|
8162
|
+
# version is only specified for tasks using the Fargate launch type. If
|
|
8163
|
+
# a platform version is not specified, the `LATEST` platform version is
|
|
8164
|
+
# used. For more information, see [Fargate Platform Versions][1] in the
|
|
8165
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
|
8110
8166
|
#
|
|
8111
8167
|
#
|
|
8112
8168
|
#
|
|
8113
8169
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
|
8114
8170
|
#
|
|
8115
8171
|
# @option params [Boolean] :force_new_deployment
|
|
8116
|
-
#
|
|
8117
|
-
#
|
|
8118
|
-
# with no service definition changes. For example, you
|
|
8119
|
-
# service's tasks to use a newer Docker image with the
|
|
8120
|
-
# combination (`my_image:latest`) or to roll Fargate
|
|
8121
|
-
# platform version.
|
|
8172
|
+
# Determines whether to force a new deployment of the service. By
|
|
8173
|
+
# default, deployments aren't forced. You can use this option to start
|
|
8174
|
+
# a new deployment with no service definition changes. For example, you
|
|
8175
|
+
# can update a service's tasks to use a newer Docker image with the
|
|
8176
|
+
# same image/tag combination (`my_image:latest`) or to roll Fargate
|
|
8177
|
+
# tasks onto a newer platform version.
|
|
8122
8178
|
#
|
|
8123
8179
|
# @option params [Integer] :health_check_grace_period_seconds
|
|
8124
8180
|
# The period of time, in seconds, that the Amazon ECS service scheduler
|
|
8125
|
-
#
|
|
8126
|
-
#
|
|
8181
|
+
# ignores unhealthy Elastic Load Balancing target health checks after a
|
|
8182
|
+
# task has first started. This is only valid if your service is
|
|
8127
8183
|
# configured to use a load balancer. If your service's tasks take a
|
|
8128
8184
|
# while to start and respond to Elastic Load Balancing health checks,
|
|
8129
8185
|
# you can specify a health check grace period of up to 2,147,483,647
|
|
@@ -8452,11 +8508,11 @@ module Aws::ECS
|
|
|
8452
8508
|
#
|
|
8453
8509
|
# @option params [required, String] :cluster
|
|
8454
8510
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
8455
|
-
# hosts the service that the task set
|
|
8511
|
+
# hosts the service that the task set is found in.
|
|
8456
8512
|
#
|
|
8457
8513
|
# @option params [required, String] :service
|
|
8458
8514
|
# The short name or full Amazon Resource Name (ARN) of the service that
|
|
8459
|
-
# the task set
|
|
8515
|
+
# the task set is found in.
|
|
8460
8516
|
#
|
|
8461
8517
|
# @option params [required, String] :task_set
|
|
8462
8518
|
# The short name or full Amazon Resource Name (ARN) of the task set to
|
|
@@ -8549,7 +8605,7 @@ module Aws::ECS
|
|
|
8549
8605
|
params: params,
|
|
8550
8606
|
config: config)
|
|
8551
8607
|
context[:gem_name] = 'aws-sdk-ecs'
|
|
8552
|
-
context[:gem_version] = '1.
|
|
8608
|
+
context[:gem_version] = '1.92.0'
|
|
8553
8609
|
Seahorse::Client::Request.new(handlers, context)
|
|
8554
8610
|
end
|
|
8555
8611
|
|