aws-sdk-ecs 1.162.0 → 1.173.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +55 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ecs/client.rb +499 -81
- data/lib/aws-sdk-ecs/client_api.rb +205 -1
- data/lib/aws-sdk-ecs/endpoint_parameters.rb +9 -6
- data/lib/aws-sdk-ecs/endpoints.rb +2 -614
- data/lib/aws-sdk-ecs/plugins/endpoints.rb +1 -118
- data/lib/aws-sdk-ecs/types.rb +1026 -132
- data/lib/aws-sdk-ecs.rb +1 -1
- data/sig/client.rbs +68 -9
- data/sig/types.rbs +154 -3
- metadata +4 -4
data/lib/aws-sdk-ecs/client.rb
CHANGED
@@ -972,6 +972,18 @@ module Aws::ECS
|
|
972
972
|
#
|
973
973
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html
|
974
974
|
#
|
975
|
+
# @option params [String] :availability_zone_rebalancing
|
976
|
+
# Indicates whether to use Availability Zone rebalancing for the
|
977
|
+
# service.
|
978
|
+
#
|
979
|
+
# For more information, see [Balancing an Amazon ECS service across
|
980
|
+
# Availability Zones][1] in the *Amazon Elastic Container Service
|
981
|
+
# Developer Guide*.
|
982
|
+
#
|
983
|
+
#
|
984
|
+
#
|
985
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html
|
986
|
+
#
|
975
987
|
# @option params [Array<Types::LoadBalancer>] :load_balancers
|
976
988
|
# A load balancer object representing the load balancers to use with
|
977
989
|
# your service. For more information, see [Service load balancing][1] in
|
@@ -1093,7 +1105,7 @@ module Aws::ECS
|
|
1093
1105
|
# `launchType` is specified, the `defaultCapacityProviderStrategy` for
|
1094
1106
|
# the cluster is used.
|
1095
1107
|
#
|
1096
|
-
# A capacity provider strategy
|
1108
|
+
# A capacity provider strategy can contain a maximum of 20 capacity
|
1097
1109
|
# providers.
|
1098
1110
|
#
|
1099
1111
|
# @option params [String] :platform_version
|
@@ -1164,26 +1176,18 @@ module Aws::ECS
|
|
1164
1176
|
#
|
1165
1177
|
# @option params [Integer] :health_check_grace_period_seconds
|
1166
1178
|
# The period of time, in seconds, that the Amazon ECS service scheduler
|
1167
|
-
# ignores unhealthy Elastic Load Balancing
|
1168
|
-
# task has first started.
|
1169
|
-
#
|
1170
|
-
#
|
1171
|
-
#
|
1172
|
-
#
|
1173
|
-
# If
|
1174
|
-
#
|
1175
|
-
#
|
1176
|
-
#
|
1177
|
-
#
|
1178
|
-
#
|
1179
|
-
# period of up to 2,147,483,647 seconds (about 69 years). During that
|
1180
|
-
# time, the Amazon ECS service scheduler ignores health check status.
|
1181
|
-
# This grace period can prevent the service scheduler from marking tasks
|
1182
|
-
# as unhealthy and stopping them before they have time to come up.
|
1183
|
-
#
|
1184
|
-
#
|
1185
|
-
#
|
1186
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html
|
1179
|
+
# ignores unhealthy Elastic Load Balancing, VPC Lattice, and container
|
1180
|
+
# health checks after a task has first started. If you don't specify a
|
1181
|
+
# health check grace period value, the default value of `0` is used. If
|
1182
|
+
# you don't use any of the health checks, then
|
1183
|
+
# `healthCheckGracePeriodSeconds` is unused.
|
1184
|
+
#
|
1185
|
+
# If your service's tasks take a while to start and respond to health
|
1186
|
+
# checks, you can specify a health check grace period of up to
|
1187
|
+
# 2,147,483,647 seconds (about 69 years). During that time, the Amazon
|
1188
|
+
# ECS service scheduler ignores health check status. This grace period
|
1189
|
+
# can prevent the service scheduler from marking tasks as unhealthy and
|
1190
|
+
# stopping them before they have time to come up.
|
1187
1191
|
#
|
1188
1192
|
# @option params [String] :scheduling_strategy
|
1189
1193
|
# The scheduling strategy to use for the service. For more information,
|
@@ -1309,6 +1313,9 @@ module Aws::ECS
|
|
1309
1313
|
# volume that is configured at launch time. Currently, the only
|
1310
1314
|
# supported volume type is an Amazon EBS volume.
|
1311
1315
|
#
|
1316
|
+
# @option params [Array<Types::VpcLatticeConfiguration>] :vpc_lattice_configurations
|
1317
|
+
# The VPC Lattice configuration for the service being created.
|
1318
|
+
#
|
1312
1319
|
# @return [Types::CreateServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1313
1320
|
#
|
1314
1321
|
# * {Types::CreateServiceResponse#service #service} => Types::Service
|
@@ -1437,6 +1444,7 @@ module Aws::ECS
|
|
1437
1444
|
# cluster: "String",
|
1438
1445
|
# service_name: "String", # required
|
1439
1446
|
# task_definition: "String",
|
1447
|
+
# availability_zone_rebalancing: "ENABLED", # accepts ENABLED, DISABLED
|
1440
1448
|
# load_balancers: [
|
1441
1449
|
# {
|
1442
1450
|
# target_group_arn: "String",
|
@@ -1474,8 +1482,8 @@ module Aws::ECS
|
|
1474
1482
|
# minimum_healthy_percent: 1,
|
1475
1483
|
# alarms: {
|
1476
1484
|
# alarm_names: ["String"], # required
|
1477
|
-
# enable: false, # required
|
1478
1485
|
# rollback: false, # required
|
1486
|
+
# enable: false, # required
|
1479
1487
|
# },
|
1480
1488
|
# },
|
1481
1489
|
# placement_constraints: [
|
@@ -1575,10 +1583,17 @@ module Aws::ECS
|
|
1575
1583
|
# },
|
1576
1584
|
# ],
|
1577
1585
|
# role_arn: "IAMRoleArn", # required
|
1578
|
-
# filesystem_type: "ext3", # accepts ext3, ext4, xfs
|
1586
|
+
# filesystem_type: "ext3", # accepts ext3, ext4, xfs, ntfs
|
1579
1587
|
# },
|
1580
1588
|
# },
|
1581
1589
|
# ],
|
1590
|
+
# vpc_lattice_configurations: [
|
1591
|
+
# {
|
1592
|
+
# role_arn: "IAMRoleArn", # required
|
1593
|
+
# target_group_arn: "String", # required
|
1594
|
+
# port_name: "String", # required
|
1595
|
+
# },
|
1596
|
+
# ],
|
1582
1597
|
# })
|
1583
1598
|
#
|
1584
1599
|
# @example Response structure
|
@@ -1614,8 +1629,8 @@ module Aws::ECS
|
|
1614
1629
|
# resp.service.deployment_configuration.minimum_healthy_percent #=> Integer
|
1615
1630
|
# resp.service.deployment_configuration.alarms.alarm_names #=> Array
|
1616
1631
|
# resp.service.deployment_configuration.alarms.alarm_names[0] #=> String
|
1617
|
-
# resp.service.deployment_configuration.alarms.enable #=> Boolean
|
1618
1632
|
# resp.service.deployment_configuration.alarms.rollback #=> Boolean
|
1633
|
+
# resp.service.deployment_configuration.alarms.enable #=> Boolean
|
1619
1634
|
# resp.service.task_sets #=> Array
|
1620
1635
|
# resp.service.task_sets[0].id #=> String
|
1621
1636
|
# resp.service.task_sets[0].task_set_arn #=> String
|
@@ -1723,8 +1738,12 @@ module Aws::ECS
|
|
1723
1738
|
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].value #=> String
|
1724
1739
|
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
|
1725
1740
|
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.role_arn #=> String
|
1726
|
-
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs"
|
1741
|
+
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs", "ntfs"
|
1727
1742
|
# resp.service.deployments[0].fargate_ephemeral_storage.kms_key_id #=> String
|
1743
|
+
# resp.service.deployments[0].vpc_lattice_configurations #=> Array
|
1744
|
+
# resp.service.deployments[0].vpc_lattice_configurations[0].role_arn #=> String
|
1745
|
+
# resp.service.deployments[0].vpc_lattice_configurations[0].target_group_arn #=> String
|
1746
|
+
# resp.service.deployments[0].vpc_lattice_configurations[0].port_name #=> String
|
1728
1747
|
# resp.service.role_arn #=> String
|
1729
1748
|
# resp.service.events #=> Array
|
1730
1749
|
# resp.service.events[0].id #=> String
|
@@ -1752,6 +1771,7 @@ module Aws::ECS
|
|
1752
1771
|
# resp.service.enable_ecs_managed_tags #=> Boolean
|
1753
1772
|
# resp.service.propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
|
1754
1773
|
# resp.service.enable_execute_command #=> Boolean
|
1774
|
+
# resp.service.availability_zone_rebalancing #=> String, one of "ENABLED", "DISABLED"
|
1755
1775
|
#
|
1756
1776
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateService AWS API Documentation
|
1757
1777
|
#
|
@@ -2156,7 +2176,7 @@ module Aws::ECS
|
|
2156
2176
|
#
|
2157
2177
|
# <note markdown="1"> The `FARGATE` and `FARGATE_SPOT` capacity providers are reserved and
|
2158
2178
|
# can't be deleted. You can disassociate them from a cluster using
|
2159
|
-
# either [
|
2179
|
+
# either [PutClusterCapacityProviders][1] or by deleting the cluster.
|
2160
2180
|
#
|
2161
2181
|
# </note>
|
2162
2182
|
#
|
@@ -2169,12 +2189,12 @@ module Aws::ECS
|
|
2169
2189
|
# transitioned to use the capacity from the remaining capacity
|
2170
2190
|
# providers. Only capacity providers that aren't associated with a
|
2171
2191
|
# cluster can be deleted. To remove a capacity provider from a cluster,
|
2172
|
-
# you can either use [
|
2192
|
+
# you can either use [PutClusterCapacityProviders][1] or delete the
|
2173
2193
|
# cluster.
|
2174
2194
|
#
|
2175
2195
|
#
|
2176
2196
|
#
|
2177
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/
|
2197
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html
|
2178
2198
|
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html
|
2179
2199
|
#
|
2180
2200
|
# @option params [required, String] :capacity_provider
|
@@ -2425,8 +2445,8 @@ module Aws::ECS
|
|
2425
2445
|
# resp.service.deployment_configuration.minimum_healthy_percent #=> Integer
|
2426
2446
|
# resp.service.deployment_configuration.alarms.alarm_names #=> Array
|
2427
2447
|
# resp.service.deployment_configuration.alarms.alarm_names[0] #=> String
|
2428
|
-
# resp.service.deployment_configuration.alarms.enable #=> Boolean
|
2429
2448
|
# resp.service.deployment_configuration.alarms.rollback #=> Boolean
|
2449
|
+
# resp.service.deployment_configuration.alarms.enable #=> Boolean
|
2430
2450
|
# resp.service.task_sets #=> Array
|
2431
2451
|
# resp.service.task_sets[0].id #=> String
|
2432
2452
|
# resp.service.task_sets[0].task_set_arn #=> String
|
@@ -2534,8 +2554,12 @@ module Aws::ECS
|
|
2534
2554
|
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].value #=> String
|
2535
2555
|
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
|
2536
2556
|
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.role_arn #=> String
|
2537
|
-
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs"
|
2557
|
+
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs", "ntfs"
|
2538
2558
|
# resp.service.deployments[0].fargate_ephemeral_storage.kms_key_id #=> String
|
2559
|
+
# resp.service.deployments[0].vpc_lattice_configurations #=> Array
|
2560
|
+
# resp.service.deployments[0].vpc_lattice_configurations[0].role_arn #=> String
|
2561
|
+
# resp.service.deployments[0].vpc_lattice_configurations[0].target_group_arn #=> String
|
2562
|
+
# resp.service.deployments[0].vpc_lattice_configurations[0].port_name #=> String
|
2539
2563
|
# resp.service.role_arn #=> String
|
2540
2564
|
# resp.service.events #=> Array
|
2541
2565
|
# resp.service.events[0].id #=> String
|
@@ -2563,6 +2587,7 @@ module Aws::ECS
|
|
2563
2587
|
# resp.service.enable_ecs_managed_tags #=> Boolean
|
2564
2588
|
# resp.service.propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
|
2565
2589
|
# resp.service.enable_execute_command #=> Boolean
|
2590
|
+
# resp.service.availability_zone_rebalancing #=> String, one of "ENABLED", "DISABLED"
|
2566
2591
|
#
|
2567
2592
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteService AWS API Documentation
|
2568
2593
|
#
|
@@ -2691,6 +2716,7 @@ module Aws::ECS
|
|
2691
2716
|
# resp.task_definitions[0].container_definitions[0].depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
|
2692
2717
|
# resp.task_definitions[0].container_definitions[0].start_timeout #=> Integer
|
2693
2718
|
# resp.task_definitions[0].container_definitions[0].stop_timeout #=> Integer
|
2719
|
+
# resp.task_definitions[0].container_definitions[0].version_consistency #=> String, one of "enabled", "disabled"
|
2694
2720
|
# resp.task_definitions[0].container_definitions[0].hostname #=> String
|
2695
2721
|
# resp.task_definitions[0].container_definitions[0].user #=> String
|
2696
2722
|
# resp.task_definitions[0].container_definitions[0].working_directory #=> String
|
@@ -2794,6 +2820,7 @@ module Aws::ECS
|
|
2794
2820
|
# resp.task_definitions[0].deregistered_at #=> Time
|
2795
2821
|
# resp.task_definitions[0].registered_by #=> String
|
2796
2822
|
# resp.task_definitions[0].ephemeral_storage.size_in_gi_b #=> Integer
|
2823
|
+
# resp.task_definitions[0].enable_fault_injection #=> Boolean
|
2797
2824
|
# resp.failures #=> Array
|
2798
2825
|
# resp.failures[0].arn #=> String
|
2799
2826
|
# resp.failures[0].reason #=> String
|
@@ -3152,6 +3179,7 @@ module Aws::ECS
|
|
3152
3179
|
# resp.task_definition.container_definitions[0].depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
|
3153
3180
|
# resp.task_definition.container_definitions[0].start_timeout #=> Integer
|
3154
3181
|
# resp.task_definition.container_definitions[0].stop_timeout #=> Integer
|
3182
|
+
# resp.task_definition.container_definitions[0].version_consistency #=> String, one of "enabled", "disabled"
|
3155
3183
|
# resp.task_definition.container_definitions[0].hostname #=> String
|
3156
3184
|
# resp.task_definition.container_definitions[0].user #=> String
|
3157
3185
|
# resp.task_definition.container_definitions[0].working_directory #=> String
|
@@ -3255,6 +3283,7 @@ module Aws::ECS
|
|
3255
3283
|
# resp.task_definition.deregistered_at #=> Time
|
3256
3284
|
# resp.task_definition.registered_by #=> String
|
3257
3285
|
# resp.task_definition.ephemeral_storage.size_in_gi_b #=> Integer
|
3286
|
+
# resp.task_definition.enable_fault_injection #=> Boolean
|
3258
3287
|
#
|
3259
3288
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterTaskDefinition AWS API Documentation
|
3260
3289
|
#
|
@@ -3353,6 +3382,12 @@ module Aws::ECS
|
|
3353
3382
|
|
3354
3383
|
# Describes one or more of your clusters.
|
3355
3384
|
#
|
3385
|
+
# For CLI examples, see [describe-clusters.rst][1] on GitHub.
|
3386
|
+
#
|
3387
|
+
#
|
3388
|
+
#
|
3389
|
+
# [1]: https://github.com/aws/aws-cli/blob/develop/awscli/examples/ecs/describe-clusters.rst
|
3390
|
+
#
|
3356
3391
|
# @option params [Array<String>] :clusters
|
3357
3392
|
# A list of up to 100 cluster names or full cluster Amazon Resource Name
|
3358
3393
|
# (ARN) entries. If you do not specify a cluster, the default cluster is
|
@@ -3662,6 +3697,215 @@ module Aws::ECS
|
|
3662
3697
|
req.send_request(options)
|
3663
3698
|
end
|
3664
3699
|
|
3700
|
+
# Describes one or more of your service deployments.
|
3701
|
+
#
|
3702
|
+
# A service deployment happens when you release a software update for
|
3703
|
+
# the service. For more information, see [Amazon ECS service
|
3704
|
+
# deployments][1].
|
3705
|
+
#
|
3706
|
+
#
|
3707
|
+
#
|
3708
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-deployments.html
|
3709
|
+
#
|
3710
|
+
# @option params [required, Array<String>] :service_deployment_arns
|
3711
|
+
# The ARN of the service deployment.
|
3712
|
+
#
|
3713
|
+
# You can specify a maximum of 20 ARNs.
|
3714
|
+
#
|
3715
|
+
# @return [Types::DescribeServiceDeploymentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3716
|
+
#
|
3717
|
+
# * {Types::DescribeServiceDeploymentsResponse#service_deployments #service_deployments} => Array<Types::ServiceDeployment>
|
3718
|
+
# * {Types::DescribeServiceDeploymentsResponse#failures #failures} => Array<Types::Failure>
|
3719
|
+
#
|
3720
|
+
# @example Request syntax with placeholder values
|
3721
|
+
#
|
3722
|
+
# resp = client.describe_service_deployments({
|
3723
|
+
# service_deployment_arns: ["String"], # required
|
3724
|
+
# })
|
3725
|
+
#
|
3726
|
+
# @example Response structure
|
3727
|
+
#
|
3728
|
+
# resp.service_deployments #=> Array
|
3729
|
+
# resp.service_deployments[0].service_deployment_arn #=> String
|
3730
|
+
# resp.service_deployments[0].service_arn #=> String
|
3731
|
+
# resp.service_deployments[0].cluster_arn #=> String
|
3732
|
+
# resp.service_deployments[0].created_at #=> Time
|
3733
|
+
# resp.service_deployments[0].started_at #=> Time
|
3734
|
+
# resp.service_deployments[0].finished_at #=> Time
|
3735
|
+
# resp.service_deployments[0].stopped_at #=> Time
|
3736
|
+
# resp.service_deployments[0].updated_at #=> Time
|
3737
|
+
# resp.service_deployments[0].source_service_revisions #=> Array
|
3738
|
+
# resp.service_deployments[0].source_service_revisions[0].arn #=> String
|
3739
|
+
# resp.service_deployments[0].source_service_revisions[0].requested_task_count #=> Integer
|
3740
|
+
# resp.service_deployments[0].source_service_revisions[0].running_task_count #=> Integer
|
3741
|
+
# resp.service_deployments[0].source_service_revisions[0].pending_task_count #=> Integer
|
3742
|
+
# resp.service_deployments[0].target_service_revision.arn #=> String
|
3743
|
+
# resp.service_deployments[0].target_service_revision.requested_task_count #=> Integer
|
3744
|
+
# resp.service_deployments[0].target_service_revision.running_task_count #=> Integer
|
3745
|
+
# resp.service_deployments[0].target_service_revision.pending_task_count #=> Integer
|
3746
|
+
# resp.service_deployments[0].status #=> String, one of "PENDING", "SUCCESSFUL", "STOPPED", "STOP_REQUESTED", "IN_PROGRESS", "ROLLBACK_IN_PROGRESS", "ROLLBACK_SUCCESSFUL", "ROLLBACK_FAILED"
|
3747
|
+
# resp.service_deployments[0].status_reason #=> String
|
3748
|
+
# resp.service_deployments[0].deployment_configuration.deployment_circuit_breaker.enable #=> Boolean
|
3749
|
+
# resp.service_deployments[0].deployment_configuration.deployment_circuit_breaker.rollback #=> Boolean
|
3750
|
+
# resp.service_deployments[0].deployment_configuration.maximum_percent #=> Integer
|
3751
|
+
# resp.service_deployments[0].deployment_configuration.minimum_healthy_percent #=> Integer
|
3752
|
+
# resp.service_deployments[0].deployment_configuration.alarms.alarm_names #=> Array
|
3753
|
+
# resp.service_deployments[0].deployment_configuration.alarms.alarm_names[0] #=> String
|
3754
|
+
# resp.service_deployments[0].deployment_configuration.alarms.rollback #=> Boolean
|
3755
|
+
# resp.service_deployments[0].deployment_configuration.alarms.enable #=> Boolean
|
3756
|
+
# resp.service_deployments[0].rollback.reason #=> String
|
3757
|
+
# resp.service_deployments[0].rollback.started_at #=> Time
|
3758
|
+
# resp.service_deployments[0].rollback.service_revision_arn #=> String
|
3759
|
+
# resp.service_deployments[0].deployment_circuit_breaker.status #=> String, one of "TRIGGERED", "MONITORING", "MONITORING_COMPLETE", "DISABLED"
|
3760
|
+
# resp.service_deployments[0].deployment_circuit_breaker.failure_count #=> Integer
|
3761
|
+
# resp.service_deployments[0].deployment_circuit_breaker.threshold #=> Integer
|
3762
|
+
# resp.service_deployments[0].alarms.status #=> String, one of "TRIGGERED", "MONITORING", "MONITORING_COMPLETE", "DISABLED"
|
3763
|
+
# resp.service_deployments[0].alarms.alarm_names #=> Array
|
3764
|
+
# resp.service_deployments[0].alarms.alarm_names[0] #=> String
|
3765
|
+
# resp.service_deployments[0].alarms.triggered_alarm_names #=> Array
|
3766
|
+
# resp.service_deployments[0].alarms.triggered_alarm_names[0] #=> String
|
3767
|
+
# resp.failures #=> Array
|
3768
|
+
# resp.failures[0].arn #=> String
|
3769
|
+
# resp.failures[0].reason #=> String
|
3770
|
+
# resp.failures[0].detail #=> String
|
3771
|
+
#
|
3772
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServiceDeployments AWS API Documentation
|
3773
|
+
#
|
3774
|
+
# @overload describe_service_deployments(params = {})
|
3775
|
+
# @param [Hash] params ({})
|
3776
|
+
def describe_service_deployments(params = {}, options = {})
|
3777
|
+
req = build_request(:describe_service_deployments, params)
|
3778
|
+
req.send_request(options)
|
3779
|
+
end
|
3780
|
+
|
3781
|
+
# Describes one or more service revisions.
|
3782
|
+
#
|
3783
|
+
# A service revision is a version of the service that includes the
|
3784
|
+
# values for the Amazon ECS resources (for example, task definition) and
|
3785
|
+
# the environment resources (for example, load balancers, subnets, and
|
3786
|
+
# security groups). For more information, see [Amazon ECS service
|
3787
|
+
# revisions][1].
|
3788
|
+
#
|
3789
|
+
# You can't describe a service revision that was created before October
|
3790
|
+
# 25, 2024.
|
3791
|
+
#
|
3792
|
+
#
|
3793
|
+
#
|
3794
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-revision.html
|
3795
|
+
#
|
3796
|
+
# @option params [required, Array<String>] :service_revision_arns
|
3797
|
+
# The ARN of the service revision.
|
3798
|
+
#
|
3799
|
+
# You can specify a maximum of 20 ARNs.
|
3800
|
+
#
|
3801
|
+
# You can call [ListServiceDeployments][1] to get the ARNs.
|
3802
|
+
#
|
3803
|
+
#
|
3804
|
+
#
|
3805
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServiceDeployments.html
|
3806
|
+
#
|
3807
|
+
# @return [Types::DescribeServiceRevisionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3808
|
+
#
|
3809
|
+
# * {Types::DescribeServiceRevisionsResponse#service_revisions #service_revisions} => Array<Types::ServiceRevision>
|
3810
|
+
# * {Types::DescribeServiceRevisionsResponse#failures #failures} => Array<Types::Failure>
|
3811
|
+
#
|
3812
|
+
# @example Request syntax with placeholder values
|
3813
|
+
#
|
3814
|
+
# resp = client.describe_service_revisions({
|
3815
|
+
# service_revision_arns: ["String"], # required
|
3816
|
+
# })
|
3817
|
+
#
|
3818
|
+
# @example Response structure
|
3819
|
+
#
|
3820
|
+
# resp.service_revisions #=> Array
|
3821
|
+
# resp.service_revisions[0].service_revision_arn #=> String
|
3822
|
+
# resp.service_revisions[0].service_arn #=> String
|
3823
|
+
# resp.service_revisions[0].cluster_arn #=> String
|
3824
|
+
# resp.service_revisions[0].task_definition #=> String
|
3825
|
+
# resp.service_revisions[0].capacity_provider_strategy #=> Array
|
3826
|
+
# resp.service_revisions[0].capacity_provider_strategy[0].capacity_provider #=> String
|
3827
|
+
# resp.service_revisions[0].capacity_provider_strategy[0].weight #=> Integer
|
3828
|
+
# resp.service_revisions[0].capacity_provider_strategy[0].base #=> Integer
|
3829
|
+
# resp.service_revisions[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
|
3830
|
+
# resp.service_revisions[0].platform_version #=> String
|
3831
|
+
# resp.service_revisions[0].platform_family #=> String
|
3832
|
+
# resp.service_revisions[0].load_balancers #=> Array
|
3833
|
+
# resp.service_revisions[0].load_balancers[0].target_group_arn #=> String
|
3834
|
+
# resp.service_revisions[0].load_balancers[0].load_balancer_name #=> String
|
3835
|
+
# resp.service_revisions[0].load_balancers[0].container_name #=> String
|
3836
|
+
# resp.service_revisions[0].load_balancers[0].container_port #=> Integer
|
3837
|
+
# resp.service_revisions[0].service_registries #=> Array
|
3838
|
+
# resp.service_revisions[0].service_registries[0].registry_arn #=> String
|
3839
|
+
# resp.service_revisions[0].service_registries[0].port #=> Integer
|
3840
|
+
# resp.service_revisions[0].service_registries[0].container_name #=> String
|
3841
|
+
# resp.service_revisions[0].service_registries[0].container_port #=> Integer
|
3842
|
+
# resp.service_revisions[0].network_configuration.awsvpc_configuration.subnets #=> Array
|
3843
|
+
# resp.service_revisions[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
|
3844
|
+
# resp.service_revisions[0].network_configuration.awsvpc_configuration.security_groups #=> Array
|
3845
|
+
# resp.service_revisions[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
|
3846
|
+
# resp.service_revisions[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
|
3847
|
+
# resp.service_revisions[0].container_images #=> Array
|
3848
|
+
# resp.service_revisions[0].container_images[0].container_name #=> String
|
3849
|
+
# resp.service_revisions[0].container_images[0].image_digest #=> String
|
3850
|
+
# resp.service_revisions[0].container_images[0].image #=> String
|
3851
|
+
# resp.service_revisions[0].guard_duty_enabled #=> Boolean
|
3852
|
+
# resp.service_revisions[0].service_connect_configuration.enabled #=> Boolean
|
3853
|
+
# resp.service_revisions[0].service_connect_configuration.namespace #=> String
|
3854
|
+
# resp.service_revisions[0].service_connect_configuration.services #=> Array
|
3855
|
+
# resp.service_revisions[0].service_connect_configuration.services[0].port_name #=> String
|
3856
|
+
# resp.service_revisions[0].service_connect_configuration.services[0].discovery_name #=> String
|
3857
|
+
# resp.service_revisions[0].service_connect_configuration.services[0].client_aliases #=> Array
|
3858
|
+
# resp.service_revisions[0].service_connect_configuration.services[0].client_aliases[0].port #=> Integer
|
3859
|
+
# resp.service_revisions[0].service_connect_configuration.services[0].client_aliases[0].dns_name #=> String
|
3860
|
+
# resp.service_revisions[0].service_connect_configuration.services[0].ingress_port_override #=> Integer
|
3861
|
+
# resp.service_revisions[0].service_connect_configuration.services[0].timeout.idle_timeout_seconds #=> Integer
|
3862
|
+
# resp.service_revisions[0].service_connect_configuration.services[0].timeout.per_request_timeout_seconds #=> Integer
|
3863
|
+
# resp.service_revisions[0].service_connect_configuration.services[0].tls.issuer_certificate_authority.aws_pca_authority_arn #=> String
|
3864
|
+
# resp.service_revisions[0].service_connect_configuration.services[0].tls.kms_key #=> String
|
3865
|
+
# resp.service_revisions[0].service_connect_configuration.services[0].tls.role_arn #=> String
|
3866
|
+
# resp.service_revisions[0].service_connect_configuration.log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
|
3867
|
+
# resp.service_revisions[0].service_connect_configuration.log_configuration.options #=> Hash
|
3868
|
+
# resp.service_revisions[0].service_connect_configuration.log_configuration.options["String"] #=> String
|
3869
|
+
# resp.service_revisions[0].service_connect_configuration.log_configuration.secret_options #=> Array
|
3870
|
+
# resp.service_revisions[0].service_connect_configuration.log_configuration.secret_options[0].name #=> String
|
3871
|
+
# resp.service_revisions[0].service_connect_configuration.log_configuration.secret_options[0].value_from #=> String
|
3872
|
+
# resp.service_revisions[0].volume_configurations #=> Array
|
3873
|
+
# resp.service_revisions[0].volume_configurations[0].name #=> String
|
3874
|
+
# resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.encrypted #=> Boolean
|
3875
|
+
# resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.kms_key_id #=> String
|
3876
|
+
# resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.volume_type #=> String
|
3877
|
+
# resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.size_in_gi_b #=> Integer
|
3878
|
+
# resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.snapshot_id #=> String
|
3879
|
+
# resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.iops #=> Integer
|
3880
|
+
# resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.throughput #=> Integer
|
3881
|
+
# resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.tag_specifications #=> Array
|
3882
|
+
# resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].resource_type #=> String, one of "volume"
|
3883
|
+
# resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags #=> Array
|
3884
|
+
# resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].key #=> String
|
3885
|
+
# resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].value #=> String
|
3886
|
+
# resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
|
3887
|
+
# resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.role_arn #=> String
|
3888
|
+
# resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs", "ntfs"
|
3889
|
+
# resp.service_revisions[0].fargate_ephemeral_storage.kms_key_id #=> String
|
3890
|
+
# resp.service_revisions[0].created_at #=> Time
|
3891
|
+
# resp.service_revisions[0].vpc_lattice_configurations #=> Array
|
3892
|
+
# resp.service_revisions[0].vpc_lattice_configurations[0].role_arn #=> String
|
3893
|
+
# resp.service_revisions[0].vpc_lattice_configurations[0].target_group_arn #=> String
|
3894
|
+
# resp.service_revisions[0].vpc_lattice_configurations[0].port_name #=> String
|
3895
|
+
# resp.failures #=> Array
|
3896
|
+
# resp.failures[0].arn #=> String
|
3897
|
+
# resp.failures[0].reason #=> String
|
3898
|
+
# resp.failures[0].detail #=> String
|
3899
|
+
#
|
3900
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServiceRevisions AWS API Documentation
|
3901
|
+
#
|
3902
|
+
# @overload describe_service_revisions(params = {})
|
3903
|
+
# @param [Hash] params ({})
|
3904
|
+
def describe_service_revisions(params = {}, options = {})
|
3905
|
+
req = build_request(:describe_service_revisions, params)
|
3906
|
+
req.send_request(options)
|
3907
|
+
end
|
3908
|
+
|
3665
3909
|
# Describes the specified services running in your cluster.
|
3666
3910
|
#
|
3667
3911
|
# @option params [String] :cluster
|
@@ -3782,8 +4026,8 @@ module Aws::ECS
|
|
3782
4026
|
# resp.services[0].deployment_configuration.minimum_healthy_percent #=> Integer
|
3783
4027
|
# resp.services[0].deployment_configuration.alarms.alarm_names #=> Array
|
3784
4028
|
# resp.services[0].deployment_configuration.alarms.alarm_names[0] #=> String
|
3785
|
-
# resp.services[0].deployment_configuration.alarms.enable #=> Boolean
|
3786
4029
|
# resp.services[0].deployment_configuration.alarms.rollback #=> Boolean
|
4030
|
+
# resp.services[0].deployment_configuration.alarms.enable #=> Boolean
|
3787
4031
|
# resp.services[0].task_sets #=> Array
|
3788
4032
|
# resp.services[0].task_sets[0].id #=> String
|
3789
4033
|
# resp.services[0].task_sets[0].task_set_arn #=> String
|
@@ -3891,8 +4135,12 @@ module Aws::ECS
|
|
3891
4135
|
# resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].value #=> String
|
3892
4136
|
# resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
|
3893
4137
|
# resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.role_arn #=> String
|
3894
|
-
# resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs"
|
4138
|
+
# resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs", "ntfs"
|
3895
4139
|
# resp.services[0].deployments[0].fargate_ephemeral_storage.kms_key_id #=> String
|
4140
|
+
# resp.services[0].deployments[0].vpc_lattice_configurations #=> Array
|
4141
|
+
# resp.services[0].deployments[0].vpc_lattice_configurations[0].role_arn #=> String
|
4142
|
+
# resp.services[0].deployments[0].vpc_lattice_configurations[0].target_group_arn #=> String
|
4143
|
+
# resp.services[0].deployments[0].vpc_lattice_configurations[0].port_name #=> String
|
3896
4144
|
# resp.services[0].role_arn #=> String
|
3897
4145
|
# resp.services[0].events #=> Array
|
3898
4146
|
# resp.services[0].events[0].id #=> String
|
@@ -3920,6 +4168,7 @@ module Aws::ECS
|
|
3920
4168
|
# resp.services[0].enable_ecs_managed_tags #=> Boolean
|
3921
4169
|
# resp.services[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
|
3922
4170
|
# resp.services[0].enable_execute_command #=> Boolean
|
4171
|
+
# resp.services[0].availability_zone_rebalancing #=> String, one of "ENABLED", "DISABLED"
|
3923
4172
|
# resp.failures #=> Array
|
3924
4173
|
# resp.failures[0].arn #=> String
|
3925
4174
|
# resp.failures[0].reason #=> String
|
@@ -4102,6 +4351,7 @@ module Aws::ECS
|
|
4102
4351
|
# resp.task_definition.container_definitions[0].depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
|
4103
4352
|
# resp.task_definition.container_definitions[0].start_timeout #=> Integer
|
4104
4353
|
# resp.task_definition.container_definitions[0].stop_timeout #=> Integer
|
4354
|
+
# resp.task_definition.container_definitions[0].version_consistency #=> String, one of "enabled", "disabled"
|
4105
4355
|
# resp.task_definition.container_definitions[0].hostname #=> String
|
4106
4356
|
# resp.task_definition.container_definitions[0].user #=> String
|
4107
4357
|
# resp.task_definition.container_definitions[0].working_directory #=> String
|
@@ -4205,6 +4455,7 @@ module Aws::ECS
|
|
4205
4455
|
# resp.task_definition.deregistered_at #=> Time
|
4206
4456
|
# resp.task_definition.registered_by #=> String
|
4207
4457
|
# resp.task_definition.ephemeral_storage.size_in_gi_b #=> Integer
|
4458
|
+
# resp.task_definition.enable_fault_injection #=> Boolean
|
4208
4459
|
# resp.tags #=> Array
|
4209
4460
|
# resp.tags[0].key #=> String
|
4210
4461
|
# resp.tags[0].value #=> String
|
@@ -4330,9 +4581,8 @@ module Aws::ECS
|
|
4330
4581
|
# @option params [String] :cluster
|
4331
4582
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
4332
4583
|
# hosts the task or tasks to describe. If you do not specify a cluster,
|
4333
|
-
# the default cluster is assumed. This parameter is required
|
4334
|
-
#
|
4335
|
-
# the default cluster.
|
4584
|
+
# the default cluster is assumed. This parameter is required. If you do
|
4585
|
+
# not specify a value, the `default` cluster is used.
|
4336
4586
|
#
|
4337
4587
|
# @option params [required, Array<String>] :tasks
|
4338
4588
|
# A list of up to 100 task IDs or full ARN entries.
|
@@ -5127,6 +5377,100 @@ module Aws::ECS
|
|
5127
5377
|
req.send_request(options)
|
5128
5378
|
end
|
5129
5379
|
|
5380
|
+
# This operation lists all the service deployments that meet the
|
5381
|
+
# specified filter criteria.
|
5382
|
+
#
|
5383
|
+
# A service deployment happens when you release a softwre update for the
|
5384
|
+
# service. You route traffic from the running service revisions to the
|
5385
|
+
# new service revison and control the number of running tasks.
|
5386
|
+
#
|
5387
|
+
# This API returns the values that you use for the request parameters in
|
5388
|
+
# [DescribeServiceRevisions][1].
|
5389
|
+
#
|
5390
|
+
#
|
5391
|
+
#
|
5392
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServiceRevisions.html
|
5393
|
+
#
|
5394
|
+
# @option params [required, String] :service
|
5395
|
+
# The ARN or name of the service
|
5396
|
+
#
|
5397
|
+
# @option params [String] :cluster
|
5398
|
+
# The cluster that hosts the service. This can either be the cluster
|
5399
|
+
# name or ARN. Starting April 15, 2023, Amazon Web Services will not
|
5400
|
+
# onboard new customers to Amazon Elastic Inference (EI), and will help
|
5401
|
+
# current customers migrate their workloads to options that offer better
|
5402
|
+
# price and performance. If you don't specify a cluster, `default` is
|
5403
|
+
# used.
|
5404
|
+
#
|
5405
|
+
# @option params [Array<String>] :status
|
5406
|
+
# An optional filter you can use to narrow the results. If you do not
|
5407
|
+
# specify a status, then all status values are included in the result.
|
5408
|
+
#
|
5409
|
+
# @option params [Types::CreatedAt] :created_at
|
5410
|
+
# An optional filter you can use to narrow the results by the service
|
5411
|
+
# creation date. If you do not specify a value, the result includes all
|
5412
|
+
# services created before the current time. The format is yyyy-MM-dd
|
5413
|
+
# HH:mm:ss.SSSSSS.
|
5414
|
+
#
|
5415
|
+
# @option params [String] :next_token
|
5416
|
+
# The `nextToken` value returned from a `ListServiceDeployments` request
|
5417
|
+
# indicating that more results are available to fulfill the request and
|
5418
|
+
# further calls are needed. If you provided `maxResults`, it's possible
|
5419
|
+
# the number of results is fewer than `maxResults`.
|
5420
|
+
#
|
5421
|
+
# @option params [Integer] :max_results
|
5422
|
+
# The maximum number of service deployment results that
|
5423
|
+
# `ListServiceDeployments` returned in paginated output. When this
|
5424
|
+
# parameter is used, `ListServiceDeployments` only returns `maxResults`
|
5425
|
+
# results in a single page along with a `nextToken` response element.
|
5426
|
+
# The remaining results of the initial request can be seen by sending
|
5427
|
+
# another `ListServiceDeployments` request with the returned `nextToken`
|
5428
|
+
# value. This value can be between 1 and 100. If this parameter isn't
|
5429
|
+
# used, then `ListServiceDeployments` returns up to 20 results and a
|
5430
|
+
# `nextToken` value if applicable.
|
5431
|
+
#
|
5432
|
+
# @return [Types::ListServiceDeploymentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5433
|
+
#
|
5434
|
+
# * {Types::ListServiceDeploymentsResponse#service_deployments #service_deployments} => Array<Types::ServiceDeploymentBrief>
|
5435
|
+
# * {Types::ListServiceDeploymentsResponse#next_token #next_token} => String
|
5436
|
+
#
|
5437
|
+
# @example Request syntax with placeholder values
|
5438
|
+
#
|
5439
|
+
# resp = client.list_service_deployments({
|
5440
|
+
# service: "String", # required
|
5441
|
+
# cluster: "String",
|
5442
|
+
# status: ["PENDING"], # accepts PENDING, SUCCESSFUL, STOPPED, STOP_REQUESTED, IN_PROGRESS, ROLLBACK_IN_PROGRESS, ROLLBACK_SUCCESSFUL, ROLLBACK_FAILED
|
5443
|
+
# created_at: {
|
5444
|
+
# before: Time.now,
|
5445
|
+
# after: Time.now,
|
5446
|
+
# },
|
5447
|
+
# next_token: "String",
|
5448
|
+
# max_results: 1,
|
5449
|
+
# })
|
5450
|
+
#
|
5451
|
+
# @example Response structure
|
5452
|
+
#
|
5453
|
+
# resp.service_deployments #=> Array
|
5454
|
+
# resp.service_deployments[0].service_deployment_arn #=> String
|
5455
|
+
# resp.service_deployments[0].service_arn #=> String
|
5456
|
+
# resp.service_deployments[0].cluster_arn #=> String
|
5457
|
+
# resp.service_deployments[0].started_at #=> Time
|
5458
|
+
# resp.service_deployments[0].created_at #=> Time
|
5459
|
+
# resp.service_deployments[0].finished_at #=> Time
|
5460
|
+
# resp.service_deployments[0].target_service_revision_arn #=> String
|
5461
|
+
# resp.service_deployments[0].status #=> String, one of "PENDING", "SUCCESSFUL", "STOPPED", "STOP_REQUESTED", "IN_PROGRESS", "ROLLBACK_IN_PROGRESS", "ROLLBACK_SUCCESSFUL", "ROLLBACK_FAILED"
|
5462
|
+
# resp.service_deployments[0].status_reason #=> String
|
5463
|
+
# resp.next_token #=> String
|
5464
|
+
#
|
5465
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListServiceDeployments AWS API Documentation
|
5466
|
+
#
|
5467
|
+
# @overload list_service_deployments(params = {})
|
5468
|
+
# @param [Hash] params ({})
|
5469
|
+
def list_service_deployments(params = {}, options = {})
|
5470
|
+
req = build_request(:list_service_deployments, params)
|
5471
|
+
req.send_request(options)
|
5472
|
+
end
|
5473
|
+
|
5130
5474
|
# Returns a list of services. You can filter the results by cluster,
|
5131
5475
|
# launch type, and scheduling strategy.
|
5132
5476
|
#
|
@@ -5752,6 +6096,11 @@ module Aws::ECS
|
|
5752
6096
|
# You must turn on this setting to use Amazon ECS features such as
|
5753
6097
|
# resource tagging.
|
5754
6098
|
#
|
6099
|
+
# * `fargateFIPSMode` - When turned on, you can run Fargate workloads in
|
6100
|
+
# a manner that is compliant with Federal Information Processing
|
6101
|
+
# Standard (FIPS-140). For more information, see [Fargate Federal
|
6102
|
+
# Information Processing Standard (FIPS-140)][1].
|
6103
|
+
#
|
5755
6104
|
# * `containerInstanceLongArnFormat` - When modified, the Amazon
|
5756
6105
|
# Resource Name (ARN) and resource ID format of the resource type for
|
5757
6106
|
# a specified user, role, or the root user for an account is affected.
|
@@ -5766,23 +6115,36 @@ module Aws::ECS
|
|
5766
6115
|
# is changed. If `awsvpcTrunking` is turned on, any new container
|
5767
6116
|
# instances that support the feature are launched have the increased
|
5768
6117
|
# ENI limits available to them. For more information, see [Elastic
|
5769
|
-
# Network Interface Trunking][
|
6118
|
+
# Network Interface Trunking][2] in the *Amazon Elastic Container
|
5770
6119
|
# Service Developer Guide*.
|
5771
6120
|
#
|
5772
|
-
# * `containerInsights` -
|
5773
|
-
#
|
5774
|
-
#
|
5775
|
-
#
|
5776
|
-
#
|
5777
|
-
#
|
6121
|
+
# * `containerInsights` - Container Insights with enhanced observability
|
6122
|
+
# provides all the Container Insights metrics, plus additional task
|
6123
|
+
# and container metrics. This version supports enhanced observability
|
6124
|
+
# for Amazon ECS clusters using the Amazon EC2 and Fargate launch
|
6125
|
+
# types. After you configure Container Insights with enhanced
|
6126
|
+
# observability on Amazon ECS, Container Insights auto-collects
|
6127
|
+
# detailed infrastructure telemetry from the cluster level down to the
|
6128
|
+
# container level in your environment and displays these critical
|
6129
|
+
# performance data in curated dashboards removing the heavy lifting in
|
6130
|
+
# observability set-up.
|
6131
|
+
#
|
6132
|
+
# To use Container Insights with enhanced observability, set the
|
6133
|
+
# `containerInsights` account setting to `enhanced`.
|
6134
|
+
#
|
6135
|
+
# To use Container Insights, set the `containerInsights` account
|
6136
|
+
# setting to `enabled`.
|
6137
|
+
#
|
6138
|
+
# For more information, see [Monitor Amazon ECS containers using
|
6139
|
+
# Container Insights with enhanced observability][3] in the *Amazon
|
5778
6140
|
# Elastic Container Service Developer Guide*.
|
5779
6141
|
#
|
5780
6142
|
# * `dualStackIPv6` - When turned on, when using a VPC in dual stack
|
5781
6143
|
# mode, your tasks using the `awsvpc` network mode can have an IPv6
|
5782
6144
|
# address assigned. For more information on using IPv6 with tasks
|
5783
6145
|
# launched on Amazon EC2 instances, see [Using a VPC in dual-stack
|
5784
|
-
# mode][
|
5785
|
-
# Fargate, see [Using a VPC in dual-stack mode][
|
6146
|
+
# mode][4]. For more information on using IPv6 with tasks launched on
|
6147
|
+
# Fargate, see [Using a VPC in dual-stack mode][5].
|
5786
6148
|
#
|
5787
6149
|
# * `fargateTaskRetirementWaitPeriod` - When Amazon Web Services
|
5788
6150
|
# determines that a security or infrastructure update is needed for an
|
@@ -5790,7 +6152,7 @@ module Aws::ECS
|
|
5790
6152
|
# new tasks launched to replace them. Use
|
5791
6153
|
# `fargateTaskRetirementWaitPeriod` to configure the wait time to
|
5792
6154
|
# retire a Fargate task. For information about the Fargate tasks
|
5793
|
-
# maintenance, see [Amazon Web Services Fargate task maintenance][
|
6155
|
+
# maintenance, see [Amazon Web Services Fargate task maintenance][6]
|
5794
6156
|
# in the *Amazon ECS Developer Guide*.
|
5795
6157
|
#
|
5796
6158
|
# * `tagResourceAuthorization` - Amazon ECS is introducing tagging
|
@@ -5800,7 +6162,7 @@ module Aws::ECS
|
|
5800
6162
|
# performs additional authorization to verify if users or roles have
|
5801
6163
|
# permissions to create tags. Therefore, you must grant explicit
|
5802
6164
|
# permissions to use the `ecs:TagResource` action. For more
|
5803
|
-
# information, see [Grant permission to tag resources on creation][
|
6165
|
+
# information, see [Grant permission to tag resources on creation][7]
|
5804
6166
|
# in the *Amazon ECS Developer Guide*.
|
5805
6167
|
#
|
5806
6168
|
# * `guardDutyActivate` - The `guardDutyActivate` parameter is read-only
|
@@ -5808,21 +6170,22 @@ module Aws::ECS
|
|
5808
6170
|
# enabled or disabled by your security administrator in your Amazon
|
5809
6171
|
# ECS account. Amazon GuardDuty controls this account setting on your
|
5810
6172
|
# behalf. For more information, see [Protecting Amazon ECS workloads
|
5811
|
-
# with Amazon ECS Runtime Monitoring][
|
6173
|
+
# with Amazon ECS Runtime Monitoring][8].
|
5812
6174
|
#
|
5813
6175
|
#
|
5814
6176
|
#
|
5815
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
5816
|
-
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
5817
|
-
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
5818
|
-
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
5819
|
-
# [5]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-
|
5820
|
-
# [6]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
5821
|
-
# [7]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
6177
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-fips-compliance.html
|
6178
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html
|
6179
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html
|
6180
|
+
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking-awsvpc.html#task-networking-vpc-dual-stack
|
6181
|
+
# [5]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-task-networking.html#fargate-task-networking-vpc-dual-stack
|
6182
|
+
# [6]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html
|
6183
|
+
# [7]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html
|
6184
|
+
# [8]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html
|
5822
6185
|
#
|
5823
6186
|
# @option params [required, String] :value
|
5824
6187
|
# The account setting value for the specified principal ARN. Accepted
|
5825
|
-
# values are `enabled`, `disabled`, `on`, and `off`.
|
6188
|
+
# values are `enabled`, `disabled`, `enhanced`, `on`, and `off`.
|
5826
6189
|
#
|
5827
6190
|
# When you specify `fargateTaskRetirementWaitPeriod` for the `name`, the
|
5828
6191
|
# following are the valid values:
|
@@ -5965,12 +6328,25 @@ module Aws::ECS
|
|
5965
6328
|
# Network Interface Trunking][1] in the *Amazon Elastic Container
|
5966
6329
|
# Service Developer Guide*.
|
5967
6330
|
#
|
5968
|
-
# * `containerInsights` -
|
5969
|
-
#
|
5970
|
-
#
|
5971
|
-
#
|
5972
|
-
#
|
5973
|
-
#
|
6331
|
+
# * `containerInsights` - Container Insights with enhanced observability
|
6332
|
+
# provides all the Container Insights metrics, plus additional task
|
6333
|
+
# and container metrics. This version supports enhanced observability
|
6334
|
+
# for Amazon ECS clusters using the Amazon EC2 and Fargate launch
|
6335
|
+
# types. After you configure Container Insights with enhanced
|
6336
|
+
# observability on Amazon ECS, Container Insights auto-collects
|
6337
|
+
# detailed infrastructure telemetry from the cluster level down to the
|
6338
|
+
# container level in your environment and displays these critical
|
6339
|
+
# performance data in curated dashboards removing the heavy lifting in
|
6340
|
+
# observability set-up.
|
6341
|
+
#
|
6342
|
+
# To use Container Insights with enhanced observability, set the
|
6343
|
+
# `containerInsights` account setting to `enhanced`.
|
6344
|
+
#
|
6345
|
+
# To use Container Insights, set the `containerInsights` account
|
6346
|
+
# setting to `enabled`.
|
6347
|
+
#
|
6348
|
+
# For more information, see [Monitor Amazon ECS containers using
|
6349
|
+
# Container Insights with enhanced observability][2] in the *Amazon
|
5974
6350
|
# Elastic Container Service Developer Guide*.
|
5975
6351
|
#
|
5976
6352
|
# * `dualStackIPv6` - When turned on, when using a VPC in dual stack
|
@@ -6021,7 +6397,7 @@ module Aws::ECS
|
|
6021
6397
|
#
|
6022
6398
|
# @option params [required, String] :value
|
6023
6399
|
# The account setting value for the specified principal ARN. Accepted
|
6024
|
-
# values are `enabled`, `disabled`, `on`, and `off`.
|
6400
|
+
# values are `enabled`, `disabled`, `on`, `enhanced`, and `off`.
|
6025
6401
|
#
|
6026
6402
|
# When you specify `fargateTaskRetirementWaitPeriod` for the `name`, the
|
6027
6403
|
# following are the valid values:
|
@@ -6820,6 +7196,11 @@ module Aws::ECS
|
|
6820
7196
|
# The operating system that your tasks definitions run on. A platform
|
6821
7197
|
# family is specified only for tasks using the Fargate launch type.
|
6822
7198
|
#
|
7199
|
+
# @option params [Boolean] :enable_fault_injection
|
7200
|
+
# Enables fault injection when you register your task definition and
|
7201
|
+
# allows for fault injection requests to be accepted from the task's
|
7202
|
+
# containers. The default value is `false`.
|
7203
|
+
#
|
6823
7204
|
# @return [Types::RegisterTaskDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6824
7205
|
#
|
6825
7206
|
# * {Types::RegisterTaskDefinitionResponse#task_definition #task_definition} => Types::TaskDefinition
|
@@ -6981,6 +7362,7 @@ module Aws::ECS
|
|
6981
7362
|
# ],
|
6982
7363
|
# start_timeout: 1,
|
6983
7364
|
# stop_timeout: 1,
|
7365
|
+
# version_consistency: "enabled", # accepts enabled, disabled
|
6984
7366
|
# hostname: "String",
|
6985
7367
|
# user: "String",
|
6986
7368
|
# working_directory: "String",
|
@@ -7126,6 +7508,7 @@ module Aws::ECS
|
|
7126
7508
|
# cpu_architecture: "X86_64", # accepts X86_64, ARM64
|
7127
7509
|
# operating_system_family: "WINDOWS_SERVER_2019_FULL", # accepts WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2016_FULL, WINDOWS_SERVER_2004_CORE, WINDOWS_SERVER_2022_CORE, WINDOWS_SERVER_2022_FULL, WINDOWS_SERVER_20H2_CORE, LINUX
|
7128
7510
|
# },
|
7511
|
+
# enable_fault_injection: false,
|
7129
7512
|
# })
|
7130
7513
|
#
|
7131
7514
|
# @example Response structure
|
@@ -7195,6 +7578,7 @@ module Aws::ECS
|
|
7195
7578
|
# resp.task_definition.container_definitions[0].depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
|
7196
7579
|
# resp.task_definition.container_definitions[0].start_timeout #=> Integer
|
7197
7580
|
# resp.task_definition.container_definitions[0].stop_timeout #=> Integer
|
7581
|
+
# resp.task_definition.container_definitions[0].version_consistency #=> String, one of "enabled", "disabled"
|
7198
7582
|
# resp.task_definition.container_definitions[0].hostname #=> String
|
7199
7583
|
# resp.task_definition.container_definitions[0].user #=> String
|
7200
7584
|
# resp.task_definition.container_definitions[0].working_directory #=> String
|
@@ -7298,6 +7682,7 @@ module Aws::ECS
|
|
7298
7682
|
# resp.task_definition.deregistered_at #=> Time
|
7299
7683
|
# resp.task_definition.registered_by #=> String
|
7300
7684
|
# resp.task_definition.ephemeral_storage.size_in_gi_b #=> Integer
|
7685
|
+
# resp.task_definition.enable_fault_injection #=> Boolean
|
7301
7686
|
# resp.tags #=> Array
|
7302
7687
|
# resp.tags[0].key #=> String
|
7303
7688
|
# resp.tags[0].value #=> String
|
@@ -7375,7 +7760,7 @@ module Aws::ECS
|
|
7375
7760
|
# When you use cluster auto scaling, you must specify
|
7376
7761
|
# `capacityProviderStrategy` and not `launchType`.
|
7377
7762
|
#
|
7378
|
-
# A capacity provider strategy
|
7763
|
+
# A capacity provider strategy can contain a maximum of 20 capacity
|
7379
7764
|
# providers.
|
7380
7765
|
#
|
7381
7766
|
# @option params [String] :cluster
|
@@ -7501,8 +7886,8 @@ module Aws::ECS
|
|
7501
7886
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html
|
7502
7887
|
#
|
7503
7888
|
# @option params [String] :reference_id
|
7504
|
-
#
|
7505
|
-
#
|
7889
|
+
# This parameter is only used by Amazon ECS. It is not intended for use
|
7890
|
+
# by customers.
|
7506
7891
|
#
|
7507
7892
|
# @option params [String] :started_by
|
7508
7893
|
# An optional tag specified when a task is started. For example, if you
|
@@ -7760,7 +8145,7 @@ module Aws::ECS
|
|
7760
8145
|
# termination_policy: {
|
7761
8146
|
# delete_on_termination: false, # required
|
7762
8147
|
# },
|
7763
|
-
# filesystem_type: "ext3", # accepts ext3, ext4, xfs
|
8148
|
+
# filesystem_type: "ext3", # accepts ext3, ext4, xfs, ntfs
|
7764
8149
|
# },
|
7765
8150
|
# },
|
7766
8151
|
# ],
|
@@ -7972,7 +8357,8 @@ module Aws::ECS
|
|
7972
8357
|
# propagated.
|
7973
8358
|
#
|
7974
8359
|
# @option params [String] :reference_id
|
7975
|
-
#
|
8360
|
+
# This parameter is only used by Amazon ECS. It is not intended for use
|
8361
|
+
# by customers.
|
7976
8362
|
#
|
7977
8363
|
# @option params [String] :started_by
|
7978
8364
|
# An optional tag specified when a task is started. For example, if you
|
@@ -8135,7 +8521,7 @@ module Aws::ECS
|
|
8135
8521
|
# termination_policy: {
|
8136
8522
|
# delete_on_termination: false, # required
|
8137
8523
|
# },
|
8138
|
-
# filesystem_type: "ext3", # accepts ext3, ext4, xfs
|
8524
|
+
# filesystem_type: "ext3", # accepts ext3, ext4, xfs, ntfs
|
8139
8525
|
# },
|
8140
8526
|
# },
|
8141
8527
|
# ],
|
@@ -9540,6 +9926,18 @@ module Aws::ECS
|
|
9540
9926
|
# Optional deployment parameters that control how many tasks run during
|
9541
9927
|
# the deployment and the ordering of stopping and starting tasks.
|
9542
9928
|
#
|
9929
|
+
# @option params [String] :availability_zone_rebalancing
|
9930
|
+
# Indicates whether to use Availability Zone rebalancing for the
|
9931
|
+
# service.
|
9932
|
+
#
|
9933
|
+
# For more information, see [Balancing an Amazon ECS service across
|
9934
|
+
# Availability Zones][1] in the *Amazon Elastic Container Service
|
9935
|
+
# Developer Guide*.
|
9936
|
+
#
|
9937
|
+
#
|
9938
|
+
#
|
9939
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html
|
9940
|
+
#
|
9543
9941
|
# @option params [Types::NetworkConfiguration] :network_configuration
|
9544
9942
|
# An object representing the network configuration for the service.
|
9545
9943
|
#
|
@@ -9584,14 +9982,17 @@ module Aws::ECS
|
|
9584
9982
|
#
|
9585
9983
|
# @option params [Integer] :health_check_grace_period_seconds
|
9586
9984
|
# The period of time, in seconds, that the Amazon ECS service scheduler
|
9587
|
-
# ignores unhealthy Elastic Load Balancing
|
9588
|
-
# task has first started.
|
9589
|
-
#
|
9590
|
-
#
|
9591
|
-
#
|
9592
|
-
#
|
9593
|
-
#
|
9594
|
-
#
|
9985
|
+
# ignores unhealthy Elastic Load Balancing, VPC Lattice, and container
|
9986
|
+
# health checks after a task has first started. If you don't specify a
|
9987
|
+
# health check grace period value, the default value of `0` is used. If
|
9988
|
+
# you don't use any of the health checks, then
|
9989
|
+
# `healthCheckGracePeriodSeconds` is unused.
|
9990
|
+
#
|
9991
|
+
# If your service's tasks take a while to start and respond to health
|
9992
|
+
# checks, you can specify a health check grace period of up to
|
9993
|
+
# 2,147,483,647 seconds (about 69 years). During that time, the Amazon
|
9994
|
+
# ECS service scheduler ignores health check status. This grace period
|
9995
|
+
# can prevent the service scheduler from marking tasks as unhealthy and
|
9595
9996
|
# stopping them before they have time to come up.
|
9596
9997
|
#
|
9597
9998
|
# @option params [Boolean] :enable_execute_command
|
@@ -9705,6 +10106,10 @@ module Aws::ECS
|
|
9705
10106
|
#
|
9706
10107
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html
|
9707
10108
|
#
|
10109
|
+
# @option params [Array<Types::VpcLatticeConfiguration>] :vpc_lattice_configurations
|
10110
|
+
# An object representing the VPC Lattice configuration for the service
|
10111
|
+
# being updated.
|
10112
|
+
#
|
9708
10113
|
# @return [Types::UpdateServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9709
10114
|
#
|
9710
10115
|
# * {Types::UpdateServiceResponse#service #service} => Types::Service
|
@@ -9759,10 +10164,11 @@ module Aws::ECS
|
|
9759
10164
|
# minimum_healthy_percent: 1,
|
9760
10165
|
# alarms: {
|
9761
10166
|
# alarm_names: ["String"], # required
|
9762
|
-
# enable: false, # required
|
9763
10167
|
# rollback: false, # required
|
10168
|
+
# enable: false, # required
|
9764
10169
|
# },
|
9765
10170
|
# },
|
10171
|
+
# availability_zone_rebalancing: "ENABLED", # accepts ENABLED, DISABLED
|
9766
10172
|
# network_configuration: {
|
9767
10173
|
# awsvpc_configuration: {
|
9768
10174
|
# subnets: ["String"], # required
|
@@ -9868,10 +10274,17 @@ module Aws::ECS
|
|
9868
10274
|
# },
|
9869
10275
|
# ],
|
9870
10276
|
# role_arn: "IAMRoleArn", # required
|
9871
|
-
# filesystem_type: "ext3", # accepts ext3, ext4, xfs
|
10277
|
+
# filesystem_type: "ext3", # accepts ext3, ext4, xfs, ntfs
|
9872
10278
|
# },
|
9873
10279
|
# },
|
9874
10280
|
# ],
|
10281
|
+
# vpc_lattice_configurations: [
|
10282
|
+
# {
|
10283
|
+
# role_arn: "IAMRoleArn", # required
|
10284
|
+
# target_group_arn: "String", # required
|
10285
|
+
# port_name: "String", # required
|
10286
|
+
# },
|
10287
|
+
# ],
|
9875
10288
|
# })
|
9876
10289
|
#
|
9877
10290
|
# @example Response structure
|
@@ -9907,8 +10320,8 @@ module Aws::ECS
|
|
9907
10320
|
# resp.service.deployment_configuration.minimum_healthy_percent #=> Integer
|
9908
10321
|
# resp.service.deployment_configuration.alarms.alarm_names #=> Array
|
9909
10322
|
# resp.service.deployment_configuration.alarms.alarm_names[0] #=> String
|
9910
|
-
# resp.service.deployment_configuration.alarms.enable #=> Boolean
|
9911
10323
|
# resp.service.deployment_configuration.alarms.rollback #=> Boolean
|
10324
|
+
# resp.service.deployment_configuration.alarms.enable #=> Boolean
|
9912
10325
|
# resp.service.task_sets #=> Array
|
9913
10326
|
# resp.service.task_sets[0].id #=> String
|
9914
10327
|
# resp.service.task_sets[0].task_set_arn #=> String
|
@@ -10016,8 +10429,12 @@ module Aws::ECS
|
|
10016
10429
|
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].value #=> String
|
10017
10430
|
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
|
10018
10431
|
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.role_arn #=> String
|
10019
|
-
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs"
|
10432
|
+
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs", "ntfs"
|
10020
10433
|
# resp.service.deployments[0].fargate_ephemeral_storage.kms_key_id #=> String
|
10434
|
+
# resp.service.deployments[0].vpc_lattice_configurations #=> Array
|
10435
|
+
# resp.service.deployments[0].vpc_lattice_configurations[0].role_arn #=> String
|
10436
|
+
# resp.service.deployments[0].vpc_lattice_configurations[0].target_group_arn #=> String
|
10437
|
+
# resp.service.deployments[0].vpc_lattice_configurations[0].port_name #=> String
|
10021
10438
|
# resp.service.role_arn #=> String
|
10022
10439
|
# resp.service.events #=> Array
|
10023
10440
|
# resp.service.events[0].id #=> String
|
@@ -10045,6 +10462,7 @@ module Aws::ECS
|
|
10045
10462
|
# resp.service.enable_ecs_managed_tags #=> Boolean
|
10046
10463
|
# resp.service.propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
|
10047
10464
|
# resp.service.enable_execute_command #=> Boolean
|
10465
|
+
# resp.service.availability_zone_rebalancing #=> String, one of "ENABLED", "DISABLED"
|
10048
10466
|
#
|
10049
10467
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateService AWS API Documentation
|
10050
10468
|
#
|
@@ -10431,7 +10849,7 @@ module Aws::ECS
|
|
10431
10849
|
tracer: tracer
|
10432
10850
|
)
|
10433
10851
|
context[:gem_name] = 'aws-sdk-ecs'
|
10434
|
-
context[:gem_version] = '1.
|
10852
|
+
context[:gem_version] = '1.173.0'
|
10435
10853
|
Seahorse::Client::Request.new(handlers, context)
|
10436
10854
|
end
|
10437
10855
|
|