aws-sdk-ecs 1.80.0 → 1.81.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ecs.rb +1 -1
- data/lib/aws-sdk-ecs/client.rb +123 -126
- data/lib/aws-sdk-ecs/types.rb +241 -258
- metadata +2 -2
data/lib/aws-sdk-ecs/types.rb
CHANGED
@@ -181,8 +181,8 @@ module Aws::ECS
|
|
181
181
|
# from being terminated during a scale-in action. The Auto Scaling
|
182
182
|
# group and each instance in the Auto Scaling group must have instance
|
183
183
|
# protection from scale-in actions enabled as well. For more
|
184
|
-
# information, see [Instance Protection][1] in the *
|
185
|
-
#
|
184
|
+
# information, see [Instance Protection][1] in the *Auto Scaling User
|
185
|
+
# Guide*.
|
186
186
|
#
|
187
187
|
# When managed termination protection is disabled, your Amazon EC2
|
188
188
|
# instances are not protected from termination when the Auto Scaling
|
@@ -237,8 +237,8 @@ module Aws::ECS
|
|
237
237
|
# from being terminated during a scale-in action. The Auto Scaling
|
238
238
|
# group and each instance in the Auto Scaling group must have instance
|
239
239
|
# protection from scale-in actions enabled as well. For more
|
240
|
-
# information, see [Instance Protection][1] in the *
|
241
|
-
#
|
240
|
+
# information, see [Instance Protection][1] in the *Auto Scaling User
|
241
|
+
# Guide*.
|
242
242
|
#
|
243
243
|
# When managed termination protection is disabled, your Amazon EC2
|
244
244
|
# instances are not protected from termination when the Auto Scaling
|
@@ -305,8 +305,8 @@ module Aws::ECS
|
|
305
305
|
include Aws::Structure
|
306
306
|
end
|
307
307
|
|
308
|
-
# Your
|
309
|
-
# Support][1].
|
308
|
+
# Your Amazon Web Services account has been blocked. For more
|
309
|
+
# information, contact [ Amazon Web Services Support][1].
|
310
310
|
#
|
311
311
|
#
|
312
312
|
#
|
@@ -387,9 +387,9 @@ module Aws::ECS
|
|
387
387
|
#
|
388
388
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
389
389
|
# of such as a prefix for either keys or values as it is reserved
|
390
|
-
# for
|
391
|
-
# this prefix. Tags with this prefix do not count
|
392
|
-
# per resource limit.
|
390
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
391
|
+
# values with this prefix. Tags with this prefix do not count
|
392
|
+
# against your tags per resource limit.
|
393
393
|
# @return [Array<Types::Tag>]
|
394
394
|
#
|
395
395
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CapacityProvider AWS API Documentation
|
@@ -421,10 +421,10 @@ module Aws::ECS
|
|
421
421
|
# capacity providers can be created with the CreateCapacityProvider API
|
422
422
|
# operation.
|
423
423
|
#
|
424
|
-
# To use a
|
425
|
-
#
|
426
|
-
#
|
427
|
-
#
|
424
|
+
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
425
|
+
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
426
|
+
# available to all accounts and only need to be associated with a
|
427
|
+
# cluster to be used in a capacity provider strategy.
|
428
428
|
#
|
429
429
|
# @note When making an API call, you may pass CapacityProviderStrategyItem
|
430
430
|
# data as a hash:
|
@@ -505,7 +505,7 @@ module Aws::ECS
|
|
505
505
|
# @!attribute [rw] cluster_arn
|
506
506
|
# The Amazon Resource Name (ARN) that identifies the cluster. The ARN
|
507
507
|
# contains the `arn:aws:ecs` namespace, followed by the Region of the
|
508
|
-
# cluster, the
|
508
|
+
# cluster, the account ID of the cluster owner, the `cluster`
|
509
509
|
# namespace, and then the cluster name. For example,
|
510
510
|
# `arn:aws:ecs:region:012345678910:cluster/test`.
|
511
511
|
# @return [String]
|
@@ -615,9 +615,9 @@ module Aws::ECS
|
|
615
615
|
#
|
616
616
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
617
617
|
# of such as a prefix for either keys or values as it is reserved
|
618
|
-
# for
|
619
|
-
# this prefix. Tags with this prefix do not count
|
620
|
-
# per resource limit.
|
618
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
619
|
+
# values with this prefix. Tags with this prefix do not count
|
620
|
+
# against your tags per resource limit.
|
621
621
|
# @return [Array<Types::Tag>]
|
622
622
|
#
|
623
623
|
# @!attribute [rw] settings
|
@@ -1635,7 +1635,7 @@ module Aws::ECS
|
|
1635
1635
|
# `--privileged` option to [docker run][3].
|
1636
1636
|
#
|
1637
1637
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
1638
|
-
# on
|
1638
|
+
# on Fargate.
|
1639
1639
|
#
|
1640
1640
|
# </note>
|
1641
1641
|
#
|
@@ -2054,16 +2054,17 @@ module Aws::ECS
|
|
2054
2054
|
# @!attribute [rw] container_instance_arn
|
2055
2055
|
# The Amazon Resource Name (ARN) of the container instance. The ARN
|
2056
2056
|
# contains the `arn:aws:ecs` namespace, followed by the Region of the
|
2057
|
-
# container instance, the
|
2058
|
-
#
|
2059
|
-
#
|
2057
|
+
# container instance, the account ID of the container instance owner,
|
2058
|
+
# the `container-instance` namespace, and then the container instance
|
2059
|
+
# ID. For example,
|
2060
2060
|
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
2061
2061
|
# @return [String]
|
2062
2062
|
#
|
2063
2063
|
# @!attribute [rw] ec2_instance_id
|
2064
2064
|
# The ID of the container instance. For Amazon EC2 instances, this
|
2065
2065
|
# value is the Amazon EC2 instance ID. For external instances, this
|
2066
|
-
# value is the
|
2066
|
+
# value is the Amazon Web Services Systems Manager managed instance
|
2067
|
+
# ID.
|
2067
2068
|
# @return [String]
|
2068
2069
|
#
|
2069
2070
|
# @!attribute [rw] capacity_provider_name
|
@@ -2204,9 +2205,9 @@ module Aws::ECS
|
|
2204
2205
|
#
|
2205
2206
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
2206
2207
|
# of such as a prefix for either keys or values as it is reserved
|
2207
|
-
# for
|
2208
|
-
# this prefix. Tags with this prefix do not count
|
2209
|
-
# per resource limit.
|
2208
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
2209
|
+
# values with this prefix. Tags with this prefix do not count
|
2210
|
+
# against your tags per resource limit.
|
2210
2211
|
# @return [Array<Types::Tag>]
|
2211
2212
|
#
|
2212
2213
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerInstance AWS API Documentation
|
@@ -2457,9 +2458,9 @@ module Aws::ECS
|
|
2457
2458
|
#
|
2458
2459
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
2459
2460
|
# of such as a prefix for either keys or values as it is reserved
|
2460
|
-
# for
|
2461
|
-
# this prefix. Tags with this prefix do not count
|
2462
|
-
# per resource limit.
|
2461
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
2462
|
+
# values with this prefix. Tags with this prefix do not count
|
2463
|
+
# against your tags per resource limit.
|
2463
2464
|
# @return [Array<Types::Tag>]
|
2464
2465
|
#
|
2465
2466
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateCapacityProviderRequest AWS API Documentation
|
@@ -2557,9 +2558,9 @@ module Aws::ECS
|
|
2557
2558
|
#
|
2558
2559
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
2559
2560
|
# of such as a prefix for either keys or values as it is reserved
|
2560
|
-
# for
|
2561
|
-
# this prefix. Tags with this prefix do not count
|
2562
|
-
# per resource limit.
|
2561
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
2562
|
+
# values with this prefix. Tags with this prefix do not count
|
2563
|
+
# against your tags per resource limit.
|
2563
2564
|
# @return [Array<Types::Tag>]
|
2564
2565
|
#
|
2565
2566
|
# @!attribute [rw] settings
|
@@ -2586,10 +2587,10 @@ module Aws::ECS
|
|
2586
2587
|
# providers can be created with the CreateCapacityProvider API
|
2587
2588
|
# operation.
|
2588
2589
|
#
|
2589
|
-
# To use a
|
2590
|
-
#
|
2591
|
-
#
|
2592
|
-
#
|
2590
|
+
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
2591
|
+
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
2592
|
+
# are available to all accounts and only need to be associated with a
|
2593
|
+
# cluster to be used.
|
2593
2594
|
#
|
2594
2595
|
# The PutClusterCapacityProviders API operation is used to update the
|
2595
2596
|
# list of available capacity providers for a cluster after the cluster
|
@@ -2749,15 +2750,15 @@ module Aws::ECS
|
|
2749
2750
|
#
|
2750
2751
|
# If the service is using the `CODE_DEPLOY` deployment controller, the
|
2751
2752
|
# service is required to use either an Application Load Balancer or
|
2752
|
-
# Network Load Balancer. When creating an
|
2753
|
-
#
|
2754
|
-
#
|
2755
|
-
#
|
2756
|
-
#
|
2757
|
-
#
|
2758
|
-
#
|
2759
|
-
#
|
2760
|
-
#
|
2753
|
+
# Network Load Balancer. When creating an CodeDeploy deployment group,
|
2754
|
+
# you specify two target groups (referred to as a `targetGroupPair`).
|
2755
|
+
# During a deployment, CodeDeploy determines which task set in your
|
2756
|
+
# service has the status `PRIMARY` and associates one target group
|
2757
|
+
# with it, and then associates the other target group with the
|
2758
|
+
# replacement task set. The load balancer can also have up to two
|
2759
|
+
# listeners: a required listener for production traffic and an
|
2760
|
+
# optional listener that allows you perform validation tests with
|
2761
|
+
# Lambda functions before routing production traffic to it.
|
2761
2762
|
#
|
2762
2763
|
# After you create a service using the `ECS` deployment controller,
|
2763
2764
|
# the load balancer name or target group ARN, container name, and
|
@@ -2829,13 +2830,12 @@ module Aws::ECS
|
|
2829
2830
|
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
2830
2831
|
# Container Service Developer Guide*.
|
2831
2832
|
#
|
2832
|
-
# The `FARGATE` launch type runs your tasks on
|
2833
|
+
# The `FARGATE` launch type runs your tasks on Fargate On-Demand
|
2833
2834
|
# infrastructure.
|
2834
2835
|
#
|
2835
2836
|
# <note markdown="1"> Fargate Spot infrastructure is available for use but a capacity
|
2836
|
-
# provider strategy must be used. For more information, see [
|
2837
|
-
#
|
2838
|
-
# Fargate*.
|
2837
|
+
# provider strategy must be used. For more information, see [Fargate
|
2838
|
+
# capacity providers][2] in the *Amazon ECS User Guide for Fargate*.
|
2839
2839
|
#
|
2840
2840
|
# </note>
|
2841
2841
|
#
|
@@ -2868,7 +2868,7 @@ module Aws::ECS
|
|
2868
2868
|
# The platform version that your tasks in the service are running on.
|
2869
2869
|
# A platform version is specified only for tasks using the Fargate
|
2870
2870
|
# launch type. If one isn't specified, the `LATEST` platform version
|
2871
|
-
# is used by default. For more information, see [
|
2871
|
+
# is used by default. For more information, see [Fargate platform
|
2872
2872
|
# versions][1] in the *Amazon Elastic Container Service Developer
|
2873
2873
|
# Guide*.
|
2874
2874
|
#
|
@@ -3022,9 +3022,9 @@ module Aws::ECS
|
|
3022
3022
|
#
|
3023
3023
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
3024
3024
|
# of such as a prefix for either keys or values as it is reserved
|
3025
|
-
# for
|
3026
|
-
# this prefix. Tags with this prefix do not count
|
3027
|
-
# per resource limit.
|
3025
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
3026
|
+
# values with this prefix. Tags with this prefix do not count
|
3027
|
+
# against your tags per resource limit.
|
3028
3028
|
# @return [Array<Types::Tag>]
|
3029
3029
|
#
|
3030
3030
|
# @!attribute [rw] enable_ecs_managed_tags
|
@@ -3084,6 +3084,10 @@ module Aws::ECS
|
|
3084
3084
|
# @!attribute [rw] service
|
3085
3085
|
# The full description of your service following the create call.
|
3086
3086
|
#
|
3087
|
+
# A service will return either a `capacityProviderStrategy` or
|
3088
|
+
# `launchType` parameter, but not both, depending on which one was
|
3089
|
+
# specified during creation.
|
3090
|
+
#
|
3087
3091
|
# If a service is using the `ECS` deployment controller, the
|
3088
3092
|
# `deploymentController` and `taskSets` parameters will not be
|
3089
3093
|
# returned.
|
@@ -3169,8 +3173,8 @@ module Aws::ECS
|
|
3169
3173
|
# An optional non-unique tag that identifies this task set in external
|
3170
3174
|
# systems. If the task set is associated with a service discovery
|
3171
3175
|
# registry, the tasks in this task set will have the
|
3172
|
-
# `ECS_TASK_SET_EXTERNAL_ID`
|
3173
|
-
#
|
3176
|
+
# `ECS_TASK_SET_EXTERNAL_ID` Cloud Map attribute set to the provided
|
3177
|
+
# value.
|
3174
3178
|
# @return [String]
|
3175
3179
|
#
|
3176
3180
|
# @!attribute [rw] task_definition
|
@@ -3229,10 +3233,10 @@ module Aws::ECS
|
|
3229
3233
|
# providers can be created with the CreateCapacityProvider API
|
3230
3234
|
# operation.
|
3231
3235
|
#
|
3232
|
-
# To use a
|
3233
|
-
#
|
3234
|
-
#
|
3235
|
-
#
|
3236
|
+
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
3237
|
+
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
3238
|
+
# are available to all accounts and only need to be associated with a
|
3239
|
+
# cluster to be used.
|
3236
3240
|
#
|
3237
3241
|
# The PutClusterCapacityProviders API operation is used to update the
|
3238
3242
|
# list of available capacity providers for a cluster after the cluster
|
@@ -3283,9 +3287,9 @@ module Aws::ECS
|
|
3283
3287
|
#
|
3284
3288
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
3285
3289
|
# of such as a prefix for either keys or values as it is reserved
|
3286
|
-
# for
|
3287
|
-
# this prefix. Tags with this prefix do not count
|
3288
|
-
# per resource limit.
|
3290
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
3291
|
+
# values with this prefix. Tags with this prefix do not count
|
3292
|
+
# against your tags per resource limit.
|
3289
3293
|
# @return [Array<Types::Tag>]
|
3290
3294
|
#
|
3291
3295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateTaskSetRequest AWS API Documentation
|
@@ -3309,10 +3313,10 @@ module Aws::ECS
|
|
3309
3313
|
end
|
3310
3314
|
|
3311
3315
|
# @!attribute [rw] task_set
|
3312
|
-
# Information about a set of Amazon ECS tasks in either an
|
3313
|
-
#
|
3314
|
-
#
|
3315
|
-
#
|
3316
|
+
# Information about a set of Amazon ECS tasks in either an CodeDeploy
|
3317
|
+
# or an `EXTERNAL` deployment. A task set includes details such as the
|
3318
|
+
# desired number of tasks, how many tasks are running, and whether the
|
3319
|
+
# task set serves production traffic.
|
3316
3320
|
# @return [Types::TaskSet]
|
3317
3321
|
#
|
3318
3322
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateTaskSetResponse AWS API Documentation
|
@@ -3670,7 +3674,7 @@ module Aws::ECS
|
|
3670
3674
|
# The platform version on which your tasks in the service are running.
|
3671
3675
|
# A platform version is only specified for tasks using the Fargate
|
3672
3676
|
# launch type. If one is not specified, the `LATEST` platform version
|
3673
|
-
# is used by default. For more information, see [
|
3677
|
+
# is used by default. For more information, see [Fargate Platform
|
3674
3678
|
# Versions][1] in the *Amazon Elastic Container Service Developer
|
3675
3679
|
# Guide*.
|
3676
3680
|
#
|
@@ -3897,9 +3901,9 @@ module Aws::ECS
|
|
3897
3901
|
# CODE\_DEPLOY
|
3898
3902
|
#
|
3899
3903
|
# : The blue/green (`CODE_DEPLOY`) deployment type uses the blue/green
|
3900
|
-
# deployment model powered by
|
3901
|
-
#
|
3902
|
-
#
|
3904
|
+
# deployment model powered by CodeDeploy, which allows you to verify
|
3905
|
+
# a new deployment of a service before sending production traffic to
|
3906
|
+
# it.
|
3903
3907
|
#
|
3904
3908
|
# EXTERNAL
|
3905
3909
|
#
|
@@ -3934,7 +3938,7 @@ module Aws::ECS
|
|
3934
3938
|
# @!attribute [rw] container_instance
|
3935
3939
|
# The container instance ID or full ARN of the container instance to
|
3936
3940
|
# deregister. The ARN contains the `arn:aws:ecs` namespace, followed
|
3937
|
-
# by the Region of the container instance, the
|
3941
|
+
# by the Region of the container instance, the account ID of the
|
3938
3942
|
# container instance owner, the `container-instance` namespace, and
|
3939
3943
|
# then the container instance ID. For example,
|
3940
3944
|
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
@@ -4327,9 +4331,9 @@ module Aws::ECS
|
|
4327
4331
|
#
|
4328
4332
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
4329
4333
|
# of such as a prefix for either keys or values as it is reserved
|
4330
|
-
# for
|
4331
|
-
# this prefix. Tags with this prefix do not count
|
4332
|
-
# per resource limit.
|
4334
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
4335
|
+
# values with this prefix. Tags with this prefix do not count
|
4336
|
+
# against your tags per resource limit.
|
4333
4337
|
# @return [Array<Types::Tag>]
|
4334
4338
|
#
|
4335
4339
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskDefinitionResponse AWS API Documentation
|
@@ -4499,7 +4503,7 @@ module Aws::ECS
|
|
4499
4503
|
# @!attribute [rw] container_instance
|
4500
4504
|
# The container instance ID or full ARN of the container instance. The
|
4501
4505
|
# ARN contains the `arn:aws:ecs` namespace, followed by the Region of
|
4502
|
-
# the container instance, the
|
4506
|
+
# the container instance, the account ID of the container instance
|
4503
4507
|
# owner, the `container-instance` namespace, and then the container
|
4504
4508
|
# instance ID. For example,
|
4505
4509
|
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
@@ -4811,11 +4815,11 @@ module Aws::ECS
|
|
4811
4815
|
|
4812
4816
|
# The amount of ephemeral storage to allocate for the task. This
|
4813
4817
|
# parameter is used to expand the total amount of ephemeral storage
|
4814
|
-
# available, beyond the default amount, for tasks hosted on
|
4815
|
-
#
|
4816
|
-
# User Guide for
|
4818
|
+
# available, beyond the default amount, for tasks hosted on Fargate. For
|
4819
|
+
# more information, see [Fargate task storage][1] in the *Amazon ECS
|
4820
|
+
# User Guide for Fargate*.
|
4817
4821
|
#
|
4818
|
-
# <note markdown="1"> This parameter is only supported for tasks hosted on
|
4822
|
+
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
|
4819
4823
|
# platform version `1.4.0` or later.
|
4820
4824
|
#
|
4821
4825
|
# </note>
|
@@ -4863,8 +4867,8 @@ module Aws::ECS
|
|
4863
4867
|
# }
|
4864
4868
|
#
|
4865
4869
|
# @!attribute [rw] kms_key_id
|
4866
|
-
# Specify an
|
4867
|
-
#
|
4870
|
+
# Specify an Key Management Service key ID to encrypt the data between
|
4871
|
+
# the local client and the container.
|
4868
4872
|
# @return [String]
|
4869
4873
|
#
|
4870
4874
|
# @!attribute [rw] logging
|
@@ -5069,14 +5073,14 @@ module Aws::ECS
|
|
5069
5073
|
# @!attribute [rw] credentials_parameter
|
5070
5074
|
# The authorization credential option to use. The authorization
|
5071
5075
|
# credential options can be provided using either the Amazon Resource
|
5072
|
-
# Name (ARN) of an
|
5073
|
-
#
|
5076
|
+
# Name (ARN) of an Secrets Manager secret or SSM Parameter Store
|
5077
|
+
# parameter. The ARNs refer to the stored credentials.
|
5074
5078
|
# @return [String]
|
5075
5079
|
#
|
5076
5080
|
# @!attribute [rw] domain
|
5077
|
-
# A fully qualified domain name hosted by an [
|
5078
|
-
#
|
5079
|
-
#
|
5081
|
+
# A fully qualified domain name hosted by an [Directory Service][1]
|
5082
|
+
# Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon
|
5083
|
+
# EC2.
|
5080
5084
|
#
|
5081
5085
|
#
|
5082
5086
|
#
|
@@ -5204,8 +5208,8 @@ module Aws::ECS
|
|
5204
5208
|
# FireLens Configuration][1] in the *Amazon Elastic Container Service
|
5205
5209
|
# Developer Guide*.
|
5206
5210
|
#
|
5207
|
-
# <note markdown="1"> Tasks hosted on
|
5208
|
-
#
|
5211
|
+
# <note markdown="1"> Tasks hosted on Fargate only support the `file` configuration file
|
5212
|
+
# type.
|
5209
5213
|
#
|
5210
5214
|
# </note>
|
5211
5215
|
#
|
@@ -5269,7 +5273,7 @@ module Aws::ECS
|
|
5269
5273
|
#
|
5270
5274
|
# * Container health checks are supported for Fargate tasks if you are
|
5271
5275
|
# using platform version 1.1.0 or greater. For more information, see
|
5272
|
-
# [
|
5276
|
+
# [Fargate Platform Versions][2].
|
5273
5277
|
#
|
5274
5278
|
# * Container health checks are not supported for tasks that are part of
|
5275
5279
|
# a service that is configured to use a Classic Load Balancer.
|
@@ -5517,7 +5521,7 @@ module Aws::ECS
|
|
5517
5521
|
# `CapAdd` in the [Create a container][1] section of the [Docker
|
5518
5522
|
# Remote API][2] and the `--cap-add` option to [docker run][3].
|
5519
5523
|
#
|
5520
|
-
# <note markdown="1"> Tasks launched on
|
5524
|
+
# <note markdown="1"> Tasks launched on Fargate only support adding the `SYS_PTRACE`
|
5521
5525
|
# kernel capability.
|
5522
5526
|
#
|
5523
5527
|
# </note>
|
@@ -6651,7 +6655,7 @@ module Aws::ECS
|
|
6651
6655
|
# configuration][5] in the *Amazon Elastic Container Service Developer
|
6652
6656
|
# Guide*.
|
6653
6657
|
#
|
6654
|
-
# * For tasks on
|
6658
|
+
# * For tasks on Fargate, because you do not have access to the
|
6655
6659
|
# underlying infrastructure your tasks are hosted on, any additional
|
6656
6660
|
# software needed will have to be installed outside of the task. For
|
6657
6661
|
# example, the Fluentd output aggregators or a remote host running
|
@@ -6684,7 +6688,7 @@ module Aws::ECS
|
|
6684
6688
|
# @!attribute [rw] log_driver
|
6685
6689
|
# The log driver to use for the container.
|
6686
6690
|
#
|
6687
|
-
# For tasks on
|
6691
|
+
# For tasks on Fargate, the supported log drivers are `awslogs`,
|
6688
6692
|
# `splunk`, and `awsfirelens`.
|
6689
6693
|
#
|
6690
6694
|
# For tasks hosted on Amazon EC2 instances, the supported log drivers
|
@@ -7542,10 +7546,10 @@ module Aws::ECS
|
|
7542
7546
|
# providers can be created with the CreateCapacityProvider API
|
7543
7547
|
# operation.
|
7544
7548
|
#
|
7545
|
-
# To use a
|
7546
|
-
#
|
7547
|
-
#
|
7548
|
-
#
|
7549
|
+
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
7550
|
+
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
7551
|
+
# are available to all accounts and only need to be associated with a
|
7552
|
+
# cluster to be used.
|
7549
7553
|
# @return [Array<String>]
|
7550
7554
|
#
|
7551
7555
|
# @!attribute [rw] default_capacity_provider_strategy
|
@@ -7567,10 +7571,10 @@ module Aws::ECS
|
|
7567
7571
|
# providers can be created with the CreateCapacityProvider API
|
7568
7572
|
# operation.
|
7569
7573
|
#
|
7570
|
-
# To use a
|
7571
|
-
#
|
7572
|
-
#
|
7573
|
-
#
|
7574
|
+
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
7575
|
+
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
7576
|
+
# are available to all accounts and only need to be associated with a
|
7577
|
+
# cluster to be used.
|
7574
7578
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
7575
7579
|
#
|
7576
7580
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutClusterCapacityProvidersRequest AWS API Documentation
|
@@ -7709,9 +7713,9 @@ module Aws::ECS
|
|
7709
7713
|
#
|
7710
7714
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
7711
7715
|
# of such as a prefix for either keys or values as it is reserved
|
7712
|
-
# for
|
7713
|
-
# this prefix. Tags with this prefix do not count
|
7714
|
-
# per resource limit.
|
7716
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
7717
|
+
# values with this prefix. Tags with this prefix do not count
|
7718
|
+
# against your tags per resource limit.
|
7715
7719
|
# @return [Array<Types::Tag>]
|
7716
7720
|
#
|
7717
7721
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterContainerInstanceRequest AWS API Documentation
|
@@ -7997,11 +8001,11 @@ module Aws::ECS
|
|
7997
8001
|
#
|
7998
8002
|
# @!attribute [rw] execution_role_arn
|
7999
8003
|
# The Amazon Resource Name (ARN) of the task execution role that
|
8000
|
-
# grants the Amazon ECS container agent permission to make
|
8001
|
-
# calls on your behalf. The task execution IAM role is
|
8002
|
-
# depending on the requirements of your task. For more
|
8003
|
-
# see [Amazon ECS task execution IAM role][1] in the
|
8004
|
-
# Container Service Developer Guide*.
|
8004
|
+
# grants the Amazon ECS container agent permission to make Amazon Web
|
8005
|
+
# Services API calls on your behalf. The task execution IAM role is
|
8006
|
+
# required depending on the requirements of your task. For more
|
8007
|
+
# information, see [Amazon ECS task execution IAM role][1] in the
|
8008
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
8005
8009
|
#
|
8006
8010
|
#
|
8007
8011
|
#
|
@@ -8014,13 +8018,15 @@ module Aws::ECS
|
|
8014
8018
|
# network mode is specified, the default is `bridge`.
|
8015
8019
|
#
|
8016
8020
|
# For Amazon ECS tasks on Fargate, the `awsvpc` network mode is
|
8017
|
-
# required. For Amazon ECS tasks on Amazon EC2 instances, any
|
8018
|
-
# mode can be used.
|
8019
|
-
#
|
8020
|
-
#
|
8021
|
-
#
|
8022
|
-
#
|
8023
|
-
#
|
8021
|
+
# required. For Amazon ECS tasks on Amazon EC2 Linux instances, any
|
8022
|
+
# network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows
|
8023
|
+
# instances, `<default>` or `awsvpc` can be used. If the network mode
|
8024
|
+
# is set to `none`, you cannot specify port mappings in your container
|
8025
|
+
# definitions, and the tasks containers do not have external
|
8026
|
+
# connectivity. The `host` and `awsvpc` network modes offer the
|
8027
|
+
# highest networking performance for containers because they use the
|
8028
|
+
# EC2 network stack instead of the virtualized network stack provided
|
8029
|
+
# by the `bridge` mode.
|
8024
8030
|
#
|
8025
8031
|
# With the `host` and `awsvpc` network modes, exposed container ports
|
8026
8032
|
# are mapped directly to the corresponding host port (for the `host`
|
@@ -8038,22 +8044,10 @@ module Aws::ECS
|
|
8038
8044
|
# For more information, see [Task Networking][1] in the *Amazon
|
8039
8045
|
# Elastic Container Service Developer Guide*.
|
8040
8046
|
#
|
8041
|
-
# <note markdown="1"> Currently, only Amazon ECS-optimized AMIs, other Amazon Linux
|
8042
|
-
# variants with the `ecs-init` package, or AWS Fargate infrastructure
|
8043
|
-
# support the `awsvpc` network mode.
|
8044
|
-
#
|
8045
|
-
# </note>
|
8046
|
-
#
|
8047
8047
|
# If the network mode is `host`, you cannot run multiple
|
8048
8048
|
# instantiations of the same task on a single container instance when
|
8049
8049
|
# port mappings are used.
|
8050
8050
|
#
|
8051
|
-
# Docker for Windows uses different network modes than Docker for
|
8052
|
-
# Linux. When you register a task definition with Windows containers,
|
8053
|
-
# you must not specify a network mode. If you use the console to
|
8054
|
-
# register a task definition with Windows containers, you must choose
|
8055
|
-
# the `<default>` network mode object.
|
8056
|
-
#
|
8057
8051
|
# For more information, see [Network settings][2] in the *Docker run
|
8058
8052
|
# reference*.
|
8059
8053
|
#
|
@@ -8187,9 +8181,9 @@ module Aws::ECS
|
|
8187
8181
|
#
|
8188
8182
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
8189
8183
|
# of such as a prefix for either keys or values as it is reserved
|
8190
|
-
# for
|
8191
|
-
# this prefix. Tags with this prefix do not count
|
8192
|
-
# per resource limit.
|
8184
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
8185
|
+
# values with this prefix. Tags with this prefix do not count
|
8186
|
+
# against your tags per resource limit.
|
8193
8187
|
# @return [Array<Types::Tag>]
|
8194
8188
|
#
|
8195
8189
|
# @!attribute [rw] pid_mode
|
@@ -8207,7 +8201,7 @@ module Aws::ECS
|
|
8207
8201
|
# see [Docker security][2].
|
8208
8202
|
#
|
8209
8203
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
8210
|
-
# on
|
8204
|
+
# on Fargate.
|
8211
8205
|
#
|
8212
8206
|
# </note>
|
8213
8207
|
#
|
@@ -8248,7 +8242,7 @@ module Aws::ECS
|
|
8248
8242
|
# `systemControls` will apply to all containers within a task.
|
8249
8243
|
#
|
8250
8244
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
8251
|
-
# on
|
8245
|
+
# on Fargate.
|
8252
8246
|
#
|
8253
8247
|
# </note>
|
8254
8248
|
#
|
@@ -8284,12 +8278,12 @@ module Aws::ECS
|
|
8284
8278
|
# @!attribute [rw] ephemeral_storage
|
8285
8279
|
# The amount of ephemeral storage to allocate for the task. This
|
8286
8280
|
# parameter is used to expand the total amount of ephemeral storage
|
8287
|
-
# available, beyond the default amount, for tasks hosted on
|
8288
|
-
#
|
8289
|
-
#
|
8281
|
+
# available, beyond the default amount, for tasks hosted on Fargate.
|
8282
|
+
# For more information, see [Fargate task storage][1] in the *Amazon
|
8283
|
+
# ECS User Guide for Fargate*.
|
8290
8284
|
#
|
8291
|
-
# <note markdown="1"> This parameter is only supported for tasks hosted on
|
8292
|
-
#
|
8285
|
+
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
|
8286
|
+
# platform version `1.4.0` or later.
|
8293
8287
|
#
|
8294
8288
|
# </note>
|
8295
8289
|
#
|
@@ -8351,11 +8345,11 @@ module Aws::ECS
|
|
8351
8345
|
# The Amazon Resource Name (ARN) of the secret containing the private
|
8352
8346
|
# repository credentials.
|
8353
8347
|
#
|
8354
|
-
# <note markdown="1"> When you are using the Amazon ECS API,
|
8355
|
-
# secret exists in the same Region as the task that you
|
8356
|
-
# then you can use either the full ARN or the name of
|
8357
|
-
# you are using the
|
8358
|
-
# ARN of the secret.
|
8348
|
+
# <note markdown="1"> When you are using the Amazon ECS API, CLI, or Amazon Web Services
|
8349
|
+
# SDK, if the secret exists in the same Region as the task that you
|
8350
|
+
# are launching then you can use either the full ARN or the name of
|
8351
|
+
# the secret. When you are using the Amazon Web Services Management
|
8352
|
+
# Console, you must specify the full ARN of the secret.
|
8359
8353
|
#
|
8360
8354
|
# </note>
|
8361
8355
|
# @return [String]
|
@@ -8582,6 +8576,9 @@ module Aws::ECS
|
|
8582
8576
|
# parameter must be omitted. If no `capacityProviderStrategy` or
|
8583
8577
|
# `launchType` is specified, the `defaultCapacityProviderStrategy` for
|
8584
8578
|
# the cluster is used.
|
8579
|
+
#
|
8580
|
+
# When you use cluster auto scaling, you must specify
|
8581
|
+
# `capacityProviderStrategy` and not `launchType`.
|
8585
8582
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
8586
8583
|
#
|
8587
8584
|
# @!attribute [rw] cluster
|
@@ -8622,13 +8619,12 @@ module Aws::ECS
|
|
8622
8619
|
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
8623
8620
|
# Container Service Developer Guide*.
|
8624
8621
|
#
|
8625
|
-
# The `FARGATE` launch type runs your tasks on
|
8622
|
+
# The `FARGATE` launch type runs your tasks on Fargate On-Demand
|
8626
8623
|
# infrastructure.
|
8627
8624
|
#
|
8628
8625
|
# <note markdown="1"> Fargate Spot infrastructure is available for use but a capacity
|
8629
|
-
# provider strategy must be used. For more information, see [
|
8630
|
-
#
|
8631
|
-
# Fargate*.
|
8626
|
+
# provider strategy must be used. For more information, see [Fargate
|
8627
|
+
# capacity providers][2] in the *Amazon ECS User Guide for Fargate*.
|
8632
8628
|
#
|
8633
8629
|
# </note>
|
8634
8630
|
#
|
@@ -8642,6 +8638,9 @@ module Aws::ECS
|
|
8642
8638
|
# If a `launchType` is specified, the `capacityProviderStrategy`
|
8643
8639
|
# parameter must be omitted.
|
8644
8640
|
#
|
8641
|
+
# When you use cluster auto scaling, you must specify
|
8642
|
+
# `capacityProviderStrategy` and not `launchType`.
|
8643
|
+
#
|
8645
8644
|
#
|
8646
8645
|
#
|
8647
8646
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html
|
@@ -8691,8 +8690,8 @@ module Aws::ECS
|
|
8691
8690
|
# The platform version the task should run. A platform version is only
|
8692
8691
|
# specified for tasks using the Fargate launch type. If one is not
|
8693
8692
|
# specified, the `LATEST` platform version is used by default. For
|
8694
|
-
# more information, see [
|
8695
|
-
#
|
8693
|
+
# more information, see [Fargate Platform Versions][1] in the *Amazon
|
8694
|
+
# Elastic Container Service Developer Guide*.
|
8696
8695
|
#
|
8697
8696
|
#
|
8698
8697
|
#
|
@@ -8754,9 +8753,9 @@ module Aws::ECS
|
|
8754
8753
|
#
|
8755
8754
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
8756
8755
|
# of such as a prefix for either keys or values as it is reserved
|
8757
|
-
# for
|
8758
|
-
# this prefix. Tags with this prefix do not count
|
8759
|
-
# per resource limit.
|
8756
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
8757
|
+
# values with this prefix. Tags with this prefix do not count
|
8758
|
+
# against your tags per resource limit.
|
8760
8759
|
# @return [Array<Types::Tag>]
|
8761
8760
|
#
|
8762
8761
|
# @!attribute [rw] task_definition
|
@@ -8867,13 +8866,13 @@ module Aws::ECS
|
|
8867
8866
|
#
|
8868
8867
|
# @!attribute [rw] value_from
|
8869
8868
|
# The secret to expose to the container. The supported values are
|
8870
|
-
# either the full ARN of the
|
8871
|
-
#
|
8869
|
+
# either the full ARN of the Secrets Manager secret or the full ARN of
|
8870
|
+
# the parameter in the SSM Parameter Store.
|
8872
8871
|
#
|
8873
|
-
# <note markdown="1"> If the
|
8874
|
-
#
|
8875
|
-
#
|
8876
|
-
#
|
8872
|
+
# <note markdown="1"> If the SSM Parameter Store parameter exists in the same Region as
|
8873
|
+
# the task you are launching, then you can use either the full ARN or
|
8874
|
+
# name of the parameter. If the parameter exists in a different
|
8875
|
+
# Region, then the full ARN must be specified.
|
8877
8876
|
#
|
8878
8877
|
# </note>
|
8879
8878
|
# @return [String]
|
@@ -8905,8 +8904,8 @@ module Aws::ECS
|
|
8905
8904
|
# @!attribute [rw] service_arn
|
8906
8905
|
# The ARN that identifies the service. The ARN contains the
|
8907
8906
|
# `arn:aws:ecs` namespace, followed by the Region of the service, the
|
8908
|
-
#
|
8909
|
-
#
|
8907
|
+
# account ID of the service owner, the `service` namespace, and then
|
8908
|
+
# the service name. For example,
|
8910
8909
|
# `arn:aws:ecs:region:012345678910:service/my-service`.
|
8911
8910
|
# @return [String]
|
8912
8911
|
#
|
@@ -8960,26 +8959,23 @@ module Aws::ECS
|
|
8960
8959
|
# @return [Integer]
|
8961
8960
|
#
|
8962
8961
|
# @!attribute [rw] launch_type
|
8963
|
-
# The
|
8964
|
-
#
|
8965
|
-
#
|
8966
|
-
#
|
8967
|
-
#
|
8968
|
-
#
|
8969
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html
|
8962
|
+
# The launch type the service is using. When using the
|
8963
|
+
# DescribeServices API, this field is omitted if the service was
|
8964
|
+
# created using a capacity provider strategy.
|
8970
8965
|
# @return [String]
|
8971
8966
|
#
|
8972
8967
|
# @!attribute [rw] capacity_provider_strategy
|
8973
|
-
# The capacity provider strategy
|
8968
|
+
# The capacity provider strategy the service is using. When using the
|
8969
|
+
# DescribeServices API, this field is omitted if the service was
|
8970
|
+
# created using a launch type.
|
8974
8971
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
8975
8972
|
#
|
8976
8973
|
# @!attribute [rw] platform_version
|
8977
8974
|
# The platform version on which to run your service. A platform
|
8978
|
-
# version is only specified for tasks
|
8979
|
-
#
|
8980
|
-
#
|
8981
|
-
#
|
8982
|
-
# Guide*.
|
8975
|
+
# version is only specified for tasks hosted on Fargate. If one is not
|
8976
|
+
# specified, the `LATEST` platform version is used by default. For
|
8977
|
+
# more information, see [Fargate Platform Versions][1] in the *Amazon
|
8978
|
+
# Elastic Container Service Developer Guide*.
|
8983
8979
|
#
|
8984
8980
|
#
|
8985
8981
|
#
|
@@ -8999,10 +8995,10 @@ module Aws::ECS
|
|
8999
8995
|
# @return [Types::DeploymentConfiguration]
|
9000
8996
|
#
|
9001
8997
|
# @!attribute [rw] task_sets
|
9002
|
-
# Information about a set of Amazon ECS tasks in either an
|
9003
|
-
#
|
9004
|
-
#
|
9005
|
-
#
|
8998
|
+
# Information about a set of Amazon ECS tasks in either an CodeDeploy
|
8999
|
+
# or an `EXTERNAL` deployment. An Amazon ECS task set includes details
|
9000
|
+
# such as the desired number of tasks, how many tasks are running, and
|
9001
|
+
# whether the task set serves production traffic.
|
9006
9002
|
# @return [Array<Types::TaskSet>]
|
9007
9003
|
#
|
9008
9004
|
# @!attribute [rw] deployments
|
@@ -9105,9 +9101,9 @@ module Aws::ECS
|
|
9105
9101
|
#
|
9106
9102
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
9107
9103
|
# of such as a prefix for either keys or values as it is reserved
|
9108
|
-
# for
|
9109
|
-
# this prefix. Tags with this prefix do not count
|
9110
|
-
# per resource limit.
|
9104
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
9105
|
+
# values with this prefix. Tags with this prefix do not count
|
9106
|
+
# against your tags per resource limit.
|
9111
9107
|
# @return [Array<Types::Tag>]
|
9112
9108
|
#
|
9113
9109
|
# @!attribute [rw] created_by
|
@@ -9228,7 +9224,7 @@ module Aws::ECS
|
|
9228
9224
|
#
|
9229
9225
|
# @!attribute [rw] registry_arn
|
9230
9226
|
# The Amazon Resource Name (ARN) of the service registry. The
|
9231
|
-
# currently supported service registry is
|
9227
|
+
# currently supported service registry is Cloud Map. For more
|
9232
9228
|
# information, see [CreateService][1].
|
9233
9229
|
#
|
9234
9230
|
#
|
@@ -9505,9 +9501,9 @@ module Aws::ECS
|
|
9505
9501
|
#
|
9506
9502
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
9507
9503
|
# of such as a prefix for either keys or values as it is reserved
|
9508
|
-
# for
|
9509
|
-
# this prefix. Tags with this prefix do not count
|
9510
|
-
# per resource limit.
|
9504
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
9505
|
+
# values with this prefix. Tags with this prefix do not count
|
9506
|
+
# against your tags per resource limit.
|
9511
9507
|
# @return [Array<Types::Tag>]
|
9512
9508
|
#
|
9513
9509
|
# @!attribute [rw] task_definition
|
@@ -9918,10 +9914,10 @@ module Aws::ECS
|
|
9918
9914
|
# * Tag keys and values are case-sensitive.
|
9919
9915
|
#
|
9920
9916
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
9921
|
-
# such as a prefix for either keys or values as it is reserved for
|
9922
|
-
# use. You cannot edit or delete tag keys or
|
9923
|
-
# Tags with this prefix do not count against
|
9924
|
-
# limit.
|
9917
|
+
# such as a prefix for either keys or values as it is reserved for
|
9918
|
+
# Amazon Web Services use. You cannot edit or delete tag keys or
|
9919
|
+
# values with this prefix. Tags with this prefix do not count against
|
9920
|
+
# your tags per resource limit.
|
9925
9921
|
#
|
9926
9922
|
# @note When making an API call, you may pass Tag
|
9927
9923
|
# data as a hash:
|
@@ -9996,9 +9992,9 @@ module Aws::ECS
|
|
9996
9992
|
#
|
9997
9993
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
9998
9994
|
# of such as a prefix for either keys or values as it is reserved
|
9999
|
-
# for
|
10000
|
-
# this prefix. Tags with this prefix do not count
|
10001
|
-
# per resource limit.
|
9995
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
9996
|
+
# values with this prefix. Tags with this prefix do not count
|
9997
|
+
# against your tags per resource limit.
|
10002
9998
|
# @return [Array<Types::Tag>]
|
10003
9999
|
#
|
10004
10000
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TagResourceRequest AWS API Documentation
|
@@ -10208,9 +10204,8 @@ module Aws::ECS
|
|
10208
10204
|
# The platform version on which your task is running. A platform
|
10209
10205
|
# version is only specified for tasks using the Fargate launch type.
|
10210
10206
|
# If one is not specified, the `LATEST` platform version is used by
|
10211
|
-
# default. For more information, see [
|
10212
|
-
#
|
10213
|
-
# Guide*.
|
10207
|
+
# default. For more information, see [Fargate Platform Versions][1] in
|
10208
|
+
# the *Amazon Elastic Container Service Developer Guide*.
|
10214
10209
|
#
|
10215
10210
|
#
|
10216
10211
|
#
|
@@ -10281,9 +10276,9 @@ module Aws::ECS
|
|
10281
10276
|
#
|
10282
10277
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
10283
10278
|
# of such as a prefix for either keys or values as it is reserved
|
10284
|
-
# for
|
10285
|
-
# this prefix. Tags with this prefix do not count
|
10286
|
-
# per resource limit.
|
10279
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
10280
|
+
# values with this prefix. Tags with this prefix do not count
|
10281
|
+
# against your tags per resource limit.
|
10287
10282
|
# @return [Array<Types::Tag>]
|
10288
10283
|
#
|
10289
10284
|
# @!attribute [rw] task_arn
|
@@ -10384,9 +10379,9 @@ module Aws::ECS
|
|
10384
10379
|
# @return [String]
|
10385
10380
|
#
|
10386
10381
|
# @!attribute [rw] task_role_arn
|
10387
|
-
# The short name or full Amazon Resource Name (ARN) of the
|
10388
|
-
#
|
10389
|
-
#
|
10382
|
+
# The short name or full Amazon Resource Name (ARN) of the Identity
|
10383
|
+
# and Access Management role that grants containers in the task
|
10384
|
+
# permission to call Amazon Web Services APIs on your behalf. For more
|
10390
10385
|
# information, see [Amazon ECS Task Role][1] in the *Amazon Elastic
|
10391
10386
|
# Container Service Developer Guide*.
|
10392
10387
|
#
|
@@ -10405,11 +10400,11 @@ module Aws::ECS
|
|
10405
10400
|
#
|
10406
10401
|
# @!attribute [rw] execution_role_arn
|
10407
10402
|
# The Amazon Resource Name (ARN) of the task execution role that
|
10408
|
-
# grants the Amazon ECS container agent permission to make
|
10409
|
-
# calls on your behalf. The task execution IAM role is
|
10410
|
-
# depending on the requirements of your task. For more
|
10411
|
-
# see [Amazon ECS task execution IAM role][1] in the
|
10412
|
-
# Container Service Developer Guide*.
|
10403
|
+
# grants the Amazon ECS container agent permission to make Amazon Web
|
10404
|
+
# Services API calls on your behalf. The task execution IAM role is
|
10405
|
+
# required depending on the requirements of your task. For more
|
10406
|
+
# information, see [Amazon ECS task execution IAM role][1] in the
|
10407
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
10413
10408
|
#
|
10414
10409
|
#
|
10415
10410
|
#
|
@@ -10422,13 +10417,15 @@ module Aws::ECS
|
|
10422
10417
|
# network mode is specified, the default is `bridge`.
|
10423
10418
|
#
|
10424
10419
|
# For Amazon ECS tasks on Fargate, the `awsvpc` network mode is
|
10425
|
-
# required. For Amazon ECS tasks on Amazon EC2 instances, any
|
10426
|
-
# mode can be used.
|
10427
|
-
#
|
10428
|
-
#
|
10429
|
-
#
|
10430
|
-
#
|
10431
|
-
#
|
10420
|
+
# required. For Amazon ECS tasks on Amazon EC2 Linux instances, any
|
10421
|
+
# network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows
|
10422
|
+
# instances, `<default>` or `awsvpc` can be used. If the network mode
|
10423
|
+
# is set to `none`, you cannot specify port mappings in your container
|
10424
|
+
# definitions, and the tasks containers do not have external
|
10425
|
+
# connectivity. The `host` and `awsvpc` network modes offer the
|
10426
|
+
# highest networking performance for containers because they use the
|
10427
|
+
# EC2 network stack instead of the virtualized network stack provided
|
10428
|
+
# by the `bridge` mode.
|
10432
10429
|
#
|
10433
10430
|
# With the `host` and `awsvpc` network modes, exposed container ports
|
10434
10431
|
# are mapped directly to the corresponding host port (for the `host`
|
@@ -10446,22 +10443,10 @@ module Aws::ECS
|
|
10446
10443
|
# For more information, see [Task Networking][1] in the *Amazon
|
10447
10444
|
# Elastic Container Service Developer Guide*.
|
10448
10445
|
#
|
10449
|
-
# <note markdown="1"> Currently, only Amazon ECS-optimized AMIs, other Amazon Linux
|
10450
|
-
# variants with the `ecs-init` package, or AWS Fargate infrastructure
|
10451
|
-
# support the `awsvpc` network mode.
|
10452
|
-
#
|
10453
|
-
# </note>
|
10454
|
-
#
|
10455
10446
|
# If the network mode is `host`, you cannot run multiple
|
10456
10447
|
# instantiations of the same task on a single container instance when
|
10457
10448
|
# port mappings are used.
|
10458
10449
|
#
|
10459
|
-
# Docker for Windows uses different network modes than Docker for
|
10460
|
-
# Linux. When you register a task definition with Windows containers,
|
10461
|
-
# you must not specify a network mode. If you use the console to
|
10462
|
-
# register a task definition with Windows containers, you must choose
|
10463
|
-
# the `<default>` network mode object.
|
10464
|
-
#
|
10465
10450
|
# For more information, see [Network settings][2] in the *Docker run
|
10466
10451
|
# reference*.
|
10467
10452
|
#
|
@@ -10486,7 +10471,7 @@ module Aws::ECS
|
|
10486
10471
|
# Elastic Container Service Developer Guide*.
|
10487
10472
|
#
|
10488
10473
|
# <note markdown="1"> The `host` and `sourcePath` parameters are not supported for tasks
|
10489
|
-
# run on
|
10474
|
+
# run on Fargate.
|
10490
10475
|
#
|
10491
10476
|
# </note>
|
10492
10477
|
#
|
@@ -10509,7 +10494,7 @@ module Aws::ECS
|
|
10509
10494
|
# EC2 instances. For more information, see [Attributes][1] in the
|
10510
10495
|
# *Amazon Elastic Container Service Developer Guide*.
|
10511
10496
|
#
|
10512
|
-
# <note markdown="1"> This parameter is not supported for tasks run on
|
10497
|
+
# <note markdown="1"> This parameter is not supported for tasks run on Fargate.
|
10513
10498
|
#
|
10514
10499
|
# </note>
|
10515
10500
|
#
|
@@ -10521,7 +10506,7 @@ module Aws::ECS
|
|
10521
10506
|
# @!attribute [rw] placement_constraints
|
10522
10507
|
# An array of placement constraint objects to use for tasks.
|
10523
10508
|
#
|
10524
|
-
# <note markdown="1"> This parameter is not supported for tasks run on
|
10509
|
+
# <note markdown="1"> This parameter is not supported for tasks run on Fargate.
|
10525
10510
|
#
|
10526
10511
|
# </note>
|
10527
10512
|
# @return [Array<Types::TaskDefinitionPlacementConstraint>]
|
@@ -10577,9 +10562,9 @@ module Aws::ECS
|
|
10577
10562
|
# optional. For more information regarding container-level memory and
|
10578
10563
|
# memory reservation, see [ContainerDefinition][1].
|
10579
10564
|
#
|
10580
|
-
# If your tasks will be run on
|
10581
|
-
#
|
10582
|
-
#
|
10565
|
+
# If your tasks will be run on Fargate, this field is required and you
|
10566
|
+
# must use one of the following values, which determines your range of
|
10567
|
+
# valid values for the `cpu` parameter:
|
10583
10568
|
#
|
10584
10569
|
# * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values:
|
10585
10570
|
# 256 (.25 vCPU)
|
@@ -10620,7 +10605,7 @@ module Aws::ECS
|
|
10620
10605
|
# see [Docker security][2].
|
10621
10606
|
#
|
10622
10607
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
10623
|
-
# on
|
10608
|
+
# on Fargate.
|
10624
10609
|
#
|
10625
10610
|
# </note>
|
10626
10611
|
#
|
@@ -10661,7 +10646,7 @@ module Aws::ECS
|
|
10661
10646
|
# `systemControls` will apply to all containers within a task.
|
10662
10647
|
#
|
10663
10648
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
10664
|
-
# on
|
10649
|
+
# on Fargate.
|
10665
10650
|
#
|
10666
10651
|
# </note>
|
10667
10652
|
#
|
@@ -10740,8 +10725,7 @@ module Aws::ECS
|
|
10740
10725
|
# definition. For more information, see [Task placement constraints][1]
|
10741
10726
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
10742
10727
|
#
|
10743
|
-
# <note markdown="1"> Task placement constraints are not supported for tasks run on
|
10744
|
-
# Fargate.
|
10728
|
+
# <note markdown="1"> Task placement constraints are not supported for tasks run on Fargate.
|
10745
10729
|
#
|
10746
10730
|
# </note>
|
10747
10731
|
#
|
@@ -10859,8 +10843,8 @@ module Aws::ECS
|
|
10859
10843
|
# @!attribute [rw] ephemeral_storage
|
10860
10844
|
# The ephemeral storage setting override for the task.
|
10861
10845
|
#
|
10862
|
-
# <note markdown="1"> This parameter is only supported for tasks hosted on
|
10863
|
-
#
|
10846
|
+
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
|
10847
|
+
# platform version `1.4.0` or later.
|
10864
10848
|
#
|
10865
10849
|
# </note>
|
10866
10850
|
# @return [Types::EphemeralStorage]
|
@@ -10879,10 +10863,10 @@ module Aws::ECS
|
|
10879
10863
|
include Aws::Structure
|
10880
10864
|
end
|
10881
10865
|
|
10882
|
-
# Information about a set of Amazon ECS tasks in either an
|
10883
|
-
#
|
10884
|
-
#
|
10885
|
-
#
|
10866
|
+
# Information about a set of Amazon ECS tasks in either an CodeDeploy or
|
10867
|
+
# an `EXTERNAL` deployment. An Amazon ECS task set includes details such
|
10868
|
+
# as the desired number of tasks, how many tasks are running, and
|
10869
|
+
# whether the task set serves production traffic.
|
10886
10870
|
#
|
10887
10871
|
# @!attribute [rw] id
|
10888
10872
|
# The ID of the task set.
|
@@ -10904,20 +10888,20 @@ module Aws::ECS
|
|
10904
10888
|
#
|
10905
10889
|
# @!attribute [rw] started_by
|
10906
10890
|
# The tag specified when a task set is started. If the task set is
|
10907
|
-
# created by an
|
10908
|
-
#
|
10891
|
+
# created by an CodeDeploy deployment, the `startedBy` parameter is
|
10892
|
+
# `CODE_DEPLOY`. For a task set created for an external deployment,
|
10909
10893
|
# the startedBy field isn't used.
|
10910
10894
|
# @return [String]
|
10911
10895
|
#
|
10912
10896
|
# @!attribute [rw] external_id
|
10913
10897
|
# The external ID associated with the task set.
|
10914
10898
|
#
|
10915
|
-
# If a task set is created by an
|
10916
|
-
# `externalId` parameter contains the
|
10899
|
+
# If a task set is created by an CodeDeploy deployment, the
|
10900
|
+
# `externalId` parameter contains the CodeDeploy deployment ID.
|
10917
10901
|
#
|
10918
10902
|
# If a task set is created for an external deployment and is
|
10919
10903
|
# associated with a service discovery registry, the `externalId`
|
10920
|
-
# parameter contains the `ECS_TASK_SET_EXTERNAL_ID`
|
10904
|
+
# parameter contains the `ECS_TASK_SET_EXTERNAL_ID` Cloud Map
|
10921
10905
|
# attribute.
|
10922
10906
|
# @return [String]
|
10923
10907
|
#
|
@@ -10987,11 +10971,10 @@ module Aws::ECS
|
|
10987
10971
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
10988
10972
|
#
|
10989
10973
|
# @!attribute [rw] platform_version
|
10990
|
-
# The
|
10991
|
-
#
|
10992
|
-
#
|
10993
|
-
#
|
10994
|
-
# Guide*.
|
10974
|
+
# The Fargate platform version on which the tasks in the task set are
|
10975
|
+
# running. A platform version is only specified for tasks run on
|
10976
|
+
# Fargate. For more information, see [Fargate platform versions][1] in
|
10977
|
+
# the *Amazon Elastic Container Service Developer Guide*.
|
10995
10978
|
#
|
10996
10979
|
#
|
10997
10980
|
#
|
@@ -11070,9 +11053,9 @@ module Aws::ECS
|
|
11070
11053
|
#
|
11071
11054
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
11072
11055
|
# of such as a prefix for either keys or values as it is reserved
|
11073
|
-
# for
|
11074
|
-
# this prefix. Tags with this prefix do not count
|
11075
|
-
# per resource limit.
|
11056
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
11057
|
+
# values with this prefix. Tags with this prefix do not count
|
11058
|
+
# against your tags per resource limit.
|
11076
11059
|
# @return [Array<Types::Tag>]
|
11077
11060
|
#
|
11078
11061
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TaskSet AWS API Documentation
|
@@ -11632,10 +11615,10 @@ module Aws::ECS
|
|
11632
11615
|
# providers can be created with the CreateCapacityProvider API
|
11633
11616
|
# operation.
|
11634
11617
|
#
|
11635
|
-
# To use a
|
11636
|
-
#
|
11637
|
-
#
|
11638
|
-
#
|
11618
|
+
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
11619
|
+
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
11620
|
+
# are available to all accounts and only need to be associated with a
|
11621
|
+
# cluster to be used.
|
11639
11622
|
#
|
11640
11623
|
# The PutClusterCapacityProviders API operation is used to update the
|
11641
11624
|
# list of available capacity providers for a cluster after the cluster
|
@@ -11679,8 +11662,8 @@ module Aws::ECS
|
|
11679
11662
|
# The platform version on which your tasks in the service are running.
|
11680
11663
|
# A platform version is only specified for tasks using the Fargate
|
11681
11664
|
# launch type. If a platform version is not specified, the `LATEST`
|
11682
|
-
# platform version is used by default. For more information, see
|
11683
|
-
# Fargate Platform Versions][1] in the *Amazon Elastic Container
|
11665
|
+
# platform version is used by default. For more information, see
|
11666
|
+
# [Fargate Platform Versions][1] in the *Amazon Elastic Container
|
11684
11667
|
# Service Developer Guide*.
|
11685
11668
|
#
|
11686
11669
|
#
|
@@ -11928,7 +11911,7 @@ module Aws::ECS
|
|
11928
11911
|
# Windows containers only support the use of the `local` driver. To
|
11929
11912
|
# use bind mounts, specify the `host` parameter instead.
|
11930
11913
|
#
|
11931
|
-
# <note markdown="1"> Docker volumes are not supported by tasks run on
|
11914
|
+
# <note markdown="1"> Docker volumes are not supported by tasks run on Fargate.
|
11932
11915
|
#
|
11933
11916
|
# </note>
|
11934
11917
|
# @return [Types::DockerVolumeConfiguration]
|