Модуль community.aws.ecs_service_info — список или описание сервисов в ECS

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.aws.ecs_service_info.

Добавлено в community.aws 1.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Перечисляет или описывает сервисы в ECS.

Требования

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

python >= 3.6
boto3 >= 1.34.0
botocore >= 1.34.0

Параметры

Параметр	Описание
access_key псевдонимы: aws_access_key_id, aws_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` (в порядке убывания приоритета). Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore.
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.
cluster строка	ARN кластеров, в которых нужно перечислить сервисы.
debug_botocore_endpoint_logs логический тип	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общего числа) вызовов API `"resource:action"`, выполненных во время задачи, и выводить набор в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в ходе плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
details логический тип	Установите значение true, если нужна подробная информация о сервисах. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Его можно использовать для подключения к другим совместимым с AWS сервисам, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
events логический тип	Возвращать ли события сервиса ECS. Действует только при details=true. Варианты: `false` `true` ← (по умолчанию)
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 и session_token.
region псевдонимы: aws_region строка	Используемый регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_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` (в порядке убывания приоритета). Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore.
service псевдонимы: name список / элементы=строки	Один или несколько сервисов, сведения о которых нужно получить
session_token псевдонимы: aws_session_token строка	Токен сеанса 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`. Параметры session_token и profile являются взаимоисключающими.
validate_certs логический тип	Если задано значение `false`, SSL-сертификаты при взаимодействии с API AWS не проверяются. Настоятельно не рекомендуется устанавливать validate_certs=false; в качестве альтернативы рассмотрите возможность задать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
Используемый Ansible AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Basic listing example
- community.aws.ecs_service_info:
    cluster: test-cluster
    service: console-test-service
    details: true
  register: output

# Basic listing example
- community.aws.ecs_service_info:
    cluster: test-cluster
  register: output

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
services сложный тип	Если details имеет значение false, возвращает массив ARN сервисов; в противном случае — массив сложных объектов, описанных ниже. Возвращается: при успешном выполнении
clusterArn строка	Amazon Resource Name (ARN) кластера, в котором размещен сервис. Возвращается: всегда
deployments список / элементы=словарь	Список развертываний сервиса Возвращается: всегда
desiredCount целое число	Желаемое количество экземпляров определения задачи, которые должны выполняться в сервисе. Возвращается: всегда
events список / элементы=словарь	Список событий сервиса Возвращается: если events имеет значение true
loadBalancers сложный тип	Список объектов балансировщиков нагрузки Возвращается: всегда
containerName строка	Имя контейнера, связываемого с балансировщиком нагрузки. Возвращается: всегда
containerPort целое число	Порт контейнера, связываемый с балансировщиком нагрузки. Возвращается: всегда
loadBalancerName строка	Имя Возвращается: всегда
pendingCount целое число	Количество задач в кластере, находящихся в состоянии PENDING. Возвращается: всегда
runningCount целое число	Количество задач в кластере, находящихся в состоянии RUNNING. Возвращается: всегда
serviceArn строка	Amazon Resource Name (ARN), идентифицирующий сервис. ARN содержит пространство имен arn:aws:ecs, за которым следуют регион сервиса, идентификатор учетной записи AWS владельца сервиса, пространство имен сервиса и имя сервиса. Возвращается: всегда Пример: `"arn:aws:ecs:us-east-1:123456789012:service/my-service"`
serviceName строка	Созданная пользователем строка для идентификации сервиса Возвращается: всегда
status строка	Допустимые значения: ACTIVE, DRAINING или INACTIVE. Возвращается: всегда
taskDefinition строка	ARN определения задачи, используемого для задач в сервисе. Возвращается: всегда

Авторы

Mark Chance (@Java1Guy)
Darek Kaczynski (@kaczynskid)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/ecs_service_info_module.html