Spec-Zone.ru › AWS CLI v2

[ aws . ecs ]

delete-service

Описание

Удаляет указанную службу в кластере. Вы можете удалить службу, если в ней нет запущенных задач, и желаемое количество задач равно нулю. Если служба активно поддерживает задачи, вы не можете её удалить, и вы должны обновить службу до желаемого количества задач, равного нулю. Для получения дополнительной информации см. UpdateService.

Примечание

При удалении службы, если по-прежнему есть запущенные задачи, требующие очистки, статус службы переходит от ACTIVE к DRAINING, и служба больше не отображается в консоли или в операции API ListServices. После того, как все задачи перейдут в состояние STOPPING или STOPPED, статус службы переходит от DRAINING к INACTIVE. Службы в состоянии DRAINING или INACTIVE по-прежнему можно просмотреть с помощью операции API DescribeServices. Однако в будущем службы в состоянии INACTIVE могут быть очищены и удалены из регистрации Amazon ECS, и вызовы DescribeServices для этих служб возвращают ошибку ServiceNotFoundException.

Предупреждение

Если вы попытаетесь создать новую службу с тем же именем, что и существующая служба в состоянии ACTIVE или DRAINING, вы получите ошибку.

См. также: Документация AWS API

Синтаксис

  delete-service
[--cluster <value>]
--service <value>
[--force | --no-force]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--cluster (строка)

Короткое имя или полное Amazon Resource Name (ARN) кластера, который содержит службу для удаления. Если вы не указываете кластер, используется кластер по умолчанию.

--service (строка)

Имя службы для удаления.

--force | --no-force (булево)

Если true, позволяет удалить службу, даже если она не была масштабирована до нуля задач. Это необходимо только в том случае, если служба использует стратегию планирования REPLICA.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные через JSON. Невозможно передать произвольные двоичные значения, используя значение, предоставленное через JSON, так как строка будет воспринята буквально. Это нельзя указать вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если не указано значение или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, будет напечатан пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, оно проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (булево)

Включить отладовую регистрацию.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (булево)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки config/env.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл с пакетом сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки config/env.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный, и будут использоваться содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить пейджер cli для вывода.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в справочнике пользователя AWS CLI.

Если не указано иное, все примеры имеют правила цитирования, подобные Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной среды. См. Использование кавычек со строками в справочнике пользователя AWS CLI.

Для удаления службы

Следующий ecs delete-service пример удаляет указанную службу из кластера. Вы можете включить параметр --force для удаления службы, даже если она не была масштабирована до нуля задач.

aws ecs delete-service --cluster MyCluster --service MyService1 --force

Для получения дополнительной информации см. Удаление службы в Руководстве разработчика Amazon ECS.

Вывод

service -> (структура)

Полное описание удаленной службы.

serviceArn -> (строка)

Идентификатор службы ARN. Для получения дополнительной информации о формате ARN см. Amazon Resource Name (ARN) в руководстве разработчика Amazon ECS .

serviceName -> (строка)

Имя вашей службы. Допускается до 255 букв (строчные и прописные), цифр, символов подчеркивания и дефисов. Имена служб должны быть уникальными в кластере. Однако вы можете иметь службы с одинаковыми именами в нескольких кластерах в одном регионе или в нескольких регионах.

clusterArn -> (строка)

Amazon Resource Name (ARN) кластера, который предоставляет службу.

loadBalancers -> (список)

Список объектов балансировщиков нагрузки Elastic Load Balancing. Он содержит имя балансировщика нагрузки, имя контейнера и порт контейнера для доступа из балансировщика нагрузки. Имя контейнера соответствует имени в определении контейнера.

(структура)

Настройка балансировщика нагрузки для использования со службой или набором задач.

При добавлении, обновлении или удалении конфигурации балансировщика нагрузки Amazon ECS запускает новый процесс развертывания с обновленной конфигурацией Elastic Load Balancing. Это приводит к регистрации и отмене регистрации задач в балансировщиках нагрузки.

Рекомендуется проверить это в тестовой среде перед обновлением конфигурации Elastic Load Balancing.

Для служб, использующих несколько целевых групп, требуется роль службы. Дополнительные сведения см. в разделе Использование ролей службы в руководстве разработчика Amazon Elastic Container Service .

targetGroupArn -> (строка)

Полный Amazon Resource Name (ARN) целевой группы или групп Elastic Load Balancing, связанных со службой или набором задач.

ARN целевой группы указывается только при использовании балансировщика приложений или балансировщика сети.

Для служб, использующих ECS контроллер развертывания, можно указать одну или несколько целевых групп. Дополнительные сведения см. в разделе Регистрация нескольких целевых групп со службой в руководстве разработчика Amazon Elastic Container Service .

Для служб, использующих CODE_DEPLOY контроллер развертывания, необходимо определить две целевые группы для балансировщика. Дополнительные сведения см. в разделе Развертывание "синий/зеленый" с CodeDeploy в руководстве разработчика Amazon Elastic Container Service .

Предупреждение

Если определение задачи вашей службы использует режим сети awsvpc , необходимо выбрать ip в качестве типа целевой группы, а не instance . Сделайте это при создании целевых групп, поскольку задачи, использующие режим сети awsvpc , связаны с интерфейсом эластичной сети, а не с экземпляром Amazon EC2. Этот режим сети требуется для типа запуска Fargate.

loadBalancerName -> (строка)

Имя балансировщика нагрузки, который необходимо связать со службой Amazon ECS или набором задач.

Если вы используете балансировщик приложений или балансировщик сети, параметр имени балансировщика нагрузки следует опустить.

containerName -> (строка)

Имя контейнера (как оно указано в определении контейнера), которое необходимо связать с балансировщиком нагрузки.

Имя контейнера необходимо указать при конфигурировании целевой группы для балансировщика Amazon ECS.

containerPort -> (целое число)

Порт в контейнере, который необходимо связать с балансировщиком нагрузки. Этот порт должен соответствовать containerPort в определении задачи, используемом задачами в службе. Для задач, использующих тип запуска EC2, экземпляр контейнера, на котором они запускаются, должен разрешать входящий трафик на hostPort сопоставления портов.

serviceRegistries -> (список)

Подробная информация о реестрах обнаружения служб для назначения этой службе. Дополнительные сведения см. в разделе Обнаружение служб.

(структура)

Подробная информация о реестре служб.

Каждая служба может быть связана с одним реестром служб. Несколько реестров служб для каждой службы не поддерживаются.

При добавлении, обновлении или удалении конфигурации реестров служб Amazon ECS запускает новый процесс развертывания. Новые задачи регистрируются и отменяют регистрацию в обновленной конфигурации реестра служб.

registryArn -> (строка)

Amazon Resource Name (ARN) реестра служб. В настоящее время поддерживается реестр служб Cloud Map. Дополнительные сведения см. в CreateService .

port -> (целое число)

Значение порта, используемое, если служба обнаружения служб указала запись SRV. Этот параметр может быть использован, если используются как режим сети awsvpc , так и записи SRV.

containerName -> (строка)

Значение имени контейнера, используемое для вашей службы обнаружения служб. Оно уже указано в определении задачи. Если определение задачи вашей задачи службы использует режим сети bridge или host , необходимо указать комбинацию containerName и containerPort из определения задачи. Если определение задачи вашей задачи службы использует режим сети awsvpc и используется запись DNS типа SRV, необходимо указать комбинацию containerName и containerPort или значение port. Однако вы не можете указать оба.

containerPort -> (целое число)

Значение порта, используемое для вашей службы обнаружения служб. Оно уже указано в определении задачи. Если определение задачи вашей задачи службы использует режим сети bridge или host , необходимо указать комбинацию containerName и containerPort из определения задачи. Если определение задачи вашей задачи службы использует режим сети awsvpc и используется запись DNS типа SRV, необходимо указать комбинацию containerName и containerPort или значение port. Однако вы не можете указать оба.

status -> (строка)

Состояние службы. Допустимые значения - ACTIVE , DRAINING или INACTIVE .

desiredCount -> (целое число)

Желаемое количество экземпляров определения задачи, которые нужно запускать в службе. Это значение задается при создании службы с помощью CreateService , и его можно изменить с помощью UpdateService .

runningCount -> (целое число)

Количество задач в кластере, которые находятся в состоянии RUNNING .

pendingCount -> (целое число)

Количество задач в кластере, которые находятся в состоянии PENDING .

launchType -> (строка)

Тип запуска, используемый службой. При использовании API DescribeServices этот параметр опускается, если служба была создана с помощью стратегии поставщика емкости.

capacityProviderStrategy -> (список)

Стратегия поставщика емкости, используемая службой. При использовании API DescribeServices этот параметр опускается, если служба была создана с использованием типа запуска.

(структура)

Подробности стратегии поставщика емкости. Стратегию поставщика емкости можно задать при использовании API RunTask или CreateCluster или в качестве стратегии поставщика емкости по умолчанию для кластера с помощью API CreateCluster.

Можно использовать только поставщиков емкости, которые уже связаны с кластером и имеют состояние ACTIVE или UPDATING . API PutClusterCapacityProviders используется для связывания поставщика емкости с кластером.

Если используется поставщик емкости, использующий группу Auto Scaling, поставщик емкости должен быть уже создан. Новые поставщики емкости для групп Auto Scaling могут быть созданы с помощью операции API CreateClusterCapacityProvider.

Для использования поставщика емкости Fargate укажите поставщиков емкости FARGATE или FARGATE_SPOT. Поставщики емкости Fargate доступны для всех учетных записей и должны быть связаны с кластером, чтобы их можно было использовать в стратегии поставщика емкости.

С FARGATE_SPOT вы можете запускать задачи, допускающие прерывания, со скидкой по сравнению с ценой FARGATE. FARGATE_SPOT запускает задачи на свободных вычислительных ресурсах. Когда Amazon Web Services нуждается в освобождении ресурсов, ваши задачи прерываются с двухминутным предупреждением. FARGATE_SPOT поддерживает задачи Linux с архитектурой X86_64 на версии платформы 1.3.0 или выше. FARGATE_SPOT поддерживает задачи Linux с архитектурой ARM64 на версии платформы 1.4.0 или выше.

Стратегия поставщика емкости может содержать максимум 20 поставщиков емкости.

capacityProvider -> (строка)

Короткое имя поставщика емкости.

weight -> (целое число)

Значение weight определяет процентное соотношение от общего количества задач, запускаемых для использования указанного поставщика емкости. Значение weight учитывается после удовлетворения значения base , если оно определено.

Если значение weight не указано, используется значение по умолчанию 0. При указании нескольких поставщиков емкости в стратегии поставщика емкости по крайней мере один из поставщиков емкости должен иметь значение веса, большее нуля, и любые поставщики емкости с весом 0 не могут использоваться для размещения задач. Если вы укажете несколько поставщиков емкости в стратегии, у которых все имеют значение веса 0 , любые действия RunTask или CreateService с использованием стратегии поставщика емкости завершатся ошибкой.

Пример сценария использования весов - определение стратегии, содержащей два поставщика емкости, у которых оба имеют значение веса 1. После удовлетворения base задачи будут распределяться равномерно между двумя поставщиками емкости. Используя тот же принцип, если вы укажете вес 1 для capacityProviderA и вес 4 для capacityProviderB , то на каждую запущенную задачу с использованием capacityProviderA будет использоваться четыре задачи с использованием capacityProviderB.

base -> (целое число)

Значение base указывает минимальное количество задач для запуска на указанном поставщике емкости. Только один поставщик емкости в стратегии поставщика емкости может иметь значение base. Если значение не указано, используется значение по умолчанию 0.

platformVersion -> (строка)

Версия платформы для запуска вашей службы. Версия платформы указывается только для задач, размещаемых на Fargate. Если она не указана, используется версия платформы LATEST. Дополнительные сведения см. в разделе Версии платформы Fargate в руководстве разработчика Amazon Elastic Container Service.

platformFamily -> (строка)

Операционная система, на которой работают задачи в службе. Семейство платформ указывается только для задач, использующих тип запуска Fargate.

Все задачи, выполняемые в рамках этой службы, должны использовать то же значение platformFamily, что и служба (например, LINUX ).

taskDefinition -> (строка)

Определение задачи для задач в службе. Это значение задаётся при создании службы с помощью CreateService и может быть изменено с помощью UpdateService.

deploymentConfiguration -> (структура)

Необязательные параметры развертывания, которые управляют количеством задач, выполняемых во время развертывания, и порядком остановки и запуска задач.

deploymentCircuitBreaker -> (структура)

Примечание

Разрыв цепи развертывания может использоваться только для служб, использующих тип развертывания rolling update (ECS).

Разрыв цепи развертывания (deployment circuit breaker) определяет, произойдёт ли сбой развертывания службы, если служба не может достичь стабильного состояния. Если используется разрыв цепи развертывания, развертывание службы перейдёт в состояние ошибки и прекратит запуск новых задач. Если используется опция отката, при сбое развертывания службы служба откатывается к последнему успешно завершённому развертыванию. Дополнительную информацию см. в разделе Rolling update в Руководстве разработчика Amazon Elastic Container Service

enable -> (булево)

Определяет, использовать ли логику разрыва цепи развертывания для службы.

rollback -> (булево)

Определяет, будет ли Amazon ECS откатывать службу, если развертывание службы завершится с ошибкой. Если откат включён, при сбое развертывания службы, служба откатывается к последнему успешно завершённому развертыванию.

maximumPercent -> (целое число)

Если служба использует тип развертывания rolling update (ECS), параметр maximumPercent представляет собой верхний предел количества задач вашей службы, которые разрешено находиться в состоянии RUNNING или PENDING во время развертывания, в процентах от desiredCount (округлено вниз до ближайшего целого числа). Этот параметр позволяет определить размер пакета развертывания. Например, если ваша служба использует планировщик служб REPLICA и имеет desiredCount в четыре задачи, а значение maximumPercent равно 200%, планировщик может запустить четыре новые задачи перед остановкой четырёх старых задач (при условии, что для этого доступны ресурсы кластера). Значение по умолчанию для maximumPercent для службы, использующей планировщик служб REPLICA, составляет 200%.

Планировщик Amazon ECS использует этот параметр для замены неисправных задач путём запуска задач-заменителей сначала, а затем остановки неисправных задач, при условии, что ресурсы кластера для запуска задач-заменителей доступны. Дополнительную информацию о том, как планировщик заменяет неисправные задачи, см. в разделе Amazon ECS services.

Если служба использует типы развертывания blue/green (CODE_DEPLOY) или EXTERNAL, а задачи в службе используют тип запуска EC2, значение максимальный процент устанавливается по умолчанию. Значение максимальный процент используется для определения верхнего предела количества задач в службе, которые остаются в состоянии RUNNING, в то время как экземпляры контейнеров находятся в состоянии DRAINING.

Примечание

Вы не можете указать пользовательское значение maximumPercent для службы, использующей типы развертывания blue/green (CODE_DEPLOY) или EXTERNAL и имеющей задачи, которые используют тип запуска EC2.

Если служба использует типы развертывания blue/green (CODE_DEPLOY) или EXTERNAL, и задачи в службе используют тип запуска Fargate, значение максимального процента не используется. Это значение всё равно возвращается при описании вашей службы.

minimumHealthyPercent -> (целое число)

Если служба использует тип развертывания rolling update (ECS), minimumHealthyPercent представляет собой нижний предел количества задач вашей службы, которые должны оставаться в состоянии RUNNING во время развертывания, в процентах от desiredCount (округлено вверх до ближайшего целого числа). Этот параметр позволяет развернуть службу без использования дополнительных ресурсов кластера. Например, если у вашей службы есть desiredCount в четыре задачи, а minimumHealthyPercent составляет 50%, планировщик служб может остановить две существующие задачи, чтобы освободить ресурсы кластера, прежде чем запустить две новые задачи.

Если какие-либо задачи неисправны, и maximumPercent не позволяет планировщику Amazon ECS запускать задачи-заменители, планировщик останавливает неисправные задачи по одной — используя minimumHealthyPercent в качестве ограничения — для освобождения ресурсов для запуска задач-заменителей. Дополнительную информацию о том, как планировщик заменяет неисправные задачи, см. в разделе Amazon ECS services.

Для служб, не использующих балансировщик нагрузки, следует обратить внимание на следующее:

  • Служба считается работоспособной, если все необходимые контейнеры внутри задач в службе проходят свои проверки работоспособности.
  • Если у задачи нет необходимых контейнеров с определённой проверкой работоспособности, планировщик служб будет ждать 40 секунд после того, как задача достигнет состояния RUNNING, прежде чем задача будет учтена в общей сумме минимального процента работоспособных задач.
  • Если у задачи есть один или несколько необходимых контейнеров с определённой проверкой работоспособности, планировщик служб будет ждать, пока задача достигнет работоспособного состояния, прежде чем учитывать её в минимальном проценте работоспособных задач. Задача считается работоспособной, когда все необходимые контейнеры внутри задачи прошли свои проверки работоспособности. Время, которое планировщик служб может ждать, определяется настройками проверки работоспособности контейнера.

Для служб, использующих балансировщик нагрузки, следует обратить внимание на следующее:

  • Если у задачи нет необходимых контейнеров с определённой проверкой работоспособности, планировщик служб будет ждать, пока проверка работоспособности целевой группы балансировщика нагрузки вернёт состояние работоспособности, прежде чем учитывать задачу в минимальном проценте работоспособных задач.
  • Если у задачи есть необходимый контейнер с определённой проверкой работоспособности, планировщик служб будет ждать, пока задача достигнет работоспособного состояния и проверка работоспособности целевой группы балансировщика нагрузки вернёт состояние работоспособности, прежде чем учитывать задачу в минимальном проценте работоспособных задач.

Значение по умолчанию для службы-реплики для minimumHealthyPercent составляет 100%. Значение по умолчанию для minimumHealthyPercent для службы, использующей планировщик служб DAEMON, составляет 0% для CLI, Amazon Web Services SDK и API и 50% для Amazon Web Services Management Console.

Минимальное количество работоспособных задач во время развертывания равно desiredCount, умноженному на minimumHealthyPercent /100, округленному вверх до ближайшего целого значения.

Если служба использует типы развертывания blue/green (CODE_DEPLOY) или EXTERNAL и выполняет задачи, использующие тип запуска EC2, значение минимального процента работоспособности устанавливается по умолчанию. Значение минимального процента работоспособности используется для определения нижнего предела количества задач в службе, которые остаются в состоянии RUNNING, в то время как экземпляры контейнеров находятся в состоянии DRAINING.

Примечание

Вы не можете указать пользовательское значение minimumHealthyPercent для службы, использующей типы развертывания blue/green (CODE_DEPLOY) или EXTERNAL и имеющей задачи, которые используют тип запуска EC2.

Если служба использует типы развертывания blue/green (CODE_DEPLOY) или EXTERNAL и выполняет задачи, использующие тип запуска Fargate, значение минимального процента работоспособности не используется, хотя оно возвращается при описании вашей службы.

alarms -> (структура)

Информация о CloudWatch сигнализации.

alarmNames -> (список)

Одно или несколько имён CloudWatch сигнализации. Разделяйте сигнализации запятой.

(строка)

rollback -> (булево)

Определяет, будет ли Amazon ECS откатывать службу, если развертывание службы завершится с ошибкой. Если откат используется, при сбое развертывания службы, служба откатывается к последнему успешно завершённому развертыванию.

enable -> (булево)

Определяет, использовать ли опцию CloudWatch alarm в процессе развертывания службы.

taskSets -> (список)

Информация о наборе задач Amazon ECS в развертывании CodeDeploy или EXTERNAL. Набор задач Amazon ECS содержит такие данные, как желаемое количество задач, количество работающих задач и то, обслуживает ли набор задач трафик производства.

(структура)

Информация о наборе задач Amazon ECS в развертывании CodeDeploy или EXTERNAL. Набор задач Amazon ECS содержит такие данные, как желаемое количество задач, количество работающих задач и то, обслуживает ли набор задач трафик производства.

id -> (строка)

Идентификатор набора задач.

taskSetArn -> (строка)

Amazon Resource Name (ARN) набора задач.

serviceArn -> (строка)

Amazon Resource Name (ARN) сервиса, в котором существует набор задач.

clusterArn -> (строка)

Amazon Resource Name (ARN) кластера, в котором существует сервис, содержащий набор задач.

startedBy -> (строка)

Тег, указанный при запуске набора задач. Если развертывание CodeDeploy создало набор задач, параметр startedBy равен CODE_DEPLOY. Если набор задач создан внешним развертыванием, поле startedBy не используется.

externalId -> (строка)

Внешний идентификатор, связанный с набором задач.

Если развертывание CodeDeploy создало набор задач, параметр externalId содержит идентификатор развертывания CodeDeploy.

Если набор задач создан для внешнего развертывания и связан с реестром обнаружения сервисов, параметр externalId содержит атрибут ECS_TASK_SET_EXTERNAL_ID Cloud Map.

status -> (строка)

Статус набора задач. Ниже описывается каждый из состояний.

PRIMARY

Набор задач обслуживает трафик производства.

ACTIVE

Набор задач не обслуживает трафик производства.

DRAINING

Задачи в наборе задач останавливаются, а соответствующие целевые объекты удаляются из группы целевых объектов.

taskDefinition -> (строка)

Определения задачи, используемой набором задач.

computedDesiredCount -> (целое число)

Вычисленное желаемое количество задач для набора задач. Это вычисляется путем умножения desiredCount сервиса на процентный показатель scale набора задач. Результат всегда округляется в большую сторону. Например, если вычисленное желаемое количество задач равно 1,2, оно округляется до 2 задач.

pendingCount -> (целое число)

Количество задач в наборе задач, находящихся в статусе PENDING во время развертывания. Задача в состоянии PENDING готовится перейти в состояние RUNNING. Набор задач переходит в состояние PENDING, когда он запускается впервые или перезапускается после состояния STOPPED.

runningCount -> (целое число)

Количество задач в наборе задач, находящихся в состоянии RUNNING во время развертывания. Задача в состоянии RUNNING работает и готова к использованию.

createdAt -> (временная метка)

Временная метка Unix для времени создания набора задач.

updatedAt -> (временная метка)

Временная метка Unix для времени последнего обновления набора задач.

launchType -> (строка)

Тип запуска, используемый задачами в наборе задач. Дополнительную информацию см. в разделе Типы запуска Amazon ECS в руководстве разработчика Amazon Elastic Container Service.

capacityProviderStrategy -> (список)

Стратегия поставщика емкости, связанная с набором задач.

(структура)

Детали стратегии поставщика емкости. Стратегию поставщика емкости можно задать при использовании API RunTask или CreateCluster или в качестве стратегии поставщика емкости по умолчанию для кластера с помощью API CreateCluster.

Можно использовать только поставщиков емкости, которые уже связаны с кластером и имеют статус ACTIVE или UPDATING. API PutClusterCapacityProviders используется для связывания поставщика емкости с кластером.

Если вы указываете поставщика емкости, использующего группу Auto Scaling, поставщик емкости должен быть уже создан. Новые поставщики емкости группы Auto Scaling могут быть созданы с помощью операции API CreateClusterCapacityProvider.

Для использования поставщика емкости Fargate укажите либо поставщиков емкости FARGATE или FARGATE_SPOT. Поставщики емкости Fargate доступны для всех учетных записей и должны быть связаны только с кластером, чтобы использоваться в стратегии поставщика емкости.

С помощью FARGATE_SPOT вы можете запускать задачи, устойчивые к прерываниям, со скидкой по сравнению с ценой FARGATE. FARGATE_SPOT запускает задачи на свободных вычислительных ресурсах. Когда Amazon Web Services нуждается в этих ресурсах обратно, ваши задачи прерываются с предупреждением в течение двух минут. FARGATE_SPOT поддерживает задачи Linux с архитектурой X86_64 на версии платформы 1.3.0 или более поздней. FARGATE_SPOT поддерживает задачи Linux с архитектурой ARM64 на версии платформы 1.4.0 или более поздней.

Стратегия поставщика емкости может содержать максимум 20 поставщиков емкости.

capacityProvider -> (строка)

Короткое имя поставщика емкости.

weight -> (целое число)

Значение weight определяет относительный процент общего количества запускаемых задач, которые должны использовать указанного поставщика емкости. Значение weight учитывается после удовлетворения значения base, если оно определено.

Если значение weight не указано, используется значение по умолчанию 0. Если в стратегии поставщика емкости указаны несколько поставщиков емкости, по крайней мере один из поставщиков емкости должен иметь значение веса, большее нуля, и любые поставщики емкости с весом 0 не могут использоваться для размещения задач. Если вы указываете несколько поставщиков емкости в стратегии, которые все имеют вес 0, любые действия RunTask или CreateService, использующие стратегию поставщика емкости, завершатся ошибкой.

Пример сценария использования весов: определение стратегии, содержащей двух поставщиков емкости, и оба имеют вес 1, затем, когда условие base выполняется, задачи будут распределены равномерно между двумя поставщиками емкости. Используя тот же принцип, если вы задаете вес 1 для capacityProviderA и вес 4 для capacityProviderB, то на каждую задачу, запущенную с помощью capacityProviderA, четыре задачи будут использовать capacityProviderB.

base -> (целое число)

Значение base определяет минимальное количество задач, которые необходимо запустить на указанном поставщике емкости. Только один поставщик емкости в стратегии поставщика емкости может иметь определенное значение base. Если значение не указано, используется значение по умолчанию 0.

platformVersion -> (строка)

Версия платформы Fargate, на которой выполняются задачи в наборе задач. Версия платформы указывается только для задач, выполняемых на Fargate. Дополнительную информацию см. в разделе Версии платформы Fargate в руководстве разработчика Amazon Elastic Container Service.

platformFamily -> (строка)

Операционная система, на которой выполняются ваши задачи в наборе. Семейство платформ указывается только для задач, использующих тип запуска Fargate.

Все задачи в наборе должны иметь одинаковое значение.

networkConfiguration -> (структура)

Настройка сети для набора задач.

awsvpcConfiguration -> (структура)

Подсети VPC и группы безопасности, связанные с задачей.

Примечание

Все указанные подсети и группы безопасности должны быть из одной VPC.

subnets -> (список)

Идентификаторы подсетей, связанных с задачей или сервисом. Можно указать до 16 подсетей.

Примечание

Все указанные подсети должны быть из одной VPC.

(строка)

securityGroups -> (список)

Идентификаторы групп безопасности, связанных с задачей или сервисом. Если вы не указываете группу безопасности, используется группа безопасности по умолчанию для VPC. Можно указать до 5 групп безопасности.

Примечание

Все указанные группы безопасности должны быть из одной VPC.

(строка)

assignPublicIp -> (строка)

Получает ли эластичный сетевой интерфейс задачи общедоступный IP-адрес.

Учитывайте следующее при установке этого значения:

  • При использовании create-service или update-service значение по умолчанию равно DISABLED.
  • Если сервис deploymentController находится в состоянии ECS, значение должно быть DISABLED.

loadBalancers -> (список)

Подробности о балансировщике нагрузки, используемом с набором задач.

(структура)

Настройка балансировщика нагрузки для использования с сервисом или набором задач.

При добавлении, обновлении или удалении конфигурации балансировщика нагрузки Amazon ECS запускает новую развертку с обновлённой конфигурацией Elastic Load Balancing. Это приводит к регистрации и отмене регистрации задач в балансировщиках.

Рекомендуется проверять эту настройку в тестовой среде перед обновлением конфигурации Elastic Load Balancing.

Для служб, использующих несколько групп целевых серверов, требуется роль, связанная со службой. Дополнительную информацию см. в разделе «Использование ролей, связанных со службой», в руководстве разработчика Amazon Elastic Container Service.

targetGroupArn -> (строка)

Полный Amazon Resource Name (ARN) группы или групп целевых серверов Elastic Load Balancing, связанных с сервисом или набором задач.

ARN группы целевых серверов указывается только при использовании Application Load Balancer или Network Load Balancer.

Для служб, использующих контроллер развертывания ECS, можно указать одну или несколько групп целевых серверов. Дополнительную информацию см. в разделе «Регистрация нескольких групп целевых серверов со службой» в руководстве разработчика Amazon Elastic Container Service.

Для служб, использующих контроллер развертывания CODE_DEPLOY, необходимо определить две группы целевых серверов для балансировщика. Дополнительную информацию см. в разделе «Развертывание «синий/зелёный» с помощью CodeDeploy» в руководстве разработчика Amazon Elastic Container Service.

Предупреждение

Если определение задачи вашего сервиса использует режим сети awsvpc, вы должны выбрать ip в качестве типа целевого сервера, а не instance. Сделайте это при создании групп целевых серверов, так как задачи, использующие режим сети awsvpc, связаны с интерфейсом эластичной сети, а не с экземпляром Amazon EC2. Этот режим сети требуется для типа запуска Fargate.

loadBalancerName -> (строка)

Имя балансировщика нагрузки, который следует связать с сервисом Amazon ECS или набором задач.

Если вы используете Application Load Balancer или Network Load Balancer, параметр имени балансировщика нагрузки следует опустить.

containerName -> (строка)

Имя контейнера (как оно отображается в определении контейнера) для связи с балансировщиком.

Вам необходимо указать имя контейнера при настройке группы целевых серверов для балансировщика Amazon ECS.

containerPort -> (целое число)

Порт в контейнере, который следует связать с балансировщиком. Этот порт должен соответствовать containerPort в определении задачи, используемом задачами в службе. Для задач, использующих тип запуска EC2, экземпляр контейнера, на котором они запускаются, должен разрешать входящий трафик на hostPort сопоставления портов.

serviceRegistries -> (список)

Подробности для регистров обнаружения служб для назначения этому набору задач. Дополнительную информацию см. в разделе Обнаружение служб.

(структура)

Подробности для реестра служб.

Каждая служба может быть связана с одним реестром служб. Несколько регистров служб для каждой службы не поддерживаются.

При добавлении, обновлении или удалении конфигурации регистров служб Amazon ECS запускает новую развертку. Новые задачи регистрируются и отменяют регистрацию в обновлённой конфигурации реестра служб.

registryArn -> (строка)

Amazon Resource Name (ARN) реестра служб. В настоящее время поддерживается реестр служб Cloud Map. Дополнительную информацию см. в разделе CreateService.

port -> (целое число)

Значение порта, используемое, если ваша служба обнаружения служб указала запись SRV. Это поле может быть использовано, если используются как режим сети awsvpc, так и записи SRV.

containerName -> (строка)

Значение имени контейнера, которое будет использоваться для вашей службы обнаружения служб. Оно уже указано в определении задачи. Если определение задачи, указанное вашей задачей сервиса, использует режим сети bridge или host, вы должны указать сочетание containerName и containerPort из определения задачи. Если определение задачи, указанное вашей задачей сервиса, использует режим сети awsvpc и используется запись DNS типа SRV, вы должны указать сочетание containerName и containerPort или значение port. Однако вы не можете указать оба.

containerPort -> (целое число)

Значение порта, которое будет использоваться для вашей службы обнаружения служб. Оно уже указано в определении задачи. Если определение задачи, указанное вашей задачей сервиса, использует режим сети bridge или host, вы должны указать сочетание containerName и containerPort из определения задачи. Если определение задачи, указанное вашей задачей сервиса, использует режим сети awsvpc и используется запись DNS типа SRV, вы должны указать сочетание containerName и containerPort или значение port. Однако вы не можете указать оба.

scale -> (структура)

Поплавковая точка процента от желаемого числа задач, которые нужно разместить и поддерживать в рабочем состоянии в наборе задач.

value -> (двойное число)

Значение, указанное в процентах от общего числа desiredCount сервиса, для масштабирования набора задач. Допустимые значения — числа от 0 до 100.

unit -> (строка)

Единица измерения для значения масштаба.

stabilityStatus -> (строка)

Статус стабильности. Это указывает, достиг ли набор задач устойчивого состояния. Если выполнены следующие условия, набор задач находится в состоянии STEADY_STATE:

  • Количество задач runningCount равно computedDesiredCount.
  • pendingCount находится в состоянии 0.
  • Нет задач, которые работают на экземплярах контейнеров в состоянии DRAINING.
  • Все задачи сообщают о нормальном статусе от балансировщиков, обнаружения служб и проверок работоспособности контейнеров.

Если любое из этих условий не выполняется, статус стабильности возвращает STABILIZING.

stabilityStatusAt -> (метка времени)

Маркер Unix для времени получения статуса стабильности набора задач.

tags -> (список)

Метаданные, которые вы применяете к набору задач, чтобы помочь в их категоризации и организации. Каждый тег состоит из ключа и необязательного значения. Вы определяете их оба.

Применимы следующие базовые ограничения к тегам:

  • Максимальное число тегов на ресурс — 50
  • Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
  • Максимальная длина ключа — 128 символов Юникода в UTF-8
  • Максимальная длина значения — 256 символов Юникода в UTF-8
  • Если ваша схема тегов используется в нескольких сервисах и ресурсах, помните, что другие сервисы могут иметь ограничения на допустимые символы. Обычно допустимые символы: буквы, цифры и пробелы, представимые в UTF-8, и следующие символы: + - = . _ : / @.
  • Ключи и значения тегов чувствительны к регистру.
  • Не используйте aws:, AWS: или любое сочетание верхнего/нижнего регистра таких префиксов для ключей или значений, так как они зарезервированы для использования Amazon Web Services. Вы не можете редактировать или удалять ключи или значения тегов с этим префиксом. Теги с этим префиксом не учитываются при подсчете ограничений на количество тегов на ресурс.

(структура)

Метаданные, которые вы применяете к ресурсу, чтобы помочь в их категоризации и организации. Каждый тег состоит из ключа и необязательного значения. Вы определяете их оба.

Применимы следующие базовые ограничения к тегам:

  • Максимальное число тегов на ресурс — 50
  • Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
  • Максимальная длина ключа — 128 символов Юникода в UTF-8
  • Максимальная длина значения — 256 символов Юникода в UTF-8
  • Если ваша схема тегов используется в нескольких сервисах и ресурсах, помните, что другие сервисы могут иметь ограничения на допустимые символы. Обычно допустимые символы: буквы, цифры и пробелы, представимые в UTF-8, и следующие символы: + - = . _ : / @.
  • Ключи и значения тегов чувствительны к регистру.
  • Не используйте aws:, AWS: или любое сочетание верхнего/нижнего регистра таких префиксов для ключей или значений, так как они зарезервированы для использования Amazon Web Services. Вы не можете редактировать или удалять ключи или значения тегов с этим префиксом. Теги с этим префиксом не учитываются при подсчете ограничений на количество тегов на ресурс.

key -> (строка)

Одна часть пары «ключ-значение», которая образует тег. Ключ — это общая метка, которая действует как категория для более конкретных значений тегов.

value -> (строка)

Необязательная часть пары «ключ-значение», которая образует тег. Значение выступает в роли описателя в категории тега (ключ).

fargateEphemeralStorage -> (структура)

Настройки временного хранилища Fargate для набора задач.

kmsKeyId -> (строка)

Укажите идентификатор ключа Key Management Service для шифрования временного хранилища для развертывания.

deployments -> (список)

Текущее состояние развертываний для службы.

(структура)

Подробная информация о развертывании службы Amazon ECS. Используется только в случае, если служба использует тип контроллера развертывания ECS.

id -> (строка)

Идентификатор развертывания.

status -> (строка)

Состояние развертывания. Ниже описано каждое состояние.

PRIMARY

Последнее развертывание службы.

ACTIVE

Развертывание службы, у которой всё ещё работают задачи, но они заменяются на новое развертывание PRIMARY.

INACTIVE

Развертывание, которое было полностью заменено.

taskDefinition -> (строка)

Последняя определённая задача, используемая для задач в службе.

desiredCount -> (целое число)

Последнее желаемое количество задач, которое было указано для развертывания или поддержания службы.

pendingCount -> (целое число)

Количество задач в развертывании, находящихся в состоянии PENDING.

runningCount -> (целое число)

Количество задач в развертывании, находящихся в состоянии RUNNING.

failedTasks -> (целое число)

Количество последовательно завершившихся неудачно задач в развертывании. Задача считается неудачной, если планировщик службы не может запустить задачу, задача не переходит в состояние RUNNING или если она не проходит ни один из определённых проверок работоспособности и останавливается.

Примечание

После того, как в развертывании службы одна или несколько задач успешно запущены, счётчик неудачных задач сбрасывается до нуля и перестаёт учитываться.

createdAt -> (отметка времени)

Отметка Unix времени создания развертывания службы.

updatedAt -> (отметка времени)

Отметка Unix времени последнего обновления развертывания службы.

capacityProviderStrategy -> (список)

Стратегия поставщика ресурсов, используемая развертыванием.

(структура)

Подробная информация о стратегии поставщика ресурсов. Стратегию поставщика ресурсов можно задать при использовании API RunTask или CreateCluster или как стратегию поставщика ресурсов по умолчанию для кластера с помощью API CreateCluster.

Можно использовать только поставщиков ресурсов, которые уже связаны с кластером и имеют состояние ACTIVE или UPDATING. Для связи поставщика ресурсов с кластером используется API PutClusterCapacityProviders.

Если указан поставщик ресурсов, использующий группу Auto Scaling, то группа Auto Scaling должна быть уже создана. Новые поставщики ресурсов группы Auto Scaling можно создать с помощью операции API CreateClusterCapacityProvider.

Для использования поставщика ресурсов Fargate укажите либо поставщиков ресурсов FARGATE или FARGATE_SPOT. Поставщики ресурсов Fargate доступны для всех учётных записей и требуют только связи с кластером для использования в стратегии поставщика ресурсов.

С помощью FARGATE_SPOT вы можете запускать задачи, устойчивые к прерываниям, со скоростью, которая снижена по сравнению с ценой FARGATE. FARGATE_SPOT запускает задачи на свободных вычислительных мощностях. Когда Amazon Web Services нуждается в этих мощностях обратно, ваши задачи прерываются с двухминутным предупреждением. FARGATE_SPOT поддерживает задачи Linux с архитектурой X86_64 на версии платформы 1.3.0 или выше. FARGATE_SPOT поддерживает задачи Linux с архитектурой ARM64 на версии платформы 1.4.0 или выше.

Стратегия поставщика ресурсов может содержать не более 20 поставщиков ресурсов.

capacityProvider -> (строка)

Короткое имя поставщика ресурсов.

weight -> (целое число)

Значение weight определяет процентный показатель от общего количества запущенных задач, которые должны использовать указанного поставщика ресурсов. Значение weight учитывается после значения base, если оно определено.

Если значение weight не указано, используется значение по умолчанию 0. При указании нескольких поставщиков ресурсов в стратегии поставщика ресурсов по крайней мере один из поставщиков ресурсов должен иметь значение weight больше нуля, и любые поставщики ресурсов с весом 0 не могут быть использованы для размещения задач. Если вы указываете несколько поставщиков ресурсов в стратегии, которые все имеют значение weight, равное 0, любые действия RunTask или CreateService, использующие стратегию поставщика ресурсов, завершатся ошибкой.

Пример сценария использования весов — определение стратегии, содержащей двух поставщиков ресурсов, и оба имеют значение weight, равное 1, а затем, когда выполняется base, задачи распределяются равномерно между двумя поставщиками ресурсов. Используя ту же логику, если вы задаёте значение weight, равное 1 для capacityProviderA и значение weight, равное 4 для capacityProviderB, то для каждой задачи, запущенной с использованием capacityProviderA, четыре задачи будут использовать capacityProviderB.

base -> (целое число)

Значение base определяет минимальное количество задач, которые необходимо запустить на указанном поставщике ресурсов. Только один поставщик ресурсов в стратегии поставщика ресурсов может иметь заданное значение base. Если значение не указано, используется значение по умолчанию 0.

launchType -> (строка)

Тип запуска, используемый задачами в службе. Дополнительную информацию см. в разделе Amazon ECS Launch Types в руководстве Amazon Elastic Container Service Developer Guide.

platformVersion -> (строка)

Версия платформы, на которой выполняются ваши задачи в службе. Версия платформы указывается только для задач, использующих тип запуска Fargate. Если версия не указана, используется версия платформы LATEST. Дополнительную информацию см. в разделе Fargate Platform Versions в руководстве Amazon Elastic Container Service Developer Guide.

platformFamily -> (строка)

Операционная система, на которой выполняются ваши задачи в службе или задачи. Семейство платформ указывается только для задач, использующих тип запуска Fargate.

Все задачи, выполняемые в рамках этой службы, должны использовать то же значение platformFamily, что и служба, например, LINUX..

networkConfiguration -> (структура)

Настройка подсети VPC и группы безопасности для задач, которые получают собственный интерфейс эластичной сети, используя режим сетевой конфигурации awsvpc.

awsvpcConfiguration -> (структура)

Подсети VPC и группы безопасности, связанные с задачей.

Примечание

Все указанные подсети и группы безопасности должны принадлежать одной и той же VPC.

subnets -> (список)

Идентификаторы подсетей, связанные с задачей или службой. Можно указать до 16 подсетей.

Примечание

Все указанные подсети должны принадлежать одной и той же VPC.

(строка)

securityGroups -> (список)

Идентификаторы групп безопасности, связанные с задачей или службой. Если вы не указываете группу безопасности, используется группа безопасности по умолчанию для VPC. Можно указать до 5 групп безопасности.

Примечание

Все указанные группы безопасности должны принадлежать одной и той же VPC.

(строка)

assignPublicIp -> (строка)

Получает ли интерфейс эластичной сети задачи публичный IP-адрес.

Рассмотрите следующие моменты при установке этого значения:

  • При использовании create-service или update-service значение по умолчанию — DISABLED.
  • Когда служба deploymentController находится в состоянии ECS, значение должно быть DISABLED.

rolloutState -> (строка)

Примечание

Состояние развертывания службы возвращается только для служб, которые используют тип развертывания с постепенным обновлением (ECS), но не находятся за Классическим балансировщиком.

Состояние развертывания. При запуске развертывания службы оно начинает работу в состоянии IN_PROGRESS. Когда служба достигает стабильного состояния, развертывание переходит в состояние COMPLETED. Если служба не достигает стабильного состояния и предохранитель от сбоев включён, развертывание переходит в состояние FAILED. Развертывание в состоянии FAILED не запускает новые задачи. Дополнительную информацию см. в разделе DeploymentCircuitBreaker.

rolloutStateReason -> (строка)

Описание состояния развертывания.

serviceConnectConfiguration -> (структура)

Подробности конфигурации Service Connect, используемой данным развертыванием. Сравнивайте конфигурацию между несколькими развертываниями при устранении неполадок с новыми развертываниями.

Конфигурация для этого сервиса для обнаружения и подключения к сервисам, а также для обнаружения и подключения к другим сервисам в рамках пространства имен.

Задачи, выполняемые в пространстве имен, могут использовать короткие имена для подключения к сервисам в пространстве имен. Задачи могут подключаться к сервисам во всех кластерах в пространстве имен. Задачи подключаются через управляемый контейнер-прокси, который собирает журналы и метрики для повышения видимости. Поддержка Service Connect предоставляется только для задач, созданных сервисами Amazon ECS. Дополнительную информацию см. в разделе Service Connect в руководстве разработчика Amazon Elastic Container Service.

enabled -> (boolean)

Указывает, использовать ли Service Connect с этим сервисом.

namespace -> (string)

Имя пространства имен или полный Amazon Resource Name (ARN) пространства имен Cloud Map для использования с Service Connect. Пространство имен должно находиться в той же области Amazon Web Services, что и сервис и кластер Amazon ECS. Тип пространства имен не влияет на Service Connect. Дополнительную информацию о Cloud Map см. в руководстве разработчика Cloud Map.

services -> (list)

Список объектов сервиса Service Connect. Это имена и псевдонимы (также известные как конечные точки), используемые другими сервисами Amazon ECS для подключения к этому сервису.

Это поле не требуется для сервиса Amazon ECS типа «клиент», который является членом пространства имен только для подключения к другим сервисам в рамках пространства имен. Примером этого может служить приложение front-end, которое принимает входящие запросы либо от балансировщика нагрузки, подключенного к сервису, либо иными способами.

Объект выбирает порт из определения задачи, присваивает имя сервису Cloud Map и список псевдонимов (конечных точек) и портов для того, чтобы клиентские приложения могли обращаться к этому сервису.

(structure)

Конфигурация объекта сервиса Service Connect. Дополнительную информацию см. в разделе Service Connect в руководстве разработчика Amazon Elastic Container Service.

portName -> (string)

portName должен соответствовать имени одного из portMappings из всех контейнеров в определении задачи этого сервиса Amazon ECS.

discoveryName -> (string)

discoveryName — это имя нового сервиса Cloud Map, созданного Amazon ECS для этого сервиса Amazon ECS. Оно должно быть уникальным в пространстве имен Cloud Map. Имя может содержать до 64 символов. Имя может включать строчные буквы, цифры, символы подчеркивания (_) и дефисы (-). Имя не может начинаться с дефиса.

Если discoveryName не указано, используется имя сопоставления портов из определения задачи в portName.namespace.

clientAliases -> (list)

Список псевдонимов клиентов для этого сервиса Service Connect. Используйте их для присвоения имен, которые могут использоваться клиентскими приложениями. Максимальное количество псевдонимов клиентов в этом списке — 1.

Каждый псевдоним («конечная точка») — это полное имя и номер порта, которые другие задачи Amazon ECS («клиенты») могут использовать для подключения к этому сервису.

Каждое имя и сопоставление портов должны быть уникальными в рамках пространства имен.

Для каждого ServiceConnectService необходимо указать хотя бы один clientAlias с одним port.

(structure)

Каждый псевдоним («конечная точка») — это полное имя и номер порта, которые другие задачи («клиенты») могут использовать для подключения к этому сервису.

Каждое имя и сопоставление портов должны быть уникальными в рамках пространства имен.

Задачи, выполняемые в пространстве имен, могут использовать короткие имена для подключения к сервисам в пространстве имен. Задачи могут подключаться к сервисам во всех кластерах в пространстве имен. Задачи подключаются через управляемый контейнер-прокси, который собирает журналы и метрики для повышения видимости. Поддержка Service Connect предоставляется только для задач, созданных сервисами Amazon ECS. Дополнительную информацию см. в разделе Service Connect в руководстве разработчика Amazon Elastic Container Service.

port -> (integer)

Номер порта прослушивания прокси Service Connect. Этот порт доступен во всех задачах в том же пространстве имен.

Чтобы избежать изменения приложений в клиентских сервисах Amazon ECS, задайте этот параметр на тот же порт, который приложение-клиент использует по умолчанию. Дополнительную информацию см. в разделе Service Connect в руководстве разработчика Amazon Elastic Container Service.

dnsName -> (string)

dnsName — это имя, которое вы используете в приложениях клиентских задач для подключения к этому сервису. Имя должно быть допустимым именем DNS, но не обязательно полным. Имя может содержать до 127 символов. Имя может включать строчные буквы, цифры, символы подчеркивания (_), дефисы (-) и точки (.). Имя не может начинаться с дефиса.

Если этот параметр не указан, используется значение по умолчанию discoveryName.namespace. Если discoveryName не указан, используется имя сопоставления портов из определения задачи в portName.namespace.

Чтобы избежать изменения приложений в клиентских сервисах Amazon ECS, задайте это значение на то же имя, которое приложение-клиент использует по умолчанию. Например, некоторые распространённые имена: database, db или строчное имя базы данных, например mysql или redis. Дополнительную информацию см. в разделе Service Connect в руководстве разработчика Amazon Elastic Container Service.

ingressPortOverride -> (integer)

Номер порта для прокси Service Connect для прослушивания.

Используйте значение этого поля для пропуска прокси для трафика по номеру порта, указанному в названном portMapping в определении задачи этого приложения, а затем используйте его в группах безопасности VPC для разрешения трафика в прокси для этого сервиса Amazon ECS.

В режиме awsvpc и Fargate значение по умолчанию — номер порта контейнера. Номер порта контейнера указан в portMapping в определении задачи. В режиме bridge значение по умолчанию — временный порт прокси Service Connect.

timeout -> (structure)

Ссылка на объект, представляющий настроенные таймауты для Service Connect.

idleTimeoutSeconds -> (integer)

Время в секундах, в течение которого соединение будет оставаться активным в режиме простоя. Значение 0 может быть установлено для отключения idleTimeout.

Значение по умолчанию для idleTimeout/HTTP/HTTP2/GRPC — 5 минут.

Значение по умолчанию для idleTimeout/TCP — 1 час.

perRequestTimeoutSeconds -> (integer)

Время ожидания ответа от источника с полным ответом на запрос. Значение 0 может быть установлено для отключения perRequestTimeout. perRequestTimeout может быть задано только в том случае, если Service Connect appProtocol не TCP. Только idleTimeout разрешено для TCP appProtocol.

tls -> (structure)

Ссылка на объект, представляющий конфигурацию Transport Layer Security (TLS).

issuerCertificateAuthority -> (structure)

Сертификат удостоверяющего центра.

awsPcaAuthorityArn -> (string)

ARN сертификата Amazon Web Services Private Certificate Authority.

kmsKey -> (string)

Ключ Amazon Web Services Key Management Service.

roleArn -> (string)

Amazon Resource Name (ARN) роли IAM, связанной с TLS Service Connect.

logConfiguration -> (structure)

Конфигурация журналов для контейнера. Этот параметр сопоставляется с LogConfig в команде docker container create и опцией --log-driver к docker run.

По умолчанию контейнеры используют тот же драйвер журналов, что и демоны Docker. Однако контейнер может использовать другой драйвер журналов, чем Docker daemon, указав конфигурацию драйвера журналов в определении контейнера.

Следует учитывать следующее при указании конфигурации журналов для контейнеров.

  • Amazon ECS в настоящее время поддерживает подмножество драйверов журналов, доступных для Docker daemon. Дополнительные драйверы журналов могут быть доступны в будущих версиях агента контейнеров Amazon ECS. Для задач на Fargate поддерживаются драйверы журналов awslogs, splunk и awsfirelens. Для задач, размещенных на экземплярах Amazon EC2, поддерживаются драйверы журналов awslogs, fluentd, gelf, json-file, journald, ``syslog`` , splunk и awsfirelens.
  • Для этого параметра требуется версия 1.18 или более поздняя версии Docker Remote API на вашем экземпляре контейнера.
  • Для задач, размещенных на экземплярах Amazon EC2, агент контейнеров Amazon ECS должен зарегистрировать доступные драйверы журналов с переменной окружения ECS_AVAILABLE_LOGGING_DRIVERS, прежде чем контейнеры, размещенные на этом экземпляре, смогут использовать эти параметры конфигурации журналов. Дополнительную информацию см. в разделе Конфигурация агента контейнеров Amazon ECS в руководстве разработчика Amazon Elastic Container Service.
  • Для задач на Fargate, поскольку у вас нет доступа к базовой инфраструктуре, на которой размещаются ваши задачи, необходимое дополнительное программное обеспечение должно быть установлено вне задачи. Например, агрегаторы вывода Fluentd или удаленный хост, выполняющий Logstash, для отправки журналов Gelf.

logDriver -> (string)

Драйвер журналов для использования контейнером.

Для задач на Fargate поддерживаются драйверы журналов awslogs, splunk и awsfirelens.

Для задач, размещенных на экземплярах Amazon EC2, поддерживаются драйверы журналов awslogs, fluentd, gelf, json-file, journald, syslog, splunk и awsfirelens.

Дополнительную информацию об использовании драйвера журналов awslogs см. в разделе Отправка журналов Amazon ECS в CloudWatch в руководстве разработчика Amazon Elastic Container Service.

Дополнительную информацию об использовании драйвера журналов awsfirelens см. в разделе Отправка журналов Amazon ECS в сервис Amazon Web Services или партнера Amazon Web Services.

Примечание

Если у вас есть собственный драйвер, который не указан, вы можете вилочить проект агента контейнеров Amazon ECS, доступный на GitHub, и настроить его для работы с этим драйвером. Мы рекомендуем отправлять запросы на внесение изменений, которые вы хотели бы включить. Однако в настоящее время мы не предоставляем поддержку запуска модифицированных копий этого программного обеспечения.

options -> (map)

``` END_OF_DOCUMENT_MARKER

Параметры конфигурации для отправки в драйвер регистрации.

Доступные параметры зависят от драйвера регистрации. Некоторые параметры, которые можно указать при использовании драйвера awslogs для маршрутизации журналов в Amazon CloudWatch, включают следующие:

awslogs-create-group

Обязательно: Нет

Укажите, хотите ли вы, чтобы группа журналов создавалась автоматически. Если этот параметр не указан, он по умолчанию равен false.

Примечание

Ваша политика IAM должна включать разрешение logs:CreateLogGroup, прежде чем вы попытаетесь использовать awslogs-create-group.

awslogs-region

Обязательно: Да

Укажите регион Amazon Web Services, в который драйвер регистрации awslogs должен отправлять ваши журналы Docker. Вы можете направить все журналы из кластеров в разных регионах в один регион CloudWatch Logs, чтобы все они отображались в одном месте. В противном случае вы можете разделить их по регионам для большей детализации. Убедитесь, что указанная группа журналов существует в регионе, который вы указали в этом параметре.

awslogs-group

Обязательно: Да

Убедитесь, что вы указали группу журналов, в которую драйвер регистрации awslogs отправляет свои потоки журналов.

awslogs-stream-prefix

Обязательно: Да, при использовании Fargate. Необязательно при использовании EC2.

Используйте параметр awslogs-stream-prefix, чтобы связать поток журнала с указанным префиксом, именем контейнера и идентификатором задачи Amazon ECS, к которой принадлежит контейнер. Если вы укажете префикс с этим параметром, то поток журнала будет иметь формат prefix-name/container-name/ecs-task-id.

Если вы не укажете префикс с этим параметром, поток журнала будет назван по идентификатору контейнера, назначенному демоном Docker на экземпляре контейнера. Поскольку отслеживание журналов обратно к контейнеру, который их отправил, только по идентификатору контейнера Docker (который доступен только на экземпляре контейнера) затруднительно, рекомендуется указать префикс с этим параметром.

Для служб Amazon ECS вы можете использовать имя службы в качестве префикса. Таким образом, вы можете проследить потоки журналов до службы, к которой принадлежит контейнер, имени контейнера, который их отправил, и идентификатору задачи, к которой принадлежит контейнер.

Вы должны указать префикс потока журнала, чтобы ваши журналы отображались в панели «Журналы» при использовании консоли Amazon ECS.

awslogs-datetime-format

Обязательно: Нет

Этот параметр определяет шаблон начала многострочного текста в формате Python strftime. Сообщение журнала состоит из строки, соответствующей шаблону, и всех последующих строк, не соответствующих шаблону. Соответствующая строка является разделителем между сообщениями журнала.

Один пример использования этого формата — для разбора вывода, такого как дамп стека, который в противном случае мог быть записан в несколько записей. Правильный шаблон позволяет захватить его в одной записи.

Дополнительную информацию см. в awslogs-datetime-format.

Вы не можете настроить оба параметра awslogs-datetime-format и awslogs-multiline-pattern.

Примечание

Многострочная регистрация выполняет разбор и сопоставление всех сообщений журнала с помощью регулярных выражений. Это может негативно сказаться на производительности регистрации.

awslogs-multiline-pattern

Обязательно: Нет

Этот параметр определяет шаблон начала многострочного текста, использующий регулярное выражение. Сообщение журнала состоит из строки, соответствующей шаблону, и всех последующих строк, не соответствующих шаблону. Соответствующая строка является разделителем между сообщениями журнала.

Дополнительную информацию см. в awslogs-multiline-pattern.

Этот параметр игнорируется, если также настроен awslogs-datetime-format.

Вы не можете настроить оба параметра awslogs-datetime-format и awslogs-multiline-pattern.

Примечание

Многострочная регистрация выполняет разбор и сопоставление всех сообщений журнала с помощью регулярных выражений. Это может негативно сказаться на производительности регистрации.

Следующие параметры применимы ко всем поддерживаемым драйверам журналов.

mode

Обязательно: Нет

Допустимые значения: non-blocking | blocking

Этот параметр определяет режим доставки сообщений журналов из контейнера в драйвер журналов, указанный с помощью logDriver. Выбранный режим доставки влияет на доступность приложения при прерывании потока журналов из контейнера.

Если вы используете режим blocking и поток журналов прерывается, вызовы из кода контейнера для записи в потоки stdout и stderr заблокируются. В результате заблокируется поток регистрации приложения. Это может привести к тому, что приложение станет недоступным и к ошибкам проверки работоспособности контейнера.

Если вы используете режим non-blocking, журналы контейнера вместо этого хранятся в промежуточном буфере в памяти, настроенном с помощью параметра max-buffer-size. Это предотвращает заблокирование приложения при невозможности отправки журналов. Мы рекомендуем использовать этот режим, если вы хотите гарантировать доступность службы и готовы к потере некоторых журналов. Дополнительную информацию см. в Предотвращение потери журналов с помощью режима без блокировки в драйвере журналов контейнера ``awslogs` <http://aws.amazon.com/blogs/containers/preventing-log-loss-with-non-blocking-mode-in-the-awslogs-container-log-driver/>`__.

Вы можете установить значение по умолчанию для mode для всех контейнеров в определенном регионе Amazon Web Services, используя настройку учетной записи defaultLogDriverMode. Если вы не указали параметр mode или не настроили настройку учетной записи, Amazon ECS по умолчанию будет использовать режим blocking. Дополнительную информацию о настройке учетной записи см. в разделе Режим драйвера журналов по умолчанию в Руководстве разработчика Amazon Elastic Container Service.

max-buffer-size

Обязательно: Нет

Значение по умолчанию: 1m

При использовании режима non-blocking параметр журнала max-buffer-size управляет размером буфера, используемого для промежуточного хранения сообщений. Убедитесь, что вы указали достаточный размер буфера, исходя из ваших требований приложения. При заполнении буфера дальнейшие журналы не могут быть сохранены. Журналы, которые не могут быть сохранены, теряются.

Чтобы маршрутизировать журналы с помощью маршрутизатора журналов splunk, необходимо указать splunk-token и splunk-url.

При использовании маршрутизатора журналов awsfirelens для маршрутизации журналов в целевой сервис Amazon Web Services или в целевой сервис Amazon Web Services Partner Network для хранения и анализа журналов, вы можете установить параметр log-driver-buffer-limit, чтобы ограничить количество событий, буферизованных в памяти, перед отправкой в контейнер маршрутизатора журналов. Это может помочь в решении потенциальных проблем с потерей журналов, поскольку высокая пропускная способность может привести к недостатку памяти для буфера внутри Docker.

Другие параметры, которые можно указать при использовании awsfirelens для маршрутизации журналов, зависят от целевого адреса. При экспорте журналов в Amazon Data Firehose вы можете указать регион Amazon Web Services с помощью region и имя потока журнала с помощью delivery_stream.

При экспорте журналов в Amazon Kinesis Data Streams вы можете указать регион Amazon Web Services с помощью region и имя потока данных с помощью stream.

При экспорте журналов в Amazon OpenSearch Service вы можете указать параметры, такие как Name, Host (конечная точка OpenSearch Service без протокола), Port, Index, Type, Aws_auth, Aws_region, Suppress_Type_Name и tls. Дополнительную информацию см. в разделе Под капотом: FireLens для задач Amazon ECS.

При экспорте журналов в Amazon S3 вы можете указать ведро с помощью параметра bucket. Вы также можете указать region, total_file_size, upload_timeout и use_put_object в качестве параметров.

Для этого параметра требуется версия 1.19 или более поздняя версия Docker Remote API на вашем экземпляре контейнера. Чтобы проверить версию Docker Remote API на вашем экземпляре контейнера, войдите в ваш экземпляр контейнера и выполните следующую команду: sudo docker version --format '{{.Server.APIVersion}}'

key -> (строка)

value -> (строка)

secretOptions -> (список)

Секреты, которые нужно передать конфигурации регистрации. Дополнительную информацию см. в разделе Указание конфиденциальных данных в Руководстве разработчика Amazon Elastic Container Service.

(структура)

Объект, представляющий секрет, который нужно открыть для вашего контейнера. Секреты могут быть открыты для контейнера следующими способами:

  • Для вставки конфиденциальных данных в ваши контейнеры в качестве переменных среды используйте параметр определения контейнера secrets.
  • Для ссылки на конфиденциальную информацию в конфигурации регистрации контейнера используйте параметр определения контейнера secretOptions.

Дополнительную информацию см. в разделе Указание конфиденциальных данных в Руководстве разработчика Amazon Elastic Container Service.

name -> (строка)

Имя секрета.

valueFrom -> (строка)

Секрет, который нужно открыть для контейнера. Поддерживаются полный ARN секрета Secrets Manager или полный ARN параметра в SSM Parameter Store.

Сведения о необходимых разрешениях Identity and Access Management см. в разделе Требуемые разрешения IAM для секретов Amazon ECS (для Secrets Manager) или Требуемые разрешения IAM для секретов Amazon ECS (для хранилища параметров Systems Manager) в Руководстве разработчика Amazon Elastic Container Service.

Примечание

Если параметр хранилища параметров SSM существует в том же регионе, что и запускаемая вами задача, вы можете использовать полный ARN или имя параметра. Если параметр существует в другом регионе, должен быть указан полный ARN.

serviceConnectResources -> (список)

Список ресурсов Service Connect, связанных с этим развертыванием. Каждая запись в списке сопоставляет имя обнаружения с именем службы Cloud Map.

(структура)

Ресурс Service Connect. Каждая конфигурация сопоставляет имя обнаружения с именем службы Cloud Map. Данные хранятся в Cloud Map как часть конфигурации Service Connect для каждого имени обнаружения этой службы Amazon ECS.

Задача может разрешить dnsName для каждого из clientAliases службы. Однако задача не может разрешить имена обнаружения. Если вы хотите подключиться к службе, обратитесь к ServiceConnectConfiguration этой службы для списка clientAliases, которые вы можете использовать.

discoveryName -> (строка)

Имя обнаружения этого ресурса Service Connect.

discoveryName — это имя новой службы Cloud Map, созданной Amazon ECS для этой службы Amazon ECS. Это имя должно быть уникальным в пространстве имен Cloud Map. Имя может содержать до 64 символов. Имя может включать строчные буквы, цифры, символы подчеркивания (_) и дефисы (-). Имя не может начинаться с дефиса.

Если discoveryName не указано, используется имя сопоставления портов из определения задачи в portName.namespace.

discoveryArn -> (строка)

Идентификатор Amazon Resource Name (ARN) для пространства имен в Cloud Map, соответствующего имени обнаружения для этого ресурса Service Connect. Вы можете использовать этот ARN в других интеграциях с Cloud Map. Однако Service Connect не может гарантировать подключение за пределами Amazon ECS.

volumeConfigurations -> (список)

Подробности тома, который был configuredAtLaunch. Вы можете настроить различные параметры, такие как размер, пропускная способность, тип тома и шифрование в ServiceManagedEBSVolumeConfiguration. name тома должен соответствовать name из определения задачи.

(структура)

Конфигурация для тома, указанного в определении задачи в качестве тома, настроенного во время запуска. В настоящее время поддерживается только тип тома Amazon EBS.

name -> (строка)

Имя тома. Это значение должно соответствовать имени тома из объекта Volume в определении задачи.

managedEBSVolume -> (структура)

Конфигурация для тома Amazon EBS, который создается и управляется Amazon ECS от вашего имени. Эти параметры используются для создания каждого тома Amazon EBS, при этом для каждой задачи в службе создается по одному тому. Тома Amazon EBS будут видны в вашей учетной записи в консоли Amazon EC2 после их создания.

encrypted -> (булево)

Указывает, следует ли шифровать том. Если вы включили региональное шифрование Amazon EBS по умолчанию, но задали это значение как false, настройка перекрывается, и том шифруется с использованием ключа KMS, указанного для шифрования Amazon EBS по умолчанию. Этот параметр сопоставляется 1:1 с параметром Encrypted API CreateVolume в Справочнике по API Amazon EC2.

kmsKeyId -> (строка)

Идентификатор Amazon Resource Name (ARN) ключа службы управления ключами Amazon Web Services для шифрования тома Amazon EBS. Когда ключ указан с помощью этого параметра, он перекрывает шифрование Amazon EBS по умолчанию или любой ключ KMS, который вы указали для шифрования управляемого хранения на уровне кластера. Этот параметр сопоставляется 1:1 с параметром KmsKeyId API CreateVolume в Справочнике по API Amazon EC2. Дополнительную информацию о шифровании томов Amazon EBS, подключенных к задачам, см. в разделе Шифрование данных, хранящихся в томах Amazon EBS, подключенных к задачам Amazon ECS.

Предупреждение

Amazon Web Services аутентифицирует ключ службы управления ключами Amazon Web Services асинхронно. Поэтому, если вы укажете недопустимый идентификатор, псевдоним или ARN, действие может показаться завершенным, но в конечном итоге завершится неудачей.

volumeType -> (строка)

Тип тома. Этот параметр сопоставляется 1:1 с параметром VolumeType API CreateVolume в Справочнике по API Amazon EC2. Дополнительную информацию см. в разделе Типы томов Amazon EBS в Руководстве пользователя Amazon EC2.

Поддерживаются следующие типы томов.

  • SSD общего назначения: gp2 |gp3
  • SSD с предварительно заданным IOPS: io1 |io2
  • Оптимизированный по пропускной способности HDD: st1
  • HDD для холодного хранения: sc1
  • Магнитный: standard

Примечание

Тип магнитного тома не поддерживается в Fargate.

sizeInGiB -> (целое число)

Размер тома в GiB. Вы должны указать либо размер тома, либо идентификатор снимка. Если вы укажете идентификатор снимка, размер снимка по умолчанию используется для размера тома. Вы можете дополнительно указать размер тома, равный или больший размера снимка. Этот параметр сопоставляется 1:1 с параметром Size API CreateVolume в Справочнике по API Amazon EC2.

Поддерживаемые значения размера тома для каждого типа тома:

  • gp2 и gp3 : 1-16 384
  • io1 и io2 : 4-16 384
  • st1 и sc1 : 125-16 384
  • standard : 1-1024

snapshotId -> (строка)

Снимок, который Amazon ECS использует для создания томов для подключения к задачам, поддерживаемым службой. Вы должны указать либо snapshotId, либо sizeInGiB в вашей конфигурации тома. Этот параметр сопоставляется 1:1 с параметром SnapshotId API CreateVolume в Справочнике по API Amazon EC2.

volumeInitializationRate -> (целое число)

Скорость в MiB/с, с которой данные извлекаются из снимка существующего тома EBS для создания новых томов для подключения к задачам, поддерживаемым службой. Этот параметр может быть указан только если вы укажите snapshotId. Дополнительную информацию см. в разделе Инициализация томов Amazon EBS в Руководстве пользователя Amazon EBS.

iops -> (целое число)

Количество операций ввода-вывода в секунду (IOPS). Для томов gp3, io1 и io2 это число IOPS, выделенных для тома. Для томов gp2 это базовая производительность тома и скорость, с которой том накапливает кредиты I/O для увеличения пропускной способности.

Поддерживаемые значения для каждого типа тома:

  • gp3 : 3000 - 16 000 IOPS
  • io1 : 100 - 64 000 IOPS
  • io2 : 100 - 256 000 IOPS

Этот параметр требуется для типов томов io1 и io2. По умолчанию для томов gp3 — 3,000 IOPS. Этот параметр не поддерживается для типов томов st1, sc1 или standard.

Этот параметр сопоставляется 1:1 с параметром Iops API CreateVolume в Справочнике по API Amazon EC2.

throughput -> (целое число)

Пропускная способность для выделения тома в MiB/с, максимальное значение 1000 MiB/с. Этот параметр сопоставляется 1:1 с параметром Throughput API CreateVolume в Справочнике по API Amazon EC2.

Предупреждение

Этот параметр поддерживается только для типа тома gp3.

tagSpecifications -> (список)

Теги для применения к тому. Amazon ECS по умолчанию применяет управляемые службой теги. Этот параметр сопоставляется 1:1 с параметром TagSpecifications.N API CreateVolume в Справочнике по API Amazon EC2.

(структура)

Параметры тегов тома Amazon EBS.

resourceType -> (строка)

Тип ресурса тома.

tags -> (список)

Теги, применённые к этому тому Amazon EBS. AmazonECSCreated и AmazonECSManaged — это зарезервированные теги, которые нельзя использовать.

(структура)

Метаданные, которые вы применяете к ресурсу, чтобы помочь вам классифицировать и организовать их. Каждый тег состоит из ключа и необязательного значения. Вы их определяете.

Следующие базовые ограничения применяются к тегам:

  • Максимальное количество тегов на ресурс — 50
  • Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
  • Максимальная длина ключа — 128 символов Юникода в UTF-8
  • Максимальная длина значения — 256 символов Юникода в UTF-8
  • Если ваша схема тегирования используется в нескольких сервисах и ресурсах, помните, что другие службы могут иметь ограничения на допустимые символы. В целом, допустимые символы: буквы, цифры и пробелы, представимые в UTF-8, а также следующие символы: + - = . _ : / @.
  • Ключи и значения тегов чувствительны к регистру.
  • Не используйте aws:, AWS: или любые комбинации таких префиксов, как верхний или нижний регистр, для ключей или значений, так как они зарезервированы для использования Amazon Web Services. Вы не можете редактировать или удалять ключи или значения тегов с этим префиксом. Теги с этим префиксом не учитываются при подсчёте лимита тегов на ресурс.

key -> (строка)

Одна часть пары ключ-значение, составляющей тег. key — это общий ярлык, который действует как категория для более конкретных значений тегов.

value -> (строка)

Необязательная часть пары ключ-значение, составляющей тег. value действует как описатель в категории тега (ключ).

propagateTags -> (строка)

Определяет, распространять ли теги из определения задачи в том Amazon EBS. Теги могут быть распространены только на SERVICE, указанном в ServiceVolumeConfiguration. Если значение не указано, теги не распространяются.

roleArn -> (строка)

ARN роли IAM, которая должна быть связана с этим томом. Это роль IAM инфраструктуры Amazon ECS, используемая для управления вашей инфраструктурой Amazon Web Services. Мы рекомендуем использовать управляемую Amazon ECS политику IAM AmazonECSInfrastructureRolePolicyForVolumes с этой ролью. Дополнительную информацию см. в разделе Роль IAM инфраструктуры Amazon ECS в Руководстве разработчика Amazon ECS.

filesystemType -> (строка)

Тип файловой системы для тома. Для томов, созданных из снимка, необходимо указать тот же тип файловой системы, что и у тома при создании снимка. Если тип файловой системы не совпадает, задачи не будут запускаться.

Доступные типы файловых систем Linux — ext3, ext4 и xfs. Если значение не указано, используется тип файловой системы xfs по умолчанию.

Доступные типы файловых систем Windows — NTFS.

```

fargateEphemeralStorage -> (структура)

Настройки временного хранилища Fargate для развертывания.

kmsKeyId -> (строка)

Укажите идентификатор ключа Key Management Service для шифрования временного хранилища для развертывания.

vpcLatticeConfigurations -> (список)

Конфигурация VPC Lattice для развертывания сервиса.

(структура)

Конфигурация VPC Lattice для вашего сервиса, содержащая информацию о целевых группах, к которым будут регистрироваться задачи Amazon ECS.

roleArn -> (строка)

ARN роли IAM, которая должна быть связана с этой конфигурацией VPC Lattice. Это роль IAM инфраструктуры Amazon ECS, используемая для управления вашей инфраструктурой VPC Lattice.

targetGroupArn -> (строка)

Полный Amazon Resource Name (ARN) целевой группы или групп, связанных с конфигурацией VPC Lattice, к которым будут регистрироваться задачи Amazon ECS.

portName -> (строка)

Имя отображения порта для регистрации в целевой группе VPC Lattice. Это имя portMapping, которое вы определили в определении вашей задачи.

roleArn -> (строка)

ARN роли IAM, связанной с сервисом. Она позволяет агенту Amazon ECS контейнеров регистрировать экземпляры контейнеров с балансировщиком нагрузки Elastic Load Balancing.

events -> (список)

Поток событий для вашего сервиса. Отображаются не более 100 последних событий.

(структура)

Подробности события, связанного с сервисом.

id -> (строка)

Строковый идентификатор события.

createdAt -> (временная метка)

Временная метка Unix для момента запуска события.

message -> (строка)

Сообщение события.

createdAt -> (временная метка)

Временная метка Unix для момента создания сервиса.

placementConstraints -> (список)

Ограничения размещения для задач в сервисе.

(структура)

Объект, представляющий ограничение размещения задач. Дополнительную информацию см. в разделе Ограничения размещения задач в руководстве разработчика Amazon Elastic Container Service .

Примечание

Если вы используете тип запуска Fargate, ограничения размещения задач не поддерживаются.

type -> (строка)

Тип ограничения. Используйте distinctInstance, чтобы гарантировать, что каждая задача в определенной группе работает на разных экземплярах контейнеров. Используйте memberOf, чтобы ограничить выбор группой допустимых кандидатов.

expression -> (строка)

Выражение языка запросов кластера для применения ограничения. Длина выражения может составлять максимум 2000 символов. Вы не можете указать выражение, если тип ограничения - distinctInstance . Дополнительную информацию см. в разделе Язык запросов кластера в руководстве разработчика Amazon Elastic Container Service .

placementStrategy -> (список)

Стратегия размещения, определяющая, как размещаются задачи для сервиса.

(структура)

Стратегия размещения задач для задачи или сервиса. Дополнительную информацию см. в разделе Стратегии размещения задач в руководстве разработчика Amazon Elastic Container Service .

type -> (строка)

Тип стратегии размещения. random стратегия размещения случайным образом размещает задачи на доступных кандидатах. spread стратегия равномерно распределяет размещение по доступным кандидатам, основываясь на параметре field. binpack стратегия размещает задачи на доступных кандидатах, у которых наименьшее количество ресурсов, указанных в параметре field. Например, при использовании binpack по памяти задача размещается на экземпляре с наименьшим объемом свободной памяти, но достаточным для запуска задачи.

field -> (строка)

Поле, к которому применяется стратегия размещения. Для spread стратегии размещения допустимые значения — instanceId (или host, что имеет тот же эффект), или любой платформенный или пользовательский атрибут, применяемый к экземпляру контейнера, такой как attribute:ecs.availability-zone. Для binpack стратегии размещения допустимые значения — cpu и memory. Для random стратегии размещения это поле не используется.

networkConfiguration -> (структура)

Конфигурация подсети VPC и группы безопасности для задач, которые получают собственный эластичный сетевой интерфейс, используя режим сети awsvpc.

awsvpcConfiguration -> (структура)

Подсети VPC и группы безопасности, связанные с задачей.

Примечание

Все указанные подсети и группы безопасности должны быть из одной VPC.

subnets -> (список)

Идентификаторы подсетей, связанных с задачей или сервисом. Можно указать до 16 подсетей.

Примечание

Все указанные подсети должны быть из одной VPC.

(строка)

securityGroups -> (список)

Идентификаторы групп безопасности, связанные с задачей или сервисом. Если вы не указываете группу безопасности, используется группа безопасности по умолчанию для VPC. Можно указать до 5 групп безопасности.

Примечание

Все указанные группы безопасности должны быть из одной VPC.

(строка)

assignPublicIp -> (строка)

Получает ли эластичный сетевой интерфейс задачи общедоступный IP-адрес.

Учитывайте следующее при установке этого значения:

  • При использовании create-service или update-service значение по умолчанию — DISABLED.
  • Если сервис deploymentController находится в состоянии ECS, значение должно быть DISABLED.

healthCheckGracePeriodSeconds -> (целое число)

Период времени в секундах, в течение которого планировщик сервиса Amazon ECS игнорирует проверки состояния Elastic Load Balancing нездоровых целевых узлов после первоначального запуска задачи.

schedulingStrategy -> (строка)

Стратегия планирования для сервиса. Дополнительную информацию см. в разделе Сервисы.

Доступны две стратегии планирования сервисов.

  • REPLICA - Стратегия планирования реплик размещает и поддерживает нужное количество задач в кластере. По умолчанию планировщик сервиса распределяет задачи по зонам доступности. Вы можете использовать стратегии размещения задач и ограничения для настройки решений о размещении задач.
  • DAEMON - Стратегия планирования демонов разворачивает ровно одну задачу на каждом активном экземпляре контейнера. Эта задача соответствует всем ограничениям размещения задач, указанным в вашем кластере. Планировщик сервиса также оценивает ограничения размещения задач для запущенных задач. Он останавливает задачи, которые не соответствуют ограничениям размещения.

Примечание

Задачи Fargate не поддерживают стратегию планирования DAEMON.

deploymentController -> (структура)

Тип контроллера развертывания, используемый сервисом.

type -> (строка)

Тип контроллера развертывания для использования.

Доступны три типа контроллеров развертывания:

ECS

Тип развертывания с постепенным обновлением (ECS) подразумевает замену текущей запущенной версии контейнера на последнюю версию. Количество контейнеров, которое Amazon ECS добавляет или удаляет из сервиса во время постепенного обновления, контролируется путем изменения минимального и максимального количества здоровых задач, разрешенных во время развертывания сервиса, как указано в DeploymentConfiguration.

Дополнительную информацию о постепенных развертываниях см. в разделе Развертывание сервисов Amazon ECS заменой задач в руководстве разработчика Amazon Elastic Container Service .

CODE_DEPLOY

Тип развертывания синего/зеленого (CODE_DEPLOY) использует модель развертывания синего/зеленого, управляемую CodeDeploy, что позволяет проверять новое развертывание сервиса перед отправкой производственного трафика к нему.

Дополнительную информацию о развертываниях синего/зеленого см. в разделе Проверка состояния сервиса Amazon ECS перед развертыванием в руководстве разработчика Amazon Elastic Container Service .

EXTERNAL

Тип развертывания внешнего (EXTERNAL) позволяет использовать любой сторонний контроллер развертывания для полного управления процессом развертывания сервиса Amazon ECS.

Дополнительную информацию о внешних развертываниях см. в разделе Развертывание сервисов Amazon ECS с использованием стороннего контроллера в руководстве разработчика Amazon Elastic Container Service .

tags -> (список)

Метаданные, которые вы применяете к службе для категоризации и организации. Каждый тег состоит из ключа и необязательного значения. Вы определяете как ключ, так и значение.

Применяются следующие основные ограничения к тегам:

  • Максимальное количество тегов на ресурс - 50
  • Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
  • Максимальная длина ключа - 128 символов Юникода в UTF-8
  • Максимальная длина значения - 256 символов Юникода в UTF-8
  • Если ваша схема тегов используется в нескольких службах и ресурсах, помните, что другие службы могут иметь ограничения на разрешенные символы. В целом разрешенными символами являются: буквы, цифры и пробелы, отображаемые в UTF-8, а также следующие символы: + - = . _ : / @.
  • Ключи и значения тегов чувствительны к регистру.
  • Не используйте aws: , AWS: или любую комбинацию верхнего или нижнего регистра, такую как префикс для ключей или значений, так как он зарезервирован для использования Amazon Web Services. Вы не можете изменять или удалять ключи или значения тегов с этим префиксом. Теги с этим префиксом не учитываются при подсчете количества тегов на ресурс.

(структура)

Метаданные, которые вы применяете к ресурсу для категоризации и организации. Каждый тег состоит из ключа и необязательного значения. Вы определяете их.

Применяются следующие основные ограничения к тегам:

  • Максимальное количество тегов на ресурс - 50
  • Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
  • Максимальная длина ключа - 128 символов Юникода в UTF-8
  • Максимальная длина значения - 256 символов Юникода в UTF-8
  • Если ваша схема тегов используется в нескольких службах и ресурсах, помните, что другие службы могут иметь ограничения на разрешенные символы. В целом разрешенными символами являются: буквы, цифры и пробелы, отображаемые в UTF-8, а также следующие символы: + - = . _ : / @.
  • Ключи и значения тегов чувствительны к регистру.
  • Не используйте aws: , AWS: или любую комбинацию верхнего или нижнего регистра, такую как префикс для ключей или значений, так как он зарезервирован для использования Amazon Web Services. Вы не можете изменять или удалять ключи или значения тегов с этим префиксом. Теги с этим префиксом не учитываются при подсчете количества тегов на ресурс.

ключ -> (строка)

Одна часть пары ключ-значение, составляющей тег. key — это общий ярлык, который действует как категория для более конкретных значений тегов.

значение -> (строка)

Необязательная часть пары ключ-значение, составляющей тег. value действует как описание в рамках категории тега (ключ).

createdBy -> (строка)

Принципал, создавший службу.

enableECSManagedTags -> (булево)

Определяет, использовать ли управляемые Amazon ECS теги для задач в службе. Для получения дополнительной информации см. Раздел Разметка ваших ресурсов Amazon ECS в руководстве разработчика Amazon Elastic Container Service.

propagateTags -> (строка)

Определяет, распространять ли теги из определения задачи или службы на задачу. Если значение не указано, теги не распространяются.

enableExecuteCommand -> (булево)

Определяет, включена ли функциональность выполнения команд для службы. Если true, функциональность выполнения команд включена для всех контейнеров в задачах в составе службы.

availabilityZoneRebalancing -> (строка)

Указывает, использовать ли балансировку зон доступности для службы.

Дополнительные сведения см. в разделе Балансировка службы Amazon ECS по зонам доступности в * Руководстве разработчика Amazon Elastic Container Service *.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API