Spec-Zone.ru › Ansible

amazon.aws.cloudwatchlogs_log_group модуль — создание или удаление группы логов в CloudWatchLogs

Примечание

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

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

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

Для использования в playbook укажите: amazon.aws.cloudwatchlogs_log_group.

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

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

Обзор

  • Создает или удаляет группу логов в CloudWatchLogs.
  • Этот модуль был первоначально добавлен в community.aws в релизе 1.0.0.

Требования

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

  • python >= 3.6
  • boto3 >= 1.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_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 или EC2_ACCESS_KEY в порядке убывания приоритета.

Опции aws_access_key и profile взаимоисключающие.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для соответствия SDK botocore AWS.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

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 логгер для анализа уникальных (а не общих) "resource:action" API-вызовов, сделанных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте aws_resource_action обратный вызов для вывода в общий список, созданный во время выполнения книги задач.

Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_url

псевдонимы: ec2_url, aws_endpoint_url, s3_url

строка

URL для подключения вместо стандартных конечных точек AWS. Хотя это может быть использовано для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только с AWS.

Также можно использовать переменные среды AWS_URL или EC2_URL в порядке убывания приоритета.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

kms_key_id

строка

Amazon Resource Name (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 и security_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, ec2_region

строка

AWS-регион для использования.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется.

Также можно использовать переменные среды AWS_REGION или EC2_REGION.

Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

retention

integer

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

Допустимые значения: [1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653]

Взаимоисключительно с purge_retention_policy.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

Секретный ключ доступа 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, или EC2_SECRET_KEY в порядке убывания предпочтения.

Параметры secret_key и profile взаимоисключающие.

Алиас aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore.

Алиас ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

Токен сеанса 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, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания предпочтения.

Параметры security_token и profile взаимоисключающие.

Алиасы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0.

Алиасы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

state

string

Наличие или отсутствие правила.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

aliases: resource_tags

dictionary

Словарь, представляющий метки, которые будут применены к ресурсу.

Если параметр tags не задан, метки не будут изменены.

validate_certs

boolean

При значении 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 ‘host’, а не из контекста ‘controller’. Поэтому файлы может потребоваться явно скопировать на ‘host’. Для плагинов поиска и подключения переменные среды и файлы конфигурации читаются из контекста Ansible ‘controller’, а не из контекста ‘host’.
  • Используемый Ansible AWS SDK (boto3) также может читать значения по умолчанию для учетных данных и других параметров, таких как регион, из файлов конфигурации в контексте Ansible ‘host’ (обычно ~/.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

string

Универсальное имя ресурса (ARN) группы журналов.

Возвращается: всегда

creation_time

integer

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

Возвращается: всегда

kms_key_id

string

Универсальное имя ресурса (ARN) ключа CMK, используемого при шифровании данных журнала.

Возвращается: всегда

log_group_name

string

Имя группы журналов.

Возвращается: всегда

log_groups

complex

добавлено в community.aws 4.0.0

Возвращает список сложных объектов, представляющих группы журналов.

Возвращается: успех

arn

string

Универсальное имя ресурса (ARN) группы журналов.

Возвращается: всегда

creation_time

integer

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

Возвращается: всегда

kms_key_id

string

Универсальное имя ресурса (ARN) ключа CMK, используемого при шифровании данных журнала.

Возвращается: всегда

log_group_name

string

Имя группы журналов.

Возвращается: всегда

metric_filter_count

integer

Количество фильтров метрик.

Возвращается: всегда

retention_in_days

integer

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

Возвращается: всегда

stored_bytes

string

Количество хранимых байтов.

Возвращается: всегда

tags

dictionary

Словарь, представляющий теги в группе журналов.

Возвращается: всегда

metric_filter_count

integer

Количество фильтров метрик.

Возвращается: всегда

retention_in_days

integer

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

Возвращается: всегда

stored_bytes

string

Количество хранимых байтов.

Возвращается: всегда

tags

dictionary

Словарь, представляющий теги в группе журналов.

Возвращается: всегда

Авторы

  • Willian Ricardo (@willricardo)

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

  • Система отслеживания ошибок
  • Репозиторий (исходный код)
  • Связь

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

Spec-Zone.ru

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