Модуль amazon.aws.cloudwatchlogs_log_group — создание или удаление log_group в CloudWatchLogs

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для работы с этим модулем необходимы дополнительные требования; подробности см. в разделе Требования.

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

Добавлено в amazon.aws 5.0.0

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

Краткое описание

Создание или удаление log_group в CloudWatchLogs.
Этот модуль был впервые добавлен в community.aws в выпуске 1.0.0.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 3.6
boto3 >= 1.35.0
botocore >= 1.35.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_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` в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.
aws_ca_bundle путь	Путь к пакету сертификатов CA, используемому для проверки SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Описание параметров см. в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполненных во время задачи, и выводить набор в ключ resource_actions результатов задачи. Используйте обработчик `aws_resource_action` для вывода общего списка вызовов, выполненных в рамках плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
kms_key_id строка	Имя ресурса Amazon (ARN) ключа CMK, используемого для шифрования данных журнала.
log_group_name строка / обязательный	Имя группы журналов.
overwrite логическое значение	Следует ли перезаписывать существующую группу журналов при создании. Взаимоисключающий параметр с `purge_retention_policy`. Варианты: `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 и session_token.
purge_retention_policy логическое значение	Следует ли удалить политику хранения. Взаимоисключающий параметр с `retention` и `overwrite`. Варианты: `false` ← (по умолчанию) `true`
purge_tags логическое значение	Если задано значение `purge_tags=true` и указан параметр `tags`, существующие теги ресурса будут удалены, чтобы точно соответствовать значениям, заданным параметром `tags`. Если параметр `tags` не задан, теги не будут изменены, даже если задано `purge_tags=True`. Ключи тегов, начинающиеся с `aws:`, зарезервированы Amazon и не могут быть изменены. Поэтому они игнорируются при обработке параметра `purge_tags`. Дополнительные сведения см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Варианты: `false` `true` ← (по умолчанию)
region псевдонимы: aws_region строка	Используемый регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
retention целое число	Количество дней хранения событий журнала в указанной группе журналов. Допустимые значения: [1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653] Взаимоисключающий параметр с `purge_retention_policy`.
secret_key псевдонимы: aws_secret_access_key, aws_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` в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.
session_token псевдонимы: aws_session_token строка	Токен сеанса AWS STS для использования с временными учетными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды `AWS_SESSION_TOKEN`. Параметры session_token и profile являются взаимоисключающими.
state строка	Наличие или отсутствие правила. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags псевдонимы: resource_tags словарь	Словарь тегов, применяемых к ресурсу. Если параметр `tags` не задан, теги не будут изменены.
validate_certs логическое значение	Если задано значение `false`, SSL-сертификаты не будут проверяться при взаимодействии с API AWS. Не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Сведения о параметрах и возвращаемых значениях см. здесь: http://boto3.readthedocs.io/en/latest/reference/services/logs.html.
Поддержка purge_tags добавлена в выпуске 4.0.0.
Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
Используемый Ansible пакет AWS SDK (boto3) также может считывать значения учетных данных и других параметров по умолчанию, например региона, из файлов конфигурации в контексте «узла» 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.

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

- amazon.aws.cloudwatchlogs_log_group:
    state: present
    log_group_name: test-log-group
    tags:
      Name: "test-log-group"
      Env: "QA"

- amazon.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

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

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

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

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

Авторы

Willian Ricardo (@willricardo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/cloudwatchlogs_log_group_module.html