aws-sdk-ecs 1.79.0 → 1.83.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ecs.rb +1 -1
- data/lib/aws-sdk-ecs/client.rb +128 -149
- data/lib/aws-sdk-ecs/types.rb +248 -279
- metadata +4 -4
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,14 +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
|
-
# The
|
2064
|
+
# The ID of the container instance. For Amazon EC2 instances, this
|
2065
|
+
# value is the Amazon EC2 instance ID. For external instances, this
|
2066
|
+
# value is the Amazon Web Services Systems Manager managed instance
|
2067
|
+
# ID.
|
2065
2068
|
# @return [String]
|
2066
2069
|
#
|
2067
2070
|
# @!attribute [rw] capacity_provider_name
|
@@ -2202,9 +2205,9 @@ module Aws::ECS
|
|
2202
2205
|
#
|
2203
2206
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
2204
2207
|
# of such as a prefix for either keys or values as it is reserved
|
2205
|
-
# for
|
2206
|
-
# this prefix. Tags with this prefix do not count
|
2207
|
-
# 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.
|
2208
2211
|
# @return [Array<Types::Tag>]
|
2209
2212
|
#
|
2210
2213
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerInstance AWS API Documentation
|
@@ -2455,9 +2458,9 @@ module Aws::ECS
|
|
2455
2458
|
#
|
2456
2459
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
2457
2460
|
# of such as a prefix for either keys or values as it is reserved
|
2458
|
-
# for
|
2459
|
-
# this prefix. Tags with this prefix do not count
|
2460
|
-
# 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.
|
2461
2464
|
# @return [Array<Types::Tag>]
|
2462
2465
|
#
|
2463
2466
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateCapacityProviderRequest AWS API Documentation
|
@@ -2555,9 +2558,9 @@ module Aws::ECS
|
|
2555
2558
|
#
|
2556
2559
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
2557
2560
|
# of such as a prefix for either keys or values as it is reserved
|
2558
|
-
# for
|
2559
|
-
# this prefix. Tags with this prefix do not count
|
2560
|
-
# 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.
|
2561
2564
|
# @return [Array<Types::Tag>]
|
2562
2565
|
#
|
2563
2566
|
# @!attribute [rw] settings
|
@@ -2584,10 +2587,10 @@ module Aws::ECS
|
|
2584
2587
|
# providers can be created with the CreateCapacityProvider API
|
2585
2588
|
# operation.
|
2586
2589
|
#
|
2587
|
-
# To use a
|
2588
|
-
#
|
2589
|
-
#
|
2590
|
-
#
|
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.
|
2591
2594
|
#
|
2592
2595
|
# The PutClusterCapacityProviders API operation is used to update the
|
2593
2596
|
# list of available capacity providers for a cluster after the cluster
|
@@ -2747,15 +2750,15 @@ module Aws::ECS
|
|
2747
2750
|
#
|
2748
2751
|
# If the service is using the `CODE_DEPLOY` deployment controller, the
|
2749
2752
|
# service is required to use either an Application Load Balancer or
|
2750
|
-
# Network Load Balancer. When creating an
|
2751
|
-
#
|
2752
|
-
#
|
2753
|
-
#
|
2754
|
-
#
|
2755
|
-
#
|
2756
|
-
#
|
2757
|
-
#
|
2758
|
-
#
|
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.
|
2759
2762
|
#
|
2760
2763
|
# After you create a service using the `ECS` deployment controller,
|
2761
2764
|
# the load balancer name or target group ARN, container name, and
|
@@ -2827,13 +2830,12 @@ module Aws::ECS
|
|
2827
2830
|
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
2828
2831
|
# Container Service Developer Guide*.
|
2829
2832
|
#
|
2830
|
-
# The `FARGATE` launch type runs your tasks on
|
2833
|
+
# The `FARGATE` launch type runs your tasks on Fargate On-Demand
|
2831
2834
|
# infrastructure.
|
2832
2835
|
#
|
2833
2836
|
# <note markdown="1"> Fargate Spot infrastructure is available for use but a capacity
|
2834
|
-
# provider strategy must be used. For more information, see [
|
2835
|
-
#
|
2836
|
-
# Fargate*.
|
2837
|
+
# provider strategy must be used. For more information, see [Fargate
|
2838
|
+
# capacity providers][2] in the *Amazon ECS User Guide for Fargate*.
|
2837
2839
|
#
|
2838
2840
|
# </note>
|
2839
2841
|
#
|
@@ -2866,7 +2868,7 @@ module Aws::ECS
|
|
2866
2868
|
# The platform version that your tasks in the service are running on.
|
2867
2869
|
# A platform version is specified only for tasks using the Fargate
|
2868
2870
|
# launch type. If one isn't specified, the `LATEST` platform version
|
2869
|
-
# is used by default. For more information, see [
|
2871
|
+
# is used by default. For more information, see [Fargate platform
|
2870
2872
|
# versions][1] in the *Amazon Elastic Container Service Developer
|
2871
2873
|
# Guide*.
|
2872
2874
|
#
|
@@ -3020,9 +3022,9 @@ module Aws::ECS
|
|
3020
3022
|
#
|
3021
3023
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
3022
3024
|
# of such as a prefix for either keys or values as it is reserved
|
3023
|
-
# for
|
3024
|
-
# this prefix. Tags with this prefix do not count
|
3025
|
-
# 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.
|
3026
3028
|
# @return [Array<Types::Tag>]
|
3027
3029
|
#
|
3028
3030
|
# @!attribute [rw] enable_ecs_managed_tags
|
@@ -3082,6 +3084,10 @@ module Aws::ECS
|
|
3082
3084
|
# @!attribute [rw] service
|
3083
3085
|
# The full description of your service following the create call.
|
3084
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
|
+
#
|
3085
3091
|
# If a service is using the `ECS` deployment controller, the
|
3086
3092
|
# `deploymentController` and `taskSets` parameters will not be
|
3087
3093
|
# returned.
|
@@ -3167,8 +3173,8 @@ module Aws::ECS
|
|
3167
3173
|
# An optional non-unique tag that identifies this task set in external
|
3168
3174
|
# systems. If the task set is associated with a service discovery
|
3169
3175
|
# registry, the tasks in this task set will have the
|
3170
|
-
# `ECS_TASK_SET_EXTERNAL_ID`
|
3171
|
-
#
|
3176
|
+
# `ECS_TASK_SET_EXTERNAL_ID` Cloud Map attribute set to the provided
|
3177
|
+
# value.
|
3172
3178
|
# @return [String]
|
3173
3179
|
#
|
3174
3180
|
# @!attribute [rw] task_definition
|
@@ -3227,10 +3233,10 @@ module Aws::ECS
|
|
3227
3233
|
# providers can be created with the CreateCapacityProvider API
|
3228
3234
|
# operation.
|
3229
3235
|
#
|
3230
|
-
# To use a
|
3231
|
-
#
|
3232
|
-
#
|
3233
|
-
#
|
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.
|
3234
3240
|
#
|
3235
3241
|
# The PutClusterCapacityProviders API operation is used to update the
|
3236
3242
|
# list of available capacity providers for a cluster after the cluster
|
@@ -3281,9 +3287,9 @@ module Aws::ECS
|
|
3281
3287
|
#
|
3282
3288
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
3283
3289
|
# of such as a prefix for either keys or values as it is reserved
|
3284
|
-
# for
|
3285
|
-
# this prefix. Tags with this prefix do not count
|
3286
|
-
# 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.
|
3287
3293
|
# @return [Array<Types::Tag>]
|
3288
3294
|
#
|
3289
3295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateTaskSetRequest AWS API Documentation
|
@@ -3307,10 +3313,10 @@ module Aws::ECS
|
|
3307
3313
|
end
|
3308
3314
|
|
3309
3315
|
# @!attribute [rw] task_set
|
3310
|
-
# Information about a set of Amazon ECS tasks in either an
|
3311
|
-
#
|
3312
|
-
#
|
3313
|
-
#
|
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.
|
3314
3320
|
# @return [Types::TaskSet]
|
3315
3321
|
#
|
3316
3322
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateTaskSetResponse AWS API Documentation
|
@@ -3668,7 +3674,7 @@ module Aws::ECS
|
|
3668
3674
|
# The platform version on which your tasks in the service are running.
|
3669
3675
|
# A platform version is only specified for tasks using the Fargate
|
3670
3676
|
# launch type. If one is not specified, the `LATEST` platform version
|
3671
|
-
# is used by default. For more information, see [
|
3677
|
+
# is used by default. For more information, see [Fargate Platform
|
3672
3678
|
# Versions][1] in the *Amazon Elastic Container Service Developer
|
3673
3679
|
# Guide*.
|
3674
3680
|
#
|
@@ -3895,9 +3901,9 @@ module Aws::ECS
|
|
3895
3901
|
# CODE\_DEPLOY
|
3896
3902
|
#
|
3897
3903
|
# : The blue/green (`CODE_DEPLOY`) deployment type uses the blue/green
|
3898
|
-
# deployment model powered by
|
3899
|
-
#
|
3900
|
-
#
|
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.
|
3901
3907
|
#
|
3902
3908
|
# EXTERNAL
|
3903
3909
|
#
|
@@ -3932,7 +3938,7 @@ module Aws::ECS
|
|
3932
3938
|
# @!attribute [rw] container_instance
|
3933
3939
|
# The container instance ID or full ARN of the container instance to
|
3934
3940
|
# deregister. The ARN contains the `arn:aws:ecs` namespace, followed
|
3935
|
-
# by the Region of the container instance, the
|
3941
|
+
# by the Region of the container instance, the account ID of the
|
3936
3942
|
# container instance owner, the `container-instance` namespace, and
|
3937
3943
|
# then the container instance ID. For example,
|
3938
3944
|
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
@@ -4110,9 +4116,9 @@ module Aws::ECS
|
|
4110
4116
|
# @return [Array<String>]
|
4111
4117
|
#
|
4112
4118
|
# @!attribute [rw] include
|
4113
|
-
# Whether to include additional information about
|
4114
|
-
# response. If this field is omitted,
|
4115
|
-
#
|
4119
|
+
# Whether to include additional information about the clusters in the
|
4120
|
+
# response. If this field is omitted, this information isn't
|
4121
|
+
# included.
|
4116
4122
|
#
|
4117
4123
|
# If `ATTACHMENTS` is specified, the attachments for the container
|
4118
4124
|
# instances or tasks within the cluster are included.
|
@@ -4120,24 +4126,8 @@ module Aws::ECS
|
|
4120
4126
|
# If `SETTINGS` is specified, the settings for the cluster are
|
4121
4127
|
# included.
|
4122
4128
|
#
|
4123
|
-
# If `STATISTICS` is specified, the
|
4124
|
-
# separated by launch type
|
4125
|
-
#
|
4126
|
-
# * runningEC2TasksCount
|
4127
|
-
#
|
4128
|
-
# * runningFargateTasksCount
|
4129
|
-
#
|
4130
|
-
# * pendingEC2TasksCount
|
4131
|
-
#
|
4132
|
-
# * pendingFargateTasksCount
|
4133
|
-
#
|
4134
|
-
# * activeEC2ServiceCount
|
4135
|
-
#
|
4136
|
-
# * activeFargateServiceCount
|
4137
|
-
#
|
4138
|
-
# * drainingEC2ServiceCount
|
4139
|
-
#
|
4140
|
-
# * drainingFargateServiceCount
|
4129
|
+
# If `STATISTICS` is specified, the task and service count is
|
4130
|
+
# included, separated by launch type.
|
4141
4131
|
#
|
4142
4132
|
# If `TAGS` is specified, the metadata tags associated with the
|
4143
4133
|
# cluster are included.
|
@@ -4341,9 +4331,9 @@ module Aws::ECS
|
|
4341
4331
|
#
|
4342
4332
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
4343
4333
|
# of such as a prefix for either keys or values as it is reserved
|
4344
|
-
# for
|
4345
|
-
# this prefix. Tags with this prefix do not count
|
4346
|
-
# 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.
|
4347
4337
|
# @return [Array<Types::Tag>]
|
4348
4338
|
#
|
4349
4339
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskDefinitionResponse AWS API Documentation
|
@@ -4513,7 +4503,7 @@ module Aws::ECS
|
|
4513
4503
|
# @!attribute [rw] container_instance
|
4514
4504
|
# The container instance ID or full ARN of the container instance. The
|
4515
4505
|
# ARN contains the `arn:aws:ecs` namespace, followed by the Region of
|
4516
|
-
# the container instance, the
|
4506
|
+
# the container instance, the account ID of the container instance
|
4517
4507
|
# owner, the `container-instance` namespace, and then the container
|
4518
4508
|
# instance ID. For example,
|
4519
4509
|
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
@@ -4825,11 +4815,11 @@ module Aws::ECS
|
|
4825
4815
|
|
4826
4816
|
# The amount of ephemeral storage to allocate for the task. This
|
4827
4817
|
# parameter is used to expand the total amount of ephemeral storage
|
4828
|
-
# available, beyond the default amount, for tasks hosted on
|
4829
|
-
#
|
4830
|
-
# 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*.
|
4831
4821
|
#
|
4832
|
-
# <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
|
4833
4823
|
# platform version `1.4.0` or later.
|
4834
4824
|
#
|
4835
4825
|
# </note>
|
@@ -4877,8 +4867,8 @@ module Aws::ECS
|
|
4877
4867
|
# }
|
4878
4868
|
#
|
4879
4869
|
# @!attribute [rw] kms_key_id
|
4880
|
-
# Specify an
|
4881
|
-
#
|
4870
|
+
# Specify an Key Management Service key ID to encrypt the data between
|
4871
|
+
# the local client and the container.
|
4882
4872
|
# @return [String]
|
4883
4873
|
#
|
4884
4874
|
# @!attribute [rw] logging
|
@@ -5083,14 +5073,14 @@ module Aws::ECS
|
|
5083
5073
|
# @!attribute [rw] credentials_parameter
|
5084
5074
|
# The authorization credential option to use. The authorization
|
5085
5075
|
# credential options can be provided using either the Amazon Resource
|
5086
|
-
# Name (ARN) of an
|
5087
|
-
#
|
5076
|
+
# Name (ARN) of an Secrets Manager secret or SSM Parameter Store
|
5077
|
+
# parameter. The ARNs refer to the stored credentials.
|
5088
5078
|
# @return [String]
|
5089
5079
|
#
|
5090
5080
|
# @!attribute [rw] domain
|
5091
|
-
# A fully qualified domain name hosted by an [
|
5092
|
-
#
|
5093
|
-
#
|
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.
|
5094
5084
|
#
|
5095
5085
|
#
|
5096
5086
|
#
|
@@ -5218,8 +5208,8 @@ module Aws::ECS
|
|
5218
5208
|
# FireLens Configuration][1] in the *Amazon Elastic Container Service
|
5219
5209
|
# Developer Guide*.
|
5220
5210
|
#
|
5221
|
-
# <note markdown="1"> Tasks hosted on
|
5222
|
-
#
|
5211
|
+
# <note markdown="1"> Tasks hosted on Fargate only support the `file` configuration file
|
5212
|
+
# type.
|
5223
5213
|
#
|
5224
5214
|
# </note>
|
5225
5215
|
#
|
@@ -5283,7 +5273,7 @@ module Aws::ECS
|
|
5283
5273
|
#
|
5284
5274
|
# * Container health checks are supported for Fargate tasks if you are
|
5285
5275
|
# using platform version 1.1.0 or greater. For more information, see
|
5286
|
-
# [
|
5276
|
+
# [Fargate Platform Versions][2].
|
5287
5277
|
#
|
5288
5278
|
# * Container health checks are not supported for tasks that are part of
|
5289
5279
|
# a service that is configured to use a Classic Load Balancer.
|
@@ -5531,7 +5521,7 @@ module Aws::ECS
|
|
5531
5521
|
# `CapAdd` in the [Create a container][1] section of the [Docker
|
5532
5522
|
# Remote API][2] and the `--cap-add` option to [docker run][3].
|
5533
5523
|
#
|
5534
|
-
# <note markdown="1"> Tasks launched on
|
5524
|
+
# <note markdown="1"> Tasks launched on Fargate only support adding the `SYS_PTRACE`
|
5535
5525
|
# kernel capability.
|
5536
5526
|
#
|
5537
5527
|
# </note>
|
@@ -6665,7 +6655,7 @@ module Aws::ECS
|
|
6665
6655
|
# configuration][5] in the *Amazon Elastic Container Service Developer
|
6666
6656
|
# Guide*.
|
6667
6657
|
#
|
6668
|
-
# * For tasks on
|
6658
|
+
# * For tasks on Fargate, because you do not have access to the
|
6669
6659
|
# underlying infrastructure your tasks are hosted on, any additional
|
6670
6660
|
# software needed will have to be installed outside of the task. For
|
6671
6661
|
# example, the Fluentd output aggregators or a remote host running
|
@@ -6698,7 +6688,7 @@ module Aws::ECS
|
|
6698
6688
|
# @!attribute [rw] log_driver
|
6699
6689
|
# The log driver to use for the container.
|
6700
6690
|
#
|
6701
|
-
# For tasks on
|
6691
|
+
# For tasks on Fargate, the supported log drivers are `awslogs`,
|
6702
6692
|
# `splunk`, and `awsfirelens`.
|
6703
6693
|
#
|
6704
6694
|
# For tasks hosted on Amazon EC2 instances, the supported log drivers
|
@@ -7556,10 +7546,10 @@ module Aws::ECS
|
|
7556
7546
|
# providers can be created with the CreateCapacityProvider API
|
7557
7547
|
# operation.
|
7558
7548
|
#
|
7559
|
-
# To use a
|
7560
|
-
#
|
7561
|
-
#
|
7562
|
-
#
|
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.
|
7563
7553
|
# @return [Array<String>]
|
7564
7554
|
#
|
7565
7555
|
# @!attribute [rw] default_capacity_provider_strategy
|
@@ -7581,10 +7571,10 @@ module Aws::ECS
|
|
7581
7571
|
# providers can be created with the CreateCapacityProvider API
|
7582
7572
|
# operation.
|
7583
7573
|
#
|
7584
|
-
# To use a
|
7585
|
-
#
|
7586
|
-
#
|
7587
|
-
#
|
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.
|
7588
7578
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
7589
7579
|
#
|
7590
7580
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutClusterCapacityProvidersRequest AWS API Documentation
|
@@ -7723,9 +7713,9 @@ module Aws::ECS
|
|
7723
7713
|
#
|
7724
7714
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
7725
7715
|
# of such as a prefix for either keys or values as it is reserved
|
7726
|
-
# for
|
7727
|
-
# this prefix. Tags with this prefix do not count
|
7728
|
-
# 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.
|
7729
7719
|
# @return [Array<Types::Tag>]
|
7730
7720
|
#
|
7731
7721
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterContainerInstanceRequest AWS API Documentation
|
@@ -8011,11 +8001,11 @@ module Aws::ECS
|
|
8011
8001
|
#
|
8012
8002
|
# @!attribute [rw] execution_role_arn
|
8013
8003
|
# The Amazon Resource Name (ARN) of the task execution role that
|
8014
|
-
# grants the Amazon ECS container agent permission to make
|
8015
|
-
# calls on your behalf. The task execution IAM role is
|
8016
|
-
# depending on the requirements of your task. For more
|
8017
|
-
# see [Amazon ECS task execution IAM role][1] in the
|
8018
|
-
# 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*.
|
8019
8009
|
#
|
8020
8010
|
#
|
8021
8011
|
#
|
@@ -8028,13 +8018,15 @@ module Aws::ECS
|
|
8028
8018
|
# network mode is specified, the default is `bridge`.
|
8029
8019
|
#
|
8030
8020
|
# For Amazon ECS tasks on Fargate, the `awsvpc` network mode is
|
8031
|
-
# required. For Amazon ECS tasks on Amazon EC2 instances, any
|
8032
|
-
# mode can be used.
|
8033
|
-
#
|
8034
|
-
#
|
8035
|
-
#
|
8036
|
-
#
|
8037
|
-
#
|
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.
|
8038
8030
|
#
|
8039
8031
|
# With the `host` and `awsvpc` network modes, exposed container ports
|
8040
8032
|
# are mapped directly to the corresponding host port (for the `host`
|
@@ -8052,22 +8044,10 @@ module Aws::ECS
|
|
8052
8044
|
# For more information, see [Task Networking][1] in the *Amazon
|
8053
8045
|
# Elastic Container Service Developer Guide*.
|
8054
8046
|
#
|
8055
|
-
# <note markdown="1"> Currently, only Amazon ECS-optimized AMIs, other Amazon Linux
|
8056
|
-
# variants with the `ecs-init` package, or AWS Fargate infrastructure
|
8057
|
-
# support the `awsvpc` network mode.
|
8058
|
-
#
|
8059
|
-
# </note>
|
8060
|
-
#
|
8061
8047
|
# If the network mode is `host`, you cannot run multiple
|
8062
8048
|
# instantiations of the same task on a single container instance when
|
8063
8049
|
# port mappings are used.
|
8064
8050
|
#
|
8065
|
-
# Docker for Windows uses different network modes than Docker for
|
8066
|
-
# Linux. When you register a task definition with Windows containers,
|
8067
|
-
# you must not specify a network mode. If you use the console to
|
8068
|
-
# register a task definition with Windows containers, you must choose
|
8069
|
-
# the `<default>` network mode object.
|
8070
|
-
#
|
8071
8051
|
# For more information, see [Network settings][2] in the *Docker run
|
8072
8052
|
# reference*.
|
8073
8053
|
#
|
@@ -8201,9 +8181,9 @@ module Aws::ECS
|
|
8201
8181
|
#
|
8202
8182
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
8203
8183
|
# of such as a prefix for either keys or values as it is reserved
|
8204
|
-
# for
|
8205
|
-
# this prefix. Tags with this prefix do not count
|
8206
|
-
# 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.
|
8207
8187
|
# @return [Array<Types::Tag>]
|
8208
8188
|
#
|
8209
8189
|
# @!attribute [rw] pid_mode
|
@@ -8221,7 +8201,7 @@ module Aws::ECS
|
|
8221
8201
|
# see [Docker security][2].
|
8222
8202
|
#
|
8223
8203
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
8224
|
-
# on
|
8204
|
+
# on Fargate.
|
8225
8205
|
#
|
8226
8206
|
# </note>
|
8227
8207
|
#
|
@@ -8262,7 +8242,7 @@ module Aws::ECS
|
|
8262
8242
|
# `systemControls` will apply to all containers within a task.
|
8263
8243
|
#
|
8264
8244
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
8265
|
-
# on
|
8245
|
+
# on Fargate.
|
8266
8246
|
#
|
8267
8247
|
# </note>
|
8268
8248
|
#
|
@@ -8298,12 +8278,12 @@ module Aws::ECS
|
|
8298
8278
|
# @!attribute [rw] ephemeral_storage
|
8299
8279
|
# The amount of ephemeral storage to allocate for the task. This
|
8300
8280
|
# parameter is used to expand the total amount of ephemeral storage
|
8301
|
-
# available, beyond the default amount, for tasks hosted on
|
8302
|
-
#
|
8303
|
-
#
|
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*.
|
8304
8284
|
#
|
8305
|
-
# <note markdown="1"> This parameter is only supported for tasks hosted on
|
8306
|
-
#
|
8285
|
+
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
|
8286
|
+
# platform version `1.4.0` or later.
|
8307
8287
|
#
|
8308
8288
|
# </note>
|
8309
8289
|
#
|
@@ -8365,11 +8345,11 @@ module Aws::ECS
|
|
8365
8345
|
# The Amazon Resource Name (ARN) of the secret containing the private
|
8366
8346
|
# repository credentials.
|
8367
8347
|
#
|
8368
|
-
# <note markdown="1"> When you are using the Amazon ECS API,
|
8369
|
-
# secret exists in the same Region as the task that you
|
8370
|
-
# then you can use either the full ARN or the name of
|
8371
|
-
# you are using the
|
8372
|
-
# 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.
|
8373
8353
|
#
|
8374
8354
|
# </note>
|
8375
8355
|
# @return [String]
|
@@ -8596,6 +8576,9 @@ module Aws::ECS
|
|
8596
8576
|
# parameter must be omitted. If no `capacityProviderStrategy` or
|
8597
8577
|
# `launchType` is specified, the `defaultCapacityProviderStrategy` for
|
8598
8578
|
# the cluster is used.
|
8579
|
+
#
|
8580
|
+
# When you use cluster auto scaling, you must specify
|
8581
|
+
# `capacityProviderStrategy` and not `launchType`.
|
8599
8582
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
8600
8583
|
#
|
8601
8584
|
# @!attribute [rw] cluster
|
@@ -8636,13 +8619,12 @@ module Aws::ECS
|
|
8636
8619
|
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
8637
8620
|
# Container Service Developer Guide*.
|
8638
8621
|
#
|
8639
|
-
# The `FARGATE` launch type runs your tasks on
|
8622
|
+
# The `FARGATE` launch type runs your tasks on Fargate On-Demand
|
8640
8623
|
# infrastructure.
|
8641
8624
|
#
|
8642
8625
|
# <note markdown="1"> Fargate Spot infrastructure is available for use but a capacity
|
8643
|
-
# provider strategy must be used. For more information, see [
|
8644
|
-
#
|
8645
|
-
# Fargate*.
|
8626
|
+
# provider strategy must be used. For more information, see [Fargate
|
8627
|
+
# capacity providers][2] in the *Amazon ECS User Guide for Fargate*.
|
8646
8628
|
#
|
8647
8629
|
# </note>
|
8648
8630
|
#
|
@@ -8656,6 +8638,9 @@ module Aws::ECS
|
|
8656
8638
|
# If a `launchType` is specified, the `capacityProviderStrategy`
|
8657
8639
|
# parameter must be omitted.
|
8658
8640
|
#
|
8641
|
+
# When you use cluster auto scaling, you must specify
|
8642
|
+
# `capacityProviderStrategy` and not `launchType`.
|
8643
|
+
#
|
8659
8644
|
#
|
8660
8645
|
#
|
8661
8646
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html
|
@@ -8705,8 +8690,8 @@ module Aws::ECS
|
|
8705
8690
|
# The platform version the task should run. A platform version is only
|
8706
8691
|
# specified for tasks using the Fargate launch type. If one is not
|
8707
8692
|
# specified, the `LATEST` platform version is used by default. For
|
8708
|
-
# more information, see [
|
8709
|
-
#
|
8693
|
+
# more information, see [Fargate Platform Versions][1] in the *Amazon
|
8694
|
+
# Elastic Container Service Developer Guide*.
|
8710
8695
|
#
|
8711
8696
|
#
|
8712
8697
|
#
|
@@ -8768,9 +8753,9 @@ module Aws::ECS
|
|
8768
8753
|
#
|
8769
8754
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
8770
8755
|
# of such as a prefix for either keys or values as it is reserved
|
8771
|
-
# for
|
8772
|
-
# this prefix. Tags with this prefix do not count
|
8773
|
-
# 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.
|
8774
8759
|
# @return [Array<Types::Tag>]
|
8775
8760
|
#
|
8776
8761
|
# @!attribute [rw] task_definition
|
@@ -8881,13 +8866,13 @@ module Aws::ECS
|
|
8881
8866
|
#
|
8882
8867
|
# @!attribute [rw] value_from
|
8883
8868
|
# The secret to expose to the container. The supported values are
|
8884
|
-
# either the full ARN of the
|
8885
|
-
#
|
8869
|
+
# either the full ARN of the Secrets Manager secret or the full ARN of
|
8870
|
+
# the parameter in the SSM Parameter Store.
|
8886
8871
|
#
|
8887
|
-
# <note markdown="1"> If the
|
8888
|
-
#
|
8889
|
-
#
|
8890
|
-
#
|
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.
|
8891
8876
|
#
|
8892
8877
|
# </note>
|
8893
8878
|
# @return [String]
|
@@ -8919,8 +8904,8 @@ module Aws::ECS
|
|
8919
8904
|
# @!attribute [rw] service_arn
|
8920
8905
|
# The ARN that identifies the service. The ARN contains the
|
8921
8906
|
# `arn:aws:ecs` namespace, followed by the Region of the service, the
|
8922
|
-
#
|
8923
|
-
#
|
8907
|
+
# account ID of the service owner, the `service` namespace, and then
|
8908
|
+
# the service name. For example,
|
8924
8909
|
# `arn:aws:ecs:region:012345678910:service/my-service`.
|
8925
8910
|
# @return [String]
|
8926
8911
|
#
|
@@ -8974,26 +8959,23 @@ module Aws::ECS
|
|
8974
8959
|
# @return [Integer]
|
8975
8960
|
#
|
8976
8961
|
# @!attribute [rw] launch_type
|
8977
|
-
# The
|
8978
|
-
#
|
8979
|
-
#
|
8980
|
-
#
|
8981
|
-
#
|
8982
|
-
#
|
8983
|
-
# [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.
|
8984
8965
|
# @return [String]
|
8985
8966
|
#
|
8986
8967
|
# @!attribute [rw] capacity_provider_strategy
|
8987
|
-
# 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.
|
8988
8971
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
8989
8972
|
#
|
8990
8973
|
# @!attribute [rw] platform_version
|
8991
8974
|
# The platform version on which to run your service. A platform
|
8992
|
-
# version is only specified for tasks
|
8993
|
-
#
|
8994
|
-
#
|
8995
|
-
#
|
8996
|
-
# 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*.
|
8997
8979
|
#
|
8998
8980
|
#
|
8999
8981
|
#
|
@@ -9013,10 +8995,10 @@ module Aws::ECS
|
|
9013
8995
|
# @return [Types::DeploymentConfiguration]
|
9014
8996
|
#
|
9015
8997
|
# @!attribute [rw] task_sets
|
9016
|
-
# Information about a set of Amazon ECS tasks in either an
|
9017
|
-
#
|
9018
|
-
#
|
9019
|
-
#
|
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.
|
9020
9002
|
# @return [Array<Types::TaskSet>]
|
9021
9003
|
#
|
9022
9004
|
# @!attribute [rw] deployments
|
@@ -9119,9 +9101,9 @@ module Aws::ECS
|
|
9119
9101
|
#
|
9120
9102
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
9121
9103
|
# of such as a prefix for either keys or values as it is reserved
|
9122
|
-
# for
|
9123
|
-
# this prefix. Tags with this prefix do not count
|
9124
|
-
# 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.
|
9125
9107
|
# @return [Array<Types::Tag>]
|
9126
9108
|
#
|
9127
9109
|
# @!attribute [rw] created_by
|
@@ -9242,7 +9224,7 @@ module Aws::ECS
|
|
9242
9224
|
#
|
9243
9225
|
# @!attribute [rw] registry_arn
|
9244
9226
|
# The Amazon Resource Name (ARN) of the service registry. The
|
9245
|
-
# currently supported service registry is
|
9227
|
+
# currently supported service registry is Cloud Map. For more
|
9246
9228
|
# information, see [CreateService][1].
|
9247
9229
|
#
|
9248
9230
|
#
|
@@ -9519,9 +9501,9 @@ module Aws::ECS
|
|
9519
9501
|
#
|
9520
9502
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
9521
9503
|
# of such as a prefix for either keys or values as it is reserved
|
9522
|
-
# for
|
9523
|
-
# this prefix. Tags with this prefix do not count
|
9524
|
-
# 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.
|
9525
9507
|
# @return [Array<Types::Tag>]
|
9526
9508
|
#
|
9527
9509
|
# @!attribute [rw] task_definition
|
@@ -9932,10 +9914,10 @@ module Aws::ECS
|
|
9932
9914
|
# * Tag keys and values are case-sensitive.
|
9933
9915
|
#
|
9934
9916
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
9935
|
-
# such as a prefix for either keys or values as it is reserved for
|
9936
|
-
# use. You cannot edit or delete tag keys or
|
9937
|
-
# Tags with this prefix do not count against
|
9938
|
-
# 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.
|
9939
9921
|
#
|
9940
9922
|
# @note When making an API call, you may pass Tag
|
9941
9923
|
# data as a hash:
|
@@ -10010,9 +9992,9 @@ module Aws::ECS
|
|
10010
9992
|
#
|
10011
9993
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
10012
9994
|
# of such as a prefix for either keys or values as it is reserved
|
10013
|
-
# for
|
10014
|
-
# this prefix. Tags with this prefix do not count
|
10015
|
-
# 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.
|
10016
9998
|
# @return [Array<Types::Tag>]
|
10017
9999
|
#
|
10018
10000
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TagResourceRequest AWS API Documentation
|
@@ -10222,9 +10204,8 @@ module Aws::ECS
|
|
10222
10204
|
# The platform version on which your task is running. A platform
|
10223
10205
|
# version is only specified for tasks using the Fargate launch type.
|
10224
10206
|
# If one is not specified, the `LATEST` platform version is used by
|
10225
|
-
# default. For more information, see [
|
10226
|
-
#
|
10227
|
-
# Guide*.
|
10207
|
+
# default. For more information, see [Fargate Platform Versions][1] in
|
10208
|
+
# the *Amazon Elastic Container Service Developer Guide*.
|
10228
10209
|
#
|
10229
10210
|
#
|
10230
10211
|
#
|
@@ -10295,9 +10276,9 @@ module Aws::ECS
|
|
10295
10276
|
#
|
10296
10277
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
10297
10278
|
# of such as a prefix for either keys or values as it is reserved
|
10298
|
-
# for
|
10299
|
-
# this prefix. Tags with this prefix do not count
|
10300
|
-
# 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.
|
10301
10282
|
# @return [Array<Types::Tag>]
|
10302
10283
|
#
|
10303
10284
|
# @!attribute [rw] task_arn
|
@@ -10398,9 +10379,9 @@ module Aws::ECS
|
|
10398
10379
|
# @return [String]
|
10399
10380
|
#
|
10400
10381
|
# @!attribute [rw] task_role_arn
|
10401
|
-
# The short name or full Amazon Resource Name (ARN) of the
|
10402
|
-
#
|
10403
|
-
#
|
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
|
10404
10385
|
# information, see [Amazon ECS Task Role][1] in the *Amazon Elastic
|
10405
10386
|
# Container Service Developer Guide*.
|
10406
10387
|
#
|
@@ -10419,11 +10400,11 @@ module Aws::ECS
|
|
10419
10400
|
#
|
10420
10401
|
# @!attribute [rw] execution_role_arn
|
10421
10402
|
# The Amazon Resource Name (ARN) of the task execution role that
|
10422
|
-
# grants the Amazon ECS container agent permission to make
|
10423
|
-
# calls on your behalf. The task execution IAM role is
|
10424
|
-
# depending on the requirements of your task. For more
|
10425
|
-
# see [Amazon ECS task execution IAM role][1] in the
|
10426
|
-
# 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*.
|
10427
10408
|
#
|
10428
10409
|
#
|
10429
10410
|
#
|
@@ -10436,13 +10417,15 @@ module Aws::ECS
|
|
10436
10417
|
# network mode is specified, the default is `bridge`.
|
10437
10418
|
#
|
10438
10419
|
# For Amazon ECS tasks on Fargate, the `awsvpc` network mode is
|
10439
|
-
# required. For Amazon ECS tasks on Amazon EC2 instances, any
|
10440
|
-
# mode can be used.
|
10441
|
-
#
|
10442
|
-
#
|
10443
|
-
#
|
10444
|
-
#
|
10445
|
-
#
|
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.
|
10446
10429
|
#
|
10447
10430
|
# With the `host` and `awsvpc` network modes, exposed container ports
|
10448
10431
|
# are mapped directly to the corresponding host port (for the `host`
|
@@ -10460,22 +10443,10 @@ module Aws::ECS
|
|
10460
10443
|
# For more information, see [Task Networking][1] in the *Amazon
|
10461
10444
|
# Elastic Container Service Developer Guide*.
|
10462
10445
|
#
|
10463
|
-
# <note markdown="1"> Currently, only Amazon ECS-optimized AMIs, other Amazon Linux
|
10464
|
-
# variants with the `ecs-init` package, or AWS Fargate infrastructure
|
10465
|
-
# support the `awsvpc` network mode.
|
10466
|
-
#
|
10467
|
-
# </note>
|
10468
|
-
#
|
10469
10446
|
# If the network mode is `host`, you cannot run multiple
|
10470
10447
|
# instantiations of the same task on a single container instance when
|
10471
10448
|
# port mappings are used.
|
10472
10449
|
#
|
10473
|
-
# Docker for Windows uses different network modes than Docker for
|
10474
|
-
# Linux. When you register a task definition with Windows containers,
|
10475
|
-
# you must not specify a network mode. If you use the console to
|
10476
|
-
# register a task definition with Windows containers, you must choose
|
10477
|
-
# the `<default>` network mode object.
|
10478
|
-
#
|
10479
10450
|
# For more information, see [Network settings][2] in the *Docker run
|
10480
10451
|
# reference*.
|
10481
10452
|
#
|
@@ -10500,7 +10471,7 @@ module Aws::ECS
|
|
10500
10471
|
# Elastic Container Service Developer Guide*.
|
10501
10472
|
#
|
10502
10473
|
# <note markdown="1"> The `host` and `sourcePath` parameters are not supported for tasks
|
10503
|
-
# run on
|
10474
|
+
# run on Fargate.
|
10504
10475
|
#
|
10505
10476
|
# </note>
|
10506
10477
|
#
|
@@ -10523,7 +10494,7 @@ module Aws::ECS
|
|
10523
10494
|
# EC2 instances. For more information, see [Attributes][1] in the
|
10524
10495
|
# *Amazon Elastic Container Service Developer Guide*.
|
10525
10496
|
#
|
10526
|
-
# <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.
|
10527
10498
|
#
|
10528
10499
|
# </note>
|
10529
10500
|
#
|
@@ -10535,7 +10506,7 @@ module Aws::ECS
|
|
10535
10506
|
# @!attribute [rw] placement_constraints
|
10536
10507
|
# An array of placement constraint objects to use for tasks.
|
10537
10508
|
#
|
10538
|
-
# <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.
|
10539
10510
|
#
|
10540
10511
|
# </note>
|
10541
10512
|
# @return [Array<Types::TaskDefinitionPlacementConstraint>]
|
@@ -10591,9 +10562,9 @@ module Aws::ECS
|
|
10591
10562
|
# optional. For more information regarding container-level memory and
|
10592
10563
|
# memory reservation, see [ContainerDefinition][1].
|
10593
10564
|
#
|
10594
|
-
# If your tasks will be run on
|
10595
|
-
#
|
10596
|
-
#
|
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:
|
10597
10568
|
#
|
10598
10569
|
# * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values:
|
10599
10570
|
# 256 (.25 vCPU)
|
@@ -10634,7 +10605,7 @@ module Aws::ECS
|
|
10634
10605
|
# see [Docker security][2].
|
10635
10606
|
#
|
10636
10607
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
10637
|
-
# on
|
10608
|
+
# on Fargate.
|
10638
10609
|
#
|
10639
10610
|
# </note>
|
10640
10611
|
#
|
@@ -10675,7 +10646,7 @@ module Aws::ECS
|
|
10675
10646
|
# `systemControls` will apply to all containers within a task.
|
10676
10647
|
#
|
10677
10648
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
10678
|
-
# on
|
10649
|
+
# on Fargate.
|
10679
10650
|
#
|
10680
10651
|
# </note>
|
10681
10652
|
#
|
@@ -10754,8 +10725,7 @@ module Aws::ECS
|
|
10754
10725
|
# definition. For more information, see [Task placement constraints][1]
|
10755
10726
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
10756
10727
|
#
|
10757
|
-
# <note markdown="1"> Task placement constraints are not supported for tasks run on
|
10758
|
-
# Fargate.
|
10728
|
+
# <note markdown="1"> Task placement constraints are not supported for tasks run on Fargate.
|
10759
10729
|
#
|
10760
10730
|
# </note>
|
10761
10731
|
#
|
@@ -10873,8 +10843,8 @@ module Aws::ECS
|
|
10873
10843
|
# @!attribute [rw] ephemeral_storage
|
10874
10844
|
# The ephemeral storage setting override for the task.
|
10875
10845
|
#
|
10876
|
-
# <note markdown="1"> This parameter is only supported for tasks hosted on
|
10877
|
-
#
|
10846
|
+
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
|
10847
|
+
# platform version `1.4.0` or later.
|
10878
10848
|
#
|
10879
10849
|
# </note>
|
10880
10850
|
# @return [Types::EphemeralStorage]
|
@@ -10893,10 +10863,10 @@ module Aws::ECS
|
|
10893
10863
|
include Aws::Structure
|
10894
10864
|
end
|
10895
10865
|
|
10896
|
-
# Information about a set of Amazon ECS tasks in either an
|
10897
|
-
#
|
10898
|
-
#
|
10899
|
-
#
|
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.
|
10900
10870
|
#
|
10901
10871
|
# @!attribute [rw] id
|
10902
10872
|
# The ID of the task set.
|
@@ -10918,20 +10888,20 @@ module Aws::ECS
|
|
10918
10888
|
#
|
10919
10889
|
# @!attribute [rw] started_by
|
10920
10890
|
# The tag specified when a task set is started. If the task set is
|
10921
|
-
# created by an
|
10922
|
-
#
|
10891
|
+
# created by an CodeDeploy deployment, the `startedBy` parameter is
|
10892
|
+
# `CODE_DEPLOY`. For a task set created for an external deployment,
|
10923
10893
|
# the startedBy field isn't used.
|
10924
10894
|
# @return [String]
|
10925
10895
|
#
|
10926
10896
|
# @!attribute [rw] external_id
|
10927
10897
|
# The external ID associated with the task set.
|
10928
10898
|
#
|
10929
|
-
# If a task set is created by an
|
10930
|
-
# `externalId` parameter contains the
|
10899
|
+
# If a task set is created by an CodeDeploy deployment, the
|
10900
|
+
# `externalId` parameter contains the CodeDeploy deployment ID.
|
10931
10901
|
#
|
10932
10902
|
# If a task set is created for an external deployment and is
|
10933
10903
|
# associated with a service discovery registry, the `externalId`
|
10934
|
-
# parameter contains the `ECS_TASK_SET_EXTERNAL_ID`
|
10904
|
+
# parameter contains the `ECS_TASK_SET_EXTERNAL_ID` Cloud Map
|
10935
10905
|
# attribute.
|
10936
10906
|
# @return [String]
|
10937
10907
|
#
|
@@ -11001,11 +10971,10 @@ module Aws::ECS
|
|
11001
10971
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
11002
10972
|
#
|
11003
10973
|
# @!attribute [rw] platform_version
|
11004
|
-
# The
|
11005
|
-
#
|
11006
|
-
#
|
11007
|
-
#
|
11008
|
-
# 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*.
|
11009
10978
|
#
|
11010
10979
|
#
|
11011
10980
|
#
|
@@ -11084,9 +11053,9 @@ module Aws::ECS
|
|
11084
11053
|
#
|
11085
11054
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
11086
11055
|
# of such as a prefix for either keys or values as it is reserved
|
11087
|
-
# for
|
11088
|
-
# this prefix. Tags with this prefix do not count
|
11089
|
-
# 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.
|
11090
11059
|
# @return [Array<Types::Tag>]
|
11091
11060
|
#
|
11092
11061
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TaskSet AWS API Documentation
|
@@ -11646,10 +11615,10 @@ module Aws::ECS
|
|
11646
11615
|
# providers can be created with the CreateCapacityProvider API
|
11647
11616
|
# operation.
|
11648
11617
|
#
|
11649
|
-
# To use a
|
11650
|
-
#
|
11651
|
-
#
|
11652
|
-
#
|
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.
|
11653
11622
|
#
|
11654
11623
|
# The PutClusterCapacityProviders API operation is used to update the
|
11655
11624
|
# list of available capacity providers for a cluster after the cluster
|
@@ -11693,8 +11662,8 @@ module Aws::ECS
|
|
11693
11662
|
# The platform version on which your tasks in the service are running.
|
11694
11663
|
# A platform version is only specified for tasks using the Fargate
|
11695
11664
|
# launch type. If a platform version is not specified, the `LATEST`
|
11696
|
-
# platform version is used by default. For more information, see
|
11697
|
-
# 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
|
11698
11667
|
# Service Developer Guide*.
|
11699
11668
|
#
|
11700
11669
|
#
|
@@ -11942,7 +11911,7 @@ module Aws::ECS
|
|
11942
11911
|
# Windows containers only support the use of the `local` driver. To
|
11943
11912
|
# use bind mounts, specify the `host` parameter instead.
|
11944
11913
|
#
|
11945
|
-
# <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.
|
11946
11915
|
#
|
11947
11916
|
# </note>
|
11948
11917
|
# @return [Types::DockerVolumeConfiguration]
|