Модуль amazon.aws.cloudtrail_info — сбор информации о трейлах в AWS CloudTrail
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).
Возможно, эта коллекция уже установлена, если вы используете пакет 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.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 и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore. |
aws_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 псевдонимы: aws_endpoint_url строка | URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды |
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 и session_token. |
region псевдонимы: aws_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 строка | Секретный ключ доступа 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 для соответствия AWS SDK botocore. |
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. Также можно использовать переменную среды Параметры session_token и profile являются взаимоисключающими. |
trail_names список / элементы=строка | Список имён трейлов, ARN трейлов или того и другого, сведения о которых нужно получить. Если указан пустой список, возвращаются сведения о трейле в текущем регионе. По умолчанию: |
validate_certs логическое значение | Если задано значение Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: В модулях переменные среды и файлы конфигурации считываются из контекста «хоста» 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.
# 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 типы Insights в списке InsightSelector. Возвращается: при успешном выполнении Пример: |
|
home_region string |
Регион, в котором был создан trail. Возвращается: при успешном выполнении Пример: |
|
include_global_service_events boolean |
Если значение равно True, включаются вызовы API AWS глобальных сервисов, например IAM. Возвращается: при успешном выполнении Пример: |
|
is_logging boolean |
Указывает, записывает ли CloudTrail в данный момент вызовы API AWS. Возвращается: при успешном выполнении Пример: |
|
is_multi_region_trail boolean |
Указывает, существует ли trail только в одном регионе или во всех регионах. Возвращается: при успешном выполнении Пример: |
|
is_organization_trail boolean |
Указывает, является ли trail организационным. Возвращается: при успешном выполнении Пример: |
|
kms_key_id string |
Указывает идентификатор ключа 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 при попытке доставить файл сводки в указанную корзину. Возвращается: при успешном выполнении |
|
latest_digest_delivery_time string |
Указывает дату и время последней доставки CloudTrail файла сводки в корзину Amazon S3 учетной записи. Возвращается: при успешном выполнении |
|
latest_notification_attempt_succeeded string |
Указывает дату и время последней успешной попытки CloudTrail отправить уведомление. Возвращается: при успешном выполнении |
|
latest_notification_attempt_time string |
Указывает дату и время последней попытки CloudTrail отправить уведомление. Возвращается: при успешном выполнении |
|
latest_notification_error string |
Отображает ошибки Amazon SNS, возникшие у CloudTrail при попытке отправить уведомление. Возвращается: при успешном выполнении |
|
log_file_validation_enabled boolean |
Указывает, включена ли проверка файлов журналов. Возвращается: при успешном выполнении Пример: |
|
name string |
Имя trail. Возвращается: при успешном выполнении Пример: |
|
resource_id string |
Указывает ARN ресурса. Возвращается: при успешном выполнении |
|
s3_bucket_name string |
Имя корзины Amazon S3, в которую CloudTrail доставляет файлы trail. Возвращается: при успешном выполнении Пример: |
|
s3_key_prefix string |
Префикс ключа Amazon S3, следующий за именем корзины, указанной для доставки файлов журналов. Возвращается: при успешном выполнении Пример: |
|
sns_topic_arn string |
ARN темы Amazon SNS, которую CloudTrail использует для отправки уведомлений о доставке файлов журналов. Возвращается: при успешном выполнении Пример: |
|
start_logging_time string |
Указывает последние дату и время, когда CloudTrail начал записывать вызовы API для учетной записи AWS. Возвращается: при успешном выполнении |
|
stop_logging_time string |
Указывает последние дату и время, когда CloudTrail прекратил записывать вызовы API для учетной записи AWS. Возвращается: при успешном выполнении |
|
tags dictionary |
Все теги, назначенные CloudTrail. Возвращается: всегда Пример: |
|
trail_arn string |
Указывает ARN trail. Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 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/cloudtrail_info_module.html