Spec-Zone.ru › Ansible 2.10

community.aws.cloudwatchlogs_log_group – создание или удаление группы журналов в CloudWatchLogs

Примечание

Этот плагин входит в состав коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

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

Новое в версии 1.0.0: коллекции community.aws

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Обзор

  • Создание или удаление группы журналов в CloudWatchLogs.

Требования

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

  • boto
  • boto3
  • botocore
  • json
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key
строка
Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
Если задан параметр profile, этот параметр игнорируется.
Одновременное указание параметров aws_access_key и profile устарело и станет взаимоисключающим после 2022-06-01.

Псевдонимы: ec2_access_key, access_key
aws_ca_bundle
путь
Расположение файла с сертификатами CA для проверки SSL-сертификатов.
Используется только для модулей, основанных на boto3.
Примечание: Файл CA Bundle считывается на стороне модуля и, возможно, должен быть явно скопирован с контроллера, если он не запускается локально.
aws_config
словарь
Словарь для изменения конфигурации botocore.
Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Для модулей boto используется только ключ 'user_agent'. Более подробная информация о конфигурации boto по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto.
aws_secret_key
строка
Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
Если задан параметр profile, этот параметр игнорируется.
Одновременное указание параметров aws_secret_key и profile устарело и станет взаимоисключающим после 2022-06-01.

Псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
логический тип
    Варианты:
  • нет ←
  • да
Используйте логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», произведенных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время плейбука. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url
строка
URL для подключения к EC2 или вашей облачной системе Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковая имеется.

Псевдонимы: aws_endpoint_url, endpoint_url
kms_key_id
строка
Amazon Resource Name (ARN) CMK для шифрования данных журналов.
log_group_name
строка / обязательно
Имя группы журналов.
overwrite
логический тип
    Варианты:
  • нет ←
  • да
Указывает, следует ли перезаписывать существующую группу журналов при создании.
Взаимоисключающий параметр с purge_retention_policy.
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
Использование profile переопределит aws_access_key, aws_secret_key и security_token, и поддержка одновременного их указания с profile устарела.
aws_access_key, aws_secret_key и security_token станут взаимоисключающими с profile после 2022-06-01.

Псевдонимы: aws_profile
purge_retention_policy
логический тип
    Варианты:
  • нет ←
  • да
Указывает, следует ли очищать политику удержания.
Взаимоисключающий параметр с retention и overwrite.
region
строка
Регион AWS для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

Псевдонимы: aws_region, ec2_region
retention
целое число
Количество дней, в течение которых следует удерживать события журнала в указанной группе журналов.
Допустимые значения: [1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653]
Взаимоисключающий параметр с purge_retention_policy.
security_token
строка
Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
Если задан параметр profile, этот параметр игнорируется.
Одновременное указание параметров security_token и profile устарело и станет взаимоисключающим после 2022-06-01.

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

Примечания

Примечание

  • Подробная информация о параметрах и возвращаемых значениях находится по адресу http://boto3.readthedocs.io/en/latest/reference/services/logs.html.
  • Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE.
  • 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.

- community.aws.cloudwatchlogs_log_group:
    log_group_name: test-log-group

- community.aws.cloudwatchlogs_log_group:
    state: present
    log_group_name: test-log-group
    tags: { "Name": "test-log-group", "Env" : "QA" }

- community.aws.cloudwatchlogs_log_group:
    state: present
    log_group_name: test-log-group
    tags: { "Name": "test-log-group", "Env" : "QA" }
    kms_key_id: arn:aws:kms:region:account-id:key/key-id

- community.aws.cloudwatchlogs_log_group:
    state: absent
    log_group_name: test-log-group

Значения возврата

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

Ключ Возвращаемое значение Описание
log_groups
complex
success
Возвращает список комплексных объектов, представляющих группы журналов.
arn
string
всегда
Amazon Resource Name (ARN) группы журналов.
creation_time
integer
всегда
Время создания группы журналов.
kms_key_id
string
всегда
Amazon Resource Name (ARN) CMK, используемого при шифровании данных журналов.
log_group_name
string
всегда
Имя группы журналов.
metric_filter_count
integer
всегда
Количество фильтров метрик.
retention_in_days
integer
всегда
Количество дней хранения событий журналов в указанной группе журналов.
stored_bytes
string
всегда
Количество сохраненных байтов.


Авторы

  • 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.10/collections/community/aws/cloudwatchlogs_log_group_module.html

Spec-Zone.ru

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