lib/aws-sdk-ecs/client.rb in aws-sdk-ecs-1.148.0 vs lib/aws-sdk-ecs/client.rb in aws-sdk-ecs-1.149.0
- old
+ new
@@ -87,10 +87,15 @@
add_plugin(Aws::Plugins::Protocols::JsonRpc)
add_plugin(Aws::ECS::Plugins::Endpoints)
# @overload initialize(options)
# @param [Hash] options
+ #
+ # @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
+ # A list of plugins to apply to the client. Each plugin is either a
+ # class name or an instance of a plugin class.
+ #
# @option options [required, Aws::CredentialProvider] :credentials
# Your AWS credentials. This can be an instance of any one of the
# following classes:
#
# * `Aws::Credentials` - Used for configuring static, non-refreshing
@@ -207,11 +212,10 @@
#
# 'http://example.com'
# 'https://example.com'
# 'http://example.com:123'
#
- #
# @option options [Integer] :endpoint_cache_max_entries (1000)
# Used for the maximum size limit of the LRU cache storing endpoints data
# for endpoint discovery enabled operations. Defaults to 1000.
#
# @option options [Integer] :endpoint_cache_max_threads (10)
@@ -296,11 +300,10 @@
# * `adaptive` - An experimental retry mode that includes all the
# functionality of `standard` mode along with automatic client side
# throttling. This is a provisional mode that may change behavior
# in the future.
#
- #
# @option options [String] :sdk_ua_app_id
# A unique and opaque application ID that is appended to the
# User-Agent header as app/sdk_ua_app_id. It should have a
# maximum length of 50. This variable is sourced from environment
# variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
@@ -710,10 +713,14 @@
# s3_bucket_name: "String",
# s3_encryption_enabled: false,
# s3_key_prefix: "String",
# },
# },
+ # managed_storage_configuration: {
+ # kms_key_id: "String",
+ # fargate_ephemeral_storage_kms_key_id: "String",
+ # },
# },
# capacity_providers: ["String"],
# default_capacity_provider_strategy: [
# {
# capacity_provider: "String", # required
@@ -735,10 +742,12 @@
# resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_log_group_name #=> String
# resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_encryption_enabled #=> Boolean
# resp.cluster.configuration.execute_command_configuration.log_configuration.s3_bucket_name #=> String
# resp.cluster.configuration.execute_command_configuration.log_configuration.s3_encryption_enabled #=> Boolean
# resp.cluster.configuration.execute_command_configuration.log_configuration.s3_key_prefix #=> String
+ # resp.cluster.configuration.managed_storage_configuration.kms_key_id #=> String
+ # resp.cluster.configuration.managed_storage_configuration.fargate_ephemeral_storage_kms_key_id #=> String
# resp.cluster.status #=> String
# resp.cluster.registered_container_instances_count #=> Integer
# resp.cluster.running_tasks_count #=> Integer
# resp.cluster.pending_tasks_count #=> Integer
# resp.cluster.active_services_count #=> Integer
@@ -1617,10 +1626,11 @@
# resp.service.task_sets[0].stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
# resp.service.task_sets[0].stability_status_at #=> Time
# resp.service.task_sets[0].tags #=> Array
# resp.service.task_sets[0].tags[0].key #=> String
# resp.service.task_sets[0].tags[0].value #=> String
+ # resp.service.task_sets[0].fargate_ephemeral_storage.kms_key_id #=> String
# resp.service.deployments #=> Array
# resp.service.deployments[0].id #=> String
# resp.service.deployments[0].status #=> String
# resp.service.deployments[0].task_definition #=> String
# resp.service.deployments[0].desired_count #=> Integer
@@ -1681,10 +1691,11 @@
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].key #=> String
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].value #=> String
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.role_arn #=> String
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs"
+ # resp.service.deployments[0].fargate_ephemeral_storage.kms_key_id #=> String
# resp.service.role_arn #=> String
# resp.service.events #=> Array
# resp.service.events[0].id #=> String
# resp.service.events[0].created_at #=> Time
# resp.service.events[0].message #=> String
@@ -1958,10 +1969,11 @@
# resp.task_set.stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
# resp.task_set.stability_status_at #=> Time
# resp.task_set.tags #=> Array
# resp.task_set.tags[0].key #=> String
# resp.task_set.tags[0].value #=> String
+ # resp.task_set.fargate_ephemeral_storage.kms_key_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateTaskSet AWS API Documentation
#
# @overload create_task_set(params = {})
# @param [Hash] params ({})
@@ -2221,10 +2233,12 @@
# resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_log_group_name #=> String
# resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_encryption_enabled #=> Boolean
# resp.cluster.configuration.execute_command_configuration.log_configuration.s3_bucket_name #=> String
# resp.cluster.configuration.execute_command_configuration.log_configuration.s3_encryption_enabled #=> Boolean
# resp.cluster.configuration.execute_command_configuration.log_configuration.s3_key_prefix #=> String
+ # resp.cluster.configuration.managed_storage_configuration.kms_key_id #=> String
+ # resp.cluster.configuration.managed_storage_configuration.fargate_ephemeral_storage_kms_key_id #=> String
# resp.cluster.status #=> String
# resp.cluster.registered_container_instances_count #=> Integer
# resp.cluster.running_tasks_count #=> Integer
# resp.cluster.pending_tasks_count #=> Integer
# resp.cluster.active_services_count #=> Integer
@@ -2400,10 +2414,11 @@
# resp.service.task_sets[0].stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
# resp.service.task_sets[0].stability_status_at #=> Time
# resp.service.task_sets[0].tags #=> Array
# resp.service.task_sets[0].tags[0].key #=> String
# resp.service.task_sets[0].tags[0].value #=> String
+ # resp.service.task_sets[0].fargate_ephemeral_storage.kms_key_id #=> String
# resp.service.deployments #=> Array
# resp.service.deployments[0].id #=> String
# resp.service.deployments[0].status #=> String
# resp.service.deployments[0].task_definition #=> String
# resp.service.deployments[0].desired_count #=> Integer
@@ -2464,10 +2479,11 @@
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].key #=> String
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].value #=> String
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.role_arn #=> String
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs"
+ # resp.service.deployments[0].fargate_ephemeral_storage.kms_key_id #=> String
# resp.service.role_arn #=> String
# resp.service.events #=> Array
# resp.service.events[0].id #=> String
# resp.service.events[0].created_at #=> Time
# resp.service.events[0].message #=> String
@@ -2814,10 +2830,11 @@
# resp.task_set.stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
# resp.task_set.stability_status_at #=> Time
# resp.task_set.tags #=> Array
# resp.task_set.tags[0].key #=> String
# resp.task_set.tags[0].value #=> String
+ # resp.task_set.fargate_ephemeral_storage.kms_key_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteTaskSet AWS API Documentation
#
# @overload delete_task_set(params = {})
# @param [Hash] params ({})
@@ -3345,10 +3362,12 @@
# resp.clusters[0].configuration.execute_command_configuration.log_configuration.cloud_watch_log_group_name #=> String
# resp.clusters[0].configuration.execute_command_configuration.log_configuration.cloud_watch_encryption_enabled #=> Boolean
# resp.clusters[0].configuration.execute_command_configuration.log_configuration.s3_bucket_name #=> String
# resp.clusters[0].configuration.execute_command_configuration.log_configuration.s3_encryption_enabled #=> Boolean
# resp.clusters[0].configuration.execute_command_configuration.log_configuration.s3_key_prefix #=> String
+ # resp.clusters[0].configuration.managed_storage_configuration.kms_key_id #=> String
+ # resp.clusters[0].configuration.managed_storage_configuration.fargate_ephemeral_storage_kms_key_id #=> String
# resp.clusters[0].status #=> String
# resp.clusters[0].registered_container_instances_count #=> Integer
# resp.clusters[0].running_tasks_count #=> Integer
# resp.clusters[0].pending_tasks_count #=> Integer
# resp.clusters[0].active_services_count #=> Integer
@@ -3744,10 +3763,11 @@
# resp.services[0].task_sets[0].stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
# resp.services[0].task_sets[0].stability_status_at #=> Time
# resp.services[0].task_sets[0].tags #=> Array
# resp.services[0].task_sets[0].tags[0].key #=> String
# resp.services[0].task_sets[0].tags[0].value #=> String
+ # resp.services[0].task_sets[0].fargate_ephemeral_storage.kms_key_id #=> String
# resp.services[0].deployments #=> Array
# resp.services[0].deployments[0].id #=> String
# resp.services[0].deployments[0].status #=> String
# resp.services[0].deployments[0].task_definition #=> String
# resp.services[0].deployments[0].desired_count #=> Integer
@@ -3808,10 +3828,11 @@
# resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].key #=> String
# resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].value #=> String
# resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
# resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.role_arn #=> String
# resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs"
+ # resp.services[0].deployments[0].fargate_ephemeral_storage.kms_key_id #=> String
# resp.services[0].role_arn #=> String
# resp.services[0].events #=> Array
# resp.services[0].events[0].id #=> String
# resp.services[0].events[0].created_at #=> Time
# resp.services[0].events[0].message #=> String
@@ -4213,10 +4234,11 @@
# resp.task_sets[0].stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
# resp.task_sets[0].stability_status_at #=> Time
# resp.task_sets[0].tags #=> Array
# resp.task_sets[0].tags[0].key #=> String
# resp.task_sets[0].tags[0].value #=> String
+ # resp.task_sets[0].fargate_ephemeral_storage.kms_key_id #=> String
# resp.failures #=> Array
# resp.failures[0].arn #=> String
# resp.failures[0].reason #=> String
# resp.failures[0].detail #=> String
#
@@ -4422,10 +4444,12 @@
# resp.tasks[0].tags[0].value #=> String
# resp.tasks[0].task_arn #=> String
# resp.tasks[0].task_definition_arn #=> String
# resp.tasks[0].version #=> Integer
# resp.tasks[0].ephemeral_storage.size_in_gi_b #=> Integer
+ # resp.tasks[0].fargate_ephemeral_storage.size_in_gi_b #=> Integer
+ # resp.tasks[0].fargate_ephemeral_storage.kms_key_id #=> String
# resp.failures #=> Array
# resp.failures[0].arn #=> String
# resp.failures[0].reason #=> String
# resp.failures[0].detail #=> String
#
@@ -6133,10 +6157,12 @@
# resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_log_group_name #=> String
# resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_encryption_enabled #=> Boolean
# resp.cluster.configuration.execute_command_configuration.log_configuration.s3_bucket_name #=> String
# resp.cluster.configuration.execute_command_configuration.log_configuration.s3_encryption_enabled #=> Boolean
# resp.cluster.configuration.execute_command_configuration.log_configuration.s3_key_prefix #=> String
+ # resp.cluster.configuration.managed_storage_configuration.kms_key_id #=> String
+ # resp.cluster.configuration.managed_storage_configuration.fargate_ephemeral_storage_kms_key_id #=> String
# resp.cluster.status #=> String
# resp.cluster.registered_container_instances_count #=> Integer
# resp.cluster.running_tasks_count #=> Integer
# resp.cluster.pending_tasks_count #=> Integer
# resp.cluster.active_services_count #=> Integer
@@ -6727,13 +6753,10 @@
#
# @option params [Types::RuntimePlatform] :runtime_platform
# The operating system that your tasks definitions run on. A platform
# family is specified only for tasks using the Fargate launch type.
#
- # When you specify a task definition in a service, this value must match
- # the `runtimePlatform` value of the service.
- #
# @return [Types::RegisterTaskDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RegisterTaskDefinitionResponse#task_definition #task_definition} => Types::TaskDefinition
# * {Types::RegisterTaskDefinitionResponse#tags #tags} => Array<Types::Tag>
#
@@ -7770,10 +7793,12 @@
# resp.tasks[0].tags[0].value #=> String
# resp.tasks[0].task_arn #=> String
# resp.tasks[0].task_definition_arn #=> String
# resp.tasks[0].version #=> Integer
# resp.tasks[0].ephemeral_storage.size_in_gi_b #=> Integer
+ # resp.tasks[0].fargate_ephemeral_storage.size_in_gi_b #=> Integer
+ # resp.tasks[0].fargate_ephemeral_storage.kms_key_id #=> String
# resp.failures #=> Array
# resp.failures[0].arn #=> String
# resp.failures[0].reason #=> String
# resp.failures[0].detail #=> String
#
@@ -8143,10 +8168,12 @@
# resp.tasks[0].tags[0].value #=> String
# resp.tasks[0].task_arn #=> String
# resp.tasks[0].task_definition_arn #=> String
# resp.tasks[0].version #=> Integer
# resp.tasks[0].ephemeral_storage.size_in_gi_b #=> Integer
+ # resp.tasks[0].fargate_ephemeral_storage.size_in_gi_b #=> Integer
+ # resp.tasks[0].fargate_ephemeral_storage.kms_key_id #=> String
# resp.failures #=> Array
# resp.failures[0].arn #=> String
# resp.failures[0].reason #=> String
# resp.failures[0].detail #=> String
#
@@ -8167,20 +8194,26 @@
# `SIGTERM` value and a default 30-second timeout, after which the
# `SIGKILL` value is sent and the containers are forcibly stopped. If
# the container handles the `SIGTERM` value gracefully and exits within
# 30 seconds from receiving it, no `SIGKILL` value is sent.
#
+ # For Windows containers, POSIX signals do not work and runtime stops
+ # the container by sending a `CTRL_SHUTDOWN_EVENT`. For more
+ # information, see [Unable to react to graceful shutdown of (Windows)
+ # container #25982][1] on GitHub.
+ #
# <note markdown="1"> The default 30-second timeout can be configured on the Amazon ECS
# container agent with the `ECS_CONTAINER_STOP_TIMEOUT` variable. For
- # more information, see [Amazon ECS Container Agent Configuration][1] in
+ # more information, see [Amazon ECS Container Agent Configuration][2] in
# the *Amazon Elastic Container Service Developer Guide*.
#
# </note>
#
#
#
- # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html
+ # [1]: https://github.com/moby/moby/issues/25982
+ # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html
#
# @option params [String] :cluster
# The short name or full Amazon Resource Name (ARN) of the cluster that
# hosts the task to stop. If you do not specify a cluster, the default
# cluster is assumed.
@@ -8310,10 +8343,12 @@
# resp.task.tags[0].value #=> String
# resp.task.task_arn #=> String
# resp.task.task_definition_arn #=> String
# resp.task.version #=> Integer
# resp.task.ephemeral_storage.size_in_gi_b #=> Integer
+ # resp.task.fargate_ephemeral_storage.size_in_gi_b #=> Integer
+ # resp.task.fargate_ephemeral_storage.kms_key_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StopTask AWS API Documentation
#
# @overload stop_task(params = {})
# @param [Hash] params ({})
@@ -8777,10 +8812,14 @@
# s3_bucket_name: "String",
# s3_encryption_enabled: false,
# s3_key_prefix: "String",
# },
# },
+ # managed_storage_configuration: {
+ # kms_key_id: "String",
+ # fargate_ephemeral_storage_kms_key_id: "String",
+ # },
# },
# service_connect_defaults: {
# namespace: "String", # required
# },
# })
@@ -8794,10 +8833,12 @@
# resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_log_group_name #=> String
# resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_encryption_enabled #=> Boolean
# resp.cluster.configuration.execute_command_configuration.log_configuration.s3_bucket_name #=> String
# resp.cluster.configuration.execute_command_configuration.log_configuration.s3_encryption_enabled #=> Boolean
# resp.cluster.configuration.execute_command_configuration.log_configuration.s3_key_prefix #=> String
+ # resp.cluster.configuration.managed_storage_configuration.kms_key_id #=> String
+ # resp.cluster.configuration.managed_storage_configuration.fargate_ephemeral_storage_kms_key_id #=> String
# resp.cluster.status #=> String
# resp.cluster.registered_container_instances_count #=> Integer
# resp.cluster.running_tasks_count #=> Integer
# resp.cluster.pending_tasks_count #=> Integer
# resp.cluster.active_services_count #=> Integer
@@ -8878,10 +8919,12 @@
# resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_log_group_name #=> String
# resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_encryption_enabled #=> Boolean
# resp.cluster.configuration.execute_command_configuration.log_configuration.s3_bucket_name #=> String
# resp.cluster.configuration.execute_command_configuration.log_configuration.s3_encryption_enabled #=> Boolean
# resp.cluster.configuration.execute_command_configuration.log_configuration.s3_key_prefix #=> String
+ # resp.cluster.configuration.managed_storage_configuration.kms_key_id #=> String
+ # resp.cluster.configuration.managed_storage_configuration.fargate_ephemeral_storage_kms_key_id #=> String
# resp.cluster.status #=> String
# resp.cluster.registered_container_instances_count #=> Integer
# resp.cluster.running_tasks_count #=> Integer
# resp.cluster.pending_tasks_count #=> Integer
# resp.cluster.active_services_count #=> Integer
@@ -9806,10 +9849,11 @@
# resp.service.task_sets[0].stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
# resp.service.task_sets[0].stability_status_at #=> Time
# resp.service.task_sets[0].tags #=> Array
# resp.service.task_sets[0].tags[0].key #=> String
# resp.service.task_sets[0].tags[0].value #=> String
+ # resp.service.task_sets[0].fargate_ephemeral_storage.kms_key_id #=> String
# resp.service.deployments #=> Array
# resp.service.deployments[0].id #=> String
# resp.service.deployments[0].status #=> String
# resp.service.deployments[0].task_definition #=> String
# resp.service.deployments[0].desired_count #=> Integer
@@ -9870,10 +9914,11 @@
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].key #=> String
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].value #=> String
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.role_arn #=> String
# resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs"
+ # resp.service.deployments[0].fargate_ephemeral_storage.kms_key_id #=> String
# resp.service.role_arn #=> String
# resp.service.events #=> Array
# resp.service.events[0].id #=> String
# resp.service.events[0].created_at #=> Time
# resp.service.events[0].message #=> String
@@ -9986,10 +10031,11 @@
# resp.task_set.stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
# resp.task_set.stability_status_at #=> Time
# resp.task_set.tags #=> Array
# resp.task_set.tags[0].key #=> String
# resp.task_set.tags[0].value #=> String
+ # resp.task_set.fargate_ephemeral_storage.kms_key_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateServicePrimaryTaskSet AWS API Documentation
#
# @overload update_service_primary_task_set(params = {})
# @param [Hash] params ({})
@@ -10253,10 +10299,11 @@
# resp.task_set.stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
# resp.task_set.stability_status_at #=> Time
# resp.task_set.tags #=> Array
# resp.task_set.tags[0].key #=> String
# resp.task_set.tags[0].value #=> String
+ # resp.task_set.fargate_ephemeral_storage.kms_key_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateTaskSet AWS API Documentation
#
# @overload update_task_set(params = {})
# @param [Hash] params ({})
@@ -10276,10 +10323,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-ecs'
- context[:gem_version] = '1.148.0'
+ context[:gem_version] = '1.149.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#