aws-sdk-ecs 1.162.0 → 1.173.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +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/types.rb
CHANGED
@@ -242,7 +242,7 @@ module Aws::ECS
|
|
242
242
|
|
243
243
|
# An object representing the networking details for a task or service.
|
244
244
|
# For example
|
245
|
-
# `awsVpcConfiguration
|
245
|
+
# `awsVpcConfiguration={subnets=["subnet-12344321"],securityGroups=["sg-12344321"]}`.
|
246
246
|
#
|
247
247
|
# @!attribute [rw] subnets
|
248
248
|
# The IDs of the subnets associated with the task or service. There's
|
@@ -267,7 +267,7 @@ module Aws::ECS
|
|
267
267
|
#
|
268
268
|
# @!attribute [rw] assign_public_ip
|
269
269
|
# Whether the task's elastic network interface receives a public IP
|
270
|
-
# address. The default value is `
|
270
|
+
# address. The default value is `ENABLED`.
|
271
271
|
# @return [String]
|
272
272
|
#
|
273
273
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/AwsVpcConfiguration AWS API Documentation
|
@@ -410,7 +410,7 @@ module Aws::ECS
|
|
410
410
|
# supports Linux tasks with the ARM64 architecture on platform version
|
411
411
|
# 1.4.0 or later.
|
412
412
|
#
|
413
|
-
# A capacity provider strategy
|
413
|
+
# A capacity provider strategy can contain a maximum of 20 capacity
|
414
414
|
# providers.
|
415
415
|
#
|
416
416
|
#
|
@@ -871,7 +871,26 @@ module Aws::ECS
|
|
871
871
|
end
|
872
872
|
|
873
873
|
# The settings to use when creating a cluster. This parameter is used to
|
874
|
-
# turn on CloudWatch Container Insights
|
874
|
+
# turn on CloudWatch Container Insights with enhanced observability or
|
875
|
+
# CloudWatch Container Insights for a cluster.
|
876
|
+
#
|
877
|
+
# Container Insights with enhanced observability provides all the
|
878
|
+
# Container Insights metrics, plus additional task and container
|
879
|
+
# metrics. This version supports enhanced observability for Amazon ECS
|
880
|
+
# clusters using the Amazon EC2 and Fargate launch types. After you
|
881
|
+
# configure Container Insights with enhanced observability on Amazon
|
882
|
+
# ECS, Container Insights auto-collects detailed infrastructure
|
883
|
+
# telemetry from the cluster level down to the container level in your
|
884
|
+
# environment and displays these critical performance data in curated
|
885
|
+
# dashboards removing the heavy lifting in observability set-up.
|
886
|
+
#
|
887
|
+
# For more information, see [Monitor Amazon ECS containers using
|
888
|
+
# Container Insights with enhanced observability][1] in the *Amazon
|
889
|
+
# Elastic Container Service Developer Guide*.
|
890
|
+
#
|
891
|
+
#
|
892
|
+
#
|
893
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html
|
875
894
|
#
|
876
895
|
# @!attribute [rw] name
|
877
896
|
# The name of the cluster setting. The value is `containerInsights` .
|
@@ -879,12 +898,15 @@ module Aws::ECS
|
|
879
898
|
#
|
880
899
|
# @!attribute [rw] value
|
881
900
|
# The value to set for the cluster setting. The supported values are
|
882
|
-
# `enabled
|
901
|
+
# `enhanced`, `enabled`, and `disabled`.
|
883
902
|
#
|
884
|
-
#
|
885
|
-
#
|
886
|
-
#
|
887
|
-
#
|
903
|
+
# To use Container Insights with enhanced observability, set the
|
904
|
+
# `containerInsights` account setting to `enhanced`.
|
905
|
+
#
|
906
|
+
# To use Container Insights, set the `containerInsights` account
|
907
|
+
# setting to `enabled`.
|
908
|
+
#
|
909
|
+
# If a cluster value is specified, it will override the
|
888
910
|
# `containerInsights` value set with [PutAccountSetting][1] or
|
889
911
|
# [PutAccountSettingDefault][2].
|
890
912
|
#
|
@@ -1500,6 +1522,21 @@ module Aws::ECS
|
|
1500
1522
|
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html
|
1501
1523
|
# @return [Integer]
|
1502
1524
|
#
|
1525
|
+
# @!attribute [rw] version_consistency
|
1526
|
+
# Specifies whether Amazon ECS will resolve the container image tag
|
1527
|
+
# provided in the container definition to an image digest. By default,
|
1528
|
+
# the value is `enabled`. If you set the value for a container as
|
1529
|
+
# `disabled`, Amazon ECS will not resolve the provided container image
|
1530
|
+
# tag to a digest and will use the original image URI specified in the
|
1531
|
+
# container definition for deployment. For more information about
|
1532
|
+
# container image resolution, see [Container image resolution][1] in
|
1533
|
+
# the *Amazon ECS Developer Guide*.
|
1534
|
+
#
|
1535
|
+
#
|
1536
|
+
#
|
1537
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability
|
1538
|
+
# @return [String]
|
1539
|
+
#
|
1503
1540
|
# @!attribute [rw] hostname
|
1504
1541
|
# The hostname to use for your container. This parameter maps to
|
1505
1542
|
# `Hostname` in the docker container create command and the
|
@@ -1667,7 +1704,7 @@ module Aws::ECS
|
|
1667
1704
|
# of the Docker Remote API or greater on your container instance. To
|
1668
1705
|
# check the Docker Remote API version on your container instance, log
|
1669
1706
|
# in to your container instance and run the following command: `sudo
|
1670
|
-
# docker version --format '
|
1707
|
+
# docker version --format '{{.Server.APIVersion}}'`
|
1671
1708
|
# @return [Hash<String,String>]
|
1672
1709
|
#
|
1673
1710
|
# @!attribute [rw] ulimits
|
@@ -1688,7 +1725,7 @@ module Aws::ECS
|
|
1688
1725
|
# greater on your container instance. To check the Docker Remote API
|
1689
1726
|
# version on your container instance, log in to your container
|
1690
1727
|
# instance and run the following command: `sudo docker version
|
1691
|
-
# --format '
|
1728
|
+
# --format '{{.Server.APIVersion}}'`
|
1692
1729
|
#
|
1693
1730
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
1694
1731
|
#
|
@@ -1723,7 +1760,7 @@ module Aws::ECS
|
|
1723
1760
|
# greater on your container instance. To check the Docker Remote API
|
1724
1761
|
# version on your container instance, log in to your container
|
1725
1762
|
# instance and run the following command: `sudo docker version
|
1726
|
-
# --format '
|
1763
|
+
# --format '{{.Server.APIVersion}}'`
|
1727
1764
|
#
|
1728
1765
|
# <note markdown="1"> The Amazon ECS container agent running on a container instance must
|
1729
1766
|
# register the logging drivers available on that instance with the
|
@@ -1842,6 +1879,7 @@ module Aws::ECS
|
|
1842
1879
|
:depends_on,
|
1843
1880
|
:start_timeout,
|
1844
1881
|
:stop_timeout,
|
1882
|
+
:version_consistency,
|
1845
1883
|
:hostname,
|
1846
1884
|
:user,
|
1847
1885
|
:working_directory,
|
@@ -1940,6 +1978,45 @@ module Aws::ECS
|
|
1940
1978
|
include Aws::Structure
|
1941
1979
|
end
|
1942
1980
|
|
1981
|
+
# The details about the container image a service revision uses.
|
1982
|
+
#
|
1983
|
+
# To ensure that all tasks in a service use the same container image,
|
1984
|
+
# Amazon ECS resolves container image names and any image tags specified
|
1985
|
+
# in the task definition to container image digests.
|
1986
|
+
#
|
1987
|
+
# After the container image digest has been established, Amazon ECS uses
|
1988
|
+
# the digest to start any other desired tasks, and for any future
|
1989
|
+
# service and service revision updates. This leads to all tasks in a
|
1990
|
+
# service always running identical container images, resulting in
|
1991
|
+
# version consistency for your software. For more information, see
|
1992
|
+
# [Container image resolution][1] in the Amazon ECS Developer Guide.
|
1993
|
+
#
|
1994
|
+
#
|
1995
|
+
#
|
1996
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability
|
1997
|
+
#
|
1998
|
+
# @!attribute [rw] container_name
|
1999
|
+
# The name of the container.
|
2000
|
+
# @return [String]
|
2001
|
+
#
|
2002
|
+
# @!attribute [rw] image_digest
|
2003
|
+
# The container image digest.
|
2004
|
+
# @return [String]
|
2005
|
+
#
|
2006
|
+
# @!attribute [rw] image
|
2007
|
+
# The container image.
|
2008
|
+
# @return [String]
|
2009
|
+
#
|
2010
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerImage AWS API Documentation
|
2011
|
+
#
|
2012
|
+
class ContainerImage < Struct.new(
|
2013
|
+
:container_name,
|
2014
|
+
:image_digest,
|
2015
|
+
:image)
|
2016
|
+
SENSITIVE = []
|
2017
|
+
include Aws::Structure
|
2018
|
+
end
|
2019
|
+
|
1943
2020
|
# An Amazon EC2 or External instance that's running the Amazon ECS
|
1944
2021
|
# agent and has been registered with a cluster.
|
1945
2022
|
#
|
@@ -2161,7 +2238,7 @@ module Aws::ECS
|
|
2161
2238
|
|
2162
2239
|
# The overrides that are sent to a container. An empty container
|
2163
2240
|
# override can be passed in. An example of an empty container override
|
2164
|
-
# is
|
2241
|
+
# is `{"containerOverrides": [ ] }`. If a non-empty container override
|
2165
2242
|
# is specified, the `name` parameter must be included.
|
2166
2243
|
#
|
2167
2244
|
# You can use Secrets Manager or Amazon Web Services Systems Manager
|
@@ -2569,6 +2646,19 @@ module Aws::ECS
|
|
2569
2646
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html
|
2570
2647
|
# @return [String]
|
2571
2648
|
#
|
2649
|
+
# @!attribute [rw] availability_zone_rebalancing
|
2650
|
+
# Indicates whether to use Availability Zone rebalancing for the
|
2651
|
+
# service.
|
2652
|
+
#
|
2653
|
+
# For more information, see [Balancing an Amazon ECS service across
|
2654
|
+
# Availability Zones][1] in the *Amazon Elastic Container Service
|
2655
|
+
# Developer Guide*.
|
2656
|
+
#
|
2657
|
+
#
|
2658
|
+
#
|
2659
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html
|
2660
|
+
# @return [String]
|
2661
|
+
#
|
2572
2662
|
# @!attribute [rw] load_balancers
|
2573
2663
|
# A load balancer object representing the load balancers to use with
|
2574
2664
|
# your service. For more information, see [Service load balancing][1]
|
@@ -2696,7 +2786,7 @@ module Aws::ECS
|
|
2696
2786
|
# `launchType` is specified, the `defaultCapacityProviderStrategy` for
|
2697
2787
|
# the cluster is used.
|
2698
2788
|
#
|
2699
|
-
# A capacity provider strategy
|
2789
|
+
# A capacity provider strategy can contain a maximum of 20 capacity
|
2700
2790
|
# providers.
|
2701
2791
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
2702
2792
|
#
|
@@ -2777,27 +2867,18 @@ module Aws::ECS
|
|
2777
2867
|
#
|
2778
2868
|
# @!attribute [rw] health_check_grace_period_seconds
|
2779
2869
|
# The period of time, in seconds, that the Amazon ECS service
|
2780
|
-
# scheduler ignores unhealthy Elastic Load Balancing
|
2781
|
-
# checks after a task has first started.
|
2782
|
-
#
|
2783
|
-
#
|
2784
|
-
#
|
2785
|
-
#
|
2786
|
-
# If
|
2787
|
-
#
|
2788
|
-
#
|
2789
|
-
#
|
2790
|
-
#
|
2791
|
-
#
|
2792
|
-
# grace period of up to 2,147,483,647 seconds (about 69 years). During
|
2793
|
-
# that time, the Amazon ECS service scheduler ignores health check
|
2794
|
-
# status. This grace period can prevent the service scheduler from
|
2795
|
-
# marking tasks as unhealthy and stopping them before they have time
|
2796
|
-
# to come up.
|
2797
|
-
#
|
2798
|
-
#
|
2799
|
-
#
|
2800
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html
|
2870
|
+
# scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and
|
2871
|
+
# container health checks after a task has first started. If you
|
2872
|
+
# don't specify a health check grace period value, the default value
|
2873
|
+
# of `0` is used. If you don't use any of the health checks, then
|
2874
|
+
# `healthCheckGracePeriodSeconds` is unused.
|
2875
|
+
#
|
2876
|
+
# If your service's tasks take a while to start and respond to health
|
2877
|
+
# checks, you can specify a health check grace period of up to
|
2878
|
+
# 2,147,483,647 seconds (about 69 years). During that time, the Amazon
|
2879
|
+
# ECS service scheduler ignores health check status. This grace period
|
2880
|
+
# can prevent the service scheduler from marking tasks as unhealthy
|
2881
|
+
# and stopping them before they have time to come up.
|
2801
2882
|
# @return [Integer]
|
2802
2883
|
#
|
2803
2884
|
# @!attribute [rw] scheduling_strategy
|
@@ -2935,12 +3016,17 @@ module Aws::ECS
|
|
2935
3016
|
# supported volume type is an Amazon EBS volume.
|
2936
3017
|
# @return [Array<Types::ServiceVolumeConfiguration>]
|
2937
3018
|
#
|
3019
|
+
# @!attribute [rw] vpc_lattice_configurations
|
3020
|
+
# The VPC Lattice configuration for the service being created.
|
3021
|
+
# @return [Array<Types::VpcLatticeConfiguration>]
|
3022
|
+
#
|
2938
3023
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateServiceRequest AWS API Documentation
|
2939
3024
|
#
|
2940
3025
|
class CreateServiceRequest < Struct.new(
|
2941
3026
|
:cluster,
|
2942
3027
|
:service_name,
|
2943
3028
|
:task_definition,
|
3029
|
+
:availability_zone_rebalancing,
|
2944
3030
|
:load_balancers,
|
2945
3031
|
:service_registries,
|
2946
3032
|
:desired_count,
|
@@ -2961,7 +3047,8 @@ module Aws::ECS
|
|
2961
3047
|
:propagate_tags,
|
2962
3048
|
:enable_execute_command,
|
2963
3049
|
:service_connect_configuration,
|
2964
|
-
:volume_configurations
|
3050
|
+
:volume_configurations,
|
3051
|
+
:vpc_lattice_configurations)
|
2965
3052
|
SENSITIVE = []
|
2966
3053
|
include Aws::Structure
|
2967
3054
|
end
|
@@ -3165,6 +3252,30 @@ module Aws::ECS
|
|
3165
3252
|
include Aws::Structure
|
3166
3253
|
end
|
3167
3254
|
|
3255
|
+
# The optional filter to narrow the `ListServiceDeployment` results.
|
3256
|
+
#
|
3257
|
+
# If you do not specify a value, service deployments that were created
|
3258
|
+
# before the current time are included in the result.
|
3259
|
+
#
|
3260
|
+
# @!attribute [rw] before
|
3261
|
+
# Include service deployments in the result that were created before
|
3262
|
+
# this time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
|
3263
|
+
# @return [Time]
|
3264
|
+
#
|
3265
|
+
# @!attribute [rw] after
|
3266
|
+
# Include service deployments in the result that were created after
|
3267
|
+
# this time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
|
3268
|
+
# @return [Time]
|
3269
|
+
#
|
3270
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreatedAt AWS API Documentation
|
3271
|
+
#
|
3272
|
+
class CreatedAt < Struct.new(
|
3273
|
+
:before,
|
3274
|
+
:after)
|
3275
|
+
SENSITIVE = []
|
3276
|
+
include Aws::Structure
|
3277
|
+
end
|
3278
|
+
|
3168
3279
|
# @!attribute [rw] name
|
3169
3280
|
# The resource name to disable the account setting for. If
|
3170
3281
|
# `serviceLongArnFormat` is specified, the ARN for your Amazon ECS
|
@@ -3582,6 +3693,10 @@ module Aws::ECS
|
|
3582
3693
|
# The Fargate ephemeral storage settings for the deployment.
|
3583
3694
|
# @return [Types::DeploymentEphemeralStorage]
|
3584
3695
|
#
|
3696
|
+
# @!attribute [rw] vpc_lattice_configurations
|
3697
|
+
# The VPC Lattice configuration for the service deployment.
|
3698
|
+
# @return [Array<Types::VpcLatticeConfiguration>]
|
3699
|
+
#
|
3585
3700
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Deployment AWS API Documentation
|
3586
3701
|
#
|
3587
3702
|
class Deployment < Struct.new(
|
@@ -3604,7 +3719,8 @@ module Aws::ECS
|
|
3604
3719
|
:service_connect_configuration,
|
3605
3720
|
:service_connect_resources,
|
3606
3721
|
:volume_configurations,
|
3607
|
-
:fargate_ephemeral_storage
|
3722
|
+
:fargate_ephemeral_storage,
|
3723
|
+
:vpc_lattice_configurations)
|
3608
3724
|
SENSITIVE = []
|
3609
3725
|
include Aws::Structure
|
3610
3726
|
end
|
@@ -3632,11 +3748,6 @@ module Aws::ECS
|
|
3632
3748
|
# alarms.
|
3633
3749
|
# @return [Array<String>]
|
3634
3750
|
#
|
3635
|
-
# @!attribute [rw] enable
|
3636
|
-
# Determines whether to use the CloudWatch alarm option in the service
|
3637
|
-
# deployment process.
|
3638
|
-
# @return [Boolean]
|
3639
|
-
#
|
3640
3751
|
# @!attribute [rw] rollback
|
3641
3752
|
# Determines whether to configure Amazon ECS to roll back the service
|
3642
3753
|
# if a service deployment fails. If rollback is used, when a service
|
@@ -3644,12 +3755,17 @@ module Aws::ECS
|
|
3644
3755
|
# that completed successfully.
|
3645
3756
|
# @return [Boolean]
|
3646
3757
|
#
|
3758
|
+
# @!attribute [rw] enable
|
3759
|
+
# Determines whether to use the CloudWatch alarm option in the service
|
3760
|
+
# deployment process.
|
3761
|
+
# @return [Boolean]
|
3762
|
+
#
|
3647
3763
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeploymentAlarms AWS API Documentation
|
3648
3764
|
#
|
3649
3765
|
class DeploymentAlarms < Struct.new(
|
3650
3766
|
:alarm_names,
|
3651
|
-
:
|
3652
|
-
:
|
3767
|
+
:rollback,
|
3768
|
+
:enable)
|
3653
3769
|
SENSITIVE = []
|
3654
3770
|
include Aws::Structure
|
3655
3771
|
end
|
@@ -3733,6 +3849,12 @@ module Aws::ECS
|
|
3733
3849
|
# are available). The default `maximumPercent` value for a service
|
3734
3850
|
# using the `REPLICA` service scheduler is 200%.
|
3735
3851
|
#
|
3852
|
+
# The Amazon ECS scheduler uses this parameter to replace unhealthy
|
3853
|
+
# tasks by starting replacement tasks first and then stopping the
|
3854
|
+
# unhealthy tasks, as long as cluster resources for starting
|
3855
|
+
# replacement tasks are available. For more information about how the
|
3856
|
+
# scheduler replaces unhealthy tasks, see [Amazon ECS services][1].
|
3857
|
+
#
|
3736
3858
|
# If a service is using either the blue/green (`CODE_DEPLOY`) or
|
3737
3859
|
# `EXTERNAL` deployment types, and tasks in the service use the EC2
|
3738
3860
|
# launch type, the **maximum percent** value is set to the default
|
@@ -3747,9 +3869,14 @@ module Aws::ECS
|
|
3747
3869
|
#
|
3748
3870
|
# </note>
|
3749
3871
|
#
|
3750
|
-
# If the
|
3751
|
-
#
|
3752
|
-
#
|
3872
|
+
# If the service uses either the blue/green (`CODE_DEPLOY`) or
|
3873
|
+
# `EXTERNAL` deployment types, and the tasks in the service use the
|
3874
|
+
# Fargate launch type, the maximum percent value is not used. The
|
3875
|
+
# value is still returned when describing your service.
|
3876
|
+
#
|
3877
|
+
#
|
3878
|
+
#
|
3879
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html
|
3753
3880
|
# @return [Integer]
|
3754
3881
|
#
|
3755
3882
|
# @!attribute [rw] minimum_healthy_percent
|
@@ -3764,6 +3891,13 @@ module Aws::ECS
|
|
3764
3891
|
# existing tasks to free up cluster capacity before starting two new
|
3765
3892
|
# tasks.
|
3766
3893
|
#
|
3894
|
+
# If any tasks are unhealthy and if `maximumPercent` doesn't allow
|
3895
|
+
# the Amazon ECS scheduler to start replacement tasks, the scheduler
|
3896
|
+
# stops the unhealthy tasks one-by-one — using the
|
3897
|
+
# `minimumHealthyPercent` as a constraint — to clear up capacity to
|
3898
|
+
# launch replacement tasks. For more information about how the
|
3899
|
+
# scheduler replaces unhealthy tasks, see [Amazon ECS services][1] .
|
3900
|
+
#
|
3767
3901
|
# For services that *do not* use a load balancer, the following should
|
3768
3902
|
# be noted:
|
3769
3903
|
#
|
@@ -3826,6 +3960,10 @@ module Aws::ECS
|
|
3826
3960
|
# `EXTERNAL` deployment types and is running tasks that use the
|
3827
3961
|
# Fargate launch type, the minimum healthy percent value is not used,
|
3828
3962
|
# although it is returned when describing your service.
|
3963
|
+
#
|
3964
|
+
#
|
3965
|
+
#
|
3966
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html
|
3829
3967
|
# @return [Integer]
|
3830
3968
|
#
|
3831
3969
|
# @!attribute [rw] alarms
|
@@ -3843,13 +3981,7 @@ module Aws::ECS
|
|
3843
3981
|
include Aws::Structure
|
3844
3982
|
end
|
3845
3983
|
|
3846
|
-
# The deployment controller to use for the service.
|
3847
|
-
# information, see [Amazon ECS deployment types][1] in the *Amazon
|
3848
|
-
# Elastic Container Service Developer Guide*.
|
3849
|
-
#
|
3850
|
-
#
|
3851
|
-
#
|
3852
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html
|
3984
|
+
# The deployment controller to use for the service.
|
3853
3985
|
#
|
3854
3986
|
# @!attribute [rw] type
|
3855
3987
|
# The deployment controller type to use.
|
@@ -3866,6 +3998,10 @@ module Aws::ECS
|
|
3866
3998
|
# service deployment, as specified in the
|
3867
3999
|
# [DeploymentConfiguration][1].
|
3868
4000
|
#
|
4001
|
+
# For more information about rolling deployments, see [Deploy Amazon
|
4002
|
+
# ECS services by replacing tasks][2] in the *Amazon Elastic
|
4003
|
+
# Container Service Developer Guide*.
|
4004
|
+
#
|
3869
4005
|
# CODE\_DEPLOY
|
3870
4006
|
#
|
3871
4007
|
# : The blue/green (`CODE_DEPLOY`) deployment type uses the blue/green
|
@@ -3873,15 +4009,26 @@ module Aws::ECS
|
|
3873
4009
|
# a new deployment of a service before sending production traffic to
|
3874
4010
|
# it.
|
3875
4011
|
#
|
4012
|
+
# For more information about blue/green deployments, see [Validate
|
4013
|
+
# the state of an Amazon ECS service before deployment ][3] in the
|
4014
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
4015
|
+
#
|
3876
4016
|
# EXTERNAL
|
3877
4017
|
#
|
3878
4018
|
# : The external (`EXTERNAL`) deployment type enables you to use any
|
3879
4019
|
# third-party deployment controller for full control over the
|
3880
4020
|
# deployment process for an Amazon ECS service.
|
3881
4021
|
#
|
4022
|
+
# For more information about external deployments, see [Deploy
|
4023
|
+
# Amazon ECS services using a third-party controller ][4] in the
|
4024
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
4025
|
+
#
|
3882
4026
|
#
|
3883
4027
|
#
|
3884
4028
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeploymentConfiguration.html
|
4029
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html
|
4030
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html
|
4031
|
+
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-external.html
|
3885
4032
|
# @return [String]
|
3886
4033
|
#
|
3887
4034
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeploymentController AWS API Documentation
|
@@ -4167,6 +4314,78 @@ module Aws::ECS
|
|
4167
4314
|
include Aws::Structure
|
4168
4315
|
end
|
4169
4316
|
|
4317
|
+
# @!attribute [rw] service_deployment_arns
|
4318
|
+
# The ARN of the service deployment.
|
4319
|
+
#
|
4320
|
+
# You can specify a maximum of 20 ARNs.
|
4321
|
+
# @return [Array<String>]
|
4322
|
+
#
|
4323
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServiceDeploymentsRequest AWS API Documentation
|
4324
|
+
#
|
4325
|
+
class DescribeServiceDeploymentsRequest < Struct.new(
|
4326
|
+
:service_deployment_arns)
|
4327
|
+
SENSITIVE = []
|
4328
|
+
include Aws::Structure
|
4329
|
+
end
|
4330
|
+
|
4331
|
+
# @!attribute [rw] service_deployments
|
4332
|
+
# The list of service deployments described.
|
4333
|
+
# @return [Array<Types::ServiceDeployment>]
|
4334
|
+
#
|
4335
|
+
# @!attribute [rw] failures
|
4336
|
+
# Any failures associated with the call.
|
4337
|
+
#
|
4338
|
+
# If you decsribe a deployment with a service revision created before
|
4339
|
+
# October 25, 2024, the call fails. The failure includes the service
|
4340
|
+
# revision ARN and the reason set to `MISSING`.
|
4341
|
+
# @return [Array<Types::Failure>]
|
4342
|
+
#
|
4343
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServiceDeploymentsResponse AWS API Documentation
|
4344
|
+
#
|
4345
|
+
class DescribeServiceDeploymentsResponse < Struct.new(
|
4346
|
+
:service_deployments,
|
4347
|
+
:failures)
|
4348
|
+
SENSITIVE = []
|
4349
|
+
include Aws::Structure
|
4350
|
+
end
|
4351
|
+
|
4352
|
+
# @!attribute [rw] service_revision_arns
|
4353
|
+
# The ARN of the service revision.
|
4354
|
+
#
|
4355
|
+
# You can specify a maximum of 20 ARNs.
|
4356
|
+
#
|
4357
|
+
# You can call [ListServiceDeployments][1] to get the ARNs.
|
4358
|
+
#
|
4359
|
+
#
|
4360
|
+
#
|
4361
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServiceDeployments.html
|
4362
|
+
# @return [Array<String>]
|
4363
|
+
#
|
4364
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServiceRevisionsRequest AWS API Documentation
|
4365
|
+
#
|
4366
|
+
class DescribeServiceRevisionsRequest < Struct.new(
|
4367
|
+
:service_revision_arns)
|
4368
|
+
SENSITIVE = []
|
4369
|
+
include Aws::Structure
|
4370
|
+
end
|
4371
|
+
|
4372
|
+
# @!attribute [rw] service_revisions
|
4373
|
+
# The list of service revisions described.
|
4374
|
+
# @return [Array<Types::ServiceRevision>]
|
4375
|
+
#
|
4376
|
+
# @!attribute [rw] failures
|
4377
|
+
# Any failures associated with the call.
|
4378
|
+
# @return [Array<Types::Failure>]
|
4379
|
+
#
|
4380
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServiceRevisionsResponse AWS API Documentation
|
4381
|
+
#
|
4382
|
+
class DescribeServiceRevisionsResponse < Struct.new(
|
4383
|
+
:service_revisions,
|
4384
|
+
:failures)
|
4385
|
+
SENSITIVE = []
|
4386
|
+
include Aws::Structure
|
4387
|
+
end
|
4388
|
+
|
4170
4389
|
# @!attribute [rw] cluster
|
4171
4390
|
# The short name or full Amazon Resource Name (ARN)the cluster that
|
4172
4391
|
# hosts the service to describe. If you do not specify a cluster, the
|
@@ -4331,9 +4550,8 @@ module Aws::ECS
|
|
4331
4550
|
# @!attribute [rw] cluster
|
4332
4551
|
# The short name or full Amazon Resource Name (ARN) of the cluster
|
4333
4552
|
# that hosts the task or tasks to describe. If you do not specify a
|
4334
|
-
# cluster, the default cluster is assumed. This parameter is required
|
4335
|
-
#
|
4336
|
-
# other than the default cluster.
|
4553
|
+
# cluster, the default cluster is assumed. This parameter is required.
|
4554
|
+
# If you do not specify a value, the `default` cluster is used.
|
4337
4555
|
# @return [String]
|
4338
4556
|
#
|
4339
4557
|
# @!attribute [rw] tasks
|
@@ -4719,7 +4937,7 @@ module Aws::ECS
|
|
4719
4937
|
#
|
4720
4938
|
# @!attribute [rw] size_in_gi_b
|
4721
4939
|
# The total amount, in GiB, of ephemeral storage to set for the task.
|
4722
|
-
# The minimum supported value is `
|
4940
|
+
# The minimum supported value is `21` GiB and the maximum supported
|
4723
4941
|
# value is `200` GiB.
|
4724
4942
|
# @return [Integer]
|
4725
4943
|
#
|
@@ -5018,7 +5236,7 @@ module Aws::ECS
|
|
5018
5236
|
# to add additional metadata, such as the task, task definition,
|
5019
5237
|
# cluster, and container instance details to the log event. If
|
5020
5238
|
# specified, the syntax to use is
|
5021
|
-
# `"options"
|
5239
|
+
# `"options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}`.
|
5022
5240
|
# For more information, see [Creating a task definition that uses a
|
5023
5241
|
# FireLens configuration][1] in the *Amazon Elastic Container Service
|
5024
5242
|
# Developer Guide*.
|
@@ -5222,7 +5440,7 @@ module Aws::ECS
|
|
5222
5440
|
#
|
5223
5441
|
# An exit code of 0 indicates success, and non-zero exit code
|
5224
5442
|
# indicates failure. For more information, see `HealthCheck` in the
|
5225
|
-
# docker container create command
|
5443
|
+
# docker container create command.
|
5226
5444
|
# @return [Array<String>]
|
5227
5445
|
#
|
5228
5446
|
# @!attribute [rw] interval
|
@@ -5537,7 +5755,7 @@ module Aws::ECS
|
|
5537
5755
|
# Remote API or greater on your container instance. To check the
|
5538
5756
|
# Docker Remote API version on your container instance, log in to your
|
5539
5757
|
# container instance and run the following command: `sudo docker
|
5540
|
-
# version --format '
|
5758
|
+
# version --format '{{.Server.APIVersion}}'`
|
5541
5759
|
# @return [Boolean]
|
5542
5760
|
#
|
5543
5761
|
# @!attribute [rw] shared_memory_size
|
@@ -5922,6 +6140,103 @@ module Aws::ECS
|
|
5922
6140
|
include Aws::Structure
|
5923
6141
|
end
|
5924
6142
|
|
6143
|
+
# @!attribute [rw] service
|
6144
|
+
# The ARN or name of the service
|
6145
|
+
# @return [String]
|
6146
|
+
#
|
6147
|
+
# @!attribute [rw] cluster
|
6148
|
+
# The cluster that hosts the service. This can either be the cluster
|
6149
|
+
# name or ARN. Starting April 15, 2023, Amazon Web Services will not
|
6150
|
+
# onboard new customers to Amazon Elastic Inference (EI), and will
|
6151
|
+
# help current customers migrate their workloads to options that offer
|
6152
|
+
# better price and performance. If you don't specify a cluster,
|
6153
|
+
# `default` is used.
|
6154
|
+
# @return [String]
|
6155
|
+
#
|
6156
|
+
# @!attribute [rw] status
|
6157
|
+
# An optional filter you can use to narrow the results. If you do not
|
6158
|
+
# specify a status, then all status values are included in the result.
|
6159
|
+
# @return [Array<String>]
|
6160
|
+
#
|
6161
|
+
# @!attribute [rw] created_at
|
6162
|
+
# An optional filter you can use to narrow the results by the service
|
6163
|
+
# creation date. If you do not specify a value, the result includes
|
6164
|
+
# all services created before the current time. The format is
|
6165
|
+
# yyyy-MM-dd HH:mm:ss.SSSSSS.
|
6166
|
+
# @return [Types::CreatedAt]
|
6167
|
+
#
|
6168
|
+
# @!attribute [rw] next_token
|
6169
|
+
# The `nextToken` value returned from a `ListServiceDeployments`
|
6170
|
+
# request indicating that more results are available to fulfill the
|
6171
|
+
# request and further calls are needed. If you provided `maxResults`,
|
6172
|
+
# it's possible the number of results is fewer than `maxResults`.
|
6173
|
+
# @return [String]
|
6174
|
+
#
|
6175
|
+
# @!attribute [rw] max_results
|
6176
|
+
# The maximum number of service deployment results that
|
6177
|
+
# `ListServiceDeployments` returned in paginated output. When this
|
6178
|
+
# parameter is used, `ListServiceDeployments` only returns
|
6179
|
+
# `maxResults` results in a single page along with a `nextToken`
|
6180
|
+
# response element. The remaining results of the initial request can
|
6181
|
+
# be seen by sending another `ListServiceDeployments` request with the
|
6182
|
+
# returned `nextToken` value. This value can be between 1 and 100. If
|
6183
|
+
# this parameter isn't used, then `ListServiceDeployments` returns up
|
6184
|
+
# to 20 results and a `nextToken` value if applicable.
|
6185
|
+
# @return [Integer]
|
6186
|
+
#
|
6187
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListServiceDeploymentsRequest AWS API Documentation
|
6188
|
+
#
|
6189
|
+
class ListServiceDeploymentsRequest < Struct.new(
|
6190
|
+
:service,
|
6191
|
+
:cluster,
|
6192
|
+
:status,
|
6193
|
+
:created_at,
|
6194
|
+
:next_token,
|
6195
|
+
:max_results)
|
6196
|
+
SENSITIVE = []
|
6197
|
+
include Aws::Structure
|
6198
|
+
end
|
6199
|
+
|
6200
|
+
# @!attribute [rw] service_deployments
|
6201
|
+
# An overview of the service deployment, including the following
|
6202
|
+
# properties:
|
6203
|
+
#
|
6204
|
+
# * The ARN of the service deployment.
|
6205
|
+
#
|
6206
|
+
# * The ARN of the service being deployed.
|
6207
|
+
#
|
6208
|
+
# * The ARN of the cluster that hosts the service in the service
|
6209
|
+
# deployment.
|
6210
|
+
#
|
6211
|
+
# * The time that the service deployment started.
|
6212
|
+
#
|
6213
|
+
# * The time that the service deployment completed.
|
6214
|
+
#
|
6215
|
+
# * The service deployment status.
|
6216
|
+
#
|
6217
|
+
# * Information about why the service deployment is in the current
|
6218
|
+
# state.
|
6219
|
+
#
|
6220
|
+
# * The ARN of the service revision that is being deployed.
|
6221
|
+
# @return [Array<Types::ServiceDeploymentBrief>]
|
6222
|
+
#
|
6223
|
+
# @!attribute [rw] next_token
|
6224
|
+
# The `nextToken` value to include in a future
|
6225
|
+
# `ListServiceDeployments` request. When the results of a
|
6226
|
+
# `ListServiceDeployments` request exceed `maxResults`, this value can
|
6227
|
+
# be used to retrieve the next page of results. This value is null
|
6228
|
+
# when there are no more results to return.
|
6229
|
+
# @return [String]
|
6230
|
+
#
|
6231
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListServiceDeploymentsResponse AWS API Documentation
|
6232
|
+
#
|
6233
|
+
class ListServiceDeploymentsResponse < Struct.new(
|
6234
|
+
:service_deployments,
|
6235
|
+
:next_token)
|
6236
|
+
SENSITIVE = []
|
6237
|
+
include Aws::Structure
|
6238
|
+
end
|
6239
|
+
|
5925
6240
|
# @!attribute [rw] namespace
|
5926
6241
|
# The namespace name or full Amazon Resource Name (ARN) of the Cloud
|
5927
6242
|
# Map namespace to list the services in.
|
@@ -6705,7 +7020,8 @@ module Aws::ECS
|
|
6705
7020
|
# When you export logs to Amazon OpenSearch Service, you can specify
|
6706
7021
|
# options like `Name`, `Host` (OpenSearch Service endpoint without
|
6707
7022
|
# protocol), `Port`, `Index`, `Type`, `Aws_auth`, `Aws_region`,
|
6708
|
-
# `Suppress_Type_Name`, and `tls`.
|
7023
|
+
# `Suppress_Type_Name`, and `tls`. For more information, see [Under
|
7024
|
+
# the hood: FireLens for Amazon ECS Tasks][4].
|
6709
7025
|
#
|
6710
7026
|
# When you export logs to Amazon S3, you can specify the bucket using
|
6711
7027
|
# the `bucket` option. You can also specify `region`,
|
@@ -6716,13 +7032,14 @@ module Aws::ECS
|
|
6716
7032
|
# greater on your container instance. To check the Docker Remote API
|
6717
7033
|
# version on your container instance, log in to your container
|
6718
7034
|
# instance and run the following command: `sudo docker version
|
6719
|
-
# --format '
|
7035
|
+
# --format '{{.Server.APIVersion}}'`
|
6720
7036
|
#
|
6721
7037
|
#
|
6722
7038
|
#
|
6723
7039
|
# [1]: https://docs.docker.com/config/containers/logging/awslogs/#awslogs-datetime-format
|
6724
7040
|
# [2]: https://docs.docker.com/config/containers/logging/awslogs/#awslogs-multiline-pattern
|
6725
7041
|
# [3]: http://aws.amazon.com/blogs/containers/preventing-log-loss-with-non-blocking-mode-in-the-awslogs-container-log-driver/
|
7042
|
+
# [4]: http://aws.amazon.com/blogs/containers/under-the-hood-firelens-for-amazon-ecs-tasks/
|
6726
7043
|
# @return [Hash<String,String>]
|
6727
7044
|
#
|
6728
7045
|
# @!attribute [rw] secret_options
|
@@ -7002,7 +7319,6 @@ module Aws::ECS
|
|
7002
7319
|
# Amazon ECS agent finds open host ports from the default
|
7003
7320
|
# ephemeral range and passes it to docker to bind them to the
|
7004
7321
|
# container ports.
|
7005
|
-
#
|
7006
7322
|
# * The `containerPortRange` valid values are between 1 and 65535.
|
7007
7323
|
#
|
7008
7324
|
# * A port can only be included in one port mapping per container.
|
@@ -7320,19 +7636,12 @@ module Aws::ECS
|
|
7320
7636
|
# @return [String]
|
7321
7637
|
#
|
7322
7638
|
# @!attribute [rw] name
|
7323
|
-
# The name that's used for the port mapping. This parameter
|
7324
|
-
#
|
7325
|
-
#
|
7326
|
-
#
|
7327
|
-
#
|
7328
|
-
#
|
7329
|
-
#
|
7330
|
-
# For more information, see [Service Connect][1] in the *Amazon
|
7331
|
-
# Elastic Container Service Developer Guide*.
|
7332
|
-
#
|
7333
|
-
#
|
7334
|
-
#
|
7335
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html
|
7639
|
+
# The name that's used for the port mapping. This parameter is the
|
7640
|
+
# name that you use in the `serviceConnectConfiguration` and the
|
7641
|
+
# `vpcLatticeConfigurations` of a service. The name can include up to
|
7642
|
+
# 64 characters. The characters can include lowercase letters,
|
7643
|
+
# numbers, underscores (\_), and hyphens (-). The name can't start
|
7644
|
+
# with a hyphen.
|
7336
7645
|
# @return [String]
|
7337
7646
|
#
|
7338
7647
|
# @!attribute [rw] app_protocol
|
@@ -7397,7 +7706,6 @@ module Aws::ECS
|
|
7397
7706
|
# Amazon ECS agent finds open host ports from the default
|
7398
7707
|
# ephemeral range and passes it to docker to bind them to the
|
7399
7708
|
# container ports.
|
7400
|
-
#
|
7401
7709
|
# * The `containerPortRange` valid values are between 1 and 65535.
|
7402
7710
|
#
|
7403
7711
|
# * A port can only be included in one port mapping per container.
|
@@ -7577,14 +7885,26 @@ module Aws::ECS
|
|
7577
7885
|
# [Elastic Network Interface Trunking][1] in the *Amazon Elastic
|
7578
7886
|
# Container Service Developer Guide*.
|
7579
7887
|
#
|
7580
|
-
# * `containerInsights` -
|
7581
|
-
#
|
7582
|
-
#
|
7583
|
-
#
|
7584
|
-
#
|
7585
|
-
#
|
7586
|
-
#
|
7587
|
-
#
|
7888
|
+
# * `containerInsights` - Container Insights with enhanced
|
7889
|
+
# observability provides all the Container Insights metrics, plus
|
7890
|
+
# additional task and container metrics. This version supports
|
7891
|
+
# enhanced observability for Amazon ECS clusters using the Amazon
|
7892
|
+
# EC2 and Fargate launch types. After you configure Container
|
7893
|
+
# Insights with enhanced observability on Amazon ECS, Container
|
7894
|
+
# Insights auto-collects detailed infrastructure telemetry from the
|
7895
|
+
# cluster level down to the container level in your environment and
|
7896
|
+
# displays these critical performance data in curated dashboards
|
7897
|
+
# removing the heavy lifting in observability set-up.
|
7898
|
+
#
|
7899
|
+
# To use Container Insights with enhanced observability, set the
|
7900
|
+
# `containerInsights` account setting to `enhanced`.
|
7901
|
+
#
|
7902
|
+
# To use Container Insights, set the `containerInsights` account
|
7903
|
+
# setting to `enabled`.
|
7904
|
+
#
|
7905
|
+
# For more information, see [Monitor Amazon ECS containers using
|
7906
|
+
# Container Insights with enhanced observability][2] in the *Amazon
|
7907
|
+
# Elastic Container Service Developer Guide*.
|
7588
7908
|
#
|
7589
7909
|
# * `dualStackIPv6` - When turned on, when using a VPC in dual stack
|
7590
7910
|
# mode, your tasks using the `awsvpc` network mode can have an IPv6
|
@@ -7635,7 +7955,7 @@ module Aws::ECS
|
|
7635
7955
|
#
|
7636
7956
|
# @!attribute [rw] value
|
7637
7957
|
# The account setting value for the specified principal ARN. Accepted
|
7638
|
-
# values are `enabled`, `disabled`, `on`, and `off`.
|
7958
|
+
# values are `enabled`, `disabled`, `on`, `enhanced`, and `off`.
|
7639
7959
|
#
|
7640
7960
|
# When you specify `fargateTaskRetirementWaitPeriod` for the `name`,
|
7641
7961
|
# the following are the valid values:
|
@@ -7694,6 +8014,11 @@ module Aws::ECS
|
|
7694
8014
|
# the resource. You must turn on this setting to use Amazon ECS
|
7695
8015
|
# features such as resource tagging.
|
7696
8016
|
#
|
8017
|
+
# * `fargateFIPSMode` - When turned on, you can run Fargate workloads
|
8018
|
+
# in a manner that is compliant with Federal Information Processing
|
8019
|
+
# Standard (FIPS-140). For more information, see [Fargate Federal
|
8020
|
+
# Information Processing Standard (FIPS-140)][1].
|
8021
|
+
#
|
7697
8022
|
# * `containerInstanceLongArnFormat` - When modified, the Amazon
|
7698
8023
|
# Resource Name (ARN) and resource ID format of the resource type
|
7699
8024
|
# for a specified user, role, or the root user for an account is
|
@@ -7708,24 +8033,36 @@ module Aws::ECS
|
|
7708
8033
|
# feature is changed. If `awsvpcTrunking` is turned on, any new
|
7709
8034
|
# container instances that support the feature are launched have the
|
7710
8035
|
# increased ENI limits available to them. For more information, see
|
7711
|
-
# [Elastic Network Interface Trunking][
|
8036
|
+
# [Elastic Network Interface Trunking][2] in the *Amazon Elastic
|
7712
8037
|
# Container Service Developer Guide*.
|
7713
8038
|
#
|
7714
|
-
# * `containerInsights` -
|
7715
|
-
#
|
7716
|
-
#
|
7717
|
-
#
|
7718
|
-
#
|
7719
|
-
#
|
7720
|
-
#
|
7721
|
-
#
|
8039
|
+
# * `containerInsights` - Container Insights with enhanced
|
8040
|
+
# observability provides all the Container Insights metrics, plus
|
8041
|
+
# additional task and container metrics. This version supports
|
8042
|
+
# enhanced observability for Amazon ECS clusters using the Amazon
|
8043
|
+
# EC2 and Fargate launch types. After you configure Container
|
8044
|
+
# Insights with enhanced observability on Amazon ECS, Container
|
8045
|
+
# Insights auto-collects detailed infrastructure telemetry from the
|
8046
|
+
# cluster level down to the container level in your environment and
|
8047
|
+
# displays these critical performance data in curated dashboards
|
8048
|
+
# removing the heavy lifting in observability set-up.
|
8049
|
+
#
|
8050
|
+
# To use Container Insights with enhanced observability, set the
|
8051
|
+
# `containerInsights` account setting to `enhanced`.
|
8052
|
+
#
|
8053
|
+
# To use Container Insights, set the `containerInsights` account
|
8054
|
+
# setting to `enabled`.
|
8055
|
+
#
|
8056
|
+
# For more information, see [Monitor Amazon ECS containers using
|
8057
|
+
# Container Insights with enhanced observability][3] in the *Amazon
|
8058
|
+
# Elastic Container Service Developer Guide*.
|
7722
8059
|
#
|
7723
8060
|
# * `dualStackIPv6` - When turned on, when using a VPC in dual stack
|
7724
8061
|
# mode, your tasks using the `awsvpc` network mode can have an IPv6
|
7725
8062
|
# address assigned. For more information on using IPv6 with tasks
|
7726
8063
|
# launched on Amazon EC2 instances, see [Using a VPC in dual-stack
|
7727
|
-
# mode][
|
7728
|
-
# on Fargate, see [Using a VPC in dual-stack mode][
|
8064
|
+
# mode][4]. For more information on using IPv6 with tasks launched
|
8065
|
+
# on Fargate, see [Using a VPC in dual-stack mode][5].
|
7729
8066
|
#
|
7730
8067
|
# * `fargateTaskRetirementWaitPeriod` - When Amazon Web Services
|
7731
8068
|
# determines that a security or infrastructure update is needed for
|
@@ -7733,7 +8070,7 @@ module Aws::ECS
|
|
7733
8070
|
# and new tasks launched to replace them. Use
|
7734
8071
|
# `fargateTaskRetirementWaitPeriod` to configure the wait time to
|
7735
8072
|
# retire a Fargate task. For information about the Fargate tasks
|
7736
|
-
# maintenance, see [Amazon Web Services Fargate task maintenance][
|
8073
|
+
# maintenance, see [Amazon Web Services Fargate task maintenance][6]
|
7737
8074
|
# in the *Amazon ECS Developer Guide*.
|
7738
8075
|
#
|
7739
8076
|
# * `tagResourceAuthorization` - Amazon ECS is introducing tagging
|
@@ -7744,29 +8081,30 @@ module Aws::ECS
|
|
7744
8081
|
# roles have permissions to create tags. Therefore, you must grant
|
7745
8082
|
# explicit permissions to use the `ecs:TagResource` action. For more
|
7746
8083
|
# information, see [Grant permission to tag resources on
|
7747
|
-
# creation][
|
8084
|
+
# creation][7] in the *Amazon ECS Developer Guide*.
|
7748
8085
|
#
|
7749
8086
|
# * `guardDutyActivate` - The `guardDutyActivate` parameter is
|
7750
8087
|
# read-only in Amazon ECS and indicates whether Amazon ECS Runtime
|
7751
8088
|
# Monitoring is enabled or disabled by your security administrator
|
7752
8089
|
# in your Amazon ECS account. Amazon GuardDuty controls this account
|
7753
8090
|
# setting on your behalf. For more information, see [Protecting
|
7754
|
-
# Amazon ECS workloads with Amazon ECS Runtime Monitoring][
|
8091
|
+
# Amazon ECS workloads with Amazon ECS Runtime Monitoring][8].
|
7755
8092
|
#
|
7756
8093
|
#
|
7757
8094
|
#
|
7758
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
7759
|
-
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
7760
|
-
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
7761
|
-
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
7762
|
-
# [5]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-
|
7763
|
-
# [6]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
7764
|
-
# [7]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/
|
8095
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-fips-compliance.html
|
8096
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html
|
8097
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html
|
8098
|
+
# [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking-awsvpc.html#task-networking-vpc-dual-stack
|
8099
|
+
# [5]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-task-networking.html#fargate-task-networking-vpc-dual-stack
|
8100
|
+
# [6]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html
|
8101
|
+
# [7]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html
|
8102
|
+
# [8]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html
|
7765
8103
|
# @return [String]
|
7766
8104
|
#
|
7767
8105
|
# @!attribute [rw] value
|
7768
8106
|
# The account setting value for the specified principal ARN. Accepted
|
7769
|
-
# values are `enabled`, `disabled`, `on`, and `off`.
|
8107
|
+
# values are `enabled`, `disabled`, `enhanced`, `on`, and `off`.
|
7770
8108
|
#
|
7771
8109
|
# When you specify `fargateTaskRetirementWaitPeriod` for the `name`,
|
7772
8110
|
# the following are the valid values:
|
@@ -8378,6 +8716,12 @@ module Aws::ECS
|
|
8378
8716
|
# family is specified only for tasks using the Fargate launch type.
|
8379
8717
|
# @return [Types::RuntimePlatform]
|
8380
8718
|
#
|
8719
|
+
# @!attribute [rw] enable_fault_injection
|
8720
|
+
# Enables fault injection when you register your task definition and
|
8721
|
+
# allows for fault injection requests to be accepted from the task's
|
8722
|
+
# containers. The default value is `false`.
|
8723
|
+
# @return [Boolean]
|
8724
|
+
#
|
8381
8725
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterTaskDefinitionRequest AWS API Documentation
|
8382
8726
|
#
|
8383
8727
|
class RegisterTaskDefinitionRequest < Struct.new(
|
@@ -8397,7 +8741,8 @@ module Aws::ECS
|
|
8397
8741
|
:proxy_configuration,
|
8398
8742
|
:inference_accelerators,
|
8399
8743
|
:ephemeral_storage,
|
8400
|
-
:runtime_platform
|
8744
|
+
:runtime_platform,
|
8745
|
+
:enable_fault_injection)
|
8401
8746
|
SENSITIVE = []
|
8402
8747
|
include Aws::Structure
|
8403
8748
|
end
|
@@ -8541,6 +8886,46 @@ module Aws::ECS
|
|
8541
8886
|
include Aws::Structure
|
8542
8887
|
end
|
8543
8888
|
|
8889
|
+
# Information about the service deployment rollback.
|
8890
|
+
#
|
8891
|
+
# @!attribute [rw] reason
|
8892
|
+
# The reason the rollback happened. For example, the circuit breaker
|
8893
|
+
# initiated the rollback operation.
|
8894
|
+
# @return [String]
|
8895
|
+
#
|
8896
|
+
# @!attribute [rw] started_at
|
8897
|
+
# Time time that the rollback started. The format is yyyy-MM-dd
|
8898
|
+
# HH:mm:ss.SSSSSS.
|
8899
|
+
# @return [Time]
|
8900
|
+
#
|
8901
|
+
# @!attribute [rw] service_revision_arn
|
8902
|
+
# The ARN of the service revision deployed as part of the rollback.
|
8903
|
+
#
|
8904
|
+
# When the type is `GPU`, the value is the number of physical `GPUs`
|
8905
|
+
# the Amazon ECS container agent reserves for the container. The
|
8906
|
+
# number of GPUs that's reserved for all containers in a task can't
|
8907
|
+
# exceed the number of available GPUs on the container instance that
|
8908
|
+
# the task is launched on.
|
8909
|
+
#
|
8910
|
+
# When the type is `InferenceAccelerator`, the `value` matches the
|
8911
|
+
# `deviceName` for an [InferenceAccelerator][1] specified in a task
|
8912
|
+
# definition.
|
8913
|
+
#
|
8914
|
+
#
|
8915
|
+
#
|
8916
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html
|
8917
|
+
# @return [String]
|
8918
|
+
#
|
8919
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Rollback AWS API Documentation
|
8920
|
+
#
|
8921
|
+
class Rollback < Struct.new(
|
8922
|
+
:reason,
|
8923
|
+
:started_at,
|
8924
|
+
:service_revision_arn)
|
8925
|
+
SENSITIVE = []
|
8926
|
+
include Aws::Structure
|
8927
|
+
end
|
8928
|
+
|
8544
8929
|
# @!attribute [rw] capacity_provider_strategy
|
8545
8930
|
# The capacity provider strategy to use for the task.
|
8546
8931
|
#
|
@@ -8552,7 +8937,7 @@ module Aws::ECS
|
|
8552
8937
|
# When you use cluster auto scaling, you must specify
|
8553
8938
|
# `capacityProviderStrategy` and not `launchType`.
|
8554
8939
|
#
|
8555
|
-
# A capacity provider strategy
|
8940
|
+
# A capacity provider strategy can contain a maximum of 20 capacity
|
8556
8941
|
# providers.
|
8557
8942
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
8558
8943
|
#
|
@@ -8692,8 +9077,8 @@ module Aws::ECS
|
|
8692
9077
|
# @return [String]
|
8693
9078
|
#
|
8694
9079
|
# @!attribute [rw] reference_id
|
8695
|
-
#
|
8696
|
-
#
|
9080
|
+
# This parameter is only used by Amazon ECS. It is not intended for
|
9081
|
+
# use by customers.
|
8697
9082
|
# @return [String]
|
8698
9083
|
#
|
8699
9084
|
# @!attribute [rw] started_by
|
@@ -9223,7 +9608,20 @@ module Aws::ECS
|
|
9223
9608
|
# turned on for all containers in tasks as part of the service.
|
9224
9609
|
# @return [Boolean]
|
9225
9610
|
#
|
9226
|
-
#
|
9611
|
+
# @!attribute [rw] availability_zone_rebalancing
|
9612
|
+
# Indicates whether to use Availability Zone rebalancing for the
|
9613
|
+
# service.
|
9614
|
+
#
|
9615
|
+
# For more information, see [Balancing an Amazon ECS service across
|
9616
|
+
# Availability Zones][1] in the *Amazon Elastic Container Service
|
9617
|
+
# Developer Guide*.
|
9618
|
+
#
|
9619
|
+
#
|
9620
|
+
#
|
9621
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html
|
9622
|
+
# @return [String]
|
9623
|
+
#
|
9624
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Service AWS API Documentation
|
9227
9625
|
#
|
9228
9626
|
class Service < Struct.new(
|
9229
9627
|
:service_arn,
|
@@ -9256,7 +9654,8 @@ module Aws::ECS
|
|
9256
9654
|
:created_by,
|
9257
9655
|
:enable_ecs_managed_tags,
|
9258
9656
|
:propagate_tags,
|
9259
|
-
:enable_execute_command
|
9657
|
+
:enable_execute_command,
|
9658
|
+
:availability_zone_rebalancing)
|
9260
9659
|
SENSITIVE = []
|
9261
9660
|
include Aws::Structure
|
9262
9661
|
end
|
@@ -9594,6 +9993,268 @@ module Aws::ECS
|
|
9594
9993
|
include Aws::Structure
|
9595
9994
|
end
|
9596
9995
|
|
9996
|
+
# Information about the service deployment.
|
9997
|
+
#
|
9998
|
+
# Service deployments provide a comprehensive view of your deployments.
|
9999
|
+
# For information about service deployments, see [View service history
|
10000
|
+
# using Amazon ECS service deployments][1] in the <i> <i>Amazon Elastic
|
10001
|
+
# Container Service Developer Guide</i> </i>.
|
10002
|
+
#
|
10003
|
+
#
|
10004
|
+
#
|
10005
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-deployment.html
|
10006
|
+
#
|
10007
|
+
# @!attribute [rw] service_deployment_arn
|
10008
|
+
# The ARN of the service deployment.
|
10009
|
+
# @return [String]
|
10010
|
+
#
|
10011
|
+
# @!attribute [rw] service_arn
|
10012
|
+
# The ARN of the service for this service deployment.
|
10013
|
+
# @return [String]
|
10014
|
+
#
|
10015
|
+
# @!attribute [rw] cluster_arn
|
10016
|
+
# The ARN of the cluster that hosts the service.
|
10017
|
+
# @return [String]
|
10018
|
+
#
|
10019
|
+
# @!attribute [rw] created_at
|
10020
|
+
# The time the service deployment was created. The format is
|
10021
|
+
# yyyy-MM-dd HH:mm:ss.SSSSSS.
|
10022
|
+
# @return [Time]
|
10023
|
+
#
|
10024
|
+
# @!attribute [rw] started_at
|
10025
|
+
# The time the service deployment statred. The format is yyyy-MM-dd
|
10026
|
+
# HH:mm:ss.SSSSSS.
|
10027
|
+
# @return [Time]
|
10028
|
+
#
|
10029
|
+
# @!attribute [rw] finished_at
|
10030
|
+
# The time the service deployment finished. The format is yyyy-MM-dd
|
10031
|
+
# HH:mm:ss.SSSSSS.
|
10032
|
+
# @return [Time]
|
10033
|
+
#
|
10034
|
+
# @!attribute [rw] stopped_at
|
10035
|
+
# The time the service deployment stopped. The format is yyyy-MM-dd
|
10036
|
+
# HH:mm:ss.SSSSSS.
|
10037
|
+
#
|
10038
|
+
# The service deployment stops when any of the following actions
|
10039
|
+
# happen:
|
10040
|
+
#
|
10041
|
+
# * A user manually stops the deployment
|
10042
|
+
#
|
10043
|
+
# * The rollback option is not in use for the failure detection
|
10044
|
+
# mechanism (the circuit breaker or alarm-based) and the service
|
10045
|
+
# fails.
|
10046
|
+
# @return [Time]
|
10047
|
+
#
|
10048
|
+
# @!attribute [rw] updated_at
|
10049
|
+
# The time that the service deployment was last updated. The format is
|
10050
|
+
# yyyy-MM-dd HH:mm:ss.SSSSSS.
|
10051
|
+
# @return [Time]
|
10052
|
+
#
|
10053
|
+
# @!attribute [rw] source_service_revisions
|
10054
|
+
# The currently deployed workload configuration.
|
10055
|
+
# @return [Array<Types::ServiceRevisionSummary>]
|
10056
|
+
#
|
10057
|
+
# @!attribute [rw] target_service_revision
|
10058
|
+
# The workload configuration being deployed.
|
10059
|
+
# @return [Types::ServiceRevisionSummary]
|
10060
|
+
#
|
10061
|
+
# @!attribute [rw] status
|
10062
|
+
# The service deployment state.
|
10063
|
+
# @return [String]
|
10064
|
+
#
|
10065
|
+
# @!attribute [rw] status_reason
|
10066
|
+
# Information about why the service deployment is in the current
|
10067
|
+
# status. For example, the circuit breaker detected a failure.
|
10068
|
+
# @return [String]
|
10069
|
+
#
|
10070
|
+
# @!attribute [rw] deployment_configuration
|
10071
|
+
# Optional deployment parameters that control how many tasks run
|
10072
|
+
# during a deployment and the ordering of stopping and starting tasks.
|
10073
|
+
# @return [Types::DeploymentConfiguration]
|
10074
|
+
#
|
10075
|
+
# @!attribute [rw] rollback
|
10076
|
+
# The rollback options the service deployment uses when the deployment
|
10077
|
+
# fails.
|
10078
|
+
# @return [Types::Rollback]
|
10079
|
+
#
|
10080
|
+
# @!attribute [rw] deployment_circuit_breaker
|
10081
|
+
# The circuit breaker configuration that determines a service
|
10082
|
+
# deployment failed.
|
10083
|
+
# @return [Types::ServiceDeploymentCircuitBreaker]
|
10084
|
+
#
|
10085
|
+
# @!attribute [rw] alarms
|
10086
|
+
# The CloudWatch alarms that determine when a service deployment
|
10087
|
+
# fails.
|
10088
|
+
# @return [Types::ServiceDeploymentAlarms]
|
10089
|
+
#
|
10090
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceDeployment AWS API Documentation
|
10091
|
+
#
|
10092
|
+
class ServiceDeployment < Struct.new(
|
10093
|
+
:service_deployment_arn,
|
10094
|
+
:service_arn,
|
10095
|
+
:cluster_arn,
|
10096
|
+
:created_at,
|
10097
|
+
:started_at,
|
10098
|
+
:finished_at,
|
10099
|
+
:stopped_at,
|
10100
|
+
:updated_at,
|
10101
|
+
:source_service_revisions,
|
10102
|
+
:target_service_revision,
|
10103
|
+
:status,
|
10104
|
+
:status_reason,
|
10105
|
+
:deployment_configuration,
|
10106
|
+
:rollback,
|
10107
|
+
:deployment_circuit_breaker,
|
10108
|
+
:alarms)
|
10109
|
+
SENSITIVE = []
|
10110
|
+
include Aws::Structure
|
10111
|
+
end
|
10112
|
+
|
10113
|
+
# The CloudWatch alarms used to determine a service deployment failed.
|
10114
|
+
#
|
10115
|
+
# Amazon ECS considers the service deployment as failed when any of the
|
10116
|
+
# alarms move to the `ALARM` state. For more information, see [How
|
10117
|
+
# CloudWatch alarms detect Amazon ECS deployment failures][1] in the
|
10118
|
+
# Amazon ECS Developer Guide.
|
10119
|
+
#
|
10120
|
+
#
|
10121
|
+
#
|
10122
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-alarm-failure.html
|
10123
|
+
#
|
10124
|
+
# @!attribute [rw] status
|
10125
|
+
# The status of the alarms check. Amazon ECS is not using alarms for
|
10126
|
+
# service deployment failures when the status is `DISABLED`.
|
10127
|
+
# @return [String]
|
10128
|
+
#
|
10129
|
+
# @!attribute [rw] alarm_names
|
10130
|
+
# The name of the CloudWatch alarms that determine when a service
|
10131
|
+
# deployment failed. A "," separates the alarms.
|
10132
|
+
# @return [Array<String>]
|
10133
|
+
#
|
10134
|
+
# @!attribute [rw] triggered_alarm_names
|
10135
|
+
# One or more CloudWatch alarm names that have been triggered during
|
10136
|
+
# the service deployment. A "," separates the alarm names.
|
10137
|
+
# @return [Array<String>]
|
10138
|
+
#
|
10139
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceDeploymentAlarms AWS API Documentation
|
10140
|
+
#
|
10141
|
+
class ServiceDeploymentAlarms < Struct.new(
|
10142
|
+
:status,
|
10143
|
+
:alarm_names,
|
10144
|
+
:triggered_alarm_names)
|
10145
|
+
SENSITIVE = []
|
10146
|
+
include Aws::Structure
|
10147
|
+
end
|
10148
|
+
|
10149
|
+
# The service deployment properties that are retured when you call
|
10150
|
+
# `ListServiceDeployments`.
|
10151
|
+
#
|
10152
|
+
# This provides a high-level overview of the service deployment.
|
10153
|
+
#
|
10154
|
+
# @!attribute [rw] service_deployment_arn
|
10155
|
+
# The ARN of the service deployment.
|
10156
|
+
# @return [String]
|
10157
|
+
#
|
10158
|
+
# @!attribute [rw] service_arn
|
10159
|
+
# The ARN of the service for this service deployment.
|
10160
|
+
# @return [String]
|
10161
|
+
#
|
10162
|
+
# @!attribute [rw] cluster_arn
|
10163
|
+
# The ARN of the cluster that hosts the service.
|
10164
|
+
# @return [String]
|
10165
|
+
#
|
10166
|
+
# @!attribute [rw] started_at
|
10167
|
+
# The time that the service deployment statred. The format is
|
10168
|
+
# yyyy-MM-dd HH:mm:ss.SSSSSS.
|
10169
|
+
# @return [Time]
|
10170
|
+
#
|
10171
|
+
# @!attribute [rw] created_at
|
10172
|
+
# The time that the service deployment was created. The format is
|
10173
|
+
# yyyy-MM-dd HH:mm:ss.SSSSSS.
|
10174
|
+
# @return [Time]
|
10175
|
+
#
|
10176
|
+
# @!attribute [rw] finished_at
|
10177
|
+
# The time that the service deployment completed. The format is
|
10178
|
+
# yyyy-MM-dd HH:mm:ss.SSSSSS.
|
10179
|
+
# @return [Time]
|
10180
|
+
#
|
10181
|
+
# @!attribute [rw] target_service_revision_arn
|
10182
|
+
# The ARN of the service revision being deplyed.
|
10183
|
+
# @return [String]
|
10184
|
+
#
|
10185
|
+
# @!attribute [rw] status
|
10186
|
+
# The status of the service deployment
|
10187
|
+
# @return [String]
|
10188
|
+
#
|
10189
|
+
# @!attribute [rw] status_reason
|
10190
|
+
# Information about why the service deployment is in the current
|
10191
|
+
# status. For example, the circuit breaker detected a deployment
|
10192
|
+
# failure.
|
10193
|
+
# @return [String]
|
10194
|
+
#
|
10195
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceDeploymentBrief AWS API Documentation
|
10196
|
+
#
|
10197
|
+
class ServiceDeploymentBrief < Struct.new(
|
10198
|
+
:service_deployment_arn,
|
10199
|
+
:service_arn,
|
10200
|
+
:cluster_arn,
|
10201
|
+
:started_at,
|
10202
|
+
:created_at,
|
10203
|
+
:finished_at,
|
10204
|
+
:target_service_revision_arn,
|
10205
|
+
:status,
|
10206
|
+
:status_reason)
|
10207
|
+
SENSITIVE = []
|
10208
|
+
include Aws::Structure
|
10209
|
+
end
|
10210
|
+
|
10211
|
+
# Information about the circuit breaker used to determine when a service
|
10212
|
+
# deployment has failed.
|
10213
|
+
#
|
10214
|
+
# The deployment circuit breaker is the rolling update mechanism that
|
10215
|
+
# determines if the tasks reach a steady state. The deployment circuit
|
10216
|
+
# breaker has an option that will automatically roll back a failed
|
10217
|
+
# deployment to the last cpompleted service revision. For more
|
10218
|
+
# information, see [How the Amazon ECS deployment circuit breaker
|
10219
|
+
# detects failures][1] in the<i> Amazon ECS Developer Guide</i>.
|
10220
|
+
#
|
10221
|
+
#
|
10222
|
+
#
|
10223
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-circuit-breaker.html
|
10224
|
+
#
|
10225
|
+
# @!attribute [rw] status
|
10226
|
+
# The circuit breaker status. Amazon ECS is not using the circuit
|
10227
|
+
# breaker for service deployment failures when the status is
|
10228
|
+
# `DISABLED`.
|
10229
|
+
# @return [String]
|
10230
|
+
#
|
10231
|
+
# @!attribute [rw] failure_count
|
10232
|
+
# The number of times the circuit breaker detected a service
|
10233
|
+
# deploymeny failure.
|
10234
|
+
# @return [Integer]
|
10235
|
+
#
|
10236
|
+
# @!attribute [rw] threshold
|
10237
|
+
# The threshhold which determines that the service deployment failed.
|
10238
|
+
#
|
10239
|
+
# The deployment circuit breaker calculates the threshold value, and
|
10240
|
+
# then uses the value to determine when to move the deployment to a
|
10241
|
+
# FAILED state. The deployment circuit breaker has a minimum threshold
|
10242
|
+
# of 3 and a maximum threshold of 200. and uses the values in the
|
10243
|
+
# following formula to determine the deployment failure.
|
10244
|
+
#
|
10245
|
+
# `0.5 * desired task count`
|
10246
|
+
# @return [Integer]
|
10247
|
+
#
|
10248
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceDeploymentCircuitBreaker AWS API Documentation
|
10249
|
+
#
|
10250
|
+
class ServiceDeploymentCircuitBreaker < Struct.new(
|
10251
|
+
:status,
|
10252
|
+
:failure_count,
|
10253
|
+
:threshold)
|
10254
|
+
SENSITIVE = []
|
10255
|
+
include Aws::Structure
|
10256
|
+
end
|
10257
|
+
|
9597
10258
|
# The details for an event that's associated with a service.
|
9598
10259
|
#
|
9599
10260
|
# @!attribute [rw] id
|
@@ -9621,11 +10282,18 @@ module Aws::ECS
|
|
9621
10282
|
# The configuration for the Amazon EBS volume that Amazon ECS creates
|
9622
10283
|
# and manages on your behalf. These settings are used to create each
|
9623
10284
|
# Amazon EBS volume, with one volume created for each task in the
|
9624
|
-
# service.
|
10285
|
+
# service. For information about the supported launch types and
|
10286
|
+
# operating systems, see [Supported operating systems and launch
|
10287
|
+
# types][1] in the<i> Amazon Elastic Container Service Developer
|
10288
|
+
# Guide</i>.
|
9625
10289
|
#
|
9626
10290
|
# Many of these parameters map 1:1 with the Amazon EBS `CreateVolume`
|
9627
10291
|
# API request parameters.
|
9628
10292
|
#
|
10293
|
+
#
|
10294
|
+
#
|
10295
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volumes-configuration
|
10296
|
+
#
|
9629
10297
|
# @!attribute [rw] encrypted
|
9630
10298
|
# Indicates whether the volume should be encrypted. If no value is
|
9631
10299
|
# specified, encryption is turned on by default. This parameter maps
|
@@ -9784,13 +10452,16 @@ module Aws::ECS
|
|
9784
10452
|
# @return [String]
|
9785
10453
|
#
|
9786
10454
|
# @!attribute [rw] filesystem_type
|
9787
|
-
# The
|
10455
|
+
# The filesystem type for the volume. For volumes created from a
|
9788
10456
|
# snapshot, you must specify the same filesystem type that the volume
|
9789
10457
|
# was using when the snapshot was created. If there is a filesystem
|
9790
10458
|
# type mismatch, the task will fail to start.
|
9791
10459
|
#
|
9792
|
-
# The available filesystem types are
`ext3`, `ext4`, and `xfs`.
|
9793
|
-
# value is specified, the `xfs` filesystem type is used by
|
10460
|
+
# The available Linux filesystem types are
`ext3`, `ext4`, and `xfs`.
|
10461
|
+
# If no value is specified, the `xfs` filesystem type is used by
|
10462
|
+
# default.
|
10463
|
+
#
|
10464
|
+
# The available Windows filesystem types are `NTFS`.
|
9794
10465
|
# @return [String]
|
9795
10466
|
#
|
9796
10467
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceManagedEBSVolumeConfiguration AWS API Documentation
|
@@ -9894,6 +10565,167 @@ module Aws::ECS
|
|
9894
10565
|
include Aws::Structure
|
9895
10566
|
end
|
9896
10567
|
|
10568
|
+
# Information about the service revision.
|
10569
|
+
#
|
10570
|
+
# A service revision contains a record of the workload configuration
|
10571
|
+
# Amazon ECS is attempting to deploy. Whenever you create or deploy a
|
10572
|
+
# service, Amazon ECS automatically creates and captures the
|
10573
|
+
# configuration that you're trying to deploy in the service revision.
|
10574
|
+
# For information about service revisions, see [Amazon ECS service
|
10575
|
+
# revisions][1] in the <i> <i>Amazon Elastic Container Service Developer
|
10576
|
+
# Guide</i> </i>.
|
10577
|
+
#
|
10578
|
+
#
|
10579
|
+
#
|
10580
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-revision.html
|
10581
|
+
#
|
10582
|
+
# @!attribute [rw] service_revision_arn
|
10583
|
+
# The ARN of the service revision.
|
10584
|
+
# @return [String]
|
10585
|
+
#
|
10586
|
+
# @!attribute [rw] service_arn
|
10587
|
+
# The ARN of the service for the service revision.
|
10588
|
+
# @return [String]
|
10589
|
+
#
|
10590
|
+
# @!attribute [rw] cluster_arn
|
10591
|
+
# The ARN of the cluster that hosts the service.
|
10592
|
+
# @return [String]
|
10593
|
+
#
|
10594
|
+
# @!attribute [rw] task_definition
|
10595
|
+
# The task definition the service revision uses.
|
10596
|
+
# @return [String]
|
10597
|
+
#
|
10598
|
+
# @!attribute [rw] capacity_provider_strategy
|
10599
|
+
# The capacity provider strategy the service revision uses.
|
10600
|
+
# @return [Array<Types::CapacityProviderStrategyItem>]
|
10601
|
+
#
|
10602
|
+
# @!attribute [rw] launch_type
|
10603
|
+
# The launch type the service revision uses.
|
10604
|
+
# @return [String]
|
10605
|
+
#
|
10606
|
+
# @!attribute [rw] platform_version
|
10607
|
+
# For the Fargate launch type, the platform version the service
|
10608
|
+
# revision uses.
|
10609
|
+
# @return [String]
|
10610
|
+
#
|
10611
|
+
# @!attribute [rw] platform_family
|
10612
|
+
# The platform family the service revision uses.
|
10613
|
+
# @return [String]
|
10614
|
+
#
|
10615
|
+
# @!attribute [rw] load_balancers
|
10616
|
+
# The load balancers the service revision uses.
|
10617
|
+
# @return [Array<Types::LoadBalancer>]
|
10618
|
+
#
|
10619
|
+
# @!attribute [rw] service_registries
|
10620
|
+
# The service registries (for Service Discovery) the service revision
|
10621
|
+
# uses.
|
10622
|
+
# @return [Array<Types::ServiceRegistry>]
|
10623
|
+
#
|
10624
|
+
# @!attribute [rw] network_configuration
|
10625
|
+
# The network configuration for a task or service.
|
10626
|
+
# @return [Types::NetworkConfiguration]
|
10627
|
+
#
|
10628
|
+
# @!attribute [rw] container_images
|
10629
|
+
# The container images the service revision uses.
|
10630
|
+
# @return [Array<Types::ContainerImage>]
|
10631
|
+
#
|
10632
|
+
# @!attribute [rw] guard_duty_enabled
|
10633
|
+
# Indicates whether Runtime Monitoring is turned on.
|
10634
|
+
# @return [Boolean]
|
10635
|
+
#
|
10636
|
+
# @!attribute [rw] service_connect_configuration
|
10637
|
+
# The Service Connect configuration of your Amazon ECS service. The
|
10638
|
+
# configuration for this service to discover and connect to services,
|
10639
|
+
# and be discovered by, and connected from, other services within a
|
10640
|
+
# namespace.
|
10641
|
+
#
|
10642
|
+
# Tasks that run in a namespace can use short names to connect to
|
10643
|
+
# services in the namespace. Tasks can connect to services across all
|
10644
|
+
# of the clusters in the namespace. Tasks connect through a managed
|
10645
|
+
# proxy container that collects logs and metrics for increased
|
10646
|
+
# visibility. Only the tasks that Amazon ECS services create are
|
10647
|
+
# supported with Service Connect. For more information, see [Service
|
10648
|
+
# Connect][1] in the *Amazon Elastic Container Service Developer
|
10649
|
+
# Guide*.
|
10650
|
+
#
|
10651
|
+
#
|
10652
|
+
#
|
10653
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html
|
10654
|
+
# @return [Types::ServiceConnectConfiguration]
|
10655
|
+
#
|
10656
|
+
# @!attribute [rw] volume_configurations
|
10657
|
+
# The volumes that are configured at deployment that the service
|
10658
|
+
# revision uses.
|
10659
|
+
# @return [Array<Types::ServiceVolumeConfiguration>]
|
10660
|
+
#
|
10661
|
+
# @!attribute [rw] fargate_ephemeral_storage
|
10662
|
+
# The amount of ephemeral storage to allocate for the deployment.
|
10663
|
+
# @return [Types::DeploymentEphemeralStorage]
|
10664
|
+
#
|
10665
|
+
# @!attribute [rw] created_at
|
10666
|
+
# The time that the service revision was created. The format is
|
10667
|
+
# yyyy-mm-dd HH:mm:ss.SSSSS.
|
10668
|
+
# @return [Time]
|
10669
|
+
#
|
10670
|
+
# @!attribute [rw] vpc_lattice_configurations
|
10671
|
+
# The VPC Lattice configuration for the service revision.
|
10672
|
+
# @return [Array<Types::VpcLatticeConfiguration>]
|
10673
|
+
#
|
10674
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceRevision AWS API Documentation
|
10675
|
+
#
|
10676
|
+
class ServiceRevision < Struct.new(
|
10677
|
+
:service_revision_arn,
|
10678
|
+
:service_arn,
|
10679
|
+
:cluster_arn,
|
10680
|
+
:task_definition,
|
10681
|
+
:capacity_provider_strategy,
|
10682
|
+
:launch_type,
|
10683
|
+
:platform_version,
|
10684
|
+
:platform_family,
|
10685
|
+
:load_balancers,
|
10686
|
+
:service_registries,
|
10687
|
+
:network_configuration,
|
10688
|
+
:container_images,
|
10689
|
+
:guard_duty_enabled,
|
10690
|
+
:service_connect_configuration,
|
10691
|
+
:volume_configurations,
|
10692
|
+
:fargate_ephemeral_storage,
|
10693
|
+
:created_at,
|
10694
|
+
:vpc_lattice_configurations)
|
10695
|
+
SENSITIVE = []
|
10696
|
+
include Aws::Structure
|
10697
|
+
end
|
10698
|
+
|
10699
|
+
# The information about the number of requested, pending, and running
|
10700
|
+
# tasks for a service revision.
|
10701
|
+
#
|
10702
|
+
# @!attribute [rw] arn
|
10703
|
+
# The ARN of the service revision.
|
10704
|
+
# @return [String]
|
10705
|
+
#
|
10706
|
+
# @!attribute [rw] requested_task_count
|
10707
|
+
# The number of requested tasks for the service revision.
|
10708
|
+
# @return [Integer]
|
10709
|
+
#
|
10710
|
+
# @!attribute [rw] running_task_count
|
10711
|
+
# The number of running tasks for the service revision.
|
10712
|
+
# @return [Integer]
|
10713
|
+
#
|
10714
|
+
# @!attribute [rw] pending_task_count
|
10715
|
+
# The number of pending tasks for the service revision.
|
10716
|
+
# @return [Integer]
|
10717
|
+
#
|
10718
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceRevisionSummary AWS API Documentation
|
10719
|
+
#
|
10720
|
+
class ServiceRevisionSummary < Struct.new(
|
10721
|
+
:arn,
|
10722
|
+
:requested_task_count,
|
10723
|
+
:running_task_count,
|
10724
|
+
:pending_task_count)
|
10725
|
+
SENSITIVE = []
|
10726
|
+
include Aws::Structure
|
10727
|
+
end
|
10728
|
+
|
9897
10729
|
# The configuration for a volume specified in the task definition as a
|
9898
10730
|
# volume that is configured at launch time. Currently, the only
|
9899
10731
|
# supported volume type is an Amazon EBS volume.
|
@@ -10047,7 +10879,8 @@ module Aws::ECS
|
|
10047
10879
|
# @return [String]
|
10048
10880
|
#
|
10049
10881
|
# @!attribute [rw] reference_id
|
10050
|
-
#
|
10882
|
+
# This parameter is only used by Amazon ECS. It is not intended for
|
10883
|
+
# use by customers.
|
10051
10884
|
# @return [String]
|
10052
10885
|
#
|
10053
10886
|
# @!attribute [rw] started_by
|
@@ -11315,6 +12148,12 @@ module Aws::ECS
|
|
11315
12148
|
# definition.
|
11316
12149
|
# @return [Types::EphemeralStorage]
|
11317
12150
|
#
|
12151
|
+
# @!attribute [rw] enable_fault_injection
|
12152
|
+
# Enables fault injection and allows for fault injection requests to
|
12153
|
+
# be accepted from the task's containers. The default value is
|
12154
|
+
# `false`.
|
12155
|
+
# @return [Boolean]
|
12156
|
+
#
|
11318
12157
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TaskDefinition AWS API Documentation
|
11319
12158
|
#
|
11320
12159
|
class TaskDefinition < Struct.new(
|
@@ -11341,7 +12180,8 @@ module Aws::ECS
|
|
11341
12180
|
:registered_at,
|
11342
12181
|
:deregistered_at,
|
11343
12182
|
:registered_by,
|
11344
|
-
:ephemeral_storage
|
12183
|
+
:ephemeral_storage,
|
12184
|
+
:enable_fault_injection)
|
11345
12185
|
SENSITIVE = []
|
11346
12186
|
include Aws::Structure
|
11347
12187
|
end
|
@@ -12435,6 +13275,19 @@ module Aws::ECS
|
|
12435
13275
|
# tasks.
|
12436
13276
|
# @return [Types::DeploymentConfiguration]
|
12437
13277
|
#
|
13278
|
+
# @!attribute [rw] availability_zone_rebalancing
|
13279
|
+
# Indicates whether to use Availability Zone rebalancing for the
|
13280
|
+
# service.
|
13281
|
+
#
|
13282
|
+
# For more information, see [Balancing an Amazon ECS service across
|
13283
|
+
# Availability Zones][1] in the *Amazon Elastic Container Service
|
13284
|
+
# Developer Guide*.
|
13285
|
+
#
|
13286
|
+
#
|
13287
|
+
#
|
13288
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html
|
13289
|
+
# @return [String]
|
13290
|
+
#
|
12438
13291
|
# @!attribute [rw] network_configuration
|
12439
13292
|
# An object representing the network configuration for the service.
|
12440
13293
|
# @return [Types::NetworkConfiguration]
|
@@ -12486,16 +13339,18 @@ module Aws::ECS
|
|
12486
13339
|
#
|
12487
13340
|
# @!attribute [rw] health_check_grace_period_seconds
|
12488
13341
|
# The period of time, in seconds, that the Amazon ECS service
|
12489
|
-
# scheduler ignores unhealthy Elastic Load Balancing
|
12490
|
-
# checks after a task has first started.
|
12491
|
-
#
|
12492
|
-
#
|
12493
|
-
#
|
12494
|
-
#
|
12495
|
-
#
|
12496
|
-
#
|
12497
|
-
#
|
12498
|
-
#
|
13342
|
+
# scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and
|
13343
|
+
# container health checks after a task has first started. If you
|
13344
|
+
# don't specify a health check grace period value, the default value
|
13345
|
+
# of `0` is used. If you don't use any of the health checks, then
|
13346
|
+
# `healthCheckGracePeriodSeconds` is unused.
|
13347
|
+
#
|
13348
|
+
# If your service's tasks take a while to start and respond to health
|
13349
|
+
# checks, you can specify a health check grace period of up to
|
13350
|
+
# 2,147,483,647 seconds (about 69 years). During that time, the Amazon
|
13351
|
+
# ECS service scheduler ignores health check status. This grace period
|
13352
|
+
# can prevent the service scheduler from marking tasks as unhealthy
|
13353
|
+
# and stopping them before they have time to come up.
|
12499
13354
|
# @return [Integer]
|
12500
13355
|
#
|
12501
13356
|
# @!attribute [rw] enable_execute_command
|
@@ -12620,6 +13475,11 @@ module Aws::ECS
|
|
12620
13475
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html
|
12621
13476
|
# @return [Array<Types::ServiceVolumeConfiguration>]
|
12622
13477
|
#
|
13478
|
+
# @!attribute [rw] vpc_lattice_configurations
|
13479
|
+
# An object representing the VPC Lattice configuration for the service
|
13480
|
+
# being updated.
|
13481
|
+
# @return [Array<Types::VpcLatticeConfiguration>]
|
13482
|
+
#
|
12623
13483
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateServiceRequest AWS API Documentation
|
12624
13484
|
#
|
12625
13485
|
class UpdateServiceRequest < Struct.new(
|
@@ -12629,6 +13489,7 @@ module Aws::ECS
|
|
12629
13489
|
:task_definition,
|
12630
13490
|
:capacity_provider_strategy,
|
12631
13491
|
:deployment_configuration,
|
13492
|
+
:availability_zone_rebalancing,
|
12632
13493
|
:network_configuration,
|
12633
13494
|
:placement_constraints,
|
12634
13495
|
:placement_strategy,
|
@@ -12641,7 +13502,8 @@ module Aws::ECS
|
|
12641
13502
|
:propagate_tags,
|
12642
13503
|
:service_registries,
|
12643
13504
|
:service_connect_configuration,
|
12644
|
-
:volume_configurations
|
13505
|
+
:volume_configurations,
|
13506
|
+
:vpc_lattice_configurations)
|
12645
13507
|
SENSITIVE = []
|
12646
13508
|
include Aws::Structure
|
12647
13509
|
end
|
@@ -12911,6 +13773,38 @@ module Aws::ECS
|
|
12911
13773
|
include Aws::Structure
|
12912
13774
|
end
|
12913
13775
|
|
13776
|
+
# The VPC Lattice configuration for your service that holds the
|
13777
|
+
# information for the target group(s) Amazon ECS tasks will be
|
13778
|
+
# registered to.
|
13779
|
+
#
|
13780
|
+
# @!attribute [rw] role_arn
|
13781
|
+
# The ARN of the IAM role to associate with this VPC Lattice
|
13782
|
+
# configuration. This is the Amazon ECS
infrastructure IAM role that
|
13783
|
+
# is used to manage your VPC Lattice infrastructure.
|
13784
|
+
# @return [String]
|
13785
|
+
#
|
13786
|
+
# @!attribute [rw] target_group_arn
|
13787
|
+
# The full Amazon Resource Name (ARN) of the target group or groups
|
13788
|
+
# associated with the VPC Lattice configuration that the Amazon ECS
|
13789
|
+
# tasks will be registered to.
|
13790
|
+
# @return [String]
|
13791
|
+
#
|
13792
|
+
# @!attribute [rw] port_name
|
13793
|
+
# The name of the port mapping to register in the VPC Lattice target
|
13794
|
+
# group. This is the name of the `portMapping` you defined in your
|
13795
|
+
# task definition.
|
13796
|
+
# @return [String]
|
13797
|
+
#
|
13798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/VpcLatticeConfiguration AWS API Documentation
|
13799
|
+
#
|
13800
|
+
class VpcLatticeConfiguration < Struct.new(
|
13801
|
+
:role_arn,
|
13802
|
+
:target_group_arn,
|
13803
|
+
:port_name)
|
13804
|
+
SENSITIVE = []
|
13805
|
+
include Aws::Structure
|
13806
|
+
end
|
13807
|
+
|
12914
13808
|
end
|
12915
13809
|
end
|
12916
13810
|
|