aws-sdk-ecs 1.86.0 → 1.90.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ecs/client.rb +568 -472
- data/lib/aws-sdk-ecs/client_api.rb +31 -0
- data/lib/aws-sdk-ecs/types.rb +1196 -987
- data/lib/aws-sdk-ecs.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-ecs/client.rb
CHANGED
|
@@ -285,6 +285,15 @@ module Aws::ECS
|
|
|
285
285
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
286
286
|
# requests are made, and retries are disabled.
|
|
287
287
|
#
|
|
288
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
|
289
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
|
290
|
+
# will be used if available.
|
|
291
|
+
#
|
|
292
|
+
# @option options [Boolean] :use_fips_endpoint
|
|
293
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
|
294
|
+
# When a `fips` region is used, the region is normalized and this config
|
|
295
|
+
# is set to `true`.
|
|
296
|
+
#
|
|
288
297
|
# @option options [Boolean] :validate_params (true)
|
|
289
298
|
# When `true`, request parameters are validated before
|
|
290
299
|
# sending the request.
|
|
@@ -341,24 +350,24 @@ module Aws::ECS
|
|
|
341
350
|
# with an Amazon ECS cluster and are used in capacity provider
|
|
342
351
|
# strategies to facilitate cluster auto scaling.
|
|
343
352
|
#
|
|
344
|
-
# Only capacity providers
|
|
353
|
+
# Only capacity providers that use an Auto Scaling group can be created.
|
|
345
354
|
# Amazon ECS tasks on Fargate use the `FARGATE` and `FARGATE_SPOT`
|
|
346
|
-
# capacity providers
|
|
347
|
-
#
|
|
355
|
+
# capacity providers. These providers are available to all accounts in
|
|
356
|
+
# the Amazon Web Services Regions that Fargate supports.
|
|
348
357
|
#
|
|
349
358
|
# @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`".
|
|
359
|
+
# The name of the capacity provider. Up to 255 characters are allowed.
|
|
360
|
+
# They include letters (both upper and lowercase letters), numbers,
|
|
361
|
+
# underscores (\_), and hyphens (-). The name can't be prefixed with
|
|
362
|
+
# "`aws`", "`ecs`", or "`fargate`".
|
|
354
363
|
#
|
|
355
364
|
# @option params [required, Types::AutoScalingGroupProvider] :auto_scaling_group_provider
|
|
356
365
|
# The details of the Auto Scaling group for the capacity provider.
|
|
357
366
|
#
|
|
358
367
|
# @option params [Array<Types::Tag>] :tags
|
|
359
|
-
# The metadata that you apply to the capacity provider to
|
|
360
|
-
#
|
|
361
|
-
# optional value
|
|
368
|
+
# The metadata that you apply to the capacity provider to categorize and
|
|
369
|
+
# organize them more conveniently. Each tag consists of a key and an
|
|
370
|
+
# optional value. You define both of them.
|
|
362
371
|
#
|
|
363
372
|
# The following basic restrictions apply to tags:
|
|
364
373
|
#
|
|
@@ -445,10 +454,10 @@ module Aws::ECS
|
|
|
445
454
|
# `CreateCluster` action.
|
|
446
455
|
#
|
|
447
456
|
# <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
|
-
#
|
|
457
|
+
# create the Amazon ECS service-linked role for your account. This is so
|
|
458
|
+
# that it can manage required resources in other Amazon Web Services
|
|
459
|
+
# services on your behalf. However, if the IAM user that makes the call
|
|
460
|
+
# doesn't have permissions to create the service-linked role, it isn't
|
|
452
461
|
# created. For more information, see [Using Service-Linked Roles for
|
|
453
462
|
# Amazon ECS][1] in the *Amazon Elastic Container Service Developer
|
|
454
463
|
# Guide*.
|
|
@@ -460,15 +469,15 @@ module Aws::ECS
|
|
|
460
469
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html
|
|
461
470
|
#
|
|
462
471
|
# @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.
|
|
472
|
+
# The name of your cluster. If you don't specify a name for your
|
|
473
|
+
# cluster, you create a cluster that's named `default`. Up to 255
|
|
474
|
+
# letters (uppercase and lowercase), numbers, underscores, and hyphens
|
|
475
|
+
# are allowed.
|
|
467
476
|
#
|
|
468
477
|
# @option params [Array<Types::Tag>] :tags
|
|
469
478
|
# 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
|
-
#
|
|
479
|
+
# organize them. Each tag consists of a key and an optional value. You
|
|
480
|
+
# define both.
|
|
472
481
|
#
|
|
473
482
|
# The following basic restrictions apply to tags:
|
|
474
483
|
#
|
|
@@ -498,7 +507,7 @@ module Aws::ECS
|
|
|
498
507
|
# @option params [Array<Types::ClusterSetting>] :settings
|
|
499
508
|
# The setting to use when creating a cluster. This parameter is used to
|
|
500
509
|
# enable CloudWatch Container Insights for a cluster. If this value is
|
|
501
|
-
# specified, it
|
|
510
|
+
# specified, it overrides the `containerInsights` value set with
|
|
502
511
|
# PutAccountSetting or PutAccountSettingDefault.
|
|
503
512
|
#
|
|
504
513
|
# @option params [Types::ClusterConfiguration] :configuration
|
|
@@ -512,9 +521,9 @@ module Aws::ECS
|
|
|
512
521
|
# the CreateService or RunTask actions.
|
|
513
522
|
#
|
|
514
523
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
|
515
|
-
# capacity provider must
|
|
516
|
-
#
|
|
517
|
-
#
|
|
524
|
+
# capacity provider must be created but not associated with another
|
|
525
|
+
# cluster. New Auto Scaling group capacity providers can be created with
|
|
526
|
+
# the CreateCapacityProvider API operation.
|
|
518
527
|
#
|
|
519
528
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
|
520
529
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
|
@@ -527,13 +536,13 @@ module Aws::ECS
|
|
|
527
536
|
#
|
|
528
537
|
# @option params [Array<Types::CapacityProviderStrategyItem>] :default_capacity_provider_strategy
|
|
529
538
|
# The capacity provider strategy to set as the default for the cluster.
|
|
530
|
-
#
|
|
531
|
-
#
|
|
539
|
+
# After a default capacity provider strategy is set for a cluster, when
|
|
540
|
+
# you call the RunTask or CreateService APIs with no capacity provider
|
|
532
541
|
# strategy or launch type specified, the default capacity provider
|
|
533
542
|
# strategy for the cluster is used.
|
|
534
543
|
#
|
|
535
|
-
# If a default capacity provider strategy
|
|
536
|
-
#
|
|
544
|
+
# If a default capacity provider strategy isn't defined for a cluster
|
|
545
|
+
# when it was created, it can be defined later with the
|
|
537
546
|
# PutClusterCapacityProviders API operation.
|
|
538
547
|
#
|
|
539
548
|
# @return [Types::CreateClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -650,7 +659,7 @@ module Aws::ECS
|
|
|
650
659
|
req.send_request(options)
|
|
651
660
|
end
|
|
652
661
|
|
|
653
|
-
# Runs and maintains
|
|
662
|
+
# Runs and maintains your desired number of tasks from a specified task
|
|
654
663
|
# definition. If the number of tasks running in a service drops below
|
|
655
664
|
# the `desiredCount`, Amazon ECS runs another copy of the task in the
|
|
656
665
|
# specified cluster. To update an existing service, see the
|
|
@@ -663,26 +672,27 @@ module Aws::ECS
|
|
|
663
672
|
# Balancing][1] in the *Amazon Elastic Container Service Developer
|
|
664
673
|
# Guide*.
|
|
665
674
|
#
|
|
666
|
-
# Tasks for services that
|
|
675
|
+
# Tasks for services that don't use a load balancer are considered
|
|
667
676
|
# healthy if they're in the `RUNNING` state. Tasks for services that
|
|
668
|
-
#
|
|
677
|
+
# use a load balancer are considered healthy if they're in the
|
|
669
678
|
# `RUNNING` state and the container instance that they're hosted on is
|
|
670
679
|
# reported as healthy by the load balancer.
|
|
671
680
|
#
|
|
672
681
|
# There are two service scheduler strategies available:
|
|
673
682
|
#
|
|
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
|
|
683
|
+
# * `REPLICA` - The replica scheduling strategy places and maintains
|
|
684
|
+
# your desired number of tasks across your cluster. By default, the
|
|
685
|
+
# service scheduler spreads tasks across Availability Zones. You can
|
|
686
|
+
# use task placement strategies and constraints to customize task
|
|
687
|
+
# placement decisions. For more information, see [Service Scheduler
|
|
688
|
+
# Concepts][2] in the *Amazon Elastic Container Service Developer
|
|
689
|
+
# Guide*.
|
|
680
690
|
#
|
|
681
691
|
# * `DAEMON` - The daemon scheduling strategy deploys exactly one task
|
|
682
692
|
# on each active container instance that meets all of the task
|
|
683
693
|
# placement constraints that you specify in your cluster. The service
|
|
684
694
|
# scheduler also evaluates the task placement constraints for running
|
|
685
|
-
# tasks
|
|
695
|
+
# tasks. It also stops tasks that don't meet the placement
|
|
686
696
|
# constraints. When using this strategy, you don't need to specify a
|
|
687
697
|
# desired number of tasks, a task placement strategy, or use Service
|
|
688
698
|
# Auto Scaling policies. For more information, see [Service Scheduler
|
|
@@ -690,51 +700,53 @@ module Aws::ECS
|
|
|
690
700
|
# Guide*.
|
|
691
701
|
#
|
|
692
702
|
# You can optionally specify a deployment configuration for your
|
|
693
|
-
# service. The deployment is
|
|
694
|
-
# the
|
|
695
|
-
#
|
|
703
|
+
# service. The deployment is initiated by changing properties. For
|
|
704
|
+
# example, the deployment might be initiated by the task definition or
|
|
705
|
+
# by your desired count of a service. This is done with an UpdateService
|
|
706
|
+
# operation. The default value for a replica service for
|
|
696
707
|
# `minimumHealthyPercent` is 100%. The default value for a daemon
|
|
697
708
|
# service for `minimumHealthyPercent` is 0%.
|
|
698
709
|
#
|
|
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
|
|
710
|
+
# If a service uses the `ECS` deployment controller, the minimum healthy
|
|
711
|
+
# percent represents a lower limit on the number of tasks in a service
|
|
712
|
+
# that must remain in the `RUNNING` state during a deployment.
|
|
713
|
+
# Specifically, it represents it as a percentage of your desired number
|
|
714
|
+
# of tasks (rounded up to the nearest integer). This happens when any of
|
|
715
|
+
# your container instances are in the `DRAINING` state if the service
|
|
716
|
+
# contains tasks using the EC2 launch type. Using this parameter, you
|
|
717
|
+
# can deploy without using additional cluster capacity. For example, if
|
|
718
|
+
# you set your service to have desired number of four tasks and a
|
|
719
|
+
# minimum healthy percent of 50%, the scheduler might stop two existing
|
|
720
|
+
# tasks to free up cluster capacity before starting two new tasks. If
|
|
721
|
+
# they're in the `RUNNING` state, tasks for services that don't use a
|
|
722
|
+
# load balancer are considered healthy . If they're in the `RUNNING`
|
|
723
|
+
# state and reported as healthy by the load balancer, tasks for services
|
|
724
|
+
# that *do* use a load balancer are considered healthy . The default
|
|
725
|
+
# value for minimum healthy percent is 100%.
|
|
726
|
+
#
|
|
727
|
+
# If a service uses the `ECS` deployment controller, the **maximum
|
|
717
728
|
# percent** parameter represents an upper limit on the number of tasks
|
|
718
729
|
# 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
|
-
#
|
|
730
|
+
# during a deployment. Specifically, it represents it as a percentage of
|
|
731
|
+
# the desired number of tasks (rounded down to the nearest integer).
|
|
732
|
+
# This happens when any of your container instances are in the
|
|
733
|
+
# `DRAINING` state if the service contains tasks using the EC2 launch
|
|
734
|
+
# type. Using this parameter, you can define the deployment batch size.
|
|
735
|
+
# For example, if your service has a desired number of four tasks and a
|
|
736
|
+
# maximum percent value of 200%, the scheduler may start four new tasks
|
|
737
|
+
# before stopping the four older tasks (provided that the cluster
|
|
738
|
+
# resources required to do this are available). The default value for
|
|
739
|
+
# maximum percent is 200%.
|
|
740
|
+
#
|
|
741
|
+
# If a service uses either the `CODE_DEPLOY` or `EXTERNAL` deployment
|
|
742
|
+
# controller types and tasks that use the EC2 launch type, the **minimum
|
|
743
|
+
# healthy percent** and **maximum percent** values are used only to
|
|
744
|
+
# define the lower and upper limit on the number of the tasks in the
|
|
745
|
+
# service that remain in the `RUNNING` state. This is while the
|
|
734
746
|
# container instances are in the `DRAINING` state. If the tasks in the
|
|
735
747
|
# service use the Fargate launch type, the minimum healthy percent and
|
|
736
|
-
# maximum percent values aren't used
|
|
737
|
-
# visible when describing your service.
|
|
748
|
+
# maximum percent values aren't used. This is the case even if they're
|
|
749
|
+
# currently visible when describing your service.
|
|
738
750
|
#
|
|
739
751
|
# When creating a service that uses the `EXTERNAL` deployment
|
|
740
752
|
# controller, you can specify only parameters that aren't controlled at
|
|
@@ -747,13 +759,13 @@ module Aws::ECS
|
|
|
747
759
|
# placement in your cluster using the following logic:
|
|
748
760
|
#
|
|
749
761
|
# * Determine which of the container instances in your cluster can
|
|
750
|
-
# support
|
|
751
|
-
# required CPU, memory, ports, and container instance attributes
|
|
762
|
+
# support the task definition of your service. For example, they have
|
|
763
|
+
# the required CPU, memory, ports, and container instance attributes.
|
|
752
764
|
#
|
|
753
765
|
# * By default, the service scheduler attempts to balance tasks across
|
|
754
|
-
# Availability Zones in this manner
|
|
755
|
-
# different placement strategy
|
|
756
|
-
# parameter
|
|
766
|
+
# Availability Zones in this manner. This is the case even if you can
|
|
767
|
+
# choose a different placement strategy with the `placementStrategy`
|
|
768
|
+
# parameter.
|
|
757
769
|
#
|
|
758
770
|
# * Sort the valid container instances, giving priority to instances
|
|
759
771
|
# that have the fewest number of running tasks for this service in
|
|
@@ -763,7 +775,7 @@ module Aws::ECS
|
|
|
763
775
|
# for placement.
|
|
764
776
|
#
|
|
765
777
|
# * Place the new service task on a valid container instance in an
|
|
766
|
-
# optimal Availability Zone
|
|
778
|
+
# optimal Availability Zone based on the previous steps, favoring
|
|
767
779
|
# container instances with the fewest number of running tasks for
|
|
768
780
|
# this service.
|
|
769
781
|
#
|
|
@@ -774,9 +786,9 @@ module Aws::ECS
|
|
|
774
786
|
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html
|
|
775
787
|
#
|
|
776
788
|
# @option params [String] :cluster
|
|
777
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
778
|
-
#
|
|
779
|
-
#
|
|
789
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
790
|
+
# you run your service on. If you do not specify a cluster, the default
|
|
791
|
+
# cluster is assumed.
|
|
780
792
|
#
|
|
781
793
|
# @option params [required, String] :service_name
|
|
782
794
|
# The name of your service. Up to 255 letters (uppercase and lowercase),
|
|
@@ -786,10 +798,10 @@ module Aws::ECS
|
|
|
786
798
|
#
|
|
787
799
|
# @option params [String] :task_definition
|
|
788
800
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
|
789
|
-
# task definition to run in your service. If a `revision`
|
|
801
|
+
# task definition to run in your service. If a `revision` isn't
|
|
790
802
|
# specified, the latest `ACTIVE` revision is used.
|
|
791
803
|
#
|
|
792
|
-
# A task definition must be specified if the service
|
|
804
|
+
# A task definition must be specified if the service uses either the
|
|
793
805
|
# `ECS` or `CODE_DEPLOY` deployment controllers.
|
|
794
806
|
#
|
|
795
807
|
# @option params [Array<Types::LoadBalancer>] :load_balancers
|
|
@@ -797,54 +809,56 @@ module Aws::ECS
|
|
|
797
809
|
# your service. For more information, see [Service Load Balancing][1] in
|
|
798
810
|
# the *Amazon Elastic Container Service Developer Guide*.
|
|
799
811
|
#
|
|
800
|
-
# If the service
|
|
801
|
-
#
|
|
802
|
-
#
|
|
803
|
-
#
|
|
804
|
-
#
|
|
805
|
-
#
|
|
806
|
-
#
|
|
812
|
+
# If the service uses the rolling update (`ECS`) deployment controller
|
|
813
|
+
# and using either an Application Load Balancer or Network Load
|
|
814
|
+
# Balancer, you must specify one or more target group ARNs to attach to
|
|
815
|
+
# the service. The service-linked role is required for services that use
|
|
816
|
+
# multiple target groups. For more information, see [Using
|
|
817
|
+
# service-linked roles for Amazon ECS][2] in the *Amazon Elastic
|
|
818
|
+
# Container Service Developer Guide*.
|
|
807
819
|
#
|
|
808
|
-
# If the service
|
|
820
|
+
# If the service uses the `CODE_DEPLOY` deployment controller, the
|
|
809
821
|
# service is required to use either an Application Load Balancer or
|
|
810
822
|
# Network Load Balancer. When creating an CodeDeploy deployment group,
|
|
811
823
|
# you specify two target groups (referred to as a `targetGroupPair`).
|
|
812
824
|
# 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.
|
|
825
|
+
# service has the status `PRIMARY`, and it associates one target group
|
|
826
|
+
# with it. Then, it also associates the other target group with the
|
|
827
|
+
# replacement task set. The load balancer can also have up to two
|
|
828
|
+
# listeners: a required listener for production traffic and an optional
|
|
829
|
+
# listener that you can use to perform validation tests with Lambda
|
|
830
|
+
# functions before routing production traffic to it.
|
|
819
831
|
#
|
|
820
832
|
# After you create a service using the `ECS` deployment controller, the
|
|
821
833
|
# load balancer name or target group ARN, container name, and container
|
|
822
|
-
# port specified in the service definition are immutable. If you
|
|
823
|
-
#
|
|
834
|
+
# port that's specified in the service definition are immutable. If you
|
|
835
|
+
# use the `CODE_DEPLOY` deployment controller, these values can be
|
|
824
836
|
# changed when updating the service.
|
|
825
837
|
#
|
|
826
838
|
# 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
|
|
839
|
+
# must contain the load balancer target group ARN, the container name,
|
|
840
|
+
# and the container port to access from the load balancer. The container
|
|
841
|
+
# name must be as it appears in a container definition. The load
|
|
842
|
+
# balancer name parameter must be omitted. When a task from this service
|
|
843
|
+
# is placed on a container instance, the container instance and port
|
|
844
|
+
# combination is registered as a target in the target group that's
|
|
845
|
+
# specified here.
|
|
833
846
|
#
|
|
834
847
|
# 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
|
|
848
|
+
# name, the container name , and the container port to access from the
|
|
849
|
+
# load balancer. The container name must be as it appears in a container
|
|
850
|
+
# definition. The target group ARN parameter must be omitted. When a
|
|
851
|
+
# task from this service is placed on a container instance, the
|
|
852
|
+
# container instance is registered with the load balancer that's
|
|
853
|
+
# specified here.
|
|
840
854
|
#
|
|
841
855
|
# Services with tasks that use the `awsvpc` network mode (for example,
|
|
842
856
|
# those with the Fargate launch type) only support Application Load
|
|
843
|
-
# Balancers and Network Load Balancers. Classic Load Balancers
|
|
857
|
+
# Balancers and Network Load Balancers. Classic Load Balancers aren't
|
|
844
858
|
# 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.
|
|
859
|
+
# you must choose `ip` as the target type, not `instance`. This is
|
|
860
|
+
# because tasks that use the `awsvpc` network mode are associated with
|
|
861
|
+
# an elastic network interface, not an Amazon EC2 instance.
|
|
848
862
|
#
|
|
849
863
|
#
|
|
850
864
|
#
|
|
@@ -856,7 +870,7 @@ module Aws::ECS
|
|
|
856
870
|
# service. For more information, see [Service discovery][1].
|
|
857
871
|
#
|
|
858
872
|
# <note markdown="1"> Each service may be associated with one service registry. Multiple
|
|
859
|
-
# service registries
|
|
873
|
+
# service registries for each service isn't supported.
|
|
860
874
|
#
|
|
861
875
|
# </note>
|
|
862
876
|
#
|
|
@@ -868,16 +882,17 @@ module Aws::ECS
|
|
|
868
882
|
# The number of instantiations of the specified task definition to place
|
|
869
883
|
# and keep running on your cluster.
|
|
870
884
|
#
|
|
871
|
-
# This is required if `schedulingStrategy` is `REPLICA` or
|
|
872
|
-
# specified. If `schedulingStrategy` is `DAEMON` then this
|
|
885
|
+
# This is required if `schedulingStrategy` is `REPLICA` or isn't
|
|
886
|
+
# specified. If `schedulingStrategy` is `DAEMON` then this isn't
|
|
873
887
|
# required.
|
|
874
888
|
#
|
|
875
889
|
# @option params [String] :client_token
|
|
876
|
-
#
|
|
877
|
-
#
|
|
890
|
+
# An identifier that you provide to ensure the idempotency of the
|
|
891
|
+
# request. It must be unique and is case sensitive. Up to 32 ASCII
|
|
892
|
+
# characters are allowed.
|
|
878
893
|
#
|
|
879
894
|
# @option params [String] :launch_type
|
|
880
|
-
# The infrastructure
|
|
895
|
+
# The infrastructure that you run your service on. For more information,
|
|
881
896
|
# see [Amazon ECS launch types][1] in the *Amazon Elastic Container
|
|
882
897
|
# Service Developer Guide*.
|
|
883
898
|
#
|
|
@@ -893,7 +908,7 @@ module Aws::ECS
|
|
|
893
908
|
# The `EC2` launch type runs your tasks on Amazon EC2 instances
|
|
894
909
|
# registered to your cluster.
|
|
895
910
|
#
|
|
896
|
-
# The `EXTERNAL` launch type runs your tasks on your on-
|
|
911
|
+
# The `EXTERNAL` launch type runs your tasks on your on-premises server
|
|
897
912
|
# or virtual machine (VM) capacity registered to your cluster.
|
|
898
913
|
#
|
|
899
914
|
# A service can use either a launch type or a capacity provider
|
|
@@ -919,9 +934,9 @@ module Aws::ECS
|
|
|
919
934
|
# @option params [String] :platform_version
|
|
920
935
|
# The platform version that your tasks in the service are running on. A
|
|
921
936
|
# 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
|
-
#
|
|
937
|
+
# type. If one isn't specified, the `LATEST` platform version is used.
|
|
938
|
+
# For more information, see [Fargate platform versions][1] in the
|
|
939
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
|
925
940
|
#
|
|
926
941
|
#
|
|
927
942
|
#
|
|
@@ -931,19 +946,19 @@ module Aws::ECS
|
|
|
931
946
|
# The name or full Amazon Resource Name (ARN) of the IAM role that
|
|
932
947
|
# allows Amazon ECS to make calls to your load balancer on your behalf.
|
|
933
948
|
# This parameter is only permitted if you are using a load balancer with
|
|
934
|
-
# your service and your task definition
|
|
949
|
+
# your service and your task definition doesn't use the `awsvpc`
|
|
935
950
|
# network mode. If you specify the `role` parameter, you must also
|
|
936
951
|
# specify a load balancer object with the `loadBalancers` parameter.
|
|
937
952
|
#
|
|
938
953
|
# If your account has already created the Amazon ECS service-linked
|
|
939
|
-
# role, that role is used
|
|
940
|
-
#
|
|
941
|
-
#
|
|
942
|
-
#
|
|
943
|
-
#
|
|
944
|
-
#
|
|
945
|
-
#
|
|
946
|
-
#
|
|
954
|
+
# role, that role is used for your service unless you specify a role
|
|
955
|
+
# here. The service-linked role is required if your task definition uses
|
|
956
|
+
# the `awsvpc` network mode or if the service is configured to use
|
|
957
|
+
# service discovery, an external deployment controller, multiple target
|
|
958
|
+
# groups, or Elastic Inference accelerators in which case you don't
|
|
959
|
+
# specify a role here. For more information, see [Using service-linked
|
|
960
|
+
# roles for Amazon ECS][1] in the *Amazon Elastic Container Service
|
|
961
|
+
# Developer Guide*.
|
|
947
962
|
#
|
|
948
963
|
# If your specified role has a path other than `/`, then you must either
|
|
949
964
|
# specify the full role ARN (this is recommended) or prefix the role
|
|
@@ -963,18 +978,18 @@ module Aws::ECS
|
|
|
963
978
|
#
|
|
964
979
|
# @option params [Array<Types::PlacementConstraint>] :placement_constraints
|
|
965
980
|
# 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
|
|
981
|
+
# service. You can specify a maximum of 10 constraints for each task.
|
|
982
|
+
# This limit includes constraints in the task definition and those
|
|
983
|
+
# specified at runtime.
|
|
969
984
|
#
|
|
970
985
|
# @option params [Array<Types::PlacementStrategy>] :placement_strategy
|
|
971
986
|
# The placement strategy objects to use for tasks in your service. You
|
|
972
|
-
# can specify a maximum of 5 strategy rules
|
|
987
|
+
# can specify a maximum of 5 strategy rules for each service.
|
|
973
988
|
#
|
|
974
989
|
# @option params [Types::NetworkConfiguration] :network_configuration
|
|
975
990
|
# The network configuration for the service. This parameter is required
|
|
976
991
|
# for task definitions that use the `awsvpc` network mode to receive
|
|
977
|
-
# their own elastic network interface, and it
|
|
992
|
+
# their own elastic network interface, and it isn't supported for other
|
|
978
993
|
# network modes. For more information, see [Task networking][1] in the
|
|
979
994
|
# *Amazon Elastic Container Service Developer Guide*.
|
|
980
995
|
#
|
|
@@ -984,18 +999,18 @@ module Aws::ECS
|
|
|
984
999
|
#
|
|
985
1000
|
# @option params [Integer] :health_check_grace_period_seconds
|
|
986
1001
|
# The period of time, in seconds, that the Amazon ECS service scheduler
|
|
987
|
-
#
|
|
988
|
-
#
|
|
1002
|
+
# ignores unhealthy Elastic Load Balancing target health checks after a
|
|
1003
|
+
# task has first started. This is only used when your service is
|
|
989
1004
|
# configured to use a load balancer. If your service has a load balancer
|
|
990
1005
|
# defined and you don't specify a health check grace period value, the
|
|
991
1006
|
# default value of `0` is used.
|
|
992
1007
|
#
|
|
993
1008
|
# If your service's tasks take a while to start and respond to Elastic
|
|
994
1009
|
# 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.
|
|
1010
|
+
# period of up to 2,147,483,647 seconds (about 69 years). During that
|
|
1011
|
+
# time, the Amazon ECS service scheduler ignores health check status.
|
|
1012
|
+
# This grace period can prevent the service scheduler from marking tasks
|
|
1013
|
+
# as unhealthy and stopping them before they have time to come up.
|
|
999
1014
|
#
|
|
1000
1015
|
# @option params [String] :scheduling_strategy
|
|
1001
1016
|
# The scheduling strategy to use for the service. For more information,
|
|
@@ -1007,14 +1022,14 @@ module Aws::ECS
|
|
|
1007
1022
|
# desired number of tasks across your cluster. By default, the service
|
|
1008
1023
|
# scheduler spreads tasks across Availability Zones. You can use task
|
|
1009
1024
|
# placement strategies and constraints to customize task placement
|
|
1010
|
-
# decisions. This scheduler strategy is required if the service
|
|
1011
|
-
#
|
|
1025
|
+
# decisions. This scheduler strategy is required if the service uses
|
|
1026
|
+
# the `CODE_DEPLOY` or `EXTERNAL` deployment controller types.
|
|
1012
1027
|
#
|
|
1013
1028
|
# * `DAEMON`-The daemon scheduling strategy deploys exactly one task on
|
|
1014
1029
|
# each active container instance that meets all of the task placement
|
|
1015
1030
|
# constraints that you specify in your cluster. The service scheduler
|
|
1016
1031
|
# also evaluates the task placement constraints for running tasks and
|
|
1017
|
-
# will stop tasks that
|
|
1032
|
+
# will stop tasks that don't meet the placement constraints. When
|
|
1018
1033
|
# you're using this strategy, you don't need to specify a desired
|
|
1019
1034
|
# number of tasks, a task placement strategy, or use Service Auto
|
|
1020
1035
|
# Scaling policies.
|
|
@@ -1077,15 +1092,15 @@ module Aws::ECS
|
|
|
1077
1092
|
# @option params [String] :propagate_tags
|
|
1078
1093
|
# Specifies whether to propagate the tags from the task definition or
|
|
1079
1094
|
# the service to the tasks in the service. If no value is specified, the
|
|
1080
|
-
# tags
|
|
1095
|
+
# tags aren't propagated. Tags can only be propagated to the tasks
|
|
1081
1096
|
# within the service during service creation. To add tags to a task
|
|
1082
1097
|
# after service creation or task creation, use the TagResource API
|
|
1083
1098
|
# action.
|
|
1084
1099
|
#
|
|
1085
1100
|
# @option params [Boolean] :enable_execute_command
|
|
1086
|
-
#
|
|
1087
|
-
# service. If `true`, this enables execute command functionality on
|
|
1088
|
-
# containers in the service tasks.
|
|
1101
|
+
# Determines whether the execute command functionality is enabled for
|
|
1102
|
+
# the service. If `true`, this enables execute command functionality on
|
|
1103
|
+
# all containers in the service tasks.
|
|
1089
1104
|
#
|
|
1090
1105
|
# @return [Types::CreateServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1091
1106
|
#
|
|
@@ -1311,6 +1326,7 @@ module Aws::ECS
|
|
|
1311
1326
|
# resp.service.capacity_provider_strategy[0].weight #=> Integer
|
|
1312
1327
|
# resp.service.capacity_provider_strategy[0].base #=> Integer
|
|
1313
1328
|
# resp.service.platform_version #=> String
|
|
1329
|
+
# resp.service.platform_family #=> String
|
|
1314
1330
|
# resp.service.task_definition #=> String
|
|
1315
1331
|
# resp.service.deployment_configuration.deployment_circuit_breaker.enable #=> Boolean
|
|
1316
1332
|
# resp.service.deployment_configuration.deployment_circuit_breaker.rollback #=> Boolean
|
|
@@ -1336,6 +1352,7 @@ module Aws::ECS
|
|
|
1336
1352
|
# resp.service.task_sets[0].capacity_provider_strategy[0].weight #=> Integer
|
|
1337
1353
|
# resp.service.task_sets[0].capacity_provider_strategy[0].base #=> Integer
|
|
1338
1354
|
# resp.service.task_sets[0].platform_version #=> String
|
|
1355
|
+
# resp.service.task_sets[0].platform_family #=> String
|
|
1339
1356
|
# resp.service.task_sets[0].network_configuration.awsvpc_configuration.subnets #=> Array
|
|
1340
1357
|
# resp.service.task_sets[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
|
|
1341
1358
|
# resp.service.task_sets[0].network_configuration.awsvpc_configuration.security_groups #=> Array
|
|
@@ -1374,6 +1391,7 @@ module Aws::ECS
|
|
|
1374
1391
|
# resp.service.deployments[0].capacity_provider_strategy[0].base #=> Integer
|
|
1375
1392
|
# resp.service.deployments[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
|
|
1376
1393
|
# resp.service.deployments[0].platform_version #=> String
|
|
1394
|
+
# resp.service.deployments[0].platform_family #=> String
|
|
1377
1395
|
# resp.service.deployments[0].network_configuration.awsvpc_configuration.subnets #=> Array
|
|
1378
1396
|
# resp.service.deployments[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
|
|
1379
1397
|
# resp.service.deployments[0].network_configuration.awsvpc_configuration.security_groups #=> Array
|
|
@@ -1462,7 +1480,7 @@ module Aws::ECS
|
|
|
1462
1480
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html
|
|
1463
1481
|
#
|
|
1464
1482
|
# @option params [String] :launch_type
|
|
1465
|
-
# The launch type that new tasks in the task set
|
|
1483
|
+
# The launch type that new tasks in the task set uses. For more
|
|
1466
1484
|
# information, see [Amazon ECS Launch Types][1] in the *Amazon Elastic
|
|
1467
1485
|
# Container Service Developer Guide*.
|
|
1468
1486
|
#
|
|
@@ -1502,24 +1520,23 @@ module Aws::ECS
|
|
|
1502
1520
|
# is created.
|
|
1503
1521
|
#
|
|
1504
1522
|
# @option params [String] :platform_version
|
|
1505
|
-
# The platform version that the tasks in the task set
|
|
1506
|
-
#
|
|
1507
|
-
#
|
|
1508
|
-
# by default.
|
|
1523
|
+
# The platform version that the tasks in the task set uses. A platform
|
|
1524
|
+
# version is specified only for tasks using the Fargate launch type. If
|
|
1525
|
+
# one isn't specified, the `LATEST` platform version is used.
|
|
1509
1526
|
#
|
|
1510
1527
|
# @option params [Types::Scale] :scale
|
|
1511
1528
|
# A floating-point percentage of the desired number of tasks to place
|
|
1512
1529
|
# and keep running in the task set.
|
|
1513
1530
|
#
|
|
1514
1531
|
# @option params [String] :client_token
|
|
1515
|
-
#
|
|
1516
|
-
#
|
|
1532
|
+
# The identifier that you provide to ensure the idempotency of the
|
|
1533
|
+
# request. It's case sensitive and must be unique. It can be up to 32
|
|
1534
|
+
# ASCII characters are allowed.
|
|
1517
1535
|
#
|
|
1518
1536
|
# @option params [Array<Types::Tag>] :tags
|
|
1519
1537
|
# The metadata that you apply to the task set to help you categorize and
|
|
1520
|
-
# organize them. Each tag consists of a key and an optional value
|
|
1521
|
-
#
|
|
1522
|
-
# as well.
|
|
1538
|
+
# organize them. Each tag consists of a key and an optional value. You
|
|
1539
|
+
# define both. When a service is deleted, the tags are deleted.
|
|
1523
1540
|
#
|
|
1524
1541
|
# The following basic restrictions apply to tags:
|
|
1525
1542
|
#
|
|
@@ -1623,6 +1640,7 @@ module Aws::ECS
|
|
|
1623
1640
|
# resp.task_set.capacity_provider_strategy[0].weight #=> Integer
|
|
1624
1641
|
# resp.task_set.capacity_provider_strategy[0].base #=> Integer
|
|
1625
1642
|
# resp.task_set.platform_version #=> String
|
|
1643
|
+
# resp.task_set.platform_family #=> String
|
|
1626
1644
|
# resp.task_set.network_configuration.awsvpc_configuration.subnets #=> Array
|
|
1627
1645
|
# resp.task_set.network_configuration.awsvpc_configuration.subnets[0] #=> String
|
|
1628
1646
|
# resp.task_set.network_configuration.awsvpc_configuration.security_groups #=> Array
|
|
@@ -1659,7 +1677,7 @@ module Aws::ECS
|
|
|
1659
1677
|
# root user for an account.
|
|
1660
1678
|
#
|
|
1661
1679
|
# @option params [required, String] :name
|
|
1662
|
-
# The resource name
|
|
1680
|
+
# The resource name to disable the account setting for. If
|
|
1663
1681
|
# `serviceLongArnFormat` is specified, the ARN for your Amazon ECS
|
|
1664
1682
|
# services is affected. If `taskLongArnFormat` is specified, the ARN and
|
|
1665
1683
|
# resource ID for your Amazon ECS tasks is affected. If
|
|
@@ -1669,12 +1687,12 @@ module Aws::ECS
|
|
|
1669
1687
|
# container instances is affected.
|
|
1670
1688
|
#
|
|
1671
1689
|
# @option params [String] :principal_arn
|
|
1672
|
-
# The ARN of the principal
|
|
1673
|
-
# root user. If you specify the root user, it
|
|
1674
|
-
# setting for all IAM users, IAM roles, and the
|
|
1675
|
-
# unless an IAM user or role explicitly
|
|
1676
|
-
# this field is omitted, the setting is
|
|
1677
|
-
# authenticated user.
|
|
1690
|
+
# The Amazon Resource Name (ARN) of the principal. It can be an IAM
|
|
1691
|
+
# user, IAM role, or the root user. If you specify the root user, it
|
|
1692
|
+
# disables the account setting for all IAM users, IAM roles, and the
|
|
1693
|
+
# root user of the account unless an IAM user or role explicitly
|
|
1694
|
+
# overrides these settings. If this field is omitted, the setting is
|
|
1695
|
+
# changed only for the authenticated user.
|
|
1678
1696
|
#
|
|
1679
1697
|
# @return [Types::DeleteAccountSettingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1680
1698
|
#
|
|
@@ -1748,9 +1766,10 @@ module Aws::ECS
|
|
|
1748
1766
|
#
|
|
1749
1767
|
# @option params [required, Array<Types::Attribute>] :attributes
|
|
1750
1768
|
# The attributes to delete from your resource. You can specify up to 10
|
|
1751
|
-
# attributes
|
|
1752
|
-
# name and target ID, but
|
|
1753
|
-
# target ID using the short form, you must also specify the
|
|
1769
|
+
# attributes for each request. For custom attributes, specify the
|
|
1770
|
+
# attribute name and target ID, but don't specify the value. If you
|
|
1771
|
+
# specify the target ID using the short form, you must also specify the
|
|
1772
|
+
# target type.
|
|
1754
1773
|
#
|
|
1755
1774
|
# @return [Types::DeleteAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1756
1775
|
#
|
|
@@ -1790,7 +1809,7 @@ module Aws::ECS
|
|
|
1790
1809
|
# Deletes the specified capacity provider.
|
|
1791
1810
|
#
|
|
1792
1811
|
# <note markdown="1"> The `FARGATE` and `FARGATE_SPOT` capacity providers are reserved and
|
|
1793
|
-
#
|
|
1812
|
+
# can't be deleted. You can disassociate them from a cluster using
|
|
1794
1813
|
# either the PutClusterCapacityProviders API or by deleting the cluster.
|
|
1795
1814
|
#
|
|
1796
1815
|
# </note>
|
|
@@ -1802,7 +1821,7 @@ module Aws::ECS
|
|
|
1802
1821
|
# `forceNewDeployment` option can be used to ensure that any tasks using
|
|
1803
1822
|
# the Amazon EC2 instance capacity provided by the capacity provider are
|
|
1804
1823
|
# transitioned to use the capacity from the remaining capacity
|
|
1805
|
-
# providers. Only capacity providers that
|
|
1824
|
+
# providers. Only capacity providers that aren't associated with a
|
|
1806
1825
|
# cluster can be deleted. To remove a capacity provider from a cluster,
|
|
1807
1826
|
# you can either use PutClusterCapacityProviders or delete the cluster.
|
|
1808
1827
|
#
|
|
@@ -1847,11 +1866,11 @@ module Aws::ECS
|
|
|
1847
1866
|
req.send_request(options)
|
|
1848
1867
|
end
|
|
1849
1868
|
|
|
1850
|
-
# Deletes the specified cluster. The cluster
|
|
1851
|
-
# `INACTIVE` state. Clusters with an `INACTIVE` status
|
|
1869
|
+
# Deletes the specified cluster. The cluster transitions to the
|
|
1870
|
+
# `INACTIVE` state. Clusters with an `INACTIVE` status might remain
|
|
1852
1871
|
# discoverable in your account for a period of time. However, this
|
|
1853
|
-
# behavior is subject to change in the future
|
|
1854
|
-
# `INACTIVE` clusters persisting.
|
|
1872
|
+
# behavior is subject to change in the future. We don't recommend that
|
|
1873
|
+
# you rely on `INACTIVE` clusters persisting.
|
|
1855
1874
|
#
|
|
1856
1875
|
# You must deregister all container instances from this cluster before
|
|
1857
1876
|
# you may delete it. You can list the container instances in a cluster
|
|
@@ -1945,7 +1964,7 @@ module Aws::ECS
|
|
|
1945
1964
|
|
|
1946
1965
|
# Deletes a specified service within a cluster. You can delete a service
|
|
1947
1966
|
# if you have no running tasks in it and the desired task count is zero.
|
|
1948
|
-
# If the service is actively maintaining tasks, you
|
|
1967
|
+
# If the service is actively maintaining tasks, you can't delete it,
|
|
1949
1968
|
# and you must update the service to a desired task count of zero. For
|
|
1950
1969
|
# more information, see UpdateService.
|
|
1951
1970
|
#
|
|
@@ -1975,9 +1994,9 @@ module Aws::ECS
|
|
|
1975
1994
|
# The name of the service to delete.
|
|
1976
1995
|
#
|
|
1977
1996
|
# @option params [Boolean] :force
|
|
1978
|
-
# If `true`, allows you to delete a service even if it
|
|
1979
|
-
#
|
|
1980
|
-
#
|
|
1997
|
+
# If `true`, allows you to delete a service even if it wasn't scaled
|
|
1998
|
+
# down to zero tasks. It's only necessary to use this if the service
|
|
1999
|
+
# uses the `REPLICA` scheduling strategy.
|
|
1981
2000
|
#
|
|
1982
2001
|
# @return [Types::DeleteServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1983
2002
|
#
|
|
@@ -2030,6 +2049,7 @@ module Aws::ECS
|
|
|
2030
2049
|
# resp.service.capacity_provider_strategy[0].weight #=> Integer
|
|
2031
2050
|
# resp.service.capacity_provider_strategy[0].base #=> Integer
|
|
2032
2051
|
# resp.service.platform_version #=> String
|
|
2052
|
+
# resp.service.platform_family #=> String
|
|
2033
2053
|
# resp.service.task_definition #=> String
|
|
2034
2054
|
# resp.service.deployment_configuration.deployment_circuit_breaker.enable #=> Boolean
|
|
2035
2055
|
# resp.service.deployment_configuration.deployment_circuit_breaker.rollback #=> Boolean
|
|
@@ -2055,6 +2075,7 @@ module Aws::ECS
|
|
|
2055
2075
|
# resp.service.task_sets[0].capacity_provider_strategy[0].weight #=> Integer
|
|
2056
2076
|
# resp.service.task_sets[0].capacity_provider_strategy[0].base #=> Integer
|
|
2057
2077
|
# resp.service.task_sets[0].platform_version #=> String
|
|
2078
|
+
# resp.service.task_sets[0].platform_family #=> String
|
|
2058
2079
|
# resp.service.task_sets[0].network_configuration.awsvpc_configuration.subnets #=> Array
|
|
2059
2080
|
# resp.service.task_sets[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
|
|
2060
2081
|
# resp.service.task_sets[0].network_configuration.awsvpc_configuration.security_groups #=> Array
|
|
@@ -2093,6 +2114,7 @@ module Aws::ECS
|
|
|
2093
2114
|
# resp.service.deployments[0].capacity_provider_strategy[0].base #=> Integer
|
|
2094
2115
|
# resp.service.deployments[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
|
|
2095
2116
|
# resp.service.deployments[0].platform_version #=> String
|
|
2117
|
+
# resp.service.deployments[0].platform_family #=> String
|
|
2096
2118
|
# resp.service.deployments[0].network_configuration.awsvpc_configuration.subnets #=> Array
|
|
2097
2119
|
# resp.service.deployments[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
|
|
2098
2120
|
# resp.service.deployments[0].network_configuration.awsvpc_configuration.security_groups #=> Array
|
|
@@ -2148,7 +2170,7 @@ module Aws::ECS
|
|
|
2148
2170
|
#
|
|
2149
2171
|
# @option params [required, String] :cluster
|
|
2150
2172
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
2151
|
-
# hosts the service that the task set
|
|
2173
|
+
# hosts the service that the task set found in to delete.
|
|
2152
2174
|
#
|
|
2153
2175
|
# @option params [required, String] :service
|
|
2154
2176
|
# The short name or full Amazon Resource Name (ARN) of the service that
|
|
@@ -2159,8 +2181,8 @@ module Aws::ECS
|
|
|
2159
2181
|
# delete.
|
|
2160
2182
|
#
|
|
2161
2183
|
# @option params [Boolean] :force
|
|
2162
|
-
# If `true`,
|
|
2163
|
-
#
|
|
2184
|
+
# If `true`, you can delete a task set even if it hasn't been scaled
|
|
2185
|
+
# down to zero.
|
|
2164
2186
|
#
|
|
2165
2187
|
# @return [Types::DeleteTaskSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2166
2188
|
#
|
|
@@ -2196,6 +2218,7 @@ module Aws::ECS
|
|
|
2196
2218
|
# resp.task_set.capacity_provider_strategy[0].weight #=> Integer
|
|
2197
2219
|
# resp.task_set.capacity_provider_strategy[0].base #=> Integer
|
|
2198
2220
|
# resp.task_set.platform_version #=> String
|
|
2221
|
+
# resp.task_set.platform_family #=> String
|
|
2199
2222
|
# resp.task_set.network_configuration.awsvpc_configuration.subnets #=> Array
|
|
2200
2223
|
# resp.task_set.network_configuration.awsvpc_configuration.subnets[0] #=> String
|
|
2201
2224
|
# resp.task_set.network_configuration.awsvpc_configuration.security_groups #=> Array
|
|
@@ -2232,18 +2255,18 @@ module Aws::ECS
|
|
|
2232
2255
|
# cluster. This instance is no longer available to run tasks.
|
|
2233
2256
|
#
|
|
2234
2257
|
# If you intend to use the container instance for some other purpose
|
|
2235
|
-
# after deregistration, you
|
|
2236
|
-
# container instance before deregistration. That prevents
|
|
2237
|
-
# tasks from consuming resources.
|
|
2258
|
+
# after deregistration, we recommend that you stop all of the tasks
|
|
2259
|
+
# running on the container instance before deregistration. That prevents
|
|
2260
|
+
# any orphaned tasks from consuming resources.
|
|
2238
2261
|
#
|
|
2239
2262
|
# Deregistering a container instance removes the instance from a
|
|
2240
|
-
# cluster, but it
|
|
2263
|
+
# cluster, but it doesn't terminate the EC2 instance. If you are
|
|
2241
2264
|
# finished using the instance, be sure to terminate it in the Amazon EC2
|
|
2242
2265
|
# console to stop billing.
|
|
2243
2266
|
#
|
|
2244
2267
|
# <note markdown="1"> If you terminate a running container instance, Amazon ECS
|
|
2245
2268
|
# automatically deregisters the instance from your cluster (stopped
|
|
2246
|
-
# container instances or instances with disconnected agents
|
|
2269
|
+
# container instances or instances with disconnected agents aren't
|
|
2247
2270
|
# automatically deregistered when terminated).
|
|
2248
2271
|
#
|
|
2249
2272
|
# </note>
|
|
@@ -2262,10 +2285,10 @@ module Aws::ECS
|
|
|
2262
2285
|
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
|
2263
2286
|
#
|
|
2264
2287
|
# @option params [Boolean] :force
|
|
2265
|
-
# Forces the
|
|
2288
|
+
# Forces the container instance to be deregistered. If you have tasks
|
|
2266
2289
|
# running on the container instance when you deregister it with the
|
|
2267
2290
|
# `force` option, these tasks remain running until you terminate the
|
|
2268
|
-
# instance or the tasks stop through some other means, but they
|
|
2291
|
+
# instance or the tasks stop through some other means, but they're
|
|
2269
2292
|
# orphaned (no longer monitored or accounted for by Amazon ECS). If an
|
|
2270
2293
|
# orphaned task on your container instance is part of an Amazon ECS
|
|
2271
2294
|
# service, then the service scheduler starts another copy of that task,
|
|
@@ -2351,6 +2374,12 @@ module Aws::ECS
|
|
|
2351
2374
|
# resp.container_instance.tags #=> Array
|
|
2352
2375
|
# resp.container_instance.tags[0].key #=> String
|
|
2353
2376
|
# resp.container_instance.tags[0].value #=> String
|
|
2377
|
+
# resp.container_instance.health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
2378
|
+
# resp.container_instance.health_status.details #=> Array
|
|
2379
|
+
# resp.container_instance.health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
|
|
2380
|
+
# resp.container_instance.health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
2381
|
+
# resp.container_instance.health_status.details[0].last_updated #=> Time
|
|
2382
|
+
# resp.container_instance.health_status.details[0].last_status_change #=> Time
|
|
2354
2383
|
#
|
|
2355
2384
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterContainerInstance AWS API Documentation
|
|
2356
2385
|
#
|
|
@@ -2368,16 +2397,17 @@ module Aws::ECS
|
|
|
2368
2397
|
# an `INACTIVE` task definition can still scale up or down by modifying
|
|
2369
2398
|
# the service's desired count.
|
|
2370
2399
|
#
|
|
2371
|
-
# You
|
|
2372
|
-
# create new services, and you
|
|
2400
|
+
# You can't use an `INACTIVE` task definition to run new tasks or
|
|
2401
|
+
# create new services, and you can't update an existing service to
|
|
2373
2402
|
# reference an `INACTIVE` task definition. However, there may be up to a
|
|
2374
2403
|
# 10-minute window following deregistration where these restrictions
|
|
2375
2404
|
# have not yet taken effect.
|
|
2376
2405
|
#
|
|
2377
2406
|
# <note markdown="1"> At this time, `INACTIVE` task definitions remain discoverable in your
|
|
2378
2407
|
# account indefinitely. However, this behavior is subject to change in
|
|
2379
|
-
# the future
|
|
2380
|
-
# persisting beyond the lifecycle of any associated tasks
|
|
2408
|
+
# the future. We don't recommend that you rely on `INACTIVE` task
|
|
2409
|
+
# definitions persisting beyond the lifecycle of any associated tasks
|
|
2410
|
+
# and services.
|
|
2381
2411
|
#
|
|
2382
2412
|
# </note>
|
|
2383
2413
|
#
|
|
@@ -2536,6 +2566,8 @@ module Aws::ECS
|
|
|
2536
2566
|
# resp.task_definition.placement_constraints[0].expression #=> String
|
|
2537
2567
|
# resp.task_definition.compatibilities #=> Array
|
|
2538
2568
|
# resp.task_definition.compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
|
|
2569
|
+
# resp.task_definition.runtime_platform.cpu_architecture #=> String, one of "X86_64", "ARM64"
|
|
2570
|
+
# resp.task_definition.runtime_platform.operating_system_family #=> String, one of "WINDOWS_SERVER_2019_FULL", "WINDOWS_SERVER_2019_CORE", "WINDOWS_SERVER_2016_FULL", "WINDOWS_SERVER_2004_CORE", "WINDOWS_SERVER_2022_CORE", "WINDOWS_SERVER_2022_FULL", "WINDOWS_SERVER_20H2_CORE", "LINUX"
|
|
2539
2571
|
# resp.task_definition.requires_compatibilities #=> Array
|
|
2540
2572
|
# resp.task_definition.requires_compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
|
|
2541
2573
|
# resp.task_definition.cpu #=> String
|
|
@@ -2574,7 +2606,7 @@ module Aws::ECS
|
|
|
2574
2606
|
# @option params [Array<String>] :include
|
|
2575
2607
|
# Specifies whether or not you want to see the resource tags for the
|
|
2576
2608
|
# capacity provider. If `TAGS` is specified, the tags are included in
|
|
2577
|
-
# the response. If this field is omitted, tags
|
|
2609
|
+
# the response. If this field is omitted, tags aren't included in the
|
|
2578
2610
|
# response.
|
|
2579
2611
|
#
|
|
2580
2612
|
# @option params [Integer] :max_results
|
|
@@ -2657,8 +2689,9 @@ module Aws::ECS
|
|
|
2657
2689
|
# assumed.
|
|
2658
2690
|
#
|
|
2659
2691
|
# @option params [Array<String>] :include
|
|
2660
|
-
#
|
|
2661
|
-
# response. If this field is omitted, this information
|
|
2692
|
+
# Determines whether to include additional information about the
|
|
2693
|
+
# clusters in the response. If this field is omitted, this information
|
|
2694
|
+
# isn't included.
|
|
2662
2695
|
#
|
|
2663
2696
|
# If `ATTACHMENTS` is specified, the attachments for the container
|
|
2664
2697
|
# instances or tasks within the cluster are included.
|
|
@@ -2781,7 +2814,9 @@ module Aws::ECS
|
|
|
2781
2814
|
# @option params [Array<String>] :include
|
|
2782
2815
|
# Specifies whether you want to see the resource tags for the container
|
|
2783
2816
|
# instance. If `TAGS` is specified, the tags are included in the
|
|
2784
|
-
# response. If
|
|
2817
|
+
# response. If `CONTAINER_INSTANCE_HEALTH` is specified, the container
|
|
2818
|
+
# instance health is included in the response. If this field is omitted,
|
|
2819
|
+
# tags and container instance health status aren't included in the
|
|
2785
2820
|
# response.
|
|
2786
2821
|
#
|
|
2787
2822
|
# @return [Types::DescribeContainerInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -2882,7 +2917,7 @@ module Aws::ECS
|
|
|
2882
2917
|
# resp = client.describe_container_instances({
|
|
2883
2918
|
# cluster: "String",
|
|
2884
2919
|
# container_instances: ["String"], # required
|
|
2885
|
-
# include: ["TAGS"], # accepts TAGS
|
|
2920
|
+
# include: ["TAGS"], # accepts TAGS, CONTAINER_INSTANCE_HEALTH
|
|
2886
2921
|
# })
|
|
2887
2922
|
#
|
|
2888
2923
|
# @example Response structure
|
|
@@ -2933,6 +2968,12 @@ module Aws::ECS
|
|
|
2933
2968
|
# resp.container_instances[0].tags #=> Array
|
|
2934
2969
|
# resp.container_instances[0].tags[0].key #=> String
|
|
2935
2970
|
# resp.container_instances[0].tags[0].value #=> String
|
|
2971
|
+
# resp.container_instances[0].health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
2972
|
+
# resp.container_instances[0].health_status.details #=> Array
|
|
2973
|
+
# resp.container_instances[0].health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
|
|
2974
|
+
# resp.container_instances[0].health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
2975
|
+
# resp.container_instances[0].health_status.details[0].last_updated #=> Time
|
|
2976
|
+
# resp.container_instances[0].health_status.details[0].last_status_change #=> Time
|
|
2936
2977
|
# resp.failures #=> Array
|
|
2937
2978
|
# resp.failures[0].arn #=> String
|
|
2938
2979
|
# resp.failures[0].reason #=> String
|
|
@@ -2961,9 +3002,9 @@ module Aws::ECS
|
|
|
2961
3002
|
# describe in a single operation.
|
|
2962
3003
|
#
|
|
2963
3004
|
# @option params [Array<String>] :include
|
|
2964
|
-
#
|
|
3005
|
+
# Determines whether you want to see the resource tags for the service.
|
|
2965
3006
|
# If `TAGS` is specified, the tags are included in the response. If this
|
|
2966
|
-
# field is omitted, tags
|
|
3007
|
+
# field is omitted, tags aren't included in the response.
|
|
2967
3008
|
#
|
|
2968
3009
|
# @return [Types::DescribeServicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2969
3010
|
#
|
|
@@ -3059,6 +3100,7 @@ module Aws::ECS
|
|
|
3059
3100
|
# resp.services[0].capacity_provider_strategy[0].weight #=> Integer
|
|
3060
3101
|
# resp.services[0].capacity_provider_strategy[0].base #=> Integer
|
|
3061
3102
|
# resp.services[0].platform_version #=> String
|
|
3103
|
+
# resp.services[0].platform_family #=> String
|
|
3062
3104
|
# resp.services[0].task_definition #=> String
|
|
3063
3105
|
# resp.services[0].deployment_configuration.deployment_circuit_breaker.enable #=> Boolean
|
|
3064
3106
|
# resp.services[0].deployment_configuration.deployment_circuit_breaker.rollback #=> Boolean
|
|
@@ -3084,6 +3126,7 @@ module Aws::ECS
|
|
|
3084
3126
|
# resp.services[0].task_sets[0].capacity_provider_strategy[0].weight #=> Integer
|
|
3085
3127
|
# resp.services[0].task_sets[0].capacity_provider_strategy[0].base #=> Integer
|
|
3086
3128
|
# resp.services[0].task_sets[0].platform_version #=> String
|
|
3129
|
+
# resp.services[0].task_sets[0].platform_family #=> String
|
|
3087
3130
|
# resp.services[0].task_sets[0].network_configuration.awsvpc_configuration.subnets #=> Array
|
|
3088
3131
|
# resp.services[0].task_sets[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
|
|
3089
3132
|
# resp.services[0].task_sets[0].network_configuration.awsvpc_configuration.security_groups #=> Array
|
|
@@ -3122,6 +3165,7 @@ module Aws::ECS
|
|
|
3122
3165
|
# resp.services[0].deployments[0].capacity_provider_strategy[0].base #=> Integer
|
|
3123
3166
|
# resp.services[0].deployments[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
|
|
3124
3167
|
# resp.services[0].deployments[0].platform_version #=> String
|
|
3168
|
+
# resp.services[0].deployments[0].platform_family #=> String
|
|
3125
3169
|
# resp.services[0].deployments[0].network_configuration.awsvpc_configuration.subnets #=> Array
|
|
3126
3170
|
# resp.services[0].deployments[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
|
|
3127
3171
|
# resp.services[0].deployments[0].network_configuration.awsvpc_configuration.security_groups #=> Array
|
|
@@ -3192,9 +3236,9 @@ module Aws::ECS
|
|
|
3192
3236
|
# Amazon Resource Name (ARN) of the task definition to describe.
|
|
3193
3237
|
#
|
|
3194
3238
|
# @option params [Array<String>] :include
|
|
3195
|
-
#
|
|
3196
|
-
# `TAGS` is specified, the tags are included in the response. If this
|
|
3197
|
-
# field is omitted, tags
|
|
3239
|
+
# Determines whether to see the resource tags for the task definition.
|
|
3240
|
+
# If `TAGS` is specified, the tags are included in the response. If this
|
|
3241
|
+
# field is omitted, tags aren't included in the response.
|
|
3198
3242
|
#
|
|
3199
3243
|
# @return [Types::DescribeTaskDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3200
3244
|
#
|
|
@@ -3411,6 +3455,8 @@ module Aws::ECS
|
|
|
3411
3455
|
# resp.task_definition.placement_constraints[0].expression #=> String
|
|
3412
3456
|
# resp.task_definition.compatibilities #=> Array
|
|
3413
3457
|
# resp.task_definition.compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
|
|
3458
|
+
# resp.task_definition.runtime_platform.cpu_architecture #=> String, one of "X86_64", "ARM64"
|
|
3459
|
+
# resp.task_definition.runtime_platform.operating_system_family #=> String, one of "WINDOWS_SERVER_2019_FULL", "WINDOWS_SERVER_2019_CORE", "WINDOWS_SERVER_2016_FULL", "WINDOWS_SERVER_2004_CORE", "WINDOWS_SERVER_2022_CORE", "WINDOWS_SERVER_2022_FULL", "WINDOWS_SERVER_20H2_CORE", "LINUX"
|
|
3414
3460
|
# resp.task_definition.requires_compatibilities #=> Array
|
|
3415
3461
|
# resp.task_definition.requires_compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
|
|
3416
3462
|
# resp.task_definition.cpu #=> String
|
|
@@ -3465,7 +3511,7 @@ module Aws::ECS
|
|
|
3465
3511
|
# @option params [Array<String>] :include
|
|
3466
3512
|
# Specifies whether to see the resource tags for the task set. If `TAGS`
|
|
3467
3513
|
# is specified, the tags are included in the response. If this field is
|
|
3468
|
-
# omitted, tags
|
|
3514
|
+
# omitted, tags aren't included in the response.
|
|
3469
3515
|
#
|
|
3470
3516
|
# @return [Types::DescribeTaskSetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3471
3517
|
#
|
|
@@ -3503,6 +3549,7 @@ module Aws::ECS
|
|
|
3503
3549
|
# resp.task_sets[0].capacity_provider_strategy[0].weight #=> Integer
|
|
3504
3550
|
# resp.task_sets[0].capacity_provider_strategy[0].base #=> Integer
|
|
3505
3551
|
# resp.task_sets[0].platform_version #=> String
|
|
3552
|
+
# resp.task_sets[0].platform_family #=> String
|
|
3506
3553
|
# resp.task_sets[0].network_configuration.awsvpc_configuration.subnets #=> Array
|
|
3507
3554
|
# resp.task_sets[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
|
|
3508
3555
|
# resp.task_sets[0].network_configuration.awsvpc_configuration.security_groups #=> Array
|
|
@@ -3554,7 +3601,7 @@ module Aws::ECS
|
|
|
3554
3601
|
# @option params [Array<String>] :include
|
|
3555
3602
|
# Specifies whether you want to see the resource tags for the task. If
|
|
3556
3603
|
# `TAGS` is specified, the tags are included in the response. If this
|
|
3557
|
-
# field is omitted, tags
|
|
3604
|
+
# field is omitted, tags aren't included in the response.
|
|
3558
3605
|
#
|
|
3559
3606
|
# @return [Types::DescribeTasksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3560
3607
|
#
|
|
@@ -3708,6 +3755,7 @@ module Aws::ECS
|
|
|
3708
3755
|
# resp.tasks[0].overrides.task_role_arn #=> String
|
|
3709
3756
|
# resp.tasks[0].overrides.ephemeral_storage.size_in_gi_b #=> Integer
|
|
3710
3757
|
# resp.tasks[0].platform_version #=> String
|
|
3758
|
+
# resp.tasks[0].platform_family #=> String
|
|
3711
3759
|
# resp.tasks[0].pull_started_at #=> Time
|
|
3712
3760
|
# resp.tasks[0].pull_stopped_at #=> Time
|
|
3713
3761
|
# resp.tasks[0].started_at #=> Time
|
|
@@ -3759,8 +3807,8 @@ module Aws::ECS
|
|
|
3759
3807
|
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
|
3760
3808
|
#
|
|
3761
3809
|
# @option params [String] :cluster
|
|
3762
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
3763
|
-
#
|
|
3810
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
3811
|
+
# the container instance belongs to.
|
|
3764
3812
|
#
|
|
3765
3813
|
# @return [Types::DiscoverPollEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3766
3814
|
#
|
|
@@ -3854,8 +3902,8 @@ module Aws::ECS
|
|
|
3854
3902
|
# The name of the account setting you want to list the settings for.
|
|
3855
3903
|
#
|
|
3856
3904
|
# @option params [String] :value
|
|
3857
|
-
# The value of the account settings
|
|
3858
|
-
#
|
|
3905
|
+
# The value of the account settings to filter results with. You must
|
|
3906
|
+
# also specify an account setting name to use this parameter.
|
|
3859
3907
|
#
|
|
3860
3908
|
# @option params [String] :principal_arn
|
|
3861
3909
|
# The ARN of the principal, which can be an IAM user, IAM role, or the
|
|
@@ -3868,16 +3916,16 @@ module Aws::ECS
|
|
|
3868
3916
|
# </note>
|
|
3869
3917
|
#
|
|
3870
3918
|
# @option params [Boolean] :effective_settings
|
|
3871
|
-
#
|
|
3919
|
+
# Determines whether to return the effective settings. If `true`, the
|
|
3872
3920
|
# account settings for the root user or the default setting for the
|
|
3873
3921
|
# `principalArn` are returned. If `false`, the account settings for the
|
|
3874
|
-
# `principalArn` are returned if they
|
|
3922
|
+
# `principalArn` are returned if they're set. Otherwise, no account
|
|
3875
3923
|
# settings are returned.
|
|
3876
3924
|
#
|
|
3877
3925
|
# @option params [String] :next_token
|
|
3878
3926
|
# The `nextToken` value returned from a `ListAccountSettings` request
|
|
3879
3927
|
# indicating that more results are available to fulfill the request and
|
|
3880
|
-
# further calls will be needed. If `maxResults` was provided, it
|
|
3928
|
+
# further calls will be needed. If `maxResults` was provided, it's
|
|
3881
3929
|
# possible the number of results to be fewer than `maxResults`.
|
|
3882
3930
|
#
|
|
3883
3931
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
|
@@ -3893,7 +3941,7 @@ module Aws::ECS
|
|
|
3893
3941
|
# single page along with a `nextToken` response element. The remaining
|
|
3894
3942
|
# results of the initial request can be seen by sending another
|
|
3895
3943
|
# `ListAccountSettings` request with the returned `nextToken` value.
|
|
3896
|
-
# This value can be between 1 and 10. If this parameter
|
|
3944
|
+
# This value can be between 1 and 10. If this parameter isn't used,
|
|
3897
3945
|
# then `ListAccountSettings` returns up to 10 results and a `nextToken`
|
|
3898
3946
|
# value if applicable.
|
|
3899
3947
|
#
|
|
@@ -3997,9 +4045,9 @@ module Aws::ECS
|
|
|
3997
4045
|
# `ListAttributes` returns a list of attribute objects, one for each
|
|
3998
4046
|
# attribute on each resource. You can filter the list of results to a
|
|
3999
4047
|
# single attribute name to only return results that have that name. You
|
|
4000
|
-
# can also filter the results by attribute name and value
|
|
4001
|
-
# to see which container instances in a cluster are
|
|
4002
|
-
# (`ecs.os-type=linux`).
|
|
4048
|
+
# can also filter the results by attribute name and value. You can do
|
|
4049
|
+
# this, for example, to see which container instances in a cluster are
|
|
4050
|
+
# running a Linux AMI (`ecs.os-type=linux`).
|
|
4003
4051
|
#
|
|
4004
4052
|
# @option params [String] :cluster
|
|
4005
4053
|
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
@@ -4007,20 +4055,20 @@ module Aws::ECS
|
|
|
4007
4055
|
# is assumed.
|
|
4008
4056
|
#
|
|
4009
4057
|
# @option params [required, String] :target_type
|
|
4010
|
-
# The type of the target
|
|
4058
|
+
# The type of the target to list attributes with.
|
|
4011
4059
|
#
|
|
4012
4060
|
# @option params [String] :attribute_name
|
|
4013
|
-
# The name of the attribute
|
|
4061
|
+
# The name of the attribute to filter the results with.
|
|
4014
4062
|
#
|
|
4015
4063
|
# @option params [String] :attribute_value
|
|
4016
|
-
# The value of the attribute
|
|
4064
|
+
# The value of the attribute to filter results with. You must also
|
|
4017
4065
|
# specify an attribute name to use this parameter.
|
|
4018
4066
|
#
|
|
4019
4067
|
# @option params [String] :next_token
|
|
4020
4068
|
# The `nextToken` value returned from a `ListAttributes` request
|
|
4021
4069
|
# indicating that more results are available to fulfill the request and
|
|
4022
|
-
# further calls
|
|
4023
|
-
#
|
|
4070
|
+
# further calls are needed. If `maxResults` was provided, it's possible
|
|
4071
|
+
# the number of results to be fewer than `maxResults`.
|
|
4024
4072
|
#
|
|
4025
4073
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
|
4026
4074
|
# to retrieve the next items in a list and not for other programmatic
|
|
@@ -4029,14 +4077,14 @@ module Aws::ECS
|
|
|
4029
4077
|
# </note>
|
|
4030
4078
|
#
|
|
4031
4079
|
# @option params [Integer] :max_results
|
|
4032
|
-
# The maximum number of cluster results
|
|
4033
|
-
# paginated output. When this parameter is used, `ListAttributes`
|
|
4034
|
-
# returns `maxResults` results in a single page along with a
|
|
4035
|
-
# response element. The remaining results of the initial
|
|
4036
|
-
# seen by sending another `ListAttributes` request with
|
|
4037
|
-
# `nextToken` value. This value can be between 1 and 100.
|
|
4038
|
-
# parameter
|
|
4039
|
-
# and a `nextToken` value if applicable.
|
|
4080
|
+
# The maximum number of cluster results that `ListAttributes` returned
|
|
4081
|
+
# in paginated output. When this parameter is used, `ListAttributes`
|
|
4082
|
+
# only returns `maxResults` results in a single page along with a
|
|
4083
|
+
# `nextToken` response element. The remaining results of the initial
|
|
4084
|
+
# request can be seen by sending another `ListAttributes` request with
|
|
4085
|
+
# the returned `nextToken` value. This value can be between 1 and 100.
|
|
4086
|
+
# If this parameter isn't used, then `ListAttributes` returns up to 100
|
|
4087
|
+
# results and a `nextToken` value if applicable.
|
|
4040
4088
|
#
|
|
4041
4089
|
# @return [Types::ListAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4042
4090
|
#
|
|
@@ -4079,8 +4127,8 @@ module Aws::ECS
|
|
|
4079
4127
|
# @option params [String] :next_token
|
|
4080
4128
|
# The `nextToken` value returned from a `ListClusters` request
|
|
4081
4129
|
# indicating that more results are available to fulfill the request and
|
|
4082
|
-
# further calls
|
|
4083
|
-
#
|
|
4130
|
+
# further calls are needed. If `maxResults` was provided, it's possible
|
|
4131
|
+
# the number of results to be fewer than `maxResults`.
|
|
4084
4132
|
#
|
|
4085
4133
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
|
4086
4134
|
# to retrieve the next items in a list and not for other programmatic
|
|
@@ -4089,13 +4137,13 @@ module Aws::ECS
|
|
|
4089
4137
|
# </note>
|
|
4090
4138
|
#
|
|
4091
4139
|
# @option params [Integer] :max_results
|
|
4092
|
-
# The maximum number of cluster results
|
|
4140
|
+
# The maximum number of cluster results that `ListClusters` returned in
|
|
4093
4141
|
# paginated output. When this parameter is used, `ListClusters` only
|
|
4094
4142
|
# returns `maxResults` results in a single page along with a `nextToken`
|
|
4095
4143
|
# response element. The remaining results of the initial request can be
|
|
4096
4144
|
# seen by sending another `ListClusters` request with the returned
|
|
4097
4145
|
# `nextToken` value. This value can be between 1 and 100. If this
|
|
4098
|
-
# parameter
|
|
4146
|
+
# parameter isn't used, then `ListClusters` returns up to 100 results
|
|
4099
4147
|
# and a `nextToken` value if applicable.
|
|
4100
4148
|
#
|
|
4101
4149
|
# @return [Types::ListClustersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -4171,8 +4219,8 @@ module Aws::ECS
|
|
|
4171
4219
|
# @option params [String] :next_token
|
|
4172
4220
|
# The `nextToken` value returned from a `ListContainerInstances` request
|
|
4173
4221
|
# indicating that more results are available to fulfill the request and
|
|
4174
|
-
# further calls
|
|
4175
|
-
#
|
|
4222
|
+
# further calls are needed. If `maxResults` was provided, it's possible
|
|
4223
|
+
# the number of results to be fewer than `maxResults`.
|
|
4176
4224
|
#
|
|
4177
4225
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
|
4178
4226
|
# to retrieve the next items in a list and not for other programmatic
|
|
@@ -4181,21 +4229,21 @@ module Aws::ECS
|
|
|
4181
4229
|
# </note>
|
|
4182
4230
|
#
|
|
4183
4231
|
# @option params [Integer] :max_results
|
|
4184
|
-
# The maximum number of container instance results
|
|
4185
|
-
# `ListContainerInstances` in paginated output. When this
|
|
4186
|
-
# used, `ListContainerInstances` only returns `maxResults`
|
|
4187
|
-
# single page along with a `nextToken` response element.
|
|
4188
|
-
# results of the initial request can be seen by sending
|
|
4189
|
-
# `ListContainerInstances` request with the returned `nextToken`
|
|
4190
|
-
# This value can be between 1 and 100. If this parameter
|
|
4191
|
-
# then `ListContainerInstances` returns up to 100 results and a
|
|
4232
|
+
# The maximum number of container instance results that
|
|
4233
|
+
# `ListContainerInstances` returned in paginated output. When this
|
|
4234
|
+
# parameter is used, `ListContainerInstances` only returns `maxResults`
|
|
4235
|
+
# results in a single page along with a `nextToken` response element.
|
|
4236
|
+
# The remaining results of the initial request can be seen by sending
|
|
4237
|
+
# another `ListContainerInstances` request with the returned `nextToken`
|
|
4238
|
+
# value. This value can be between 1 and 100. If this parameter isn't
|
|
4239
|
+
# used, then `ListContainerInstances` returns up to 100 results and a
|
|
4192
4240
|
# `nextToken` value if applicable.
|
|
4193
4241
|
#
|
|
4194
4242
|
# @option params [String] :status
|
|
4195
4243
|
# Filters the container instances by status. For example, if you specify
|
|
4196
4244
|
# the `DRAINING` status, the results include only container instances
|
|
4197
4245
|
# that have been set to `DRAINING` using UpdateContainerInstancesState.
|
|
4198
|
-
# If you
|
|
4246
|
+
# If you don't specify this parameter, the default is to include
|
|
4199
4247
|
# container instances set to all states other than `INACTIVE`.
|
|
4200
4248
|
#
|
|
4201
4249
|
# @return [Types::ListContainerInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -4268,13 +4316,13 @@ module Aws::ECS
|
|
|
4268
4316
|
# </note>
|
|
4269
4317
|
#
|
|
4270
4318
|
# @option params [Integer] :max_results
|
|
4271
|
-
# The maximum number of service results
|
|
4319
|
+
# The maximum number of service results that `ListServices` returned in
|
|
4272
4320
|
# paginated output. When this parameter is used, `ListServices` only
|
|
4273
4321
|
# returns `maxResults` results in a single page along with a `nextToken`
|
|
4274
4322
|
# response element. The remaining results of the initial request can be
|
|
4275
4323
|
# seen by sending another `ListServices` request with the returned
|
|
4276
4324
|
# `nextToken` value. This value can be between 1 and 100. If this
|
|
4277
|
-
# parameter
|
|
4325
|
+
# parameter isn't used, then `ListServices` returns up to 10 results
|
|
4278
4326
|
# and a `nextToken` value if applicable.
|
|
4279
4327
|
#
|
|
4280
4328
|
# @option params [String] :launch_type
|
|
@@ -4334,9 +4382,9 @@ module Aws::ECS
|
|
|
4334
4382
|
# List the tags for an Amazon ECS resource.
|
|
4335
4383
|
#
|
|
4336
4384
|
# @option params [required, String] :resource_arn
|
|
4337
|
-
# The Amazon Resource Name (ARN) that identifies the resource
|
|
4338
|
-
#
|
|
4339
|
-
#
|
|
4385
|
+
# The Amazon Resource Name (ARN) that identifies the resource to list
|
|
4386
|
+
# the tags for. Currently, the supported resources are Amazon ECS tasks,
|
|
4387
|
+
# services, task definitions, clusters, and container instances.
|
|
4340
4388
|
#
|
|
4341
4389
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4342
4390
|
#
|
|
@@ -4383,27 +4431,27 @@ module Aws::ECS
|
|
|
4383
4431
|
end
|
|
4384
4432
|
|
|
4385
4433
|
# Returns a list of task definition families that are registered to your
|
|
4386
|
-
# account
|
|
4387
|
-
# have any `ACTIVE` task definition revisions
|
|
4434
|
+
# account. This list includes task definition families that no longer
|
|
4435
|
+
# have any `ACTIVE` task definition revisions.
|
|
4388
4436
|
#
|
|
4389
|
-
# You can filter out task definition families that
|
|
4437
|
+
# You can filter out task definition families that don't contain any
|
|
4390
4438
|
# `ACTIVE` task definition revisions by setting the `status` parameter
|
|
4391
4439
|
# to `ACTIVE`. You can also filter the results with the `familyPrefix`
|
|
4392
4440
|
# parameter.
|
|
4393
4441
|
#
|
|
4394
4442
|
# @option params [String] :family_prefix
|
|
4395
|
-
# The `familyPrefix` is a string that
|
|
4443
|
+
# The `familyPrefix` is a string that's used to filter the results of
|
|
4396
4444
|
# `ListTaskDefinitionFamilies`. If you specify a `familyPrefix`, only
|
|
4397
4445
|
# task definition family names that begin with the `familyPrefix` string
|
|
4398
4446
|
# are returned.
|
|
4399
4447
|
#
|
|
4400
4448
|
# @option params [String] :status
|
|
4401
|
-
# The task definition family status
|
|
4402
|
-
# `ListTaskDefinitionFamilies` results. By default, both `ACTIVE`
|
|
4403
|
-
# `INACTIVE` task definition families are listed. If this parameter
|
|
4404
|
-
# set to `ACTIVE`, only task definition families that have an
|
|
4405
|
-
# task definition revision are returned. If this parameter is
|
|
4406
|
-
# `INACTIVE`, only task definition families that do not have any
|
|
4449
|
+
# The task definition family status to filter the
|
|
4450
|
+
# `ListTaskDefinitionFamilies` results with. By default, both `ACTIVE`
|
|
4451
|
+
# and `INACTIVE` task definition families are listed. If this parameter
|
|
4452
|
+
# is set to `ACTIVE`, only task definition families that have an
|
|
4453
|
+
# `ACTIVE` task definition revision are returned. If this parameter is
|
|
4454
|
+
# set to `INACTIVE`, only task definition families that do not have any
|
|
4407
4455
|
# `ACTIVE` task definition revisions are returned. If you paginate the
|
|
4408
4456
|
# resulting output, be sure to keep the `status` value constant in each
|
|
4409
4457
|
# subsequent request.
|
|
@@ -4422,15 +4470,15 @@ module Aws::ECS
|
|
|
4422
4470
|
# </note>
|
|
4423
4471
|
#
|
|
4424
4472
|
# @option params [Integer] :max_results
|
|
4425
|
-
# The maximum number of task definition family results
|
|
4426
|
-
# `ListTaskDefinitionFamilies` in paginated output. When this
|
|
4427
|
-
# is used, `ListTaskDefinitions` only returns `maxResults`
|
|
4428
|
-
# single page along with a `nextToken` response element.
|
|
4429
|
-
# results of the initial request can be seen by sending
|
|
4430
|
-
# `ListTaskDefinitionFamilies` request with the returned
|
|
4431
|
-
# value. This value can be between 1 and 100. If this
|
|
4432
|
-
# used, then `ListTaskDefinitionFamilies` returns up to
|
|
4433
|
-
# a `nextToken` value if applicable.
|
|
4473
|
+
# The maximum number of task definition family results that
|
|
4474
|
+
# `ListTaskDefinitionFamilies` returned in paginated output. When this
|
|
4475
|
+
# parameter is used, `ListTaskDefinitions` only returns `maxResults`
|
|
4476
|
+
# results in a single page along with a `nextToken` response element.
|
|
4477
|
+
# The remaining results of the initial request can be seen by sending
|
|
4478
|
+
# another `ListTaskDefinitionFamilies` request with the returned
|
|
4479
|
+
# `nextToken` value. This value can be between 1 and 100. If this
|
|
4480
|
+
# parameter isn't used, then `ListTaskDefinitionFamilies` returns up to
|
|
4481
|
+
# 100 results and a `nextToken` value if applicable.
|
|
4434
4482
|
#
|
|
4435
4483
|
# @return [Types::ListTaskDefinitionFamiliesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4436
4484
|
#
|
|
@@ -4502,27 +4550,26 @@ module Aws::ECS
|
|
|
4502
4550
|
# `familyPrefix` parameter or by status with the `status` parameter.
|
|
4503
4551
|
#
|
|
4504
4552
|
# @option params [String] :family_prefix
|
|
4505
|
-
# The full family name
|
|
4506
|
-
#
|
|
4507
|
-
#
|
|
4553
|
+
# The full family name to filter the `ListTaskDefinitions` results with.
|
|
4554
|
+
# Specifying a `familyPrefix` limits the listed task definitions to task
|
|
4555
|
+
# definition revisions that belong to that family.
|
|
4508
4556
|
#
|
|
4509
4557
|
# @option params [String] :status
|
|
4510
|
-
# The task definition status
|
|
4511
|
-
#
|
|
4512
|
-
#
|
|
4513
|
-
#
|
|
4514
|
-
#
|
|
4515
|
-
#
|
|
4516
|
-
# request.
|
|
4558
|
+
# The task definition status to filter the `ListTaskDefinitions` results
|
|
4559
|
+
# with. By default, only `ACTIVE` task definitions are listed. By
|
|
4560
|
+
# setting this parameter to `INACTIVE`, you can view task definitions
|
|
4561
|
+
# that are `INACTIVE` as long as an active task or service still
|
|
4562
|
+
# references them. If you paginate the resulting output, be sure to keep
|
|
4563
|
+
# the `status` value constant in each subsequent request.
|
|
4517
4564
|
#
|
|
4518
4565
|
# @option params [String] :sort
|
|
4519
|
-
# The order
|
|
4520
|
-
#
|
|
4521
|
-
#
|
|
4522
|
-
#
|
|
4523
|
-
#
|
|
4524
|
-
#
|
|
4525
|
-
#
|
|
4566
|
+
# The order to sort the results in. Valid values are `ASC` and `DESC`.
|
|
4567
|
+
# By default, (`ASC`) task definitions are listed lexicographically by
|
|
4568
|
+
# family name and in ascending numerical order by revision so that the
|
|
4569
|
+
# newest task definitions in a family are listed last. Setting this
|
|
4570
|
+
# parameter to `DESC` reverses the sort order on family name and
|
|
4571
|
+
# revision. This is so that the newest task definitions in a family are
|
|
4572
|
+
# listed first.
|
|
4526
4573
|
#
|
|
4527
4574
|
# @option params [String] :next_token
|
|
4528
4575
|
# The `nextToken` value returned from a `ListTaskDefinitions` request
|
|
@@ -4537,15 +4584,15 @@ module Aws::ECS
|
|
|
4537
4584
|
# </note>
|
|
4538
4585
|
#
|
|
4539
4586
|
# @option params [Integer] :max_results
|
|
4540
|
-
# The maximum number of task definition results
|
|
4541
|
-
# `ListTaskDefinitions` in paginated output. When this
|
|
4542
|
-
# used, `ListTaskDefinitions` only returns `maxResults`
|
|
4543
|
-
# single page along with a `nextToken` response element.
|
|
4544
|
-
# results of the initial request can be seen by sending
|
|
4545
|
-
# `ListTaskDefinitions` request with the returned `nextToken`
|
|
4546
|
-
# This value can be between 1 and 100. If this parameter
|
|
4547
|
-
# then `ListTaskDefinitions` returns up to 100 results and a
|
|
4548
|
-
# value if applicable.
|
|
4587
|
+
# The maximum number of task definition results that
|
|
4588
|
+
# `ListTaskDefinitions` returned in paginated output. When this
|
|
4589
|
+
# parameter is used, `ListTaskDefinitions` only returns `maxResults`
|
|
4590
|
+
# results in a single page along with a `nextToken` response element.
|
|
4591
|
+
# The remaining results of the initial request can be seen by sending
|
|
4592
|
+
# another `ListTaskDefinitions` request with the returned `nextToken`
|
|
4593
|
+
# value. This value can be between 1 and 100. If this parameter isn't
|
|
4594
|
+
# used, then `ListTaskDefinitions` returns up to 100 results and a
|
|
4595
|
+
# `nextToken` value if applicable.
|
|
4549
4596
|
#
|
|
4550
4597
|
# @return [Types::ListTaskDefinitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4551
4598
|
#
|
|
@@ -4644,7 +4691,7 @@ module Aws::ECS
|
|
|
4644
4691
|
# @option params [String] :next_token
|
|
4645
4692
|
# The `nextToken` value returned from a `ListTasks` request indicating
|
|
4646
4693
|
# that more results are available to fulfill the request and further
|
|
4647
|
-
# calls will be needed. If `maxResults` was provided, it
|
|
4694
|
+
# calls will be needed. If `maxResults` was provided, it's possible the
|
|
4648
4695
|
# number of results to be fewer than `maxResults`.
|
|
4649
4696
|
#
|
|
4650
4697
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
|
@@ -4654,19 +4701,19 @@ module Aws::ECS
|
|
|
4654
4701
|
# </note>
|
|
4655
4702
|
#
|
|
4656
4703
|
# @option params [Integer] :max_results
|
|
4657
|
-
# The maximum number of task results
|
|
4704
|
+
# The maximum number of task results that `ListTasks` returned in
|
|
4658
4705
|
# paginated output. When this parameter is used, `ListTasks` only
|
|
4659
4706
|
# returns `maxResults` results in a single page along with a `nextToken`
|
|
4660
4707
|
# response element. The remaining results of the initial request can be
|
|
4661
4708
|
# seen by sending another `ListTasks` request with the returned
|
|
4662
4709
|
# `nextToken` value. This value can be between 1 and 100. If this
|
|
4663
|
-
# parameter
|
|
4710
|
+
# parameter isn't used, then `ListTasks` returns up to 100 results and
|
|
4664
4711
|
# a `nextToken` value if applicable.
|
|
4665
4712
|
#
|
|
4666
4713
|
# @option params [String] :started_by
|
|
4667
|
-
# The `startedBy` value
|
|
4668
|
-
#
|
|
4669
|
-
#
|
|
4714
|
+
# The `startedBy` value to filter the task results with. Specifying a
|
|
4715
|
+
# `startedBy` value limits the results to tasks that were started with
|
|
4716
|
+
# that value.
|
|
4670
4717
|
#
|
|
4671
4718
|
# @option params [String] :service_name
|
|
4672
4719
|
# The name of the service to use when filtering the `ListTasks` results.
|
|
@@ -4677,12 +4724,12 @@ module Aws::ECS
|
|
|
4677
4724
|
# The task desired status to use when filtering the `ListTasks` results.
|
|
4678
4725
|
# Specifying a `desiredStatus` of `STOPPED` limits the results to tasks
|
|
4679
4726
|
# that Amazon ECS has set the desired status to `STOPPED`. This can be
|
|
4680
|
-
# useful for debugging tasks that
|
|
4727
|
+
# useful for debugging tasks that aren't starting properly or have died
|
|
4681
4728
|
# or finished. The default status filter is `RUNNING`, which shows tasks
|
|
4682
4729
|
# that Amazon ECS has set the desired status to `RUNNING`.
|
|
4683
4730
|
#
|
|
4684
4731
|
# <note markdown="1"> Although you can filter results based on a desired status of
|
|
4685
|
-
# `PENDING`, this
|
|
4732
|
+
# `PENDING`, this doesn't return any results. Amazon ECS never sets the
|
|
4686
4733
|
# desired status of a task to that value (only a task's `lastStatus`
|
|
4687
4734
|
# may have a value of `PENDING`).
|
|
4688
4735
|
#
|
|
@@ -4765,9 +4812,9 @@ module Aws::ECS
|
|
|
4765
4812
|
# basis.
|
|
4766
4813
|
#
|
|
4767
4814
|
# If you change the account setting for the root user, the default
|
|
4768
|
-
# settings for all of the IAM users and roles
|
|
4769
|
-
#
|
|
4770
|
-
#
|
|
4815
|
+
# settings for all of the IAM users and roles that no individual account
|
|
4816
|
+
# setting was specified are reset for. For more information, see
|
|
4817
|
+
# [Account Settings][1] in the *Amazon Elastic Container Service
|
|
4771
4818
|
# Developer Guide*.
|
|
4772
4819
|
#
|
|
4773
4820
|
# When `serviceLongArnFormat`, `taskLongArnFormat`, or
|
|
@@ -4775,10 +4822,10 @@ module Aws::ECS
|
|
|
4775
4822
|
# Name (ARN) and resource ID format of the resource type for a specified
|
|
4776
4823
|
# IAM user, IAM role, or the root user for an account is affected. The
|
|
4777
4824
|
# opt-in and opt-out account setting must be set for each Amazon ECS
|
|
4778
|
-
# resource separately. The ARN and resource ID format of a resource
|
|
4779
|
-
#
|
|
4780
|
-
#
|
|
4781
|
-
#
|
|
4825
|
+
# resource separately. The ARN and resource ID format of a resource is
|
|
4826
|
+
# defined by the opt-in status of the IAM user or role that created the
|
|
4827
|
+
# resource. You must enable this setting to use Amazon ECS features such
|
|
4828
|
+
# as resource tagging.
|
|
4782
4829
|
#
|
|
4783
4830
|
# When `awsvpcTrunking` is specified, the elastic network interface
|
|
4784
4831
|
# (ENI) limit for any new container instances that support the feature
|
|
@@ -4968,7 +5015,7 @@ module Aws::ECS
|
|
|
4968
5015
|
end
|
|
4969
5016
|
|
|
4970
5017
|
# Create or update an attribute on an Amazon ECS resource. If the
|
|
4971
|
-
# attribute
|
|
5018
|
+
# attribute doesn't exist, it's created. If the attribute exists, its
|
|
4972
5019
|
# value is replaced with the specified value. To delete an attribute,
|
|
4973
5020
|
# use DeleteAttributes. For more information, see [Attributes][1] in the
|
|
4974
5021
|
# *Amazon Elastic Container Service Developer Guide*.
|
|
@@ -4984,8 +5031,8 @@ module Aws::ECS
|
|
|
4984
5031
|
#
|
|
4985
5032
|
# @option params [required, Array<Types::Attribute>] :attributes
|
|
4986
5033
|
# The attributes to apply to your resource. You can specify up to 10
|
|
4987
|
-
# custom attributes
|
|
4988
|
-
# a single call.
|
|
5034
|
+
# custom attributes for each resource. You can specify up to 10
|
|
5035
|
+
# attributes in a single call.
|
|
4989
5036
|
#
|
|
4990
5037
|
# @return [Types::PutAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4991
5038
|
#
|
|
@@ -5029,21 +5076,21 @@ module Aws::ECS
|
|
|
5029
5076
|
# capacity provider strategy for the cluster. If the specified cluster
|
|
5030
5077
|
# has existing capacity providers associated with it, you must specify
|
|
5031
5078
|
# all existing capacity providers in addition to any new ones you want
|
|
5032
|
-
# to add. Any existing capacity providers associated with a
|
|
5033
|
-
# are omitted from a PutClusterCapacityProviders API call
|
|
5034
|
-
# disassociated with the cluster. You can only disassociate an
|
|
5035
|
-
# capacity provider from a cluster if it's not being used by
|
|
5036
|
-
# existing tasks.
|
|
5079
|
+
# to add. Any existing capacity providers that are associated with a
|
|
5080
|
+
# cluster that are omitted from a PutClusterCapacityProviders API call
|
|
5081
|
+
# will be disassociated with the cluster. You can only disassociate an
|
|
5082
|
+
# existing capacity provider from a cluster if it's not being used by
|
|
5083
|
+
# any existing tasks.
|
|
5037
5084
|
#
|
|
5038
5085
|
# When creating a service or running a task on a cluster, if no capacity
|
|
5039
5086
|
# provider or launch type is specified, then the cluster's default
|
|
5040
|
-
# capacity provider strategy is used.
|
|
5041
|
-
# default capacity provider strategy for your cluster,
|
|
5087
|
+
# capacity provider strategy is used. We recommend that you define a
|
|
5088
|
+
# default capacity provider strategy for your cluster. However, you must
|
|
5042
5089
|
# specify an empty array (`[]`) to bypass defining a default strategy.
|
|
5043
5090
|
#
|
|
5044
5091
|
# @option params [required, String] :cluster
|
|
5045
5092
|
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
5046
|
-
# modify the capacity provider settings for. If you
|
|
5093
|
+
# modify the capacity provider settings for. If you don't specify a
|
|
5047
5094
|
# cluster, the default cluster is assumed.
|
|
5048
5095
|
#
|
|
5049
5096
|
# @option params [required, Array<String>] :capacity_providers
|
|
@@ -5158,8 +5205,8 @@ module Aws::ECS
|
|
|
5158
5205
|
# becomes available to place containers on.
|
|
5159
5206
|
#
|
|
5160
5207
|
# @option params [String] :cluster
|
|
5161
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
5162
|
-
#
|
|
5208
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
5209
|
+
# register your container instance with. If you do not specify a
|
|
5163
5210
|
# cluster, the default cluster is assumed.
|
|
5164
5211
|
#
|
|
5165
5212
|
# @option params [String] :instance_identity_document
|
|
@@ -5179,7 +5226,7 @@ module Aws::ECS
|
|
|
5179
5226
|
#
|
|
5180
5227
|
# @option params [Types::VersionInfo] :version_info
|
|
5181
5228
|
# The version information for the Amazon ECS container agent and Docker
|
|
5182
|
-
# daemon
|
|
5229
|
+
# daemon that runs on the container instance.
|
|
5183
5230
|
#
|
|
5184
5231
|
# @option params [String] :container_instance_arn
|
|
5185
5232
|
# The ARN of the container instance (if it was previously registered).
|
|
@@ -5195,7 +5242,7 @@ module Aws::ECS
|
|
|
5195
5242
|
# @option params [Array<Types::Tag>] :tags
|
|
5196
5243
|
# The metadata that you apply to the container instance to help you
|
|
5197
5244
|
# categorize and organize them. Each tag consists of a key and an
|
|
5198
|
-
# optional value
|
|
5245
|
+
# optional value. You define both.
|
|
5199
5246
|
#
|
|
5200
5247
|
# The following basic restrictions apply to tags:
|
|
5201
5248
|
#
|
|
@@ -5317,6 +5364,12 @@ module Aws::ECS
|
|
|
5317
5364
|
# resp.container_instance.tags #=> Array
|
|
5318
5365
|
# resp.container_instance.tags[0].key #=> String
|
|
5319
5366
|
# resp.container_instance.tags[0].value #=> String
|
|
5367
|
+
# resp.container_instance.health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
5368
|
+
# resp.container_instance.health_status.details #=> Array
|
|
5369
|
+
# resp.container_instance.health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
|
|
5370
|
+
# resp.container_instance.health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
5371
|
+
# resp.container_instance.health_status.details[0].last_updated #=> Time
|
|
5372
|
+
# resp.container_instance.health_status.details[0].last_status_change #=> Time
|
|
5320
5373
|
#
|
|
5321
5374
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterContainerInstance AWS API Documentation
|
|
5322
5375
|
#
|
|
@@ -5338,9 +5391,9 @@ module Aws::ECS
|
|
|
5338
5391
|
# parameter. When you specify an IAM role for a task, its containers can
|
|
5339
5392
|
# then use the latest versions of the CLI or SDKs to make API requests
|
|
5340
5393
|
# to the Amazon Web Services services that are specified in the IAM
|
|
5341
|
-
# policy associated with the role. For more information, see
|
|
5342
|
-
# for Tasks][2] in the *Amazon Elastic Container Service
|
|
5343
|
-
# Guide*.
|
|
5394
|
+
# policy that's associated with the role. For more information, see
|
|
5395
|
+
# [IAM Roles for Tasks][2] in the *Amazon Elastic Container Service
|
|
5396
|
+
# Developer Guide*.
|
|
5344
5397
|
#
|
|
5345
5398
|
# You can specify a Docker networking mode for the containers in your
|
|
5346
5399
|
# task definition with the `networkMode` parameter. The available
|
|
@@ -5360,7 +5413,7 @@ module Aws::ECS
|
|
|
5360
5413
|
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
|
5361
5414
|
#
|
|
5362
5415
|
# @option params [required, String] :family
|
|
5363
|
-
# You must specify a `family` for a task definition
|
|
5416
|
+
# You must specify a `family` for a task definition. You can use it
|
|
5364
5417
|
# track multiple versions of the same task definition. The `family` is
|
|
5365
5418
|
# used as a name for your task definition. Up to 255 letters (uppercase
|
|
5366
5419
|
# and lowercase), numbers, underscores, and hyphens are allowed.
|
|
@@ -5438,23 +5491,23 @@ module Aws::ECS
|
|
|
5438
5491
|
#
|
|
5439
5492
|
# @option params [Array<Types::Volume>] :volumes
|
|
5440
5493
|
# A list of volume definitions in JSON format that containers in your
|
|
5441
|
-
# task
|
|
5494
|
+
# task might use.
|
|
5442
5495
|
#
|
|
5443
5496
|
# @option params [Array<Types::TaskDefinitionPlacementConstraint>] :placement_constraints
|
|
5444
5497
|
# An array of placement constraint objects to use for the task. You can
|
|
5445
|
-
# specify a maximum of 10 constraints
|
|
5446
|
-
# constraints in the task definition and those specified at runtime
|
|
5498
|
+
# specify a maximum of 10 constraints for each task. This limit includes
|
|
5499
|
+
# constraints in the task definition and those specified at runtime.
|
|
5447
5500
|
#
|
|
5448
5501
|
# @option params [Array<String>] :requires_compatibilities
|
|
5449
|
-
# The task launch type that Amazon ECS
|
|
5450
|
-
#
|
|
5451
|
-
#
|
|
5452
|
-
#
|
|
5502
|
+
# The task launch type that Amazon ECS validates the task definition
|
|
5503
|
+
# against. A client exception is returned if the task definition
|
|
5504
|
+
# doesn't validate against the compatibilities specified. If no value
|
|
5505
|
+
# is specified, the parameter is omitted from the response.
|
|
5453
5506
|
#
|
|
5454
5507
|
# @option params [String] :cpu
|
|
5455
5508
|
# The number of CPU units used by the task. It can be expressed as an
|
|
5456
|
-
# integer using CPU units
|
|
5457
|
-
# vCPUs
|
|
5509
|
+
# integer using CPU units (for example, `1024`) or as a string using
|
|
5510
|
+
# vCPUs (for example, `1 vCPU` or `1 vcpu`) in a task definition. String
|
|
5458
5511
|
# values are converted to an integer indicating the CPU units when the
|
|
5459
5512
|
# task definition is registered.
|
|
5460
5513
|
#
|
|
@@ -5464,14 +5517,17 @@ module Aws::ECS
|
|
|
5464
5517
|
#
|
|
5465
5518
|
# </note>
|
|
5466
5519
|
#
|
|
5467
|
-
# If you
|
|
5520
|
+
# If you're using the EC2 launch type, this field is optional.
|
|
5468
5521
|
# Supported values are between `128` CPU units (`0.125` vCPUs) and
|
|
5469
5522
|
# `10240` CPU units (`10` vCPUs).
|
|
5470
5523
|
#
|
|
5471
|
-
# If you
|
|
5524
|
+
# If you're using the Fargate launch type, this field is required and
|
|
5472
5525
|
# you must use one of the following values, which determines your range
|
|
5473
5526
|
# of supported values for the `memory` parameter:
|
|
5474
5527
|
#
|
|
5528
|
+
# The CPU units cannot be less than 1 vCPU when you use Windows
|
|
5529
|
+
# containers on Fargate.
|
|
5530
|
+
#
|
|
5475
5531
|
# * 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1
|
|
5476
5532
|
# GB), 2048 (2 GB)
|
|
5477
5533
|
#
|
|
@@ -5489,8 +5545,8 @@ module Aws::ECS
|
|
|
5489
5545
|
#
|
|
5490
5546
|
# @option params [String] :memory
|
|
5491
5547
|
# The amount of memory (in MiB) used by the task. It can be expressed as
|
|
5492
|
-
# an integer using MiB
|
|
5493
|
-
# example `1GB` or `1 GB
|
|
5548
|
+
# an integer using MiB (for example ,`1024`) or as a string using GB
|
|
5549
|
+
# (for example, `1GB` or `1 GB`) in a task definition. String values are
|
|
5494
5550
|
# converted to an integer indicating the MiB when the task definition is
|
|
5495
5551
|
# registered.
|
|
5496
5552
|
#
|
|
@@ -5503,8 +5559,11 @@ module Aws::ECS
|
|
|
5503
5559
|
# If using the EC2 launch type, this field is optional.
|
|
5504
5560
|
#
|
|
5505
5561
|
# If using the Fargate launch type, this field is required and you must
|
|
5506
|
-
# use one of the following values
|
|
5507
|
-
# supported values for the `cpu` parameter
|
|
5562
|
+
# use one of the following values. This determines your range of
|
|
5563
|
+
# supported values for the `cpu` parameter.
|
|
5564
|
+
#
|
|
5565
|
+
# The CPU units cannot be less than 1 vCPU when you use Windows
|
|
5566
|
+
# containers on Fargate.
|
|
5508
5567
|
#
|
|
5509
5568
|
# * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values: 256
|
|
5510
5569
|
# (.25 vCPU)
|
|
@@ -5524,7 +5583,7 @@ module Aws::ECS
|
|
|
5524
5583
|
# @option params [Array<Types::Tag>] :tags
|
|
5525
5584
|
# The metadata that you apply to the task definition to help you
|
|
5526
5585
|
# categorize and organize them. Each tag consists of a key and an
|
|
5527
|
-
# optional value
|
|
5586
|
+
# optional value. You define both of them.
|
|
5528
5587
|
#
|
|
5529
5588
|
# The following basic restrictions apply to tags:
|
|
5530
5589
|
#
|
|
@@ -5642,8 +5701,12 @@ module Aws::ECS
|
|
|
5642
5701
|
# more information, see [Fargate task storage][1] in the *Amazon ECS
|
|
5643
5702
|
# User Guide for Fargate*.
|
|
5644
5703
|
#
|
|
5645
|
-
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
|
|
5646
|
-
# platform
|
|
5704
|
+
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using the
|
|
5705
|
+
# following platform versions:
|
|
5706
|
+
#
|
|
5707
|
+
# * Linux platform version `1.4.0` or later.
|
|
5708
|
+
#
|
|
5709
|
+
# * Windows platform version `1.0.0` or later.
|
|
5647
5710
|
#
|
|
5648
5711
|
# </note>
|
|
5649
5712
|
#
|
|
@@ -5651,6 +5714,13 @@ module Aws::ECS
|
|
|
5651
5714
|
#
|
|
5652
5715
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html
|
|
5653
5716
|
#
|
|
5717
|
+
# @option params [Types::RuntimePlatform] :runtime_platform
|
|
5718
|
+
# The operating system that your tasks definitions run on. A platform
|
|
5719
|
+
# family is specified only for tasks using the Fargate launch type.
|
|
5720
|
+
#
|
|
5721
|
+
# When you specify a task definition in a service, this value must match
|
|
5722
|
+
# the `runtimePlatform` value of the service.
|
|
5723
|
+
#
|
|
5654
5724
|
# @return [Types::RegisterTaskDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5655
5725
|
#
|
|
5656
5726
|
# * {Types::RegisterTaskDefinitionResponse#task_definition #task_definition} => Types::TaskDefinition
|
|
@@ -5943,6 +6013,10 @@ module Aws::ECS
|
|
|
5943
6013
|
# ephemeral_storage: {
|
|
5944
6014
|
# size_in_gi_b: 1, # required
|
|
5945
6015
|
# },
|
|
6016
|
+
# runtime_platform: {
|
|
6017
|
+
# cpu_architecture: "X86_64", # accepts X86_64, ARM64
|
|
6018
|
+
# operating_system_family: "WINDOWS_SERVER_2019_FULL", # accepts WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2016_FULL, WINDOWS_SERVER_2004_CORE, WINDOWS_SERVER_2022_CORE, WINDOWS_SERVER_2022_FULL, WINDOWS_SERVER_20H2_CORE, LINUX
|
|
6019
|
+
# },
|
|
5946
6020
|
# })
|
|
5947
6021
|
#
|
|
5948
6022
|
# @example Response structure
|
|
@@ -6085,6 +6159,8 @@ module Aws::ECS
|
|
|
6085
6159
|
# resp.task_definition.placement_constraints[0].expression #=> String
|
|
6086
6160
|
# resp.task_definition.compatibilities #=> Array
|
|
6087
6161
|
# resp.task_definition.compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
|
|
6162
|
+
# resp.task_definition.runtime_platform.cpu_architecture #=> String, one of "X86_64", "ARM64"
|
|
6163
|
+
# resp.task_definition.runtime_platform.operating_system_family #=> String, one of "WINDOWS_SERVER_2019_FULL", "WINDOWS_SERVER_2019_CORE", "WINDOWS_SERVER_2016_FULL", "WINDOWS_SERVER_2004_CORE", "WINDOWS_SERVER_2022_CORE", "WINDOWS_SERVER_2022_FULL", "WINDOWS_SERVER_20H2_CORE", "LINUX"
|
|
6088
6164
|
# resp.task_definition.requires_compatibilities #=> Array
|
|
6089
6165
|
# resp.task_definition.requires_compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
|
|
6090
6166
|
# resp.task_definition.cpu #=> String
|
|
@@ -6126,12 +6202,12 @@ module Aws::ECS
|
|
|
6126
6202
|
# Alternatively, you can use StartTask to use your own scheduler or
|
|
6127
6203
|
# place tasks manually on specific container instances.
|
|
6128
6204
|
#
|
|
6129
|
-
# The Amazon ECS API follows an eventual consistency model
|
|
6130
|
-
# distributed nature of the system supporting the API. This
|
|
6131
|
-
# the result of an API command you run that affects your
|
|
6132
|
-
# resources might not be immediately visible to all
|
|
6133
|
-
# you run. Keep this in mind when you carry out an
|
|
6134
|
-
# immediately follows a previous API command.
|
|
6205
|
+
# The Amazon ECS API follows an eventual consistency model. This is
|
|
6206
|
+
# because the distributed nature of the system supporting the API. This
|
|
6207
|
+
# means that the result of an API command you run that affects your
|
|
6208
|
+
# Amazon ECS resources might not be immediately visible to all
|
|
6209
|
+
# subsequent commands you run. Keep this in mind when you carry out an
|
|
6210
|
+
# API command that immediately follows a previous API command.
|
|
6135
6211
|
#
|
|
6136
6212
|
# To manage eventual consistency, you can do the following:
|
|
6137
6213
|
#
|
|
@@ -6167,13 +6243,13 @@ module Aws::ECS
|
|
|
6167
6243
|
# providers.
|
|
6168
6244
|
#
|
|
6169
6245
|
# @option params [String] :cluster
|
|
6170
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
6171
|
-
#
|
|
6172
|
-
#
|
|
6246
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
6247
|
+
# run your task on. If you do not specify a cluster, the default cluster
|
|
6248
|
+
# is assumed.
|
|
6173
6249
|
#
|
|
6174
6250
|
# @option params [Integer] :count
|
|
6175
6251
|
# The number of instantiations of the specified task to place on your
|
|
6176
|
-
# cluster. You can specify up to 10 tasks
|
|
6252
|
+
# cluster. You can specify up to 10 tasks for each call.
|
|
6177
6253
|
#
|
|
6178
6254
|
# @option params [Boolean] :enable_ecs_managed_tags
|
|
6179
6255
|
# Specifies whether to enable Amazon ECS managed tags for the task. For
|
|
@@ -6185,7 +6261,7 @@ module Aws::ECS
|
|
|
6185
6261
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
|
6186
6262
|
#
|
|
6187
6263
|
# @option params [Boolean] :enable_execute_command
|
|
6188
|
-
#
|
|
6264
|
+
# Determines whether to enable the execute command functionality for the
|
|
6189
6265
|
# containers in this task. If `true`, this enables execute command
|
|
6190
6266
|
# functionality on all containers in the task.
|
|
6191
6267
|
#
|
|
@@ -6195,7 +6271,7 @@ module Aws::ECS
|
|
|
6195
6271
|
# `family:my-family-name`).
|
|
6196
6272
|
#
|
|
6197
6273
|
# @option params [String] :launch_type
|
|
6198
|
-
# The infrastructure
|
|
6274
|
+
# The infrastructure to run your standalone task on. For more
|
|
6199
6275
|
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
|
6200
6276
|
# Container Service Developer Guide*.
|
|
6201
6277
|
#
|
|
@@ -6211,7 +6287,7 @@ module Aws::ECS
|
|
|
6211
6287
|
# The `EC2` launch type runs your tasks on Amazon EC2 instances
|
|
6212
6288
|
# registered to your cluster.
|
|
6213
6289
|
#
|
|
6214
|
-
# The `EXTERNAL` launch type runs your tasks on your on-
|
|
6290
|
+
# The `EXTERNAL` launch type runs your tasks on your on-premises server
|
|
6215
6291
|
# or virtual machine (VM) capacity registered to your cluster.
|
|
6216
6292
|
#
|
|
6217
6293
|
# A task can use either a launch type or a capacity provider strategy.
|
|
@@ -6229,7 +6305,7 @@ module Aws::ECS
|
|
|
6229
6305
|
# @option params [Types::NetworkConfiguration] :network_configuration
|
|
6230
6306
|
# The network configuration for the task. This parameter is required for
|
|
6231
6307
|
# task definitions that use the `awsvpc` network mode to receive their
|
|
6232
|
-
# own elastic network interface, and it
|
|
6308
|
+
# own elastic network interface, and it isn't supported for other
|
|
6233
6309
|
# network modes. For more information, see [Task networking][1] in the
|
|
6234
6310
|
# *Amazon Elastic Container Service Developer Guide*.
|
|
6235
6311
|
#
|
|
@@ -6241,7 +6317,7 @@ module Aws::ECS
|
|
|
6241
6317
|
# A list of container overrides in JSON format that specify the name of
|
|
6242
6318
|
# a container in the specified task definition and the overrides it
|
|
6243
6319
|
# should receive. You can override the default command for a container
|
|
6244
|
-
# (that
|
|
6320
|
+
# (that's specified in the task definition or Docker image) with a
|
|
6245
6321
|
# `command` override. You can also override existing environment
|
|
6246
6322
|
# variables (that are specified in the task definition or Docker image)
|
|
6247
6323
|
# on a container or add new environment variables to it with an
|
|
@@ -6252,19 +6328,19 @@ module Aws::ECS
|
|
|
6252
6328
|
#
|
|
6253
6329
|
# @option params [Array<Types::PlacementConstraint>] :placement_constraints
|
|
6254
6330
|
# An array of placement constraint objects to use for the task. You can
|
|
6255
|
-
# specify up to 10 constraints
|
|
6256
|
-
# task definition and those specified at runtime).
|
|
6331
|
+
# specify up to 10 constraints for each task (including constraints in
|
|
6332
|
+
# the task definition and those specified at runtime).
|
|
6257
6333
|
#
|
|
6258
6334
|
# @option params [Array<Types::PlacementStrategy>] :placement_strategy
|
|
6259
6335
|
# The placement strategy objects to use for the task. You can specify a
|
|
6260
|
-
# maximum of 5 strategy rules
|
|
6336
|
+
# maximum of 5 strategy rules for each task.
|
|
6261
6337
|
#
|
|
6262
6338
|
# @option params [String] :platform_version
|
|
6263
|
-
# The platform version the task
|
|
6264
|
-
# specified for tasks hosted on Fargate. If one
|
|
6265
|
-
# `LATEST` platform version is used
|
|
6266
|
-
#
|
|
6267
|
-
#
|
|
6339
|
+
# The platform version the task uses. A platform version is only
|
|
6340
|
+
# specified for tasks hosted on Fargate. If one isn't specified, the
|
|
6341
|
+
# `LATEST` platform version is used. For more information, see [Fargate
|
|
6342
|
+
# platform versions][1] in the *Amazon Elastic Container Service
|
|
6343
|
+
# Developer Guide*.
|
|
6268
6344
|
#
|
|
6269
6345
|
#
|
|
6270
6346
|
#
|
|
@@ -6272,7 +6348,7 @@ module Aws::ECS
|
|
|
6272
6348
|
#
|
|
6273
6349
|
# @option params [String] :propagate_tags
|
|
6274
6350
|
# Specifies whether to propagate the tags from the task definition to
|
|
6275
|
-
# the task. If no value is specified, the tags
|
|
6351
|
+
# the task. If no value is specified, the tags aren't propagated. Tags
|
|
6276
6352
|
# can only be propagated to the task during task creation. To add tags
|
|
6277
6353
|
# to a task after task creation, use the TagResource API action.
|
|
6278
6354
|
#
|
|
@@ -6292,7 +6368,7 @@ module Aws::ECS
|
|
|
6292
6368
|
# `startedBy` parameter. You can then identify which tasks belong to
|
|
6293
6369
|
# that job by filtering the results of a ListTasks call with the
|
|
6294
6370
|
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
|
6295
|
-
# numbers, hyphens, and underscores are allowed.
|
|
6371
|
+
# numbers, hyphens (-), and underscores (\_) are allowed.
|
|
6296
6372
|
#
|
|
6297
6373
|
# If a task is started by an Amazon ECS service, then the `startedBy`
|
|
6298
6374
|
# parameter contains the deployment ID of the service that starts it.
|
|
@@ -6329,10 +6405,10 @@ module Aws::ECS
|
|
|
6329
6405
|
#
|
|
6330
6406
|
# @option params [required, String] :task_definition
|
|
6331
6407
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
|
6332
|
-
# task definition to run. If a `revision`
|
|
6408
|
+
# task definition to run. If a `revision` isn't specified, the latest
|
|
6333
6409
|
# `ACTIVE` revision is used.
|
|
6334
6410
|
#
|
|
6335
|
-
# The full ARN value must match the value that you specified
|
|
6411
|
+
# The full ARN value must match the value that you specified as the
|
|
6336
6412
|
# `Resource` of the IAM principal's permissions policy. For example, if
|
|
6337
6413
|
# the `Resource` is
|
|
6338
6414
|
# arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*,
|
|
@@ -6561,6 +6637,7 @@ module Aws::ECS
|
|
|
6561
6637
|
# resp.tasks[0].overrides.task_role_arn #=> String
|
|
6562
6638
|
# resp.tasks[0].overrides.ephemeral_storage.size_in_gi_b #=> Integer
|
|
6563
6639
|
# resp.tasks[0].platform_version #=> String
|
|
6640
|
+
# resp.tasks[0].platform_family #=> String
|
|
6564
6641
|
# resp.tasks[0].pull_started_at #=> Time
|
|
6565
6642
|
# resp.tasks[0].pull_stopped_at #=> Time
|
|
6566
6643
|
# resp.tasks[0].started_at #=> Time
|
|
@@ -6602,14 +6679,14 @@ module Aws::ECS
|
|
|
6602
6679
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html
|
|
6603
6680
|
#
|
|
6604
6681
|
# @option params [String] :cluster
|
|
6605
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
6606
|
-
#
|
|
6682
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster where
|
|
6683
|
+
# to start your task. If you do not specify a cluster, the default
|
|
6607
6684
|
# cluster is assumed.
|
|
6608
6685
|
#
|
|
6609
6686
|
# @option params [required, Array<String>] :container_instances
|
|
6610
6687
|
# The container instance IDs or full ARN entries for the container
|
|
6611
|
-
# instances
|
|
6612
|
-
#
|
|
6688
|
+
# instances where you would like to place your task. You can specify up
|
|
6689
|
+
# to 10 container instances.
|
|
6613
6690
|
#
|
|
6614
6691
|
# @option params [Boolean] :enable_ecs_managed_tags
|
|
6615
6692
|
# Specifies whether to enable Amazon ECS managed tags for the task. For
|
|
@@ -6638,8 +6715,8 @@ module Aws::ECS
|
|
|
6638
6715
|
# @option params [Types::TaskOverride] :overrides
|
|
6639
6716
|
# A list of container overrides in JSON format that specify the name of
|
|
6640
6717
|
# a container in the specified task definition and the overrides it
|
|
6641
|
-
#
|
|
6642
|
-
# (that
|
|
6718
|
+
# receives. You can override the default command for a container
|
|
6719
|
+
# (that's specified in the task definition or Docker image) with a
|
|
6643
6720
|
# `command` override. You can also override existing environment
|
|
6644
6721
|
# variables (that are specified in the task definition or Docker image)
|
|
6645
6722
|
# on a container or add new environment variables to it with an
|
|
@@ -6652,7 +6729,7 @@ module Aws::ECS
|
|
|
6652
6729
|
#
|
|
6653
6730
|
# @option params [String] :propagate_tags
|
|
6654
6731
|
# Specifies whether to propagate the tags from the task definition or
|
|
6655
|
-
# the service to the task. If no value is specified, the tags
|
|
6732
|
+
# the service to the task. If no value is specified, the tags aren't
|
|
6656
6733
|
# propagated.
|
|
6657
6734
|
#
|
|
6658
6735
|
# @option params [String] :reference_id
|
|
@@ -6665,9 +6742,9 @@ module Aws::ECS
|
|
|
6665
6742
|
# `startedBy` parameter. You can then identify which tasks belong to
|
|
6666
6743
|
# that job by filtering the results of a ListTasks call with the
|
|
6667
6744
|
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
|
6668
|
-
# numbers, hyphens, and underscores are allowed.
|
|
6745
|
+
# numbers, hyphens (-), and underscores (\_) are allowed.
|
|
6669
6746
|
#
|
|
6670
|
-
# If a task is started by an Amazon ECS service,
|
|
6747
|
+
# If a task is started by an Amazon ECS service, the `startedBy`
|
|
6671
6748
|
# parameter contains the deployment ID of the service that starts it.
|
|
6672
6749
|
#
|
|
6673
6750
|
# @option params [Array<Types::Tag>] :tags
|
|
@@ -6702,7 +6779,7 @@ module Aws::ECS
|
|
|
6702
6779
|
#
|
|
6703
6780
|
# @option params [required, String] :task_definition
|
|
6704
6781
|
# The `family` and `revision` (`family:revision`) or full ARN of the
|
|
6705
|
-
# task definition to start. If a `revision`
|
|
6782
|
+
# task definition to start. If a `revision` isn't specified, the latest
|
|
6706
6783
|
# `ACTIVE` revision is used.
|
|
6707
6784
|
#
|
|
6708
6785
|
# @return [Types::StartTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -6868,6 +6945,7 @@ module Aws::ECS
|
|
|
6868
6945
|
# resp.tasks[0].overrides.task_role_arn #=> String
|
|
6869
6946
|
# resp.tasks[0].overrides.ephemeral_storage.size_in_gi_b #=> Integer
|
|
6870
6947
|
# resp.tasks[0].platform_version #=> String
|
|
6948
|
+
# resp.tasks[0].platform_family #=> String
|
|
6871
6949
|
# resp.tasks[0].pull_started_at #=> Time
|
|
6872
6950
|
# resp.tasks[0].pull_stopped_at #=> Time
|
|
6873
6951
|
# resp.tasks[0].started_at #=> Time
|
|
@@ -6928,7 +7006,7 @@ module Aws::ECS
|
|
|
6928
7006
|
#
|
|
6929
7007
|
# @option params [String] :reason
|
|
6930
7008
|
# An optional message specified when a task is stopped. For example, if
|
|
6931
|
-
# you
|
|
7009
|
+
# you're using a custom scheduler, you can use this parameter to
|
|
6932
7010
|
# specify the reason for stopping the task here, and the message appears
|
|
6933
7011
|
# in subsequent DescribeTasks API operations on this task. Up to 255
|
|
6934
7012
|
# characters are allowed in this message.
|
|
@@ -7033,6 +7111,7 @@ module Aws::ECS
|
|
|
7033
7111
|
# resp.task.overrides.task_role_arn #=> String
|
|
7034
7112
|
# resp.task.overrides.ephemeral_storage.size_in_gi_b #=> Integer
|
|
7035
7113
|
# resp.task.platform_version #=> String
|
|
7114
|
+
# resp.task.platform_family #=> String
|
|
7036
7115
|
# resp.task.pull_started_at #=> Time
|
|
7037
7116
|
# resp.task.pull_stopped_at #=> Time
|
|
7038
7117
|
# resp.task.started_at #=> Time
|
|
@@ -7125,7 +7204,7 @@ module Aws::ECS
|
|
|
7125
7204
|
# The status of the state change request.
|
|
7126
7205
|
#
|
|
7127
7206
|
# @option params [Integer] :exit_code
|
|
7128
|
-
# The exit code returned for the state change request.
|
|
7207
|
+
# The exit code that's returned for the state change request.
|
|
7129
7208
|
#
|
|
7130
7209
|
# @option params [String] :reason
|
|
7131
7210
|
# The reason for the state change request.
|
|
@@ -7191,22 +7270,23 @@ module Aws::ECS
|
|
|
7191
7270
|
# The reason for the state change request.
|
|
7192
7271
|
#
|
|
7193
7272
|
# @option params [Array<Types::ContainerStateChange>] :containers
|
|
7194
|
-
# Any containers associated with the state change request.
|
|
7273
|
+
# Any containers that's associated with the state change request.
|
|
7195
7274
|
#
|
|
7196
7275
|
# @option params [Array<Types::AttachmentStateChange>] :attachments
|
|
7197
7276
|
# Any attachments associated with the state change request.
|
|
7198
7277
|
#
|
|
7199
7278
|
# @option params [Array<Types::ManagedAgentStateChange>] :managed_agents
|
|
7200
|
-
# The details for the managed agent associated with the task.
|
|
7279
|
+
# The details for the managed agent that's associated with the task.
|
|
7201
7280
|
#
|
|
7202
7281
|
# @option params [Time,DateTime,Date,Integer,String] :pull_started_at
|
|
7203
|
-
# The Unix timestamp for when the container image pull
|
|
7282
|
+
# The Unix timestamp for the time when the container image pull started.
|
|
7204
7283
|
#
|
|
7205
7284
|
# @option params [Time,DateTime,Date,Integer,String] :pull_stopped_at
|
|
7206
|
-
# The Unix timestamp for when the container image pull
|
|
7285
|
+
# The Unix timestamp for the time when the container image pull
|
|
7286
|
+
# completed.
|
|
7207
7287
|
#
|
|
7208
7288
|
# @option params [Time,DateTime,Date,Integer,String] :execution_stopped_at
|
|
7209
|
-
# The Unix timestamp for when the task execution stopped.
|
|
7289
|
+
# The Unix timestamp for the time when the task execution stopped.
|
|
7210
7290
|
#
|
|
7211
7291
|
# @return [Types::SubmitTaskStateChangeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7212
7292
|
#
|
|
@@ -7270,12 +7350,12 @@ module Aws::ECS
|
|
|
7270
7350
|
end
|
|
7271
7351
|
|
|
7272
7352
|
# Associates the specified tags to a resource with the specified
|
|
7273
|
-
# `resourceArn`. If existing tags on a resource
|
|
7274
|
-
# request parameters, they
|
|
7275
|
-
# the tags associated with that resource are deleted as well.
|
|
7353
|
+
# `resourceArn`. If existing tags on a resource aren't specified in the
|
|
7354
|
+
# request parameters, they aren't changed. When a resource is deleted,
|
|
7355
|
+
# the tags that are associated with that resource are deleted as well.
|
|
7276
7356
|
#
|
|
7277
7357
|
# @option params [required, String] :resource_arn
|
|
7278
|
-
# The Amazon Resource Name (ARN) of the resource to
|
|
7358
|
+
# The Amazon Resource Name (ARN) of the resource to add tags to.
|
|
7279
7359
|
# Currently, the supported resources are Amazon ECS capacity providers,
|
|
7280
7360
|
# tasks, services, task definitions, clusters, and container instances.
|
|
7281
7361
|
#
|
|
@@ -7352,10 +7432,9 @@ module Aws::ECS
|
|
|
7352
7432
|
# Deletes specified tags from a resource.
|
|
7353
7433
|
#
|
|
7354
7434
|
# @option params [required, String] :resource_arn
|
|
7355
|
-
# The Amazon Resource Name (ARN) of the resource
|
|
7356
|
-
#
|
|
7357
|
-
#
|
|
7358
|
-
# instances.
|
|
7435
|
+
# The Amazon Resource Name (ARN) of the resource to delete tags from.
|
|
7436
|
+
# Currently, the supported resources are Amazon ECS capacity providers,
|
|
7437
|
+
# tasks, services, task definitions, clusters, and container instances.
|
|
7359
7438
|
#
|
|
7360
7439
|
# @option params [required, Array<String>] :tag_keys
|
|
7361
7440
|
# The keys of the tags to be removed.
|
|
@@ -7400,7 +7479,7 @@ module Aws::ECS
|
|
|
7400
7479
|
# The name of the capacity provider to update.
|
|
7401
7480
|
#
|
|
7402
7481
|
# @option params [required, Types::AutoScalingGroupProviderUpdate] :auto_scaling_group_provider
|
|
7403
|
-
# An object
|
|
7482
|
+
# An object that represent the parameters to update for the Auto Scaling
|
|
7404
7483
|
# group capacity provider.
|
|
7405
7484
|
#
|
|
7406
7485
|
# @return [Types::UpdateCapacityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -7547,7 +7626,7 @@ module Aws::ECS
|
|
|
7547
7626
|
# @option params [required, Array<Types::ClusterSetting>] :settings
|
|
7548
7627
|
# The setting to use by default for a cluster. This parameter is used to
|
|
7549
7628
|
# enable CloudWatch Container Insights for a cluster. If this value is
|
|
7550
|
-
# specified, it
|
|
7629
|
+
# specified, it overrides the `containerInsights` value set with
|
|
7551
7630
|
# PutAccountSetting or PutAccountSettingDefault.
|
|
7552
7631
|
#
|
|
7553
7632
|
# @return [Types::UpdateClusterSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -7616,7 +7695,7 @@ module Aws::ECS
|
|
|
7616
7695
|
end
|
|
7617
7696
|
|
|
7618
7697
|
# Updates the Amazon ECS container agent on a specified container
|
|
7619
|
-
# instance. Updating the Amazon ECS container agent
|
|
7698
|
+
# instance. Updating the Amazon ECS container agent doesn't interrupt
|
|
7620
7699
|
# running tasks or services on the container instance. The process for
|
|
7621
7700
|
# updating the agent differs depending on whether your container
|
|
7622
7701
|
# instance was launched with the Amazon ECS-optimized AMI or another
|
|
@@ -7624,10 +7703,10 @@ module Aws::ECS
|
|
|
7624
7703
|
#
|
|
7625
7704
|
# <note markdown="1"> The `UpdateContainerAgent` API isn't supported for container
|
|
7626
7705
|
# instances using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI.
|
|
7627
|
-
# To update the container agent, you can update the `ecs-init` package
|
|
7628
|
-
#
|
|
7629
|
-
#
|
|
7630
|
-
#
|
|
7706
|
+
# To update the container agent, you can update the `ecs-init` package.
|
|
7707
|
+
# This updates the agent. For more information, see [Updating the Amazon
|
|
7708
|
+
# ECS container agent][1] in the *Amazon Elastic Container Service
|
|
7709
|
+
# Developer Guide*.
|
|
7631
7710
|
#
|
|
7632
7711
|
# </note>
|
|
7633
7712
|
#
|
|
@@ -7649,7 +7728,7 @@ module Aws::ECS
|
|
|
7649
7728
|
#
|
|
7650
7729
|
# @option params [required, String] :container_instance
|
|
7651
7730
|
# The container instance ID or full ARN entries for the container
|
|
7652
|
-
# instance
|
|
7731
|
+
# instance where you would like to update the Amazon ECS container
|
|
7653
7732
|
# agent.
|
|
7654
7733
|
#
|
|
7655
7734
|
# @return [Types::UpdateContainerAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -7710,6 +7789,12 @@ module Aws::ECS
|
|
|
7710
7789
|
# resp.container_instance.tags #=> Array
|
|
7711
7790
|
# resp.container_instance.tags[0].key #=> String
|
|
7712
7791
|
# resp.container_instance.tags[0].value #=> String
|
|
7792
|
+
# resp.container_instance.health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
7793
|
+
# resp.container_instance.health_status.details #=> Array
|
|
7794
|
+
# resp.container_instance.health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
|
|
7795
|
+
# resp.container_instance.health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
7796
|
+
# resp.container_instance.health_status.details[0].last_updated #=> Time
|
|
7797
|
+
# resp.container_instance.health_status.details[0].last_status_change #=> Time
|
|
7713
7798
|
#
|
|
7714
7799
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerAgent AWS API Documentation
|
|
7715
7800
|
#
|
|
@@ -7727,7 +7812,7 @@ module Aws::ECS
|
|
|
7727
7812
|
# remove an instance from a cluster, for example to perform system
|
|
7728
7813
|
# updates, update the Docker daemon, or scale down the cluster size.
|
|
7729
7814
|
#
|
|
7730
|
-
# A container instance
|
|
7815
|
+
# A container instance can't be changed to `DRAINING` until it has
|
|
7731
7816
|
# reached an `ACTIVE` status. If the instance is in any other status, an
|
|
7732
7817
|
# error will be received.
|
|
7733
7818
|
#
|
|
@@ -7751,22 +7836,23 @@ module Aws::ECS
|
|
|
7751
7836
|
# minimum is 100%, the service scheduler can't remove existing tasks
|
|
7752
7837
|
# until the replacement tasks are considered healthy. Tasks for
|
|
7753
7838
|
# services that do not use a load balancer are considered healthy if
|
|
7754
|
-
# they
|
|
7755
|
-
# balancer are considered healthy if they
|
|
7756
|
-
# and the container instance they
|
|
7839
|
+
# they're in the `RUNNING` state. Tasks for services that use a load
|
|
7840
|
+
# balancer are considered healthy if they're in the `RUNNING` state
|
|
7841
|
+
# and the container instance they're hosted on is reported as healthy
|
|
7757
7842
|
# by the load balancer.
|
|
7758
7843
|
#
|
|
7759
7844
|
# * The `maximumPercent` parameter represents an upper limit on the
|
|
7760
|
-
# number of running tasks during task replacement
|
|
7761
|
-
#
|
|
7762
|
-
#
|
|
7763
|
-
#
|
|
7764
|
-
#
|
|
7765
|
-
#
|
|
7845
|
+
# number of running tasks during task replacement. You can use this to
|
|
7846
|
+
# define the replacement batch size. For example, if `desiredCount` is
|
|
7847
|
+
# four tasks, a maximum of 200% starts four new tasks before stopping
|
|
7848
|
+
# the four tasks to be drained, provided that the cluster resources
|
|
7849
|
+
# required to do this are available. If the maximum is 100%, then
|
|
7850
|
+
# replacement tasks can't start until the draining tasks have
|
|
7766
7851
|
# stopped.
|
|
7767
7852
|
#
|
|
7768
|
-
# Any `PENDING` or `RUNNING` tasks that do not belong to a service
|
|
7769
|
-
#
|
|
7853
|
+
# Any `PENDING` or `RUNNING` tasks that do not belong to a service
|
|
7854
|
+
# aren't affected. You must wait for them to finish or stop them
|
|
7855
|
+
# manually.
|
|
7770
7856
|
#
|
|
7771
7857
|
# A container instance has completed draining when it has no more
|
|
7772
7858
|
# `RUNNING` tasks. You can verify this using ListTasks.
|
|
@@ -7784,13 +7870,13 @@ module Aws::ECS
|
|
|
7784
7870
|
# A list of container instance IDs or full ARN entries.
|
|
7785
7871
|
#
|
|
7786
7872
|
# @option params [required, String] :status
|
|
7787
|
-
# The container instance state
|
|
7788
|
-
#
|
|
7789
|
-
#
|
|
7790
|
-
#
|
|
7791
|
-
#
|
|
7792
|
-
#
|
|
7793
|
-
#
|
|
7873
|
+
# The container instance state to update the container instance with.
|
|
7874
|
+
# The only valid values for this action are `ACTIVE` and `DRAINING`. A
|
|
7875
|
+
# container instance can only be updated to `DRAINING` status once it
|
|
7876
|
+
# has reached an `ACTIVE` state. If a container instance is in
|
|
7877
|
+
# `REGISTERING`, `DEREGISTERING`, or `REGISTRATION_FAILED` state you can
|
|
7878
|
+
# describe the container instance but can't update the container
|
|
7879
|
+
# instance state.
|
|
7794
7880
|
#
|
|
7795
7881
|
# @return [Types::UpdateContainerInstancesStateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7796
7882
|
#
|
|
@@ -7853,6 +7939,12 @@ module Aws::ECS
|
|
|
7853
7939
|
# resp.container_instances[0].tags #=> Array
|
|
7854
7940
|
# resp.container_instances[0].tags[0].key #=> String
|
|
7855
7941
|
# resp.container_instances[0].tags[0].value #=> String
|
|
7942
|
+
# resp.container_instances[0].health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
7943
|
+
# resp.container_instances[0].health_status.details #=> Array
|
|
7944
|
+
# resp.container_instances[0].health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
|
|
7945
|
+
# resp.container_instances[0].health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
|
|
7946
|
+
# resp.container_instances[0].health_status.details[0].last_updated #=> Time
|
|
7947
|
+
# resp.container_instances[0].health_status.details[0].last_status_change #=> Time
|
|
7856
7948
|
# resp.failures #=> Array
|
|
7857
7949
|
# resp.failures[0].arn #=> String
|
|
7858
7950
|
# resp.failures[0].reason #=> String
|
|
@@ -7885,15 +7977,15 @@ module Aws::ECS
|
|
|
7885
7977
|
# placement constraints and strategies, and health check grace period
|
|
7886
7978
|
# can be updated using this API. If the network configuration, platform
|
|
7887
7979
|
# version, or task definition need to be updated, a new CodeDeploy
|
|
7888
|
-
# deployment
|
|
7889
|
-
#
|
|
7980
|
+
# deployment is created. For more information, see [CreateDeployment][2]
|
|
7981
|
+
# in the *CodeDeploy API Reference*.
|
|
7890
7982
|
#
|
|
7891
7983
|
# For services using an external deployment controller, you can update
|
|
7892
7984
|
# only the desired count, task placement constraints and strategies, and
|
|
7893
7985
|
# health check grace period using this API. If the launch type, load
|
|
7894
7986
|
# balancer, network configuration, platform version, or task definition
|
|
7895
|
-
# need to be updated,
|
|
7896
|
-
#
|
|
7987
|
+
# need to be updated, create a new task set. For more information, see
|
|
7988
|
+
# CreateTaskSet.
|
|
7897
7989
|
#
|
|
7898
7990
|
# You can add to or subtract from the number of instantiations of a task
|
|
7899
7991
|
# definition in a service by specifying the cluster that the service is
|
|
@@ -7907,7 +7999,7 @@ module Aws::ECS
|
|
|
7907
7999
|
#
|
|
7908
8000
|
# <note markdown="1"> If your updated Docker image uses the same tag as what is in the
|
|
7909
8001
|
# existing task definition for your service (for example,
|
|
7910
|
-
# `my_image:latest`), you
|
|
8002
|
+
# `my_image:latest`), you don't need to create a new revision of your
|
|
7911
8003
|
# task definition. You can update the service using the
|
|
7912
8004
|
# `forceNewDeployment` option. The new tasks launched by the deployment
|
|
7913
8005
|
# pull the current image/tag combination from your repository when they
|
|
@@ -7925,14 +8017,14 @@ module Aws::ECS
|
|
|
7925
8017
|
# `desiredCount` temporarily during a deployment. For example, if
|
|
7926
8018
|
# `desiredCount` is four tasks, a minimum of 50% allows the scheduler
|
|
7927
8019
|
# to stop two existing tasks before starting two new tasks. Tasks for
|
|
7928
|
-
# services that
|
|
7929
|
-
# they
|
|
7930
|
-
# balancer are considered healthy if they
|
|
7931
|
-
# and the container instance they
|
|
8020
|
+
# services that don't use a load balancer are considered healthy if
|
|
8021
|
+
# they're in the `RUNNING` state. Tasks for services that use a load
|
|
8022
|
+
# balancer are considered healthy if they're in the `RUNNING` state
|
|
8023
|
+
# and the container instance they're hosted on is reported as healthy
|
|
7932
8024
|
# by the load balancer.
|
|
7933
8025
|
#
|
|
7934
8026
|
# * The `maximumPercent` parameter represents an upper limit on the
|
|
7935
|
-
# number of running tasks during a deployment
|
|
8027
|
+
# number of running tasks during a deployment. You can use it to
|
|
7936
8028
|
# define the deployment batch size. For example, if `desiredCount` is
|
|
7937
8029
|
# four tasks, a maximum of 200% starts four new tasks before stopping
|
|
7938
8030
|
# the four older tasks (provided that the cluster resources required
|
|
@@ -7940,21 +8032,21 @@ module Aws::ECS
|
|
|
7940
8032
|
#
|
|
7941
8033
|
# When UpdateService stops a task during a deployment, the equivalent of
|
|
7942
8034
|
# `docker stop` is issued to the containers running in the task. This
|
|
7943
|
-
# results in a `SIGTERM` and a 30-second timeout
|
|
8035
|
+
# results in a `SIGTERM` and a 30-second timeout. After this, `SIGKILL`
|
|
7944
8036
|
# is sent and the containers are forcibly stopped. If the container
|
|
7945
8037
|
# handles the `SIGTERM` gracefully and exits within 30 seconds from
|
|
7946
8038
|
# receiving it, no `SIGKILL` is sent.
|
|
7947
8039
|
#
|
|
7948
8040
|
# When the service scheduler launches new tasks, it determines task
|
|
7949
|
-
# placement in your cluster with the following logic
|
|
8041
|
+
# placement in your cluster with the following logic.
|
|
7950
8042
|
#
|
|
7951
8043
|
# * Determine which of the container instances in your cluster can
|
|
7952
|
-
# support your service's task definition
|
|
7953
|
-
# required CPU, memory, ports, and container instance attributes
|
|
8044
|
+
# support your service's task definition. For example, they have the
|
|
8045
|
+
# required CPU, memory, ports, and container instance attributes.
|
|
7954
8046
|
#
|
|
7955
8047
|
# * By default, the service scheduler attempts to balance tasks across
|
|
7956
|
-
# Availability Zones in this manner
|
|
7957
|
-
# different placement strategy
|
|
8048
|
+
# Availability Zones in this manner even though you can choose a
|
|
8049
|
+
# different placement strategy.
|
|
7958
8050
|
#
|
|
7959
8051
|
# * Sort the valid container instances by the fewest number of running
|
|
7960
8052
|
# tasks for this service in the same Availability Zone as the
|
|
@@ -7988,8 +8080,8 @@ module Aws::ECS
|
|
|
7988
8080
|
#
|
|
7989
8081
|
# @option params [String] :cluster
|
|
7990
8082
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
7991
|
-
# your service
|
|
7992
|
-
#
|
|
8083
|
+
# your service runs on. If you do not specify a cluster, the default
|
|
8084
|
+
# cluster is assumed.
|
|
7993
8085
|
#
|
|
7994
8086
|
# @option params [required, String] :service
|
|
7995
8087
|
# The name of the service to update.
|
|
@@ -8009,11 +8101,11 @@ module Aws::ECS
|
|
|
8009
8101
|
# @option params [Array<Types::CapacityProviderStrategyItem>] :capacity_provider_strategy
|
|
8010
8102
|
# The capacity provider strategy to update the service to use.
|
|
8011
8103
|
#
|
|
8012
|
-
#
|
|
8104
|
+
# if the service uses the default capacity provider strategy for the
|
|
8013
8105
|
# cluster, the service can be updated to use one or more capacity
|
|
8014
8106
|
# providers as opposed to the default capacity provider strategy.
|
|
8015
|
-
# However, when a service is using a capacity provider strategy that
|
|
8016
|
-
# not the default capacity provider strategy, the service
|
|
8107
|
+
# However, when a service is using a capacity provider strategy that's
|
|
8108
|
+
# not the default capacity provider strategy, the service can't be
|
|
8017
8109
|
# updated to use the cluster's default capacity provider strategy.
|
|
8018
8110
|
#
|
|
8019
8111
|
# A capacity provider strategy consists of one or more capacity
|
|
@@ -8050,9 +8142,9 @@ module Aws::ECS
|
|
|
8050
8142
|
# override any existing placement constraints defined for the service.
|
|
8051
8143
|
# To remove all existing placement constraints, specify an empty array.
|
|
8052
8144
|
#
|
|
8053
|
-
# You can specify a maximum of 10 constraints
|
|
8145
|
+
# You can specify a maximum of 10 constraints for each task. This limit
|
|
8054
8146
|
# includes constraints in the task definition and those specified at
|
|
8055
|
-
# runtime
|
|
8147
|
+
# runtime.
|
|
8056
8148
|
#
|
|
8057
8149
|
# @option params [Array<Types::PlacementStrategy>] :placement_strategy
|
|
8058
8150
|
# The task placement strategy objects to update the service to use. If
|
|
@@ -8061,32 +8153,31 @@ module Aws::ECS
|
|
|
8061
8153
|
# the existing placement strategy defined for the service. To remove an
|
|
8062
8154
|
# existing placement strategy, specify an empty object.
|
|
8063
8155
|
#
|
|
8064
|
-
# You can specify a maximum of five strategy rules
|
|
8156
|
+
# You can specify a maximum of five strategy rules for each service.
|
|
8065
8157
|
#
|
|
8066
8158
|
# @option params [String] :platform_version
|
|
8067
|
-
# The platform version
|
|
8068
|
-
#
|
|
8069
|
-
#
|
|
8070
|
-
#
|
|
8071
|
-
#
|
|
8072
|
-
# Developer Guide*.
|
|
8159
|
+
# The platform version that your tasks in the service run on. A platform
|
|
8160
|
+
# version is only specified for tasks using the Fargate launch type. If
|
|
8161
|
+
# a platform version is not specified, the `LATEST` platform version is
|
|
8162
|
+
# used. For more information, see [Fargate Platform Versions][1] in the
|
|
8163
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
|
8073
8164
|
#
|
|
8074
8165
|
#
|
|
8075
8166
|
#
|
|
8076
8167
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
|
8077
8168
|
#
|
|
8078
8169
|
# @option params [Boolean] :force_new_deployment
|
|
8079
|
-
#
|
|
8080
|
-
#
|
|
8081
|
-
# with no service definition changes. For example, you
|
|
8082
|
-
# service's tasks to use a newer Docker image with the
|
|
8083
|
-
# combination (`my_image:latest`) or to roll Fargate
|
|
8084
|
-
# platform version.
|
|
8170
|
+
# Determines whether to force a new deployment of the service. By
|
|
8171
|
+
# default, deployments aren't forced. You can use this option to start
|
|
8172
|
+
# a new deployment with no service definition changes. For example, you
|
|
8173
|
+
# can update a service's tasks to use a newer Docker image with the
|
|
8174
|
+
# same image/tag combination (`my_image:latest`) or to roll Fargate
|
|
8175
|
+
# tasks onto a newer platform version.
|
|
8085
8176
|
#
|
|
8086
8177
|
# @option params [Integer] :health_check_grace_period_seconds
|
|
8087
8178
|
# The period of time, in seconds, that the Amazon ECS service scheduler
|
|
8088
|
-
#
|
|
8089
|
-
#
|
|
8179
|
+
# ignores unhealthy Elastic Load Balancing target health checks after a
|
|
8180
|
+
# task has first started. This is only valid if your service is
|
|
8090
8181
|
# configured to use a load balancer. If your service's tasks take a
|
|
8091
8182
|
# while to start and respond to Elastic Load Balancing health checks,
|
|
8092
8183
|
# you can specify a health check grace period of up to 2,147,483,647
|
|
@@ -8205,6 +8296,7 @@ module Aws::ECS
|
|
|
8205
8296
|
# resp.service.capacity_provider_strategy[0].weight #=> Integer
|
|
8206
8297
|
# resp.service.capacity_provider_strategy[0].base #=> Integer
|
|
8207
8298
|
# resp.service.platform_version #=> String
|
|
8299
|
+
# resp.service.platform_family #=> String
|
|
8208
8300
|
# resp.service.task_definition #=> String
|
|
8209
8301
|
# resp.service.deployment_configuration.deployment_circuit_breaker.enable #=> Boolean
|
|
8210
8302
|
# resp.service.deployment_configuration.deployment_circuit_breaker.rollback #=> Boolean
|
|
@@ -8230,6 +8322,7 @@ module Aws::ECS
|
|
|
8230
8322
|
# resp.service.task_sets[0].capacity_provider_strategy[0].weight #=> Integer
|
|
8231
8323
|
# resp.service.task_sets[0].capacity_provider_strategy[0].base #=> Integer
|
|
8232
8324
|
# resp.service.task_sets[0].platform_version #=> String
|
|
8325
|
+
# resp.service.task_sets[0].platform_family #=> String
|
|
8233
8326
|
# resp.service.task_sets[0].network_configuration.awsvpc_configuration.subnets #=> Array
|
|
8234
8327
|
# resp.service.task_sets[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
|
|
8235
8328
|
# resp.service.task_sets[0].network_configuration.awsvpc_configuration.security_groups #=> Array
|
|
@@ -8268,6 +8361,7 @@ module Aws::ECS
|
|
|
8268
8361
|
# resp.service.deployments[0].capacity_provider_strategy[0].base #=> Integer
|
|
8269
8362
|
# resp.service.deployments[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
|
|
8270
8363
|
# resp.service.deployments[0].platform_version #=> String
|
|
8364
|
+
# resp.service.deployments[0].platform_family #=> String
|
|
8271
8365
|
# resp.service.deployments[0].network_configuration.awsvpc_configuration.subnets #=> Array
|
|
8272
8366
|
# resp.service.deployments[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
|
|
8273
8367
|
# resp.service.deployments[0].network_configuration.awsvpc_configuration.security_groups #=> Array
|
|
@@ -8368,6 +8462,7 @@ module Aws::ECS
|
|
|
8368
8462
|
# resp.task_set.capacity_provider_strategy[0].weight #=> Integer
|
|
8369
8463
|
# resp.task_set.capacity_provider_strategy[0].base #=> Integer
|
|
8370
8464
|
# resp.task_set.platform_version #=> String
|
|
8465
|
+
# resp.task_set.platform_family #=> String
|
|
8371
8466
|
# resp.task_set.network_configuration.awsvpc_configuration.subnets #=> Array
|
|
8372
8467
|
# resp.task_set.network_configuration.awsvpc_configuration.subnets[0] #=> String
|
|
8373
8468
|
# resp.task_set.network_configuration.awsvpc_configuration.security_groups #=> Array
|
|
@@ -8411,11 +8506,11 @@ module Aws::ECS
|
|
|
8411
8506
|
#
|
|
8412
8507
|
# @option params [required, String] :cluster
|
|
8413
8508
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
8414
|
-
# hosts the service that the task set
|
|
8509
|
+
# hosts the service that the task set is found in.
|
|
8415
8510
|
#
|
|
8416
8511
|
# @option params [required, String] :service
|
|
8417
8512
|
# The short name or full Amazon Resource Name (ARN) of the service that
|
|
8418
|
-
# the task set
|
|
8513
|
+
# the task set is found in.
|
|
8419
8514
|
#
|
|
8420
8515
|
# @option params [required, String] :task_set
|
|
8421
8516
|
# The short name or full Amazon Resource Name (ARN) of the task set to
|
|
@@ -8462,6 +8557,7 @@ module Aws::ECS
|
|
|
8462
8557
|
# resp.task_set.capacity_provider_strategy[0].weight #=> Integer
|
|
8463
8558
|
# resp.task_set.capacity_provider_strategy[0].base #=> Integer
|
|
8464
8559
|
# resp.task_set.platform_version #=> String
|
|
8560
|
+
# resp.task_set.platform_family #=> String
|
|
8465
8561
|
# resp.task_set.network_configuration.awsvpc_configuration.subnets #=> Array
|
|
8466
8562
|
# resp.task_set.network_configuration.awsvpc_configuration.subnets[0] #=> String
|
|
8467
8563
|
# resp.task_set.network_configuration.awsvpc_configuration.security_groups #=> Array
|
|
@@ -8507,7 +8603,7 @@ module Aws::ECS
|
|
|
8507
8603
|
params: params,
|
|
8508
8604
|
config: config)
|
|
8509
8605
|
context[:gem_name] = 'aws-sdk-ecs'
|
|
8510
|
-
context[:gem_version] = '1.
|
|
8606
|
+
context[:gem_version] = '1.90.0'
|
|
8511
8607
|
Seahorse::Client::Request.new(handlers, context)
|
|
8512
8608
|
end
|
|
8513
8609
|
|