cloudwatchlogs_log_group - создание или удаление группы журналов в CloudWatchLogs
Новая в версии 2.5.
Описание
- Создание или удаление группы журналов в CloudWatchLogs.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- boto3
- botocore
- json
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key | Значение по умолчанию: None | Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key |
| aws_secret_key | Значение по умолчанию: None | Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key |
| ec2_url | Значение по умолчанию: None | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть. |
| kms_key_id | Amazon Resource Name (ARN) CMK для шифрования данных журналов. | |
| log_group_name обязательно | Имя группы журналов. | |
| overwrite | Значение по умолчанию: нет | Нужно ли перезаписывать существующую группу журналов при создании. |
| profile (добавлено в 1.6) | Значение по умолчанию: None | Использует профиль 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 (добавлено в 1.6) | Значение по умолчанию: None | Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token |
| state |
| Наличие правила: присутствует, отсутствует или получить |
| tags | Ключевые пары для тегов. | |
| validate_certs (добавлено в 1.5) |
| Если установлено в "нет", сертификаты 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/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 сложный | успех | Возвращает список сложных объектов, представляющих группы журналов | |
| retention_in_days целое число | всегда | Количество дней хранения событий журнала в указанной группе журналов. | |
| stored_bytes строка | всегда | Количество сохраненных байтов. | |
| log_group_name строка | всегда | Имя группы журналов. | |
| metric_filter_count целое число | всегда | Количество фильтров метрик. | |
| kms_key_id строка | всегда | Amazon Resource Name (ARN) CMK для шифрования данных журналов. | |
| creation_time целое число | всегда | Время создания группы журналов. | |
| arn строка | всегда | Amazon Resource Name (ARN) группы журналов. | |
Статус
Этот модуль помечен как предварительный, что означает, что интерфейс не гарантирует обратную совместимость.
Автор
- 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.5/modules/cloudwatchlogs_log_group_module.html