aws-sdk-ecs 1.77.0 → 1.81.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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 +221 -220
- data/lib/aws-sdk-ecs/types.rb +332 -338
- metadata +2 -2
data/lib/aws-sdk-ecs/types.rb
CHANGED
|
@@ -181,8 +181,8 @@ module Aws::ECS
|
|
|
181
181
|
# from being terminated during a scale-in action. The Auto Scaling
|
|
182
182
|
# group and each instance in the Auto Scaling group must have instance
|
|
183
183
|
# protection from scale-in actions enabled as well. For more
|
|
184
|
-
# information, see [Instance Protection][1] in the *
|
|
185
|
-
#
|
|
184
|
+
# information, see [Instance Protection][1] in the *Auto Scaling User
|
|
185
|
+
# Guide*.
|
|
186
186
|
#
|
|
187
187
|
# When managed termination protection is disabled, your Amazon EC2
|
|
188
188
|
# instances are not protected from termination when the Auto Scaling
|
|
@@ -237,8 +237,8 @@ module Aws::ECS
|
|
|
237
237
|
# from being terminated during a scale-in action. The Auto Scaling
|
|
238
238
|
# group and each instance in the Auto Scaling group must have instance
|
|
239
239
|
# protection from scale-in actions enabled as well. For more
|
|
240
|
-
# information, see [Instance Protection][1] in the *
|
|
241
|
-
#
|
|
240
|
+
# information, see [Instance Protection][1] in the *Auto Scaling User
|
|
241
|
+
# Guide*.
|
|
242
242
|
#
|
|
243
243
|
# When managed termination protection is disabled, your Amazon EC2
|
|
244
244
|
# instances are not protected from termination when the Auto Scaling
|
|
@@ -305,8 +305,8 @@ module Aws::ECS
|
|
|
305
305
|
include Aws::Structure
|
|
306
306
|
end
|
|
307
307
|
|
|
308
|
-
# Your
|
|
309
|
-
# Support][1].
|
|
308
|
+
# Your Amazon Web Services account has been blocked. For more
|
|
309
|
+
# information, contact [ Amazon Web Services Support][1].
|
|
310
310
|
#
|
|
311
311
|
#
|
|
312
312
|
#
|
|
@@ -387,9 +387,9 @@ module Aws::ECS
|
|
|
387
387
|
#
|
|
388
388
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
|
389
389
|
# of such as a prefix for either keys or values as it is reserved
|
|
390
|
-
# for
|
|
391
|
-
# this prefix. Tags with this prefix do not count
|
|
392
|
-
# per resource limit.
|
|
390
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
|
391
|
+
# values with this prefix. Tags with this prefix do not count
|
|
392
|
+
# against your tags per resource limit.
|
|
393
393
|
# @return [Array<Types::Tag>]
|
|
394
394
|
#
|
|
395
395
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CapacityProvider AWS API Documentation
|
|
@@ -421,10 +421,10 @@ module Aws::ECS
|
|
|
421
421
|
# capacity providers can be created with the CreateCapacityProvider API
|
|
422
422
|
# operation.
|
|
423
423
|
#
|
|
424
|
-
# To use a
|
|
425
|
-
#
|
|
426
|
-
#
|
|
427
|
-
#
|
|
424
|
+
# To use a Fargate capacity provider, specify either the `FARGATE` or
|
|
425
|
+
# `FARGATE_SPOT` capacity providers. The Fargate capacity providers are
|
|
426
|
+
# available to all accounts and only need to be associated with a
|
|
427
|
+
# cluster to be used in a capacity provider strategy.
|
|
428
428
|
#
|
|
429
429
|
# @note When making an API call, you may pass CapacityProviderStrategyItem
|
|
430
430
|
# data as a hash:
|
|
@@ -505,7 +505,7 @@ module Aws::ECS
|
|
|
505
505
|
# @!attribute [rw] cluster_arn
|
|
506
506
|
# The Amazon Resource Name (ARN) that identifies the cluster. The ARN
|
|
507
507
|
# contains the `arn:aws:ecs` namespace, followed by the Region of the
|
|
508
|
-
# cluster, the
|
|
508
|
+
# cluster, the account ID of the cluster owner, the `cluster`
|
|
509
509
|
# namespace, and then the cluster name. For example,
|
|
510
510
|
# `arn:aws:ecs:region:012345678910:cluster/test`.
|
|
511
511
|
# @return [String]
|
|
@@ -615,9 +615,9 @@ module Aws::ECS
|
|
|
615
615
|
#
|
|
616
616
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
|
617
617
|
# of such as a prefix for either keys or values as it is reserved
|
|
618
|
-
# for
|
|
619
|
-
# this prefix. Tags with this prefix do not count
|
|
620
|
-
# per resource limit.
|
|
618
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
|
619
|
+
# values with this prefix. Tags with this prefix do not count
|
|
620
|
+
# against your tags per resource limit.
|
|
621
621
|
# @return [Array<Types::Tag>]
|
|
622
622
|
#
|
|
623
623
|
# @!attribute [rw] settings
|
|
@@ -1043,9 +1043,9 @@ module Aws::ECS
|
|
|
1043
1043
|
# together in a task definition, the `name` of one container can be
|
|
1044
1044
|
# entered in the `links` of another container to connect the
|
|
1045
1045
|
# containers. Up to 255 letters (uppercase and lowercase), numbers,
|
|
1046
|
-
# and hyphens are allowed. This parameter maps to `name`
|
|
1047
|
-
# [Create a container][1] section of the [Docker Remote API][2]
|
|
1048
|
-
# the `--name` option to [docker run][3].
|
|
1046
|
+
# underscores, and hyphens are allowed. This parameter maps to `name`
|
|
1047
|
+
# in the [Create a container][1] section of the [Docker Remote API][2]
|
|
1048
|
+
# and the `--name` option to [docker run][3].
|
|
1049
1049
|
#
|
|
1050
1050
|
#
|
|
1051
1051
|
#
|
|
@@ -1233,12 +1233,12 @@ module Aws::ECS
|
|
|
1233
1233
|
# other without the need for port mappings. This parameter is only
|
|
1234
1234
|
# supported if the network mode of a task definition is `bridge`. The
|
|
1235
1235
|
# `name:internalName` construct is analogous to `name:alias` in Docker
|
|
1236
|
-
# links. Up to 255 letters (uppercase and lowercase), numbers,
|
|
1237
|
-
# hyphens are allowed. For more information about
|
|
1238
|
-
# containers, go to [Legacy container links][1] in the
|
|
1239
|
-
# documentation. This parameter maps to `Links` in the [Create
|
|
1240
|
-
# container][2] section of the [Docker Remote API][3] and the
|
|
1241
|
-
# option to [docker run][4].
|
|
1236
|
+
# links. Up to 255 letters (uppercase and lowercase), numbers,
|
|
1237
|
+
# underscores, and hyphens are allowed. For more information about
|
|
1238
|
+
# linking Docker containers, go to [Legacy container links][1] in the
|
|
1239
|
+
# Docker documentation. This parameter maps to `Links` in the [Create
|
|
1240
|
+
# a container][2] section of the [Docker Remote API][3] and the
|
|
1241
|
+
# `--link` option to [docker run][4].
|
|
1242
1242
|
#
|
|
1243
1243
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
|
1244
1244
|
#
|
|
@@ -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
|
|
@@ -2525,7 +2528,8 @@ module Aws::ECS
|
|
|
2525
2528
|
# @!attribute [rw] cluster_name
|
|
2526
2529
|
# The name of your cluster. If you do not specify a name for your
|
|
2527
2530
|
# cluster, you create a cluster named `default`. Up to 255 letters
|
|
2528
|
-
# (uppercase and lowercase), numbers, and hyphens are
|
|
2531
|
+
# (uppercase and lowercase), numbers, underscores, and hyphens are
|
|
2532
|
+
# allowed.
|
|
2529
2533
|
# @return [String]
|
|
2530
2534
|
#
|
|
2531
2535
|
# @!attribute [rw] tags
|
|
@@ -2554,9 +2558,9 @@ module Aws::ECS
|
|
|
2554
2558
|
#
|
|
2555
2559
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
|
2556
2560
|
# of such as a prefix for either keys or values as it is reserved
|
|
2557
|
-
# for
|
|
2558
|
-
# this prefix. Tags with this prefix do not count
|
|
2559
|
-
# 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.
|
|
2560
2564
|
# @return [Array<Types::Tag>]
|
|
2561
2565
|
#
|
|
2562
2566
|
# @!attribute [rw] settings
|
|
@@ -2583,10 +2587,10 @@ module Aws::ECS
|
|
|
2583
2587
|
# providers can be created with the CreateCapacityProvider API
|
|
2584
2588
|
# operation.
|
|
2585
2589
|
#
|
|
2586
|
-
# To use a
|
|
2587
|
-
#
|
|
2588
|
-
#
|
|
2589
|
-
#
|
|
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.
|
|
2590
2594
|
#
|
|
2591
2595
|
# The PutClusterCapacityProviders API operation is used to update the
|
|
2592
2596
|
# list of available capacity providers for a cluster after the cluster
|
|
@@ -2655,7 +2659,7 @@ module Aws::ECS
|
|
|
2655
2659
|
# ],
|
|
2656
2660
|
# desired_count: 1,
|
|
2657
2661
|
# client_token: "String",
|
|
2658
|
-
# launch_type: "EC2", # accepts EC2, FARGATE
|
|
2662
|
+
# launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
|
|
2659
2663
|
# capacity_provider_strategy: [
|
|
2660
2664
|
# {
|
|
2661
2665
|
# capacity_provider: "String", # required
|
|
@@ -2716,9 +2720,10 @@ module Aws::ECS
|
|
|
2716
2720
|
#
|
|
2717
2721
|
# @!attribute [rw] service_name
|
|
2718
2722
|
# The name of your service. Up to 255 letters (uppercase and
|
|
2719
|
-
# lowercase), numbers, and hyphens are allowed. Service
|
|
2720
|
-
# unique within a cluster, but you can have similarly
|
|
2721
|
-
# in multiple clusters within a Region or across
|
|
2723
|
+
# lowercase), numbers, underscores, and hyphens are allowed. Service
|
|
2724
|
+
# names must be unique within a cluster, but you can have similarly
|
|
2725
|
+
# named services in multiple clusters within a Region or across
|
|
2726
|
+
# multiple Regions.
|
|
2722
2727
|
# @return [String]
|
|
2723
2728
|
#
|
|
2724
2729
|
# @!attribute [rw] task_definition
|
|
@@ -2745,15 +2750,15 @@ module Aws::ECS
|
|
|
2745
2750
|
#
|
|
2746
2751
|
# If the service is using the `CODE_DEPLOY` deployment controller, the
|
|
2747
2752
|
# service is required to use either an Application Load Balancer or
|
|
2748
|
-
# Network Load Balancer. When creating an
|
|
2749
|
-
#
|
|
2750
|
-
#
|
|
2751
|
-
#
|
|
2752
|
-
#
|
|
2753
|
-
#
|
|
2754
|
-
#
|
|
2755
|
-
#
|
|
2756
|
-
#
|
|
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.
|
|
2757
2762
|
#
|
|
2758
2763
|
# After you create a service using the `ECS` deployment controller,
|
|
2759
2764
|
# the load balancer name or target group ARN, container name, and
|
|
@@ -2821,25 +2826,33 @@ module Aws::ECS
|
|
|
2821
2826
|
# @return [String]
|
|
2822
2827
|
#
|
|
2823
2828
|
# @!attribute [rw] launch_type
|
|
2824
|
-
# The
|
|
2825
|
-
#
|
|
2826
|
-
#
|
|
2827
|
-
# Guide*.
|
|
2829
|
+
# The infrastructure on which to run your service. For more
|
|
2830
|
+
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
|
2831
|
+
# Container Service Developer Guide*.
|
|
2828
2832
|
#
|
|
2829
|
-
#
|
|
2830
|
-
#
|
|
2831
|
-
# use a capacity provider strategy with the `FARGATE_SPOT` capacity
|
|
2832
|
-
# provider.
|
|
2833
|
+
# The `FARGATE` launch type runs your tasks on Fargate On-Demand
|
|
2834
|
+
# infrastructure.
|
|
2833
2835
|
#
|
|
2834
|
-
#
|
|
2835
|
-
#
|
|
2836
|
+
# <note markdown="1"> Fargate Spot infrastructure is available for use but a capacity
|
|
2837
|
+
# provider strategy must be used. For more information, see [Fargate
|
|
2838
|
+
# capacity providers][2] in the *Amazon ECS User Guide for Fargate*.
|
|
2836
2839
|
#
|
|
2837
|
-
#
|
|
2838
|
-
#
|
|
2840
|
+
# </note>
|
|
2841
|
+
#
|
|
2842
|
+
# The `EC2` launch type runs your tasks on Amazon EC2 instances
|
|
2843
|
+
# registered to your cluster.
|
|
2844
|
+
#
|
|
2845
|
+
# The `EXTERNAL` launch type runs your tasks on your on-premise server
|
|
2846
|
+
# or virtual machine (VM) capacity registered to your cluster.
|
|
2847
|
+
#
|
|
2848
|
+
# A service can use either a launch type or a capacity provider
|
|
2849
|
+
# strategy. If a `launchType` is specified, the
|
|
2850
|
+
# `capacityProviderStrategy` parameter must be omitted.
|
|
2839
2851
|
#
|
|
2840
2852
|
#
|
|
2841
2853
|
#
|
|
2842
2854
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html
|
|
2855
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/userguide/fargate-capacity-providers.html
|
|
2843
2856
|
# @return [String]
|
|
2844
2857
|
#
|
|
2845
2858
|
# @!attribute [rw] capacity_provider_strategy
|
|
@@ -2855,7 +2868,7 @@ module Aws::ECS
|
|
|
2855
2868
|
# The platform version that your tasks in the service are running on.
|
|
2856
2869
|
# A platform version is specified only for tasks using the Fargate
|
|
2857
2870
|
# launch type. If one isn't specified, the `LATEST` platform version
|
|
2858
|
-
# is used by default. For more information, see [
|
|
2871
|
+
# is used by default. For more information, see [Fargate platform
|
|
2859
2872
|
# versions][1] in the *Amazon Elastic Container Service Developer
|
|
2860
2873
|
# Guide*.
|
|
2861
2874
|
#
|
|
@@ -3009,9 +3022,9 @@ module Aws::ECS
|
|
|
3009
3022
|
#
|
|
3010
3023
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
|
3011
3024
|
# of such as a prefix for either keys or values as it is reserved
|
|
3012
|
-
# for
|
|
3013
|
-
# this prefix. Tags with this prefix do not count
|
|
3014
|
-
# 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.
|
|
3015
3028
|
# @return [Array<Types::Tag>]
|
|
3016
3029
|
#
|
|
3017
3030
|
# @!attribute [rw] enable_ecs_managed_tags
|
|
@@ -3071,6 +3084,10 @@ module Aws::ECS
|
|
|
3071
3084
|
# @!attribute [rw] service
|
|
3072
3085
|
# The full description of your service following the create call.
|
|
3073
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
|
+
#
|
|
3074
3091
|
# If a service is using the `ECS` deployment controller, the
|
|
3075
3092
|
# `deploymentController` and `taskSets` parameters will not be
|
|
3076
3093
|
# returned.
|
|
@@ -3120,7 +3137,7 @@ module Aws::ECS
|
|
|
3120
3137
|
# container_port: 1,
|
|
3121
3138
|
# },
|
|
3122
3139
|
# ],
|
|
3123
|
-
# launch_type: "EC2", # accepts EC2, FARGATE
|
|
3140
|
+
# launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
|
|
3124
3141
|
# capacity_provider_strategy: [
|
|
3125
3142
|
# {
|
|
3126
3143
|
# capacity_provider: "String", # required
|
|
@@ -3156,8 +3173,8 @@ module Aws::ECS
|
|
|
3156
3173
|
# An optional non-unique tag that identifies this task set in external
|
|
3157
3174
|
# systems. If the task set is associated with a service discovery
|
|
3158
3175
|
# registry, the tasks in this task set will have the
|
|
3159
|
-
# `ECS_TASK_SET_EXTERNAL_ID`
|
|
3160
|
-
#
|
|
3176
|
+
# `ECS_TASK_SET_EXTERNAL_ID` Cloud Map attribute set to the provided
|
|
3177
|
+
# value.
|
|
3161
3178
|
# @return [String]
|
|
3162
3179
|
#
|
|
3163
3180
|
# @!attribute [rw] task_definition
|
|
@@ -3216,10 +3233,10 @@ module Aws::ECS
|
|
|
3216
3233
|
# providers can be created with the CreateCapacityProvider API
|
|
3217
3234
|
# operation.
|
|
3218
3235
|
#
|
|
3219
|
-
# To use a
|
|
3220
|
-
#
|
|
3221
|
-
#
|
|
3222
|
-
#
|
|
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.
|
|
3223
3240
|
#
|
|
3224
3241
|
# The PutClusterCapacityProviders API operation is used to update the
|
|
3225
3242
|
# list of available capacity providers for a cluster after the cluster
|
|
@@ -3270,9 +3287,9 @@ module Aws::ECS
|
|
|
3270
3287
|
#
|
|
3271
3288
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
|
3272
3289
|
# of such as a prefix for either keys or values as it is reserved
|
|
3273
|
-
# for
|
|
3274
|
-
# this prefix. Tags with this prefix do not count
|
|
3275
|
-
# 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.
|
|
3276
3293
|
# @return [Array<Types::Tag>]
|
|
3277
3294
|
#
|
|
3278
3295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateTaskSetRequest AWS API Documentation
|
|
@@ -3296,10 +3313,10 @@ module Aws::ECS
|
|
|
3296
3313
|
end
|
|
3297
3314
|
|
|
3298
3315
|
# @!attribute [rw] task_set
|
|
3299
|
-
# Information about a set of Amazon ECS tasks in either an
|
|
3300
|
-
#
|
|
3301
|
-
#
|
|
3302
|
-
#
|
|
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.
|
|
3303
3320
|
# @return [Types::TaskSet]
|
|
3304
3321
|
#
|
|
3305
3322
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateTaskSetResponse AWS API Documentation
|
|
@@ -3657,7 +3674,7 @@ module Aws::ECS
|
|
|
3657
3674
|
# The platform version on which your tasks in the service are running.
|
|
3658
3675
|
# A platform version is only specified for tasks using the Fargate
|
|
3659
3676
|
# launch type. If one is not specified, the `LATEST` platform version
|
|
3660
|
-
# is used by default. For more information, see [
|
|
3677
|
+
# is used by default. For more information, see [Fargate Platform
|
|
3661
3678
|
# Versions][1] in the *Amazon Elastic Container Service Developer
|
|
3662
3679
|
# Guide*.
|
|
3663
3680
|
#
|
|
@@ -3884,9 +3901,9 @@ module Aws::ECS
|
|
|
3884
3901
|
# CODE\_DEPLOY
|
|
3885
3902
|
#
|
|
3886
3903
|
# : The blue/green (`CODE_DEPLOY`) deployment type uses the blue/green
|
|
3887
|
-
# deployment model powered by
|
|
3888
|
-
#
|
|
3889
|
-
#
|
|
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.
|
|
3890
3907
|
#
|
|
3891
3908
|
# EXTERNAL
|
|
3892
3909
|
#
|
|
@@ -3921,7 +3938,7 @@ module Aws::ECS
|
|
|
3921
3938
|
# @!attribute [rw] container_instance
|
|
3922
3939
|
# The container instance ID or full ARN of the container instance to
|
|
3923
3940
|
# deregister. The ARN contains the `arn:aws:ecs` namespace, followed
|
|
3924
|
-
# by the Region of the container instance, the
|
|
3941
|
+
# by the Region of the container instance, the account ID of the
|
|
3925
3942
|
# container instance owner, the `container-instance` namespace, and
|
|
3926
3943
|
# then the container instance ID. For example,
|
|
3927
3944
|
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
|
@@ -4099,9 +4116,9 @@ module Aws::ECS
|
|
|
4099
4116
|
# @return [Array<String>]
|
|
4100
4117
|
#
|
|
4101
4118
|
# @!attribute [rw] include
|
|
4102
|
-
# Whether to include additional information about
|
|
4103
|
-
# response. If this field is omitted,
|
|
4104
|
-
#
|
|
4119
|
+
# Whether to include additional information about the clusters in the
|
|
4120
|
+
# response. If this field is omitted, this information isn't
|
|
4121
|
+
# included.
|
|
4105
4122
|
#
|
|
4106
4123
|
# If `ATTACHMENTS` is specified, the attachments for the container
|
|
4107
4124
|
# instances or tasks within the cluster are included.
|
|
@@ -4109,24 +4126,8 @@ module Aws::ECS
|
|
|
4109
4126
|
# If `SETTINGS` is specified, the settings for the cluster are
|
|
4110
4127
|
# included.
|
|
4111
4128
|
#
|
|
4112
|
-
# If `STATISTICS` is specified, the
|
|
4113
|
-
# separated by launch type
|
|
4114
|
-
#
|
|
4115
|
-
# * runningEC2TasksCount
|
|
4116
|
-
#
|
|
4117
|
-
# * runningFargateTasksCount
|
|
4118
|
-
#
|
|
4119
|
-
# * pendingEC2TasksCount
|
|
4120
|
-
#
|
|
4121
|
-
# * pendingFargateTasksCount
|
|
4122
|
-
#
|
|
4123
|
-
# * activeEC2ServiceCount
|
|
4124
|
-
#
|
|
4125
|
-
# * activeFargateServiceCount
|
|
4126
|
-
#
|
|
4127
|
-
# * drainingEC2ServiceCount
|
|
4128
|
-
#
|
|
4129
|
-
# * drainingFargateServiceCount
|
|
4129
|
+
# If `STATISTICS` is specified, the task and service count is
|
|
4130
|
+
# included, separated by launch type.
|
|
4130
4131
|
#
|
|
4131
4132
|
# If `TAGS` is specified, the metadata tags associated with the
|
|
4132
4133
|
# cluster are included.
|
|
@@ -4330,9 +4331,9 @@ module Aws::ECS
|
|
|
4330
4331
|
#
|
|
4331
4332
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
|
4332
4333
|
# of such as a prefix for either keys or values as it is reserved
|
|
4333
|
-
# for
|
|
4334
|
-
# this prefix. Tags with this prefix do not count
|
|
4335
|
-
# 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.
|
|
4336
4337
|
# @return [Array<Types::Tag>]
|
|
4337
4338
|
#
|
|
4338
4339
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskDefinitionResponse AWS API Documentation
|
|
@@ -4502,7 +4503,7 @@ module Aws::ECS
|
|
|
4502
4503
|
# @!attribute [rw] container_instance
|
|
4503
4504
|
# The container instance ID or full ARN of the container instance. The
|
|
4504
4505
|
# ARN contains the `arn:aws:ecs` namespace, followed by the Region of
|
|
4505
|
-
# the container instance, the
|
|
4506
|
+
# the container instance, the account ID of the container instance
|
|
4506
4507
|
# owner, the `container-instance` namespace, and then the container
|
|
4507
4508
|
# instance ID. For example,
|
|
4508
4509
|
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
|
@@ -4814,11 +4815,11 @@ module Aws::ECS
|
|
|
4814
4815
|
|
|
4815
4816
|
# The amount of ephemeral storage to allocate for the task. This
|
|
4816
4817
|
# parameter is used to expand the total amount of ephemeral storage
|
|
4817
|
-
# available, beyond the default amount, for tasks hosted on
|
|
4818
|
-
#
|
|
4819
|
-
# 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*.
|
|
4820
4821
|
#
|
|
4821
|
-
# <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
|
|
4822
4823
|
# platform version `1.4.0` or later.
|
|
4823
4824
|
#
|
|
4824
4825
|
# </note>
|
|
@@ -4866,8 +4867,8 @@ module Aws::ECS
|
|
|
4866
4867
|
# }
|
|
4867
4868
|
#
|
|
4868
4869
|
# @!attribute [rw] kms_key_id
|
|
4869
|
-
# Specify an
|
|
4870
|
-
#
|
|
4870
|
+
# Specify an Key Management Service key ID to encrypt the data between
|
|
4871
|
+
# the local client and the container.
|
|
4871
4872
|
# @return [String]
|
|
4872
4873
|
#
|
|
4873
4874
|
# @!attribute [rw] logging
|
|
@@ -5021,7 +5022,8 @@ module Aws::ECS
|
|
|
5021
5022
|
#
|
|
5022
5023
|
# @!attribute [rw] interactive
|
|
5023
5024
|
# Whether or not the execute command session is running in interactive
|
|
5024
|
-
# mode.
|
|
5025
|
+
# mode. Amazon ECS only supports initiating interactive sessions, so
|
|
5026
|
+
# you must specify `true` for this value.
|
|
5025
5027
|
# @return [Boolean]
|
|
5026
5028
|
#
|
|
5027
5029
|
# @!attribute [rw] session
|
|
@@ -5071,14 +5073,14 @@ module Aws::ECS
|
|
|
5071
5073
|
# @!attribute [rw] credentials_parameter
|
|
5072
5074
|
# The authorization credential option to use. The authorization
|
|
5073
5075
|
# credential options can be provided using either the Amazon Resource
|
|
5074
|
-
# Name (ARN) of an
|
|
5075
|
-
#
|
|
5076
|
+
# Name (ARN) of an Secrets Manager secret or SSM Parameter Store
|
|
5077
|
+
# parameter. The ARNs refer to the stored credentials.
|
|
5076
5078
|
# @return [String]
|
|
5077
5079
|
#
|
|
5078
5080
|
# @!attribute [rw] domain
|
|
5079
|
-
# A fully qualified domain name hosted by an [
|
|
5080
|
-
#
|
|
5081
|
-
#
|
|
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.
|
|
5082
5084
|
#
|
|
5083
5085
|
#
|
|
5084
5086
|
#
|
|
@@ -5206,8 +5208,8 @@ module Aws::ECS
|
|
|
5206
5208
|
# FireLens Configuration][1] in the *Amazon Elastic Container Service
|
|
5207
5209
|
# Developer Guide*.
|
|
5208
5210
|
#
|
|
5209
|
-
# <note markdown="1"> Tasks hosted on
|
|
5210
|
-
#
|
|
5211
|
+
# <note markdown="1"> Tasks hosted on Fargate only support the `file` configuration file
|
|
5212
|
+
# type.
|
|
5211
5213
|
#
|
|
5212
5214
|
# </note>
|
|
5213
5215
|
#
|
|
@@ -5271,7 +5273,7 @@ module Aws::ECS
|
|
|
5271
5273
|
#
|
|
5272
5274
|
# * Container health checks are supported for Fargate tasks if you are
|
|
5273
5275
|
# using platform version 1.1.0 or greater. For more information, see
|
|
5274
|
-
# [
|
|
5276
|
+
# [Fargate Platform Versions][2].
|
|
5275
5277
|
#
|
|
5276
5278
|
# * Container health checks are not supported for tasks that are part of
|
|
5277
5279
|
# a service that is configured to use a Classic Load Balancer.
|
|
@@ -5519,7 +5521,7 @@ module Aws::ECS
|
|
|
5519
5521
|
# `CapAdd` in the [Create a container][1] section of the [Docker
|
|
5520
5522
|
# Remote API][2] and the `--cap-add` option to [docker run][3].
|
|
5521
5523
|
#
|
|
5522
|
-
# <note markdown="1"> Tasks launched on
|
|
5524
|
+
# <note markdown="1"> Tasks launched on Fargate only support adding the `SYS_PTRACE`
|
|
5523
5525
|
# kernel capability.
|
|
5524
5526
|
#
|
|
5525
5527
|
# </note>
|
|
@@ -6122,14 +6124,14 @@ module Aws::ECS
|
|
|
6122
6124
|
# cluster: "String",
|
|
6123
6125
|
# next_token: "String",
|
|
6124
6126
|
# max_results: 1,
|
|
6125
|
-
# launch_type: "EC2", # accepts EC2, FARGATE
|
|
6127
|
+
# launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
|
|
6126
6128
|
# scheduling_strategy: "REPLICA", # accepts REPLICA, DAEMON
|
|
6127
6129
|
# }
|
|
6128
6130
|
#
|
|
6129
6131
|
# @!attribute [rw] cluster
|
|
6130
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
6131
|
-
#
|
|
6132
|
-
# the default cluster is assumed.
|
|
6132
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
6133
|
+
# use when filtering the `ListServices` results. If you do not specify
|
|
6134
|
+
# a cluster, the default cluster is assumed.
|
|
6133
6135
|
# @return [String]
|
|
6134
6136
|
#
|
|
6135
6137
|
# @!attribute [rw] next_token
|
|
@@ -6157,11 +6159,12 @@ module Aws::ECS
|
|
|
6157
6159
|
# @return [Integer]
|
|
6158
6160
|
#
|
|
6159
6161
|
# @!attribute [rw] launch_type
|
|
6160
|
-
# The launch type
|
|
6162
|
+
# The launch type to use when filtering the `ListServices` results.
|
|
6161
6163
|
# @return [String]
|
|
6162
6164
|
#
|
|
6163
6165
|
# @!attribute [rw] scheduling_strategy
|
|
6164
|
-
# The scheduling strategy
|
|
6166
|
+
# The scheduling strategy to use when filtering the `ListServices`
|
|
6167
|
+
# results.
|
|
6165
6168
|
# @return [String]
|
|
6166
6169
|
#
|
|
6167
6170
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListServicesRequest AWS API Documentation
|
|
@@ -6427,26 +6430,26 @@ module Aws::ECS
|
|
|
6427
6430
|
# started_by: "String",
|
|
6428
6431
|
# service_name: "String",
|
|
6429
6432
|
# desired_status: "RUNNING", # accepts RUNNING, PENDING, STOPPED
|
|
6430
|
-
# launch_type: "EC2", # accepts EC2, FARGATE
|
|
6433
|
+
# launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
|
|
6431
6434
|
# }
|
|
6432
6435
|
#
|
|
6433
6436
|
# @!attribute [rw] cluster
|
|
6434
|
-
# The short name or full Amazon Resource Name (ARN) of the cluster
|
|
6435
|
-
#
|
|
6436
|
-
# default cluster is assumed.
|
|
6437
|
+
# The short name or full Amazon Resource Name (ARN) of the cluster to
|
|
6438
|
+
# use when filtering the `ListTasks` results. If you do not specify a
|
|
6439
|
+
# cluster, the default cluster is assumed.
|
|
6437
6440
|
# @return [String]
|
|
6438
6441
|
#
|
|
6439
6442
|
# @!attribute [rw] container_instance
|
|
6440
|
-
# The container instance ID or full ARN of the container instance
|
|
6441
|
-
#
|
|
6443
|
+
# The container instance ID or full ARN of the container instance to
|
|
6444
|
+
# use when filtering the `ListTasks` results. Specifying a
|
|
6442
6445
|
# `containerInstance` limits the results to tasks that belong to that
|
|
6443
6446
|
# container instance.
|
|
6444
6447
|
# @return [String]
|
|
6445
6448
|
#
|
|
6446
6449
|
# @!attribute [rw] family
|
|
6447
|
-
# The name of the
|
|
6448
|
-
# Specifying a `family` limits the results to
|
|
6449
|
-
# that family.
|
|
6450
|
+
# The name of the task definition family to use when filtering the
|
|
6451
|
+
# `ListTasks` results. Specifying a `family` limits the results to
|
|
6452
|
+
# tasks that belong to that family.
|
|
6450
6453
|
# @return [String]
|
|
6451
6454
|
#
|
|
6452
6455
|
# @!attribute [rw] next_token
|
|
@@ -6480,13 +6483,13 @@ module Aws::ECS
|
|
|
6480
6483
|
# @return [String]
|
|
6481
6484
|
#
|
|
6482
6485
|
# @!attribute [rw] service_name
|
|
6483
|
-
# The name of the service
|
|
6486
|
+
# The name of the service to use when filtering the `ListTasks`
|
|
6484
6487
|
# results. Specifying a `serviceName` limits the results to tasks that
|
|
6485
6488
|
# belong to that service.
|
|
6486
6489
|
# @return [String]
|
|
6487
6490
|
#
|
|
6488
6491
|
# @!attribute [rw] desired_status
|
|
6489
|
-
# The task desired status
|
|
6492
|
+
# The task desired status to use when filtering the `ListTasks`
|
|
6490
6493
|
# results. Specifying a `desiredStatus` of `STOPPED` limits the
|
|
6491
6494
|
# results to tasks that Amazon ECS has set the desired status to
|
|
6492
6495
|
# `STOPPED`. This can be useful for debugging tasks that are not
|
|
@@ -6503,7 +6506,7 @@ module Aws::ECS
|
|
|
6503
6506
|
# @return [String]
|
|
6504
6507
|
#
|
|
6505
6508
|
# @!attribute [rw] launch_type
|
|
6506
|
-
# The launch type
|
|
6509
|
+
# The launch type to use when filtering the `ListTasks` results.
|
|
6507
6510
|
# @return [String]
|
|
6508
6511
|
#
|
|
6509
6512
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTasksRequest AWS API Documentation
|
|
@@ -6652,7 +6655,7 @@ module Aws::ECS
|
|
|
6652
6655
|
# configuration][5] in the *Amazon Elastic Container Service Developer
|
|
6653
6656
|
# Guide*.
|
|
6654
6657
|
#
|
|
6655
|
-
# * For tasks on
|
|
6658
|
+
# * For tasks on Fargate, because you do not have access to the
|
|
6656
6659
|
# underlying infrastructure your tasks are hosted on, any additional
|
|
6657
6660
|
# software needed will have to be installed outside of the task. For
|
|
6658
6661
|
# example, the Fluentd output aggregators or a remote host running
|
|
@@ -6685,7 +6688,7 @@ module Aws::ECS
|
|
|
6685
6688
|
# @!attribute [rw] log_driver
|
|
6686
6689
|
# The log driver to use for the container.
|
|
6687
6690
|
#
|
|
6688
|
-
# For tasks on
|
|
6691
|
+
# For tasks on Fargate, the supported log drivers are `awslogs`,
|
|
6689
6692
|
# `splunk`, and `awsfirelens`.
|
|
6690
6693
|
#
|
|
6691
6694
|
# For tasks hosted on Amazon EC2 instances, the supported log drivers
|
|
@@ -7543,10 +7546,10 @@ module Aws::ECS
|
|
|
7543
7546
|
# providers can be created with the CreateCapacityProvider API
|
|
7544
7547
|
# operation.
|
|
7545
7548
|
#
|
|
7546
|
-
# To use a
|
|
7547
|
-
#
|
|
7548
|
-
#
|
|
7549
|
-
#
|
|
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.
|
|
7550
7553
|
# @return [Array<String>]
|
|
7551
7554
|
#
|
|
7552
7555
|
# @!attribute [rw] default_capacity_provider_strategy
|
|
@@ -7568,10 +7571,10 @@ module Aws::ECS
|
|
|
7568
7571
|
# providers can be created with the CreateCapacityProvider API
|
|
7569
7572
|
# operation.
|
|
7570
7573
|
#
|
|
7571
|
-
# To use a
|
|
7572
|
-
#
|
|
7573
|
-
#
|
|
7574
|
-
#
|
|
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.
|
|
7575
7578
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
|
7576
7579
|
#
|
|
7577
7580
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutClusterCapacityProvidersRequest AWS API Documentation
|
|
@@ -7710,9 +7713,9 @@ module Aws::ECS
|
|
|
7710
7713
|
#
|
|
7711
7714
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
|
7712
7715
|
# of such as a prefix for either keys or values as it is reserved
|
|
7713
|
-
# for
|
|
7714
|
-
# this prefix. Tags with this prefix do not count
|
|
7715
|
-
# 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.
|
|
7716
7719
|
# @return [Array<Types::Tag>]
|
|
7717
7720
|
#
|
|
7718
7721
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterContainerInstanceRequest AWS API Documentation
|
|
@@ -7944,7 +7947,7 @@ module Aws::ECS
|
|
|
7944
7947
|
# expression: "String",
|
|
7945
7948
|
# },
|
|
7946
7949
|
# ],
|
|
7947
|
-
# requires_compatibilities: ["EC2"], # accepts EC2, FARGATE
|
|
7950
|
+
# requires_compatibilities: ["EC2"], # accepts EC2, FARGATE, EXTERNAL
|
|
7948
7951
|
# cpu: "String",
|
|
7949
7952
|
# memory: "String",
|
|
7950
7953
|
# tags: [
|
|
@@ -7980,7 +7983,8 @@ module Aws::ECS
|
|
|
7980
7983
|
# You must specify a `family` for a task definition, which allows you
|
|
7981
7984
|
# to track multiple versions of the same task definition. The `family`
|
|
7982
7985
|
# is used as a name for your task definition. Up to 255 letters
|
|
7983
|
-
# (uppercase and lowercase), numbers, and hyphens are
|
|
7986
|
+
# (uppercase and lowercase), numbers, underscores, and hyphens are
|
|
7987
|
+
# allowed.
|
|
7984
7988
|
# @return [String]
|
|
7985
7989
|
#
|
|
7986
7990
|
# @!attribute [rw] task_role_arn
|
|
@@ -7997,11 +8001,11 @@ module Aws::ECS
|
|
|
7997
8001
|
#
|
|
7998
8002
|
# @!attribute [rw] execution_role_arn
|
|
7999
8003
|
# The Amazon Resource Name (ARN) of the task execution role that
|
|
8000
|
-
# grants the Amazon ECS container agent permission to make
|
|
8001
|
-
# calls on your behalf. The task execution IAM role is
|
|
8002
|
-
# depending on the requirements of your task. For more
|
|
8003
|
-
# see [Amazon ECS task execution IAM role][1] in the
|
|
8004
|
-
# Container Service Developer Guide*.
|
|
8004
|
+
# grants the Amazon ECS container agent permission to make Amazon Web
|
|
8005
|
+
# Services API calls on your behalf. The task execution IAM role is
|
|
8006
|
+
# required depending on the requirements of your task. For more
|
|
8007
|
+
# information, see [Amazon ECS task execution IAM role][1] in the
|
|
8008
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
|
8005
8009
|
#
|
|
8006
8010
|
#
|
|
8007
8011
|
#
|
|
@@ -8014,13 +8018,15 @@ module Aws::ECS
|
|
|
8014
8018
|
# network mode is specified, the default is `bridge`.
|
|
8015
8019
|
#
|
|
8016
8020
|
# For Amazon ECS tasks on Fargate, the `awsvpc` network mode is
|
|
8017
|
-
# required. For Amazon ECS tasks on Amazon EC2 instances, any
|
|
8018
|
-
# mode can be used.
|
|
8019
|
-
#
|
|
8020
|
-
#
|
|
8021
|
-
#
|
|
8022
|
-
#
|
|
8023
|
-
#
|
|
8021
|
+
# required. For Amazon ECS tasks on Amazon EC2 Linux instances, any
|
|
8022
|
+
# network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows
|
|
8023
|
+
# instances, `<default>` or `awsvpc` can be used. If the network mode
|
|
8024
|
+
# is set to `none`, you cannot specify port mappings in your container
|
|
8025
|
+
# definitions, and the tasks containers do not have external
|
|
8026
|
+
# connectivity. The `host` and `awsvpc` network modes offer the
|
|
8027
|
+
# highest networking performance for containers because they use the
|
|
8028
|
+
# EC2 network stack instead of the virtualized network stack provided
|
|
8029
|
+
# by the `bridge` mode.
|
|
8024
8030
|
#
|
|
8025
8031
|
# With the `host` and `awsvpc` network modes, exposed container ports
|
|
8026
8032
|
# are mapped directly to the corresponding host port (for the `host`
|
|
@@ -8038,22 +8044,10 @@ module Aws::ECS
|
|
|
8038
8044
|
# For more information, see [Task Networking][1] in the *Amazon
|
|
8039
8045
|
# Elastic Container Service Developer Guide*.
|
|
8040
8046
|
#
|
|
8041
|
-
# <note markdown="1"> Currently, only Amazon ECS-optimized AMIs, other Amazon Linux
|
|
8042
|
-
# variants with the `ecs-init` package, or AWS Fargate infrastructure
|
|
8043
|
-
# support the `awsvpc` network mode.
|
|
8044
|
-
#
|
|
8045
|
-
# </note>
|
|
8046
|
-
#
|
|
8047
8047
|
# If the network mode is `host`, you cannot run multiple
|
|
8048
8048
|
# instantiations of the same task on a single container instance when
|
|
8049
8049
|
# port mappings are used.
|
|
8050
8050
|
#
|
|
8051
|
-
# Docker for Windows uses different network modes than Docker for
|
|
8052
|
-
# Linux. When you register a task definition with Windows containers,
|
|
8053
|
-
# you must not specify a network mode. If you use the console to
|
|
8054
|
-
# register a task definition with Windows containers, you must choose
|
|
8055
|
-
# the `<default>` network mode object.
|
|
8056
|
-
#
|
|
8057
8051
|
# For more information, see [Network settings][2] in the *Docker run
|
|
8058
8052
|
# reference*.
|
|
8059
8053
|
#
|
|
@@ -8187,9 +8181,9 @@ module Aws::ECS
|
|
|
8187
8181
|
#
|
|
8188
8182
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
|
8189
8183
|
# of such as a prefix for either keys or values as it is reserved
|
|
8190
|
-
# for
|
|
8191
|
-
# this prefix. Tags with this prefix do not count
|
|
8192
|
-
# per resource limit.
|
|
8184
|
+
# for Amazon Web Services use. You cannot edit or delete tag keys or
|
|
8185
|
+
# values with this prefix. Tags with this prefix do not count
|
|
8186
|
+
# against your tags per resource limit.
|
|
8193
8187
|
# @return [Array<Types::Tag>]
|
|
8194
8188
|
#
|
|
8195
8189
|
# @!attribute [rw] pid_mode
|
|
@@ -8207,7 +8201,7 @@ module Aws::ECS
|
|
|
8207
8201
|
# see [Docker security][2].
|
|
8208
8202
|
#
|
|
8209
8203
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
|
8210
|
-
# on
|
|
8204
|
+
# on Fargate.
|
|
8211
8205
|
#
|
|
8212
8206
|
# </note>
|
|
8213
8207
|
#
|
|
@@ -8248,7 +8242,7 @@ module Aws::ECS
|
|
|
8248
8242
|
# `systemControls` will apply to all containers within a task.
|
|
8249
8243
|
#
|
|
8250
8244
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
|
8251
|
-
# on
|
|
8245
|
+
# on Fargate.
|
|
8252
8246
|
#
|
|
8253
8247
|
# </note>
|
|
8254
8248
|
#
|
|
@@ -8284,12 +8278,12 @@ module Aws::ECS
|
|
|
8284
8278
|
# @!attribute [rw] ephemeral_storage
|
|
8285
8279
|
# The amount of ephemeral storage to allocate for the task. This
|
|
8286
8280
|
# parameter is used to expand the total amount of ephemeral storage
|
|
8287
|
-
# available, beyond the default amount, for tasks hosted on
|
|
8288
|
-
#
|
|
8289
|
-
#
|
|
8281
|
+
# available, beyond the default amount, for tasks hosted on Fargate.
|
|
8282
|
+
# For more information, see [Fargate task storage][1] in the *Amazon
|
|
8283
|
+
# ECS User Guide for Fargate*.
|
|
8290
8284
|
#
|
|
8291
|
-
# <note markdown="1"> This parameter is only supported for tasks hosted on
|
|
8292
|
-
#
|
|
8285
|
+
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
|
|
8286
|
+
# platform version `1.4.0` or later.
|
|
8293
8287
|
#
|
|
8294
8288
|
# </note>
|
|
8295
8289
|
#
|
|
@@ -8351,11 +8345,11 @@ module Aws::ECS
|
|
|
8351
8345
|
# The Amazon Resource Name (ARN) of the secret containing the private
|
|
8352
8346
|
# repository credentials.
|
|
8353
8347
|
#
|
|
8354
|
-
# <note markdown="1"> When you are using the Amazon ECS API,
|
|
8355
|
-
# secret exists in the same Region as the task that you
|
|
8356
|
-
# then you can use either the full ARN or the name of
|
|
8357
|
-
# you are using the
|
|
8358
|
-
# ARN of the secret.
|
|
8348
|
+
# <note markdown="1"> When you are using the Amazon ECS API, CLI, or Amazon Web Services
|
|
8349
|
+
# SDK, if the secret exists in the same Region as the task that you
|
|
8350
|
+
# are launching then you can use either the full ARN or the name of
|
|
8351
|
+
# the secret. When you are using the Amazon Web Services Management
|
|
8352
|
+
# Console, you must specify the full ARN of the secret.
|
|
8359
8353
|
#
|
|
8360
8354
|
# </note>
|
|
8361
8355
|
# @return [String]
|
|
@@ -8500,7 +8494,7 @@ module Aws::ECS
|
|
|
8500
8494
|
# enable_ecs_managed_tags: false,
|
|
8501
8495
|
# enable_execute_command: false,
|
|
8502
8496
|
# group: "String",
|
|
8503
|
-
# launch_type: "EC2", # accepts EC2, FARGATE
|
|
8497
|
+
# launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
|
|
8504
8498
|
# network_configuration: {
|
|
8505
8499
|
# awsvpc_configuration: {
|
|
8506
8500
|
# subnets: ["String"], # required
|
|
@@ -8582,6 +8576,9 @@ module Aws::ECS
|
|
|
8582
8576
|
# parameter must be omitted. If no `capacityProviderStrategy` or
|
|
8583
8577
|
# `launchType` is specified, the `defaultCapacityProviderStrategy` for
|
|
8584
8578
|
# the cluster is used.
|
|
8579
|
+
#
|
|
8580
|
+
# When you use cluster auto scaling, you must specify
|
|
8581
|
+
# `capacityProviderStrategy` and not `launchType`.
|
|
8585
8582
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
|
8586
8583
|
#
|
|
8587
8584
|
# @!attribute [rw] cluster
|
|
@@ -8618,24 +8615,36 @@ module Aws::ECS
|
|
|
8618
8615
|
# @return [String]
|
|
8619
8616
|
#
|
|
8620
8617
|
# @!attribute [rw] launch_type
|
|
8621
|
-
# The
|
|
8622
|
-
#
|
|
8623
|
-
#
|
|
8618
|
+
# The infrastructure on which to run your standalone task. For more
|
|
8619
|
+
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
|
8620
|
+
# Container Service Developer Guide*.
|
|
8624
8621
|
#
|
|
8625
|
-
#
|
|
8626
|
-
#
|
|
8627
|
-
#
|
|
8628
|
-
#
|
|
8622
|
+
# The `FARGATE` launch type runs your tasks on Fargate On-Demand
|
|
8623
|
+
# infrastructure.
|
|
8624
|
+
#
|
|
8625
|
+
# <note markdown="1"> Fargate Spot infrastructure is available for use but a capacity
|
|
8626
|
+
# provider strategy must be used. For more information, see [Fargate
|
|
8627
|
+
# capacity providers][2] in the *Amazon ECS User Guide for Fargate*.
|
|
8628
|
+
#
|
|
8629
|
+
# </note>
|
|
8629
8630
|
#
|
|
8630
|
-
#
|
|
8631
|
-
#
|
|
8631
|
+
# The `EC2` launch type runs your tasks on Amazon EC2 instances
|
|
8632
|
+
# registered to your cluster.
|
|
8632
8633
|
#
|
|
8634
|
+
# The `EXTERNAL` launch type runs your tasks on your on-premise server
|
|
8635
|
+
# or virtual machine (VM) capacity registered to your cluster.
|
|
8636
|
+
#
|
|
8637
|
+
# A task can use either a launch type or a capacity provider strategy.
|
|
8633
8638
|
# If a `launchType` is specified, the `capacityProviderStrategy`
|
|
8634
8639
|
# parameter must be omitted.
|
|
8635
8640
|
#
|
|
8641
|
+
# When you use cluster auto scaling, you must specify
|
|
8642
|
+
# `capacityProviderStrategy` and not `launchType`.
|
|
8643
|
+
#
|
|
8636
8644
|
#
|
|
8637
8645
|
#
|
|
8638
8646
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html
|
|
8647
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/userguide/fargate-capacity-providers.html
|
|
8639
8648
|
# @return [String]
|
|
8640
8649
|
#
|
|
8641
8650
|
# @!attribute [rw] network_configuration
|
|
@@ -8681,8 +8690,8 @@ module Aws::ECS
|
|
|
8681
8690
|
# The platform version the task should run. A platform version is only
|
|
8682
8691
|
# specified for tasks using the Fargate launch type. If one is not
|
|
8683
8692
|
# specified, the `LATEST` platform version is used by default. For
|
|
8684
|
-
# more information, see [
|
|
8685
|
-
#
|
|
8693
|
+
# more information, see [Fargate Platform Versions][1] in the *Amazon
|
|
8694
|
+
# Elastic Container Service Developer Guide*.
|
|
8686
8695
|
#
|
|
8687
8696
|
#
|
|
8688
8697
|
#
|
|
@@ -8744,9 +8753,9 @@ module Aws::ECS
|
|
|
8744
8753
|
#
|
|
8745
8754
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
|
8746
8755
|
# of such as a prefix for either keys or values as it is reserved
|
|
8747
|
-
# for
|
|
8748
|
-
# this prefix. Tags with this prefix do not count
|
|
8749
|
-
# 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.
|
|
8750
8759
|
# @return [Array<Types::Tag>]
|
|
8751
8760
|
#
|
|
8752
8761
|
# @!attribute [rw] task_definition
|
|
@@ -8857,13 +8866,13 @@ module Aws::ECS
|
|
|
8857
8866
|
#
|
|
8858
8867
|
# @!attribute [rw] value_from
|
|
8859
8868
|
# The secret to expose to the container. The supported values are
|
|
8860
|
-
# either the full ARN of the
|
|
8861
|
-
#
|
|
8869
|
+
# either the full ARN of the Secrets Manager secret or the full ARN of
|
|
8870
|
+
# the parameter in the SSM Parameter Store.
|
|
8862
8871
|
#
|
|
8863
|
-
# <note markdown="1"> If the
|
|
8864
|
-
#
|
|
8865
|
-
#
|
|
8866
|
-
#
|
|
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.
|
|
8867
8876
|
#
|
|
8868
8877
|
# </note>
|
|
8869
8878
|
# @return [String]
|
|
@@ -8895,16 +8904,17 @@ module Aws::ECS
|
|
|
8895
8904
|
# @!attribute [rw] service_arn
|
|
8896
8905
|
# The ARN that identifies the service. The ARN contains the
|
|
8897
8906
|
# `arn:aws:ecs` namespace, followed by the Region of the service, the
|
|
8898
|
-
#
|
|
8899
|
-
#
|
|
8907
|
+
# account ID of the service owner, the `service` namespace, and then
|
|
8908
|
+
# the service name. For example,
|
|
8900
8909
|
# `arn:aws:ecs:region:012345678910:service/my-service`.
|
|
8901
8910
|
# @return [String]
|
|
8902
8911
|
#
|
|
8903
8912
|
# @!attribute [rw] service_name
|
|
8904
8913
|
# The name of your service. Up to 255 letters (uppercase and
|
|
8905
|
-
# lowercase), numbers, and hyphens are allowed. Service
|
|
8906
|
-
# unique within a cluster, but you can have similarly
|
|
8907
|
-
# in multiple clusters within a Region or across
|
|
8914
|
+
# lowercase), numbers, underscores, and hyphens are allowed. Service
|
|
8915
|
+
# names must be unique within a cluster, but you can have similarly
|
|
8916
|
+
# named services in multiple clusters within a Region or across
|
|
8917
|
+
# multiple Regions.
|
|
8908
8918
|
# @return [String]
|
|
8909
8919
|
#
|
|
8910
8920
|
# @!attribute [rw] cluster_arn
|
|
@@ -8949,27 +8959,23 @@ module Aws::ECS
|
|
|
8949
8959
|
# @return [Integer]
|
|
8950
8960
|
#
|
|
8951
8961
|
# @!attribute [rw] launch_type
|
|
8952
|
-
# The launch type
|
|
8953
|
-
#
|
|
8954
|
-
#
|
|
8955
|
-
# the *Amazon Elastic Container Service Developer Guide*.
|
|
8956
|
-
#
|
|
8957
|
-
#
|
|
8958
|
-
#
|
|
8959
|
-
# [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.
|
|
8960
8965
|
# @return [String]
|
|
8961
8966
|
#
|
|
8962
8967
|
# @!attribute [rw] capacity_provider_strategy
|
|
8963
|
-
# 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.
|
|
8964
8971
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
|
8965
8972
|
#
|
|
8966
8973
|
# @!attribute [rw] platform_version
|
|
8967
8974
|
# The platform version on which to run your service. A platform
|
|
8968
|
-
# version is only specified for tasks
|
|
8969
|
-
#
|
|
8970
|
-
#
|
|
8971
|
-
#
|
|
8972
|
-
# 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*.
|
|
8973
8979
|
#
|
|
8974
8980
|
#
|
|
8975
8981
|
#
|
|
@@ -8989,10 +8995,10 @@ module Aws::ECS
|
|
|
8989
8995
|
# @return [Types::DeploymentConfiguration]
|
|
8990
8996
|
#
|
|
8991
8997
|
# @!attribute [rw] task_sets
|
|
8992
|
-
# Information about a set of Amazon ECS tasks in either an
|
|
8993
|
-
#
|
|
8994
|
-
#
|
|
8995
|
-
#
|
|
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.
|
|
8996
9002
|
# @return [Array<Types::TaskSet>]
|
|
8997
9003
|
#
|
|
8998
9004
|
# @!attribute [rw] deployments
|
|
@@ -9095,9 +9101,9 @@ module Aws::ECS
|
|
|
9095
9101
|
#
|
|
9096
9102
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
|
9097
9103
|
# of such as a prefix for either keys or values as it is reserved
|
|
9098
|
-
# for
|
|
9099
|
-
# this prefix. Tags with this prefix do not count
|
|
9100
|
-
# 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.
|
|
9101
9107
|
# @return [Array<Types::Tag>]
|
|
9102
9108
|
#
|
|
9103
9109
|
# @!attribute [rw] created_by
|
|
@@ -9218,7 +9224,7 @@ module Aws::ECS
|
|
|
9218
9224
|
#
|
|
9219
9225
|
# @!attribute [rw] registry_arn
|
|
9220
9226
|
# The Amazon Resource Name (ARN) of the service registry. The
|
|
9221
|
-
# currently supported service registry is
|
|
9227
|
+
# currently supported service registry is Cloud Map. For more
|
|
9222
9228
|
# information, see [CreateService][1].
|
|
9223
9229
|
#
|
|
9224
9230
|
#
|
|
@@ -9495,9 +9501,9 @@ module Aws::ECS
|
|
|
9495
9501
|
#
|
|
9496
9502
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
|
9497
9503
|
# of such as a prefix for either keys or values as it is reserved
|
|
9498
|
-
# for
|
|
9499
|
-
# this prefix. Tags with this prefix do not count
|
|
9500
|
-
# 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.
|
|
9501
9507
|
# @return [Array<Types::Tag>]
|
|
9502
9508
|
#
|
|
9503
9509
|
# @!attribute [rw] task_definition
|
|
@@ -9908,10 +9914,10 @@ module Aws::ECS
|
|
|
9908
9914
|
# * Tag keys and values are case-sensitive.
|
|
9909
9915
|
#
|
|
9910
9916
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
|
9911
|
-
# such as a prefix for either keys or values as it is reserved for
|
|
9912
|
-
# use. You cannot edit or delete tag keys or
|
|
9913
|
-
# Tags with this prefix do not count against
|
|
9914
|
-
# 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.
|
|
9915
9921
|
#
|
|
9916
9922
|
# @note When making an API call, you may pass Tag
|
|
9917
9923
|
# data as a hash:
|
|
@@ -9986,9 +9992,9 @@ module Aws::ECS
|
|
|
9986
9992
|
#
|
|
9987
9993
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
|
9988
9994
|
# of such as a prefix for either keys or values as it is reserved
|
|
9989
|
-
# for
|
|
9990
|
-
# this prefix. Tags with this prefix do not count
|
|
9991
|
-
# 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.
|
|
9992
9998
|
# @return [Array<Types::Tag>]
|
|
9993
9999
|
#
|
|
9994
10000
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TagResourceRequest AWS API Documentation
|
|
@@ -10152,9 +10158,9 @@ module Aws::ECS
|
|
|
10152
10158
|
# @return [String]
|
|
10153
10159
|
#
|
|
10154
10160
|
# @!attribute [rw] launch_type
|
|
10155
|
-
# The
|
|
10156
|
-
# see [Amazon ECS
|
|
10157
|
-
# Service Developer Guide*.
|
|
10161
|
+
# The infrastructure on which your task is running. For more
|
|
10162
|
+
# information, see [Amazon ECS launch types][1] in the *Amazon Elastic
|
|
10163
|
+
# Container Service Developer Guide*.
|
|
10158
10164
|
#
|
|
10159
10165
|
#
|
|
10160
10166
|
#
|
|
@@ -10198,9 +10204,8 @@ module Aws::ECS
|
|
|
10198
10204
|
# The platform version on which your task is running. A platform
|
|
10199
10205
|
# version is only specified for tasks using the Fargate launch type.
|
|
10200
10206
|
# If one is not specified, the `LATEST` platform version is used by
|
|
10201
|
-
# default. For more information, see [
|
|
10202
|
-
#
|
|
10203
|
-
# Guide*.
|
|
10207
|
+
# default. For more information, see [Fargate Platform Versions][1] in
|
|
10208
|
+
# the *Amazon Elastic Container Service Developer Guide*.
|
|
10204
10209
|
#
|
|
10205
10210
|
#
|
|
10206
10211
|
#
|
|
@@ -10271,9 +10276,9 @@ module Aws::ECS
|
|
|
10271
10276
|
#
|
|
10272
10277
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
|
10273
10278
|
# of such as a prefix for either keys or values as it is reserved
|
|
10274
|
-
# for
|
|
10275
|
-
# this prefix. Tags with this prefix do not count
|
|
10276
|
-
# 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.
|
|
10277
10282
|
# @return [Array<Types::Tag>]
|
|
10278
10283
|
#
|
|
10279
10284
|
# @!attribute [rw] task_arn
|
|
@@ -10374,9 +10379,9 @@ module Aws::ECS
|
|
|
10374
10379
|
# @return [String]
|
|
10375
10380
|
#
|
|
10376
10381
|
# @!attribute [rw] task_role_arn
|
|
10377
|
-
# The short name or full Amazon Resource Name (ARN) of the
|
|
10378
|
-
#
|
|
10379
|
-
#
|
|
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
|
|
10380
10385
|
# information, see [Amazon ECS Task Role][1] in the *Amazon Elastic
|
|
10381
10386
|
# Container Service Developer Guide*.
|
|
10382
10387
|
#
|
|
@@ -10395,11 +10400,11 @@ module Aws::ECS
|
|
|
10395
10400
|
#
|
|
10396
10401
|
# @!attribute [rw] execution_role_arn
|
|
10397
10402
|
# The Amazon Resource Name (ARN) of the task execution role that
|
|
10398
|
-
# grants the Amazon ECS container agent permission to make
|
|
10399
|
-
# calls on your behalf. The task execution IAM role is
|
|
10400
|
-
# depending on the requirements of your task. For more
|
|
10401
|
-
# see [Amazon ECS task execution IAM role][1] in the
|
|
10402
|
-
# 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*.
|
|
10403
10408
|
#
|
|
10404
10409
|
#
|
|
10405
10410
|
#
|
|
@@ -10412,13 +10417,15 @@ module Aws::ECS
|
|
|
10412
10417
|
# network mode is specified, the default is `bridge`.
|
|
10413
10418
|
#
|
|
10414
10419
|
# For Amazon ECS tasks on Fargate, the `awsvpc` network mode is
|
|
10415
|
-
# required. For Amazon ECS tasks on Amazon EC2 instances, any
|
|
10416
|
-
# mode can be used.
|
|
10417
|
-
#
|
|
10418
|
-
#
|
|
10419
|
-
#
|
|
10420
|
-
#
|
|
10421
|
-
#
|
|
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.
|
|
10422
10429
|
#
|
|
10423
10430
|
# With the `host` and `awsvpc` network modes, exposed container ports
|
|
10424
10431
|
# are mapped directly to the corresponding host port (for the `host`
|
|
@@ -10436,22 +10443,10 @@ module Aws::ECS
|
|
|
10436
10443
|
# For more information, see [Task Networking][1] in the *Amazon
|
|
10437
10444
|
# Elastic Container Service Developer Guide*.
|
|
10438
10445
|
#
|
|
10439
|
-
# <note markdown="1"> Currently, only Amazon ECS-optimized AMIs, other Amazon Linux
|
|
10440
|
-
# variants with the `ecs-init` package, or AWS Fargate infrastructure
|
|
10441
|
-
# support the `awsvpc` network mode.
|
|
10442
|
-
#
|
|
10443
|
-
# </note>
|
|
10444
|
-
#
|
|
10445
10446
|
# If the network mode is `host`, you cannot run multiple
|
|
10446
10447
|
# instantiations of the same task on a single container instance when
|
|
10447
10448
|
# port mappings are used.
|
|
10448
10449
|
#
|
|
10449
|
-
# Docker for Windows uses different network modes than Docker for
|
|
10450
|
-
# Linux. When you register a task definition with Windows containers,
|
|
10451
|
-
# you must not specify a network mode. If you use the console to
|
|
10452
|
-
# register a task definition with Windows containers, you must choose
|
|
10453
|
-
# the `<default>` network mode object.
|
|
10454
|
-
#
|
|
10455
10450
|
# For more information, see [Network settings][2] in the *Docker run
|
|
10456
10451
|
# reference*.
|
|
10457
10452
|
#
|
|
@@ -10476,7 +10471,7 @@ module Aws::ECS
|
|
|
10476
10471
|
# Elastic Container Service Developer Guide*.
|
|
10477
10472
|
#
|
|
10478
10473
|
# <note markdown="1"> The `host` and `sourcePath` parameters are not supported for tasks
|
|
10479
|
-
# run on
|
|
10474
|
+
# run on Fargate.
|
|
10480
10475
|
#
|
|
10481
10476
|
# </note>
|
|
10482
10477
|
#
|
|
@@ -10499,7 +10494,7 @@ module Aws::ECS
|
|
|
10499
10494
|
# EC2 instances. For more information, see [Attributes][1] in the
|
|
10500
10495
|
# *Amazon Elastic Container Service Developer Guide*.
|
|
10501
10496
|
#
|
|
10502
|
-
# <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.
|
|
10503
10498
|
#
|
|
10504
10499
|
# </note>
|
|
10505
10500
|
#
|
|
@@ -10511,7 +10506,7 @@ module Aws::ECS
|
|
|
10511
10506
|
# @!attribute [rw] placement_constraints
|
|
10512
10507
|
# An array of placement constraint objects to use for tasks.
|
|
10513
10508
|
#
|
|
10514
|
-
# <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.
|
|
10515
10510
|
#
|
|
10516
10511
|
# </note>
|
|
10517
10512
|
# @return [Array<Types::TaskDefinitionPlacementConstraint>]
|
|
@@ -10567,9 +10562,9 @@ module Aws::ECS
|
|
|
10567
10562
|
# optional. For more information regarding container-level memory and
|
|
10568
10563
|
# memory reservation, see [ContainerDefinition][1].
|
|
10569
10564
|
#
|
|
10570
|
-
# If your tasks will be run on
|
|
10571
|
-
#
|
|
10572
|
-
#
|
|
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:
|
|
10573
10568
|
#
|
|
10574
10569
|
# * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values:
|
|
10575
10570
|
# 256 (.25 vCPU)
|
|
@@ -10610,7 +10605,7 @@ module Aws::ECS
|
|
|
10610
10605
|
# see [Docker security][2].
|
|
10611
10606
|
#
|
|
10612
10607
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
|
10613
|
-
# on
|
|
10608
|
+
# on Fargate.
|
|
10614
10609
|
#
|
|
10615
10610
|
# </note>
|
|
10616
10611
|
#
|
|
@@ -10651,7 +10646,7 @@ module Aws::ECS
|
|
|
10651
10646
|
# `systemControls` will apply to all containers within a task.
|
|
10652
10647
|
#
|
|
10653
10648
|
# <note markdown="1"> This parameter is not supported for Windows containers or tasks run
|
|
10654
|
-
# on
|
|
10649
|
+
# on Fargate.
|
|
10655
10650
|
#
|
|
10656
10651
|
# </note>
|
|
10657
10652
|
#
|
|
@@ -10730,8 +10725,7 @@ module Aws::ECS
|
|
|
10730
10725
|
# definition. For more information, see [Task placement constraints][1]
|
|
10731
10726
|
# in the *Amazon Elastic Container Service Developer Guide*.
|
|
10732
10727
|
#
|
|
10733
|
-
# <note markdown="1"> Task placement constraints are not supported for tasks run on
|
|
10734
|
-
# Fargate.
|
|
10728
|
+
# <note markdown="1"> Task placement constraints are not supported for tasks run on Fargate.
|
|
10735
10729
|
#
|
|
10736
10730
|
# </note>
|
|
10737
10731
|
#
|
|
@@ -10849,8 +10843,8 @@ module Aws::ECS
|
|
|
10849
10843
|
# @!attribute [rw] ephemeral_storage
|
|
10850
10844
|
# The ephemeral storage setting override for the task.
|
|
10851
10845
|
#
|
|
10852
|
-
# <note markdown="1"> This parameter is only supported for tasks hosted on
|
|
10853
|
-
#
|
|
10846
|
+
# <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
|
|
10847
|
+
# platform version `1.4.0` or later.
|
|
10854
10848
|
#
|
|
10855
10849
|
# </note>
|
|
10856
10850
|
# @return [Types::EphemeralStorage]
|
|
@@ -10869,10 +10863,10 @@ module Aws::ECS
|
|
|
10869
10863
|
include Aws::Structure
|
|
10870
10864
|
end
|
|
10871
10865
|
|
|
10872
|
-
# Information about a set of Amazon ECS tasks in either an
|
|
10873
|
-
#
|
|
10874
|
-
#
|
|
10875
|
-
#
|
|
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.
|
|
10876
10870
|
#
|
|
10877
10871
|
# @!attribute [rw] id
|
|
10878
10872
|
# The ID of the task set.
|
|
@@ -10894,20 +10888,20 @@ module Aws::ECS
|
|
|
10894
10888
|
#
|
|
10895
10889
|
# @!attribute [rw] started_by
|
|
10896
10890
|
# The tag specified when a task set is started. If the task set is
|
|
10897
|
-
# created by an
|
|
10898
|
-
#
|
|
10891
|
+
# created by an CodeDeploy deployment, the `startedBy` parameter is
|
|
10892
|
+
# `CODE_DEPLOY`. For a task set created for an external deployment,
|
|
10899
10893
|
# the startedBy field isn't used.
|
|
10900
10894
|
# @return [String]
|
|
10901
10895
|
#
|
|
10902
10896
|
# @!attribute [rw] external_id
|
|
10903
10897
|
# The external ID associated with the task set.
|
|
10904
10898
|
#
|
|
10905
|
-
# If a task set is created by an
|
|
10906
|
-
# `externalId` parameter contains the
|
|
10899
|
+
# If a task set is created by an CodeDeploy deployment, the
|
|
10900
|
+
# `externalId` parameter contains the CodeDeploy deployment ID.
|
|
10907
10901
|
#
|
|
10908
10902
|
# If a task set is created for an external deployment and is
|
|
10909
10903
|
# associated with a service discovery registry, the `externalId`
|
|
10910
|
-
# parameter contains the `ECS_TASK_SET_EXTERNAL_ID`
|
|
10904
|
+
# parameter contains the `ECS_TASK_SET_EXTERNAL_ID` Cloud Map
|
|
10911
10905
|
# attribute.
|
|
10912
10906
|
# @return [String]
|
|
10913
10907
|
#
|
|
@@ -10977,11 +10971,10 @@ module Aws::ECS
|
|
|
10977
10971
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
|
10978
10972
|
#
|
|
10979
10973
|
# @!attribute [rw] platform_version
|
|
10980
|
-
# The
|
|
10981
|
-
#
|
|
10982
|
-
#
|
|
10983
|
-
#
|
|
10984
|
-
# 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*.
|
|
10985
10978
|
#
|
|
10986
10979
|
#
|
|
10987
10980
|
#
|
|
@@ -11060,9 +11053,9 @@ module Aws::ECS
|
|
|
11060
11053
|
#
|
|
11061
11054
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
|
11062
11055
|
# of such as a prefix for either keys or values as it is reserved
|
|
11063
|
-
# for
|
|
11064
|
-
# this prefix. Tags with this prefix do not count
|
|
11065
|
-
# 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.
|
|
11066
11059
|
# @return [Array<Types::Tag>]
|
|
11067
11060
|
#
|
|
11068
11061
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TaskSet AWS API Documentation
|
|
@@ -11622,10 +11615,10 @@ module Aws::ECS
|
|
|
11622
11615
|
# providers can be created with the CreateCapacityProvider API
|
|
11623
11616
|
# operation.
|
|
11624
11617
|
#
|
|
11625
|
-
# To use a
|
|
11626
|
-
#
|
|
11627
|
-
#
|
|
11628
|
-
#
|
|
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.
|
|
11629
11622
|
#
|
|
11630
11623
|
# The PutClusterCapacityProviders API operation is used to update the
|
|
11631
11624
|
# list of available capacity providers for a cluster after the cluster
|
|
@@ -11669,8 +11662,8 @@ module Aws::ECS
|
|
|
11669
11662
|
# The platform version on which your tasks in the service are running.
|
|
11670
11663
|
# A platform version is only specified for tasks using the Fargate
|
|
11671
11664
|
# launch type. If a platform version is not specified, the `LATEST`
|
|
11672
|
-
# platform version is used by default. For more information, see
|
|
11673
|
-
# 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
|
|
11674
11667
|
# Service Developer Guide*.
|
|
11675
11668
|
#
|
|
11676
11669
|
#
|
|
@@ -11891,8 +11884,9 @@ module Aws::ECS
|
|
|
11891
11884
|
#
|
|
11892
11885
|
# @!attribute [rw] name
|
|
11893
11886
|
# The name of the volume. Up to 255 letters (uppercase and lowercase),
|
|
11894
|
-
# numbers, and hyphens are allowed. This name is
|
|
11895
|
-
# `sourceVolume` parameter of container definition
|
|
11887
|
+
# numbers, underscores, and hyphens are allowed. This name is
|
|
11888
|
+
# referenced in the `sourceVolume` parameter of container definition
|
|
11889
|
+
# `mountPoints`.
|
|
11896
11890
|
# @return [String]
|
|
11897
11891
|
#
|
|
11898
11892
|
# @!attribute [rw] host
|
|
@@ -11917,7 +11911,7 @@ module Aws::ECS
|
|
|
11917
11911
|
# Windows containers only support the use of the `local` driver. To
|
|
11918
11912
|
# use bind mounts, specify the `host` parameter instead.
|
|
11919
11913
|
#
|
|
11920
|
-
# <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.
|
|
11921
11915
|
#
|
|
11922
11916
|
# </note>
|
|
11923
11917
|
# @return [Types::DockerVolumeConfiguration]
|