community.aws.ecs_service_info модуль — Список или описание служб в ECS

Примечание

Этот модуль входит в коллекцию community.aws (версия 8.0.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.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
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 путь	Расположение файла с корневым сертификатом для проверки 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` логгер для анализа уникальных (а не общих) `"resource:action"` API-вызовов, выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте `aws_resource_action` обратный вызов для вывода полного списка, созданного во время выполнения playbook. Также может использоваться переменная окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
details логический тип	Установите в значение true, если требуется подробная информация о службах. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws протестированы только против AWS. Также могут использоваться переменные окружения `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной окружения `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
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 и security_token.
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.
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 для соответствия SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.
service псевдонимы: name список / элементы=строка	Один или несколько сервисов, для которых требуется информация.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

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

См. документацию AWS для получения дополнительной информации об access-токенах 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.

validate_certs

boolean

При установке в false, сертификаты SSL не будут проверяться при общении с API AWS.

Установка validate_certs=false настоятельно не рекомендуется, в качестве альтернативы можно установить aws_ca_bundle.

Варианты:

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

Примечания

Примечание

Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хоста», а не «контроллера». Поэтому файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллера», а не «хоста».
AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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 ложно, возвращает массив ARNs сервисов, в противном случае массив сложных объектов, как описано ниже. Возвращается: успех
clusterArn строка	Amazon Resource Name (ARN) кластера, в котором размещён сервис. Возвращается: всегда
deployments список / элементы=словарь	список развертываний сервиса Возвращается: всегда
desiredCount целое число	Желаемое число экземпляров определения задачи, которые должны выполняться в сервисе. Возвращается: всегда
events список / элементы=словарь	список событий сервиса Возвращается: если events равно true
loadBalancers сложный	Список объектов балансировщиков нагрузки Возвращается: всегда
containerName строка	Имя контейнера, который нужно ассоциировать с балансировщиком нагрузки. Возвращается: всегда
containerPort целое число	Порт контейнера, который нужно ассоциировать с балансировщиком нагрузки. Возвращается: всегда
loadBalancerName строка	название Возвращается: всегда
pendingCount целое число	Количество задач в кластере, которые находятся в состоянии ОЖИДАНИЯ. Возвращается: всегда
runningCount целое число	Количество задач в кластере, которые находятся в состоянии ВЫПОЛНЕНИЯ. Возвращается: всегда
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/ecs_service_info_module.html