aws-sdk-ecs 1.96.0 → 1.99.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 +187 -52
- data/lib/aws-sdk-ecs/client_api.rb +4 -0
- data/lib/aws-sdk-ecs/types.rb +278 -82
- 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: e16d5368ec5a0127b3f337f2e935d9ce1a7e327926777a8d45faff0fe8f33e9e
|
4
|
+
data.tar.gz: 66aec1d4a433701f7fc74995ad523a8b1afe54507844b495e5aa4c7f3312406b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 37790820c3e93c9ea722ea4c16fca49bba8c556021429edc4d83763c2abf5c697793fd24bfb4cd71700177f0535687851af3347daa2828343372b2c83fff08f7
|
7
|
+
data.tar.gz: cdada09a968a4763ad6f1b7703d454e1b7c79dd9403dc9129a923c1213bd8470e227080ab48ad5cb493440b5fed9c82c87b5b8eea6904ff52d92021de810e1bb
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.99.0 (2022-03-22)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Documentation only update to address tickets
|
8
|
+
|
9
|
+
1.98.0 (2022-03-15)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Documentation only update to address tickets
|
13
|
+
|
14
|
+
1.97.0 (2022-03-07)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Amazon ECS UpdateService API now supports additional parameters: loadBalancers, propagateTags, enableECSManagedTags, and serviceRegistries
|
18
|
+
|
4
19
|
1.96.0 (2022-02-24)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.99.0
|
data/lib/aws-sdk-ecs/client.rb
CHANGED
@@ -521,12 +521,12 @@ module Aws::ECS
|
|
521
521
|
#
|
522
522
|
# @option params [Array<Types::ClusterSetting>] :settings
|
523
523
|
# The setting to use when creating a cluster. This parameter is used to
|
524
|
-
#
|
524
|
+
# turn on CloudWatch Container Insights for a cluster. If this value is
|
525
525
|
# specified, it overrides the `containerInsights` value set with
|
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
|
@@ -690,8 +690,7 @@ module Aws::ECS
|
|
690
690
|
# Tasks for services that don't use a load balancer are considered
|
691
691
|
# healthy if they're in the `RUNNING` state. Tasks for services that
|
692
692
|
# use a load balancer are considered healthy if they're in the
|
693
|
-
# `RUNNING` state and
|
694
|
-
# reported as healthy by the load balancer.
|
693
|
+
# `RUNNING` state and are reported as healthy by the load balancer.
|
695
694
|
#
|
696
695
|
# There are two service scheduler strategies available:
|
697
696
|
#
|
@@ -844,11 +843,8 @@ module Aws::ECS
|
|
844
843
|
# listener that you can use to perform validation tests with Lambda
|
845
844
|
# functions before routing production traffic to it.
|
846
845
|
#
|
847
|
-
#
|
848
|
-
#
|
849
|
-
# port that's specified in the service definition are immutable. If you
|
850
|
-
# use the `CODE_DEPLOY` deployment controller, these values can be
|
851
|
-
# changed when updating the service.
|
846
|
+
# If you use the `CODE_DEPLOY` deployment controller, these values can
|
847
|
+
# be changed when updating the service.
|
852
848
|
#
|
853
849
|
# For Application Load Balancers and Network Load Balancers, this object
|
854
850
|
# must contain the load balancer target group ARN, the container name,
|
@@ -1020,6 +1016,10 @@ module Aws::ECS
|
|
1020
1016
|
# defined and you don't specify a health check grace period value, the
|
1021
1017
|
# default value of `0` is used.
|
1022
1018
|
#
|
1019
|
+
# If you do not use an Elastic Load Balancing, we recomend that you use
|
1020
|
+
# the `startPeriod` in the task definition healtch check parameters. For
|
1021
|
+
# more information, see [Health check][1].
|
1022
|
+
#
|
1023
1023
|
# If your service's tasks take a while to start and respond to Elastic
|
1024
1024
|
# Load Balancing health checks, you can specify a health check grace
|
1025
1025
|
# period of up to 2,147,483,647 seconds (about 69 years). During that
|
@@ -1027,6 +1027,10 @@ module Aws::ECS
|
|
1027
1027
|
# This grace period can prevent the service scheduler from marking tasks
|
1028
1028
|
# as unhealthy and stopping them before they have time to come up.
|
1029
1029
|
#
|
1030
|
+
#
|
1031
|
+
#
|
1032
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html
|
1033
|
+
#
|
1030
1034
|
# @option params [String] :scheduling_strategy
|
1031
1035
|
# The scheduling strategy to use for the service. For more information,
|
1032
1036
|
# see [Services][1].
|
@@ -1095,7 +1099,7 @@ module Aws::ECS
|
|
1095
1099
|
# your tags per resource limit.
|
1096
1100
|
#
|
1097
1101
|
# @option params [Boolean] :enable_ecs_managed_tags
|
1098
|
-
# Specifies whether to
|
1102
|
+
# Specifies whether to turn on Amazon ECS managed tags for the tasks
|
1099
1103
|
# within the service. For more information, see [Tagging Your Amazon ECS
|
1100
1104
|
# Resources][1] in the *Amazon Elastic Container Service Developer
|
1101
1105
|
# Guide*.
|
@@ -1105,12 +1109,10 @@ module Aws::ECS
|
|
1105
1109
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
1106
1110
|
#
|
1107
1111
|
# @option params [String] :propagate_tags
|
1108
|
-
# Specifies whether to propagate the tags from the task definition
|
1109
|
-
# the
|
1110
|
-
#
|
1111
|
-
#
|
1112
|
-
# after service creation or task creation, use the TagResource API
|
1113
|
-
# 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.
|
1114
1116
|
#
|
1115
1117
|
# @option params [Boolean] :enable_execute_command
|
1116
1118
|
# Determines whether the execute command functionality is enabled for
|
@@ -1312,7 +1314,7 @@ module Aws::ECS
|
|
1312
1314
|
# },
|
1313
1315
|
# ],
|
1314
1316
|
# enable_ecs_managed_tags: false,
|
1315
|
-
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE
|
1317
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
|
1316
1318
|
# enable_execute_command: false,
|
1317
1319
|
# })
|
1318
1320
|
#
|
@@ -1439,7 +1441,7 @@ module Aws::ECS
|
|
1439
1441
|
# resp.service.tags[0].value #=> String
|
1440
1442
|
# resp.service.created_by #=> String
|
1441
1443
|
# resp.service.enable_ecs_managed_tags #=> Boolean
|
1442
|
-
# resp.service.propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE"
|
1444
|
+
# resp.service.propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
|
1443
1445
|
# resp.service.enable_execute_command #=> Boolean
|
1444
1446
|
#
|
1445
1447
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateService AWS API Documentation
|
@@ -2162,7 +2164,7 @@ module Aws::ECS
|
|
2162
2164
|
# resp.service.tags[0].value #=> String
|
2163
2165
|
# resp.service.created_by #=> String
|
2164
2166
|
# resp.service.enable_ecs_managed_tags #=> Boolean
|
2165
|
-
# resp.service.propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE"
|
2167
|
+
# resp.service.propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
|
2166
2168
|
# resp.service.enable_execute_command #=> Boolean
|
2167
2169
|
#
|
2168
2170
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteService AWS API Documentation
|
@@ -3213,7 +3215,7 @@ module Aws::ECS
|
|
3213
3215
|
# resp.services[0].tags[0].value #=> String
|
3214
3216
|
# resp.services[0].created_by #=> String
|
3215
3217
|
# resp.services[0].enable_ecs_managed_tags #=> Boolean
|
3216
|
-
# resp.services[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE"
|
3218
|
+
# resp.services[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
|
3217
3219
|
# resp.services[0].enable_execute_command #=> Boolean
|
3218
3220
|
# resp.failures #=> Array
|
3219
3221
|
# resp.failures[0].arn #=> String
|
@@ -4839,8 +4841,8 @@ module Aws::ECS
|
|
4839
4841
|
# opt-in and opt-out account setting must be set for each Amazon ECS
|
4840
4842
|
# resource separately. The ARN and resource ID format of a resource is
|
4841
4843
|
# defined by the opt-in status of the IAM user or role that created the
|
4842
|
-
# resource. You must
|
4843
|
-
# as resource tagging.
|
4844
|
+
# resource. You must turn on this setting to use Amazon ECS features
|
4845
|
+
# such as resource tagging.
|
4844
4846
|
#
|
4845
4847
|
# When `awsvpcTrunking` is specified, the elastic network interface
|
4846
4848
|
# (ENI) limit for any new container instances that support the feature
|
@@ -5694,7 +5696,7 @@ module Aws::ECS
|
|
5694
5696
|
#
|
5695
5697
|
# For tasks hosted on Amazon EC2 instances, the container instances
|
5696
5698
|
# require at least version `1.26.0` of the container agent and at least
|
5697
|
-
# version `1.26.0-1` of the `ecs-init` package to
|
5699
|
+
# version `1.26.0-1` of the `ecs-init` package to use a proxy
|
5698
5700
|
# configuration. If your container instances are launched from the
|
5699
5701
|
# Amazon ECS-optimized AMI version `20190301` or later, then they
|
5700
5702
|
# contain the required versions of the container agent and `ecs-init`.
|
@@ -6267,7 +6269,7 @@ module Aws::ECS
|
|
6267
6269
|
# cluster. You can specify up to 10 tasks for each call.
|
6268
6270
|
#
|
6269
6271
|
# @option params [Boolean] :enable_ecs_managed_tags
|
6270
|
-
# Specifies whether to
|
6272
|
+
# Specifies whether to use Amazon ECS managed tags for the task. For
|
6271
6273
|
# more information, see [Tagging Your Amazon ECS Resources][1] in the
|
6272
6274
|
# *Amazon Elastic Container Service Developer Guide*.
|
6273
6275
|
#
|
@@ -6276,10 +6278,13 @@ module Aws::ECS
|
|
6276
6278
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
6277
6279
|
#
|
6278
6280
|
# @option params [Boolean] :enable_execute_command
|
6279
|
-
# Determines whether to
|
6281
|
+
# Determines whether to use the execute command functionality for the
|
6280
6282
|
# containers in this task. If `true`, this enables execute command
|
6281
6283
|
# functionality on all containers in the task.
|
6282
6284
|
#
|
6285
|
+
# If `true`, then the task definition must have a task role, or you must
|
6286
|
+
# provide one as an override.
|
6287
|
+
#
|
6283
6288
|
# @option params [String] :group
|
6284
6289
|
# The name of the task group to associate with the task. The default
|
6285
6290
|
# value is the family name of the task definition (for example,
|
@@ -6423,13 +6428,33 @@ module Aws::ECS
|
|
6423
6428
|
# task definition to run. If a `revision` isn't specified, the latest
|
6424
6429
|
# `ACTIVE` revision is used.
|
6425
6430
|
#
|
6431
|
+
# When you create an IAM policy for run-task, you can set the resource
|
6432
|
+
# to be the latest task definition revision, or a specific revision.
|
6433
|
+
#
|
6426
6434
|
# The full ARN value must match the value that you specified as the
|
6427
|
-
# `Resource` of the IAM principal's permissions policy.
|
6428
|
-
#
|
6429
|
-
#
|
6430
|
-
# the `
|
6435
|
+
# `Resource` of the IAM principal's permissions policy.
|
6436
|
+
#
|
6437
|
+
# When you specify the policy resource as the latest task definition
|
6438
|
+
# version (by setting the `Resource` in the policy to
|
6439
|
+
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName`),
|
6440
|
+
# then set this value to
|
6431
6441
|
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName`.
|
6432
6442
|
#
|
6443
|
+
# When you specify the policy resource as a specific task definition
|
6444
|
+
# version (by setting the `Resource` in the policy to
|
6445
|
+
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1`
|
6446
|
+
# or
|
6447
|
+
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*`),
|
6448
|
+
# then set this value to
|
6449
|
+
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1`.
|
6450
|
+
#
|
6451
|
+
# For more information, see [Policy Resources for Amazon ECS][1] in the
|
6452
|
+
# Amazon Elastic Container Service developer Guide.
|
6453
|
+
#
|
6454
|
+
#
|
6455
|
+
#
|
6456
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-resources
|
6457
|
+
#
|
6433
6458
|
# @return [Types::RunTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6434
6459
|
#
|
6435
6460
|
# * {Types::RunTaskResponse#tasks #tasks} => Array<Types::Task>
|
@@ -6551,7 +6576,7 @@ module Aws::ECS
|
|
6551
6576
|
# },
|
6552
6577
|
# ],
|
6553
6578
|
# platform_version: "String",
|
6554
|
-
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE
|
6579
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
|
6555
6580
|
# reference_id: "String",
|
6556
6581
|
# started_by: "String",
|
6557
6582
|
# tags: [
|
@@ -6704,7 +6729,7 @@ module Aws::ECS
|
|
6704
6729
|
# to 10 container instances.
|
6705
6730
|
#
|
6706
6731
|
# @option params [Boolean] :enable_ecs_managed_tags
|
6707
|
-
# Specifies whether to
|
6732
|
+
# Specifies whether to use Amazon ECS managed tags for the task. For
|
6708
6733
|
# more information, see [Tagging Your Amazon ECS Resources][1] in the
|
6709
6734
|
# *Amazon Elastic Container Service Developer Guide*.
|
6710
6735
|
#
|
@@ -6859,7 +6884,7 @@ module Aws::ECS
|
|
6859
6884
|
# size_in_gi_b: 1, # required
|
6860
6885
|
# },
|
6861
6886
|
# },
|
6862
|
-
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE
|
6887
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
|
6863
6888
|
# reference_id: "String",
|
6864
6889
|
# started_by: "String",
|
6865
6890
|
# tags: [
|
@@ -7640,7 +7665,7 @@ module Aws::ECS
|
|
7640
7665
|
#
|
7641
7666
|
# @option params [required, Array<Types::ClusterSetting>] :settings
|
7642
7667
|
# The setting to use by default for a cluster. This parameter is used to
|
7643
|
-
#
|
7668
|
+
# turn on CloudWatch Container Insights for a cluster. If this value is
|
7644
7669
|
# specified, it overrides the `containerInsights` value set with
|
7645
7670
|
# PutAccountSetting or PutAccountSettingDefault.
|
7646
7671
|
#
|
@@ -7853,8 +7878,7 @@ module Aws::ECS
|
|
7853
7878
|
# services that do not use a load balancer are considered healthy if
|
7854
7879
|
# they're in the `RUNNING` state. Tasks for services that use a load
|
7855
7880
|
# balancer are considered healthy if they're in the `RUNNING` state
|
7856
|
-
# and
|
7857
|
-
# by the load balancer.
|
7881
|
+
# and are reported as healthy by the load balancer.
|
7858
7882
|
#
|
7859
7883
|
# * The `maximumPercent` parameter represents an upper limit on the
|
7860
7884
|
# number of running tasks during task replacement. You can use this to
|
@@ -7982,24 +8006,28 @@ module Aws::ECS
|
|
7982
8006
|
#
|
7983
8007
|
# Modifies the parameters of a service.
|
7984
8008
|
#
|
7985
|
-
# For services using the rolling update (`ECS`)
|
7986
|
-
#
|
7987
|
-
#
|
7988
|
-
#
|
8009
|
+
# For services using the rolling update (`ECS`) you can update the
|
8010
|
+
# desired count, deployment configuration, network configuration, load
|
8011
|
+
# balancers, service registries, enable ECS managed tags option,
|
8012
|
+
# propagate tags option, task placement constraints and strategies, and
|
8013
|
+
# task definition. When you update any of these parameters, Amazon ECS
|
8014
|
+
# starts new tasks with the new configuration.
|
7989
8015
|
#
|
7990
8016
|
# For services using the blue/green (`CODE_DEPLOY`) deployment
|
7991
|
-
# controller, only the desired count, deployment configuration,
|
7992
|
-
# placement constraints and strategies,
|
7993
|
-
#
|
7994
|
-
#
|
7995
|
-
#
|
7996
|
-
#
|
8017
|
+
# controller, only the desired count, deployment configuration, health
|
8018
|
+
# check grace period, task placement constraints and strategies, enable
|
8019
|
+
# ECS managed tags option, and propagate tags can be updated using this
|
8020
|
+
# API. If the network configuration, platform version, task definition,
|
8021
|
+
# or load balancer need to be updated, create a new CodeDeploy
|
8022
|
+
# deployment. For more information, see [CreateDeployment][2] in the
|
8023
|
+
# *CodeDeploy API Reference*.
|
7997
8024
|
#
|
7998
8025
|
# For services using an external deployment controller, you can update
|
7999
|
-
# only the desired count, task placement constraints and strategies,
|
8000
|
-
# health check grace period
|
8026
|
+
# only the desired count, task placement constraints and strategies,
|
8027
|
+
# health check grace period, enable ECS managed tags option, and
|
8028
|
+
# propagate tags option, using this API. If the launch type, load
|
8001
8029
|
# balancer, network configuration, platform version, or task definition
|
8002
|
-
# need to be updated, create a new task set
|
8030
|
+
# need to be updated, create a new task set For more information, see
|
8003
8031
|
# CreateTaskSet.
|
8004
8032
|
#
|
8005
8033
|
# You can add to or subtract from the number of instantiations of a task
|
@@ -8035,8 +8063,7 @@ module Aws::ECS
|
|
8035
8063
|
# services that don't use a load balancer are considered healthy if
|
8036
8064
|
# they're in the `RUNNING` state. Tasks for services that use a load
|
8037
8065
|
# balancer are considered healthy if they're in the `RUNNING` state
|
8038
|
-
# and
|
8039
|
-
# by the load balancer.
|
8066
|
+
# and are reported as healthy by the load balancer.
|
8040
8067
|
#
|
8041
8068
|
# * The `maximumPercent` parameter represents an upper limit on the
|
8042
8069
|
# number of running tasks during a deployment. You can use it to
|
@@ -8088,10 +8115,25 @@ module Aws::ECS
|
|
8088
8115
|
# Zone (based on the previous steps), favoring container instances
|
8089
8116
|
# with the largest number of running tasks for this service.
|
8090
8117
|
#
|
8118
|
+
# <note markdown="1"> You must have a service-linked role when you update any of the
|
8119
|
+
# following service properties. If you specified a custom IAM role when
|
8120
|
+
# you created the service, Amazon ECS automatically replaces the
|
8121
|
+
# [roleARN][3] associated with the service with the ARN of your
|
8122
|
+
# service-linked role. For more information, see [Service-linked
|
8123
|
+
# roles][4] in the *Amazon Elastic Container Service Developer Guide*.
|
8124
|
+
#
|
8125
|
+
# * `loadBalancers,`
|
8126
|
+
#
|
8127
|
+
# * `serviceRegistries`
|
8128
|
+
#
|
8129
|
+
# </note>
|
8130
|
+
#
|
8091
8131
|
#
|
8092
8132
|
#
|
8093
8133
|
# [1]: https://aws.amazon.com/service-terms
|
8094
8134
|
# [2]: https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html
|
8135
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Service.html#ECS-Type-Service-roleArn
|
8136
|
+
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html
|
8095
8137
|
#
|
8096
8138
|
# @option params [String] :cluster
|
8097
8139
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
@@ -8208,6 +8250,81 @@ module Aws::ECS
|
|
8208
8250
|
# If you do not want to override the value that was set when the service
|
8209
8251
|
# was created, you can set this to `null` when performing this action.
|
8210
8252
|
#
|
8253
|
+
# @option params [Boolean] :enable_ecs_managed_tags
|
8254
|
+
# Determines whether to turn on Amazon ECS managed tags for the tasks in
|
8255
|
+
# the service. For more information, see [Tagging Your Amazon ECS
|
8256
|
+
# Resources][1] in the *Amazon Elastic Container Service Developer
|
8257
|
+
# Guide*.
|
8258
|
+
#
|
8259
|
+
# Only tasks launched after the update will reflect the update. To
|
8260
|
+
# update the tags on all tasks, set `forceNewDeployment` to `true`, so
|
8261
|
+
# that Amazon ECS starts new tasks with the updated tags.
|
8262
|
+
#
|
8263
|
+
#
|
8264
|
+
#
|
8265
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
8266
|
+
#
|
8267
|
+
# @option params [Array<Types::LoadBalancer>] :load_balancers
|
8268
|
+
# A list of Elastic Load Balancing load balancer objects. It contains
|
8269
|
+
# the load balancer name, the container name, and the container port to
|
8270
|
+
# access from the load balancer. The container name is as it appears in
|
8271
|
+
# a container definition.
|
8272
|
+
#
|
8273
|
+
# When you add, update, or remove a load balancer configuration, Amazon
|
8274
|
+
# ECS starts new tasks with the updated Elastic Load Balancing
|
8275
|
+
# configuration, and then stops the old tasks when the new tasks are
|
8276
|
+
# running.
|
8277
|
+
#
|
8278
|
+
# For services that use rolling updates, you can add, update, or remove
|
8279
|
+
# Elastic Load Balancing target groups. You can update from a single
|
8280
|
+
# target group to multiple target groups and from multiple target groups
|
8281
|
+
# to a single target group.
|
8282
|
+
#
|
8283
|
+
# For services that use blue/green deployments, you can update Elastic
|
8284
|
+
# Load Balancing target groups by using ` CreateDeployment ` through
|
8285
|
+
# CodeDeploy. Note that multiple target groups are not supported for
|
8286
|
+
# blue/green deployments. For more information see [Register multiple
|
8287
|
+
# target groups with a service][1] in the *Amazon Elastic Container
|
8288
|
+
# Service Developer Guide*.
|
8289
|
+
#
|
8290
|
+
# For services that use the external deployment controller, you can add,
|
8291
|
+
# update, or remove load balancers by using [CreateTaskSet][2]. Note
|
8292
|
+
# that multiple target groups are not supported for external
|
8293
|
+
# deployments. For more information see [Register multiple target groups
|
8294
|
+
# with a service][1] in the *Amazon Elastic Container Service Developer
|
8295
|
+
# Guide*.
|
8296
|
+
#
|
8297
|
+
# You can remove existing `loadBalancers` by passing an empty list.
|
8298
|
+
#
|
8299
|
+
#
|
8300
|
+
#
|
8301
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html
|
8302
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html
|
8303
|
+
#
|
8304
|
+
# @option params [String] :propagate_tags
|
8305
|
+
# Determines whether to propagate the tags from the task definition or
|
8306
|
+
# the service to the task. If no value is specified, the tags aren't
|
8307
|
+
# propagated.
|
8308
|
+
#
|
8309
|
+
# Only tasks launched after the update will reflect the update. To
|
8310
|
+
# update the tags on all tasks, set `forceNewDeployment` to `true`, so
|
8311
|
+
# that Amazon ECS starts new tasks with the updated tags.
|
8312
|
+
#
|
8313
|
+
# @option params [Array<Types::ServiceRegistry>] :service_registries
|
8314
|
+
# The details for the service discovery registries to assign to this
|
8315
|
+
# service. For more information, see [Service Discovery][1].
|
8316
|
+
#
|
8317
|
+
# When you add, update, or remove the service registries configuration,
|
8318
|
+
# Amazon ECS starts new tasks with the updated service registries
|
8319
|
+
# configuration, and then stops the old tasks when the new tasks are
|
8320
|
+
# running.
|
8321
|
+
#
|
8322
|
+
# You can remove existing `serviceRegistries` by passing an empty list.
|
8323
|
+
#
|
8324
|
+
#
|
8325
|
+
#
|
8326
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html
|
8327
|
+
#
|
8211
8328
|
# @return [Types::UpdateServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8212
8329
|
#
|
8213
8330
|
# * {Types::UpdateServiceResponse#service #service} => Types::Service
|
@@ -8284,6 +8401,24 @@ module Aws::ECS
|
|
8284
8401
|
# force_new_deployment: false,
|
8285
8402
|
# health_check_grace_period_seconds: 1,
|
8286
8403
|
# enable_execute_command: false,
|
8404
|
+
# enable_ecs_managed_tags: false,
|
8405
|
+
# load_balancers: [
|
8406
|
+
# {
|
8407
|
+
# target_group_arn: "String",
|
8408
|
+
# load_balancer_name: "String",
|
8409
|
+
# container_name: "String",
|
8410
|
+
# container_port: 1,
|
8411
|
+
# },
|
8412
|
+
# ],
|
8413
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
|
8414
|
+
# service_registries: [
|
8415
|
+
# {
|
8416
|
+
# registry_arn: "String",
|
8417
|
+
# port: 1,
|
8418
|
+
# container_name: "String",
|
8419
|
+
# container_port: 1,
|
8420
|
+
# },
|
8421
|
+
# ],
|
8287
8422
|
# })
|
8288
8423
|
#
|
8289
8424
|
# @example Response structure
|
@@ -8409,7 +8544,7 @@ module Aws::ECS
|
|
8409
8544
|
# resp.service.tags[0].value #=> String
|
8410
8545
|
# resp.service.created_by #=> String
|
8411
8546
|
# resp.service.enable_ecs_managed_tags #=> Boolean
|
8412
|
-
# resp.service.propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE"
|
8547
|
+
# resp.service.propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
|
8413
8548
|
# resp.service.enable_execute_command #=> Boolean
|
8414
8549
|
#
|
8415
8550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateService AWS API Documentation
|
@@ -8618,7 +8753,7 @@ module Aws::ECS
|
|
8618
8753
|
params: params,
|
8619
8754
|
config: config)
|
8620
8755
|
context[:gem_name] = 'aws-sdk-ecs'
|
8621
|
-
context[:gem_version] = '1.
|
8756
|
+
context[:gem_version] = '1.99.0'
|
8622
8757
|
Seahorse::Client::Request.new(handlers, context)
|
8623
8758
|
end
|
8624
8759
|
|
@@ -1658,6 +1658,10 @@ module Aws::ECS
|
|
1658
1658
|
UpdateServiceRequest.add_member(:force_new_deployment, Shapes::ShapeRef.new(shape: Boolean, location_name: "forceNewDeployment"))
|
1659
1659
|
UpdateServiceRequest.add_member(:health_check_grace_period_seconds, Shapes::ShapeRef.new(shape: BoxedInteger, location_name: "healthCheckGracePeriodSeconds"))
|
1660
1660
|
UpdateServiceRequest.add_member(:enable_execute_command, Shapes::ShapeRef.new(shape: BoxedBoolean, location_name: "enableExecuteCommand"))
|
1661
|
+
UpdateServiceRequest.add_member(:enable_ecs_managed_tags, Shapes::ShapeRef.new(shape: BoxedBoolean, location_name: "enableECSManagedTags"))
|
1662
|
+
UpdateServiceRequest.add_member(:load_balancers, Shapes::ShapeRef.new(shape: LoadBalancers, location_name: "loadBalancers"))
|
1663
|
+
UpdateServiceRequest.add_member(:propagate_tags, Shapes::ShapeRef.new(shape: PropagateTags, location_name: "propagateTags"))
|
1664
|
+
UpdateServiceRequest.add_member(:service_registries, Shapes::ShapeRef.new(shape: ServiceRegistries, location_name: "serviceRegistries"))
|
1661
1665
|
UpdateServiceRequest.struct_class = Types::UpdateServiceRequest
|
1662
1666
|
|
1663
1667
|
UpdateServiceResponse.add_member(:service, Shapes::ShapeRef.new(shape: Service, location_name: "service"))
|
data/lib/aws-sdk-ecs/types.rb
CHANGED
@@ -77,8 +77,8 @@ module Aws::ECS
|
|
77
77
|
end
|
78
78
|
|
79
79
|
# An attribute is a name-value pair that's associated with an Amazon
|
80
|
-
# ECS object.
|
81
|
-
#
|
80
|
+
# ECS object. Use attributes to extend the Amazon ECS data model by
|
81
|
+
# adding custom metadata to your resources. For more information, see
|
82
82
|
# [Attributes][1] in the *Amazon Elastic Container Service Developer
|
83
83
|
# Guide*.
|
84
84
|
#
|
@@ -748,7 +748,7 @@ module Aws::ECS
|
|
748
748
|
class ClusterNotFoundException < Aws::EmptyStructure; end
|
749
749
|
|
750
750
|
# The settings to use when creating a cluster. This parameter is used to
|
751
|
-
#
|
751
|
+
# turn on CloudWatch Container Insights for a cluster.
|
752
752
|
#
|
753
753
|
# @note When making an API call, you may pass ClusterSetting
|
754
754
|
# data as a hash:
|
@@ -1459,7 +1459,7 @@ module Aws::ECS
|
|
1459
1459
|
# reversed.
|
1460
1460
|
#
|
1461
1461
|
# For tasks using the EC2 launch type, the container instances require
|
1462
|
-
# at least version 1.26.0 of the container agent to
|
1462
|
+
# at least version 1.26.0 of the container agent to turn on container
|
1463
1463
|
# dependencies. However, we recommend using the latest container agent
|
1464
1464
|
# version. For information about checking your agent version and
|
1465
1465
|
# updating to the latest version, see [Updating the Amazon ECS
|
@@ -1509,7 +1509,7 @@ module Aws::ECS
|
|
1509
1509
|
# * Windows platform version `1.0.0` or later.
|
1510
1510
|
#
|
1511
1511
|
# For tasks using the EC2 launch type, your container instances
|
1512
|
-
# require at least version `1.26.0` of the container agent to
|
1512
|
+
# require at least version `1.26.0` of the container agent to use a
|
1513
1513
|
# container start timeout value. However, we recommend using the
|
1514
1514
|
# latest container agent version. For information about checking your
|
1515
1515
|
# agent version and updating to the latest version, see [Updating the
|
@@ -1549,7 +1549,7 @@ module Aws::ECS
|
|
1549
1549
|
# `ECS_CONTAINER_STOP_TIMEOUT` agent configuration variable are set,
|
1550
1550
|
# then the default values of 30 seconds for Linux containers and 30
|
1551
1551
|
# seconds on Windows containers are used. Your container instances
|
1552
|
-
# require at least version 1.26.0 of the container agent to
|
1552
|
+
# require at least version 1.26.0 of the container agent to use a
|
1553
1553
|
# container stop timeout value. However, we recommend using the latest
|
1554
1554
|
# container agent version. For information about checking your agent
|
1555
1555
|
# version and updating to the latest version, see [Updating the Amazon
|
@@ -2001,7 +2001,7 @@ module Aws::ECS
|
|
2001
2001
|
# defined for container startup, for container shutdown it is reversed.
|
2002
2002
|
#
|
2003
2003
|
# Your Amazon ECS container instances require at least version 1.26.0 of
|
2004
|
-
# the container agent to
|
2004
|
+
# the container agent to use container dependencies. However, we
|
2005
2005
|
# recommend using the latest container agent version. For information
|
2006
2006
|
# about checking your agent version and updating to the latest version,
|
2007
2007
|
# see [Updating the Amazon ECS Container Agent][1] in the *Amazon
|
@@ -2618,13 +2618,13 @@ module Aws::ECS
|
|
2618
2618
|
#
|
2619
2619
|
# @!attribute [rw] settings
|
2620
2620
|
# The setting to use when creating a cluster. This parameter is used
|
2621
|
-
# to
|
2622
|
-
# is specified, it overrides the `containerInsights` value set
|
2623
|
-
# PutAccountSetting or PutAccountSettingDefault.
|
2621
|
+
# to turn on CloudWatch Container Insights for a cluster. If this
|
2622
|
+
# value is specified, it overrides the `containerInsights` value set
|
2623
|
+
# with PutAccountSetting or PutAccountSettingDefault.
|
2624
2624
|
# @return [Array<Types::ClusterSetting>]
|
2625
2625
|
#
|
2626
2626
|
# @!attribute [rw] configuration
|
2627
|
-
# The execute command configuration for the cluster.
|
2627
|
+
# The `execute` command configuration for the cluster.
|
2628
2628
|
# @return [Types::ClusterConfiguration]
|
2629
2629
|
#
|
2630
2630
|
# @!attribute [rw] capacity_providers
|
@@ -2760,7 +2760,7 @@ module Aws::ECS
|
|
2760
2760
|
# },
|
2761
2761
|
# ],
|
2762
2762
|
# enable_ecs_managed_tags: false,
|
2763
|
-
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE
|
2763
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
|
2764
2764
|
# enable_execute_command: false,
|
2765
2765
|
# }
|
2766
2766
|
#
|
@@ -2812,11 +2812,8 @@ module Aws::ECS
|
|
2812
2812
|
# optional listener that you can use to perform validation tests with
|
2813
2813
|
# Lambda functions before routing production traffic to it.
|
2814
2814
|
#
|
2815
|
-
#
|
2816
|
-
#
|
2817
|
-
# container port that's specified in the service definition are
|
2818
|
-
# immutable. If you use the `CODE_DEPLOY` deployment controller, these
|
2819
|
-
# values can be changed when updating the service.
|
2815
|
+
# If you use the `CODE_DEPLOY` deployment controller, these values can
|
2816
|
+
# be changed when updating the service.
|
2820
2817
|
#
|
2821
2818
|
# For Application Load Balancers and Network Load Balancers, this
|
2822
2819
|
# object must contain the load balancer target group ARN, the
|
@@ -3004,6 +3001,10 @@ module Aws::ECS
|
|
3004
3001
|
# load balancer defined and you don't specify a health check grace
|
3005
3002
|
# period value, the default value of `0` is used.
|
3006
3003
|
#
|
3004
|
+
# If you do not use an Elastic Load Balancing, we recomend that you
|
3005
|
+
# use the `startPeriod` in the task definition healtch check
|
3006
|
+
# parameters. For more information, see [Health check][1].
|
3007
|
+
#
|
3007
3008
|
# If your service's tasks take a while to start and respond to
|
3008
3009
|
# Elastic Load Balancing health checks, you can specify a health check
|
3009
3010
|
# grace period of up to 2,147,483,647 seconds (about 69 years). During
|
@@ -3011,6 +3012,10 @@ module Aws::ECS
|
|
3011
3012
|
# status. This grace period can prevent the service scheduler from
|
3012
3013
|
# marking tasks as unhealthy and stopping them before they have time
|
3013
3014
|
# to come up.
|
3015
|
+
#
|
3016
|
+
#
|
3017
|
+
#
|
3018
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html
|
3014
3019
|
# @return [Integer]
|
3015
3020
|
#
|
3016
3021
|
# @!attribute [rw] scheduling_strategy
|
@@ -3085,7 +3090,7 @@ module Aws::ECS
|
|
3085
3090
|
# @return [Array<Types::Tag>]
|
3086
3091
|
#
|
3087
3092
|
# @!attribute [rw] enable_ecs_managed_tags
|
3088
|
-
# Specifies whether to
|
3093
|
+
# Specifies whether to turn on Amazon ECS managed tags for the tasks
|
3089
3094
|
# within the service. For more information, see [Tagging Your Amazon
|
3090
3095
|
# ECS Resources][1] in the *Amazon Elastic Container Service Developer
|
3091
3096
|
# Guide*.
|
@@ -3096,12 +3101,10 @@ module Aws::ECS
|
|
3096
3101
|
# @return [Boolean]
|
3097
3102
|
#
|
3098
3103
|
# @!attribute [rw] propagate_tags
|
3099
|
-
# Specifies whether to propagate the tags from the task definition
|
3100
|
-
# the
|
3101
|
-
#
|
3102
|
-
#
|
3103
|
-
# task after service creation or task creation, use the TagResource
|
3104
|
-
# API action.
|
3104
|
+
# Specifies whether to propagate the tags from the task definition to
|
3105
|
+
# the task. If no value is specified, the tags aren't propagated.
|
3106
|
+
# Tags can only be propagated to the task during task creation. To add
|
3107
|
+
# tags to a task after task creation, use the TagResource API action.
|
3105
3108
|
# @return [String]
|
3106
3109
|
#
|
3107
3110
|
# @!attribute [rw] enable_execute_command
|
@@ -3808,9 +3811,9 @@ module Aws::ECS
|
|
3808
3811
|
# The **deployment circuit breaker** determines whether a service
|
3809
3812
|
# deployment will fail if the service can't reach a steady state. If
|
3810
3813
|
# enabled, a service deployment will transition to a failed state and
|
3811
|
-
# stop launching new tasks. You can also
|
3812
|
-
# your service to the last completed deployment after a failure.
|
3813
|
-
# more information, see [Rolling update][1] in the *Amazon Elastic
|
3814
|
+
# stop launching new tasks. You can also configure Amazon ECS to roll
|
3815
|
+
# back your service to the last completed deployment after a failure.
|
3816
|
+
# For more information, see [Rolling update][1] in the *Amazon Elastic
|
3814
3817
|
# Container Service Developer Guide*.
|
3815
3818
|
#
|
3816
3819
|
#
|
@@ -3826,15 +3829,15 @@ module Aws::ECS
|
|
3826
3829
|
# }
|
3827
3830
|
#
|
3828
3831
|
# @!attribute [rw] enable
|
3829
|
-
# Determines whether to
|
3830
|
-
#
|
3832
|
+
# Determines whether to use the deployment circuit breaker logic for
|
3833
|
+
# the service.
|
3831
3834
|
# @return [Boolean]
|
3832
3835
|
#
|
3833
3836
|
# @!attribute [rw] rollback
|
3834
|
-
# Determines whether to
|
3835
|
-
# a service deployment fails. If rollback is enabled, when a
|
3836
|
-
# deployment fails, the service is rolled back to the last
|
3837
|
-
# that completed successfully.
|
3837
|
+
# Determines whether to configure Amazon ECS to roll back the service
|
3838
|
+
# if a service deployment fails. If rollback is enabled, when a
|
3839
|
+
# service deployment fails, the service is rolled back to the last
|
3840
|
+
# deployment that completed successfully.
|
3838
3841
|
# @return [Boolean]
|
3839
3842
|
#
|
3840
3843
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeploymentCircuitBreaker AWS API Documentation
|
@@ -4796,12 +4799,12 @@ module Aws::ECS
|
|
4796
4799
|
# @return [String]
|
4797
4800
|
#
|
4798
4801
|
# @!attribute [rw] transit_encryption
|
4799
|
-
# Determines whether to
|
4800
|
-
#
|
4801
|
-
#
|
4802
|
-
#
|
4803
|
-
#
|
4804
|
-
#
|
4802
|
+
# Determines whether to use encryption for Amazon EFS data in transit
|
4803
|
+
# between the Amazon ECS host and the Amazon EFS server. Transit
|
4804
|
+
# encryption must be enabled if Amazon EFS IAM authorization is used.
|
4805
|
+
# If this parameter is omitted, the default value of `DISABLED` is
|
4806
|
+
# used. For more information, see [Encrypting Data in Transit][1] in
|
4807
|
+
# the *Amazon Elastic File System User Guide*.
|
4805
4808
|
#
|
4806
4809
|
#
|
4807
4810
|
#
|
@@ -4898,12 +4901,9 @@ module Aws::ECS
|
|
4898
4901
|
# more information, see [Fargate task storage][1] in the *Amazon ECS
|
4899
4902
|
# User Guide for Fargate*.
|
4900
4903
|
#
|
4901
|
-
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
|
4902
|
-
#
|
4903
|
-
#
|
4904
|
-
# * Linux platform version `1.4.0` or later.
|
4905
|
-
#
|
4906
|
-
# * Windows platform version `1.0.0` or later.
|
4904
|
+
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
|
4905
|
+
# Linux platform version `1.4.0` or later. This parameter is not
|
4906
|
+
# supported for Windows containers on Fargate.
|
4907
4907
|
#
|
4908
4908
|
# </note>
|
4909
4909
|
#
|
@@ -5010,8 +5010,8 @@ module Aws::ECS
|
|
5010
5010
|
# @return [String]
|
5011
5011
|
#
|
5012
5012
|
# @!attribute [rw] cloud_watch_encryption_enabled
|
5013
|
-
# Determines whether to
|
5014
|
-
#
|
5013
|
+
# Determines whether to use encryption on the CloudWatch logs. If not
|
5014
|
+
# specified, encryption will be disabled.
|
5015
5015
|
# @return [Boolean]
|
5016
5016
|
#
|
5017
5017
|
# @!attribute [rw] s3_bucket_name
|
@@ -5315,6 +5315,15 @@ module Aws::ECS
|
|
5315
5315
|
# Docker health checks that exist in the container image (such as those
|
5316
5316
|
# specified in a parent image or from the image's Dockerfile).
|
5317
5317
|
#
|
5318
|
+
# <note markdown="1"> The Amazon ECS container agent only monitors and reports on the health
|
5319
|
+
# checks specified in the task definition. Amazon ECS does not monitor
|
5320
|
+
# Docker health checks that are embedded in a container image and not
|
5321
|
+
# specified in the container definition. Health check parameters that
|
5322
|
+
# are specified in a container definition override any Docker health
|
5323
|
+
# checks that exist in the container image.
|
5324
|
+
#
|
5325
|
+
# </note>
|
5326
|
+
#
|
5318
5327
|
# You can view the health status of both individual containers and a
|
5319
5328
|
# task with the DescribeTasks API operation or when viewing the task
|
5320
5329
|
# details in the console.
|
@@ -6674,6 +6683,22 @@ module Aws::ECS
|
|
6674
6683
|
# balancers with services and task sets, see the CreateService and
|
6675
6684
|
# CreateTaskSet actions.
|
6676
6685
|
#
|
6686
|
+
# When you add, update, or remove a load balancer configuration, Amazon
|
6687
|
+
# ECS starts a new deployment with the updated Elastic Load Balancing
|
6688
|
+
# configuration. This causes tasks to register to and deregister from
|
6689
|
+
# load balancers.
|
6690
|
+
#
|
6691
|
+
# We recommend that you verify this on a test environment before you
|
6692
|
+
# update the Elastic Load Balancing configuration.
|
6693
|
+
#
|
6694
|
+
# A service-linked role is required for services that use multiple
|
6695
|
+
# target groups. For more information, see [Service-linked roles][1] in
|
6696
|
+
# the *Amazon Elastic Container Service Developer Guide*.
|
6697
|
+
#
|
6698
|
+
#
|
6699
|
+
#
|
6700
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html
|
6701
|
+
#
|
6677
6702
|
# @note When making an API call, you may pass LoadBalancer
|
6678
6703
|
# data as a hash:
|
6679
6704
|
#
|
@@ -6970,8 +6995,7 @@ module Aws::ECS
|
|
6970
6995
|
# }
|
6971
6996
|
#
|
6972
6997
|
# @!attribute [rw] status
|
6973
|
-
# Determines whether to
|
6974
|
-
# provider.
|
6998
|
+
# Determines whether to use managed scaling for the capacity provider.
|
6975
6999
|
# @return [String]
|
6976
7000
|
#
|
6977
7001
|
# @!attribute [rw] target_capacity
|
@@ -7407,7 +7431,7 @@ module Aws::ECS
|
|
7407
7431
|
#
|
7408
7432
|
# For tasks that use the EC2 launch type, the container instances
|
7409
7433
|
# require at least version 1.26.0 of the container agent and at least
|
7410
|
-
# version 1.26.0-1 of the `ecs-init` package to
|
7434
|
+
# version 1.26.0-1 of the `ecs-init` package to use a proxy
|
7411
7435
|
# configuration. If your container instances are launched from the
|
7412
7436
|
# Amazon ECS optimized AMI version `20190301` or later, then they
|
7413
7437
|
# contain the required versions of the container agent and `ecs-init`.
|
@@ -8391,7 +8415,7 @@ module Aws::ECS
|
|
8391
8415
|
#
|
8392
8416
|
# For tasks hosted on Amazon EC2 instances, the container instances
|
8393
8417
|
# require at least version `1.26.0` of the container agent and at
|
8394
|
-
# least version `1.26.0-1` of the `ecs-init` package to
|
8418
|
+
# least version `1.26.0-1` of the `ecs-init` package to use a proxy
|
8395
8419
|
# configuration. If your container instances are launched from the
|
8396
8420
|
# Amazon ECS-optimized AMI version `20190301` or later, then they
|
8397
8421
|
# contain the required versions of the container agent and `ecs-init`.
|
@@ -8703,7 +8727,7 @@ module Aws::ECS
|
|
8703
8727
|
# },
|
8704
8728
|
# ],
|
8705
8729
|
# platform_version: "String",
|
8706
|
-
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE
|
8730
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
|
8707
8731
|
# reference_id: "String",
|
8708
8732
|
# started_by: "String",
|
8709
8733
|
# tags: [
|
@@ -8742,9 +8766,9 @@ module Aws::ECS
|
|
8742
8766
|
# @return [Integer]
|
8743
8767
|
#
|
8744
8768
|
# @!attribute [rw] enable_ecs_managed_tags
|
8745
|
-
# Specifies whether to
|
8746
|
-
#
|
8747
|
-
#
|
8769
|
+
# Specifies whether to use Amazon ECS managed tags for the task. For
|
8770
|
+
# more information, see [Tagging Your Amazon ECS Resources][1] in the
|
8771
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
8748
8772
|
#
|
8749
8773
|
#
|
8750
8774
|
#
|
@@ -8752,9 +8776,12 @@ module Aws::ECS
|
|
8752
8776
|
# @return [Boolean]
|
8753
8777
|
#
|
8754
8778
|
# @!attribute [rw] enable_execute_command
|
8755
|
-
# Determines whether to
|
8756
|
-
#
|
8779
|
+
# Determines whether to use the execute command functionality for the
|
8780
|
+
# containers in this task. If `true`, this enables execute command
|
8757
8781
|
# functionality on all containers in the task.
|
8782
|
+
#
|
8783
|
+
# If `true`, then the task definition must have a task role, or you
|
8784
|
+
# must provide one as an override.
|
8758
8785
|
# @return [Boolean]
|
8759
8786
|
#
|
8760
8787
|
# @!attribute [rw] group
|
@@ -8911,12 +8938,32 @@ module Aws::ECS
|
|
8911
8938
|
# task definition to run. If a `revision` isn't specified, the latest
|
8912
8939
|
# `ACTIVE` revision is used.
|
8913
8940
|
#
|
8941
|
+
# When you create an IAM policy for run-task, you can set the resource
|
8942
|
+
# to be the latest task definition revision, or a specific revision.
|
8943
|
+
#
|
8914
8944
|
# The full ARN value must match the value that you specified as the
|
8915
|
-
# `Resource` of the IAM principal's permissions policy.
|
8916
|
-
#
|
8917
|
-
#
|
8918
|
-
# the `
|
8945
|
+
# `Resource` of the IAM principal's permissions policy.
|
8946
|
+
#
|
8947
|
+
# When you specify the policy resource as the latest task definition
|
8948
|
+
# version (by setting the `Resource` in the policy to
|
8949
|
+
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName`),
|
8950
|
+
# then set this value to
|
8919
8951
|
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName`.
|
8952
|
+
#
|
8953
|
+
# When you specify the policy resource as a specific task definition
|
8954
|
+
# version (by setting the `Resource` in the policy to
|
8955
|
+
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1`
|
8956
|
+
# or
|
8957
|
+
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*`),
|
8958
|
+
# then set this value to
|
8959
|
+
# `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1`.
|
8960
|
+
#
|
8961
|
+
# For more information, see [Policy Resources for Amazon ECS][1] in
|
8962
|
+
# the Amazon Elastic Container Service developer Guide.
|
8963
|
+
#
|
8964
|
+
#
|
8965
|
+
#
|
8966
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-resources
|
8920
8967
|
# @return [String]
|
8921
8968
|
#
|
8922
8969
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RunTaskRequest AWS API Documentation
|
@@ -9063,12 +9110,23 @@ module Aws::ECS
|
|
9063
9110
|
# either the full ARN of the Secrets Manager secret or the full ARN of
|
9064
9111
|
# the parameter in the SSM Parameter Store.
|
9065
9112
|
#
|
9113
|
+
# For information about the require Identity and Access Management
|
9114
|
+
# permissions, see [Required IAM permissions for Amazon ECS
|
9115
|
+
# secrets][1] (for Secrets Manager) or [Required IAM permissions for
|
9116
|
+
# Amazon ECS secrets][2] (for Systems Manager Parameter store) in the
|
9117
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
9118
|
+
#
|
9066
9119
|
# <note markdown="1"> If the SSM Parameter Store parameter exists in the same Region as
|
9067
9120
|
# the task you're launching, then you can use either the full ARN or
|
9068
9121
|
# name of the parameter. If the parameter exists in a different
|
9069
9122
|
# Region, then the full ARN must be specified.
|
9070
9123
|
#
|
9071
9124
|
# </note>
|
9125
|
+
#
|
9126
|
+
#
|
9127
|
+
#
|
9128
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam
|
9129
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html
|
9072
9130
|
# @return [String]
|
9073
9131
|
#
|
9074
9132
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Secret AWS API Documentation
|
@@ -9257,7 +9315,7 @@ module Aws::ECS
|
|
9257
9315
|
# placement decisions.
|
9258
9316
|
#
|
9259
9317
|
# * `DAEMON`-The daemon scheduling strategy deploys exactly one task
|
9260
|
-
# on each active container instance. This
|
9318
|
+
# on each active container instance. This task meets all of the task
|
9261
9319
|
# placement constraints that you specify in your cluster. The
|
9262
9320
|
# service scheduler also evaluates the task placement constraints
|
9263
9321
|
# for running tasks. It stop tasks that don't meet the placement
|
@@ -9314,8 +9372,8 @@ module Aws::ECS
|
|
9314
9372
|
# @return [String]
|
9315
9373
|
#
|
9316
9374
|
# @!attribute [rw] enable_ecs_managed_tags
|
9317
|
-
# Determines whether to
|
9318
|
-
#
|
9375
|
+
# Determines whether to use Amazon ECS managed tags for the tasks in
|
9376
|
+
# the service. For more information, see [Tagging Your Amazon ECS
|
9319
9377
|
# Resources][1] in the *Amazon Elastic Container Service Developer
|
9320
9378
|
# Guide*.
|
9321
9379
|
#
|
@@ -9416,6 +9474,13 @@ module Aws::ECS
|
|
9416
9474
|
|
9417
9475
|
# The details for the service registry.
|
9418
9476
|
#
|
9477
|
+
# Each service may be associated with one service registry. Multiple
|
9478
|
+
# service registries for each service are not supported.
|
9479
|
+
#
|
9480
|
+
# When you add, update, or remove the service registries configuration,
|
9481
|
+
# Amazon ECS starts a new deployment. New tasks are registered and
|
9482
|
+
# deregistered to the updated service registry configuration.
|
9483
|
+
#
|
9419
9484
|
# @note When making an API call, you may pass ServiceRegistry
|
9420
9485
|
# data as a hash:
|
9421
9486
|
#
|
@@ -9484,7 +9549,7 @@ module Aws::ECS
|
|
9484
9549
|
# @return [String]
|
9485
9550
|
#
|
9486
9551
|
# @!attribute [rw] stream_url
|
9487
|
-
# A URL
|
9552
|
+
# A URL to the managed agent on the container that the SSM Session
|
9488
9553
|
# Manager client uses to send commands and receive output from the
|
9489
9554
|
# container.
|
9490
9555
|
# @return [String]
|
@@ -9589,7 +9654,7 @@ module Aws::ECS
|
|
9589
9654
|
# size_in_gi_b: 1, # required
|
9590
9655
|
# },
|
9591
9656
|
# },
|
9592
|
-
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE
|
9657
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
|
9593
9658
|
# reference_id: "String",
|
9594
9659
|
# started_by: "String",
|
9595
9660
|
# tags: [
|
@@ -9614,9 +9679,9 @@ module Aws::ECS
|
|
9614
9679
|
# @return [Array<String>]
|
9615
9680
|
#
|
9616
9681
|
# @!attribute [rw] enable_ecs_managed_tags
|
9617
|
-
# Specifies whether to
|
9618
|
-
#
|
9619
|
-
#
|
9682
|
+
# Specifies whether to use Amazon ECS managed tags for the task. For
|
9683
|
+
# more information, see [Tagging Your Amazon ECS Resources][1] in the
|
9684
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
9620
9685
|
#
|
9621
9686
|
#
|
9622
9687
|
#
|
@@ -10217,8 +10282,23 @@ module Aws::ECS
|
|
10217
10282
|
#
|
10218
10283
|
class TagResourceResponse < Aws::EmptyStructure; end
|
10219
10284
|
|
10220
|
-
# The
|
10221
|
-
#
|
10285
|
+
# The execute command cannot run. This error can be caused by any of the
|
10286
|
+
# following configuration issues:
|
10287
|
+
#
|
10288
|
+
# * Incorrect IAM permissions
|
10289
|
+
#
|
10290
|
+
# * The SSM agent is not installed or is not running
|
10291
|
+
#
|
10292
|
+
# * There is an interface Amazon VPC endpoint for Amazon ECS, but there
|
10293
|
+
# is not one for for Systems Manager Session Manager
|
10294
|
+
#
|
10295
|
+
# For information about how to troubleshoot the issues, see
|
10296
|
+
# [Troubleshooting issues with ECS Exec][1] in the *Amazon Elastic
|
10297
|
+
# Container Service Developer Guide*.
|
10298
|
+
#
|
10299
|
+
#
|
10300
|
+
#
|
10301
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html
|
10222
10302
|
#
|
10223
10303
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TargetNotConnectedException AWS API Documentation
|
10224
10304
|
#
|
@@ -10456,6 +10536,20 @@ module Aws::ECS
|
|
10456
10536
|
# @!attribute [rw] stop_code
|
10457
10537
|
# The stop code indicating why a task was stopped. The `stoppedReason`
|
10458
10538
|
# might contain additional details.
|
10539
|
+
#
|
10540
|
+
# The following are valid values:
|
10541
|
+
#
|
10542
|
+
# * `TaskFailedToStart`
|
10543
|
+
#
|
10544
|
+
# * `EssentialContainerExited`
|
10545
|
+
#
|
10546
|
+
# * `UserInitiated`
|
10547
|
+
#
|
10548
|
+
# * `TerminationNotice`
|
10549
|
+
#
|
10550
|
+
# * `ServiceSchedulerInitiated`
|
10551
|
+
#
|
10552
|
+
# * `SpotInterruption`
|
10459
10553
|
# @return [String]
|
10460
10554
|
#
|
10461
10555
|
# @!attribute [rw] stopped_at
|
@@ -10898,12 +10992,12 @@ module Aws::ECS
|
|
10898
10992
|
#
|
10899
10993
|
# Your Amazon ECS container instances require at least version 1.26.0
|
10900
10994
|
# of the container agent and at least version 1.26.0-1 of the
|
10901
|
-
# `ecs-init` package to
|
10902
|
-
#
|
10903
|
-
#
|
10904
|
-
#
|
10905
|
-
#
|
10906
|
-
#
|
10995
|
+
# `ecs-init` package to use a proxy configuration. If your container
|
10996
|
+
# instances are launched from the Amazon ECS optimized AMI version
|
10997
|
+
# `20190301` or later, they contain the required versions of the
|
10998
|
+
# container agent and `ecs-init`. For more information, see [Amazon
|
10999
|
+
# ECS-optimized Linux AMI][1] in the *Amazon Elastic Container Service
|
11000
|
+
# Developer Guide*.
|
10907
11001
|
#
|
10908
11002
|
#
|
10909
11003
|
#
|
@@ -11606,9 +11700,9 @@ module Aws::ECS
|
|
11606
11700
|
#
|
11607
11701
|
# @!attribute [rw] settings
|
11608
11702
|
# The setting to use by default for a cluster. This parameter is used
|
11609
|
-
# to
|
11610
|
-
# is specified, it overrides the `containerInsights` value set
|
11611
|
-
# PutAccountSetting or PutAccountSettingDefault.
|
11703
|
+
# to turn on CloudWatch Container Insights for a cluster. If this
|
11704
|
+
# value is specified, it overrides the `containerInsights` value set
|
11705
|
+
# with PutAccountSetting or PutAccountSettingDefault.
|
11612
11706
|
# @return [Array<Types::ClusterSetting>]
|
11613
11707
|
#
|
11614
11708
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateClusterSettingsRequest AWS API Documentation
|
@@ -11775,7 +11869,7 @@ module Aws::ECS
|
|
11775
11869
|
end
|
11776
11870
|
|
11777
11871
|
# @!attribute [rw] task_set
|
11778
|
-
#
|
11872
|
+
# etails about the task set.
|
11779
11873
|
# @return [Types::TaskSet]
|
11780
11874
|
#
|
11781
11875
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateServicePrimaryTaskSetResponse AWS API Documentation
|
@@ -11832,6 +11926,24 @@ module Aws::ECS
|
|
11832
11926
|
# force_new_deployment: false,
|
11833
11927
|
# health_check_grace_period_seconds: 1,
|
11834
11928
|
# enable_execute_command: false,
|
11929
|
+
# enable_ecs_managed_tags: false,
|
11930
|
+
# load_balancers: [
|
11931
|
+
# {
|
11932
|
+
# target_group_arn: "String",
|
11933
|
+
# load_balancer_name: "String",
|
11934
|
+
# container_name: "String",
|
11935
|
+
# container_port: 1,
|
11936
|
+
# },
|
11937
|
+
# ],
|
11938
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
|
11939
|
+
# service_registries: [
|
11940
|
+
# {
|
11941
|
+
# registry_arn: "String",
|
11942
|
+
# port: 1,
|
11943
|
+
# container_name: "String",
|
11944
|
+
# container_port: 1,
|
11945
|
+
# },
|
11946
|
+
# ],
|
11835
11947
|
# }
|
11836
11948
|
#
|
11837
11949
|
# @!attribute [rw] cluster
|
@@ -11969,6 +12081,86 @@ module Aws::ECS
|
|
11969
12081
|
# action.
|
11970
12082
|
# @return [Boolean]
|
11971
12083
|
#
|
12084
|
+
# @!attribute [rw] enable_ecs_managed_tags
|
12085
|
+
# Determines whether to turn on Amazon ECS managed tags for the tasks
|
12086
|
+
# in the service. For more information, see [Tagging Your Amazon ECS
|
12087
|
+
# Resources][1] in the *Amazon Elastic Container Service Developer
|
12088
|
+
# Guide*.
|
12089
|
+
#
|
12090
|
+
# Only tasks launched after the update will reflect the update. To
|
12091
|
+
# update the tags on all tasks, set `forceNewDeployment` to `true`, so
|
12092
|
+
# that Amazon ECS starts new tasks with the updated tags.
|
12093
|
+
#
|
12094
|
+
#
|
12095
|
+
#
|
12096
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
12097
|
+
# @return [Boolean]
|
12098
|
+
#
|
12099
|
+
# @!attribute [rw] load_balancers
|
12100
|
+
# A list of Elastic Load Balancing load balancer objects. It contains
|
12101
|
+
# the load balancer name, the container name, and the container port
|
12102
|
+
# to access from the load balancer. The container name is as it
|
12103
|
+
# appears in a container definition.
|
12104
|
+
#
|
12105
|
+
# When you add, update, or remove a load balancer configuration,
|
12106
|
+
# Amazon ECS starts new tasks with the updated Elastic Load Balancing
|
12107
|
+
# configuration, and then stops the old tasks when the new tasks are
|
12108
|
+
# running.
|
12109
|
+
#
|
12110
|
+
# For services that use rolling updates, you can add, update, or
|
12111
|
+
# remove Elastic Load Balancing target groups. You can update from a
|
12112
|
+
# single target group to multiple target groups and from multiple
|
12113
|
+
# target groups to a single target group.
|
12114
|
+
#
|
12115
|
+
# For services that use blue/green deployments, you can update Elastic
|
12116
|
+
# Load Balancing target groups by using ` CreateDeployment ` through
|
12117
|
+
# CodeDeploy. Note that multiple target groups are not supported for
|
12118
|
+
# blue/green deployments. For more information see [Register multiple
|
12119
|
+
# target groups with a service][1] in the *Amazon Elastic Container
|
12120
|
+
# Service Developer Guide*.
|
12121
|
+
#
|
12122
|
+
# For services that use the external deployment controller, you can
|
12123
|
+
# add, update, or remove load balancers by using [CreateTaskSet][2].
|
12124
|
+
# Note that multiple target groups are not supported for external
|
12125
|
+
# deployments. For more information see [Register multiple target
|
12126
|
+
# groups with a service][1] in the *Amazon Elastic Container Service
|
12127
|
+
# Developer Guide*.
|
12128
|
+
#
|
12129
|
+
# You can remove existing `loadBalancers` by passing an empty list.
|
12130
|
+
#
|
12131
|
+
#
|
12132
|
+
#
|
12133
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html
|
12134
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html
|
12135
|
+
# @return [Array<Types::LoadBalancer>]
|
12136
|
+
#
|
12137
|
+
# @!attribute [rw] propagate_tags
|
12138
|
+
# Determines whether to propagate the tags from the task definition or
|
12139
|
+
# the service to the task. If no value is specified, the tags aren't
|
12140
|
+
# propagated.
|
12141
|
+
#
|
12142
|
+
# Only tasks launched after the update will reflect the update. To
|
12143
|
+
# update the tags on all tasks, set `forceNewDeployment` to `true`, so
|
12144
|
+
# that Amazon ECS starts new tasks with the updated tags.
|
12145
|
+
# @return [String]
|
12146
|
+
#
|
12147
|
+
# @!attribute [rw] service_registries
|
12148
|
+
# The details for the service discovery registries to assign to this
|
12149
|
+
# service. For more information, see [Service Discovery][1].
|
12150
|
+
#
|
12151
|
+
# When you add, update, or remove the service registries
|
12152
|
+
# configuration, Amazon ECS starts new tasks with the updated service
|
12153
|
+
# registries configuration, and then stops the old tasks when the new
|
12154
|
+
# tasks are running.
|
12155
|
+
#
|
12156
|
+
# You can remove existing `serviceRegistries` by passing an empty
|
12157
|
+
# list.
|
12158
|
+
#
|
12159
|
+
#
|
12160
|
+
#
|
12161
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html
|
12162
|
+
# @return [Array<Types::ServiceRegistry>]
|
12163
|
+
#
|
11972
12164
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateServiceRequest AWS API Documentation
|
11973
12165
|
#
|
11974
12166
|
class UpdateServiceRequest < Struct.new(
|
@@ -11984,7 +12176,11 @@ module Aws::ECS
|
|
11984
12176
|
:platform_version,
|
11985
12177
|
:force_new_deployment,
|
11986
12178
|
:health_check_grace_period_seconds,
|
11987
|
-
:enable_execute_command
|
12179
|
+
:enable_execute_command,
|
12180
|
+
:enable_ecs_managed_tags,
|
12181
|
+
:load_balancers,
|
12182
|
+
:propagate_tags,
|
12183
|
+
:service_registries)
|
11988
12184
|
SENSITIVE = []
|
11989
12185
|
include Aws::Structure
|
11990
12186
|
end
|
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.99.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-03-22 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|