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 и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle путь | Путь к файлу CA Bundle для проверки SSL-сертификатов. Также можно использовать переменную среды |
aws_config словарь | Словарь для изменения настроек botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs логический | Использовать Также можно использовать переменную среды Варианты:
|
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим службам, совместимым с AWS, коллекции amazon.aws и community.aws протестированы только для AWS. Также можно использовать переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
include_shadow_trails логический | Указывает, следует ли включать теневые трассы в ответ. Варианты:
|
profile псевдонимы: aws_profile строка | Используемый именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token. |
region псевдонимы: aws_region, ec2_region строка | Используемая область AWS. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Также можно использовать переменные среды Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
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. Также можно использовать переменные среды Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним 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. Также можно использовать переменные среды Параметры 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. Поддержка переменных среды |
trail_names список / элементы=строка | Указывает список имён трейлов, ARN трейлов или их сочетание, для описания которых предназначен модуль. Если указан пустой список, возвращается информация о трейле в текущем регионе. По умолчанию: |
validate_certs логический тип | При установке в Установка validate_certs=false категорически не рекомендуется. В качестве альтернативы, можно задать aws_ca_bundle. Возможные значения:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста 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. Возвращается: успех Пример: |
|
cloud_watch_logs_role_arn string |
Указывает роль для конечной точки CloudWatch Logs, которую необходимо принять для записи в группу журналов пользователя. Возвращается: успех Пример: |
|
has_custom_event_selectors boolean |
Указывает, есть ли у trail настраиваемые селекторы событий. Возвращается: успех Пример: |
|
has_insight_selectors boolean |
Указывает, имеет ли trail типы инсайтов, указанные в списке InsightSelector. Возвращается: успех Пример: |
|
home_region string |
Регион, в котором был создан trail. Возвращается: успех Пример: |
|
include_global_service_events boolean |
Если True, включаются вызовы AWS API из глобальных служб AWS, таких как IAM. Возвращается: успех Пример: |
|
is_logging boolean |
Ведет ли CloudTrail в данный момент ведение журналов вызовов API AWS. Возвращается: успех Пример: |
|
is_multi_region_trail boolean |
Указывает, существует ли trail только в одном регионе или во всех регионах. Возвращается: успех Пример: |
|
is_organization_trail boolean |
Указывает, является ли trail организационным trail. Возвращается: успех Пример: |
|
kms_key_id string |
Указывает ID ключа KMS, который шифрует журналы, доставляемые CloudTrail. Возвращается: успех Пример: |
|
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 Пример: |
|
name string |
Имя следа. Возвращено: success Пример: |
|
resource_id string |
Указывает ARN ресурса. Возвращено: success |
|
s3_bucket_name string |
Имя хранилища Amazon S3, в которое CloudTrail доставляет файлы следа. Возвращено: success Пример: |
|
s3_key_prefix string |
Префикс ключа Amazon S3, который идет после имени хранилища, предназначенного для доставки файлов журналов. Возвращено: success Пример: |
|
sns_topic_arn string |
ARN темы Amazon SNS, которую CloudTrail использует для отправки уведомлений при доставке файлов журналов. Возвращено: success Пример: |
|
start_logging_time string |
Указывает последнюю дату и время, когда CloudTrail начал запись вызовов API для учетной записи AWS. Возвращено: success |
|
stop_logging_time string |
Указывает последнюю дату и время, когда CloudTrail прекратил запись вызовов API для учетной записи AWS. Возвращено: success |
|
tags dictionary |
Все теги, назначенные cloudtrail. Возвращено: всегда Пример: |
|
trail_arn string |
Указывает ARN следа. Возвращено: success Пример: |
Ссылки на коллекцию
© 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