Модуль community.aws.ecs_service – Создание, завершение, запуск или остановка сервиса в ECS

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key

строка

Идентификатор ключа доступа AWS.

См. документацию AWS для получения дополнительной информации о маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут использоваться переменные среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile взаимоисключающие.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

aws_ca_bundle

путь

Расположение пакета CA для проверки сертификатов SSL.

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

aws_config

словарь

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

capacity_provider_strategy

список / элементы=словарь

добавлено в community.aws 4.0.0

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

По умолчанию: []

base

целое число

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

capacity_provider

строка

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

weight

целое число

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

client_token

строка

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Разрешается до 32 ASCII символов.

По умолчанию: ""

cluster

строка

Имя кластера, в котором существует служба.

Если не указано, имя кластера будет default.

По умолчанию: "default"

debug_botocore_endpoint_logs

логический

Использовать botocore.endpoint логгер для анализа уникальных (а не общих) "resource:action" API-вызовов, сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте aws_resource_action обратный вызов для вывода в общий список, сделанный во время выполнения playbook.

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

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

• false ← (по умолчанию)
• true

delay

целое число

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

По умолчанию: 10

deployment_configuration

словарь

Дополнительные параметры, которые контролируют deployment_configuration.

Формат — ‘{“maximum_percent”:<целое число>, “minimum_healthy_percent”:<целое число>}

По умолчанию: {}

deployment_circuit_breaker

словарь

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

enable

логический

Если включено, развертывание службы перейдет в состояние ошибки и прекратит запуск новых задач.

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

• false
• true

rollback

логический

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

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

• false
• true

maximum_percent

целое число

Верхний предел количества задач в службе, которые разрешены в состояниях RUNNING или PENDING во время развертывания.

minimum_healthy_percent

целое число

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

deployment_controller

dictionary

added in community.aws 4.1.0

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

По умолчанию: {}

type

string

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

Варианты:

• "ECS"
• "CODE_DEPLOY"
• "EXTERNAL"

desired_count

integer

Количество экземпляров службы.

Этот параметр требуется, когда state=present.

enable_execute_command

boolean

added in community.aws 5.4.0

Включить или выключить функциональность выполнения команд для контейнеров в задаче ECS.

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

Варианты:

• false
• true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только с AWS.

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

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной окружения EC2_URL устарела и будет удалена в релизе после 2024-12-01.

force_deletion

boolean

added in community.aws 2.1.0

Принудительно удалить службу. Требуется при удалении службы с масштабированием >0 или без целевой группы.

Варианты:

• false ← (по умолчанию)
• true

force_new_deployment

boolean

Принудительно развернуть службу, даже если изменений нет.

Варианты:

• false ← (по умолчанию)
• true

health_check_grace_period_seconds

integer

Секунды ожидания перед проверкой работоспособности недавно добавленных/обновленных служб.

launch_type

string

Тип запуска службы.

Варианты:

• "EC2"
• "FARGATE"

load_balancers

list / elements=dictionary

Список ELB, определенных для этой службы.

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

При контроллере развертывания CODE_DEPLOY изменения этого значения просто игнорируются и не приводят к ошибке.

По умолчанию: []

name

aliases: service

string / обязательно

Имя службы.

network_configuration

dictionary

Конфигурация сети службы. Применимо только для определений задач, созданных с network_mode=awsvpc.

assign_public_ip

boolean

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

Варианты:

• false
• true

security_groups

list / elements=string

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

subnets

list / elements=string

Список идентификаторов подсетей, которые необходимо связать с задачей.

placement_constraints

list / elements=dictionary

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

Дополнительные сведения см. на странице https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PlacementConstraint.html.

По умолчанию: []

expression

string

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

type

string

Тип ограничения.

placement_strategy

список / элементы=словарь

Объекты стратегии размещения для задач в вашем сервисе. Вы можете указать не более 5 правил стратегии на сервис.

По умолчанию: []

field

строка

Поле для применения стратегии размещения.

type

строка

Тип стратегии размещения.

platform_version

строка

добавлено в community.aws 1.5.0

Числовая часть версии платформы или LATEST

См. https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html для получения более подробной информации.

profile

псевдонимы: aws_profile

строка

Используемый профиль AWS для аутентификации.

См. документацию AWS для получения более подробной информации о профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также может быть использована переменная среды AWS_PROFILE

Параметр profile несовместим с параметрами aws_access_key, aws_secret_key и security_token.

propagate_tags

строка

добавлено в community.aws 4.1.0

Распространять теги из определения задачи ECS или сервиса ECS в задачу ECS.

Варианты:

• "TASK_DEFINITION"
• "SERVICE"

purge_placement_constraints

логическое

добавлено в community.aws 5.3.0

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

По умолчанию purge_placement_constraints=false. В версии 9.0.0 это будет изменено на purge_placement_constraints=true.

Варианты:

• false ← (по умолчанию)
• true

purge_placement_strategy

логическое

добавлено в community.aws 5.3.0

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

По умолчанию purge_placement_strategy=false. В версии 9.0.0 это будет изменено на purge_placement_strategy=true.

Варианты:

• false ← (по умолчанию)
• true

region

псевдонимы: aws_region, ec2_region

строка

Регион AWS для использования.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется.

Также могут быть использованы переменные среды AWS_REGION или EC2_REGION

См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

repeat

целое число

Количество попыток проверки доступности сервиса.

По умолчанию: 10

role

строка

Имя или полный Amazon Resource Name (ARN) роли IAM, которая позволяет вашему контейнерному агенту Amazon ECS делать вызовы к вашему балансировщику нагрузки от вашего имени.

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

По умолчанию: ""

scheduling_strategy

строка

Стратегия планирования.

По умолчанию REPLICA, если не задано, для сохранения предыдущего поведения.

Варианты:

• "DAEMON"
• "REPLICA"

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key

строка

Секретный ключ доступа AWS.

См. документацию AWS для получения дополнительной информации об маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут быть использованы переменные среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, или EC2_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile взаимоисключают друг друга.

Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для обеспечения согласованности с AWS botocore SDK.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

service_registries

список / элементы=словарь

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

По умолчанию: []

arn

строка

ARN регистра обнаружения сервиса.

container_name

string

Имя контейнера для регистрации службы обнаружения контейнеров.

container_port

integer

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

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

Токен сеанса AWS STS для использования с временными учетными данными.

Дополнительную информацию об маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут быть использованы переменные окружения AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры security_token и profile взаимоисключающие.

Алиасы aws_session_token и session_token были добавлены в релизе 3.2.0, при этом параметр был переименован из security_token в session_token в релизе 6.0.0.

Алиасы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

state

string / обязательно

Желаемое состояние службы.

Выборы:

• "present"
• "absent"
• "deleting"

tags

словарь

добавлено в community.aws 4.1.0

Словарь тегов для добавления или удаления из ресурса.

task_definition

строка

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

Этот параметр обязателен, когда state=present, если не указано force_new_deployment=True.

Этот параметр игнорируется при обновлении службы с CODE_DEPLOY контроллером развертывания, в этом случае определение задачи управляется Code Pipeline и не может быть обновлено.

validate_certs

логическое

Если установлено false, сертификаты SSL не будут проверены для связи с API AWS.

Установка validate_certs=false категорически не рекомендуется; вместо этого рассмотрите возможность установки aws_ca_bundle.

Выбори:

• false
• true ← (по умолчанию)

wait

логическое

добавлено в community.aws 4.1.0

Ожидать ли, пока служба не станет неактивной.

Ожидание выполняется только при state absent.

Выбори:

• false ← (по умолчанию)
• true

service

complex

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

Возвращено: когда служба существовала и была удалена

clusterArn

string

Универсальное имя ресурса (ARN) кластера, на котором размещается служба.

Возвращено: всегда

deploymentConfiguration

complex

словарь deploymentConfiguration

Возвращено: всегда

deploymentCircuitBreaker

complex

словарь deploymentCircuitBreaker

Возвращено: всегда

enable

boolean

Состояние функции прерывателя цепи.

Возвращено: всегда

rollback

boolean

Состояние функции отката прерывателя цепи.

Возвращено: всегда

maximumPercent

integer

Параметр maximumPercent

Возвращено: всегда

minimumHealthyPercent

integer

Параметр minimumHealthyPercent

Возвращено: всегда

deployments

list / elements=dictionary

Список развертываний служб

Возвращено: всегда

desiredCount

integer

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

Возвращено: всегда

events

list / elements=dictionary

Список событий службы

Возвращено: всегда

loadBalancers

complex

Список объектов балансировщиков нагрузки

Возвращено: всегда

containerName

string

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

Возвращено: всегда

containerPort

integer

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

Возвращено: всегда

loadBalancerName

string

имя

Возвращено: всегда

pendingCount

integer

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

Возвращено: всегда

placementConstraints

list / elements=dictionary

Список объектов ограничений размещения

Возвращено: всегда

expression

string

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

Возвращено: всегда

type

string

Тип ограничения. Допустимые значения — distinctInstance и memberOf.

Возвращено: всегда

placementStrategy

list / elements=dictionary

Список объектов стратегии размещения

Возвращено: всегда

Поле

строка

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

Возвращается: всегда

Тип

строка

Тип стратегии размещения. Допустимые значения — random, spread и binpack.

Возвращается: всегда

propagateTags

строка

Тип распространения тегов, применяемых к ресурсу.

Возвращается: всегда

runningCount

целое число

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

Возвращается: всегда

serviceArn

строка

Amazon Resource Name (ARN), определяющий сервис. ARN содержит пространство имён arn:aws:ecs, за которым следует регион сервиса, идентификатор учётной записи AWS владельца сервиса, пространство имён сервиса и затем имя сервиса.

Возвращается: всегда

Пример: "arn:aws:ecs:us-east-1:123456789012:service/my-service"

ИмяСервиса

строка

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

Возвращается: всегда

Статус

строка

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

Возвращается: всегда

Теги

список / элементы=словарь

Теги, применённые к этому ресурсу.

Возвращается: при наличии тегов

taskDefinition

строка

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

Возвращается: всегда

service

complex

Подробная информация о созданном сервисе.

Возвращается: при создании сервиса

capacityProviderStrategy

complex

added in community.aws 4.0.0

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

Возвращается: всегда

base

integer

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

Возвращается: всегда

capacityProvider

string

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

Возвращается: всегда

weight

integer

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

Возвращается: всегда

clusterArn

string

Универсальное имя ресурса (ARN) кластера, который размещает сервис.

Возвращается: всегда

deploymentConfiguration

complex

Словарь deploymentConfiguration

Возвращается: всегда

deploymentCircuitBreaker

complex

Словарь deploymentCircuitBreaker

Возвращается: всегда

enable

boolean

Состояние функции прерывателя цепи развертывания.

Возвращается: всегда

rollback

boolean

Состояние функции отката прерывателя цепи.

Возвращается: всегда

maximumPercent

integer

Параметр maximumPercent

Возвращается: всегда

minimumHealthyPercent

integer

Параметр minimumHealthyPercent

Возвращается: всегда

deployments

list / elements=dictionary

Список развертываний сервиса

Возвращается: всегда

desiredCount

integer

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

Возвращается: всегда

events

list / elements=dictionary

Список событий сервиса

Возвращается: всегда

loadBalancers

complex

Список объектов балансировщиков нагрузки

Обновление конфигурации балансировщика нагрузки существующего сервиса требует botocore>=1.24.14.

Возвращается: всегда

containerName

string

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

Возвращается: всегда

containerPort

integer

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

Возвращается: всегда

loadBalancerName

string

имя

Возвращается: всегда

pendingCount

integer

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

Возвращается: всегда

placementConstraints

list / elements=dictionary

Список объектов ограничений размещения

Возвращается: всегда

expression

string

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

Возвращается: всегда

type

string

Тип ограничения. Допустимые значения — distinctInstance и memberOf.

Возвращается: всегда

placementStrategy

list / elements=dictionary

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

Возвращается: всегда

field

string

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

Возвращается: всегда

type

string

Тип стратегии размещения. Допустимые значения — random, spread и binpack.

Возвращается: всегда

propagateTags

string

Тип распространения тегов, применяемых к ресурсу.

Возвращается: всегда

runningCount

integer

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

Возвращается: всегда

serviceArn

string

Amazon Resource Name (ARN), идентифицирующий сервис. ARN содержит arn:aws:ecs пространство имён, за которым следует регион сервиса, идентификатор AWS учётной записи владельца сервиса, пространство имён сервиса и затем имя сервиса.

Возвращается: всегда

Пример: "arn:aws:ecs:us-east-1:123456789012:service/my-service"

serviceName

string

Строка, введённая пользователем, используемая для идентификации сервиса

Возвращается: всегда

status

string

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

Возвращается: всегда

tags

dictionary

Применённые к этому ресурсу теги.

Возвращается: успех

taskDefinition

string

ARN определения задачи для использования в задачах сервиса.

Возвращается: всегда