aws-sdk-ecs 1.40.0 → 1.41.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/lib/aws-sdk-ecs.rb +1 -1
- data/lib/aws-sdk-ecs/client.rb +169 -95
- data/lib/aws-sdk-ecs/client_api.rb +22 -0
- data/lib/aws-sdk-ecs/types.rb +271 -162
- metadata +2 -2
@@ -220,6 +220,8 @@ module Aws::ECS
|
|
220
220
|
String = Shapes::StringShape.new(name: 'String')
|
221
221
|
StringList = Shapes::ListShape.new(name: 'StringList')
|
222
222
|
StringMap = Shapes::MapShape.new(name: 'StringMap')
|
223
|
+
SubmitAttachmentStateChangesRequest = Shapes::StructureShape.new(name: 'SubmitAttachmentStateChangesRequest')
|
224
|
+
SubmitAttachmentStateChangesResponse = Shapes::StructureShape.new(name: 'SubmitAttachmentStateChangesResponse')
|
223
225
|
SubmitContainerStateChangeRequest = Shapes::StructureShape.new(name: 'SubmitContainerStateChangeRequest')
|
224
226
|
SubmitContainerStateChangeResponse = Shapes::StructureShape.new(name: 'SubmitContainerStateChangeResponse')
|
225
227
|
SubmitTaskStateChangeRequest = Shapes::StructureShape.new(name: 'SubmitTaskStateChangeRequest')
|
@@ -397,6 +399,7 @@ module Aws::ECS
|
|
397
399
|
ContainerInstance.add_member(:remaining_resources, Shapes::ShapeRef.new(shape: Resources, location_name: "remainingResources"))
|
398
400
|
ContainerInstance.add_member(:registered_resources, Shapes::ShapeRef.new(shape: Resources, location_name: "registeredResources"))
|
399
401
|
ContainerInstance.add_member(:status, Shapes::ShapeRef.new(shape: String, location_name: "status"))
|
402
|
+
ContainerInstance.add_member(:status_reason, Shapes::ShapeRef.new(shape: String, location_name: "statusReason"))
|
400
403
|
ContainerInstance.add_member(:agent_connected, Shapes::ShapeRef.new(shape: Boolean, location_name: "agentConnected"))
|
401
404
|
ContainerInstance.add_member(:running_tasks_count, Shapes::ShapeRef.new(shape: Integer, location_name: "runningTasksCount"))
|
402
405
|
ContainerInstance.add_member(:pending_tasks_count, Shapes::ShapeRef.new(shape: Integer, location_name: "pendingTasksCount"))
|
@@ -1040,6 +1043,13 @@ module Aws::ECS
|
|
1040
1043
|
StringMap.key = Shapes::ShapeRef.new(shape: String)
|
1041
1044
|
StringMap.value = Shapes::ShapeRef.new(shape: String)
|
1042
1045
|
|
1046
|
+
SubmitAttachmentStateChangesRequest.add_member(:cluster, Shapes::ShapeRef.new(shape: String, location_name: "cluster"))
|
1047
|
+
SubmitAttachmentStateChangesRequest.add_member(:attachments, Shapes::ShapeRef.new(shape: AttachmentStateChanges, required: true, location_name: "attachments"))
|
1048
|
+
SubmitAttachmentStateChangesRequest.struct_class = Types::SubmitAttachmentStateChangesRequest
|
1049
|
+
|
1050
|
+
SubmitAttachmentStateChangesResponse.add_member(:acknowledgment, Shapes::ShapeRef.new(shape: String, location_name: "acknowledgment"))
|
1051
|
+
SubmitAttachmentStateChangesResponse.struct_class = Types::SubmitAttachmentStateChangesResponse
|
1052
|
+
|
1043
1053
|
SubmitContainerStateChangeRequest.add_member(:cluster, Shapes::ShapeRef.new(shape: String, location_name: "cluster"))
|
1044
1054
|
SubmitContainerStateChangeRequest.add_member(:task, Shapes::ShapeRef.new(shape: String, location_name: "task"))
|
1045
1055
|
SubmitContainerStateChangeRequest.add_member(:container_name, Shapes::ShapeRef.new(shape: String, location_name: "containerName"))
|
@@ -1738,6 +1748,18 @@ module Aws::ECS
|
|
1738
1748
|
o.errors << Shapes::ShapeRef.new(shape: ClusterNotFoundException)
|
1739
1749
|
end)
|
1740
1750
|
|
1751
|
+
api.add_operation(:submit_attachment_state_changes, Seahorse::Model::Operation.new.tap do |o|
|
1752
|
+
o.name = "SubmitAttachmentStateChanges"
|
1753
|
+
o.http_method = "POST"
|
1754
|
+
o.http_request_uri = "/"
|
1755
|
+
o.input = Shapes::ShapeRef.new(shape: SubmitAttachmentStateChangesRequest)
|
1756
|
+
o.output = Shapes::ShapeRef.new(shape: SubmitAttachmentStateChangesResponse)
|
1757
|
+
o.errors << Shapes::ShapeRef.new(shape: ServerException)
|
1758
|
+
o.errors << Shapes::ShapeRef.new(shape: ClientException)
|
1759
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1760
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
1761
|
+
end)
|
1762
|
+
|
1741
1763
|
api.add_operation(:submit_container_state_change, Seahorse::Model::Operation.new.tap do |o|
|
1742
1764
|
o.name = "SubmitContainerStateChange"
|
1743
1765
|
o.http_method = "POST"
|
data/lib/aws-sdk-ecs/types.rb
CHANGED
@@ -189,7 +189,7 @@ module Aws::ECS
|
|
189
189
|
# contains the `arn:aws:ecs` namespace, followed by the Region of the
|
190
190
|
# cluster, the AWS account ID of the cluster owner, the `cluster`
|
191
191
|
# namespace, and then the cluster name. For example,
|
192
|
-
# `arn:aws:ecs:region:012345678910:cluster/test
|
192
|
+
# `arn:aws:ecs:region:012345678910:cluster/test`.
|
193
193
|
# @return [String]
|
194
194
|
#
|
195
195
|
# @!attribute [rw] cluster_name
|
@@ -489,9 +489,9 @@ module Aws::ECS
|
|
489
489
|
# together in a task definition, the `name` of one container can be
|
490
490
|
# entered in the `links` of another container to connect the
|
491
491
|
# containers. Up to 255 letters (uppercase and lowercase), numbers,
|
492
|
-
#
|
493
|
-
#
|
494
|
-
#
|
492
|
+
# and hyphens are allowed. This parameter maps to `name` in the
|
493
|
+
# [Create a container][1] section of the [Docker Remote API][2] and
|
494
|
+
# the `--name` option to [docker run][3].
|
495
495
|
#
|
496
496
|
#
|
497
497
|
#
|
@@ -617,16 +617,16 @@ module Aws::ECS
|
|
617
617
|
# @return [Integer]
|
618
618
|
#
|
619
619
|
# @!attribute [rw] memory
|
620
|
-
# The
|
621
|
-
#
|
622
|
-
# container is killed.
|
620
|
+
# The amount (in MiB) of memory to present to the container. If your
|
621
|
+
# container attempts to exceed the memory specified here, the
|
622
|
+
# container is killed. The total amount of memory reserved for all
|
623
|
+
# containers within a task must be lower than the task `memory` value,
|
624
|
+
# if one is specified. This parameter maps to `Memory` in the [Create
|
623
625
|
# a container][1] section of the [Docker Remote API][2] and the
|
624
626
|
# `--memory` option to [docker run][3].
|
625
627
|
#
|
626
628
|
# If your containers are part of a task using the Fargate launch type,
|
627
|
-
# this field is optional
|
628
|
-
# amount of memory reserved for all containers within a task be lower
|
629
|
-
# than the task `memory` value.
|
629
|
+
# this field is optional.
|
630
630
|
#
|
631
631
|
# For containers that are part of a task using the EC2 launch type,
|
632
632
|
# you must specify a non-zero integer for one or both of `memory` or
|
@@ -685,17 +685,16 @@ module Aws::ECS
|
|
685
685
|
# @return [Integer]
|
686
686
|
#
|
687
687
|
# @!attribute [rw] links
|
688
|
-
# The `
|
689
|
-
# other without the need for port mappings.
|
690
|
-
# network mode of a task definition is
|
688
|
+
# The `links` parameter allows containers to communicate with each
|
689
|
+
# other without the need for port mappings. This parameter is only
|
690
|
+
# supported if the network mode of a task definition is `bridge`. The
|
691
691
|
# `name:internalName` construct is analogous to `name:alias` in Docker
|
692
|
-
# links. Up to 255 letters (uppercase and lowercase), numbers,
|
693
|
-
# hyphens
|
694
|
-
#
|
695
|
-
#
|
696
|
-
#
|
697
|
-
#
|
698
|
-
# `docker run` ][4].
|
692
|
+
# links. Up to 255 letters (uppercase and lowercase), numbers, and
|
693
|
+
# hyphens are allowed. For more information about linking Docker
|
694
|
+
# containers, go to [Legacy container links][1] in the Docker
|
695
|
+
# documentation. This parameter maps to `Links` in the [Create a
|
696
|
+
# container][2] section of the [Docker Remote API][3] and the `--link`
|
697
|
+
# option to [docker run][4].
|
699
698
|
#
|
700
699
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
701
700
|
#
|
@@ -708,10 +707,10 @@ module Aws::ECS
|
|
708
707
|
#
|
709
708
|
#
|
710
709
|
#
|
711
|
-
# [1]: https://docs.docker.com/
|
710
|
+
# [1]: https://docs.docker.com/network/links/
|
712
711
|
# [2]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
|
713
712
|
# [3]: https://docs.docker.com/engine/api/v1.35/
|
714
|
-
# [4]: https://docs.docker.com/engine/reference/
|
713
|
+
# [4]: https://docs.docker.com/engine/reference/run/
|
715
714
|
# @return [Array<String>]
|
716
715
|
#
|
717
716
|
# @!attribute [rw] port_mappings
|
@@ -855,7 +854,8 @@ module Aws::ECS
|
|
855
854
|
#
|
856
855
|
# @!attribute [rw] linux_parameters
|
857
856
|
# Linux-specific modifications that are applied to the container, such
|
858
|
-
# as Linux
|
857
|
+
# as Linux kernel capabilities. For more information see
|
858
|
+
# KernelCapabilities.
|
859
859
|
#
|
860
860
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
861
861
|
#
|
@@ -869,7 +869,7 @@ module Aws::ECS
|
|
869
869
|
#
|
870
870
|
#
|
871
871
|
#
|
872
|
-
# [1]:
|
872
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html
|
873
873
|
# @return [Array<Types::Secret>]
|
874
874
|
#
|
875
875
|
# @!attribute [rw] depends_on
|
@@ -898,8 +898,8 @@ module Aws::ECS
|
|
898
898
|
#
|
899
899
|
#
|
900
900
|
#
|
901
|
-
# [1]:
|
902
|
-
# [2]:
|
901
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html
|
902
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html
|
903
903
|
# @return [Array<Types::ContainerDependency>]
|
904
904
|
#
|
905
905
|
# @!attribute [rw] start_timeout
|
@@ -932,8 +932,8 @@ module Aws::ECS
|
|
932
932
|
#
|
933
933
|
#
|
934
934
|
#
|
935
|
-
# [1]:
|
936
|
-
# [2]:
|
935
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html
|
936
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html
|
937
937
|
# @return [Integer]
|
938
938
|
#
|
939
939
|
# @!attribute [rw] stop_timeout
|
@@ -962,8 +962,8 @@ module Aws::ECS
|
|
962
962
|
#
|
963
963
|
#
|
964
964
|
#
|
965
|
-
# [1]:
|
966
|
-
# [2]:
|
965
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html
|
966
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html
|
967
967
|
# @return [Integer]
|
968
968
|
#
|
969
969
|
# @!attribute [rw] hostname
|
@@ -1146,7 +1146,9 @@ module Aws::ECS
|
|
1146
1146
|
# information, see [Amazon ECS Container Agent Configuration][4] in
|
1147
1147
|
# the *Amazon Elastic Container Service Developer Guide*.
|
1148
1148
|
#
|
1149
|
-
#
|
1149
|
+
# </note>
|
1150
|
+
#
|
1151
|
+
# <note markdown="1"> This parameter is not supported for Windows containers.
|
1150
1152
|
#
|
1151
1153
|
# </note>
|
1152
1154
|
#
|
@@ -1386,8 +1388,8 @@ module Aws::ECS
|
|
1386
1388
|
#
|
1387
1389
|
#
|
1388
1390
|
#
|
1389
|
-
# [1]:
|
1390
|
-
# [2]:
|
1391
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html
|
1392
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html
|
1391
1393
|
#
|
1392
1394
|
# @note When making an API call, you may pass ContainerDependency
|
1393
1395
|
# data as a hash:
|
@@ -1441,8 +1443,7 @@ module Aws::ECS
|
|
1441
1443
|
# container instance, the AWS account ID of the container instance
|
1442
1444
|
# owner, the `container-instance` namespace, and then the container
|
1443
1445
|
# instance ID. For example,
|
1444
|
-
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
|
1445
|
-
# `.
|
1446
|
+
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
1446
1447
|
# @return [String]
|
1447
1448
|
#
|
1448
1449
|
# @!attribute [rw] ec2_instance_id
|
@@ -1488,19 +1489,38 @@ module Aws::ECS
|
|
1488
1489
|
# @return [Array<Types::Resource>]
|
1489
1490
|
#
|
1490
1491
|
# @!attribute [rw] status
|
1491
|
-
# The status of the container instance. The valid values are
|
1492
|
-
# `
|
1493
|
-
#
|
1494
|
-
#
|
1495
|
-
#
|
1496
|
-
#
|
1497
|
-
#
|
1492
|
+
# The status of the container instance. The valid values are
|
1493
|
+
# `REGISTERING`, `REGISTRATION_FAILED`, `ACTIVE`, `INACTIVE`,
|
1494
|
+
# `DEREGISTERING`, or `DRAINING`.
|
1495
|
+
#
|
1496
|
+
# If your account has opted in to the `awsvpcTrunking` account
|
1497
|
+
# setting, then any newly registered container instance will
|
1498
|
+
# transition to a `REGISTERING` status while the trunk elastic network
|
1499
|
+
# interface is provisioned for the instance. If the registration
|
1500
|
+
# fails, the instance will transition to a `REGISTRATION_FAILED`
|
1501
|
+
# status. You can describe the container instance and see the reason
|
1502
|
+
# for failure in the `statusReason` parameter. Once the container
|
1503
|
+
# instance is terminated, the instance transitions to a
|
1504
|
+
# `DEREGISTERING` status while the trunk elastic network interface is
|
1505
|
+
# deprovisioned. The instance then transitions to an `INACTIVE`
|
1506
|
+
# status.
|
1507
|
+
#
|
1508
|
+
# The `ACTIVE` status indicates that the container instance can accept
|
1509
|
+
# tasks. The `DRAINING` indicates that new tasks are not placed on the
|
1510
|
+
# container instance and any service tasks running on the container
|
1511
|
+
# instance are removed if possible. For more information, see
|
1512
|
+
# [Container Instance Draining][1] in the *Amazon Elastic Container
|
1513
|
+
# Service Developer Guide*.
|
1498
1514
|
#
|
1499
1515
|
#
|
1500
1516
|
#
|
1501
1517
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-draining.html
|
1502
1518
|
# @return [String]
|
1503
1519
|
#
|
1520
|
+
# @!attribute [rw] status_reason
|
1521
|
+
# The reason that the container instance reached its current status.
|
1522
|
+
# @return [String]
|
1523
|
+
#
|
1504
1524
|
# @!attribute [rw] agent_connected
|
1505
1525
|
# This parameter returns `true` if the agent is connected to Amazon
|
1506
1526
|
# ECS. Registered instances with an agent that may be unhealthy or
|
@@ -1534,8 +1554,8 @@ module Aws::ECS
|
|
1534
1554
|
# @return [Time]
|
1535
1555
|
#
|
1536
1556
|
# @!attribute [rw] attachments
|
1537
|
-
# The
|
1538
|
-
#
|
1557
|
+
# The resources attached to a container instance, such as elastic
|
1558
|
+
# network interfaces.
|
1539
1559
|
# @return [Array<Types::Attachment>]
|
1540
1560
|
#
|
1541
1561
|
# @!attribute [rw] tags
|
@@ -1556,6 +1576,7 @@ module Aws::ECS
|
|
1556
1576
|
:remaining_resources,
|
1557
1577
|
:registered_resources,
|
1558
1578
|
:status,
|
1579
|
+
:status_reason,
|
1559
1580
|
:agent_connected,
|
1560
1581
|
:running_tasks_count,
|
1561
1582
|
:pending_tasks_count,
|
@@ -1567,7 +1588,10 @@ module Aws::ECS
|
|
1567
1588
|
include Aws::Structure
|
1568
1589
|
end
|
1569
1590
|
|
1570
|
-
# The overrides that should be sent to a container.
|
1591
|
+
# The overrides that should be sent to a container. An empty container
|
1592
|
+
# override can be passed in. An example of an empty container override
|
1593
|
+
# would be `\{"containerOverrides": [ ] \}`. If a non-empty container
|
1594
|
+
# override is specified, the `name` parameter must be included.
|
1571
1595
|
#
|
1572
1596
|
# @note When making an API call, you may pass ContainerOverride
|
1573
1597
|
# data as a hash:
|
@@ -1717,8 +1741,7 @@ module Aws::ECS
|
|
1717
1741
|
# @!attribute [rw] cluster_name
|
1718
1742
|
# The name of your cluster. If you do not specify a name for your
|
1719
1743
|
# cluster, you create a cluster named `default`. Up to 255 letters
|
1720
|
-
# (uppercase and lowercase), numbers,
|
1721
|
-
# allowed.
|
1744
|
+
# (uppercase and lowercase), numbers, and hyphens are allowed.
|
1722
1745
|
# @return [String]
|
1723
1746
|
#
|
1724
1747
|
# @!attribute [rw] tags
|
@@ -1822,10 +1845,9 @@ module Aws::ECS
|
|
1822
1845
|
#
|
1823
1846
|
# @!attribute [rw] service_name
|
1824
1847
|
# The name of your service. Up to 255 letters (uppercase and
|
1825
|
-
# lowercase), numbers,
|
1826
|
-
#
|
1827
|
-
#
|
1828
|
-
# multiple Regions.
|
1848
|
+
# lowercase), numbers, and hyphens are allowed. Service names must be
|
1849
|
+
# unique within a cluster, but you can have similarly named services
|
1850
|
+
# in multiple clusters within a Region or across multiple Regions.
|
1829
1851
|
# @return [String]
|
1830
1852
|
#
|
1831
1853
|
# @!attribute [rw] task_definition
|
@@ -1898,8 +1920,8 @@ module Aws::ECS
|
|
1898
1920
|
#
|
1899
1921
|
#
|
1900
1922
|
#
|
1901
|
-
# [1]:
|
1902
|
-
# [2]:
|
1923
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html
|
1924
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
1903
1925
|
# @return [Array<Types::ServiceRegistry>]
|
1904
1926
|
#
|
1905
1927
|
# @!attribute [rw] desired_count
|
@@ -1961,7 +1983,7 @@ module Aws::ECS
|
|
1961
1983
|
#
|
1962
1984
|
#
|
1963
1985
|
#
|
1964
|
-
# [1]:
|
1986
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html
|
1965
1987
|
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names
|
1966
1988
|
# @return [String]
|
1967
1989
|
#
|
@@ -1993,7 +2015,7 @@ module Aws::ECS
|
|
1993
2015
|
#
|
1994
2016
|
#
|
1995
2017
|
#
|
1996
|
-
# [1]:
|
2018
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
1997
2019
|
# @return [Types::NetworkConfiguration]
|
1998
2020
|
#
|
1999
2021
|
# @!attribute [rw] health_check_grace_period_seconds
|
@@ -2038,7 +2060,7 @@ module Aws::ECS
|
|
2038
2060
|
#
|
2039
2061
|
#
|
2040
2062
|
#
|
2041
|
-
# [1]:
|
2063
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html
|
2042
2064
|
# @return [String]
|
2043
2065
|
#
|
2044
2066
|
# @!attribute [rw] deployment_controller
|
@@ -2062,7 +2084,7 @@ module Aws::ECS
|
|
2062
2084
|
#
|
2063
2085
|
#
|
2064
2086
|
#
|
2065
|
-
# [1]:
|
2087
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
2066
2088
|
# @return [Boolean]
|
2067
2089
|
#
|
2068
2090
|
# @!attribute [rw] propagate_tags
|
@@ -2198,7 +2220,7 @@ module Aws::ECS
|
|
2198
2220
|
#
|
2199
2221
|
#
|
2200
2222
|
#
|
2201
|
-
# [1]:
|
2223
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html
|
2202
2224
|
# @return [Array<Types::ServiceRegistry>]
|
2203
2225
|
#
|
2204
2226
|
# @!attribute [rw] launch_type
|
@@ -2263,26 +2285,28 @@ module Aws::ECS
|
|
2263
2285
|
# data as a hash:
|
2264
2286
|
#
|
2265
2287
|
# {
|
2266
|
-
# name: "serviceLongArnFormat", # required, accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat
|
2288
|
+
# name: "serviceLongArnFormat", # required, accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat, awsvpcTrunking
|
2267
2289
|
# principal_arn: "String",
|
2268
2290
|
# }
|
2269
2291
|
#
|
2270
2292
|
# @!attribute [rw] name
|
2271
|
-
# The resource name for which to disable the
|
2293
|
+
# The resource name for which to disable the account setting. If
|
2272
2294
|
# `serviceLongArnFormat` is specified, the ARN for your Amazon ECS
|
2273
2295
|
# services is affected. If `taskLongArnFormat` is specified, the ARN
|
2274
2296
|
# and resource ID for your Amazon ECS tasks is affected. If
|
2275
2297
|
# `containerInstanceLongArnFormat` is specified, the ARN and resource
|
2276
|
-
# ID for your Amazon ECS container instances is affected.
|
2298
|
+
# ID for your Amazon ECS container instances is affected. If
|
2299
|
+
# `awsvpcTrunking` is specified, the ENI limit for your Amazon ECS
|
2300
|
+
# container instances is affected.
|
2277
2301
|
# @return [String]
|
2278
2302
|
#
|
2279
2303
|
# @!attribute [rw] principal_arn
|
2280
2304
|
# The ARN of the principal, which can be an IAM user, IAM role, or the
|
2281
|
-
# root user. If you specify the root user, it
|
2282
|
-
#
|
2283
|
-
#
|
2284
|
-
# settings
|
2285
|
-
#
|
2305
|
+
# root user. If you specify the root user, it disables the account
|
2306
|
+
# setting for all IAM users, IAM roles, and the root user of the
|
2307
|
+
# account unless an IAM user or role explicitly overrides these
|
2308
|
+
# settings. If this field is omitted, the setting is changed only for
|
2309
|
+
# the authenticated user.
|
2286
2310
|
# @return [String]
|
2287
2311
|
#
|
2288
2312
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteAccountSettingRequest AWS API Documentation
|
@@ -2657,7 +2681,7 @@ module Aws::ECS
|
|
2657
2681
|
#
|
2658
2682
|
#
|
2659
2683
|
#
|
2660
|
-
# [1]:
|
2684
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html
|
2661
2685
|
#
|
2662
2686
|
# @note When making an API call, you may pass DeploymentController
|
2663
2687
|
# data as a hash:
|
@@ -2722,8 +2746,7 @@ module Aws::ECS
|
|
2722
2746
|
# by the Region of the container instance, the AWS account ID of the
|
2723
2747
|
# container instance owner, the `container-instance` namespace, and
|
2724
2748
|
# then the container instance ID. For example,
|
2725
|
-
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
|
2726
|
-
# `.
|
2749
|
+
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
2727
2750
|
# @return [String]
|
2728
2751
|
#
|
2729
2752
|
# @!attribute [rw] force
|
@@ -2864,7 +2887,10 @@ module Aws::ECS
|
|
2864
2887
|
# @!attribute [rw] cluster
|
2865
2888
|
# The short name or full Amazon Resource Name (ARN) of the cluster
|
2866
2889
|
# that hosts the container instances to describe. If you do not
|
2867
|
-
# specify a cluster, the default cluster is assumed.
|
2890
|
+
# specify a cluster, the default cluster is assumed. This parameter is
|
2891
|
+
# required if the container instance or container instances you are
|
2892
|
+
# describing were launched in any cluster other than the default
|
2893
|
+
# cluster.
|
2868
2894
|
# @return [String]
|
2869
2895
|
#
|
2870
2896
|
# @!attribute [rw] container_instances
|
@@ -2916,7 +2942,9 @@ module Aws::ECS
|
|
2916
2942
|
# @!attribute [rw] cluster
|
2917
2943
|
# The short name or full Amazon Resource Name (ARN)the cluster that
|
2918
2944
|
# hosts the service to describe. If you do not specify a cluster, the
|
2919
|
-
# default cluster is assumed.
|
2945
|
+
# default cluster is assumed. This parameter is required if the
|
2946
|
+
# service or services you are describing were launched in any cluster
|
2947
|
+
# other than the default cluster.
|
2920
2948
|
# @return [String]
|
2921
2949
|
#
|
2922
2950
|
# @!attribute [rw] services
|
@@ -3063,8 +3091,10 @@ module Aws::ECS
|
|
3063
3091
|
#
|
3064
3092
|
# @!attribute [rw] cluster
|
3065
3093
|
# The short name or full Amazon Resource Name (ARN) of the cluster
|
3066
|
-
# that hosts the task to describe. If you do not specify a
|
3067
|
-
# the default cluster is assumed.
|
3094
|
+
# that hosts the task or tasks to describe. If you do not specify a
|
3095
|
+
# cluster, the default cluster is assumed. This parameter is required
|
3096
|
+
# if the task or tasks you are describing were launched in any cluster
|
3097
|
+
# other than the default cluster.
|
3068
3098
|
# @return [String]
|
3069
3099
|
#
|
3070
3100
|
# @!attribute [rw] tasks
|
@@ -3150,8 +3180,7 @@ module Aws::ECS
|
|
3150
3180
|
# the container instance, the AWS account ID of the container instance
|
3151
3181
|
# owner, the `container-instance` namespace, and then the container
|
3152
3182
|
# instance ID. For example,
|
3153
|
-
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
|
3154
|
-
# `.
|
3183
|
+
# `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID`.
|
3155
3184
|
# @return [String]
|
3156
3185
|
#
|
3157
3186
|
# @!attribute [rw] cluster
|
@@ -3229,8 +3258,8 @@ module Aws::ECS
|
|
3229
3258
|
# method, use Docker plugin discovery to retrieve the driver name. For
|
3230
3259
|
# more information, see [Docker plugin discovery][1]. This parameter
|
3231
3260
|
# maps to `Driver` in the [Create a volume][2] section of the [Docker
|
3232
|
-
# Remote API][3] and the `xxdriver` option to [
|
3233
|
-
# ][4].
|
3261
|
+
# Remote API][3] and the `xxdriver` option to [docker volume
|
3262
|
+
# create][4].
|
3234
3263
|
#
|
3235
3264
|
#
|
3236
3265
|
#
|
@@ -3243,8 +3272,8 @@ module Aws::ECS
|
|
3243
3272
|
# @!attribute [rw] driver_opts
|
3244
3273
|
# A map of Docker driver-specific options passed through. This
|
3245
3274
|
# parameter maps to `DriverOpts` in the [Create a volume][1] section
|
3246
|
-
# of the [Docker Remote API][2] and the `xxopt` option to [
|
3247
|
-
# volume create
|
3275
|
+
# of the [Docker Remote API][2] and the `xxopt` option to [docker
|
3276
|
+
# volume create][3].
|
3248
3277
|
#
|
3249
3278
|
#
|
3250
3279
|
#
|
@@ -3256,7 +3285,7 @@ module Aws::ECS
|
|
3256
3285
|
# @!attribute [rw] labels
|
3257
3286
|
# Custom metadata to add to your Docker volume. This parameter maps to
|
3258
3287
|
# `Labels` in the [Create a volume][1] section of the [Docker Remote
|
3259
|
-
# API][2] and the `xxlabel` option to [
|
3288
|
+
# API][2] and the `xxlabel` option to [docker volume create][3].
|
3260
3289
|
#
|
3261
3290
|
#
|
3262
3291
|
#
|
@@ -3669,7 +3698,7 @@ module Aws::ECS
|
|
3669
3698
|
# data as a hash:
|
3670
3699
|
#
|
3671
3700
|
# {
|
3672
|
-
# name: "serviceLongArnFormat", # accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat
|
3701
|
+
# name: "serviceLongArnFormat", # accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat, awsvpcTrunking
|
3673
3702
|
# value: "String",
|
3674
3703
|
# principal_arn: "String",
|
3675
3704
|
# effective_settings: false,
|
@@ -3695,9 +3724,9 @@ module Aws::ECS
|
|
3695
3724
|
# @!attribute [rw] effective_settings
|
3696
3725
|
# Specifies whether to return the effective settings. If `true`, the
|
3697
3726
|
# account settings for the root user or the default setting for the
|
3698
|
-
# `principalArn
|
3699
|
-
# `principalArn` are returned if they are set. Otherwise, no
|
3700
|
-
# settings are returned.
|
3727
|
+
# `principalArn` are returned. If `false`, the account settings for
|
3728
|
+
# the `principalArn` are returned if they are set. Otherwise, no
|
3729
|
+
# account settings are returned.
|
3701
3730
|
# @return [Boolean]
|
3702
3731
|
#
|
3703
3732
|
# @!attribute [rw] next_token
|
@@ -3913,7 +3942,7 @@ module Aws::ECS
|
|
3913
3942
|
# filter: "String",
|
3914
3943
|
# next_token: "String",
|
3915
3944
|
# max_results: 1,
|
3916
|
-
# status: "ACTIVE", # accepts ACTIVE, DRAINING
|
3945
|
+
# status: "ACTIVE", # accepts ACTIVE, DRAINING, REGISTERING, DEREGISTERING, REGISTRATION_FAILED
|
3917
3946
|
# }
|
3918
3947
|
#
|
3919
3948
|
# @!attribute [rw] cluster
|
@@ -3964,8 +3993,8 @@ module Aws::ECS
|
|
3964
3993
|
# specify the `DRAINING` status, the results include only container
|
3965
3994
|
# instances that have been set to `DRAINING` using
|
3966
3995
|
# UpdateContainerInstancesState. If you do not specify this parameter,
|
3967
|
-
# the default is to include container instances set to
|
3968
|
-
# `
|
3996
|
+
# the default is to include container instances set to all states
|
3997
|
+
# other than `INACTIVE`.
|
3969
3998
|
# @return [String]
|
3970
3999
|
#
|
3971
4000
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListContainerInstancesRequest AWS API Documentation
|
@@ -4418,7 +4447,7 @@ module Aws::ECS
|
|
4418
4447
|
include Aws::Structure
|
4419
4448
|
end
|
4420
4449
|
|
4421
|
-
# Details on a load balancer
|
4450
|
+
# Details on a load balancer to be used with a service or task set.
|
4422
4451
|
#
|
4423
4452
|
# If the service is using the `ECS` deployment controller, you are
|
4424
4453
|
# limited to one load balancer or target group.
|
@@ -4453,10 +4482,16 @@ module Aws::ECS
|
|
4453
4482
|
#
|
4454
4483
|
# @!attribute [rw] target_group_arn
|
4455
4484
|
# The full Amazon Resource Name (ARN) of the Elastic Load Balancing
|
4456
|
-
# target group or groups associated with a service
|
4457
|
-
#
|
4458
|
-
# group
|
4459
|
-
#
|
4485
|
+
# target group or groups associated with a service or task set.
|
4486
|
+
#
|
4487
|
+
# A target group ARN is only specified when using an application load
|
4488
|
+
# balancer or a network load balancer. If you are using a classic load
|
4489
|
+
# balancer this should be omitted.
|
4490
|
+
#
|
4491
|
+
# For services using the `ECS` deployment controller, you are limited
|
4492
|
+
# to one target group. For services using the `CODE_DEPLOY` deployment
|
4493
|
+
# controller, you are required to define two target groups for the
|
4494
|
+
# load balancer.
|
4460
4495
|
#
|
4461
4496
|
# If your service's task definition uses the `awsvpc` network mode
|
4462
4497
|
# (which is required for the Fargate launch type), you must choose
|
@@ -4466,7 +4501,12 @@ module Aws::ECS
|
|
4466
4501
|
# @return [String]
|
4467
4502
|
#
|
4468
4503
|
# @!attribute [rw] load_balancer_name
|
4469
|
-
# The name of
|
4504
|
+
# The name of the load balancer to associate with the Amazon ECS
|
4505
|
+
# service or task set.
|
4506
|
+
#
|
4507
|
+
# A load balancer name is only specified when using a classic load
|
4508
|
+
# balancer. If you are using an application load balancer or a network
|
4509
|
+
# load balancer this should be omitted.
|
4470
4510
|
# @return [String]
|
4471
4511
|
#
|
4472
4512
|
# @!attribute [rw] container_name
|
@@ -4858,6 +4898,9 @@ module Aws::ECS
|
|
4858
4898
|
# more information, see `hostPort`. Port mappings that are
|
4859
4899
|
# automatically assigned in this way do not count toward the 100
|
4860
4900
|
# reserved ports limit of a container instance.
|
4901
|
+
#
|
4902
|
+
# You cannot expose the same container port for multiple protocols. An
|
4903
|
+
# error will be returned if this is attempted.
|
4861
4904
|
# @return [Integer]
|
4862
4905
|
#
|
4863
4906
|
# @!attribute [rw] host_port
|
@@ -4925,13 +4968,12 @@ module Aws::ECS
|
|
4925
4968
|
# see [Amazon ECS-optimized Linux AMI][1] in the *Amazon Elastic
|
4926
4969
|
# Container Service Developer Guide*.
|
4927
4970
|
#
|
4928
|
-
#
|
4929
|
-
# the Ohio (us-east-2) region only and the task or service requires
|
4971
|
+
# For tasks using the Fargate launch type, the task or service requires
|
4930
4972
|
# platform version 1.3.0 or later.
|
4931
4973
|
#
|
4932
4974
|
#
|
4933
4975
|
#
|
4934
|
-
# [1]:
|
4976
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html
|
4935
4977
|
#
|
4936
4978
|
# @note When making an API call, you may pass ProxyConfiguration
|
4937
4979
|
# data as a hash:
|
@@ -4967,7 +5009,7 @@ module Aws::ECS
|
|
4967
5009
|
# * `IgnoredGID` - (Required) The group ID (GID) of the proxy
|
4968
5010
|
# container as defined by the `user` parameter in a container
|
4969
5011
|
# definition. This is used to ensure the proxy ignores its own
|
4970
|
-
# traffic. If `
|
5012
|
+
# traffic. If `IgnoredUID` is specified, this field can be empty.
|
4971
5013
|
#
|
4972
5014
|
# * `AppPorts` - (Required) The list of ports that the application
|
4973
5015
|
# uses. Network traffic to these ports is forwarded to the
|
@@ -5001,17 +5043,19 @@ module Aws::ECS
|
|
5001
5043
|
# data as a hash:
|
5002
5044
|
#
|
5003
5045
|
# {
|
5004
|
-
# name: "serviceLongArnFormat", # required, accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat
|
5046
|
+
# name: "serviceLongArnFormat", # required, accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat, awsvpcTrunking
|
5005
5047
|
# value: "String", # required
|
5006
5048
|
# }
|
5007
5049
|
#
|
5008
5050
|
# @!attribute [rw] name
|
5009
|
-
# The resource
|
5051
|
+
# The resource name for which to modify the account setting. If
|
5010
5052
|
# `serviceLongArnFormat` is specified, the ARN for your Amazon ECS
|
5011
5053
|
# services is affected. If `taskLongArnFormat` is specified, the ARN
|
5012
|
-
# and resource ID for your Amazon ECS tasks
|
5054
|
+
# and resource ID for your Amazon ECS tasks is affected. If
|
5013
5055
|
# `containerInstanceLongArnFormat` is specified, the ARN and resource
|
5014
|
-
# ID for your Amazon ECS container instances
|
5056
|
+
# ID for your Amazon ECS container instances is affected. If
|
5057
|
+
# `awsvpcTrunking` is specified, the ENI limit for your Amazon ECS
|
5058
|
+
# container instances is affected.
|
5015
5059
|
# @return [String]
|
5016
5060
|
#
|
5017
5061
|
# @!attribute [rw] value
|
@@ -5042,18 +5086,20 @@ module Aws::ECS
|
|
5042
5086
|
# data as a hash:
|
5043
5087
|
#
|
5044
5088
|
# {
|
5045
|
-
# name: "serviceLongArnFormat", # required, accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat
|
5089
|
+
# name: "serviceLongArnFormat", # required, accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat, awsvpcTrunking
|
5046
5090
|
# value: "String", # required
|
5047
5091
|
# principal_arn: "String",
|
5048
5092
|
# }
|
5049
5093
|
#
|
5050
5094
|
# @!attribute [rw] name
|
5051
|
-
# The resource name for which to
|
5095
|
+
# The resource name for which to modify the account setting. If
|
5052
5096
|
# `serviceLongArnFormat` is specified, the ARN for your Amazon ECS
|
5053
5097
|
# services is affected. If `taskLongArnFormat` is specified, the ARN
|
5054
5098
|
# and resource ID for your Amazon ECS tasks is affected. If
|
5055
5099
|
# `containerInstanceLongArnFormat` is specified, the ARN and resource
|
5056
|
-
# ID for your Amazon ECS container instances is affected.
|
5100
|
+
# ID for your Amazon ECS container instances is affected. If
|
5101
|
+
# `awsvpcTrunking` is specified, the ENI limit for your Amazon ECS
|
5102
|
+
# container instances is affected.
|
5057
5103
|
# @return [String]
|
5058
5104
|
#
|
5059
5105
|
# @!attribute [rw] value
|
@@ -5063,11 +5109,11 @@ module Aws::ECS
|
|
5063
5109
|
#
|
5064
5110
|
# @!attribute [rw] principal_arn
|
5065
5111
|
# The ARN of the principal, which can be an IAM user, IAM role, or the
|
5066
|
-
# root user. If you specify the root user, it modifies the
|
5067
|
-
#
|
5068
|
-
#
|
5069
|
-
# settings
|
5070
|
-
#
|
5112
|
+
# root user. If you specify the root user, it modifies the account
|
5113
|
+
# setting for all IAM users, IAM roles, and the root user of the
|
5114
|
+
# account unless an IAM user or role explicitly overrides these
|
5115
|
+
# settings. If this field is omitted, the setting is changed only for
|
5116
|
+
# the authenticated user.
|
5071
5117
|
# @return [String]
|
5072
5118
|
#
|
5073
5119
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutAccountSettingRequest AWS API Documentation
|
@@ -5454,8 +5500,7 @@ module Aws::ECS
|
|
5454
5500
|
# You must specify a `family` for a task definition, which allows you
|
5455
5501
|
# to track multiple versions of the same task definition. The `family`
|
5456
5502
|
# is used as a name for your task definition. Up to 255 letters
|
5457
|
-
# (uppercase and lowercase), numbers,
|
5458
|
-
# allowed.
|
5503
|
+
# (uppercase and lowercase), numbers, and hyphens are allowed.
|
5459
5504
|
# @return [String]
|
5460
5505
|
#
|
5461
5506
|
# @!attribute [rw] task_role_arn
|
@@ -5521,7 +5566,7 @@ module Aws::ECS
|
|
5521
5566
|
#
|
5522
5567
|
#
|
5523
5568
|
#
|
5524
|
-
# [1]:
|
5569
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
5525
5570
|
# [2]: https://docs.docker.com/engine/reference/run/#network-settings
|
5526
5571
|
# @return [String]
|
5527
5572
|
#
|
@@ -5692,7 +5737,7 @@ module Aws::ECS
|
|
5692
5737
|
#
|
5693
5738
|
# [1]: https://docs.docker.com/engine/reference/run/#ipc-settings---ipc
|
5694
5739
|
# [2]: https://docs.docker.com/engine/security/security/
|
5695
|
-
# [3]:
|
5740
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html
|
5696
5741
|
# @return [String]
|
5697
5742
|
#
|
5698
5743
|
# @!attribute [rw] proxy_configuration
|
@@ -5707,13 +5752,12 @@ module Aws::ECS
|
|
5707
5752
|
# information, see [Amazon ECS-optimized Linux AMI][1] in the *Amazon
|
5708
5753
|
# Elastic Container Service Developer Guide*.
|
5709
5754
|
#
|
5710
|
-
#
|
5711
|
-
#
|
5712
|
-
# platform version 1.3.0 or later.
|
5755
|
+
# For tasks using the Fargate launch type, the task or service
|
5756
|
+
# requires platform version 1.3.0 or later.
|
5713
5757
|
#
|
5714
5758
|
#
|
5715
5759
|
#
|
5716
|
-
# [1]:
|
5760
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html
|
5717
5761
|
# @return [Types::ProxyConfiguration]
|
5718
5762
|
#
|
5719
5763
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterTaskDefinitionRequest AWS API Documentation
|
@@ -5844,7 +5888,7 @@ module Aws::ECS
|
|
5844
5888
|
#
|
5845
5889
|
#
|
5846
5890
|
#
|
5847
|
-
# [1]:
|
5891
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html
|
5848
5892
|
#
|
5849
5893
|
# @note When making an API call, you may pass ResourceRequirement
|
5850
5894
|
# data as a hash:
|
@@ -6033,7 +6077,7 @@ module Aws::ECS
|
|
6033
6077
|
#
|
6034
6078
|
#
|
6035
6079
|
#
|
6036
|
-
# [1]:
|
6080
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
6037
6081
|
# @return [Types::NetworkConfiguration]
|
6038
6082
|
#
|
6039
6083
|
# @!attribute [rw] tags
|
@@ -6051,7 +6095,7 @@ module Aws::ECS
|
|
6051
6095
|
#
|
6052
6096
|
#
|
6053
6097
|
#
|
6054
|
-
# [1]:
|
6098
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
6055
6099
|
# @return [Boolean]
|
6056
6100
|
#
|
6057
6101
|
# @!attribute [rw] propagate_tags
|
@@ -6146,7 +6190,7 @@ module Aws::ECS
|
|
6146
6190
|
#
|
6147
6191
|
#
|
6148
6192
|
#
|
6149
|
-
# [1]:
|
6193
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html
|
6150
6194
|
#
|
6151
6195
|
# @note When making an API call, you may pass Secret
|
6152
6196
|
# data as a hash:
|
@@ -6200,15 +6244,14 @@ module Aws::ECS
|
|
6200
6244
|
# `arn:aws:ecs` namespace, followed by the Region of the service, the
|
6201
6245
|
# AWS account ID of the service owner, the `service` namespace, and
|
6202
6246
|
# then the service name. For example,
|
6203
|
-
# `arn:aws:ecs:region:012345678910:service/my-service
|
6247
|
+
# `arn:aws:ecs:region:012345678910:service/my-service`.
|
6204
6248
|
# @return [String]
|
6205
6249
|
#
|
6206
6250
|
# @!attribute [rw] service_name
|
6207
6251
|
# The name of your service. Up to 255 letters (uppercase and
|
6208
|
-
# lowercase), numbers,
|
6209
|
-
#
|
6210
|
-
#
|
6211
|
-
# multiple Regions.
|
6252
|
+
# lowercase), numbers, and hyphens are allowed. Service names must be
|
6253
|
+
# unique within a cluster, but you can have similarly named services
|
6254
|
+
# in multiple clusters within a Region or across multiple Regions.
|
6212
6255
|
# @return [String]
|
6213
6256
|
#
|
6214
6257
|
# @!attribute [rw] cluster_arn
|
@@ -6237,7 +6280,7 @@ module Aws::ECS
|
|
6237
6280
|
#
|
6238
6281
|
#
|
6239
6282
|
#
|
6240
|
-
# [1]:
|
6283
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html
|
6241
6284
|
# @return [Array<Types::ServiceRegistry>]
|
6242
6285
|
#
|
6243
6286
|
# @!attribute [rw] status
|
@@ -6261,9 +6304,10 @@ module Aws::ECS
|
|
6261
6304
|
# @return [Integer]
|
6262
6305
|
#
|
6263
6306
|
# @!attribute [rw] launch_type
|
6264
|
-
# The launch type on which your service is running.
|
6265
|
-
#
|
6266
|
-
#
|
6307
|
+
# The launch type on which your service is running. If no value is
|
6308
|
+
# specified, it will default to `EC2`. Valid values include `EC2` and
|
6309
|
+
# `FARGATE`. For more information, see [Amazon ECS Launch Types][1] in
|
6310
|
+
# the *Amazon Elastic Container Service Developer Guide*.
|
6267
6311
|
#
|
6268
6312
|
#
|
6269
6313
|
#
|
@@ -6271,10 +6315,10 @@ module Aws::ECS
|
|
6271
6315
|
# @return [String]
|
6272
6316
|
#
|
6273
6317
|
# @!attribute [rw] platform_version
|
6274
|
-
# The platform version on which
|
6275
|
-
#
|
6276
|
-
#
|
6277
|
-
#
|
6318
|
+
# The platform version on which to run your service. A platform
|
6319
|
+
# version is only specified for tasks using the Fargate launch type.
|
6320
|
+
# If one is not specified, the `LATEST` platform version is used by
|
6321
|
+
# default. For more information, see [AWS Fargate Platform
|
6278
6322
|
# Versions][1] in the *Amazon Elastic Container Service Developer
|
6279
6323
|
# Guide*.
|
6280
6324
|
#
|
@@ -6365,7 +6409,7 @@ module Aws::ECS
|
|
6365
6409
|
#
|
6366
6410
|
#
|
6367
6411
|
#
|
6368
|
-
# [1]:
|
6412
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html
|
6369
6413
|
# @return [String]
|
6370
6414
|
#
|
6371
6415
|
# @!attribute [rw] deployment_controller
|
@@ -6392,7 +6436,7 @@ module Aws::ECS
|
|
6392
6436
|
#
|
6393
6437
|
#
|
6394
6438
|
#
|
6395
|
-
# [1]:
|
6439
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
6396
6440
|
# @return [Boolean]
|
6397
6441
|
#
|
6398
6442
|
# @!attribute [rw] propagate_tags
|
@@ -6672,7 +6716,7 @@ module Aws::ECS
|
|
6672
6716
|
#
|
6673
6717
|
#
|
6674
6718
|
#
|
6675
|
-
# [1]:
|
6719
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
6676
6720
|
# @return [Boolean]
|
6677
6721
|
#
|
6678
6722
|
# @!attribute [rw] propagate_tags
|
@@ -6761,6 +6805,47 @@ module Aws::ECS
|
|
6761
6805
|
include Aws::Structure
|
6762
6806
|
end
|
6763
6807
|
|
6808
|
+
# @note When making an API call, you may pass SubmitAttachmentStateChangesRequest
|
6809
|
+
# data as a hash:
|
6810
|
+
#
|
6811
|
+
# {
|
6812
|
+
# cluster: "String",
|
6813
|
+
# attachments: [ # required
|
6814
|
+
# {
|
6815
|
+
# attachment_arn: "String", # required
|
6816
|
+
# status: "String", # required
|
6817
|
+
# },
|
6818
|
+
# ],
|
6819
|
+
# }
|
6820
|
+
#
|
6821
|
+
# @!attribute [rw] cluster
|
6822
|
+
# The short name or full ARN of the cluster that hosts the container
|
6823
|
+
# instance the attachment belongs to.
|
6824
|
+
# @return [String]
|
6825
|
+
#
|
6826
|
+
# @!attribute [rw] attachments
|
6827
|
+
# Any attachments associated with the state change request.
|
6828
|
+
# @return [Array<Types::AttachmentStateChange>]
|
6829
|
+
#
|
6830
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitAttachmentStateChangesRequest AWS API Documentation
|
6831
|
+
#
|
6832
|
+
class SubmitAttachmentStateChangesRequest < Struct.new(
|
6833
|
+
:cluster,
|
6834
|
+
:attachments)
|
6835
|
+
include Aws::Structure
|
6836
|
+
end
|
6837
|
+
|
6838
|
+
# @!attribute [rw] acknowledgment
|
6839
|
+
# Acknowledgement of the state change.
|
6840
|
+
# @return [String]
|
6841
|
+
#
|
6842
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitAttachmentStateChangesResponse AWS API Documentation
|
6843
|
+
#
|
6844
|
+
class SubmitAttachmentStateChangesResponse < Struct.new(
|
6845
|
+
:acknowledgment)
|
6846
|
+
include Aws::Structure
|
6847
|
+
end
|
6848
|
+
|
6764
6849
|
# @note When making an API call, you may pass SubmitContainerStateChangeRequest
|
6765
6850
|
# data as a hash:
|
6766
6851
|
#
|
@@ -7083,7 +7168,7 @@ module Aws::ECS
|
|
7083
7168
|
#
|
7084
7169
|
#
|
7085
7170
|
#
|
7086
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
7171
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html
|
7087
7172
|
# @return [String]
|
7088
7173
|
#
|
7089
7174
|
# @!attribute [rw] desired_status
|
@@ -7092,7 +7177,7 @@ module Aws::ECS
|
|
7092
7177
|
#
|
7093
7178
|
#
|
7094
7179
|
#
|
7095
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
7180
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html
|
7096
7181
|
# @return [String]
|
7097
7182
|
#
|
7098
7183
|
# @!attribute [rw] cpu
|
@@ -7320,7 +7405,11 @@ module Aws::ECS
|
|
7320
7405
|
include Aws::Structure
|
7321
7406
|
end
|
7322
7407
|
|
7323
|
-
#
|
7408
|
+
# The details of a task definition which describes the container and
|
7409
|
+
# volume definitions of an Amazon Elastic Container Service task. You
|
7410
|
+
# can specify which Docker images to use, the required resources, and
|
7411
|
+
# other configurations related to launching the task definition through
|
7412
|
+
# an Amazon ECS service or task.
|
7324
7413
|
#
|
7325
7414
|
# @!attribute [rw] task_definition_arn
|
7326
7415
|
# The full Amazon Resource Name (ARN) of the task definition.
|
@@ -7339,29 +7428,37 @@ module Aws::ECS
|
|
7339
7428
|
# @return [Array<Types::ContainerDefinition>]
|
7340
7429
|
#
|
7341
7430
|
# @!attribute [rw] family
|
7342
|
-
# The
|
7431
|
+
# The name of a family that this task definition is registered to. A
|
7432
|
+
# family groups multiple versions of a task definition. Amazon ECS
|
7433
|
+
# gives the first task definition that you registered to a family a
|
7434
|
+
# revision number of 1. Amazon ECS gives sequential revision numbers
|
7435
|
+
# to each task definition that you add.
|
7343
7436
|
# @return [String]
|
7344
7437
|
#
|
7345
7438
|
# @!attribute [rw] task_role_arn
|
7346
|
-
# The
|
7347
|
-
#
|
7348
|
-
#
|
7439
|
+
# The Amazon Resource Name (ARN) of an AWS Identity and Access
|
7440
|
+
# Management (IAM) role that grants containers in the task permission
|
7441
|
+
# to call AWS APIs on your behalf. For more information, see [Amazon
|
7442
|
+
# ECS Task Role][1] in the *Amazon Elastic Container Service Developer
|
7443
|
+
# Guide*.
|
7349
7444
|
#
|
7350
7445
|
# IAM roles for tasks on Windows require that the `-EnableTaskIAMRole`
|
7351
7446
|
# option is set when you launch the Amazon ECS-optimized Windows AMI.
|
7352
7447
|
# Your containers must also run some configuration code in order to
|
7353
7448
|
# take advantage of the feature. For more information, see [Windows
|
7354
|
-
# IAM Roles for Tasks][
|
7449
|
+
# IAM Roles for Tasks][2] in the *Amazon Elastic Container Service
|
7355
7450
|
# Developer Guide*.
|
7356
7451
|
#
|
7357
7452
|
#
|
7358
7453
|
#
|
7359
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
7454
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_IAM_role.html
|
7455
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html
|
7360
7456
|
# @return [String]
|
7361
7457
|
#
|
7362
7458
|
# @!attribute [rw] execution_role_arn
|
7363
|
-
# The Amazon Resource Name (ARN) of the task execution role that
|
7364
|
-
#
|
7459
|
+
# The Amazon Resource Name (ARN) of the task execution role that
|
7460
|
+
# containers in this task can assume. All containers in this task are
|
7461
|
+
# granted the permissions that are specified in this role.
|
7365
7462
|
# @return [String]
|
7366
7463
|
#
|
7367
7464
|
# @!attribute [rw] network_mode
|
@@ -7410,7 +7507,7 @@ module Aws::ECS
|
|
7410
7507
|
#
|
7411
7508
|
#
|
7412
7509
|
#
|
7413
|
-
# [1]:
|
7510
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
7414
7511
|
# [2]: https://docs.docker.com/engine/reference/run/#network-settings
|
7415
7512
|
# @return [String]
|
7416
7513
|
#
|
@@ -7424,9 +7521,9 @@ module Aws::ECS
|
|
7424
7521
|
# @return [Integer]
|
7425
7522
|
#
|
7426
7523
|
# @!attribute [rw] volumes
|
7427
|
-
# The list of
|
7524
|
+
# The list of volume definitions for the task.
|
7428
7525
|
#
|
7429
|
-
# If
|
7526
|
+
# If your tasks are using the Fargate launch type, the `host` and
|
7430
7527
|
# `sourcePath` parameters are not supported.
|
7431
7528
|
#
|
7432
7529
|
# For more information about volume definition parameters and
|
@@ -7464,7 +7561,8 @@ module Aws::ECS
|
|
7464
7561
|
# @return [Array<String>]
|
7465
7562
|
#
|
7466
7563
|
# @!attribute [rw] requires_compatibilities
|
7467
|
-
# The launch type
|
7564
|
+
# The launch type the task requires. If no value is specified, it will
|
7565
|
+
# default to `EC2`. Valid values include `EC2` and `FARGATE`.
|
7468
7566
|
# @return [Array<String>]
|
7469
7567
|
#
|
7470
7568
|
# @!attribute [rw] cpu
|
@@ -7578,7 +7676,7 @@ module Aws::ECS
|
|
7578
7676
|
#
|
7579
7677
|
# [1]: https://docs.docker.com/engine/reference/run/#ipc-settings---ipc
|
7580
7678
|
# [2]: https://docs.docker.com/engine/security/security/
|
7581
|
-
# [3]:
|
7679
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html
|
7582
7680
|
# @return [String]
|
7583
7681
|
#
|
7584
7682
|
# @!attribute [rw] proxy_configuration
|
@@ -7595,7 +7693,7 @@ module Aws::ECS
|
|
7595
7693
|
#
|
7596
7694
|
#
|
7597
7695
|
#
|
7598
|
-
# [1]:
|
7696
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html
|
7599
7697
|
# @return [Types::ProxyConfiguration]
|
7600
7698
|
#
|
7601
7699
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TaskDefinition AWS API Documentation
|
@@ -7853,7 +7951,7 @@ module Aws::ECS
|
|
7853
7951
|
#
|
7854
7952
|
#
|
7855
7953
|
#
|
7856
|
-
# [1]:
|
7954
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html
|
7857
7955
|
# @return [Array<Types::ServiceRegistry>]
|
7858
7956
|
#
|
7859
7957
|
# @!attribute [rw] scale
|
@@ -7876,6 +7974,13 @@ module Aws::ECS
|
|
7876
7974
|
# * All tasks are reporting a healthy status from the load balancers,
|
7877
7975
|
# service discovery, and container health checks.
|
7878
7976
|
#
|
7977
|
+
# <note markdown="1"> If a `healthCheckGracePeriodSeconds` value was set when the
|
7978
|
+
# service was created, you may see a `STEADY_STATE` reached since
|
7979
|
+
# unhealthy Elastic Load Balancing target health checks will be
|
7980
|
+
# ignored until it expires.
|
7981
|
+
#
|
7982
|
+
# </note>
|
7983
|
+
#
|
7879
7984
|
# If any of those conditions are not met, the stability status returns
|
7880
7985
|
# `STABILIZING`.
|
7881
7986
|
# @return [String]
|
@@ -8059,7 +8164,7 @@ module Aws::ECS
|
|
8059
8164
|
# {
|
8060
8165
|
# cluster: "String",
|
8061
8166
|
# container_instances: ["String"], # required
|
8062
|
-
# status: "ACTIVE", # required, accepts ACTIVE, DRAINING
|
8167
|
+
# status: "ACTIVE", # required, accepts ACTIVE, DRAINING, REGISTERING, DEREGISTERING, REGISTRATION_FAILED
|
8063
8168
|
# }
|
8064
8169
|
#
|
8065
8170
|
# @!attribute [rw] cluster
|
@@ -8074,7 +8179,12 @@ module Aws::ECS
|
|
8074
8179
|
#
|
8075
8180
|
# @!attribute [rw] status
|
8076
8181
|
# The container instance state with which to update the container
|
8077
|
-
# instance.
|
8182
|
+
# instance. The only valid values for this action are `ACTIVE` and
|
8183
|
+
# `DRAINING`. A container instance can only be updated to `DRAINING`
|
8184
|
+
# status once it has reached an `ACTIVE` state. If a container
|
8185
|
+
# instance is in `REGISTERING`, `DEREGISTERING`, or
|
8186
|
+
# `REGISTRATION_FAILED` state you can describe the container instance
|
8187
|
+
# but will be unable to update the container instance state.
|
8078
8188
|
# @return [String]
|
8079
8189
|
#
|
8080
8190
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerInstancesStateRequest AWS API Documentation
|
@@ -8221,7 +8331,7 @@ module Aws::ECS
|
|
8221
8331
|
#
|
8222
8332
|
#
|
8223
8333
|
#
|
8224
|
-
# [1]:
|
8334
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
8225
8335
|
# @return [Types::NetworkConfiguration]
|
8226
8336
|
#
|
8227
8337
|
# @!attribute [rw] platform_version
|
@@ -8387,7 +8497,7 @@ module Aws::ECS
|
|
8387
8497
|
#
|
8388
8498
|
#
|
8389
8499
|
#
|
8390
|
-
# [1]:
|
8500
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html
|
8391
8501
|
#
|
8392
8502
|
# @note When making an API call, you may pass Volume
|
8393
8503
|
# data as a hash:
|
@@ -8412,9 +8522,8 @@ module Aws::ECS
|
|
8412
8522
|
#
|
8413
8523
|
# @!attribute [rw] name
|
8414
8524
|
# The name of the volume. Up to 255 letters (uppercase and lowercase),
|
8415
|
-
# numbers,
|
8416
|
-
#
|
8417
|
-
# `mountPoints`.
|
8525
|
+
# numbers, and hyphens are allowed. This name is referenced in the
|
8526
|
+
# `sourceVolume` parameter of container definition `mountPoints`.
|
8418
8527
|
# @return [String]
|
8419
8528
|
#
|
8420
8529
|
# @!attribute [rw] host
|