Spec-Zone.ru › AWS CLI v2

[ aws . ecs ]

describe-service-revisions

Описание

Описывает одну или несколько версий сервиса.

Версия сервиса — это версия сервиса, которая включает значения для ресурсов Amazon ECS (например, определения задачи) и ресурсов среды (например, балансировщики нагрузки, подсети и группы безопасности). Дополнительную информацию см. в разделе Версии сервисов Amazon ECS .

Вы не можете описать версию сервиса, созданную до 25 октября 2024 года.

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

Синтаксис

  describe-service-revisions
--service-revision-arns <value>
[--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]

Параметры

--service-revision-arns (список)

ARN версии сервиса.

Вы можете указать до 20 ARN.

Вы можете вызвать ListServiceDeployments для получения ARN.

(строка)

Синтаксис:

"string" "string" ...

--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 (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

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

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

Файл сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--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 в Руководстве пользователя AWS CLI.

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

Для описания деталей версии сервиса

Следующий describe-service-revisions пример возвращает данные о версии сервиса для версии сервиса с ARN arn:aws:ecs:us-east-1:123456789012:service-revision/example-cluster/example-service/1485800978477494678.

aws ecs describe-service-revisions \
    --service-revision-arns arn:aws:ecs:us-east-1:123456789012:service-revision/example-cluster/example-service/1485800978477494678

Вывод:

{
    "serviceRevisions": [
        {
            "serviceRevisionArn": "arn:aws:ecs:us-east-1:123456789012:service-revision/example-cluster/example-service/1485800978477494678",
            "serviceArn": "arn:aws:ecs:us-east-1:123456789012:service/example-cluster/example-service",
            "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/example-cluster",
            "taskDefinition": "arn:aws:ecs:us-east-1:123456789012:task-definition/webserver:5",
            "capacityProviderStrategy": [
                {
                    "capacityProvider": "FARGATE",
                    "weight": 1,
                    "base": 0
                }
            ],
            "platformVersion": "1.4.0",
            "platformFamily": "Linux",
            "networkConfiguration": {
                "awsvpcConfiguration": {
                    "subnets": [
                        "subnet-0d0eab1bb38d5ca64",
                        "subnet-0db5010045995c2d5"
                    ],
                    "securityGroups": [
                        "sg-02556bf85a191f59a"
                    ],
                    "assignPublicIp": "ENABLED"
                }
            },
            "containerImages": [
                {
                    "containerName": "aws-otel-collector",
                    "imageDigest": "sha256:7a1b3560655071bcacd66902c20ebe9a69470d5691fe3bd36baace7c2f3c4640",
                    "image": "public.ecr.aws/aws-observability/aws-otel-collector:v0.32.0"
                },
                {
                    "containerName": "web",
                    "imageDigest": "sha256:28402db69fec7c17e179ea87882667f1e054391138f77ffaf0c3eb388efc3ffb",
                    "image": "nginx"
                }
            ],
            "guardDutyEnabled": false,
            "serviceConnectConfiguration": {
                "enabled": false
            },
            "createdAt": "2024-10-31T08:03:29.302000-04:00"
        }
    ],
    "failures": []
}

Дополнительную информацию см. в разделе Версии сервисов Amazon ECS в Руководстве разработчика Amazon ECS.

Вывод

serviceRevisions -> (список)

Список описанных версий сервиса.

(структура)

Информация о ревизии сервиса.

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

serviceRevisionArn -> (string)

ARN ревизии сервиса.

serviceArn -> (string)

ARN сервиса для ревизии сервиса.

clusterArn -> (string)

ARN кластера, в котором размещен сервис.

taskDefinition -> (string)

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

capacityProviderStrategy -> (list)

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

(структура)

Подробности стратегии поставщика емкостей. Стратегию поставщика емкостей можно задать при использовании 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 -> (string)

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

weight -> (integer)

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

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

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

base -> (integer)

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

launchType -> (string)

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

platformVersion -> (string)

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

platformFamily -> (string)

Семейство платформ, используемое ревизией сервиса.

loadBalancers -> (list)

Нагрузка балансировщиков, используемых ревизией сервиса.

(структура)

Конфигурация балансировщика нагрузки для использования с сервисом или набором задач.

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

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

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

targetGroupArn -> (string)

Полный 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 -> (string)

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

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

containerName -> (string)

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

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

containerPort -> (integer)

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

serviceRegistries -> (list)

Регистры сервисов (для Service Discovery), используемые ревизией сервиса.

(структура)

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

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

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

registryArn -> (string)

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

port -> (integer)

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

containerName -> (string)

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

containerPort -> (integer)

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

networkConfiguration -> (structure)

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

awsvpcConfiguration -> (structure)

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

Примечание

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

subnets -> (list)

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

Примечание

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

(string)

securityGroups -> (list)

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

Примечание

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

(string)

assignPublicIp -> (string)

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

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

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

containerImages -> (list)

Контейнерные образы, используемые версией службы.

(структура)

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

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

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

containerName -> (строка)

Имя контейнера.

imageDigest -> (строка)

Дайджест контейнерного образа.

image -> (строка)

Контейнерный образ.

guardDutyEnabled -> (булево)

Указывает, включён ли мониторинг выполнения.

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

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

Задачи, выполняемые в пространстве имен, могут использовать короткие имена для подключения к службам в пространстве имен. Задачи могут подключаться к службам через все кластеры в пространстве имен. Задачи подключаются через управляемый контейнер-прокси, который собирает журналы и метрики для повышения видимости. Поддерживаются только задачи, созданные сервисами 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)

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

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

Задачи, выполняемые в пространстве имен, могут использовать короткие имена для подключения к службам в пространстве имен. Задачи могут подключаться к службам через все кластеры в пространстве имен. Задачи подключаются через управляемый контейнер-прокси, который собирает журналы и метрики для повышения видимости. Поддерживаются только задачи, созданные сервисами 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 в определении задачи. В режиме моста значение по умолчанию — временный порт прокси Service Connect.

timeout -> (structure)

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

idleTimeoutSeconds -> (integer)

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

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

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

perRequestTimeoutSeconds -> (integer)

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

tls -> (structure)

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

issuerCertificateAuthority -> (structure)

Сертификат центра сертификации.

awsPcaAuthorityArn -> (string)

ARN сертификата центра сертификации Amazon Web Services.

kmsKey -> (string)

Ключ Amazon Web Services Key Management Service.

roleArn -> (string)

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

logConfiguration -> (structure)

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

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

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

  • В настоящее время Amazon ECS поддерживает подмножество драйверов журналов, доступных для демонтажа Docker. Дополнительные драйверы журналов могут быть доступны в будущих версиях агента контейнеров 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 Partner.

Примечание

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

options -> (map)

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

Доступные параметры зависят от драйвера регистрации. Некоторые из параметров, которые можно указать при использовании драйвера 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 в качестве параметров.

Этот параметр требует версии Docker Remote API 1.19 или выше на вашем экземпляре контейнера. Чтобы проверить версию 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 Parameter Store) в руководстве разработчика Amazon Elastic Container Service.

Примечание

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

volumeConfigurations -> (список)

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

(структура)

Настройка тома, указанного в определении задачи как тома, настроенного во время запуска. В настоящее время поддерживается только тип тома 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 с предоставленным количеством операций ввода-вывода: io1 |io2
  • Жёсткий диск с оптимизированной пропускной способностью: st1
  • Жёсткий диск для холодного хранения: sc1
  • Магнитный: standard

Примечание

Тип тома «Магнитный» не поддерживается в Fargate.

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

Размер тома в ГБ. Вы должны указать либо размер тома, либо идентификатор моментального снимка. Если вы указываете идентификатор моментального снимка, размер моментального снимка используется по умолчанию для размера тома. Вы можете дополнительно указать размер тома, равный или больший размера моментального снимка. Этот параметр отображается 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 -> (целое число)

Скорость, в Мбайт/с, с которой данные извлекаются из моментального снимка существующего тома 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 -> (целое число)

Пропускная способность для выделения тома в Мбайт/с, с максимальным значением 1000 Мбайт/с. Этот параметр отображается 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 -> (строка)

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

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 -> (структура)

Объём временного хранилища, выделяемого для развертывания.

kmsKeyId -> (строка)

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

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

Время создания сервисной ревизии. Формат — yyyy-mm-dd чч:мм:сс.мсмс.

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, которое вы определили в определении задачи.

failures -> (список)

Любые ошибки, связанные с вызовом.

(структура)

Неудачный ресурс. Список распространённых причин см. в разделе Причины ошибок API в Руководстве разработчика Amazon Elastic Container Service.

arn -> (строка)

Amazon Resource Name (ARN) неисправного ресурса.

reason -> (строка)

Причина ошибки.

detail -> (строка)

Подробности ошибки.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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