Spec-Zone.ru › Ansible

amazon.aws.cloudtrail_info модуль — Сбор информации о трейлах в AWS Cloud Trail

Примечание

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

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

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

Для использования в книге задач укажите: amazon.aws.cloudtrail_info.

Новое в amazon.aws 5.0.0

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

Обзор

  • Сбор информации о трейлах в AWS CloudTrail.

Требования

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

  • 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 AWS botocore.

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

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

aws_ca_bundle

путь

Путь к файлу CA Bundle для проверки 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.

include_shadow_trails

логический

Указывает, следует ли включать теневые трассы в ответ.

Варианты:

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

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.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key, ec2_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, или 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

псевдонимы: aws_session_token, security_token, aws_security_token, access_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, 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.

trail_names

список / элементы=строка

Указывает список имён трейлов, ARN трейлов или их сочетание, для описания которых предназначен модуль.

Если указан пустой список, возвращается информация о трейле в текущем регионе.

По умолчанию: []

validate_certs

логический тип

При установке в false, сертификаты SSL не будут проверены при взаимодействии с API AWS.

Установка validate_certs=false категорически не рекомендуется. В качестве альтернативы, можно задать aws_ca_bundle.

Возможные значения:

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

Примечания

Примечание

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

# Gather information about all trails
- amazon.aws.cloudtrail_info:

# Gather information about a particular trail
- amazon.aws.cloudtrail_info:
    trail_names:
      - arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

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

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

Ключ

Описание

trail_list

list / elements=dictionary

Список объектов trail. Каждый элемент представляет собой словарь со всей информацией, связанной с этим CloudTrail.

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

cloud_watch_logs_log_group_arn

string

Указывает ARN, представляющий группу журналов, в которую будут доставляться журналы CloudTrail.

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

Пример: "arn:aws:sns:us-east-2:123456789012:Mylog"

cloud_watch_logs_role_arn

string

Указывает роль для конечной точки CloudWatch Logs, которую необходимо принять для записи в группу журналов пользователя.

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

Пример: "arn:aws:sns:us-east-2:123456789012:Mylog"

has_custom_event_selectors

boolean

Указывает, есть ли у trail настраиваемые селекторы событий.

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

Пример: true

has_insight_selectors

boolean

Указывает, имеет ли trail типы инсайтов, указанные в списке InsightSelector.

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

Пример: true

home_region

string

Регион, в котором был создан trail.

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

Пример: "us-east-1"

include_global_service_events

boolean

Если True, включаются вызовы AWS API из глобальных служб AWS, таких как IAM.

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

Пример: true

is_logging

boolean

Ведет ли CloudTrail в данный момент ведение журналов вызовов API AWS.

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

Пример: true

is_multi_region_trail

boolean

Указывает, существует ли trail только в одном регионе или во всех регионах.

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

Пример: true

is_organization_trail

boolean

Указывает, является ли trail организационным trail.

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

Пример: true

kms_key_id

string

Указывает ID ключа KMS, который шифрует журналы, доставляемые CloudTrail.

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

Пример: "arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012"

latest_cloud_watch_logs_delivery_error

string

Отображает любую ошибку CloudWatch Logs, с которой столкнулся CloudTrail при попытке доставки журналов в CloudWatch Logs.

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

latest_cloud_watch_logs_delivery_time

string

Отображает последнюю дату и время, когда CloudTrail доставлял журналы в CloudWatch Logs.

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

latest_delivery_attempt_succeeded

string

Указывает дату и время последней успешной попытки CloudTrail доставить файлы журналов в корзину Amazon S3 учетной записи.

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

latest_delivery_attempt_time

string

Указывает дату и время последней попытки CloudTrail доставить файлы журналов в корзину Amazon S3 учетной записи.

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

latest_delivery_error

string

Отображает любую ошибку Amazon S3, с которой столкнулся CloudTrail при попытке доставки файлов журналов в указанное корзину.

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

latest_delivery_time

string

Указывает дату и время, когда CloudTrail в последний раз доставлял файлы журналов в корзину Amazon S3 учетной записи.

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

latest_digest_delivery_error

string

Отображает любую ошибку Amazon S3, с которой столкнулся CloudTrail при попытке доставить файл дайджеста в указанное хранилище.

Возвращено: success

latest_digest_delivery_time

string

Указывает дату и время, когда CloudTrail в последний раз доставил файл дайджеста в хранилище Amazon S3 учетной записи.

Возвращено: success

latest_notification_attempt_succeeded

string

Указывает дату и время последней успешной попытки CloudTrail доставить уведомление.

Возвращено: success

latest_notification_attempt_time

string

Указывает дату и время последней попытки CloudTrail доставить уведомление.

Возвращено: success

latest_notification_error

string

Отображает любую ошибку Amazon SNS, с которой столкнулся CloudTrail при попытке отправить уведомление.

Возвращено: success

log_file_validation_enabled

boolean

Указывает, включена ли проверка файлов журналов.

Возвращено: success

Пример: true

name

string

Имя следа.

Возвращено: success

Пример: "MyTrail"

resource_id

string

Указывает ARN ресурса.

Возвращено: success

s3_bucket_name

string

Имя хранилища Amazon S3, в которое CloudTrail доставляет файлы следа.

Возвращено: success

Пример: "aws-cloudtrail-logs-xxxx"

s3_key_prefix

string

Префикс ключа Amazon S3, который идет после имени хранилища, предназначенного для доставки файлов журналов.

Возвращено: success

Пример: "xxxx"

sns_topic_arn

string

ARN темы Amazon SNS, которую CloudTrail использует для отправки уведомлений при доставке файлов журналов.

Возвращено: success

Пример: "arn:aws:sns:us-east-2:123456789012:MyTopic"

start_logging_time

string

Указывает последнюю дату и время, когда CloudTrail начал запись вызовов API для учетной записи AWS.

Возвращено: success

stop_logging_time

string

Указывает последнюю дату и время, когда CloudTrail прекратил запись вызовов API для учетной записи AWS.

Возвращено: success

tags

dictionary

Все теги, назначенные cloudtrail.

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

Пример: {"my_tag_key": "my_tag_value"}

trail_arn

string

Указывает ARN следа.

Возвращено: success

Пример: "arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail"

Авторы

  • Gomathi Selvi Srinivasan (@GomathiselviS)

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

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

© 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/cloudtrail_info_module.html

Spec-Zone.ru

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