aws-sdk-ecs 1.80.0 → 1.84.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 +145 -140
- data/lib/aws-sdk-ecs/types.rb +284 -281
- 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,13 @@ 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
|
+
#
|
429
|
+
# A capacity provider strategy may contain a maximum of 6 capacity
|
430
|
+
# providers.
|
428
431
|
#
|
429
432
|
# @note When making an API call, you may pass CapacityProviderStrategyItem
|
430
433
|
# data as a hash:
|
@@ -505,8 +508,8 @@ module Aws::ECS
|
|
505
508
|
# @!attribute [rw] cluster_arn
|
506
509
|
# The Amazon Resource Name (ARN) that identifies the cluster. The ARN
|
507
510
|
# contains the `arn:aws:ecs` namespace, followed by the Region of the
|
508
|
-
# cluster, the
|
509
|
-
# namespace, and then the cluster name. For example,
|
511
|
+
# cluster, the Amazon Web Services account ID of the cluster owner,
|
512
|
+
# the `cluster` namespace, and then the cluster name. For example,
|
510
513
|
# `arn:aws:ecs:region:012345678910:cluster/test`.
|
511
514
|
# @return [String]
|
512
515
|
#
|
@@ -615,9 +618,9 @@ module Aws::ECS
|
|
615
618
|
#
|
616
619
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
617
620
|
# 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.
|
621
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
622
|
+
# values with this prefix. Tags with this prefix do not count
|
623
|
+
# against your tags per resource limit.
|
621
624
|
# @return [Array<Types::Tag>]
|
622
625
|
#
|
623
626
|
# @!attribute [rw] settings
|
@@ -1635,7 +1638,7 @@ module Aws::ECS
|
|
1635
1638
|
# `--privileged` option to [docker run][3].
|
1636
1639
|
#
|
1637
1640
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
1638
|
-
# on
|
1641
|
+
# on Fargate.
|
1639
1642
|
#
|
1640
1643
|
# </note>
|
1641
1644
|
#
|
@@ -2054,16 +2057,17 @@ module Aws::ECS
|
|
2054
2057
|
# @!attribute [rw] container_instance_arn
|
2055
2058
|
# The Amazon Resource Name (ARN) of the container instance. The ARN
|
2056
2059
|
# contains the `arn:aws:ecs` namespace, followed by the Region of the
|
2057
|
-
# container instance, the
|
2058
|
-
# owner, the `container-instance` namespace, and
|
2059
|
-
# instance ID. For example,
|
2060
|
+
# container instance, the Amazon Web Services account ID of the
|
2061
|
+
# container instance owner, the `container-instance` namespace, and
|
2062
|
+
# then the container instance ID. For example,
|
2060
2063
|
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
2061
2064
|
# @return [String]
|
2062
2065
|
#
|
2063
2066
|
# @!attribute [rw] ec2_instance_id
|
2064
2067
|
# The ID of the container instance. For Amazon EC2 instances, this
|
2065
2068
|
# value is the Amazon EC2 instance ID. For external instances, this
|
2066
|
-
# value is the
|
2069
|
+
# value is the Amazon Web Services Systems Manager managed instance
|
2070
|
+
# ID.
|
2067
2071
|
# @return [String]
|
2068
2072
|
#
|
2069
2073
|
# @!attribute [rw] capacity_provider_name
|
@@ -2204,9 +2208,9 @@ module Aws::ECS
|
|
2204
2208
|
#
|
2205
2209
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
2206
2210
|
# 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.
|
2211
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
2212
|
+
# values with this prefix. Tags with this prefix do not count
|
2213
|
+
# against your tags per resource limit.
|
2210
2214
|
# @return [Array<Types::Tag>]
|
2211
2215
|
#
|
2212
2216
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerInstance AWS API Documentation
|
@@ -2457,9 +2461,9 @@ module Aws::ECS
|
|
2457
2461
|
#
|
2458
2462
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
2459
2463
|
# 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.
|
2464
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
2465
|
+
# values with this prefix. Tags with this prefix do not count
|
2466
|
+
# against your tags per resource limit.
|
2463
2467
|
# @return [Array<Types::Tag>]
|
2464
2468
|
#
|
2465
2469
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateCapacityProviderRequest AWS API Documentation
|
@@ -2557,9 +2561,9 @@ module Aws::ECS
|
|
2557
2561
|
#
|
2558
2562
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
2559
2563
|
# 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.
|
2564
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
2565
|
+
# values with this prefix. Tags with this prefix do not count
|
2566
|
+
# against your tags per resource limit.
|
2563
2567
|
# @return [Array<Types::Tag>]
|
2564
2568
|
#
|
2565
2569
|
# @!attribute [rw] settings
|
@@ -2586,10 +2590,10 @@ module Aws::ECS
|
|
2586
2590
|
# providers can be created with the CreateCapacityProvider API
|
2587
2591
|
# operation.
|
2588
2592
|
#
|
2589
|
-
# To use a
|
2590
|
-
#
|
2591
|
-
#
|
2592
|
-
#
|
2593
|
+
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
2594
|
+
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
2595
|
+
# are available to all accounts and only need to be associated with a
|
2596
|
+
# cluster to be used.
|
2593
2597
|
#
|
2594
2598
|
# The PutClusterCapacityProviders API operation is used to update the
|
2595
2599
|
# list of available capacity providers for a cluster after the cluster
|
@@ -2599,7 +2603,7 @@ module Aws::ECS
|
|
2599
2603
|
# @!attribute [rw] default_capacity_provider_strategy
|
2600
2604
|
# The capacity provider strategy to set as the default for the
|
2601
2605
|
# cluster. When a default capacity provider strategy is set for a
|
2602
|
-
# cluster, when calling the RunTask or CreateService APIs
|
2606
|
+
# cluster, when calling the RunTask or CreateService APIs with no
|
2603
2607
|
# capacity provider strategy or launch type specified, the default
|
2604
2608
|
# capacity provider strategy for the cluster is used.
|
2605
2609
|
#
|
@@ -2749,15 +2753,15 @@ module Aws::ECS
|
|
2749
2753
|
#
|
2750
2754
|
# If the service is using the `CODE_DEPLOY` deployment controller, the
|
2751
2755
|
# 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
|
-
#
|
2756
|
+
# Network Load Balancer. When creating an CodeDeploy deployment group,
|
2757
|
+
# you specify two target groups (referred to as a `targetGroupPair`).
|
2758
|
+
# During a deployment, CodeDeploy determines which task set in your
|
2759
|
+
# service has the status `PRIMARY` and associates one target group
|
2760
|
+
# with it, and then associates the other target group with the
|
2761
|
+
# replacement task set. The load balancer can also have up to two
|
2762
|
+
# listeners: a required listener for production traffic and an
|
2763
|
+
# optional listener that allows you perform validation tests with
|
2764
|
+
# Lambda functions before routing production traffic to it.
|
2761
2765
|
#
|
2762
2766
|
# After you create a service using the `ECS` deployment controller,
|
2763
2767
|
# the load balancer name or target group ARN, container name, and
|
@@ -2829,13 +2833,12 @@ module Aws::ECS
|
|
2829
2833
|
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
2830
2834
|
# Container Service Developer Guide*.
|
2831
2835
|
#
|
2832
|
-
# The `FARGATE` launch type runs your tasks on
|
2836
|
+
# The `FARGATE` launch type runs your tasks on Fargate On-Demand
|
2833
2837
|
# infrastructure.
|
2834
2838
|
#
|
2835
2839
|
# <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*.
|
2840
|
+
# provider strategy must be used. For more information, see [Fargate
|
2841
|
+
# capacity providers][2] in the *Amazon ECS User Guide for Fargate*.
|
2839
2842
|
#
|
2840
2843
|
# </note>
|
2841
2844
|
#
|
@@ -2862,13 +2865,16 @@ module Aws::ECS
|
|
2862
2865
|
# parameter must be omitted. If no `capacityProviderStrategy` or
|
2863
2866
|
# `launchType` is specified, the `defaultCapacityProviderStrategy` for
|
2864
2867
|
# the cluster is used.
|
2868
|
+
#
|
2869
|
+
# A capacity provider strategy may contain a maximum of 6 capacity
|
2870
|
+
# providers.
|
2865
2871
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
2866
2872
|
#
|
2867
2873
|
# @!attribute [rw] platform_version
|
2868
2874
|
# The platform version that your tasks in the service are running on.
|
2869
2875
|
# A platform version is specified only for tasks using the Fargate
|
2870
2876
|
# launch type. If one isn't specified, the `LATEST` platform version
|
2871
|
-
# is used by default. For more information, see [
|
2877
|
+
# is used by default. For more information, see [Fargate platform
|
2872
2878
|
# versions][1] in the *Amazon Elastic Container Service Developer
|
2873
2879
|
# Guide*.
|
2874
2880
|
#
|
@@ -2924,7 +2930,7 @@ module Aws::ECS
|
|
2924
2930
|
#
|
2925
2931
|
# @!attribute [rw] placement_strategy
|
2926
2932
|
# The placement strategy objects to use for tasks in your service. You
|
2927
|
-
# can specify a maximum of
|
2933
|
+
# can specify a maximum of 5 strategy rules per service.
|
2928
2934
|
# @return [Array<Types::PlacementStrategy>]
|
2929
2935
|
#
|
2930
2936
|
# @!attribute [rw] network_configuration
|
@@ -3022,9 +3028,9 @@ module Aws::ECS
|
|
3022
3028
|
#
|
3023
3029
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
3024
3030
|
# 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.
|
3031
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
3032
|
+
# values with this prefix. Tags with this prefix do not count
|
3033
|
+
# against your tags per resource limit.
|
3028
3034
|
# @return [Array<Types::Tag>]
|
3029
3035
|
#
|
3030
3036
|
# @!attribute [rw] enable_ecs_managed_tags
|
@@ -3084,6 +3090,10 @@ module Aws::ECS
|
|
3084
3090
|
# @!attribute [rw] service
|
3085
3091
|
# The full description of your service following the create call.
|
3086
3092
|
#
|
3093
|
+
# A service will return either a `capacityProviderStrategy` or
|
3094
|
+
# `launchType` parameter, but not both, depending on which one was
|
3095
|
+
# specified during creation.
|
3096
|
+
#
|
3087
3097
|
# If a service is using the `ECS` deployment controller, the
|
3088
3098
|
# `deploymentController` and `taskSets` parameters will not be
|
3089
3099
|
# returned.
|
@@ -3169,8 +3179,8 @@ module Aws::ECS
|
|
3169
3179
|
# An optional non-unique tag that identifies this task set in external
|
3170
3180
|
# systems. If the task set is associated with a service discovery
|
3171
3181
|
# registry, the tasks in this task set will have the
|
3172
|
-
# `ECS_TASK_SET_EXTERNAL_ID`
|
3173
|
-
#
|
3182
|
+
# `ECS_TASK_SET_EXTERNAL_ID` Cloud Map attribute set to the provided
|
3183
|
+
# value.
|
3174
3184
|
# @return [String]
|
3175
3185
|
#
|
3176
3186
|
# @!attribute [rw] task_definition
|
@@ -3229,10 +3239,10 @@ module Aws::ECS
|
|
3229
3239
|
# providers can be created with the CreateCapacityProvider API
|
3230
3240
|
# operation.
|
3231
3241
|
#
|
3232
|
-
# To use a
|
3233
|
-
#
|
3234
|
-
#
|
3235
|
-
#
|
3242
|
+
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
3243
|
+
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
3244
|
+
# are available to all accounts and only need to be associated with a
|
3245
|
+
# cluster to be used.
|
3236
3246
|
#
|
3237
3247
|
# The PutClusterCapacityProviders API operation is used to update the
|
3238
3248
|
# list of available capacity providers for a cluster after the cluster
|
@@ -3283,9 +3293,9 @@ module Aws::ECS
|
|
3283
3293
|
#
|
3284
3294
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
3285
3295
|
# 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.
|
3296
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
3297
|
+
# values with this prefix. Tags with this prefix do not count
|
3298
|
+
# against your tags per resource limit.
|
3289
3299
|
# @return [Array<Types::Tag>]
|
3290
3300
|
#
|
3291
3301
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateTaskSetRequest AWS API Documentation
|
@@ -3309,10 +3319,10 @@ module Aws::ECS
|
|
3309
3319
|
end
|
3310
3320
|
|
3311
3321
|
# @!attribute [rw] task_set
|
3312
|
-
# Information about a set of Amazon ECS tasks in either an
|
3313
|
-
#
|
3314
|
-
#
|
3315
|
-
#
|
3322
|
+
# Information about a set of Amazon ECS tasks in either an CodeDeploy
|
3323
|
+
# or an `EXTERNAL` deployment. A task set includes details such as the
|
3324
|
+
# desired number of tasks, how many tasks are running, and whether the
|
3325
|
+
# task set serves production traffic.
|
3316
3326
|
# @return [Types::TaskSet]
|
3317
3327
|
#
|
3318
3328
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateTaskSetResponse AWS API Documentation
|
@@ -3670,7 +3680,7 @@ module Aws::ECS
|
|
3670
3680
|
# The platform version on which your tasks in the service are running.
|
3671
3681
|
# A platform version is only specified for tasks using the Fargate
|
3672
3682
|
# launch type. If one is not specified, the `LATEST` platform version
|
3673
|
-
# is used by default. For more information, see [
|
3683
|
+
# is used by default. For more information, see [Fargate Platform
|
3674
3684
|
# Versions][1] in the *Amazon Elastic Container Service Developer
|
3675
3685
|
# Guide*.
|
3676
3686
|
#
|
@@ -3897,9 +3907,9 @@ module Aws::ECS
|
|
3897
3907
|
# CODE\_DEPLOY
|
3898
3908
|
#
|
3899
3909
|
# : The blue/green (`CODE_DEPLOY`) deployment type uses the blue/green
|
3900
|
-
# deployment model powered by
|
3901
|
-
#
|
3902
|
-
#
|
3910
|
+
# deployment model powered by CodeDeploy, which allows you to verify
|
3911
|
+
# a new deployment of a service before sending production traffic to
|
3912
|
+
# it.
|
3903
3913
|
#
|
3904
3914
|
# EXTERNAL
|
3905
3915
|
#
|
@@ -3934,9 +3944,9 @@ module Aws::ECS
|
|
3934
3944
|
# @!attribute [rw] container_instance
|
3935
3945
|
# The container instance ID or full ARN of the container instance to
|
3936
3946
|
# deregister. The ARN contains the `arn:aws:ecs` namespace, followed
|
3937
|
-
# by the Region of the container instance, the
|
3938
|
-
# container instance owner, the `container-instance`
|
3939
|
-
# then the container instance ID. For example,
|
3947
|
+
# by the Region of the container instance, the Amazon Web Services
|
3948
|
+
# account ID of the container instance owner, the `container-instance`
|
3949
|
+
# namespace, and then the container instance ID. For example,
|
3940
3950
|
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
3941
3951
|
# @return [String]
|
3942
3952
|
#
|
@@ -4122,6 +4132,9 @@ module Aws::ECS
|
|
4122
4132
|
# If `SETTINGS` is specified, the settings for the cluster are
|
4123
4133
|
# included.
|
4124
4134
|
#
|
4135
|
+
# If `CONFIGURATIONS` is specified, the configuration for the cluster
|
4136
|
+
# is included.
|
4137
|
+
#
|
4125
4138
|
# If `STATISTICS` is specified, the task and service count is
|
4126
4139
|
# included, separated by launch type.
|
4127
4140
|
#
|
@@ -4327,9 +4340,9 @@ module Aws::ECS
|
|
4327
4340
|
#
|
4328
4341
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
4329
4342
|
# 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.
|
4343
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
4344
|
+
# values with this prefix. Tags with this prefix do not count
|
4345
|
+
# against your tags per resource limit.
|
4333
4346
|
# @return [Array<Types::Tag>]
|
4334
4347
|
#
|
4335
4348
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskDefinitionResponse AWS API Documentation
|
@@ -4499,9 +4512,9 @@ module Aws::ECS
|
|
4499
4512
|
# @!attribute [rw] container_instance
|
4500
4513
|
# The container instance ID or full ARN of the container instance. The
|
4501
4514
|
# ARN contains the `arn:aws:ecs` namespace, followed by the Region of
|
4502
|
-
# the container instance, the
|
4503
|
-
# owner, the `container-instance` namespace, and
|
4504
|
-
# instance ID. For example,
|
4515
|
+
# the container instance, the Amazon Web Services account ID of the
|
4516
|
+
# container instance owner, the `container-instance` namespace, and
|
4517
|
+
# then the container instance ID. For example,
|
4505
4518
|
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
4506
4519
|
# @return [String]
|
4507
4520
|
#
|
@@ -4811,11 +4824,11 @@ module Aws::ECS
|
|
4811
4824
|
|
4812
4825
|
# The amount of ephemeral storage to allocate for the task. This
|
4813
4826
|
# 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
|
4827
|
+
# available, beyond the default amount, for tasks hosted on Fargate. For
|
4828
|
+
# more information, see [Fargate task storage][1] in the *Amazon ECS
|
4829
|
+
# User Guide for Fargate*.
|
4817
4830
|
#
|
4818
|
-
# <note markdown="1"> This parameter is only supported for tasks hosted on
|
4831
|
+
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
|
4819
4832
|
# platform version `1.4.0` or later.
|
4820
4833
|
#
|
4821
4834
|
# </note>
|
@@ -4863,8 +4876,8 @@ module Aws::ECS
|
|
4863
4876
|
# }
|
4864
4877
|
#
|
4865
4878
|
# @!attribute [rw] kms_key_id
|
4866
|
-
# Specify an
|
4867
|
-
#
|
4879
|
+
# Specify an Key Management Service key ID to encrypt the data between
|
4880
|
+
# the local client and the container.
|
4868
4881
|
# @return [String]
|
4869
4882
|
#
|
4870
4883
|
# @!attribute [rw] logging
|
@@ -5069,14 +5082,14 @@ module Aws::ECS
|
|
5069
5082
|
# @!attribute [rw] credentials_parameter
|
5070
5083
|
# The authorization credential option to use. The authorization
|
5071
5084
|
# credential options can be provided using either the Amazon Resource
|
5072
|
-
# Name (ARN) of an
|
5073
|
-
#
|
5085
|
+
# Name (ARN) of an Secrets Manager secret or SSM Parameter Store
|
5086
|
+
# parameter. The ARNs refer to the stored credentials.
|
5074
5087
|
# @return [String]
|
5075
5088
|
#
|
5076
5089
|
# @!attribute [rw] domain
|
5077
|
-
# A fully qualified domain name hosted by an [
|
5078
|
-
#
|
5079
|
-
#
|
5090
|
+
# A fully qualified domain name hosted by an [Directory Service][1]
|
5091
|
+
# Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon
|
5092
|
+
# EC2.
|
5080
5093
|
#
|
5081
5094
|
#
|
5082
5095
|
#
|
@@ -5204,8 +5217,8 @@ module Aws::ECS
|
|
5204
5217
|
# FireLens Configuration][1] in the *Amazon Elastic Container Service
|
5205
5218
|
# Developer Guide*.
|
5206
5219
|
#
|
5207
|
-
# <note markdown="1"> Tasks hosted on
|
5208
|
-
#
|
5220
|
+
# <note markdown="1"> Tasks hosted on Fargate only support the `file` configuration file
|
5221
|
+
# type.
|
5209
5222
|
#
|
5210
5223
|
# </note>
|
5211
5224
|
#
|
@@ -5269,7 +5282,7 @@ module Aws::ECS
|
|
5269
5282
|
#
|
5270
5283
|
# * Container health checks are supported for Fargate tasks if you are
|
5271
5284
|
# using platform version 1.1.0 or greater. For more information, see
|
5272
|
-
# [
|
5285
|
+
# [Fargate Platform Versions][2].
|
5273
5286
|
#
|
5274
5287
|
# * Container health checks are not supported for tasks that are part of
|
5275
5288
|
# a service that is configured to use a Classic Load Balancer.
|
@@ -5294,10 +5307,19 @@ module Aws::ECS
|
|
5294
5307
|
# A string array representing the command that the container runs to
|
5295
5308
|
# determine if it is healthy. The string array must start with `CMD`
|
5296
5309
|
# to execute the command arguments directly, or `CMD-SHELL` to run the
|
5297
|
-
# command with the container's default shell.
|
5310
|
+
# command with the container's default shell.
|
5311
|
+
#
|
5312
|
+
# When you use the Amazon Web Services Management Console JSON panel,
|
5313
|
+
# the Command Line Interface, or the APIs, you should enclose the list
|
5314
|
+
# of commands in brackets, as shown below.
|
5298
5315
|
#
|
5299
5316
|
# `[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]`
|
5300
5317
|
#
|
5318
|
+
# You do not need to include the brackets when you use the Amazon Web
|
5319
|
+
# Services Management Consoleas shown below.
|
5320
|
+
#
|
5321
|
+
# ` "CMD-SHELL", "curl -f http://localhost/ || exit 1" `
|
5322
|
+
#
|
5301
5323
|
# An exit code of 0 indicates success, and non-zero exit code
|
5302
5324
|
# indicates failure. For more information, see `HealthCheck` in the
|
5303
5325
|
# [Create a container][1] section of the [Docker Remote API][2].
|
@@ -5517,7 +5539,7 @@ module Aws::ECS
|
|
5517
5539
|
# `CapAdd` in the [Create a container][1] section of the [Docker
|
5518
5540
|
# Remote API][2] and the `--cap-add` option to [docker run][3].
|
5519
5541
|
#
|
5520
|
-
# <note markdown="1"> Tasks launched on
|
5542
|
+
# <note markdown="1"> Tasks launched on Fargate only support adding the `SYS_PTRACE`
|
5521
5543
|
# kernel capability.
|
5522
5544
|
#
|
5523
5545
|
# </note>
|
@@ -6651,7 +6673,7 @@ module Aws::ECS
|
|
6651
6673
|
# configuration][5] in the *Amazon Elastic Container Service Developer
|
6652
6674
|
# Guide*.
|
6653
6675
|
#
|
6654
|
-
# * For tasks on
|
6676
|
+
# * For tasks on Fargate, because you do not have access to the
|
6655
6677
|
# underlying infrastructure your tasks are hosted on, any additional
|
6656
6678
|
# software needed will have to be installed outside of the task. For
|
6657
6679
|
# example, the Fluentd output aggregators or a remote host running
|
@@ -6684,7 +6706,7 @@ module Aws::ECS
|
|
6684
6706
|
# @!attribute [rw] log_driver
|
6685
6707
|
# The log driver to use for the container.
|
6686
6708
|
#
|
6687
|
-
# For tasks on
|
6709
|
+
# For tasks on Fargate, the supported log drivers are `awslogs`,
|
6688
6710
|
# `splunk`, and `awsfirelens`.
|
6689
6711
|
#
|
6690
6712
|
# For tasks hosted on Amazon EC2 instances, the supported log drivers
|
@@ -7066,11 +7088,11 @@ module Aws::ECS
|
|
7066
7088
|
# @return [String]
|
7067
7089
|
#
|
7068
7090
|
# @!attribute [rw] expression
|
7069
|
-
# A cluster query language expression to apply to the constraint.
|
7070
|
-
#
|
7071
|
-
#
|
7072
|
-
#
|
7073
|
-
# Guide*.
|
7091
|
+
# A cluster query language expression to apply to the constraint. The
|
7092
|
+
# expression can have a maximum length of 2000 characters. You can't
|
7093
|
+
# specify an expression if the constraint type is `distinctInstance`.
|
7094
|
+
# For more information, see [Cluster query language][1] in the *Amazon
|
7095
|
+
# Elastic Container Service Developer Guide*.
|
7074
7096
|
#
|
7075
7097
|
#
|
7076
7098
|
#
|
@@ -7542,10 +7564,10 @@ module Aws::ECS
|
|
7542
7564
|
# providers can be created with the CreateCapacityProvider API
|
7543
7565
|
# operation.
|
7544
7566
|
#
|
7545
|
-
# To use a
|
7546
|
-
#
|
7547
|
-
#
|
7548
|
-
#
|
7567
|
+
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
7568
|
+
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
7569
|
+
# are available to all accounts and only need to be associated with a
|
7570
|
+
# cluster to be used.
|
7549
7571
|
# @return [Array<String>]
|
7550
7572
|
#
|
7551
7573
|
# @!attribute [rw] default_capacity_provider_strategy
|
@@ -7567,10 +7589,10 @@ module Aws::ECS
|
|
7567
7589
|
# providers can be created with the CreateCapacityProvider API
|
7568
7590
|
# operation.
|
7569
7591
|
#
|
7570
|
-
# To use a
|
7571
|
-
#
|
7572
|
-
#
|
7573
|
-
#
|
7592
|
+
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
7593
|
+
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
7594
|
+
# are available to all accounts and only need to be associated with a
|
7595
|
+
# cluster to be used.
|
7574
7596
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
7575
7597
|
#
|
7576
7598
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutClusterCapacityProvidersRequest AWS API Documentation
|
@@ -7709,9 +7731,9 @@ module Aws::ECS
|
|
7709
7731
|
#
|
7710
7732
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
7711
7733
|
# 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.
|
7734
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
7735
|
+
# values with this prefix. Tags with this prefix do not count
|
7736
|
+
# against your tags per resource limit.
|
7715
7737
|
# @return [Array<Types::Tag>]
|
7716
7738
|
#
|
7717
7739
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterContainerInstanceRequest AWS API Documentation
|
@@ -7997,11 +8019,11 @@ module Aws::ECS
|
|
7997
8019
|
#
|
7998
8020
|
# @!attribute [rw] execution_role_arn
|
7999
8021
|
# 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*.
|
8022
|
+
# grants the Amazon ECS container agent permission to make Amazon Web
|
8023
|
+
# Services API calls on your behalf. The task execution IAM role is
|
8024
|
+
# required depending on the requirements of your task. For more
|
8025
|
+
# information, see [Amazon ECS task execution IAM role][1] in the
|
8026
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
8005
8027
|
#
|
8006
8028
|
#
|
8007
8029
|
#
|
@@ -8014,13 +8036,15 @@ module Aws::ECS
|
|
8014
8036
|
# network mode is specified, the default is `bridge`.
|
8015
8037
|
#
|
8016
8038
|
# 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
|
-
#
|
8039
|
+
# required. For Amazon ECS tasks on Amazon EC2 Linux instances, any
|
8040
|
+
# network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows
|
8041
|
+
# instances, `<default>` or `awsvpc` can be used. If the network mode
|
8042
|
+
# is set to `none`, you cannot specify port mappings in your container
|
8043
|
+
# definitions, and the tasks containers do not have external
|
8044
|
+
# connectivity. The `host` and `awsvpc` network modes offer the
|
8045
|
+
# highest networking performance for containers because they use the
|
8046
|
+
# EC2 network stack instead of the virtualized network stack provided
|
8047
|
+
# by the `bridge` mode.
|
8024
8048
|
#
|
8025
8049
|
# With the `host` and `awsvpc` network modes, exposed container ports
|
8026
8050
|
# are mapped directly to the corresponding host port (for the `host`
|
@@ -8038,22 +8062,10 @@ module Aws::ECS
|
|
8038
8062
|
# For more information, see [Task Networking][1] in the *Amazon
|
8039
8063
|
# Elastic Container Service Developer Guide*.
|
8040
8064
|
#
|
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
8065
|
# If the network mode is `host`, you cannot run multiple
|
8048
8066
|
# instantiations of the same task on a single container instance when
|
8049
8067
|
# port mappings are used.
|
8050
8068
|
#
|
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
8069
|
# For more information, see [Network settings][2] in the *Docker run
|
8058
8070
|
# reference*.
|
8059
8071
|
#
|
@@ -8187,9 +8199,9 @@ module Aws::ECS
|
|
8187
8199
|
#
|
8188
8200
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
8189
8201
|
# 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.
|
8202
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
8203
|
+
# values with this prefix. Tags with this prefix do not count
|
8204
|
+
# against your tags per resource limit.
|
8193
8205
|
# @return [Array<Types::Tag>]
|
8194
8206
|
#
|
8195
8207
|
# @!attribute [rw] pid_mode
|
@@ -8207,7 +8219,7 @@ module Aws::ECS
|
|
8207
8219
|
# see [Docker security][2].
|
8208
8220
|
#
|
8209
8221
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
8210
|
-
# on
|
8222
|
+
# on Fargate.
|
8211
8223
|
#
|
8212
8224
|
# </note>
|
8213
8225
|
#
|
@@ -8248,7 +8260,7 @@ module Aws::ECS
|
|
8248
8260
|
# `systemControls` will apply to all containers within a task.
|
8249
8261
|
#
|
8250
8262
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
8251
|
-
# on
|
8263
|
+
# on Fargate.
|
8252
8264
|
#
|
8253
8265
|
# </note>
|
8254
8266
|
#
|
@@ -8284,12 +8296,12 @@ module Aws::ECS
|
|
8284
8296
|
# @!attribute [rw] ephemeral_storage
|
8285
8297
|
# The amount of ephemeral storage to allocate for the task. This
|
8286
8298
|
# parameter is used to expand the total amount of ephemeral storage
|
8287
|
-
# available, beyond the default amount, for tasks hosted on
|
8288
|
-
#
|
8289
|
-
#
|
8299
|
+
# available, beyond the default amount, for tasks hosted on Fargate.
|
8300
|
+
# For more information, see [Fargate task storage][1] in the *Amazon
|
8301
|
+
# ECS User Guide for Fargate*.
|
8290
8302
|
#
|
8291
|
-
# <note markdown="1"> This parameter is only supported for tasks hosted on
|
8292
|
-
#
|
8303
|
+
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
|
8304
|
+
# platform version `1.4.0` or later.
|
8293
8305
|
#
|
8294
8306
|
# </note>
|
8295
8307
|
#
|
@@ -8351,11 +8363,11 @@ module Aws::ECS
|
|
8351
8363
|
# The Amazon Resource Name (ARN) of the secret containing the private
|
8352
8364
|
# repository credentials.
|
8353
8365
|
#
|
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.
|
8366
|
+
# <note markdown="1"> When you are using the Amazon ECS API, CLI, or Amazon Web Services
|
8367
|
+
# SDK, if the secret exists in the same Region as the task that you
|
8368
|
+
# are launching then you can use either the full ARN or the name of
|
8369
|
+
# the secret. When you are using the Amazon Web Services Management
|
8370
|
+
# Console, you must specify the full ARN of the secret.
|
8359
8371
|
#
|
8360
8372
|
# </note>
|
8361
8373
|
# @return [String]
|
@@ -8582,6 +8594,12 @@ module Aws::ECS
|
|
8582
8594
|
# parameter must be omitted. If no `capacityProviderStrategy` or
|
8583
8595
|
# `launchType` is specified, the `defaultCapacityProviderStrategy` for
|
8584
8596
|
# the cluster is used.
|
8597
|
+
#
|
8598
|
+
# When you use cluster auto scaling, you must specify
|
8599
|
+
# `capacityProviderStrategy` and not `launchType`.
|
8600
|
+
#
|
8601
|
+
# A capacity provider strategy may contain a maximum of 6 capacity
|
8602
|
+
# providers.
|
8585
8603
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
8586
8604
|
#
|
8587
8605
|
# @!attribute [rw] cluster
|
@@ -8614,7 +8632,7 @@ module Aws::ECS
|
|
8614
8632
|
# @!attribute [rw] group
|
8615
8633
|
# The name of the task group to associate with the task. The default
|
8616
8634
|
# value is the family name of the task definition (for example,
|
8617
|
-
# family:my-family-name).
|
8635
|
+
# `family:my-family-name`).
|
8618
8636
|
# @return [String]
|
8619
8637
|
#
|
8620
8638
|
# @!attribute [rw] launch_type
|
@@ -8622,13 +8640,12 @@ module Aws::ECS
|
|
8622
8640
|
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
8623
8641
|
# Container Service Developer Guide*.
|
8624
8642
|
#
|
8625
|
-
# The `FARGATE` launch type runs your tasks on
|
8643
|
+
# The `FARGATE` launch type runs your tasks on Fargate On-Demand
|
8626
8644
|
# infrastructure.
|
8627
8645
|
#
|
8628
8646
|
# <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*.
|
8647
|
+
# provider strategy must be used. For more information, see [Fargate
|
8648
|
+
# capacity providers][2] in the *Amazon ECS User Guide for Fargate*.
|
8632
8649
|
#
|
8633
8650
|
# </note>
|
8634
8651
|
#
|
@@ -8642,6 +8659,9 @@ module Aws::ECS
|
|
8642
8659
|
# If a `launchType` is specified, the `capacityProviderStrategy`
|
8643
8660
|
# parameter must be omitted.
|
8644
8661
|
#
|
8662
|
+
# When you use cluster auto scaling, you must specify
|
8663
|
+
# `capacityProviderStrategy` and not `launchType`.
|
8664
|
+
#
|
8645
8665
|
#
|
8646
8666
|
#
|
8647
8667
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html
|
@@ -8652,7 +8672,7 @@ module Aws::ECS
|
|
8652
8672
|
# The network configuration for the task. This parameter is required
|
8653
8673
|
# for task definitions that use the `awsvpc` network mode to receive
|
8654
8674
|
# their own elastic network interface, and it is not supported for
|
8655
|
-
# other network modes. For more information, see [Task
|
8675
|
+
# other network modes. For more information, see [Task networking][1]
|
8656
8676
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
8657
8677
|
#
|
8658
8678
|
#
|
@@ -8670,10 +8690,8 @@ module Aws::ECS
|
|
8670
8690
|
# image) on a container or add new environment variables to it with an
|
8671
8691
|
# `environment` override.
|
8672
8692
|
#
|
8673
|
-
#
|
8693
|
+
# A total of 8192 characters are allowed for overrides. This limit
|
8674
8694
|
# includes the JSON formatting characters of the override structure.
|
8675
|
-
#
|
8676
|
-
# </note>
|
8677
8695
|
# @return [Types::TaskOverride]
|
8678
8696
|
#
|
8679
8697
|
# @!attribute [rw] placement_constraints
|
@@ -8684,15 +8702,15 @@ module Aws::ECS
|
|
8684
8702
|
#
|
8685
8703
|
# @!attribute [rw] placement_strategy
|
8686
8704
|
# The placement strategy objects to use for the task. You can specify
|
8687
|
-
# a maximum of
|
8705
|
+
# a maximum of 5 strategy rules per task.
|
8688
8706
|
# @return [Array<Types::PlacementStrategy>]
|
8689
8707
|
#
|
8690
8708
|
# @!attribute [rw] platform_version
|
8691
|
-
# The platform version the task should
|
8692
|
-
# specified for tasks
|
8693
|
-
#
|
8694
|
-
#
|
8695
|
-
#
|
8709
|
+
# The platform version the task should use. A platform version is only
|
8710
|
+
# specified for tasks hosted on Fargate. If one is not specified, the
|
8711
|
+
# `LATEST` platform version is used by default. For more information,
|
8712
|
+
# see [Fargate platform versions][1] in the *Amazon Elastic Container
|
8713
|
+
# Service Developer Guide*.
|
8696
8714
|
#
|
8697
8715
|
#
|
8698
8716
|
#
|
@@ -8712,7 +8730,8 @@ module Aws::ECS
|
|
8712
8730
|
# @return [String]
|
8713
8731
|
#
|
8714
8732
|
# @!attribute [rw] reference_id
|
8715
|
-
# The reference ID to use for the task.
|
8733
|
+
# The reference ID to use for the task. The reference ID can have a
|
8734
|
+
# maximum length of 1024 characters.
|
8716
8735
|
# @return [String]
|
8717
8736
|
#
|
8718
8737
|
# @!attribute [rw] started_by
|
@@ -8754,9 +8773,9 @@ module Aws::ECS
|
|
8754
8773
|
#
|
8755
8774
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
8756
8775
|
# 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.
|
8776
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
8777
|
+
# values with this prefix. Tags with this prefix do not count
|
8778
|
+
# against your tags per resource limit.
|
8760
8779
|
# @return [Array<Types::Tag>]
|
8761
8780
|
#
|
8762
8781
|
# @!attribute [rw] task_definition
|
@@ -8867,13 +8886,13 @@ module Aws::ECS
|
|
8867
8886
|
#
|
8868
8887
|
# @!attribute [rw] value_from
|
8869
8888
|
# The secret to expose to the container. The supported values are
|
8870
|
-
# either the full ARN of the
|
8871
|
-
#
|
8889
|
+
# either the full ARN of the Secrets Manager secret or the full ARN of
|
8890
|
+
# the parameter in the SSM Parameter Store.
|
8872
8891
|
#
|
8873
|
-
# <note markdown="1"> If the
|
8874
|
-
#
|
8875
|
-
#
|
8876
|
-
#
|
8892
|
+
# <note markdown="1"> If the SSM Parameter Store parameter exists in the same Region as
|
8893
|
+
# the task you are launching, then you can use either the full ARN or
|
8894
|
+
# name of the parameter. If the parameter exists in a different
|
8895
|
+
# Region, then the full ARN must be specified.
|
8877
8896
|
#
|
8878
8897
|
# </note>
|
8879
8898
|
# @return [String]
|
@@ -8905,8 +8924,8 @@ module Aws::ECS
|
|
8905
8924
|
# @!attribute [rw] service_arn
|
8906
8925
|
# The ARN that identifies the service. The ARN contains the
|
8907
8926
|
# `arn:aws:ecs` namespace, followed by the Region of the service, the
|
8908
|
-
#
|
8909
|
-
# then the service name. For example,
|
8927
|
+
# Amazon Web Services account ID of the service owner, the `service`
|
8928
|
+
# namespace, and then the service name. For example,
|
8910
8929
|
# `arn:aws:ecs:region:012345678910:service/my-service`.
|
8911
8930
|
# @return [String]
|
8912
8931
|
#
|
@@ -8960,26 +8979,23 @@ module Aws::ECS
|
|
8960
8979
|
# @return [Integer]
|
8961
8980
|
#
|
8962
8981
|
# @!attribute [rw] launch_type
|
8963
|
-
# The
|
8964
|
-
#
|
8965
|
-
#
|
8966
|
-
#
|
8967
|
-
#
|
8968
|
-
#
|
8969
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html
|
8982
|
+
# The launch type the service is using. When using the
|
8983
|
+
# DescribeServices API, this field is omitted if the service was
|
8984
|
+
# created using a capacity provider strategy.
|
8970
8985
|
# @return [String]
|
8971
8986
|
#
|
8972
8987
|
# @!attribute [rw] capacity_provider_strategy
|
8973
|
-
# The capacity provider strategy
|
8988
|
+
# The capacity provider strategy the service is using. When using the
|
8989
|
+
# DescribeServices API, this field is omitted if the service was
|
8990
|
+
# created using a launch type.
|
8974
8991
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
8975
8992
|
#
|
8976
8993
|
# @!attribute [rw] platform_version
|
8977
8994
|
# The platform version on which to run your service. A platform
|
8978
|
-
# version is only specified for tasks
|
8979
|
-
#
|
8980
|
-
#
|
8981
|
-
#
|
8982
|
-
# Guide*.
|
8995
|
+
# version is only specified for tasks hosted on Fargate. If one is not
|
8996
|
+
# specified, the `LATEST` platform version is used by default. For
|
8997
|
+
# more information, see [Fargate Platform Versions][1] in the *Amazon
|
8998
|
+
# Elastic Container Service Developer Guide*.
|
8983
8999
|
#
|
8984
9000
|
#
|
8985
9001
|
#
|
@@ -8999,10 +9015,10 @@ module Aws::ECS
|
|
8999
9015
|
# @return [Types::DeploymentConfiguration]
|
9000
9016
|
#
|
9001
9017
|
# @!attribute [rw] task_sets
|
9002
|
-
# Information about a set of Amazon ECS tasks in either an
|
9003
|
-
#
|
9004
|
-
#
|
9005
|
-
#
|
9018
|
+
# Information about a set of Amazon ECS tasks in either an CodeDeploy
|
9019
|
+
# or an `EXTERNAL` deployment. An Amazon ECS task set includes details
|
9020
|
+
# such as the desired number of tasks, how many tasks are running, and
|
9021
|
+
# whether the task set serves production traffic.
|
9006
9022
|
# @return [Array<Types::TaskSet>]
|
9007
9023
|
#
|
9008
9024
|
# @!attribute [rw] deployments
|
@@ -9105,9 +9121,9 @@ module Aws::ECS
|
|
9105
9121
|
#
|
9106
9122
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
9107
9123
|
# 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.
|
9124
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
9125
|
+
# values with this prefix. Tags with this prefix do not count
|
9126
|
+
# against your tags per resource limit.
|
9111
9127
|
# @return [Array<Types::Tag>]
|
9112
9128
|
#
|
9113
9129
|
# @!attribute [rw] created_by
|
@@ -9228,7 +9244,7 @@ module Aws::ECS
|
|
9228
9244
|
#
|
9229
9245
|
# @!attribute [rw] registry_arn
|
9230
9246
|
# The Amazon Resource Name (ARN) of the service registry. The
|
9231
|
-
# currently supported service registry is
|
9247
|
+
# currently supported service registry is Cloud Map. For more
|
9232
9248
|
# information, see [CreateService][1].
|
9233
9249
|
#
|
9234
9250
|
#
|
@@ -9505,9 +9521,9 @@ module Aws::ECS
|
|
9505
9521
|
#
|
9506
9522
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
9507
9523
|
# 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.
|
9524
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
9525
|
+
# values with this prefix. Tags with this prefix do not count
|
9526
|
+
# against your tags per resource limit.
|
9511
9527
|
# @return [Array<Types::Tag>]
|
9512
9528
|
#
|
9513
9529
|
# @!attribute [rw] task_definition
|
@@ -9918,10 +9934,10 @@ module Aws::ECS
|
|
9918
9934
|
# * Tag keys and values are case-sensitive.
|
9919
9935
|
#
|
9920
9936
|
# * 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.
|
9937
|
+
# such as a prefix for either keys or values as it is reserved for
|
9938
|
+
# Amazon Web Services use. You cannot edit or delete tag keys or
|
9939
|
+
# values with this prefix. Tags with this prefix do not count against
|
9940
|
+
# your tags per resource limit.
|
9925
9941
|
#
|
9926
9942
|
# @note When making an API call, you may pass Tag
|
9927
9943
|
# data as a hash:
|
@@ -9996,9 +10012,9 @@ module Aws::ECS
|
|
9996
10012
|
#
|
9997
10013
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
9998
10014
|
# 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.
|
10015
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
10016
|
+
# values with this prefix. Tags with this prefix do not count
|
10017
|
+
# against your tags per resource limit.
|
10002
10018
|
# @return [Array<Types::Tag>]
|
10003
10019
|
#
|
10004
10020
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TagResourceRequest AWS API Documentation
|
@@ -10208,9 +10224,8 @@ module Aws::ECS
|
|
10208
10224
|
# The platform version on which your task is running. A platform
|
10209
10225
|
# version is only specified for tasks using the Fargate launch type.
|
10210
10226
|
# If one is not specified, the `LATEST` platform version is used by
|
10211
|
-
# default. For more information, see [
|
10212
|
-
#
|
10213
|
-
# Guide*.
|
10227
|
+
# default. For more information, see [Fargate Platform Versions][1] in
|
10228
|
+
# the *Amazon Elastic Container Service Developer Guide*.
|
10214
10229
|
#
|
10215
10230
|
#
|
10216
10231
|
#
|
@@ -10281,9 +10296,9 @@ module Aws::ECS
|
|
10281
10296
|
#
|
10282
10297
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
10283
10298
|
# 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.
|
10299
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
10300
|
+
# values with this prefix. Tags with this prefix do not count
|
10301
|
+
# against your tags per resource limit.
|
10287
10302
|
# @return [Array<Types::Tag>]
|
10288
10303
|
#
|
10289
10304
|
# @!attribute [rw] task_arn
|
@@ -10384,9 +10399,9 @@ module Aws::ECS
|
|
10384
10399
|
# @return [String]
|
10385
10400
|
#
|
10386
10401
|
# @!attribute [rw] task_role_arn
|
10387
|
-
# The short name or full Amazon Resource Name (ARN) of the
|
10388
|
-
#
|
10389
|
-
#
|
10402
|
+
# The short name or full Amazon Resource Name (ARN) of the Identity
|
10403
|
+
# and Access Management role that grants containers in the task
|
10404
|
+
# permission to call Amazon Web Services APIs on your behalf. For more
|
10390
10405
|
# information, see [Amazon ECS Task Role][1] in the *Amazon Elastic
|
10391
10406
|
# Container Service Developer Guide*.
|
10392
10407
|
#
|
@@ -10405,11 +10420,11 @@ module Aws::ECS
|
|
10405
10420
|
#
|
10406
10421
|
# @!attribute [rw] execution_role_arn
|
10407
10422
|
# 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*.
|
10423
|
+
# grants the Amazon ECS container agent permission to make Amazon Web
|
10424
|
+
# Services API calls on your behalf. The task execution IAM role is
|
10425
|
+
# required depending on the requirements of your task. For more
|
10426
|
+
# information, see [Amazon ECS task execution IAM role][1] in the
|
10427
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
10413
10428
|
#
|
10414
10429
|
#
|
10415
10430
|
#
|
@@ -10422,13 +10437,15 @@ module Aws::ECS
|
|
10422
10437
|
# network mode is specified, the default is `bridge`.
|
10423
10438
|
#
|
10424
10439
|
# 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
|
-
#
|
10440
|
+
# required. For Amazon ECS tasks on Amazon EC2 Linux instances, any
|
10441
|
+
# network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows
|
10442
|
+
# instances, `<default>` or `awsvpc` can be used. If the network mode
|
10443
|
+
# is set to `none`, you cannot specify port mappings in your container
|
10444
|
+
# definitions, and the tasks containers do not have external
|
10445
|
+
# connectivity. The `host` and `awsvpc` network modes offer the
|
10446
|
+
# highest networking performance for containers because they use the
|
10447
|
+
# EC2 network stack instead of the virtualized network stack provided
|
10448
|
+
# by the `bridge` mode.
|
10432
10449
|
#
|
10433
10450
|
# With the `host` and `awsvpc` network modes, exposed container ports
|
10434
10451
|
# are mapped directly to the corresponding host port (for the `host`
|
@@ -10446,22 +10463,10 @@ module Aws::ECS
|
|
10446
10463
|
# For more information, see [Task Networking][1] in the *Amazon
|
10447
10464
|
# Elastic Container Service Developer Guide*.
|
10448
10465
|
#
|
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
10466
|
# If the network mode is `host`, you cannot run multiple
|
10456
10467
|
# instantiations of the same task on a single container instance when
|
10457
10468
|
# port mappings are used.
|
10458
10469
|
#
|
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
10470
|
# For more information, see [Network settings][2] in the *Docker run
|
10466
10471
|
# reference*.
|
10467
10472
|
#
|
@@ -10486,7 +10491,7 @@ module Aws::ECS
|
|
10486
10491
|
# Elastic Container Service Developer Guide*.
|
10487
10492
|
#
|
10488
10493
|
# <note markdown="1"> The `host` and `sourcePath` parameters are not supported for tasks
|
10489
|
-
# run on
|
10494
|
+
# run on Fargate.
|
10490
10495
|
#
|
10491
10496
|
# </note>
|
10492
10497
|
#
|
@@ -10509,7 +10514,7 @@ module Aws::ECS
|
|
10509
10514
|
# EC2 instances. For more information, see [Attributes][1] in the
|
10510
10515
|
# *Amazon Elastic Container Service Developer Guide*.
|
10511
10516
|
#
|
10512
|
-
# <note markdown="1"> This parameter is not supported for tasks run on
|
10517
|
+
# <note markdown="1"> This parameter is not supported for tasks run on Fargate.
|
10513
10518
|
#
|
10514
10519
|
# </note>
|
10515
10520
|
#
|
@@ -10521,7 +10526,7 @@ module Aws::ECS
|
|
10521
10526
|
# @!attribute [rw] placement_constraints
|
10522
10527
|
# An array of placement constraint objects to use for tasks.
|
10523
10528
|
#
|
10524
|
-
# <note markdown="1"> This parameter is not supported for tasks run on
|
10529
|
+
# <note markdown="1"> This parameter is not supported for tasks run on Fargate.
|
10525
10530
|
#
|
10526
10531
|
# </note>
|
10527
10532
|
# @return [Array<Types::TaskDefinitionPlacementConstraint>]
|
@@ -10577,9 +10582,9 @@ module Aws::ECS
|
|
10577
10582
|
# optional. For more information regarding container-level memory and
|
10578
10583
|
# memory reservation, see [ContainerDefinition][1].
|
10579
10584
|
#
|
10580
|
-
# If your tasks will be run on
|
10581
|
-
#
|
10582
|
-
#
|
10585
|
+
# If your tasks will be run on Fargate, this field is required and you
|
10586
|
+
# must use one of the following values, which determines your range of
|
10587
|
+
# valid values for the `cpu` parameter:
|
10583
10588
|
#
|
10584
10589
|
# * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values:
|
10585
10590
|
# 256 (.25 vCPU)
|
@@ -10620,7 +10625,7 @@ module Aws::ECS
|
|
10620
10625
|
# see [Docker security][2].
|
10621
10626
|
#
|
10622
10627
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
10623
|
-
# on
|
10628
|
+
# on Fargate.
|
10624
10629
|
#
|
10625
10630
|
# </note>
|
10626
10631
|
#
|
@@ -10661,7 +10666,7 @@ module Aws::ECS
|
|
10661
10666
|
# `systemControls` will apply to all containers within a task.
|
10662
10667
|
#
|
10663
10668
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
10664
|
-
# on
|
10669
|
+
# on Fargate.
|
10665
10670
|
#
|
10666
10671
|
# </note>
|
10667
10672
|
#
|
@@ -10740,8 +10745,7 @@ module Aws::ECS
|
|
10740
10745
|
# definition. For more information, see [Task placement constraints][1]
|
10741
10746
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
10742
10747
|
#
|
10743
|
-
# <note markdown="1"> Task placement constraints are not supported for tasks run on
|
10744
|
-
# Fargate.
|
10748
|
+
# <note markdown="1"> Task placement constraints are not supported for tasks run on Fargate.
|
10745
10749
|
#
|
10746
10750
|
# </note>
|
10747
10751
|
#
|
@@ -10859,8 +10863,8 @@ module Aws::ECS
|
|
10859
10863
|
# @!attribute [rw] ephemeral_storage
|
10860
10864
|
# The ephemeral storage setting override for the task.
|
10861
10865
|
#
|
10862
|
-
# <note markdown="1"> This parameter is only supported for tasks hosted on
|
10863
|
-
#
|
10866
|
+
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
|
10867
|
+
# platform version `1.4.0` or later.
|
10864
10868
|
#
|
10865
10869
|
# </note>
|
10866
10870
|
# @return [Types::EphemeralStorage]
|
@@ -10879,10 +10883,10 @@ module Aws::ECS
|
|
10879
10883
|
include Aws::Structure
|
10880
10884
|
end
|
10881
10885
|
|
10882
|
-
# Information about a set of Amazon ECS tasks in either an
|
10883
|
-
#
|
10884
|
-
#
|
10885
|
-
#
|
10886
|
+
# Information about a set of Amazon ECS tasks in either an CodeDeploy or
|
10887
|
+
# an `EXTERNAL` deployment. An Amazon ECS task set includes details such
|
10888
|
+
# as the desired number of tasks, how many tasks are running, and
|
10889
|
+
# whether the task set serves production traffic.
|
10886
10890
|
#
|
10887
10891
|
# @!attribute [rw] id
|
10888
10892
|
# The ID of the task set.
|
@@ -10904,20 +10908,20 @@ module Aws::ECS
|
|
10904
10908
|
#
|
10905
10909
|
# @!attribute [rw] started_by
|
10906
10910
|
# The tag specified when a task set is started. If the task set is
|
10907
|
-
# created by an
|
10908
|
-
#
|
10911
|
+
# created by an CodeDeploy deployment, the `startedBy` parameter is
|
10912
|
+
# `CODE_DEPLOY`. For a task set created for an external deployment,
|
10909
10913
|
# the startedBy field isn't used.
|
10910
10914
|
# @return [String]
|
10911
10915
|
#
|
10912
10916
|
# @!attribute [rw] external_id
|
10913
10917
|
# The external ID associated with the task set.
|
10914
10918
|
#
|
10915
|
-
# If a task set is created by an
|
10916
|
-
# `externalId` parameter contains the
|
10919
|
+
# If a task set is created by an CodeDeploy deployment, the
|
10920
|
+
# `externalId` parameter contains the CodeDeploy deployment ID.
|
10917
10921
|
#
|
10918
10922
|
# If a task set is created for an external deployment and is
|
10919
10923
|
# associated with a service discovery registry, the `externalId`
|
10920
|
-
# parameter contains the `ECS_TASK_SET_EXTERNAL_ID`
|
10924
|
+
# parameter contains the `ECS_TASK_SET_EXTERNAL_ID` Cloud Map
|
10921
10925
|
# attribute.
|
10922
10926
|
# @return [String]
|
10923
10927
|
#
|
@@ -10987,11 +10991,10 @@ module Aws::ECS
|
|
10987
10991
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
10988
10992
|
#
|
10989
10993
|
# @!attribute [rw] platform_version
|
10990
|
-
# The
|
10991
|
-
#
|
10992
|
-
#
|
10993
|
-
#
|
10994
|
-
# Guide*.
|
10994
|
+
# The Fargate platform version on which the tasks in the task set are
|
10995
|
+
# running. A platform version is only specified for tasks run on
|
10996
|
+
# Fargate. For more information, see [Fargate platform versions][1] in
|
10997
|
+
# the *Amazon Elastic Container Service Developer Guide*.
|
10995
10998
|
#
|
10996
10999
|
#
|
10997
11000
|
#
|
@@ -11070,9 +11073,9 @@ module Aws::ECS
|
|
11070
11073
|
#
|
11071
11074
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
11072
11075
|
# 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.
|
11076
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
11077
|
+
# values with this prefix. Tags with this prefix do not count
|
11078
|
+
# against your tags per resource limit.
|
11076
11079
|
# @return [Array<Types::Tag>]
|
11077
11080
|
#
|
11078
11081
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TaskSet AWS API Documentation
|
@@ -11632,10 +11635,10 @@ module Aws::ECS
|
|
11632
11635
|
# providers can be created with the CreateCapacityProvider API
|
11633
11636
|
# operation.
|
11634
11637
|
#
|
11635
|
-
# To use a
|
11636
|
-
#
|
11637
|
-
#
|
11638
|
-
#
|
11638
|
+
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
11639
|
+
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers
|
11640
|
+
# are available to all accounts and only need to be associated with a
|
11641
|
+
# cluster to be used.
|
11639
11642
|
#
|
11640
11643
|
# The PutClusterCapacityProviders API operation is used to update the
|
11641
11644
|
# list of available capacity providers for a cluster after the cluster
|
@@ -11679,8 +11682,8 @@ module Aws::ECS
|
|
11679
11682
|
# The platform version on which your tasks in the service are running.
|
11680
11683
|
# A platform version is only specified for tasks using the Fargate
|
11681
11684
|
# 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
|
11685
|
+
# platform version is used by default. For more information, see
|
11686
|
+
# [Fargate Platform Versions][1] in the *Amazon Elastic Container
|
11684
11687
|
# Service Developer Guide*.
|
11685
11688
|
#
|
11686
11689
|
#
|
@@ -11928,7 +11931,7 @@ module Aws::ECS
|
|
11928
11931
|
# Windows containers only support the use of the `local` driver. To
|
11929
11932
|
# use bind mounts, specify the `host` parameter instead.
|
11930
11933
|
#
|
11931
|
-
# <note markdown="1"> Docker volumes are not supported by tasks run on
|
11934
|
+
# <note markdown="1"> Docker volumes are not supported by tasks run on Fargate.
|
11932
11935
|
#
|
11933
11936
|
# </note>
|
11934
11937
|
# @return [Types::DockerVolumeConfiguration]
|