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

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

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

Описание

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

Требования

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

boto
boto3
botocore
json
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 для вывода в общий список, созданный во время выполнения сценария.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковая имеется.
kms_key_id -		Идентификатор CMK (Amazon Resource Name) для шифрования данных журнала.
log_group_name - / обязательно		Имя группы журналов.
overwrite логический тип	Варианты: нет ← да	Определяет, нужно ли перезаписывать существующую группу журналов при создании.
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
retention -		Количество дней хранения событий журнала в указанной группе журналов. Допустимые значения: [1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653]
security_token строка		Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_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_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:
    log_group_name: test-log-group

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

- 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

- cloudwatchlogs_log_group:
    state: absent
    log_group_name: test-log-group

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

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

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

Статус

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

Авторы

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.8/modules/cloudwatchlogs_log_group_module.html