aws-sdk-ecs 1.164.0 → 1.166.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ecs/client.rb +362 -50
- data/lib/aws-sdk-ecs/client_api.rb +184 -1
- data/lib/aws-sdk-ecs/types.rb +805 -71
- data/lib/aws-sdk-ecs.rb +1 -1
- data/sig/client.rbs +49 -8
- data/sig/types.rbs +137 -3
- metadata +2 -2
data/lib/aws-sdk-ecs/types.rb
CHANGED
@@ -1940,6 +1940,45 @@ module Aws::ECS
|
|
1940
1940
|
include Aws::Structure
|
1941
1941
|
end
|
1942
1942
|
|
1943
|
+
# The details about the container image a service revision uses.
|
1944
|
+
#
|
1945
|
+
# To ensure that all tasks in a service use the same container image,
|
1946
|
+
# Amazon ECS resolves container image names and any image tags specified
|
1947
|
+
# in the task definition to container image digests.
|
1948
|
+
#
|
1949
|
+
# After the container image digest has been established, Amazon ECS uses
|
1950
|
+
# the digest to start any other desired tasks, and for any future
|
1951
|
+
# service and service revision updates. This leads to all tasks in a
|
1952
|
+
# service always running identical container images, resulting in
|
1953
|
+
# version consistency for your software. For more information, see
|
1954
|
+
# [Container image resolution][1] in the Amazon ECS Developer Guide.
|
1955
|
+
#
|
1956
|
+
#
|
1957
|
+
#
|
1958
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability
|
1959
|
+
#
|
1960
|
+
# @!attribute [rw] container_name
|
1961
|
+
# The name of the container.
|
1962
|
+
# @return [String]
|
1963
|
+
#
|
1964
|
+
# @!attribute [rw] image_digest
|
1965
|
+
# The container image digest.
|
1966
|
+
# @return [String]
|
1967
|
+
#
|
1968
|
+
# @!attribute [rw] image
|
1969
|
+
# The container image.
|
1970
|
+
# @return [String]
|
1971
|
+
#
|
1972
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerImage AWS API Documentation
|
1973
|
+
#
|
1974
|
+
class ContainerImage < Struct.new(
|
1975
|
+
:container_name,
|
1976
|
+
:image_digest,
|
1977
|
+
:image)
|
1978
|
+
SENSITIVE = []
|
1979
|
+
include Aws::Structure
|
1980
|
+
end
|
1981
|
+
|
1943
1982
|
# An Amazon EC2 or External instance that's running the Amazon ECS
|
1944
1983
|
# agent and has been registered with a cluster.
|
1945
1984
|
#
|
@@ -2746,8 +2785,7 @@ module Aws::ECS
|
|
2746
2785
|
#
|
2747
2786
|
# @!attribute [rw] deployment_configuration
|
2748
2787
|
# Optional deployment parameters that control how many tasks run
|
2749
|
-
# during the deployment and the
|
2750
|
-
# tasks.
|
2788
|
+
# during the deployment and the failure detection methods.
|
2751
2789
|
# @return [Types::DeploymentConfiguration]
|
2752
2790
|
#
|
2753
2791
|
# @!attribute [rw] placement_constraints
|
@@ -3165,6 +3203,30 @@ module Aws::ECS
|
|
3165
3203
|
include Aws::Structure
|
3166
3204
|
end
|
3167
3205
|
|
3206
|
+
# The optional filter to narrow the `ListServiceDeployment` results.
|
3207
|
+
#
|
3208
|
+
# If you do not specify a value, service deployments that were created
|
3209
|
+
# before the current time are included in the result.
|
3210
|
+
#
|
3211
|
+
# @!attribute [rw] before
|
3212
|
+
# Include service deployments in the result that were created before
|
3213
|
+
# this time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
|
3214
|
+
# @return [Time]
|
3215
|
+
#
|
3216
|
+
# @!attribute [rw] after
|
3217
|
+
# Include service deployments in the result that were created after
|
3218
|
+
# this time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
|
3219
|
+
# @return [Time]
|
3220
|
+
#
|
3221
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreatedAt AWS API Documentation
|
3222
|
+
#
|
3223
|
+
class CreatedAt < Struct.new(
|
3224
|
+
:before,
|
3225
|
+
:after)
|
3226
|
+
SENSITIVE = []
|
3227
|
+
include Aws::Structure
|
3228
|
+
end
|
3229
|
+
|
3168
3230
|
# @!attribute [rw] name
|
3169
3231
|
# The resource name to disable the account setting for. If
|
3170
3232
|
# `serviceLongArnFormat` is specified, the ARN for your Amazon ECS
|
@@ -3632,11 +3694,6 @@ module Aws::ECS
|
|
3632
3694
|
# alarms.
|
3633
3695
|
# @return [Array<String>]
|
3634
3696
|
#
|
3635
|
-
# @!attribute [rw] enable
|
3636
|
-
# Determines whether to use the CloudWatch alarm option in the service
|
3637
|
-
# deployment process.
|
3638
|
-
# @return [Boolean]
|
3639
|
-
#
|
3640
3697
|
# @!attribute [rw] rollback
|
3641
3698
|
# Determines whether to configure Amazon ECS to roll back the service
|
3642
3699
|
# if a service deployment fails. If rollback is used, when a service
|
@@ -3644,12 +3701,17 @@ module Aws::ECS
|
|
3644
3701
|
# that completed successfully.
|
3645
3702
|
# @return [Boolean]
|
3646
3703
|
#
|
3704
|
+
# @!attribute [rw] enable
|
3705
|
+
# Determines whether to use the CloudWatch alarm option in the service
|
3706
|
+
# deployment process.
|
3707
|
+
# @return [Boolean]
|
3708
|
+
#
|
3647
3709
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeploymentAlarms AWS API Documentation
|
3648
3710
|
#
|
3649
3711
|
class DeploymentAlarms < Struct.new(
|
3650
3712
|
:alarm_names,
|
3651
|
-
:
|
3652
|
-
:
|
3713
|
+
:rollback,
|
3714
|
+
:enable)
|
3653
3715
|
SENSITIVE = []
|
3654
3716
|
include Aws::Structure
|
3655
3717
|
end
|
@@ -3697,7 +3759,7 @@ module Aws::ECS
|
|
3697
3759
|
end
|
3698
3760
|
|
3699
3761
|
# Optional deployment parameters that control how many tasks run during
|
3700
|
-
#
|
3762
|
+
# the deployment and the failure detection methods.
|
3701
3763
|
#
|
3702
3764
|
# @!attribute [rw] deployment_circuit_breaker
|
3703
3765
|
# <note markdown="1"> The deployment circuit breaker can only be used for services using
|
@@ -3895,8 +3957,8 @@ module Aws::ECS
|
|
3895
3957
|
# The amount of ephemeral storage to allocate for the deployment.
|
3896
3958
|
#
|
3897
3959
|
# @!attribute [rw] kms_key_id
|
3898
|
-
# Specify an Key Management Service key ID to
|
3899
|
-
# storage for deployment.
|
3960
|
+
# Specify an Amazon Web Services Key Management Service key ID to
|
3961
|
+
# encrypt the ephemeral storage for deployment.
|
3900
3962
|
# @return [String]
|
3901
3963
|
#
|
3902
3964
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeploymentEphemeralStorage AWS API Documentation
|
@@ -4167,6 +4229,78 @@ module Aws::ECS
|
|
4167
4229
|
include Aws::Structure
|
4168
4230
|
end
|
4169
4231
|
|
4232
|
+
# @!attribute [rw] service_deployment_arns
|
4233
|
+
# The ARN of the service deployment.
|
4234
|
+
#
|
4235
|
+
# You can specify a maximum of 20 ARNs.
|
4236
|
+
# @return [Array<String>]
|
4237
|
+
#
|
4238
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServiceDeploymentsRequest AWS API Documentation
|
4239
|
+
#
|
4240
|
+
class DescribeServiceDeploymentsRequest < Struct.new(
|
4241
|
+
:service_deployment_arns)
|
4242
|
+
SENSITIVE = []
|
4243
|
+
include Aws::Structure
|
4244
|
+
end
|
4245
|
+
|
4246
|
+
# @!attribute [rw] service_deployments
|
4247
|
+
# The list of service deployments described.
|
4248
|
+
# @return [Array<Types::ServiceDeployment>]
|
4249
|
+
#
|
4250
|
+
# @!attribute [rw] failures
|
4251
|
+
# Any failures associated with the call.
|
4252
|
+
#
|
4253
|
+
# If you decsribe a deployment with a service revision created before
|
4254
|
+
# October 25, 2024, the call fails. The failure includes the service
|
4255
|
+
# revision ARN and the reason set to `MISSING`.
|
4256
|
+
# @return [Array<Types::Failure>]
|
4257
|
+
#
|
4258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServiceDeploymentsResponse AWS API Documentation
|
4259
|
+
#
|
4260
|
+
class DescribeServiceDeploymentsResponse < Struct.new(
|
4261
|
+
:service_deployments,
|
4262
|
+
:failures)
|
4263
|
+
SENSITIVE = []
|
4264
|
+
include Aws::Structure
|
4265
|
+
end
|
4266
|
+
|
4267
|
+
# @!attribute [rw] service_revision_arns
|
4268
|
+
# The ARN of the service revision.
|
4269
|
+
#
|
4270
|
+
# You can specify a maximum of 20 ARNs.
|
4271
|
+
#
|
4272
|
+
# You can call [ListServiceDeployments][1] to get the ARNs.
|
4273
|
+
#
|
4274
|
+
#
|
4275
|
+
#
|
4276
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServiceDeployments.html
|
4277
|
+
# @return [Array<String>]
|
4278
|
+
#
|
4279
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServiceRevisionsRequest AWS API Documentation
|
4280
|
+
#
|
4281
|
+
class DescribeServiceRevisionsRequest < Struct.new(
|
4282
|
+
:service_revision_arns)
|
4283
|
+
SENSITIVE = []
|
4284
|
+
include Aws::Structure
|
4285
|
+
end
|
4286
|
+
|
4287
|
+
# @!attribute [rw] service_revisions
|
4288
|
+
# The list of service revisions described.
|
4289
|
+
# @return [Array<Types::ServiceRevision>]
|
4290
|
+
#
|
4291
|
+
# @!attribute [rw] failures
|
4292
|
+
# Any failures associated with the call.
|
4293
|
+
# @return [Array<Types::Failure>]
|
4294
|
+
#
|
4295
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServiceRevisionsResponse AWS API Documentation
|
4296
|
+
#
|
4297
|
+
class DescribeServiceRevisionsResponse < Struct.new(
|
4298
|
+
:service_revisions,
|
4299
|
+
:failures)
|
4300
|
+
SENSITIVE = []
|
4301
|
+
include Aws::Structure
|
4302
|
+
end
|
4303
|
+
|
4170
4304
|
# @!attribute [rw] cluster
|
4171
4305
|
# The short name or full Amazon Resource Name (ARN)the cluster that
|
4172
4306
|
# hosts the service to describe. If you do not specify a cluster, the
|
@@ -5222,7 +5356,7 @@ module Aws::ECS
|
|
5222
5356
|
#
|
5223
5357
|
# An exit code of 0 indicates success, and non-zero exit code
|
5224
5358
|
# indicates failure. For more information, see `HealthCheck` in the
|
5225
|
-
# docker container create command
|
5359
|
+
# docker container create command.
|
5226
5360
|
# @return [Array<String>]
|
5227
5361
|
#
|
5228
5362
|
# @!attribute [rw] interval
|
@@ -5922,6 +6056,103 @@ module Aws::ECS
|
|
5922
6056
|
include Aws::Structure
|
5923
6057
|
end
|
5924
6058
|
|
6059
|
+
# @!attribute [rw] service
|
6060
|
+
# The ARN or name of the service
|
6061
|
+
# @return [String]
|
6062
|
+
#
|
6063
|
+
# @!attribute [rw] cluster
|
6064
|
+
# The cluster that hosts the service. This can either be the cluster
|
6065
|
+
# name or ARN. Starting April 15, 2023, Amazon Web Services will not
|
6066
|
+
# onboard new customers to Amazon Elastic Inference (EI), and will
|
6067
|
+
# help current customers migrate their workloads to options that offer
|
6068
|
+
# better price and performanceIf you don't specify a cluster,
|
6069
|
+
# `deault` is used.
|
6070
|
+
# @return [String]
|
6071
|
+
#
|
6072
|
+
# @!attribute [rw] status
|
6073
|
+
# An optional filter you can use to narrow the results. If you do not
|
6074
|
+
# specify a status, then all status values are included in the result.
|
6075
|
+
# @return [Array<String>]
|
6076
|
+
#
|
6077
|
+
# @!attribute [rw] created_at
|
6078
|
+
# An optional filter you can use to narrow the results by the service
|
6079
|
+
# creation date. If you do not specify a value, the result includes
|
6080
|
+
# all services created before the current time. The format is
|
6081
|
+
# yyyy-MM-dd HH:mm:ss.SSSSSS.
|
6082
|
+
# @return [Types::CreatedAt]
|
6083
|
+
#
|
6084
|
+
# @!attribute [rw] next_token
|
6085
|
+
# The `nextToken` value returned from a `ListServiceDeployments`
|
6086
|
+
# request indicating that more results are available to fulfill the
|
6087
|
+
# request and further calls are needed. If you provided `maxResults`,
|
6088
|
+
# it's possible the number of results is fewer than `maxResults`.
|
6089
|
+
# @return [String]
|
6090
|
+
#
|
6091
|
+
# @!attribute [rw] max_results
|
6092
|
+
# The maximum number of service deployment results that
|
6093
|
+
# `ListServiceDeployments` returned in paginated output. When this
|
6094
|
+
# parameter is used, `ListServiceDeployments` only returns
|
6095
|
+
# `maxResults` results in a single page along with a `nextToken`
|
6096
|
+
# response element. The remaining results of the initial request can
|
6097
|
+
# be seen by sending another `ListServiceDeployments` request with the
|
6098
|
+
# returned `nextToken` value. This value can be between 1 and 100. If
|
6099
|
+
# this parameter isn't used, then `ListServiceDeployments` returns up
|
6100
|
+
# to 20 results and a `nextToken` value if applicable.
|
6101
|
+
# @return [Integer]
|
6102
|
+
#
|
6103
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListServiceDeploymentsRequest AWS API Documentation
|
6104
|
+
#
|
6105
|
+
class ListServiceDeploymentsRequest < Struct.new(
|
6106
|
+
:service,
|
6107
|
+
:cluster,
|
6108
|
+
:status,
|
6109
|
+
:created_at,
|
6110
|
+
:next_token,
|
6111
|
+
:max_results)
|
6112
|
+
SENSITIVE = []
|
6113
|
+
include Aws::Structure
|
6114
|
+
end
|
6115
|
+
|
6116
|
+
# @!attribute [rw] service_deployments
|
6117
|
+
# An overview of the service deployment, including the following
|
6118
|
+
# properties:
|
6119
|
+
#
|
6120
|
+
# * The ARN of the service deployment.
|
6121
|
+
#
|
6122
|
+
# * The ARN of the service being deployed.
|
6123
|
+
#
|
6124
|
+
# * The ARN of the cluster that hosts the service in the service
|
6125
|
+
# deployment.
|
6126
|
+
#
|
6127
|
+
# * The time that the service deployment started.
|
6128
|
+
#
|
6129
|
+
# * The time that the service deployment completed.
|
6130
|
+
#
|
6131
|
+
# * The service deployment status.
|
6132
|
+
#
|
6133
|
+
# * Information about why the service deployment is in the current
|
6134
|
+
# state.
|
6135
|
+
#
|
6136
|
+
# * The ARN of the service revision that is being deployed.
|
6137
|
+
# @return [Array<Types::ServiceDeploymentBrief>]
|
6138
|
+
#
|
6139
|
+
# @!attribute [rw] next_token
|
6140
|
+
# The `nextToken` value to include in a future
|
6141
|
+
# `ListServiceDeployments` request. When the results of a
|
6142
|
+
# `ListServiceDeployments` request exceed `maxResults`, this value can
|
6143
|
+
# be used to retrieve the next page of results. This value is null
|
6144
|
+
# when there are no more results to return.
|
6145
|
+
# @return [String]
|
6146
|
+
#
|
6147
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListServiceDeploymentsResponse AWS API Documentation
|
6148
|
+
#
|
6149
|
+
class ListServiceDeploymentsResponse < Struct.new(
|
6150
|
+
:service_deployments,
|
6151
|
+
:next_token)
|
6152
|
+
SENSITIVE = []
|
6153
|
+
include Aws::Structure
|
6154
|
+
end
|
6155
|
+
|
5925
6156
|
# @!attribute [rw] namespace
|
5926
6157
|
# The namespace name or full Amazon Resource Name (ARN) of the Cloud
|
5927
6158
|
# Map namespace to list the services in.
|
@@ -6417,8 +6648,8 @@ module Aws::ECS
|
|
6417
6648
|
# @return [String]
|
6418
6649
|
#
|
6419
6650
|
# @!attribute [rw] load_balancer_name
|
6420
|
-
# The name of the load balancer to associate with the
|
6421
|
-
#
|
6651
|
+
# The name of the load balancer to associate with the service or task
|
6652
|
+
# set.
|
6422
6653
|
#
|
6423
6654
|
# If you are using an Application Load Balancer or a Network Load
|
6424
6655
|
# Balancer the load balancer name parameter should be omitted.
|
@@ -6838,9 +7069,8 @@ module Aws::ECS
|
|
6838
7069
|
#
|
6839
7070
|
# @!attribute [rw] minimum_scaling_step_size
|
6840
7071
|
# The minimum number of Amazon EC2 instances that Amazon ECS will
|
6841
|
-
# scale out at one time.
|
6842
|
-
#
|
6843
|
-
# used.
|
7072
|
+
# scale out at one time. If this parameter is omitted, the default
|
7073
|
+
# value of `1` is used.
|
6844
7074
|
#
|
6845
7075
|
# When additional capacity is required, Amazon ECS will scale up the
|
6846
7076
|
# minimum scaling step size even if the actual demand is less than the
|
@@ -6881,8 +7111,8 @@ module Aws::ECS
|
|
6881
7111
|
# The managed storage configuration for the cluster.
|
6882
7112
|
#
|
6883
7113
|
# @!attribute [rw] kms_key_id
|
6884
|
-
# Specify a Key Management Service key ID to
|
6885
|
-
# storage.
|
7114
|
+
# Specify a Amazon Web Services Key Management Service key ID to
|
7115
|
+
# encrypt the managed storage.
|
6886
7116
|
# @return [String]
|
6887
7117
|
#
|
6888
7118
|
# @!attribute [rw] fargate_ephemeral_storage_kms_key_id
|
@@ -7219,13 +7449,14 @@ module Aws::ECS
|
|
7219
7449
|
#
|
7220
7450
|
class PlatformUnknownException < Aws::EmptyStructure; end
|
7221
7451
|
|
7222
|
-
# Port mappings
|
7223
|
-
#
|
7224
|
-
#
|
7452
|
+
# Port mappings expose your container's network ports to the outside
|
7453
|
+
# world. this allows clients to access your application. It's also used
|
7454
|
+
# for inter-container communication within the same task.
|
7225
7455
|
#
|
7226
|
-
#
|
7227
|
-
# mode, specify the
|
7228
|
-
#
|
7456
|
+
# For task definitions (both the Fargate and EC2 launch type) that use
|
7457
|
+
# the `awsvpc` network mode, only specify the `containerPort`. The
|
7458
|
+
# `hostPort` is always ignored, and the container port is automatically
|
7459
|
+
# mapped to a random high-numbered port on the host.
|
7229
7460
|
#
|
7230
7461
|
# Most fields of this parameter (`containerPort`, `hostPort`,
|
7231
7462
|
# `protocol`) maps to `PortBindings` in the docker container create
|
@@ -7250,15 +7481,19 @@ module Aws::ECS
|
|
7250
7481
|
# The port number on the container that's bound to the user-specified
|
7251
7482
|
# or automatically assigned host port.
|
7252
7483
|
#
|
7253
|
-
#
|
7254
|
-
# mode,
|
7255
|
-
#
|
7256
|
-
#
|
7257
|
-
#
|
7258
|
-
#
|
7259
|
-
#
|
7260
|
-
#
|
7261
|
-
#
|
7484
|
+
# For tasks that use the Fargate launch type or EC2 tasks that use the
|
7485
|
+
# `awsvpc` network mode, you use `containerPort` to specify the
|
7486
|
+
# exposed ports.
|
7487
|
+
#
|
7488
|
+
# For Windows containers on Fargate, you can't use port 3150 for the
|
7489
|
+
# `containerPort`. This is because it's reserved.
|
7490
|
+
#
|
7491
|
+
# Suppose that you're using containers in a task with the EC2 launch
|
7492
|
+
# type and you specify a container port and not a host port. Then,
|
7493
|
+
# your container automatically receives a host port in the ephemeral
|
7494
|
+
# port range. For more information, see `hostPort`. Port mappings that
|
7495
|
+
# are automatically assigned in this way don't count toward the 100
|
7496
|
+
# reserved ports quota of a container instance.
|
7262
7497
|
# @return [Integer]
|
7263
7498
|
#
|
7264
7499
|
# @!attribute [rw] host_port
|
@@ -8091,19 +8326,22 @@ module Aws::ECS
|
|
8091
8326
|
# non-root user.
|
8092
8327
|
#
|
8093
8328
|
# If the network mode is `awsvpc`, the task is allocated an elastic
|
8094
|
-
# network interface, and you must specify a
|
8095
|
-
#
|
8096
|
-
#
|
8097
|
-
#
|
8329
|
+
# network interface, and you must specify a NetworkConfiguration value
|
8330
|
+
# when you create a service or run a task with the task definition.
|
8331
|
+
# For more information, see [Task Networking][1] in the *Amazon
|
8332
|
+
# Elastic Container Service Developer Guide*.
|
8098
8333
|
#
|
8099
8334
|
# If the network mode is `host`, you cannot run multiple
|
8100
8335
|
# instantiations of the same task on a single container instance when
|
8101
8336
|
# port mappings are used.
|
8102
8337
|
#
|
8338
|
+
# For more information, see [Network settings][2] in the *Docker run
|
8339
|
+
# reference*.
|
8340
|
+
#
|
8103
8341
|
#
|
8104
8342
|
#
|
8105
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/
|
8106
|
-
# [2]: https://docs.
|
8343
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
8344
|
+
# [2]: https://docs.docker.com/engine/reference/run/#network-settings
|
8107
8345
|
# @return [String]
|
8108
8346
|
#
|
8109
8347
|
# @!attribute [rw] container_definitions
|
@@ -8276,10 +8514,12 @@ module Aws::ECS
|
|
8276
8514
|
# share the same process namespace.
|
8277
8515
|
#
|
8278
8516
|
# If no value is specified, the default is a private namespace for
|
8279
|
-
# each container.
|
8517
|
+
# each container. For more information, see [PID settings][1] in the
|
8518
|
+
# *Docker run reference*.
|
8280
8519
|
#
|
8281
8520
|
# If the `host` PID mode is used, there's a heightened risk of
|
8282
|
-
# undesired process namespace exposure.
|
8521
|
+
# undesired process namespace exposure. For more information, see
|
8522
|
+
# [Docker security][2].
|
8283
8523
|
#
|
8284
8524
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
8285
8525
|
#
|
@@ -8290,6 +8530,11 @@ module Aws::ECS
|
|
8290
8530
|
# (Linux). This isn't supported for Windows containers on Fargate.
|
8291
8531
|
#
|
8292
8532
|
# </note>
|
8533
|
+
#
|
8534
|
+
#
|
8535
|
+
#
|
8536
|
+
# [1]: https://docs.docker.com/engine/reference/run/#pid-settings---pid
|
8537
|
+
# [2]: https://docs.docker.com/engine/security/security/
|
8293
8538
|
# @return [String]
|
8294
8539
|
#
|
8295
8540
|
# @!attribute [rw] ipc_mode
|
@@ -8303,15 +8548,17 @@ module Aws::ECS
|
|
8303
8548
|
# containers of a task are private and not shared with other
|
8304
8549
|
# containers in a task or on the container instance. If no value is
|
8305
8550
|
# specified, then the IPC resource namespace sharing depends on the
|
8306
|
-
# Docker daemon setting on the container instance.
|
8551
|
+
# Docker daemon setting on the container instance. For more
|
8552
|
+
# information, see [IPC settings][1] in the *Docker run reference*.
|
8307
8553
|
#
|
8308
8554
|
# If the `host` IPC mode is used, be aware that there is a heightened
|
8309
|
-
# risk of undesired IPC namespace expose.
|
8555
|
+
# risk of undesired IPC namespace expose. For more information, see
|
8556
|
+
# [Docker security][2].
|
8310
8557
|
#
|
8311
8558
|
# If you are setting namespaced kernel parameters using
|
8312
8559
|
# `systemControls` for the containers in the task, the following will
|
8313
8560
|
# apply to your IPC resource namespace. For more information, see
|
8314
|
-
# [System Controls][
|
8561
|
+
# [System Controls][3] in the *Amazon Elastic Container Service
|
8315
8562
|
# Developer Guide*.
|
8316
8563
|
#
|
8317
8564
|
# * For tasks that use the `host` IPC mode, IPC namespace related
|
@@ -8327,7 +8574,9 @@ module Aws::ECS
|
|
8327
8574
|
#
|
8328
8575
|
#
|
8329
8576
|
#
|
8330
|
-
# [1]: https://docs.
|
8577
|
+
# [1]: https://docs.docker.com/engine/reference/run/#ipc-settings---ipc
|
8578
|
+
# [2]: https://docs.docker.com/engine/security/security/
|
8579
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html
|
8331
8580
|
# @return [String]
|
8332
8581
|
#
|
8333
8582
|
# @!attribute [rw] proxy_configuration
|
@@ -8541,6 +8790,46 @@ module Aws::ECS
|
|
8541
8790
|
include Aws::Structure
|
8542
8791
|
end
|
8543
8792
|
|
8793
|
+
# Information about the service deployment rollback.
|
8794
|
+
#
|
8795
|
+
# @!attribute [rw] reason
|
8796
|
+
# The reason the rollback happened. For example, the circuit breaker
|
8797
|
+
# initiated the rollback operation.
|
8798
|
+
# @return [String]
|
8799
|
+
#
|
8800
|
+
# @!attribute [rw] started_at
|
8801
|
+
# Time time that the rollback started. The format is yyyy-MM-dd
|
8802
|
+
# HH:mm:ss.SSSSSS.
|
8803
|
+
# @return [Time]
|
8804
|
+
#
|
8805
|
+
# @!attribute [rw] service_revision_arn
|
8806
|
+
# The ARN of the service revision deployed as part of the rollback.
|
8807
|
+
#
|
8808
|
+
# When the type is `GPU`, the value is the number of physical `GPUs`
|
8809
|
+
# the Amazon ECS container agent reserves for the container. The
|
8810
|
+
# number of GPUs that's reserved for all containers in a task can't
|
8811
|
+
# exceed the number of available GPUs on the container instance that
|
8812
|
+
# the task is launched on.
|
8813
|
+
#
|
8814
|
+
# When the type is `InferenceAccelerator`, the `value` matches the
|
8815
|
+
# `deviceName` for an [InferenceAccelerator][1] specified in a task
|
8816
|
+
# definition.
|
8817
|
+
#
|
8818
|
+
#
|
8819
|
+
#
|
8820
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html
|
8821
|
+
# @return [String]
|
8822
|
+
#
|
8823
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Rollback AWS API Documentation
|
8824
|
+
#
|
8825
|
+
class Rollback < Struct.new(
|
8826
|
+
:reason,
|
8827
|
+
:started_at,
|
8828
|
+
:service_revision_arn)
|
8829
|
+
SENSITIVE = []
|
8830
|
+
include Aws::Structure
|
8831
|
+
end
|
8832
|
+
|
8544
8833
|
# @!attribute [rw] capacity_provider_strategy
|
8545
8834
|
# The capacity provider strategy to use for the task.
|
8546
8835
|
#
|
@@ -8866,10 +9155,14 @@ module Aws::ECS
|
|
8866
9155
|
# You can run your Linux tasks on an ARM-based platform by setting the
|
8867
9156
|
# value to `ARM64`. This option is available for tasks that run on
|
8868
9157
|
# Linux Amazon EC2 instance or Linux containers on Fargate.
|
9158
|
+
#
|
9159
|
+
# The default is `X86_64`.
|
8869
9160
|
# @return [String]
|
8870
9161
|
#
|
8871
9162
|
# @!attribute [rw] operating_system_family
|
8872
9163
|
# The operating system.
|
9164
|
+
#
|
9165
|
+
# The default is `Linux`.
|
8873
9166
|
# @return [String]
|
8874
9167
|
#
|
8875
9168
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RuntimePlatform AWS API Documentation
|
@@ -9043,9 +9336,9 @@ module Aws::ECS
|
|
9043
9336
|
# @return [String]
|
9044
9337
|
#
|
9045
9338
|
# @!attribute [rw] capacity_provider_strategy
|
9046
|
-
# The capacity provider strategy the service uses. When using
|
9047
|
-
# DescribeServices
|
9048
|
-
#
|
9339
|
+
# The capacity provider strategy the service uses. When using
|
9340
|
+
# `DescribeServices`, this field is omitted if the service was created
|
9341
|
+
# using a launch type.
|
9049
9342
|
# @return [Array<Types::CapacityProviderStrategyItem>]
|
9050
9343
|
#
|
9051
9344
|
# @!attribute [rw] platform_version
|
@@ -9168,7 +9461,7 @@ module Aws::ECS
|
|
9168
9461
|
# @!attribute [rw] tags
|
9169
9462
|
# The metadata that you apply to the service to help you categorize
|
9170
9463
|
# and organize them. Each tag consists of a key and an optional value.
|
9171
|
-
# You define
|
9464
|
+
# You define both the key and value.
|
9172
9465
|
#
|
9173
9466
|
# The following basic restrictions apply to tags:
|
9174
9467
|
#
|
@@ -9594,6 +9887,268 @@ module Aws::ECS
|
|
9594
9887
|
include Aws::Structure
|
9595
9888
|
end
|
9596
9889
|
|
9890
|
+
# Information about the service deployment.
|
9891
|
+
#
|
9892
|
+
# Service deployments provide a comprehensive view of your deployments.
|
9893
|
+
# For information about service deployments, see [View service history
|
9894
|
+
# using Amazon ECS service deployments][1] in the <i> <i>Amazon Elastic
|
9895
|
+
# Container Service Developer Guide</i> </i>.
|
9896
|
+
#
|
9897
|
+
#
|
9898
|
+
#
|
9899
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-deployment.html
|
9900
|
+
#
|
9901
|
+
# @!attribute [rw] service_deployment_arn
|
9902
|
+
# The ARN of the service deployment.
|
9903
|
+
# @return [String]
|
9904
|
+
#
|
9905
|
+
# @!attribute [rw] service_arn
|
9906
|
+
# The ARN of the service for this service deployment.
|
9907
|
+
# @return [String]
|
9908
|
+
#
|
9909
|
+
# @!attribute [rw] cluster_arn
|
9910
|
+
# The ARN of the cluster that hosts the service.
|
9911
|
+
# @return [String]
|
9912
|
+
#
|
9913
|
+
# @!attribute [rw] created_at
|
9914
|
+
# The time the service deployment was created. The format is
|
9915
|
+
# yyyy-MM-dd HH:mm:ss.SSSSSS.
|
9916
|
+
# @return [Time]
|
9917
|
+
#
|
9918
|
+
# @!attribute [rw] started_at
|
9919
|
+
# The time the service deployment statred. The format is yyyy-MM-dd
|
9920
|
+
# HH:mm:ss.SSSSSS.
|
9921
|
+
# @return [Time]
|
9922
|
+
#
|
9923
|
+
# @!attribute [rw] finished_at
|
9924
|
+
# The time the service deployment finished. The format is yyyy-MM-dd
|
9925
|
+
# HH:mm:ss.SSSSSS.
|
9926
|
+
# @return [Time]
|
9927
|
+
#
|
9928
|
+
# @!attribute [rw] stopped_at
|
9929
|
+
# The time the service deployment stopped. The format is yyyy-MM-dd
|
9930
|
+
# HH:mm:ss.SSSSSS.
|
9931
|
+
#
|
9932
|
+
# The service deployment stops when any of the following actions
|
9933
|
+
# happen:
|
9934
|
+
#
|
9935
|
+
# * A user manually stops the deployment
|
9936
|
+
#
|
9937
|
+
# * The rollback option is not in use for the failure detection
|
9938
|
+
# mechanism (the circuit breaker or alarm-based) and the service
|
9939
|
+
# fails.
|
9940
|
+
# @return [Time]
|
9941
|
+
#
|
9942
|
+
# @!attribute [rw] updated_at
|
9943
|
+
# The time that the service deployment was last updated. The format is
|
9944
|
+
# yyyy-MM-dd HH:mm:ss.SSSSSS.
|
9945
|
+
# @return [Time]
|
9946
|
+
#
|
9947
|
+
# @!attribute [rw] source_service_revisions
|
9948
|
+
# The currently deployed workload configuration.
|
9949
|
+
# @return [Array<Types::ServiceRevisionSummary>]
|
9950
|
+
#
|
9951
|
+
# @!attribute [rw] target_service_revision
|
9952
|
+
# The workload configuration being deployed.
|
9953
|
+
# @return [Types::ServiceRevisionSummary]
|
9954
|
+
#
|
9955
|
+
# @!attribute [rw] status
|
9956
|
+
# The service deployment state.
|
9957
|
+
# @return [String]
|
9958
|
+
#
|
9959
|
+
# @!attribute [rw] status_reason
|
9960
|
+
# Information about why the service deployment is in the current
|
9961
|
+
# status. For example, the circuit breaker detected a failure.
|
9962
|
+
# @return [String]
|
9963
|
+
#
|
9964
|
+
# @!attribute [rw] deployment_configuration
|
9965
|
+
# Optional deployment parameters that control how many tasks run
|
9966
|
+
# during the deployment and the failure detection methods.
|
9967
|
+
# @return [Types::DeploymentConfiguration]
|
9968
|
+
#
|
9969
|
+
# @!attribute [rw] rollback
|
9970
|
+
# The rollback options the service deployment uses when the deployment
|
9971
|
+
# fails.
|
9972
|
+
# @return [Types::Rollback]
|
9973
|
+
#
|
9974
|
+
# @!attribute [rw] deployment_circuit_breaker
|
9975
|
+
# The circuit breaker configuration that determines a service
|
9976
|
+
# deployment failed.
|
9977
|
+
# @return [Types::ServiceDeploymentCircuitBreaker]
|
9978
|
+
#
|
9979
|
+
# @!attribute [rw] alarms
|
9980
|
+
# The CloudWatch alarms that determine when a service deployment
|
9981
|
+
# fails.
|
9982
|
+
# @return [Types::ServiceDeploymentAlarms]
|
9983
|
+
#
|
9984
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceDeployment AWS API Documentation
|
9985
|
+
#
|
9986
|
+
class ServiceDeployment < Struct.new(
|
9987
|
+
:service_deployment_arn,
|
9988
|
+
:service_arn,
|
9989
|
+
:cluster_arn,
|
9990
|
+
:created_at,
|
9991
|
+
:started_at,
|
9992
|
+
:finished_at,
|
9993
|
+
:stopped_at,
|
9994
|
+
:updated_at,
|
9995
|
+
:source_service_revisions,
|
9996
|
+
:target_service_revision,
|
9997
|
+
:status,
|
9998
|
+
:status_reason,
|
9999
|
+
:deployment_configuration,
|
10000
|
+
:rollback,
|
10001
|
+
:deployment_circuit_breaker,
|
10002
|
+
:alarms)
|
10003
|
+
SENSITIVE = []
|
10004
|
+
include Aws::Structure
|
10005
|
+
end
|
10006
|
+
|
10007
|
+
# The CloudWatch alarms used to determine a service deployment failed.
|
10008
|
+
#
|
10009
|
+
# Amazon ECS considers the service deployment as failed when any of the
|
10010
|
+
# alarms move to the `ALARM` state. For more information, see [How
|
10011
|
+
# CloudWatch alarms detect Amazon ECS deployment failures][1] in the
|
10012
|
+
# Amazon ECS Developer Guide.
|
10013
|
+
#
|
10014
|
+
#
|
10015
|
+
#
|
10016
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-alarm-failure.html
|
10017
|
+
#
|
10018
|
+
# @!attribute [rw] status
|
10019
|
+
# The status of the alarms check. Amazon ECS is not using alarms for
|
10020
|
+
# service deployment failures when the status is `DISABLED`.
|
10021
|
+
# @return [String]
|
10022
|
+
#
|
10023
|
+
# @!attribute [rw] alarm_names
|
10024
|
+
# The name of the CloudWatch alarms that determine when a service
|
10025
|
+
# deployment failed. A "," separates the alarms.
|
10026
|
+
# @return [Array<String>]
|
10027
|
+
#
|
10028
|
+
# @!attribute [rw] triggered_alarm_names
|
10029
|
+
# One or more CloudWatch alarm names that have been triggered during
|
10030
|
+
# the service deployment. A "," separates the alarm names.
|
10031
|
+
# @return [Array<String>]
|
10032
|
+
#
|
10033
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceDeploymentAlarms AWS API Documentation
|
10034
|
+
#
|
10035
|
+
class ServiceDeploymentAlarms < Struct.new(
|
10036
|
+
:status,
|
10037
|
+
:alarm_names,
|
10038
|
+
:triggered_alarm_names)
|
10039
|
+
SENSITIVE = []
|
10040
|
+
include Aws::Structure
|
10041
|
+
end
|
10042
|
+
|
10043
|
+
# The service deployment properties that are retured when you call
|
10044
|
+
# `ListServiceDeployments`.
|
10045
|
+
#
|
10046
|
+
# This provides a high-level overview of the service deployment.
|
10047
|
+
#
|
10048
|
+
# @!attribute [rw] service_deployment_arn
|
10049
|
+
# The ARN of the service deployment.
|
10050
|
+
# @return [String]
|
10051
|
+
#
|
10052
|
+
# @!attribute [rw] service_arn
|
10053
|
+
# The ARN of the service for this service deployment.
|
10054
|
+
# @return [String]
|
10055
|
+
#
|
10056
|
+
# @!attribute [rw] cluster_arn
|
10057
|
+
# The ARN of the cluster that hosts the service.
|
10058
|
+
# @return [String]
|
10059
|
+
#
|
10060
|
+
# @!attribute [rw] started_at
|
10061
|
+
# The time that the service deployment statred. The format is
|
10062
|
+
# yyyy-MM-dd HH:mm:ss.SSSSSS.
|
10063
|
+
# @return [Time]
|
10064
|
+
#
|
10065
|
+
# @!attribute [rw] created_at
|
10066
|
+
# The time that the service deployment was created. The format is
|
10067
|
+
# yyyy-MM-dd HH:mm:ss.SSSSSS.
|
10068
|
+
# @return [Time]
|
10069
|
+
#
|
10070
|
+
# @!attribute [rw] finished_at
|
10071
|
+
# The time that the service deployment completed. The format is
|
10072
|
+
# yyyy-MM-dd HH:mm:ss.SSSSSS.
|
10073
|
+
# @return [Time]
|
10074
|
+
#
|
10075
|
+
# @!attribute [rw] target_service_revision_arn
|
10076
|
+
# The ARN of the service revision being deplyed.
|
10077
|
+
# @return [String]
|
10078
|
+
#
|
10079
|
+
# @!attribute [rw] status
|
10080
|
+
# The status of the service deployment
|
10081
|
+
# @return [String]
|
10082
|
+
#
|
10083
|
+
# @!attribute [rw] status_reason
|
10084
|
+
# Information about why the service deployment is in the current
|
10085
|
+
# status. For example, the circuit breaker detected a deployment
|
10086
|
+
# failure.
|
10087
|
+
# @return [String]
|
10088
|
+
#
|
10089
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceDeploymentBrief AWS API Documentation
|
10090
|
+
#
|
10091
|
+
class ServiceDeploymentBrief < Struct.new(
|
10092
|
+
:service_deployment_arn,
|
10093
|
+
:service_arn,
|
10094
|
+
:cluster_arn,
|
10095
|
+
:started_at,
|
10096
|
+
:created_at,
|
10097
|
+
:finished_at,
|
10098
|
+
:target_service_revision_arn,
|
10099
|
+
:status,
|
10100
|
+
:status_reason)
|
10101
|
+
SENSITIVE = []
|
10102
|
+
include Aws::Structure
|
10103
|
+
end
|
10104
|
+
|
10105
|
+
# Information about the circuit breaker used to determine when a service
|
10106
|
+
# deployment has failed.
|
10107
|
+
#
|
10108
|
+
# The deployment circuit breaker is the rolling update mechanism that
|
10109
|
+
# determines if the tasks reach a steady state. The deployment circuit
|
10110
|
+
# breaker has an option that will automatically roll back a failed
|
10111
|
+
# deployment to the last cpompleted service revision. For more
|
10112
|
+
# information, see [How the Amazon ECS deployment circuit breaker
|
10113
|
+
# detects failures][1] in the<i> Amazon ECS Developer Guide</i>.
|
10114
|
+
#
|
10115
|
+
#
|
10116
|
+
#
|
10117
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-circuit-breaker.html
|
10118
|
+
#
|
10119
|
+
# @!attribute [rw] status
|
10120
|
+
# The circuit breaker status. Amazon ECS is not using the circuit
|
10121
|
+
# breaker for service deployment failures when the status is
|
10122
|
+
# `DISABLED`.
|
10123
|
+
# @return [String]
|
10124
|
+
#
|
10125
|
+
# @!attribute [rw] failure_count
|
10126
|
+
# The number of times the circuit breaker detected a service
|
10127
|
+
# deploymeny failure.
|
10128
|
+
# @return [Integer]
|
10129
|
+
#
|
10130
|
+
# @!attribute [rw] threshold
|
10131
|
+
# The threshhold which determines that the service deployment failed.
|
10132
|
+
#
|
10133
|
+
# The deployment circuit breaker calculates the threshold value, and
|
10134
|
+
# then uses the value to determine when to move the deployment to a
|
10135
|
+
# FAILED state. The deployment circuit breaker has a minimum threshold
|
10136
|
+
# of 3 and a maximum threshold of 200. and uses the values in the
|
10137
|
+
# following formula to determine the deployment failure.
|
10138
|
+
#
|
10139
|
+
# `0.5 * desired task count`
|
10140
|
+
# @return [Integer]
|
10141
|
+
#
|
10142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceDeploymentCircuitBreaker AWS API Documentation
|
10143
|
+
#
|
10144
|
+
class ServiceDeploymentCircuitBreaker < Struct.new(
|
10145
|
+
:status,
|
10146
|
+
:failure_count,
|
10147
|
+
:threshold)
|
10148
|
+
SENSITIVE = []
|
10149
|
+
include Aws::Structure
|
10150
|
+
end
|
10151
|
+
|
9597
10152
|
# The details for an event that's associated with a service.
|
9598
10153
|
#
|
9599
10154
|
# @!attribute [rw] id
|
@@ -9621,11 +10176,18 @@ module Aws::ECS
|
|
9621
10176
|
# The configuration for the Amazon EBS volume that Amazon ECS creates
|
9622
10177
|
# and manages on your behalf. These settings are used to create each
|
9623
10178
|
# Amazon EBS volume, with one volume created for each task in the
|
9624
|
-
# service.
|
10179
|
+
# service. For information about the supported launch types and
|
10180
|
+
# operating systems, see [Supported operating systems and launch
|
10181
|
+
# types][1] in the<i> Amazon Elastic Container Service Developer
|
10182
|
+
# Guide</i>.
|
9625
10183
|
#
|
9626
10184
|
# Many of these parameters map 1:1 with the Amazon EBS `CreateVolume`
|
9627
10185
|
# API request parameters.
|
9628
10186
|
#
|
10187
|
+
#
|
10188
|
+
#
|
10189
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volumes-configuration
|
10190
|
+
#
|
9629
10191
|
# @!attribute [rw] encrypted
|
9630
10192
|
# Indicates whether the volume should be encrypted. If no value is
|
9631
10193
|
# specified, encryption is turned on by default. This parameter maps
|
@@ -9784,13 +10346,16 @@ module Aws::ECS
|
|
9784
10346
|
# @return [String]
|
9785
10347
|
#
|
9786
10348
|
# @!attribute [rw] filesystem_type
|
9787
|
-
# The
|
10349
|
+
# The filesystem type for the volume. For volumes created from a
|
9788
10350
|
# snapshot, you must specify the same filesystem type that the volume
|
9789
10351
|
# was using when the snapshot was created. If there is a filesystem
|
9790
10352
|
# type mismatch, the task will fail to start.
|
9791
10353
|
#
|
9792
|
-
# The available filesystem types are
`ext3`, `ext4`, and `xfs`.
|
9793
|
-
# value is specified, the `xfs` filesystem type is used by
|
10354
|
+
# The available Linux filesystem types are
`ext3`, `ext4`, and `xfs`.
|
10355
|
+
# If no value is specified, the `xfs` filesystem type is used by
|
10356
|
+
# default.
|
10357
|
+
#
|
10358
|
+
# The available Windows filesystem types are `NTFS`.
|
9794
10359
|
# @return [String]
|
9795
10360
|
#
|
9796
10361
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceManagedEBSVolumeConfiguration AWS API Documentation
|
@@ -9894,6 +10459,162 @@ module Aws::ECS
|
|
9894
10459
|
include Aws::Structure
|
9895
10460
|
end
|
9896
10461
|
|
10462
|
+
# Information about the service revision.
|
10463
|
+
#
|
10464
|
+
# A service revision contains a record of the workload configuration
|
10465
|
+
# Amazon ECS is attempting to deploy. Whenever you create or deploy a
|
10466
|
+
# service, Amazon ECS automatically creates and captures the
|
10467
|
+
# configuration that you're trying to deploy in the service revision.
|
10468
|
+
# For information about service revisions, see [Amazon ECS service
|
10469
|
+
# revisions][1] in the <i> <i>Amazon Elastic Container Service Developer
|
10470
|
+
# Guide</i> </i>.
|
10471
|
+
#
|
10472
|
+
#
|
10473
|
+
#
|
10474
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-revision.html
|
10475
|
+
#
|
10476
|
+
# @!attribute [rw] service_revision_arn
|
10477
|
+
# The ARN of the service revision.
|
10478
|
+
# @return [String]
|
10479
|
+
#
|
10480
|
+
# @!attribute [rw] service_arn
|
10481
|
+
# The ARN of the service for the service revision.
|
10482
|
+
# @return [String]
|
10483
|
+
#
|
10484
|
+
# @!attribute [rw] cluster_arn
|
10485
|
+
# The ARN of the cluster that hosts the service.
|
10486
|
+
# @return [String]
|
10487
|
+
#
|
10488
|
+
# @!attribute [rw] task_definition
|
10489
|
+
# The task definition the service revision uses.
|
10490
|
+
# @return [String]
|
10491
|
+
#
|
10492
|
+
# @!attribute [rw] capacity_provider_strategy
|
10493
|
+
# The capacity provider strategy the service revision uses.
|
10494
|
+
# @return [Array<Types::CapacityProviderStrategyItem>]
|
10495
|
+
#
|
10496
|
+
# @!attribute [rw] launch_type
|
10497
|
+
# The launch type the service revision uses.
|
10498
|
+
# @return [String]
|
10499
|
+
#
|
10500
|
+
# @!attribute [rw] platform_version
|
10501
|
+
# For the Fargate launch type, the platform version the service
|
10502
|
+
# revision uses.
|
10503
|
+
# @return [String]
|
10504
|
+
#
|
10505
|
+
# @!attribute [rw] platform_family
|
10506
|
+
# The platform family the service revision uses.
|
10507
|
+
# @return [String]
|
10508
|
+
#
|
10509
|
+
# @!attribute [rw] load_balancers
|
10510
|
+
# The load balancers the service revision uses.
|
10511
|
+
# @return [Array<Types::LoadBalancer>]
|
10512
|
+
#
|
10513
|
+
# @!attribute [rw] service_registries
|
10514
|
+
# The service registries (for Service Discovery) the service revision
|
10515
|
+
# uses.
|
10516
|
+
# @return [Array<Types::ServiceRegistry>]
|
10517
|
+
#
|
10518
|
+
# @!attribute [rw] network_configuration
|
10519
|
+
# The network configuration for a task or service.
|
10520
|
+
# @return [Types::NetworkConfiguration]
|
10521
|
+
#
|
10522
|
+
# @!attribute [rw] container_images
|
10523
|
+
# The container images the service revision uses.
|
10524
|
+
# @return [Array<Types::ContainerImage>]
|
10525
|
+
#
|
10526
|
+
# @!attribute [rw] guard_duty_enabled
|
10527
|
+
# Indicates whether Runtime Monitoring is turned on.
|
10528
|
+
# @return [Boolean]
|
10529
|
+
#
|
10530
|
+
# @!attribute [rw] service_connect_configuration
|
10531
|
+
# The Service Connect configuration of your Amazon ECS service. The
|
10532
|
+
# configuration for this service to discover and connect to services,
|
10533
|
+
# and be discovered by, and connected from, other services within a
|
10534
|
+
# namespace.
|
10535
|
+
#
|
10536
|
+
# Tasks that run in a namespace can use short names to connect to
|
10537
|
+
# services in the namespace. Tasks can connect to services across all
|
10538
|
+
# of the clusters in the namespace. Tasks connect through a managed
|
10539
|
+
# proxy container that collects logs and metrics for increased
|
10540
|
+
# visibility. Only the tasks that Amazon ECS services create are
|
10541
|
+
# supported with Service Connect. For more information, see [Service
|
10542
|
+
# Connect][1] in the *Amazon Elastic Container Service Developer
|
10543
|
+
# Guide*.
|
10544
|
+
#
|
10545
|
+
#
|
10546
|
+
#
|
10547
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html
|
10548
|
+
# @return [Types::ServiceConnectConfiguration]
|
10549
|
+
#
|
10550
|
+
# @!attribute [rw] volume_configurations
|
10551
|
+
# The volumes that are configured at deployment that the service
|
10552
|
+
# revision uses.
|
10553
|
+
# @return [Array<Types::ServiceVolumeConfiguration>]
|
10554
|
+
#
|
10555
|
+
# @!attribute [rw] fargate_ephemeral_storage
|
10556
|
+
# The amount of ephemeral storage to allocate for the deployment.
|
10557
|
+
# @return [Types::DeploymentEphemeralStorage]
|
10558
|
+
#
|
10559
|
+
# @!attribute [rw] created_at
|
10560
|
+
# The time that the service revision was created. The format is
|
10561
|
+
# yyyy-mm-dd HH:mm:ss.SSSSS.
|
10562
|
+
# @return [Time]
|
10563
|
+
#
|
10564
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceRevision AWS API Documentation
|
10565
|
+
#
|
10566
|
+
class ServiceRevision < Struct.new(
|
10567
|
+
:service_revision_arn,
|
10568
|
+
:service_arn,
|
10569
|
+
:cluster_arn,
|
10570
|
+
:task_definition,
|
10571
|
+
:capacity_provider_strategy,
|
10572
|
+
:launch_type,
|
10573
|
+
:platform_version,
|
10574
|
+
:platform_family,
|
10575
|
+
:load_balancers,
|
10576
|
+
:service_registries,
|
10577
|
+
:network_configuration,
|
10578
|
+
:container_images,
|
10579
|
+
:guard_duty_enabled,
|
10580
|
+
:service_connect_configuration,
|
10581
|
+
:volume_configurations,
|
10582
|
+
:fargate_ephemeral_storage,
|
10583
|
+
:created_at)
|
10584
|
+
SENSITIVE = []
|
10585
|
+
include Aws::Structure
|
10586
|
+
end
|
10587
|
+
|
10588
|
+
# The information about the number of requested, pending, and running
|
10589
|
+
# tasks for a service revision.
|
10590
|
+
#
|
10591
|
+
# @!attribute [rw] arn
|
10592
|
+
# The ARN of the service revision.
|
10593
|
+
# @return [String]
|
10594
|
+
#
|
10595
|
+
# @!attribute [rw] requested_task_count
|
10596
|
+
# The number of requested tasks for the service revision.
|
10597
|
+
# @return [Integer]
|
10598
|
+
#
|
10599
|
+
# @!attribute [rw] running_task_count
|
10600
|
+
# The number of running tasks for the service revision.
|
10601
|
+
# @return [Integer]
|
10602
|
+
#
|
10603
|
+
# @!attribute [rw] pending_task_count
|
10604
|
+
# The number of pending tasks for the service revision.
|
10605
|
+
# @return [Integer]
|
10606
|
+
#
|
10607
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceRevisionSummary AWS API Documentation
|
10608
|
+
#
|
10609
|
+
class ServiceRevisionSummary < Struct.new(
|
10610
|
+
:arn,
|
10611
|
+
:requested_task_count,
|
10612
|
+
:running_task_count,
|
10613
|
+
:pending_task_count)
|
10614
|
+
SENSITIVE = []
|
10615
|
+
include Aws::Structure
|
10616
|
+
end
|
10617
|
+
|
9897
10618
|
# The configuration for a volume specified in the task definition as a
|
9898
10619
|
# volume that is configured at launch time. Currently, the only
|
9899
10620
|
# supported volume type is an Amazon EBS volume.
|
@@ -11019,19 +11740,22 @@ module Aws::ECS
|
|
11019
11740
|
# non-root user.
|
11020
11741
|
#
|
11021
11742
|
# If the network mode is `awsvpc`, the task is allocated an elastic
|
11022
|
-
# network interface, and you must specify a
|
11023
|
-
#
|
11024
|
-
#
|
11025
|
-
#
|
11743
|
+
# network interface, and you must specify a NetworkConfiguration value
|
11744
|
+
# when you create a service or run a task with the task definition.
|
11745
|
+
# For more information, see [Task Networking][1] in the *Amazon
|
11746
|
+
# Elastic Container Service Developer Guide*.
|
11026
11747
|
#
|
11027
11748
|
# If the network mode is `host`, you cannot run multiple
|
11028
11749
|
# instantiations of the same task on a single container instance when
|
11029
11750
|
# port mappings are used.
|
11030
11751
|
#
|
11752
|
+
# For more information, see [Network settings][2] in the *Docker run
|
11753
|
+
# reference*.
|
11754
|
+
#
|
11031
11755
|
#
|
11032
11756
|
#
|
11033
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/
|
11034
|
-
# [2]: https://docs.
|
11757
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
11758
|
+
# [2]: https://docs.docker.com/engine/reference/run/#network-settings
|
11035
11759
|
# @return [String]
|
11036
11760
|
#
|
11037
11761
|
# @!attribute [rw] revision
|
@@ -11226,10 +11950,12 @@ module Aws::ECS
|
|
11226
11950
|
# share the same process namespace.
|
11227
11951
|
#
|
11228
11952
|
# If no value is specified, the default is a private namespace for
|
11229
|
-
# each container.
|
11953
|
+
# each container. For more information, see [PID settings][1] in the
|
11954
|
+
# *Docker run reference*.
|
11230
11955
|
#
|
11231
11956
|
# If the `host` PID mode is used, there's a heightened risk of
|
11232
|
-
# undesired process namespace exposure.
|
11957
|
+
# undesired process namespace exposure. For more information, see
|
11958
|
+
# [Docker security][2].
|
11233
11959
|
#
|
11234
11960
|
# <note markdown="1"> This parameter is not supported for Windows containers.
|
11235
11961
|
#
|
@@ -11240,6 +11966,11 @@ module Aws::ECS
|
|
11240
11966
|
# (Linux). This isn't supported for Windows containers on Fargate.
|
11241
11967
|
#
|
11242
11968
|
# </note>
|
11969
|
+
#
|
11970
|
+
#
|
11971
|
+
#
|
11972
|
+
# [1]: https://docs.docker.com/engine/reference/run/#pid-settings---pid
|
11973
|
+
# [2]: https://docs.docker.com/engine/security/security/
|
11243
11974
|
# @return [String]
|
11244
11975
|
#
|
11245
11976
|
# @!attribute [rw] ipc_mode
|
@@ -11253,15 +11984,17 @@ module Aws::ECS
|
|
11253
11984
|
# containers of a task are private and not shared with other
|
11254
11985
|
# containers in a task or on the container instance. If no value is
|
11255
11986
|
# specified, then the IPC resource namespace sharing depends on the
|
11256
|
-
# Docker daemon setting on the container instance.
|
11987
|
+
# Docker daemon setting on the container instance. For more
|
11988
|
+
# information, see [IPC settings][1] in the *Docker run reference*.
|
11257
11989
|
#
|
11258
11990
|
# If the `host` IPC mode is used, be aware that there is a heightened
|
11259
|
-
# risk of undesired IPC namespace expose.
|
11991
|
+
# risk of undesired IPC namespace expose. For more information, see
|
11992
|
+
# [Docker security][2].
|
11260
11993
|
#
|
11261
11994
|
# If you are setting namespaced kernel parameters using
|
11262
11995
|
# `systemControls` for the containers in the task, the following will
|
11263
11996
|
# apply to your IPC resource namespace. For more information, see
|
11264
|
-
# [System Controls][
|
11997
|
+
# [System Controls][3] in the *Amazon Elastic Container Service
|
11265
11998
|
# Developer Guide*.
|
11266
11999
|
#
|
11267
12000
|
# * For tasks that use the `host` IPC mode, IPC namespace related
|
@@ -11277,7 +12010,9 @@ module Aws::ECS
|
|
11277
12010
|
#
|
11278
12011
|
#
|
11279
12012
|
#
|
11280
|
-
# [1]: https://docs.
|
12013
|
+
# [1]: https://docs.docker.com/engine/reference/run/#ipc-settings---ipc
|
12014
|
+
# [2]: https://docs.docker.com/engine/security/security/
|
12015
|
+
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html
|
11281
12016
|
# @return [String]
|
11282
12017
|
#
|
11283
12018
|
# @!attribute [rw] proxy_configuration
|
@@ -11392,8 +12127,8 @@ module Aws::ECS
|
|
11392
12127
|
# @return [Integer]
|
11393
12128
|
#
|
11394
12129
|
# @!attribute [rw] kms_key_id
|
11395
|
-
# Specify an Key Management Service key ID to
|
11396
|
-
# storage for the task.
|
12130
|
+
# Specify an Amazon Web Services Key Management Service key ID to
|
12131
|
+
# encrypt the ephemeral storage for the task.
|
11397
12132
|
# @return [String]
|
11398
12133
|
#
|
11399
12134
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TaskEphemeralStorage AWS API Documentation
|
@@ -12432,8 +13167,7 @@ module Aws::ECS
|
|
12432
13167
|
#
|
12433
13168
|
# @!attribute [rw] deployment_configuration
|
12434
13169
|
# Optional deployment parameters that control how many tasks run
|
12435
|
-
# during the deployment and the
|
12436
|
-
# tasks.
|
13170
|
+
# during the deployment and the failure detection methods.
|
12437
13171
|
# @return [Types::DeploymentConfiguration]
|
12438
13172
|
#
|
12439
13173
|
# @!attribute [rw] network_configuration
|