Spec-Zone.ru › Ansible 2.9

cloudwatchlogs_log_group_info – получение информации о группе журналов в CloudWatchLogs

Новая версия 2.5.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Обзор

  • Перечисляет указанные группы журналов. Вы можете перечислить все группы журналов или отфильтровать результаты по префиксу.
  • Этот модуль назывался cloudwatchlogs_log_group_facts перед Ansible 2.9. Использование не изменилось.

Псевдонимы: cloudwatchlogs_log_group_facts

Требования

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

  • boto
  • boto3
  • botocore
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key
строка
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.

Псевдонимы: ec2_access_key, access_key
aws_secret_key
строка
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.

Псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
логический тип
добавлено в 2.8
    Варианты:
  • нет ←
  • да
Используйте регистрирующий механизм botocore.endpoint для анализа уникальных (а не общих) API-вызовов "ресурс:действие", выполненных во время задачи, выводив набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, выполненного во время выполнения книги задач. Также может быть использована переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url
строка
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если не используется регион. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется.
log_group_name
-
Имя или префикс группы журналов для фильтрации.
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
region
строка
AWS-регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

Псевдонимы: aws_region, ec2_region
security_token
строка
AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

Псевдонимы: access_token
validate_certs
логический тип
    Варианты:
  • нет
  • да ←
При значении "нет", сертификаты SSL не будут проверяться для версий boto >= 2.6.0.

Примечания

Примечание

  • Если параметры не заданы в модуле, могут быть использованы следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION
  • Ansible использует конфигурационный файл boto (как правило, ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION или EC2_REGION могут использоваться для указания AWS-региона, если он требуется, но это также может быть настроено в файле конфигурации boto

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.
- cloudwatchlogs_log_group_info:
    log_group_name: test-log-group

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

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

Ключ Возвращаемое значение Описание
log_groups
сложный тип
успех
Возвращает список сложных объектов, представляющих группы журналов

arn
строка
всегда
Amazon Resource Name (ARN) группы журналов.

creation_time
целое число
всегда
Время создания группы журналов.

kms_key_id
строка
всегда
Amazon Resource Name (ARN) CMK для использования при шифровании данных журналов.

log_group_name
строка
всегда
Имя группы журналов.

metric_filter_count
целое число
всегда
Количество фильтров метрик.

retention_in_days
целое число
всегда
Количество дней хранения событий журнала в указанной группе журналов.

stored_bytes
строка
всегда
Количество сохранённых байт.



Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [предварительная версия]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Willian Ricardo (@willricardo) <willricardo@gmail.com>

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ для его улучшения.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/cloudwatchlogs_log_group_info_module.html

Spec-Zone.ru

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