aws-sdk-ecs 1.110.0 → 1.112.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ecs/client.rb +330 -55
- data/lib/aws-sdk-ecs/client_api.rb +24 -0
- data/lib/aws-sdk-ecs/endpoint_parameters.rb +0 -3
- data/lib/aws-sdk-ecs/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-ecs/endpoints.rb +14 -0
- data/lib/aws-sdk-ecs/plugins/endpoints.rb +2 -0
- data/lib/aws-sdk-ecs/types.rb +210 -141
- data/lib/aws-sdk-ecs.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-ecs/types.rb
CHANGED
@@ -139,20 +139,20 @@ module Aws::ECS
|
|
139
139
|
# The managed termination protection setting to use for the Auto
|
140
140
|
# Scaling group capacity provider. This determines whether the Auto
|
141
141
|
# Scaling group has managed termination protection. The default is
|
142
|
-
#
|
142
|
+
# off.
|
143
143
|
#
|
144
144
|
# When using managed termination protection, managed scaling must also
|
145
145
|
# be used otherwise managed termination protection doesn't work.
|
146
146
|
#
|
147
|
-
# When managed termination protection is
|
148
|
-
#
|
147
|
+
# When managed termination protection is on, Amazon ECS prevents the
|
148
|
+
# Amazon EC2 instances in an Auto Scaling group that contain tasks
|
149
149
|
# from being terminated during a scale-in action. The Auto Scaling
|
150
150
|
# group and each instance in the Auto Scaling group must have instance
|
151
151
|
# protection from scale-in actions enabled as well. For more
|
152
152
|
# information, see [Instance Protection][1] in the *Auto Scaling User
|
153
153
|
# Guide*.
|
154
154
|
#
|
155
|
-
# When managed termination protection is
|
155
|
+
# When managed termination protection is off, your Amazon EC2
|
156
156
|
# instances aren't protected from termination when the Auto Scaling
|
157
157
|
# group scales in.
|
158
158
|
#
|
@@ -186,14 +186,14 @@ module Aws::ECS
|
|
186
186
|
# When using managed termination protection, managed scaling must also
|
187
187
|
# be used otherwise managed termination protection doesn't work.
|
188
188
|
#
|
189
|
-
# When managed termination protection is
|
190
|
-
#
|
189
|
+
# When managed termination protection is on, Amazon ECS prevents the
|
190
|
+
# Amazon EC2 instances in an Auto Scaling group that contain tasks
|
191
191
|
# from being terminated during a scale-in action. The Auto Scaling
|
192
192
|
# group and each instance in the Auto Scaling group must have instance
|
193
|
-
# protection from scale-in actions
|
193
|
+
# protection from scale-in actions on. For more information, see
|
194
194
|
# [Instance Protection][1] in the *Auto Scaling User Guide*.
|
195
195
|
#
|
196
|
-
# When managed termination protection is
|
196
|
+
# When managed termination protection is off, your Amazon EC2
|
197
197
|
# instances aren't protected from termination when the Auto Scaling
|
198
198
|
# group scales in.
|
199
199
|
#
|
@@ -563,7 +563,7 @@ module Aws::ECS
|
|
563
563
|
#
|
564
564
|
# @!attribute [rw] settings
|
565
565
|
# The settings for the cluster. This parameter indicates whether
|
566
|
-
# CloudWatch Container Insights is
|
566
|
+
# CloudWatch Container Insights is on or off for a cluster.
|
567
567
|
# @return [Array<Types::ClusterSetting>]
|
568
568
|
#
|
569
569
|
# @!attribute [rw] capacity_providers
|
@@ -797,10 +797,15 @@ module Aws::ECS
|
|
797
797
|
# The value to set for the cluster setting. The supported values are
|
798
798
|
# `enabled` and `disabled`. If `enabled` is specified, CloudWatch
|
799
799
|
# Container Insights will be enabled for the cluster, otherwise it
|
800
|
-
# will be
|
801
|
-
#
|
802
|
-
# `containerInsights` value set with PutAccountSetting or
|
803
|
-
# PutAccountSettingDefault.
|
800
|
+
# will be off unless the `containerInsights` account setting is turned
|
801
|
+
# on. If a cluster value is specified, it will override the
|
802
|
+
# `containerInsights` value set with [PutAccountSetting][1] or
|
803
|
+
# [PutAccountSettingDefault][2].
|
804
|
+
#
|
805
|
+
#
|
806
|
+
#
|
807
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html
|
808
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html
|
804
809
|
# @return [String]
|
805
810
|
#
|
806
811
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ClusterSetting AWS API Documentation
|
@@ -1516,8 +1521,8 @@ module Aws::ECS
|
|
1516
1521
|
# @return [String]
|
1517
1522
|
#
|
1518
1523
|
# @!attribute [rw] disable_networking
|
1519
|
-
# When this parameter is true, networking is
|
1520
|
-
#
|
1524
|
+
# When this parameter is true, networking is off within the container.
|
1525
|
+
# This parameter maps to `NetworkDisabled` in the [Create a
|
1521
1526
|
# container][1] section of the [Docker Remote API][2].
|
1522
1527
|
#
|
1523
1528
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
@@ -1713,7 +1718,7 @@ module Aws::ECS
|
|
1713
1718
|
# `nofile` resource limit parameter which Fargate overrides. The
|
1714
1719
|
# `nofile` resource limit sets a restriction on the number of open
|
1715
1720
|
# files that a container can use. The default `nofile` soft limit is
|
1716
|
-
# `1024` and hard limit is `4096`.
|
1721
|
+
# `1024` and the default hard limit is `4096`.
|
1717
1722
|
#
|
1718
1723
|
# This parameter requires version 1.18 of the Docker Remote API or
|
1719
1724
|
# greater on your container instance. To check the Docker Remote API
|
@@ -2394,33 +2399,45 @@ module Aws::ECS
|
|
2394
2399
|
# the cluster. A capacity provider must be associated with a cluster
|
2395
2400
|
# before it can be included as part of the default capacity provider
|
2396
2401
|
# strategy of the cluster or used in a capacity provider strategy when
|
2397
|
-
# calling the CreateService or RunTask actions.
|
2402
|
+
# calling the [CreateService][1] or [RunTask][2] actions.
|
2398
2403
|
#
|
2399
2404
|
# If specifying a capacity provider that uses an Auto Scaling group,
|
2400
2405
|
# the capacity provider must be created but not associated with
|
2401
2406
|
# another cluster. New Auto Scaling group capacity providers can be
|
2402
|
-
# created with the CreateCapacityProvider API operation.
|
2407
|
+
# created with the [CreateCapacityProvider][3] API operation.
|
2403
2408
|
#
|
2404
2409
|
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
2405
2410
|
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
2406
2411
|
# are available to all accounts and only need to be associated with a
|
2407
2412
|
# cluster to be used.
|
2408
2413
|
#
|
2409
|
-
# The
|
2414
|
+
# The [PutCapacityProvider][4] API operation is used to update the
|
2410
2415
|
# list of available capacity providers for a cluster after the cluster
|
2411
2416
|
# is created.
|
2417
|
+
#
|
2418
|
+
#
|
2419
|
+
#
|
2420
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html
|
2421
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html
|
2422
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html
|
2423
|
+
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html
|
2412
2424
|
# @return [Array<String>]
|
2413
2425
|
#
|
2414
2426
|
# @!attribute [rw] default_capacity_provider_strategy
|
2415
2427
|
# The capacity provider strategy to set as the default for the
|
2416
2428
|
# cluster. After a default capacity provider strategy is set for a
|
2417
|
-
# cluster, when you call the
|
2418
|
-
# capacity provider strategy or launch type specified, the
|
2419
|
-
# capacity provider strategy for the cluster is used.
|
2429
|
+
# cluster, when you call the [CreateService][1] or [RunTask][2] APIs
|
2430
|
+
# with no capacity provider strategy or launch type specified, the
|
2431
|
+
# default capacity provider strategy for the cluster is used.
|
2420
2432
|
#
|
2421
2433
|
# If a default capacity provider strategy isn't defined for a cluster
|
2422
2434
|
# when it was created, it can be defined later with the
|
2423
2435
|
# PutClusterCapacityProviders API operation.
|
2436
|
+
#
|
2437
|
+
#
|
2438
|
+
#
|
2439
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html
|
2440
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html
|
2424
2441
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
2425
2442
|
#
|
2426
2443
|
# @!attribute [rw] service_connect_defaults
|
@@ -2813,7 +2830,12 @@ module Aws::ECS
|
|
2813
2830
|
# Specifies whether to propagate the tags from the task definition to
|
2814
2831
|
# the task. If no value is specified, the tags aren't propagated.
|
2815
2832
|
# Tags can only be propagated to the task during task creation. To add
|
2816
|
-
# tags to a task after task creation, use the TagResource API
|
2833
|
+
# tags to a task after task creation, use the [TagResource][1] API
|
2834
|
+
# action.
|
2835
|
+
#
|
2836
|
+
#
|
2837
|
+
#
|
2838
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html
|
2817
2839
|
# @return [String]
|
2818
2840
|
#
|
2819
2841
|
# @!attribute [rw] enable_execute_command
|
@@ -3075,12 +3097,12 @@ module Aws::ECS
|
|
3075
3097
|
# @return [String]
|
3076
3098
|
#
|
3077
3099
|
# @!attribute [rw] principal_arn
|
3078
|
-
# The Amazon Resource Name (ARN) of the principal. It can be an
|
3079
|
-
#
|
3080
|
-
#
|
3081
|
-
#
|
3082
|
-
#
|
3083
|
-
#
|
3100
|
+
# The Amazon Resource Name (ARN) of the principal. It can be an user,
|
3101
|
+
# role, or the root user. If you specify the root user, it disables
|
3102
|
+
# the account setting for all users, roles, and the root user of the
|
3103
|
+
# account unless a user or role explicitly overrides these settings.
|
3104
|
+
# If this field is omitted, the setting is changed only for the
|
3105
|
+
# authenticated user.
|
3084
3106
|
# @return [String]
|
3085
3107
|
#
|
3086
3108
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteAccountSettingRequest AWS API Documentation
|
@@ -3228,6 +3250,39 @@ module Aws::ECS
|
|
3228
3250
|
include Aws::Structure
|
3229
3251
|
end
|
3230
3252
|
|
3253
|
+
# @!attribute [rw] task_definitions
|
3254
|
+
# The `family` and `revision` (`family:revision`) or full Amazon
|
3255
|
+
# Resource Name (ARN) of the task definition to delete. You must
|
3256
|
+
# specify a `revision`.
|
3257
|
+
#
|
3258
|
+
# You can specify up to 10 task definitions as a comma separated list.
|
3259
|
+
# @return [Array<String>]
|
3260
|
+
#
|
3261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteTaskDefinitionsRequest AWS API Documentation
|
3262
|
+
#
|
3263
|
+
class DeleteTaskDefinitionsRequest < Struct.new(
|
3264
|
+
:task_definitions)
|
3265
|
+
SENSITIVE = []
|
3266
|
+
include Aws::Structure
|
3267
|
+
end
|
3268
|
+
|
3269
|
+
# @!attribute [rw] task_definitions
|
3270
|
+
# The list of deleted task definitions.
|
3271
|
+
# @return [Array<Types::TaskDefinition>]
|
3272
|
+
#
|
3273
|
+
# @!attribute [rw] failures
|
3274
|
+
# Any failures associated with the call.
|
3275
|
+
# @return [Array<Types::Failure>]
|
3276
|
+
#
|
3277
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteTaskDefinitionsResponse AWS API Documentation
|
3278
|
+
#
|
3279
|
+
class DeleteTaskDefinitionsResponse < Struct.new(
|
3280
|
+
:task_definitions,
|
3281
|
+
:failures)
|
3282
|
+
SENSITIVE = []
|
3283
|
+
include Aws::Structure
|
3284
|
+
end
|
3285
|
+
|
3231
3286
|
# @!attribute [rw] cluster
|
3232
3287
|
# The short name or full Amazon Resource Name (ARN) of the cluster
|
3233
3288
|
# that hosts the service that the task set found in to delete.
|
@@ -3499,8 +3554,7 @@ module Aws::ECS
|
|
3499
3554
|
end
|
3500
3555
|
|
3501
3556
|
# <note markdown="1"> The deployment circuit breaker can only be used for services using the
|
3502
|
-
# rolling update (`ECS`) deployment type
|
3503
|
-
# Load Balancer.
|
3557
|
+
# rolling update (`ECS`) deployment type.
|
3504
3558
|
#
|
3505
3559
|
# </note>
|
3506
3560
|
#
|
@@ -3548,10 +3602,16 @@ module Aws::ECS
|
|
3548
3602
|
#
|
3549
3603
|
# The **deployment circuit breaker** determines whether a service
|
3550
3604
|
# deployment will fail if the service can't reach a steady state. If
|
3551
|
-
# deployment circuit breaker
|
3552
|
-
# transition to a failed state and stop launching new tasks. If
|
3553
|
-
# rollback
|
3554
|
-
# rolled back to the last deployment that completed
|
3605
|
+
# you use the deployment circuit breaker, a service deployment will
|
3606
|
+
# transition to a failed state and stop launching new tasks. If you
|
3607
|
+
# use the rollback option, when a service deployment fails, the
|
3608
|
+
# service is rolled back to the last deployment that completed
|
3609
|
+
# successfully. For more information, see [Rolling update][1] in the
|
3610
|
+
# *Amazon Elastic Container Service Developer Guide*
|
3611
|
+
#
|
3612
|
+
#
|
3613
|
+
#
|
3614
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html
|
3555
3615
|
# @return [Types::DeploymentCircuitBreaker]
|
3556
3616
|
#
|
3557
3617
|
# @!attribute [rw] maximum_percent
|
@@ -4336,13 +4396,12 @@ module Aws::ECS
|
|
4336
4396
|
# @return [String]
|
4337
4397
|
#
|
4338
4398
|
# @!attribute [rw] iam
|
4339
|
-
# Determines whether to use the Amazon ECS task
|
4340
|
-
#
|
4341
|
-
#
|
4342
|
-
#
|
4343
|
-
#
|
4344
|
-
#
|
4345
|
-
# Developer Guide*.
|
4399
|
+
# Determines whether to use the Amazon ECS task role defined in a task
|
4400
|
+
# definition when mounting the Amazon EFS file system. If enabled,
|
4401
|
+
# transit encryption must be enabled in the `EFSVolumeConfiguration`.
|
4402
|
+
# If this parameter is omitted, the default value of `DISABLED` is
|
4403
|
+
# used. For more information, see [Using Amazon EFS access points][1]
|
4404
|
+
# in the *Amazon Elastic Container Service Developer Guide*.
|
4346
4405
|
#
|
4347
4406
|
#
|
4348
4407
|
#
|
@@ -4512,14 +4571,14 @@ module Aws::ECS
|
|
4512
4571
|
# The log setting to use for redirecting logs for your execute command
|
4513
4572
|
# results. The following log settings are available.
|
4514
4573
|
#
|
4515
|
-
# * `NONE
|
4574
|
+
# * `NONE`: The execute command session is not logged.
|
4516
4575
|
#
|
4517
|
-
# * `DEFAULT
|
4576
|
+
# * `DEFAULT`: The `awslogs` configuration in the task definition is
|
4518
4577
|
# used. If no logging parameter is specified, it defaults to this
|
4519
4578
|
# value. If no `awslogs` log driver is configured in the task
|
4520
4579
|
# definition, the output won't be logged.
|
4521
4580
|
#
|
4522
|
-
# * `OVERRIDE
|
4581
|
+
# * `OVERRIDE`: Specify the logging details as a part of
|
4523
4582
|
# `logConfiguration`. If the `OVERRIDE` logging option is specified,
|
4524
4583
|
# the `logConfiguration` is required.
|
4525
4584
|
# @return [String]
|
@@ -4554,7 +4613,7 @@ module Aws::ECS
|
|
4554
4613
|
#
|
4555
4614
|
# @!attribute [rw] cloud_watch_encryption_enabled
|
4556
4615
|
# Determines whether to use encryption on the CloudWatch logs. If not
|
4557
|
-
# specified, encryption will be
|
4616
|
+
# specified, encryption will be off.
|
4558
4617
|
# @return [Boolean]
|
4559
4618
|
#
|
4560
4619
|
# @!attribute [rw] s3_bucket_name
|
@@ -4833,14 +4892,14 @@ module Aws::ECS
|
|
4833
4892
|
# @!attribute [rw] protected_tasks
|
4834
4893
|
# A list of tasks with the following information.
|
4835
4894
|
#
|
4836
|
-
# * `taskArn
|
4895
|
+
# * `taskArn`: The task ARN.
|
4837
4896
|
#
|
4838
|
-
# * `protectionEnabled
|
4897
|
+
# * `protectionEnabled`: The protection status of the task. If
|
4839
4898
|
# scale-in protection is enabled for a task, the value is `true`.
|
4840
4899
|
# Otherwise, it is `false`.
|
4841
4900
|
#
|
4842
|
-
# * `expirationDate
|
4843
|
-
#
|
4901
|
+
# * `expirationDate`: The epoch time when protection for the task will
|
4902
|
+
# expire.
|
4844
4903
|
# @return [Array<Types::ProtectedTask>]
|
4845
4904
|
#
|
4846
4905
|
# @!attribute [rw] failures
|
@@ -4859,7 +4918,8 @@ module Aws::ECS
|
|
4859
4918
|
# An object representing a container health check. Health check
|
4860
4919
|
# parameters that are specified in a container definition override any
|
4861
4920
|
# Docker health checks that exist in the container image (such as those
|
4862
|
-
# specified in a parent image or from the image's Dockerfile).
|
4921
|
+
# specified in a parent image or from the image's Dockerfile). This
|
4922
|
+
# configuration maps to the `HEALTHCHECK` parameter of [docker run][1].
|
4863
4923
|
#
|
4864
4924
|
# <note markdown="1"> The Amazon ECS container agent only monitors and reports on the health
|
4865
4925
|
# checks specified in the task definition. Amazon ECS does not monitor
|
@@ -4885,9 +4945,8 @@ module Aws::ECS
|
|
4885
4945
|
# no container health check defined.
|
4886
4946
|
#
|
4887
4947
|
# The following describes the possible `healthStatus` values for a task.
|
4888
|
-
# The container health check status of
|
4889
|
-
#
|
4890
|
-
# health checks defined.
|
4948
|
+
# The container health check status of non-essential containers don't
|
4949
|
+
# have an effect on the health status of a task.
|
4891
4950
|
#
|
4892
4951
|
# * `HEALTHY`-All essential containers within the task have passed their
|
4893
4952
|
# health checks.
|
@@ -4896,38 +4955,33 @@ module Aws::ECS
|
|
4896
4955
|
# health check.
|
4897
4956
|
#
|
4898
4957
|
# * `UNKNOWN`-The essential containers within the task are still having
|
4899
|
-
# their health checks evaluated
|
4900
|
-
# containers with health checks defined
|
4958
|
+
# their health checks evaluated, there are only nonessential
|
4959
|
+
# containers with health checks defined, or there are no container
|
4960
|
+
# health checks defined.
|
4901
4961
|
#
|
4902
4962
|
# If a task is run manually, and not as part of a service, the task will
|
4903
4963
|
# continue its lifecycle regardless of its health status. For tasks that
|
4904
4964
|
# are part of a service, if the task reports as unhealthy then the task
|
4905
4965
|
# will be stopped and the service scheduler will replace it.
|
4906
4966
|
#
|
4907
|
-
# For tasks that are a part of a service and the service uses the `ECS`
|
4908
|
-
# rolling deployment type, the deployment is paused while the new tasks
|
4909
|
-
# have the `UNKNOWN` task health check status. For example, tasks that
|
4910
|
-
# define health checks for nonessential containers when no essential
|
4911
|
-
# containers have health checks will have the `UNKNOWN` health check
|
4912
|
-
# status indefinitely which prevents the deployment from completing.
|
4913
|
-
#
|
4914
4967
|
# The following are notes about container health check support:
|
4915
4968
|
#
|
4916
4969
|
# * Container health checks require version 1.17.0 or greater of the
|
4917
4970
|
# Amazon ECS container agent. For more information, see [Updating the
|
4918
|
-
# Amazon ECS container agent][
|
4971
|
+
# Amazon ECS container agent][2].
|
4919
4972
|
#
|
4920
4973
|
# * Container health checks are supported for Fargate tasks if you're
|
4921
4974
|
# using platform version `1.1.0` or greater. For more information, see
|
4922
|
-
# [Fargate platform versions][
|
4975
|
+
# [Fargate platform versions][3].
|
4923
4976
|
#
|
4924
4977
|
# * Container health checks aren't supported for tasks that are part of
|
4925
4978
|
# a service that's configured to use a Classic Load Balancer.
|
4926
4979
|
#
|
4927
4980
|
#
|
4928
4981
|
#
|
4929
|
-
# [1]: https://docs.
|
4930
|
-
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
4982
|
+
# [1]: https://docs.docker.com/engine/reference/run/
|
4983
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html
|
4984
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
4931
4985
|
#
|
4932
4986
|
# @!attribute [rw] command
|
4933
4987
|
# A string array representing the command that the container runs to
|
@@ -4937,14 +4991,14 @@ module Aws::ECS
|
|
4937
4991
|
#
|
4938
4992
|
# When you use the Amazon Web Services Management Console JSON panel,
|
4939
4993
|
# the Command Line Interface, or the APIs, enclose the list of
|
4940
|
-
# commands in brackets.
|
4994
|
+
# commands in double quotes and brackets.
|
4941
4995
|
#
|
4942
4996
|
# `[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]`
|
4943
4997
|
#
|
4944
|
-
# You don't
|
4945
|
-
# Services Management Console.
|
4998
|
+
# You don't include the double quotes and brackets when you use the
|
4999
|
+
# Amazon Web Services Management Console.
|
4946
5000
|
#
|
4947
|
-
# `
|
5001
|
+
# ` CMD-SHELL, curl -f http://localhost/ || exit 1`
|
4948
5002
|
#
|
4949
5003
|
# An exit code of 0 indicates success, and non-zero exit code
|
4950
5004
|
# indicates failure. For more information, see `HealthCheck` in the
|
@@ -4978,7 +5032,7 @@ module Aws::ECS
|
|
4978
5032
|
# The optional grace period to provide containers time to bootstrap
|
4979
5033
|
# before failed health checks count towards the maximum number of
|
4980
5034
|
# retries. You can specify between 0 and 300 seconds. By default, the
|
4981
|
-
# `startPeriod` is
|
5035
|
+
# `startPeriod` is off.
|
4982
5036
|
#
|
4983
5037
|
# <note markdown="1"> If a health check succeeds within the `startPeriod`, then the
|
4984
5038
|
# container is considered healthy and any subsequent failures count
|
@@ -5056,7 +5110,11 @@ module Aws::ECS
|
|
5056
5110
|
# @!attribute [rw] device_name
|
5057
5111
|
# The Elastic Inference accelerator device name. The `deviceName` must
|
5058
5112
|
# also be referenced in a container definition as a
|
5059
|
-
# ResourceRequirement.
|
5113
|
+
# [ResourceRequirement][1].
|
5114
|
+
#
|
5115
|
+
#
|
5116
|
+
#
|
5117
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html
|
5060
5118
|
# @return [String]
|
5061
5119
|
#
|
5062
5120
|
# @!attribute [rw] device_type
|
@@ -5240,8 +5298,12 @@ module Aws::ECS
|
|
5240
5298
|
#
|
5241
5299
|
class LimitExceededException < Aws::EmptyStructure; end
|
5242
5300
|
|
5243
|
-
# Linux-specific options that are applied to the container, such as
|
5244
|
-
# Linux KernelCapabilities.
|
5301
|
+
# The Linux-specific options that are applied to the container, such as
|
5302
|
+
# Linux [KernelCapabilities][1].
|
5303
|
+
#
|
5304
|
+
#
|
5305
|
+
#
|
5306
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html
|
5245
5307
|
#
|
5246
5308
|
# @!attribute [rw] capabilities
|
5247
5309
|
# The Linux capabilities for the container that are added to or
|
@@ -5382,9 +5444,9 @@ module Aws::ECS
|
|
5382
5444
|
# @return [String]
|
5383
5445
|
#
|
5384
5446
|
# @!attribute [rw] principal_arn
|
5385
|
-
# The ARN of the principal, which can be
|
5386
|
-
#
|
5387
|
-
#
|
5447
|
+
# The ARN of the principal, which can be a user, role, or the root
|
5448
|
+
# user. If this field is omitted, the account settings are listed only
|
5449
|
+
# for the authenticated user.
|
5388
5450
|
#
|
5389
5451
|
# <note markdown="1"> Federated users assume the account setting of the root user and
|
5390
5452
|
# can't have explicit account settings set for them.
|
@@ -6123,10 +6185,6 @@ module Aws::ECS
|
|
6123
6185
|
|
6124
6186
|
# The load balancer configuration to use with a service or task set.
|
6125
6187
|
#
|
6126
|
-
# For specific notes and restrictions regarding the use of load
|
6127
|
-
# balancers with services and task sets, see the CreateService and
|
6128
|
-
# CreateTaskSet actions.
|
6129
|
-
#
|
6130
6188
|
# When you add, update, or remove a load balancer configuration, Amazon
|
6131
6189
|
# ECS starts a new deployment with the updated Elastic Load Balancing
|
6132
6190
|
# configuration. This causes tasks to register to and deregister from
|
@@ -6384,8 +6442,8 @@ module Aws::ECS
|
|
6384
6442
|
# for the metric. For more information, see [Using managed scaling][1]
|
6385
6443
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
6386
6444
|
#
|
6387
|
-
# If managed scaling is
|
6388
|
-
#
|
6445
|
+
# If managed scaling is off, the user must manage the scaling of the
|
6446
|
+
# Auto Scaling group.
|
6389
6447
|
#
|
6390
6448
|
#
|
6391
6449
|
#
|
@@ -6396,10 +6454,13 @@ module Aws::ECS
|
|
6396
6454
|
# @return [String]
|
6397
6455
|
#
|
6398
6456
|
# @!attribute [rw] target_capacity
|
6399
|
-
# The target capacity
|
6400
|
-
# value must be greater than `0` and less than
|
6401
|
-
#
|
6402
|
-
#
|
6457
|
+
# The target capacity utilization as a percentage for the capacity
|
6458
|
+
# provider. The specified value must be greater than `0` and less than
|
6459
|
+
# or equal to `100`. For example, if you want the capacity provider to
|
6460
|
+
# maintain 10% spare capacity, then that means the utilization is 90%,
|
6461
|
+
# so use a `targetCapacity` of `90`. The default value of `100`
|
6462
|
+
# percent results in the Amazon EC2 instances in your Auto Scaling
|
6463
|
+
# group being completely used.
|
6403
6464
|
# @return [Integer]
|
6404
6465
|
#
|
6405
6466
|
# @!attribute [rw] minimum_scaling_step_size
|
@@ -6455,7 +6516,7 @@ module Aws::ECS
|
|
6455
6516
|
#
|
6456
6517
|
class MissingVersionException < Aws::EmptyStructure; end
|
6457
6518
|
|
6458
|
-
#
|
6519
|
+
# The details for a volume mount point that's used in a container
|
6459
6520
|
# definition.
|
6460
6521
|
#
|
6461
6522
|
# @!attribute [rw] source_volume
|
@@ -6516,7 +6577,7 @@ module Aws::ECS
|
|
6516
6577
|
# The port number range on the container that's bound to the
|
6517
6578
|
# dynamically mapped host port range.
|
6518
6579
|
#
|
6519
|
-
# The following rules apply when you specify a `containerPortRange
|
6580
|
+
# The following rules apply when you specify a `containerPortRange`:
|
6520
6581
|
#
|
6521
6582
|
# * You must use either the `bridge` network mode or the `awsvpc`
|
6522
6583
|
# network mode.
|
@@ -6593,8 +6654,7 @@ module Aws::ECS
|
|
6593
6654
|
include Aws::Structure
|
6594
6655
|
end
|
6595
6656
|
|
6596
|
-
#
|
6597
|
-
# service.
|
6657
|
+
# The network configuration for a task or service.
|
6598
6658
|
#
|
6599
6659
|
# @!attribute [rw] awsvpc_configuration
|
6600
6660
|
# The VPC subnets and security groups that are associated with a task.
|
@@ -6835,10 +6895,14 @@ module Aws::ECS
|
|
6835
6895
|
# port that was previously specified in a running task is also
|
6836
6896
|
# reserved while the task is running. That is, after a task stops, the
|
6837
6897
|
# host port is released. The current reserved ports are displayed in
|
6838
|
-
# the `remainingResources` of DescribeContainerInstances output.
|
6839
|
-
# container instance can have up to 100 reserved ports at a time.
|
6840
|
-
# number includes the default reserved ports. Automatically
|
6841
|
-
# ports aren't included in the 100 reserved ports quota.
|
6898
|
+
# the `remainingResources` of [DescribeContainerInstances][1] output.
|
6899
|
+
# A container instance can have up to 100 reserved ports at a time.
|
6900
|
+
# This number includes the default reserved ports. Automatically
|
6901
|
+
# assigned ports aren't included in the 100 reserved ports quota.
|
6902
|
+
#
|
6903
|
+
#
|
6904
|
+
#
|
6905
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html
|
6842
6906
|
# @return [Integer]
|
6843
6907
|
#
|
6844
6908
|
# @!attribute [rw] protocol
|
@@ -6893,7 +6957,7 @@ module Aws::ECS
|
|
6893
6957
|
# The port number range on the container that's bound to the
|
6894
6958
|
# dynamically mapped host port range.
|
6895
6959
|
#
|
6896
|
-
# The following rules apply when you specify a `containerPortRange
|
6960
|
+
# The following rules apply when you specify a `containerPortRange`:
|
6897
6961
|
#
|
6898
6962
|
# * You must use either the `bridge` network mode or the `awsvpc`
|
6899
6963
|
# network mode.
|
@@ -6973,8 +7037,8 @@ module Aws::ECS
|
|
6973
7037
|
# @return [String]
|
6974
7038
|
#
|
6975
7039
|
# @!attribute [rw] protection_enabled
|
6976
|
-
# The protection status of the task. If scale-in protection is
|
6977
|
-
#
|
7040
|
+
# The protection status of the task. If scale-in protection is on for
|
7041
|
+
# a task, the value is `true`. Otherwise, it is `false`.
|
6978
7042
|
# @return [Boolean]
|
6979
7043
|
#
|
6980
7044
|
# @!attribute [rw] expiration_date
|
@@ -7124,12 +7188,11 @@ module Aws::ECS
|
|
7124
7188
|
# @return [String]
|
7125
7189
|
#
|
7126
7190
|
# @!attribute [rw] principal_arn
|
7127
|
-
# The ARN of the principal, which can be
|
7128
|
-
#
|
7129
|
-
#
|
7130
|
-
#
|
7131
|
-
#
|
7132
|
-
# the authenticated user.
|
7191
|
+
# The ARN of the principal, which can be a user, role, or the root
|
7192
|
+
# user. If you specify the root user, it modifies the account setting
|
7193
|
+
# for all users, roles, and the root user of the account unless a user
|
7194
|
+
# or role explicitly overrides these settings. If this field is
|
7195
|
+
# omitted, the setting is changed only for the authenticated user.
|
7133
7196
|
#
|
7134
7197
|
# <note markdown="1"> Federated users assume the account setting of the root user and
|
7135
7198
|
# can't have explicit account settings set for them.
|
@@ -7843,7 +7906,7 @@ module Aws::ECS
|
|
7843
7906
|
#
|
7844
7907
|
#
|
7845
7908
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html
|
7846
|
-
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html
|
7909
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/url-ecs-dev;ecs-inference.html
|
7847
7910
|
#
|
7848
7911
|
# @!attribute [rw] value
|
7849
7912
|
# The value for the specified resource type.
|
@@ -7855,8 +7918,12 @@ module Aws::ECS
|
|
7855
7918
|
# that the task is launched on.
|
7856
7919
|
#
|
7857
7920
|
# If the `InferenceAccelerator` type is used, the `value` matches the
|
7858
|
-
# `deviceName` for an InferenceAccelerator specified in a task
|
7921
|
+
# `deviceName` for an [InferenceAccelerator][1] specified in a task
|
7859
7922
|
# definition.
|
7923
|
+
#
|
7924
|
+
#
|
7925
|
+
#
|
7926
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html
|
7860
7927
|
# @return [String]
|
7861
7928
|
#
|
7862
7929
|
# @!attribute [rw] type
|
@@ -8072,11 +8139,11 @@ module Aws::ECS
|
|
8072
8139
|
# task definition to run. If a `revision` isn't specified, the latest
|
8073
8140
|
# `ACTIVE` revision is used.
|
8074
8141
|
#
|
8075
|
-
# When you create
|
8076
|
-
#
|
8142
|
+
# When you create a policy for run-task, you can set the resource to
|
8143
|
+
# be the latest task definition revision, or a specific revision.
|
8077
8144
|
#
|
8078
8145
|
# The full ARN value must match the value that you specified as the
|
8079
|
-
# `Resource` of the
|
8146
|
+
# `Resource` of the principal's permissions policy.
|
8080
8147
|
#
|
8081
8148
|
# When you specify the policy resource as the latest task definition
|
8082
8149
|
# version (by setting the `Resource` in the policy to
|
@@ -8260,7 +8327,7 @@ module Aws::ECS
|
|
8260
8327
|
include Aws::Structure
|
8261
8328
|
end
|
8262
8329
|
|
8263
|
-
# Details on a service within a cluster
|
8330
|
+
# Details on a service within a cluster.
|
8264
8331
|
#
|
8265
8332
|
# @!attribute [rw] service_arn
|
8266
8333
|
# The ARN that identifies the service. For more information about the
|
@@ -8735,10 +8802,8 @@ module Aws::ECS
|
|
8735
8802
|
# underscores (\_), and hyphens (-). The name can't start with a
|
8736
8803
|
# hyphen.
|
8737
8804
|
#
|
8738
|
-
# If
|
8739
|
-
#
|
8740
|
-
# specified, the port mapping name from the task definition is used in
|
8741
|
-
# `portName.namespace`.
|
8805
|
+
# If the `discoveryName` isn't specified, the port mapping name from
|
8806
|
+
# the task definition is used in `portName.namespace`.
|
8742
8807
|
# @return [String]
|
8743
8808
|
#
|
8744
8809
|
# @!attribute [rw] client_aliases
|
@@ -8803,10 +8868,8 @@ module Aws::ECS
|
|
8803
8868
|
# underscores (\_), and hyphens (-). The name can't start with a
|
8804
8869
|
# hyphen.
|
8805
8870
|
#
|
8806
|
-
# If
|
8807
|
-
#
|
8808
|
-
# specified, the port mapping name from the task definition is used in
|
8809
|
-
# `portName.namespace`.
|
8871
|
+
# If the `discoveryName` isn't specified, the port mapping name from
|
8872
|
+
# the task definition is used in `portName.namespace`.
|
8810
8873
|
# @return [String]
|
8811
8874
|
#
|
8812
8875
|
# @!attribute [rw] discovery_arn
|
@@ -8959,14 +9022,13 @@ module Aws::ECS
|
|
8959
9022
|
# @return [String]
|
8960
9023
|
#
|
8961
9024
|
# @!attribute [rw] value
|
8962
|
-
# Determines whether the account setting is
|
8963
|
-
#
|
9025
|
+
# Determines whether the account setting is on or off for the
|
9026
|
+
# specified resource.
|
8964
9027
|
# @return [String]
|
8965
9028
|
#
|
8966
9029
|
# @!attribute [rw] principal_arn
|
8967
|
-
# The ARN of the principal. It can be
|
8968
|
-
#
|
8969
|
-
# assumed.
|
9030
|
+
# The ARN of the principal. It can be a user, role, or the root user.
|
9031
|
+
# If this field is omitted, the authenticated user is assumed.
|
8970
9032
|
# @return [String]
|
8971
9033
|
#
|
8972
9034
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Setting AWS API Documentation
|
@@ -9139,7 +9201,7 @@ module Aws::ECS
|
|
9139
9201
|
# @return [String]
|
9140
9202
|
#
|
9141
9203
|
# @!attribute [rw] task
|
9142
|
-
# The task ID
|
9204
|
+
# The task ID of the task to stop.
|
9143
9205
|
# @return [String]
|
9144
9206
|
#
|
9145
9207
|
# @!attribute [rw] reason
|
@@ -10066,9 +10128,13 @@ module Aws::ECS
|
|
10066
10128
|
# @return [Types::RuntimePlatform]
|
10067
10129
|
#
|
10068
10130
|
# @!attribute [rw] requires_compatibilities
|
10069
|
-
# The task launch types the task definition was validated against.
|
10070
|
-
#
|
10071
|
-
#
|
10131
|
+
# The task launch types the task definition was validated against. For
|
10132
|
+
# more information, see [Amazon ECS launch types][1] in the *Amazon
|
10133
|
+
# Elastic Container Service Developer Guide*.
|
10134
|
+
#
|
10135
|
+
#
|
10136
|
+
#
|
10137
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html
|
10072
10138
|
# @return [Array<String>]
|
10073
10139
|
#
|
10074
10140
|
# @!attribute [rw] cpu
|
@@ -10341,10 +10407,10 @@ module Aws::ECS
|
|
10341
10407
|
# @return [Array<Types::InferenceAcceleratorOverride>]
|
10342
10408
|
#
|
10343
10409
|
# @!attribute [rw] execution_role_arn
|
10344
|
-
# The Amazon Resource Name (ARN) of the task execution
|
10345
|
-
#
|
10346
|
-
#
|
10347
|
-
#
|
10410
|
+
# The Amazon Resource Name (ARN) of the task execution role override
|
10411
|
+
# for the task. For more information, see [Amazon ECS task execution
|
10412
|
+
# IAM role][1] in the *Amazon Elastic Container Service Developer
|
10413
|
+
# Guide*.
|
10348
10414
|
#
|
10349
10415
|
#
|
10350
10416
|
#
|
@@ -10356,8 +10422,8 @@ module Aws::ECS
|
|
10356
10422
|
# @return [String]
|
10357
10423
|
#
|
10358
10424
|
# @!attribute [rw] task_role_arn
|
10359
|
-
# The Amazon Resource Name (ARN) of the
|
10360
|
-
#
|
10425
|
+
# The Amazon Resource Name (ARN) of the role that containers in this
|
10426
|
+
# task can assume. All containers in this task are granted the
|
10361
10427
|
# permissions that are specified in this role. For more information,
|
10362
10428
|
# see [IAM Role for Tasks][1] in the *Amazon Elastic Container Service
|
10363
10429
|
# Developer Guide*.
|
@@ -10546,7 +10612,7 @@ module Aws::ECS
|
|
10546
10612
|
# @!attribute [rw] stability_status
|
10547
10613
|
# The stability status. This indicates whether the task set has
|
10548
10614
|
# reached a steady state. If the following conditions are met, the
|
10549
|
-
# task set are in `STEADY_STATE
|
10615
|
+
# task set are in `STEADY_STATE`:
|
10550
10616
|
#
|
10551
10617
|
# * The task `runningCount` is equal to the `computedDesiredCount`.
|
10552
10618
|
#
|
@@ -10675,8 +10741,11 @@ module Aws::ECS
|
|
10675
10741
|
# values set by the operating system with the exception of the `nofile`
|
10676
10742
|
# resource limit parameter which Fargate overrides. The `nofile`
|
10677
10743
|
# resource limit sets a restriction on the number of open files that a
|
10678
|
-
# container can use. The default `nofile` soft limit is `1024` and
|
10679
|
-
# limit is `4096`.
|
10744
|
+
# container can use. The default `nofile` soft limit is `1024` and the
|
10745
|
+
# default hard limit is `4096`.
|
10746
|
+
#
|
10747
|
+
# You can specify the `ulimit` settings for a container in a task
|
10748
|
+
# definition.
|
10680
10749
|
#
|
10681
10750
|
# @!attribute [rw] name
|
10682
10751
|
# The `type` of the `ulimit`.
|
@@ -11297,14 +11366,14 @@ module Aws::ECS
|
|
11297
11366
|
# @!attribute [rw] protected_tasks
|
11298
11367
|
# A list of tasks with the following information.
|
11299
11368
|
#
|
11300
|
-
# * `taskArn
|
11369
|
+
# * `taskArn`: The task ARN.
|
11301
11370
|
#
|
11302
|
-
# * `protectionEnabled
|
11371
|
+
# * `protectionEnabled`: The protection status of the task. If
|
11303
11372
|
# scale-in protection is enabled for a task, the value is `true`.
|
11304
11373
|
# Otherwise, it is `false`.
|
11305
11374
|
#
|
11306
|
-
# * `expirationDate
|
11307
|
-
#
|
11375
|
+
# * `expirationDate`: The epoch time when protection for the task will
|
11376
|
+
# expire.
|
11308
11377
|
# @return [Array<Types::ProtectedTask>]
|
11309
11378
|
#
|
11310
11379
|
# @!attribute [rw] failures
|