aws-sdk-ecs 1.97.0 → 1.100.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ecs/client.rb +112 -63
- data/lib/aws-sdk-ecs/types.rb +235 -132
- data/lib/aws-sdk-ecs.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b281c3b06771b917ba901037424e0fd0729911f7fb4a379059854c0ace42794c
|
4
|
+
data.tar.gz: ca27528e3d0d988c2d25082036867137404e2aa08701127b529b9b135f775b99
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4e6f1dde1e63dc7968ade75e69a178fde91bf571aa66cdc18d7b1b48ed42647585440c4bf408aa5d85e63bd6a7f04dff9f1163af0dfeaddb8b4c3f61bf1bc391
|
7
|
+
data.tar.gz: e27a8623fc0de329ec6f72128162a25ca9a1deea292df9f9b3932f957d322f1e6206db46d5895c6731c2f81d4066e7082933a7a336c5b3739f6132d7a268422b
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.100.0 (2022-06-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Amazon ECS UpdateService now supports the following parameters: PlacementStrategies, PlacementConstraints and CapacityProviderStrategy.
|
8
|
+
|
9
|
+
1.99.0 (2022-03-22)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Documentation only update to address tickets
|
13
|
+
|
14
|
+
1.98.0 (2022-03-15)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Documentation only update to address tickets
|
18
|
+
|
4
19
|
1.97.0 (2022-03-07)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.100.0
|
data/lib/aws-sdk-ecs/client.rb
CHANGED
@@ -473,7 +473,7 @@ module Aws::ECS
|
|
473
473
|
# that it can manage required resources in other Amazon Web Services
|
474
474
|
# services on your behalf. However, if the IAM user that makes the call
|
475
475
|
# doesn't have permissions to create the service-linked role, it isn't
|
476
|
-
# created. For more information, see [Using
|
476
|
+
# created. For more information, see [Using service-linked roles for
|
477
477
|
# Amazon ECS][1] in the *Amazon Elastic Container Service Developer
|
478
478
|
# Guide*.
|
479
479
|
#
|
@@ -526,7 +526,7 @@ module Aws::ECS
|
|
526
526
|
# PutAccountSetting or PutAccountSettingDefault.
|
527
527
|
#
|
528
528
|
# @option params [Types::ClusterConfiguration] :configuration
|
529
|
-
# The execute command configuration for the cluster.
|
529
|
+
# The `execute` command configuration for the cluster.
|
530
530
|
#
|
531
531
|
# @option params [Array<String>] :capacity_providers
|
532
532
|
# The short name of one or more capacity providers to associate with the
|
@@ -683,8 +683,8 @@ module Aws::ECS
|
|
683
683
|
# In addition to maintaining the desired count of tasks in your service,
|
684
684
|
# you can optionally run your service behind one or more load balancers.
|
685
685
|
# The load balancers distribute traffic across the tasks that are
|
686
|
-
# associated with the service. For more information, see [Service
|
687
|
-
#
|
686
|
+
# associated with the service. For more information, see [Service load
|
687
|
+
# balancing][1] in the *Amazon Elastic Container Service Developer
|
688
688
|
# Guide*.
|
689
689
|
#
|
690
690
|
# Tasks for services that don't use a load balancer are considered
|
@@ -698,8 +698,8 @@ module Aws::ECS
|
|
698
698
|
# your desired number of tasks across your cluster. By default, the
|
699
699
|
# service scheduler spreads tasks across Availability Zones. You can
|
700
700
|
# use task placement strategies and constraints to customize task
|
701
|
-
# placement decisions. For more information, see [Service
|
702
|
-
#
|
701
|
+
# placement decisions. For more information, see [Service scheduler
|
702
|
+
# concepts][2] in the *Amazon Elastic Container Service Developer
|
703
703
|
# Guide*.
|
704
704
|
#
|
705
705
|
# * `DAEMON` - The daemon scheduling strategy deploys exactly one task
|
@@ -709,8 +709,8 @@ module Aws::ECS
|
|
709
709
|
# tasks. It also stops tasks that don't meet the placement
|
710
710
|
# constraints. When using this strategy, you don't need to specify a
|
711
711
|
# desired number of tasks, a task placement strategy, or use Service
|
712
|
-
# Auto Scaling policies. For more information, see [Service
|
713
|
-
#
|
712
|
+
# Auto Scaling policies. For more information, see [Service scheduler
|
713
|
+
# concepts][2] in the *Amazon Elastic Container Service Developer
|
714
714
|
# Guide*.
|
715
715
|
#
|
716
716
|
# You can optionally specify a deployment configuration for your
|
@@ -766,7 +766,7 @@ module Aws::ECS
|
|
766
766
|
# controller, you can specify only parameters that aren't controlled at
|
767
767
|
# the task set level. The only required parameter is the service name.
|
768
768
|
# You control your services using the CreateTaskSet operation. For more
|
769
|
-
# information, see [Amazon ECS
|
769
|
+
# information, see [Amazon ECS deployment types][3] in the *Amazon
|
770
770
|
# Elastic Container Service Developer Guide*.
|
771
771
|
#
|
772
772
|
# When the service scheduler launches new tasks, it determines task
|
@@ -820,7 +820,7 @@ module Aws::ECS
|
|
820
820
|
#
|
821
821
|
# @option params [Array<Types::LoadBalancer>] :load_balancers
|
822
822
|
# A load balancer object representing the load balancers to use with
|
823
|
-
# your service. For more information, see [Service
|
823
|
+
# your service. For more information, see [Service load balancing][1] in
|
824
824
|
# the *Amazon Elastic Container Service Developer Guide*.
|
825
825
|
#
|
826
826
|
# If the service uses the rolling update (`ECS`) deployment controller
|
@@ -1100,8 +1100,8 @@ module Aws::ECS
|
|
1100
1100
|
#
|
1101
1101
|
# @option params [Boolean] :enable_ecs_managed_tags
|
1102
1102
|
# Specifies whether to turn on Amazon ECS managed tags for the tasks
|
1103
|
-
# within the service. For more information, see [Tagging
|
1104
|
-
#
|
1103
|
+
# within the service. For more information, see [Tagging your Amazon ECS
|
1104
|
+
# resources][1] in the *Amazon Elastic Container Service Developer
|
1105
1105
|
# Guide*.
|
1106
1106
|
#
|
1107
1107
|
#
|
@@ -1109,12 +1109,10 @@ module Aws::ECS
|
|
1109
1109
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
1110
1110
|
#
|
1111
1111
|
# @option params [String] :propagate_tags
|
1112
|
-
# Specifies whether to propagate the tags from the task definition
|
1113
|
-
# the
|
1114
|
-
#
|
1115
|
-
#
|
1116
|
-
# after service creation or task creation, use the TagResource API
|
1117
|
-
# action.
|
1112
|
+
# Specifies whether to propagate the tags from the task definition to
|
1113
|
+
# the task. If no value is specified, the tags aren't propagated. Tags
|
1114
|
+
# can only be propagated to the task during task creation. To add tags
|
1115
|
+
# to a task after task creation, use the TagResource API action.
|
1118
1116
|
#
|
1119
1117
|
# @option params [Boolean] :enable_execute_command
|
1120
1118
|
# Determines whether the execute command functionality is enabled for
|
@@ -1457,7 +1455,7 @@ module Aws::ECS
|
|
1457
1455
|
|
1458
1456
|
# Create a task set in the specified cluster and service. This is used
|
1459
1457
|
# when a service uses the `EXTERNAL` deployment controller type. For
|
1460
|
-
# more information, see [Amazon ECS
|
1458
|
+
# more information, see [Amazon ECS deployment types][1] in the *Amazon
|
1461
1459
|
# Elastic Container Service Developer Guide*.
|
1462
1460
|
#
|
1463
1461
|
#
|
@@ -1492,7 +1490,7 @@ module Aws::ECS
|
|
1492
1490
|
#
|
1493
1491
|
# @option params [Array<Types::ServiceRegistry>] :service_registries
|
1494
1492
|
# The details of the service discovery registries to assign to this task
|
1495
|
-
# set. For more information, see [Service
|
1493
|
+
# set. For more information, see [Service discovery][1].
|
1496
1494
|
#
|
1497
1495
|
#
|
1498
1496
|
#
|
@@ -1500,7 +1498,7 @@ module Aws::ECS
|
|
1500
1498
|
#
|
1501
1499
|
# @option params [String] :launch_type
|
1502
1500
|
# The launch type that new tasks in the task set uses. For more
|
1503
|
-
# information, see [Amazon ECS
|
1501
|
+
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
1504
1502
|
# Container Service Developer Guide*.
|
1505
1503
|
#
|
1506
1504
|
# If a `launchType` is specified, the `capacityProviderStrategy`
|
@@ -2180,7 +2178,7 @@ module Aws::ECS
|
|
2180
2178
|
|
2181
2179
|
# Deletes a specified task set within a service. This is used when a
|
2182
2180
|
# service uses the `EXTERNAL` deployment controller type. For more
|
2183
|
-
# information, see [Amazon ECS
|
2181
|
+
# information, see [Amazon ECS deployment types][1] in the *Amazon
|
2184
2182
|
# Elastic Container Service Developer Guide*.
|
2185
2183
|
#
|
2186
2184
|
#
|
@@ -2297,11 +2295,12 @@ module Aws::ECS
|
|
2297
2295
|
#
|
2298
2296
|
# @option params [required, String] :container_instance
|
2299
2297
|
# The container instance ID or full ARN of the container instance to
|
2300
|
-
# deregister.
|
2301
|
-
#
|
2302
|
-
#
|
2303
|
-
#
|
2304
|
-
#
|
2298
|
+
# deregister. For more information about the ARN format, see [Amazon
|
2299
|
+
# Resource Name (ARN)][1] in the *Amazon ECS Developer Guide*.
|
2300
|
+
#
|
2301
|
+
#
|
2302
|
+
#
|
2303
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids
|
2305
2304
|
#
|
2306
2305
|
# @option params [Boolean] :force
|
2307
2306
|
# Forces the container instance to be deregistered. If you have tasks
|
@@ -3607,6 +3606,9 @@ module Aws::ECS
|
|
3607
3606
|
|
3608
3607
|
# Describes a specified task or tasks.
|
3609
3608
|
#
|
3609
|
+
# Currently, stopped tasks appear in the returned results for at least
|
3610
|
+
# one hour.
|
3611
|
+
#
|
3610
3612
|
# @option params [String] :cluster
|
3611
3613
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
3612
3614
|
# hosts the task or tasks to describe. If you do not specify a cluster,
|
@@ -3818,12 +3820,13 @@ module Aws::ECS
|
|
3818
3820
|
# Returns an endpoint for the Amazon ECS agent to poll for updates.
|
3819
3821
|
#
|
3820
3822
|
# @option params [String] :container_instance
|
3821
|
-
# The container instance ID or full ARN of the container instance.
|
3822
|
-
#
|
3823
|
-
#
|
3824
|
-
#
|
3825
|
-
#
|
3826
|
-
#
|
3823
|
+
# The container instance ID or full ARN of the container instance. For
|
3824
|
+
# more information about the ARN format, see [Amazon Resource Name
|
3825
|
+
# (ARN)][1] in the *Amazon ECS Developer Guide*.
|
3826
|
+
#
|
3827
|
+
#
|
3828
|
+
#
|
3829
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids
|
3827
3830
|
#
|
3828
3831
|
# @option params [String] :cluster
|
3829
3832
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
@@ -3857,6 +3860,12 @@ module Aws::ECS
|
|
3857
3860
|
|
3858
3861
|
# Runs a command remotely on a container within a task.
|
3859
3862
|
#
|
3863
|
+
# If you use a condition key in your IAM policy to refine the conditions
|
3864
|
+
# for the policy statement, for example limit the actions to a specific
|
3865
|
+
# cluster, you recevie an `AccessDeniedException` when there is a
|
3866
|
+
# mismatch between the condition key value and the corresponding
|
3867
|
+
# parameter value.
|
3868
|
+
#
|
3860
3869
|
# @option params [String] :cluster
|
3861
3870
|
# The Amazon Resource Name (ARN) or short name of the cluster the task
|
3862
3871
|
# is running in. If you do not specify a cluster, the default cluster is
|
@@ -6284,6 +6293,9 @@ module Aws::ECS
|
|
6284
6293
|
# containers in this task. If `true`, this enables execute command
|
6285
6294
|
# functionality on all containers in the task.
|
6286
6295
|
#
|
6296
|
+
# If `true`, then the task definition must have a task role, or you must
|
6297
|
+
# provide one as an override.
|
6298
|
+
#
|
6287
6299
|
# @option params [String] :group
|
6288
6300
|
# The name of the task group to associate with the task. The default
|
6289
6301
|
# value is the family name of the task definition (for example,
|
@@ -6427,13 +6439,33 @@ module Aws::ECS
|
|
6427
6439
|
# task definition to run. If a `revision` isn't specified, the latest
|
6428
6440
|
# `ACTIVE` revision is used.
|
6429
6441
|
#
|
6442
|
+
# When you create an IAM policy for run-task, you can set the resource
|
6443
|
+
# to be the latest task definition revision, or a specific revision.
|
6444
|
+
#
|
6430
6445
|
# The full ARN value must match the value that you specified as the
|
6431
|
-
# `Resource` of the IAM principal's permissions policy.
|
6432
|
-
#
|
6433
|
-
#
|
6434
|
-
# the `
|
6446
|
+
# `Resource` of the IAM principal's permissions policy.
|
6447
|
+
#
|
6448
|
+
# When you specify the policy resource as the latest task definition
|
6449
|
+
# version (by setting the `Resource` in the policy to
|
6450
|
+
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName`),
|
6451
|
+
# then set this value to
|
6435
6452
|
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName`.
|
6436
6453
|
#
|
6454
|
+
# When you specify the policy resource as a specific task definition
|
6455
|
+
# version (by setting the `Resource` in the policy to
|
6456
|
+
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1`
|
6457
|
+
# or
|
6458
|
+
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*`),
|
6459
|
+
# then set this value to
|
6460
|
+
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1`.
|
6461
|
+
#
|
6462
|
+
# For more information, see [Policy Resources for Amazon ECS][1] in the
|
6463
|
+
# Amazon Elastic Container Service developer Guide.
|
6464
|
+
#
|
6465
|
+
#
|
6466
|
+
#
|
6467
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-resources
|
6468
|
+
#
|
6437
6469
|
# @return [Types::RunTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6438
6470
|
#
|
6439
6471
|
# * {Types::RunTaskResponse#tasks #tasks} => Array<Types::Task>
|
@@ -7857,7 +7889,7 @@ module Aws::ECS
|
|
7857
7889
|
# services that do not use a load balancer are considered healthy if
|
7858
7890
|
# they're in the `RUNNING` state. Tasks for services that use a load
|
7859
7891
|
# balancer are considered healthy if they're in the `RUNNING` state
|
7860
|
-
# and are reported as healthy by the load balancer
|
7892
|
+
# and are reported as healthy by the load balancer.
|
7861
7893
|
#
|
7862
7894
|
# * The `maximumPercent` parameter represents an upper limit on the
|
7863
7895
|
# number of running tasks during task replacement. You can use this to
|
@@ -7977,29 +8009,23 @@ module Aws::ECS
|
|
7977
8009
|
req.send_request(options)
|
7978
8010
|
end
|
7979
8011
|
|
7980
|
-
# Updating the task placement strategies and constraints on an Amazon
|
7981
|
-
# ECS service remains in preview and is a Beta Service as defined by and
|
7982
|
-
# subject to the Beta Service Participation Service Terms located at
|
7983
|
-
# [https://aws.amazon.com/service-terms][1] ("Beta Terms"). These Beta
|
7984
|
-
# Terms apply to your participation in this preview.
|
7985
|
-
#
|
7986
8012
|
# Modifies the parameters of a service.
|
7987
8013
|
#
|
7988
8014
|
# For services using the rolling update (`ECS`) you can update the
|
7989
|
-
# desired count,
|
7990
|
-
#
|
7991
|
-
#
|
7992
|
-
#
|
7993
|
-
#
|
8015
|
+
# desired count, deployment configuration, network configuration, load
|
8016
|
+
# balancers, service registries, enable ECS managed tags option,
|
8017
|
+
# propagate tags option, task placement constraints and strategies, and
|
8018
|
+
# task definition. When you update any of these parameters, Amazon ECS
|
8019
|
+
# starts new tasks with the new configuration.
|
7994
8020
|
#
|
7995
8021
|
# For services using the blue/green (`CODE_DEPLOY`) deployment
|
7996
|
-
# controller, only the desired count, deployment configuration,
|
7997
|
-
# placement constraints and strategies, enable
|
7998
|
-
# and propagate tags can be updated using this
|
7999
|
-
# configuration, platform version, task definition,
|
8000
|
-
# need to be updated, create a new CodeDeploy
|
8001
|
-
# information, see [CreateDeployment][
|
8002
|
-
# Reference*.
|
8022
|
+
# controller, only the desired count, deployment configuration, health
|
8023
|
+
# check grace period, task placement constraints and strategies, enable
|
8024
|
+
# ECS managed tags option, and propagate tags can be updated using this
|
8025
|
+
# API. If the network configuration, platform version, task definition,
|
8026
|
+
# or load balancer need to be updated, create a new CodeDeploy
|
8027
|
+
# deployment. For more information, see [CreateDeployment][1] in the
|
8028
|
+
# *CodeDeploy API Reference*.
|
8003
8029
|
#
|
8004
8030
|
# For services using an external deployment controller, you can update
|
8005
8031
|
# only the desired count, task placement constraints and strategies,
|
@@ -8097,9 +8123,9 @@ module Aws::ECS
|
|
8097
8123
|
# <note markdown="1"> You must have a service-linked role when you update any of the
|
8098
8124
|
# following service properties. If you specified a custom IAM role when
|
8099
8125
|
# you created the service, Amazon ECS automatically replaces the
|
8100
|
-
# [roleARN][
|
8126
|
+
# [roleARN][2] associated with the service with the ARN of your
|
8101
8127
|
# service-linked role. For more information, see [Service-linked
|
8102
|
-
# roles][
|
8128
|
+
# roles][3] in the *Amazon Elastic Container Service Developer Guide*.
|
8103
8129
|
#
|
8104
8130
|
# * `loadBalancers,`
|
8105
8131
|
#
|
@@ -8109,10 +8135,9 @@ module Aws::ECS
|
|
8109
8135
|
#
|
8110
8136
|
#
|
8111
8137
|
#
|
8112
|
-
# [1]: https://aws.amazon.com/
|
8113
|
-
# [2]: https://docs.aws.amazon.com/
|
8114
|
-
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/
|
8115
|
-
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html
|
8138
|
+
# [1]: https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html
|
8139
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Service.html#ECS-Type-Service-roleArn
|
8140
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html
|
8116
8141
|
#
|
8117
8142
|
# @option params [String] :cluster
|
8118
8143
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
@@ -8254,8 +8279,32 @@ module Aws::ECS
|
|
8254
8279
|
# configuration, and then stops the old tasks when the new tasks are
|
8255
8280
|
# running.
|
8256
8281
|
#
|
8282
|
+
# For services that use rolling updates, you can add, update, or remove
|
8283
|
+
# Elastic Load Balancing target groups. You can update from a single
|
8284
|
+
# target group to multiple target groups and from multiple target groups
|
8285
|
+
# to a single target group.
|
8286
|
+
#
|
8287
|
+
# For services that use blue/green deployments, you can update Elastic
|
8288
|
+
# Load Balancing target groups by using ` CreateDeployment ` through
|
8289
|
+
# CodeDeploy. Note that multiple target groups are not supported for
|
8290
|
+
# blue/green deployments. For more information see [Register multiple
|
8291
|
+
# target groups with a service][1] in the *Amazon Elastic Container
|
8292
|
+
# Service Developer Guide*.
|
8293
|
+
#
|
8294
|
+
# For services that use the external deployment controller, you can add,
|
8295
|
+
# update, or remove load balancers by using [CreateTaskSet][2]. Note
|
8296
|
+
# that multiple target groups are not supported for external
|
8297
|
+
# deployments. For more information see [Register multiple target groups
|
8298
|
+
# with a service][1] in the *Amazon Elastic Container Service Developer
|
8299
|
+
# Guide*.
|
8300
|
+
#
|
8257
8301
|
# You can remove existing `loadBalancers` by passing an empty list.
|
8258
8302
|
#
|
8303
|
+
#
|
8304
|
+
#
|
8305
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html
|
8306
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html
|
8307
|
+
#
|
8259
8308
|
# @option params [String] :propagate_tags
|
8260
8309
|
# Determines whether to propagate the tags from the task definition or
|
8261
8310
|
# the service to the task. If no value is specified, the tags aren't
|
@@ -8708,7 +8757,7 @@ module Aws::ECS
|
|
8708
8757
|
params: params,
|
8709
8758
|
config: config)
|
8710
8759
|
context[:gem_name] = 'aws-sdk-ecs'
|
8711
|
-
context[:gem_version] = '1.
|
8760
|
+
context[:gem_version] = '1.100.0'
|
8712
8761
|
Seahorse::Client::Request.new(handlers, context)
|
8713
8762
|
end
|
8714
8763
|
|
data/lib/aws-sdk-ecs/types.rb
CHANGED
@@ -506,11 +506,13 @@ module Aws::ECS
|
|
506
506
|
# simultaneously.
|
507
507
|
#
|
508
508
|
# @!attribute [rw] cluster_arn
|
509
|
-
# The Amazon Resource Name (ARN) that identifies the cluster.
|
510
|
-
#
|
511
|
-
#
|
512
|
-
#
|
513
|
-
#
|
509
|
+
# The Amazon Resource Name (ARN) that identifies the cluster. For more
|
510
|
+
# information about the ARN format, see [Amazon Resource Name
|
511
|
+
# (ARN)][1] in the *Amazon ECS Developer Guide*.
|
512
|
+
#
|
513
|
+
#
|
514
|
+
#
|
515
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids
|
514
516
|
# @return [String]
|
515
517
|
#
|
516
518
|
# @!attribute [rw] cluster_name
|
@@ -642,8 +644,8 @@ module Aws::ECS
|
|
642
644
|
#
|
643
645
|
# @!attribute [rw] attachments
|
644
646
|
# The resources attached to a cluster. When using a capacity provider
|
645
|
-
# with a cluster, the
|
646
|
-
#
|
647
|
+
# with a cluster, the capacity provider and associated resources are
|
648
|
+
# returned as cluster attachments.
|
647
649
|
# @return [Array<Types::Attachment>]
|
648
650
|
#
|
649
651
|
# @!attribute [rw] attachments_status
|
@@ -653,8 +655,6 @@ module Aws::ECS
|
|
653
655
|
# UPDATE\_IN\_PROGRESS
|
654
656
|
#
|
655
657
|
# : The available capacity providers for the cluster are updating.
|
656
|
-
# This occurs when the Auto Scaling plan is provisioning or
|
657
|
-
# deprovisioning.
|
658
658
|
#
|
659
659
|
# UPDATE\_COMPLETE
|
660
660
|
#
|
@@ -1184,12 +1184,12 @@ module Aws::ECS
|
|
1184
1184
|
# container is placed. Otherwise, the value of `memory` is used.
|
1185
1185
|
#
|
1186
1186
|
# The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of
|
1187
|
-
# memory for a container,
|
1188
|
-
#
|
1187
|
+
# memory for a container. So, don't specify less than 6 MiB of memory
|
1188
|
+
# for your containers.
|
1189
1189
|
#
|
1190
1190
|
# The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB
|
1191
|
-
# of memory for a container,
|
1192
|
-
#
|
1191
|
+
# of memory for a container. So, don't specify less than 4 MiB of
|
1192
|
+
# memory for your containers.
|
1193
1193
|
#
|
1194
1194
|
#
|
1195
1195
|
#
|
@@ -2073,16 +2073,17 @@ module Aws::ECS
|
|
2073
2073
|
include Aws::Structure
|
2074
2074
|
end
|
2075
2075
|
|
2076
|
-
# An EC2 instance that's running the Amazon ECS
|
2077
|
-
# registered with a cluster.
|
2076
|
+
# An Amazon EC2 or External instance that's running the Amazon ECS
|
2077
|
+
# agent and has been registered with a cluster.
|
2078
2078
|
#
|
2079
2079
|
# @!attribute [rw] container_instance_arn
|
2080
|
-
# The Amazon Resource Name (ARN) of the container instance.
|
2081
|
-
#
|
2082
|
-
#
|
2083
|
-
#
|
2084
|
-
#
|
2085
|
-
#
|
2080
|
+
# The Amazon Resource Name (ARN) of the container instance. For more
|
2081
|
+
# information about the ARN format, see [Amazon Resource Name
|
2082
|
+
# (ARN)][1] in the *Amazon ECS Developer Guide*.
|
2083
|
+
#
|
2084
|
+
#
|
2085
|
+
#
|
2086
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids
|
2086
2087
|
# @return [String]
|
2087
2088
|
#
|
2088
2089
|
# @!attribute [rw] ec2_instance_id
|
@@ -2156,7 +2157,7 @@ module Aws::ECS
|
|
2156
2157
|
# tasks. The `DRAINING` indicates that new tasks aren't placed on the
|
2157
2158
|
# container instance and any service tasks running on the container
|
2158
2159
|
# instance are removed if possible. For more information, see
|
2159
|
-
# [Container
|
2160
|
+
# [Container instance draining][1] in the *Amazon Elastic Container
|
2160
2161
|
# Service Developer Guide*.
|
2161
2162
|
#
|
2162
2163
|
#
|
@@ -2170,9 +2171,9 @@ module Aws::ECS
|
|
2170
2171
|
#
|
2171
2172
|
# @!attribute [rw] agent_connected
|
2172
2173
|
# This parameter returns `true` if the agent is connected to Amazon
|
2173
|
-
# ECS.
|
2174
|
-
#
|
2175
|
-
#
|
2174
|
+
# ECS. An instance with an agent that may be unhealthy or stopped
|
2175
|
+
# return `false`. Only instances connected to an agent can accept task
|
2176
|
+
# placement requests.
|
2176
2177
|
# @return [Boolean]
|
2177
2178
|
#
|
2178
2179
|
# @!attribute [rw] running_tasks_count
|
@@ -2202,8 +2203,8 @@ module Aws::ECS
|
|
2202
2203
|
# @return [Time]
|
2203
2204
|
#
|
2204
2205
|
# @!attribute [rw] attachments
|
2205
|
-
# The resources attached to a container instance, such as elastic
|
2206
|
-
# network
|
2206
|
+
# The resources attached to a container instance, such as an elastic
|
2207
|
+
# network interface.
|
2207
2208
|
# @return [Array<Types::Attachment>]
|
2208
2209
|
#
|
2209
2210
|
# @!attribute [rw] tags
|
@@ -2624,7 +2625,7 @@ module Aws::ECS
|
|
2624
2625
|
# @return [Array<Types::ClusterSetting>]
|
2625
2626
|
#
|
2626
2627
|
# @!attribute [rw] configuration
|
2627
|
-
# The execute command configuration for the cluster.
|
2628
|
+
# The `execute` command configuration for the cluster.
|
2628
2629
|
# @return [Types::ClusterConfiguration]
|
2629
2630
|
#
|
2630
2631
|
# @!attribute [rw] capacity_providers
|
@@ -2789,7 +2790,7 @@ module Aws::ECS
|
|
2789
2790
|
#
|
2790
2791
|
# @!attribute [rw] load_balancers
|
2791
2792
|
# A load balancer object representing the load balancers to use with
|
2792
|
-
# your service. For more information, see [Service
|
2793
|
+
# your service. For more information, see [Service load balancing][1]
|
2793
2794
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
2794
2795
|
#
|
2795
2796
|
# If the service uses the rolling update (`ECS`) deployment controller
|
@@ -3091,8 +3092,8 @@ module Aws::ECS
|
|
3091
3092
|
#
|
3092
3093
|
# @!attribute [rw] enable_ecs_managed_tags
|
3093
3094
|
# Specifies whether to turn on Amazon ECS managed tags for the tasks
|
3094
|
-
# within the service. For more information, see [Tagging
|
3095
|
-
# ECS
|
3095
|
+
# within the service. For more information, see [Tagging your Amazon
|
3096
|
+
# ECS resources][1] in the *Amazon Elastic Container Service Developer
|
3096
3097
|
# Guide*.
|
3097
3098
|
#
|
3098
3099
|
#
|
@@ -3101,12 +3102,10 @@ module Aws::ECS
|
|
3101
3102
|
# @return [Boolean]
|
3102
3103
|
#
|
3103
3104
|
# @!attribute [rw] propagate_tags
|
3104
|
-
# Specifies whether to propagate the tags from the task definition
|
3105
|
-
# the
|
3106
|
-
#
|
3107
|
-
#
|
3108
|
-
# task after service creation or task creation, use the TagResource
|
3109
|
-
# API action.
|
3105
|
+
# Specifies whether to propagate the tags from the task definition to
|
3106
|
+
# the task. If no value is specified, the tags aren't propagated.
|
3107
|
+
# Tags can only be propagated to the task during task creation. To add
|
3108
|
+
# tags to a task after task creation, use the TagResource API action.
|
3110
3109
|
# @return [String]
|
3111
3110
|
#
|
3112
3111
|
# @!attribute [rw] enable_execute_command
|
@@ -3256,7 +3255,7 @@ module Aws::ECS
|
|
3256
3255
|
#
|
3257
3256
|
# @!attribute [rw] service_registries
|
3258
3257
|
# The details of the service discovery registries to assign to this
|
3259
|
-
# task set. For more information, see [Service
|
3258
|
+
# task set. For more information, see [Service discovery][1].
|
3260
3259
|
#
|
3261
3260
|
#
|
3262
3261
|
#
|
@@ -3265,7 +3264,7 @@ module Aws::ECS
|
|
3265
3264
|
#
|
3266
3265
|
# @!attribute [rw] launch_type
|
3267
3266
|
# The launch type that new tasks in the task set uses. For more
|
3268
|
-
# information, see [Amazon ECS
|
3267
|
+
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
3269
3268
|
# Container Service Developer Guide*.
|
3270
3269
|
#
|
3271
3270
|
# If a `launchType` is specified, the `capacityProviderStrategy`
|
@@ -3882,54 +3881,83 @@ module Aws::ECS
|
|
3882
3881
|
#
|
3883
3882
|
# @!attribute [rw] maximum_percent
|
3884
3883
|
# If a service is using the rolling update (`ECS`) deployment type,
|
3885
|
-
# the
|
3886
|
-
# number of
|
3887
|
-
# `PENDING` state during a deployment, as a percentage of the
|
3888
|
-
#
|
3889
|
-
#
|
3890
|
-
#
|
3891
|
-
#
|
3892
|
-
#
|
3893
|
-
#
|
3894
|
-
#
|
3895
|
-
#
|
3896
|
-
#
|
3897
|
-
# If a service is using the blue/green (`CODE_DEPLOY`) or
|
3898
|
-
# deployment types and tasks that use the EC2 launch type,
|
3899
|
-
# **maximum percent** value is set to the default value and is
|
3900
|
-
# define the upper limit on the number of the tasks in the
|
3901
|
-
# that remain in the `RUNNING` state while the container
|
3902
|
-
# in the `DRAINING` state. If the tasks in the service
|
3903
|
-
# launch type, the maximum percent value is not used,
|
3904
|
-
# returned when describing your service.
|
3884
|
+
# the `maximumPercent` parameter represents an upper limit on the
|
3885
|
+
# number of your service's tasks that are allowed in the `RUNNING` or
|
3886
|
+
# `PENDING` state during a deployment, as a percentage of the
|
3887
|
+
# `desiredCount` (rounded down to the nearest integer). This parameter
|
3888
|
+
# enables you to define the deployment batch size. For example, if
|
3889
|
+
# your service is using the `REPLICA` service scheduler and has a
|
3890
|
+
# `desiredCount` of four tasks and a `maximumPercent` value of 200%,
|
3891
|
+
# the scheduler may start four new tasks before stopping the four
|
3892
|
+
# older tasks (provided that the cluster resources required to do this
|
3893
|
+
# are available). The default `maximumPercent` value for a service
|
3894
|
+
# using the `REPLICA` service scheduler is 200%.
|
3895
|
+
#
|
3896
|
+
# If a service is using either the blue/green (`CODE_DEPLOY`) or
|
3897
|
+
# `EXTERNAL` deployment types and tasks that use the EC2 launch type,
|
3898
|
+
# the **maximum percent** value is set to the default value and is
|
3899
|
+
# used to define the upper limit on the number of the tasks in the
|
3900
|
+
# service that remain in the `RUNNING` state while the container
|
3901
|
+
# instances are in the `DRAINING` state. If the tasks in the service
|
3902
|
+
# use the Fargate launch type, the maximum percent value is not used,
|
3903
|
+
# although it is returned when describing your service.
|
3905
3904
|
# @return [Integer]
|
3906
3905
|
#
|
3907
3906
|
# @!attribute [rw] minimum_healthy_percent
|
3908
3907
|
# If a service is using the rolling update (`ECS`) deployment type,
|
3909
|
-
# the
|
3910
|
-
#
|
3911
|
-
# during a deployment, as a percentage of the
|
3912
|
-
#
|
3913
|
-
# instances are in the `DRAINING` state if the service contains tasks
|
3914
|
-
# using the EC2 launch type. This parameter enables you to deploy
|
3908
|
+
# the `minimumHealthyPercent` represents a lower limit on the number
|
3909
|
+
# of your service's tasks that must remain in the `RUNNING` state
|
3910
|
+
# during a deployment, as a percentage of the `desiredCount` (rounded
|
3911
|
+
# up to the nearest integer). This parameter enables you to deploy
|
3915
3912
|
# without using additional cluster capacity. For example, if your
|
3916
|
-
# service has a
|
3917
|
-
#
|
3918
|
-
# cluster capacity before starting two new
|
3919
|
-
#
|
3920
|
-
#
|
3921
|
-
#
|
3922
|
-
#
|
3923
|
-
#
|
3924
|
-
#
|
3925
|
-
#
|
3926
|
-
#
|
3927
|
-
#
|
3928
|
-
#
|
3929
|
-
#
|
3930
|
-
#
|
3931
|
-
#
|
3932
|
-
#
|
3913
|
+
# service has a `desiredCount` of four tasks and a
|
3914
|
+
# `minimumHealthyPercent` of 50%, the service scheduler may stop two
|
3915
|
+
# existing tasks to free up cluster capacity before starting two new
|
3916
|
+
# tasks.
|
3917
|
+
#
|
3918
|
+
# For services that *do not* use a load balancer, the following should
|
3919
|
+
# be noted:
|
3920
|
+
#
|
3921
|
+
# * A service is considered healthy if all essential containers within
|
3922
|
+
# the tasks in the service pass their health checks.
|
3923
|
+
#
|
3924
|
+
# * If a task has no essential containers with a health check defined,
|
3925
|
+
# the service scheduler will wait for 40 seconds after a task
|
3926
|
+
# reaches a `RUNNING` state before the task is counted towards the
|
3927
|
+
# minimum healthy percent total.
|
3928
|
+
#
|
3929
|
+
# * If a task has one or more essential containers with a health check
|
3930
|
+
# defined, the service scheduler will wait for the task to reach a
|
3931
|
+
# healthy status before counting it towards the minimum healthy
|
3932
|
+
# percent total. A task is considered healthy when all essential
|
3933
|
+
# containers within the task have passed their health checks. The
|
3934
|
+
# amount of time the service scheduler can wait for is determined by
|
3935
|
+
# the container health check settings.
|
3936
|
+
#
|
3937
|
+
# For services are that *do* use a load balancer, the following should
|
3938
|
+
# be noted:
|
3939
|
+
#
|
3940
|
+
# * If a task has no essential containers with a health check defined,
|
3941
|
+
# the service scheduler will wait for the load balancer target group
|
3942
|
+
# health check to return a healthy status before counting the task
|
3943
|
+
# towards the minimum healthy percent total.
|
3944
|
+
#
|
3945
|
+
# * If a task has an essential container with a health check defined,
|
3946
|
+
# the service scheduler will wait for both the task to reach a
|
3947
|
+
# healthy status and the load balancer target group health check to
|
3948
|
+
# return a healthy status before counting the task towards the
|
3949
|
+
# minimum healthy percent total.
|
3950
|
+
#
|
3951
|
+
# If a service is using either the blue/green (`CODE_DEPLOY`) or
|
3952
|
+
# `EXTERNAL` deployment types and is running tasks that use the EC2
|
3953
|
+
# launch type, the **minimum healthy percent** value is set to the
|
3954
|
+
# default value and is used to define the lower limit on the number of
|
3955
|
+
# the tasks in the service that remain in the `RUNNING` state while
|
3956
|
+
# the container instances are in the `DRAINING` state. If a service is
|
3957
|
+
# using either the blue/green (`CODE_DEPLOY`) or `EXTERNAL` deployment
|
3958
|
+
# types and is running tasks that use the Fargate launch type, the
|
3959
|
+
# minimum healthy percent value is not used, although it is returned
|
3960
|
+
# when describing your service.
|
3933
3961
|
# @return [Integer]
|
3934
3962
|
#
|
3935
3963
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeploymentConfiguration AWS API Documentation
|
@@ -3943,7 +3971,7 @@ module Aws::ECS
|
|
3943
3971
|
end
|
3944
3972
|
|
3945
3973
|
# The deployment controller to use for the service. For more
|
3946
|
-
# information, see [Amazon ECS
|
3974
|
+
# information, see [Amazon ECS deployment types][1] in the *Amazon
|
3947
3975
|
# Elastic Container Service Developer Guide*.
|
3948
3976
|
#
|
3949
3977
|
#
|
@@ -4010,11 +4038,12 @@ module Aws::ECS
|
|
4010
4038
|
#
|
4011
4039
|
# @!attribute [rw] container_instance
|
4012
4040
|
# The container instance ID or full ARN of the container instance to
|
4013
|
-
# deregister.
|
4014
|
-
#
|
4015
|
-
#
|
4016
|
-
#
|
4017
|
-
#
|
4041
|
+
# deregister. For more information about the ARN format, see [Amazon
|
4042
|
+
# Resource Name (ARN)][1] in the *Amazon ECS Developer Guide*.
|
4043
|
+
#
|
4044
|
+
#
|
4045
|
+
#
|
4046
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids
|
4018
4047
|
# @return [String]
|
4019
4048
|
#
|
4020
4049
|
# @!attribute [rw] force
|
@@ -4580,12 +4609,13 @@ module Aws::ECS
|
|
4580
4609
|
# }
|
4581
4610
|
#
|
4582
4611
|
# @!attribute [rw] container_instance
|
4583
|
-
# The container instance ID or full ARN of the container instance.
|
4584
|
-
#
|
4585
|
-
#
|
4586
|
-
#
|
4587
|
-
#
|
4588
|
-
#
|
4612
|
+
# The container instance ID or full ARN of the container instance. For
|
4613
|
+
# more information about the ARN format, see [Amazon Resource Name
|
4614
|
+
# (ARN)][1] in the *Amazon ECS Developer Guide*.
|
4615
|
+
#
|
4616
|
+
#
|
4617
|
+
#
|
4618
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids
|
4589
4619
|
# @return [String]
|
4590
4620
|
#
|
4591
4621
|
# @!attribute [rw] cluster
|
@@ -4731,7 +4761,7 @@ module Aws::ECS
|
|
4731
4761
|
# will enforce the path set on the EFS access point. If an access
|
4732
4762
|
# point is used, transit encryption must be enabled in the
|
4733
4763
|
# `EFSVolumeConfiguration`. For more information, see [Working with
|
4734
|
-
# Amazon EFS
|
4764
|
+
# Amazon EFS access points][1] in the *Amazon Elastic File System User
|
4735
4765
|
# Guide*.
|
4736
4766
|
#
|
4737
4767
|
#
|
@@ -4745,7 +4775,7 @@ module Aws::ECS
|
|
4745
4775
|
# enabled, transit encryption must be enabled in the
|
4746
4776
|
# `EFSVolumeConfiguration`. If this parameter is omitted, the default
|
4747
4777
|
# value of `DISABLED` is used. For more information, see [Using Amazon
|
4748
|
-
# EFS
|
4778
|
+
# EFS access points][1] in the *Amazon Elastic Container Service
|
4749
4779
|
# Developer Guide*.
|
4750
4780
|
#
|
4751
4781
|
#
|
@@ -4764,7 +4794,7 @@ module Aws::ECS
|
|
4764
4794
|
|
4765
4795
|
# This parameter is specified when you're using an Amazon Elastic File
|
4766
4796
|
# System file system for task storage. For more information, see [Amazon
|
4767
|
-
# EFS
|
4797
|
+
# EFS volumes][1] in the *Amazon Elastic Container Service Developer
|
4768
4798
|
# Guide*.
|
4769
4799
|
#
|
4770
4800
|
#
|
@@ -4805,7 +4835,7 @@ module Aws::ECS
|
|
4805
4835
|
# between the Amazon ECS host and the Amazon EFS server. Transit
|
4806
4836
|
# encryption must be enabled if Amazon EFS IAM authorization is used.
|
4807
4837
|
# If this parameter is omitted, the default value of `DISABLED` is
|
4808
|
-
# used. For more information, see [Encrypting
|
4838
|
+
# used. For more information, see [Encrypting data in transit][1] in
|
4809
4839
|
# the *Amazon Elastic File System User Guide*.
|
4810
4840
|
#
|
4811
4841
|
#
|
@@ -4817,8 +4847,8 @@ module Aws::ECS
|
|
4817
4847
|
# The port to use when sending encrypted data between the Amazon ECS
|
4818
4848
|
# host and the Amazon EFS server. If you do not specify a transit
|
4819
4849
|
# encryption port, it will use the port selection strategy that the
|
4820
|
-
# Amazon EFS mount helper uses. For more information, see [EFS
|
4821
|
-
#
|
4850
|
+
# Amazon EFS mount helper uses. For more information, see [EFS mount
|
4851
|
+
# helper][1] in the *Amazon Elastic File System User Guide*.
|
4822
4852
|
#
|
4823
4853
|
#
|
4824
4854
|
#
|
@@ -5135,8 +5165,8 @@ module Aws::ECS
|
|
5135
5165
|
|
5136
5166
|
# The authorization configuration details for Amazon FSx for Windows
|
5137
5167
|
# File Server file system. See
|
5138
|
-
# [FSxWindowsFileServerVolumeConfiguration][1] in the *Amazon
|
5139
|
-
#
|
5168
|
+
# [FSxWindowsFileServerVolumeConfiguration][1] in the *Amazon ECS API
|
5169
|
+
# Reference*.
|
5140
5170
|
#
|
5141
5171
|
# For more information and the input format, see [Amazon FSx for Windows
|
5142
5172
|
# File Server Volumes][2] in the *Amazon Elastic Container Service
|
@@ -5159,7 +5189,7 @@ module Aws::ECS
|
|
5159
5189
|
# The authorization credential option to use. The authorization
|
5160
5190
|
# credential options can be provided using either the Amazon Resource
|
5161
5191
|
# Name (ARN) of an Secrets Manager secret or SSM Parameter Store
|
5162
|
-
# parameter. The
|
5192
|
+
# parameter. The ARN refers to the stored credentials.
|
5163
5193
|
# @return [String]
|
5164
5194
|
#
|
5165
5195
|
# @!attribute [rw] domain
|
@@ -5185,7 +5215,7 @@ module Aws::ECS
|
|
5185
5215
|
# File Server][1] file system for task storage.
|
5186
5216
|
#
|
5187
5217
|
# For more information and the input format, see [Amazon FSx for Windows
|
5188
|
-
# File Server
|
5218
|
+
# File Server volumes][2] in the *Amazon Elastic Container Service
|
5189
5219
|
# Developer Guide*.
|
5190
5220
|
#
|
5191
5221
|
#
|
@@ -5260,7 +5290,7 @@ module Aws::ECS
|
|
5260
5290
|
|
5261
5291
|
# The FireLens configuration for the container. This is used to specify
|
5262
5292
|
# and configure a log router for container logs. For more information,
|
5263
|
-
# see [Custom
|
5293
|
+
# see [Custom log routing][1] in the *Amazon Elastic Container Service
|
5264
5294
|
# Developer Guide*.
|
5265
5295
|
#
|
5266
5296
|
#
|
@@ -5289,8 +5319,8 @@ module Aws::ECS
|
|
5289
5319
|
# cluster, and container instance details to the log event. If
|
5290
5320
|
# specified, the syntax to use is
|
5291
5321
|
# `"options":\{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"\}`.
|
5292
|
-
# For more information, see [Creating a
|
5293
|
-
# FireLens
|
5322
|
+
# For more information, see [Creating a task definition that uses a
|
5323
|
+
# FireLens configuration][1] in the *Amazon Elastic Container Service
|
5294
5324
|
# Developer Guide*.
|
5295
5325
|
#
|
5296
5326
|
# <note markdown="1"> Tasks hosted on Fargate only support the `file` configuration file
|
@@ -5317,6 +5347,15 @@ module Aws::ECS
|
|
5317
5347
|
# Docker health checks that exist in the container image (such as those
|
5318
5348
|
# specified in a parent image or from the image's Dockerfile).
|
5319
5349
|
#
|
5350
|
+
# <note markdown="1"> The Amazon ECS container agent only monitors and reports on the health
|
5351
|
+
# checks specified in the task definition. Amazon ECS does not monitor
|
5352
|
+
# Docker health checks that are embedded in a container image and not
|
5353
|
+
# specified in the container definition. Health check parameters that
|
5354
|
+
# are specified in a container definition override any Docker health
|
5355
|
+
# checks that exist in the container image.
|
5356
|
+
#
|
5357
|
+
# </note>
|
5358
|
+
#
|
5320
5359
|
# You can view the health status of both individual containers and a
|
5321
5360
|
# task with the DescribeTasks API operation or when viewing the task
|
5322
5361
|
# details in the console.
|
@@ -5354,11 +5393,11 @@ module Aws::ECS
|
|
5354
5393
|
#
|
5355
5394
|
# * Container health checks require version 1.17.0 or greater of the
|
5356
5395
|
# Amazon ECS container agent. For more information, see [Updating the
|
5357
|
-
# Amazon ECS
|
5396
|
+
# Amazon ECS container agent][1].
|
5358
5397
|
#
|
5359
5398
|
# * Container health checks are supported for Fargate tasks if you're
|
5360
|
-
# using platform version 1.1.0 or greater. For more information, see
|
5361
|
-
# [Fargate
|
5399
|
+
# using platform version `1.1.0` or greater. For more information, see
|
5400
|
+
# [Fargate platform versions][2].
|
5362
5401
|
#
|
5363
5402
|
# * Container health checks aren't supported for tasks that are part of
|
5364
5403
|
# a service that's configured to use a Classic Load Balancer.
|
@@ -6676,7 +6715,7 @@ module Aws::ECS
|
|
6676
6715
|
# balancers with services and task sets, see the CreateService and
|
6677
6716
|
# CreateTaskSet actions.
|
6678
6717
|
#
|
6679
|
-
# When you add, update, or remove a load
|
6718
|
+
# When you add, update, or remove a load balancer configuration, Amazon
|
6680
6719
|
# ECS starts a new deployment with the updated Elastic Load Balancing
|
6681
6720
|
# configuration. This causes tasks to register to and deregister from
|
6682
6721
|
# load balancers.
|
@@ -6685,8 +6724,8 @@ module Aws::ECS
|
|
6685
6724
|
# update the Elastic Load Balancing configuration.
|
6686
6725
|
#
|
6687
6726
|
# A service-linked role is required for services that use multiple
|
6688
|
-
# target groups. For more information, see [
|
6689
|
-
# the *Amazon Elastic Container Service Developer Guide*.
|
6727
|
+
# target groups. For more information, see [Using service-linked
|
6728
|
+
# roles][1] in the *Amazon Elastic Container Service Developer Guide*.
|
6690
6729
|
#
|
6691
6730
|
#
|
6692
6731
|
#
|
@@ -6712,12 +6751,12 @@ module Aws::ECS
|
|
6712
6751
|
#
|
6713
6752
|
# For services using the `ECS` deployment controller, you can specify
|
6714
6753
|
# one or multiple target groups. For more information, see
|
6715
|
-
# [Registering
|
6754
|
+
# [Registering multiple target groups with a service][1] in the
|
6716
6755
|
# *Amazon Elastic Container Service Developer Guide*.
|
6717
6756
|
#
|
6718
6757
|
# For services using the `CODE_DEPLOY` deployment controller, you're
|
6719
6758
|
# required to define two target groups for the load balancer. For more
|
6720
|
-
# information, see [Blue/
|
6759
|
+
# information, see [Blue/green deployment with CodeDeploy][2] in the
|
6721
6760
|
# *Amazon Elastic Container Service Developer Guide*.
|
6722
6761
|
#
|
6723
6762
|
# If your service's task definition uses the `awsvpc` network mode,
|
@@ -6871,7 +6910,7 @@ module Aws::ECS
|
|
6871
6910
|
#
|
6872
6911
|
# @!attribute [rw] secret_options
|
6873
6912
|
# The secrets to pass to the log configuration. For more information,
|
6874
|
-
# see [Specifying
|
6913
|
+
# see [Specifying sensitive data][1] in the *Amazon Elastic Container
|
6875
6914
|
# Service Developer Guide*.
|
6876
6915
|
#
|
6877
6916
|
#
|
@@ -6966,7 +7005,7 @@ module Aws::ECS
|
|
6966
7005
|
# scale-out actions of the Auto Scaling group. Amazon ECS manages a
|
6967
7006
|
# target tracking scaling policy using an Amazon ECS managed CloudWatch
|
6968
7007
|
# metric with the specified `targetCapacity` value as the target value
|
6969
|
-
# for the metric. For more information, see [Using
|
7008
|
+
# for the metric. For more information, see [Using managed scaling][1]
|
6970
7009
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
6971
7010
|
#
|
6972
7011
|
# If managed scaling is disabled, the user must manage the scaling of
|
@@ -7185,7 +7224,7 @@ module Aws::ECS
|
|
7185
7224
|
class NoUpdateAvailableException < Aws::EmptyStructure; end
|
7186
7225
|
|
7187
7226
|
# An object representing a constraint on task placement. For more
|
7188
|
-
# information, see [Task
|
7227
|
+
# information, see [Task placement constraints][1] in the *Amazon
|
7189
7228
|
# Elastic Container Service Developer Guide*.
|
7190
7229
|
#
|
7191
7230
|
# <note markdown="1"> If you're using the Fargate launch type, task placement constraints
|
@@ -7234,7 +7273,7 @@ module Aws::ECS
|
|
7234
7273
|
end
|
7235
7274
|
|
7236
7275
|
# The task placement strategy for a task or service. For more
|
7237
|
-
# information, see [Task
|
7276
|
+
# information, see [Task placement strategies][1] in the *Amazon Elastic
|
7238
7277
|
# Container Service Developer Guide*.
|
7239
7278
|
#
|
7240
7279
|
#
|
@@ -8772,6 +8811,9 @@ module Aws::ECS
|
|
8772
8811
|
# Determines whether to use the execute command functionality for the
|
8773
8812
|
# containers in this task. If `true`, this enables execute command
|
8774
8813
|
# functionality on all containers in the task.
|
8814
|
+
#
|
8815
|
+
# If `true`, then the task definition must have a task role, or you
|
8816
|
+
# must provide one as an override.
|
8775
8817
|
# @return [Boolean]
|
8776
8818
|
#
|
8777
8819
|
# @!attribute [rw] group
|
@@ -8928,12 +8970,32 @@ module Aws::ECS
|
|
8928
8970
|
# task definition to run. If a `revision` isn't specified, the latest
|
8929
8971
|
# `ACTIVE` revision is used.
|
8930
8972
|
#
|
8973
|
+
# When you create an IAM policy for run-task, you can set the resource
|
8974
|
+
# to be the latest task definition revision, or a specific revision.
|
8975
|
+
#
|
8931
8976
|
# The full ARN value must match the value that you specified as the
|
8932
|
-
# `Resource` of the IAM principal's permissions policy.
|
8933
|
-
#
|
8934
|
-
#
|
8935
|
-
# the `
|
8977
|
+
# `Resource` of the IAM principal's permissions policy.
|
8978
|
+
#
|
8979
|
+
# When you specify the policy resource as the latest task definition
|
8980
|
+
# version (by setting the `Resource` in the policy to
|
8981
|
+
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName`),
|
8982
|
+
# then set this value to
|
8936
8983
|
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName`.
|
8984
|
+
#
|
8985
|
+
# When you specify the policy resource as a specific task definition
|
8986
|
+
# version (by setting the `Resource` in the policy to
|
8987
|
+
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1`
|
8988
|
+
# or
|
8989
|
+
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*`),
|
8990
|
+
# then set this value to
|
8991
|
+
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1`.
|
8992
|
+
#
|
8993
|
+
# For more information, see [Policy Resources for Amazon ECS][1] in
|
8994
|
+
# the Amazon Elastic Container Service developer Guide.
|
8995
|
+
#
|
8996
|
+
#
|
8997
|
+
#
|
8998
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-resources
|
8937
8999
|
# @return [String]
|
8938
9000
|
#
|
8939
9001
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RunTaskRequest AWS API Documentation
|
@@ -9001,7 +9063,7 @@ module Aws::ECS
|
|
9001
9063
|
#
|
9002
9064
|
# You can run your Linux tasks on an ARM-based platform by setting the
|
9003
9065
|
# value to `ARM64`. This option is avaiable for tasks that run on
|
9004
|
-
#
|
9066
|
+
# Linux Amazon EC2 instance or Linux containers on Fargate.
|
9005
9067
|
# @return [String]
|
9006
9068
|
#
|
9007
9069
|
# @!attribute [rw] operating_system_family
|
@@ -9056,7 +9118,7 @@ module Aws::ECS
|
|
9056
9118
|
# * To reference sensitive information in the log configuration of a
|
9057
9119
|
# container, use the `secretOptions` container definition parameter.
|
9058
9120
|
#
|
9059
|
-
# For more information, see [Specifying
|
9121
|
+
# For more information, see [Specifying sensitive data][1] in the
|
9060
9122
|
# *Amazon Elastic Container Service Developer Guide*.
|
9061
9123
|
#
|
9062
9124
|
#
|
@@ -9124,11 +9186,13 @@ module Aws::ECS
|
|
9124
9186
|
# Details on a service within a cluster
|
9125
9187
|
#
|
9126
9188
|
# @!attribute [rw] service_arn
|
9127
|
-
# The ARN that identifies the service.
|
9128
|
-
#
|
9129
|
-
#
|
9130
|
-
#
|
9131
|
-
#
|
9189
|
+
# The ARN that identifies the service. For more information about the
|
9190
|
+
# ARN format, see [Amazon Resource Name (ARN)][1] in the *Amazon ECS
|
9191
|
+
# Developer Guide*.
|
9192
|
+
#
|
9193
|
+
#
|
9194
|
+
#
|
9195
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids
|
9132
9196
|
# @return [String]
|
9133
9197
|
#
|
9134
9198
|
# @!attribute [rw] service_name
|
@@ -10252,8 +10316,23 @@ module Aws::ECS
|
|
10252
10316
|
#
|
10253
10317
|
class TagResourceResponse < Aws::EmptyStructure; end
|
10254
10318
|
|
10255
|
-
# The
|
10256
|
-
#
|
10319
|
+
# The execute command cannot run. This error can be caused by any of the
|
10320
|
+
# following configuration issues:
|
10321
|
+
#
|
10322
|
+
# * Incorrect IAM permissions
|
10323
|
+
#
|
10324
|
+
# * The SSM agent is not installed or is not running
|
10325
|
+
#
|
10326
|
+
# * There is an interface Amazon VPC endpoint for Amazon ECS, but there
|
10327
|
+
# is not one for for Systems Manager Session Manager
|
10328
|
+
#
|
10329
|
+
# For information about how to troubleshoot the issues, see
|
10330
|
+
# [Troubleshooting issues with ECS Exec][1] in the *Amazon Elastic
|
10331
|
+
# Container Service Developer Guide*.
|
10332
|
+
#
|
10333
|
+
#
|
10334
|
+
#
|
10335
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html
|
10257
10336
|
#
|
10258
10337
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TargetNotConnectedException AWS API Documentation
|
10259
10338
|
#
|
@@ -12062,7 +12141,31 @@ module Aws::ECS
|
|
12062
12141
|
# configuration, and then stops the old tasks when the new tasks are
|
12063
12142
|
# running.
|
12064
12143
|
#
|
12144
|
+
# For services that use rolling updates, you can add, update, or
|
12145
|
+
# remove Elastic Load Balancing target groups. You can update from a
|
12146
|
+
# single target group to multiple target groups and from multiple
|
12147
|
+
# target groups to a single target group.
|
12148
|
+
#
|
12149
|
+
# For services that use blue/green deployments, you can update Elastic
|
12150
|
+
# Load Balancing target groups by using ` CreateDeployment ` through
|
12151
|
+
# CodeDeploy. Note that multiple target groups are not supported for
|
12152
|
+
# blue/green deployments. For more information see [Register multiple
|
12153
|
+
# target groups with a service][1] in the *Amazon Elastic Container
|
12154
|
+
# Service Developer Guide*.
|
12155
|
+
#
|
12156
|
+
# For services that use the external deployment controller, you can
|
12157
|
+
# add, update, or remove load balancers by using [CreateTaskSet][2].
|
12158
|
+
# Note that multiple target groups are not supported for external
|
12159
|
+
# deployments. For more information see [Register multiple target
|
12160
|
+
# groups with a service][1] in the *Amazon Elastic Container Service
|
12161
|
+
# Developer Guide*.
|
12162
|
+
#
|
12065
12163
|
# You can remove existing `loadBalancers` by passing an empty list.
|
12164
|
+
#
|
12165
|
+
#
|
12166
|
+
#
|
12167
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html
|
12168
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html
|
12066
12169
|
# @return [Array<Types::LoadBalancer>]
|
12067
12170
|
#
|
12068
12171
|
# @!attribute [rw] propagate_tags
|
data/lib/aws-sdk-ecs.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-ecs
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.100.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-06-21 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|