Модуль amazon.aws.cloudtrail — управление CloudTrail (создание, удаление, обновление)

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

Идентификатор ключа доступа 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 для согласованности с AWS botocore SDK.

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

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

aws_ca_bundle

path

Расположение пакета CA, используемого при проверке сертификатов SSL.

Переменная окружения AWS_CA_BUNDLE также может использоваться.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

cloudwatch_logs_log_group_arn

string

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

См. https://docs.aws.amazon.com/awscloudtrail/latest/userguide/send-cloudtrail-events-to-cloudwatch-logs.html.

Обязательно, когда cloudwatch_logs_role_arn.

cloudwatch_logs_role_arn

string

Указывает полный ARN для роли IAM, которая назначает необходимые разрешения для CloudTrail для создания и записи в группу журналов.

См. https://docs.aws.amazon.com/awscloudtrail/latest/userguide/send-cloudtrail-events-to-cloudwatch-logs.html.

Обязательно, когда cloudwatch_logs_log_group_arn.

debug_botocore_endpoint_logs

boolean

Использовать botocore.endpoint регистратор для анализа уникальных (а не общих) "resource:action" вызовов API, сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время playbook.

Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может использоваться.

Варианты:

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

enable_log_file_validation

aliases: log_file_validation_enabled

boolean

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

CloudTrail будет создавать хэш для каждого доставленного файла журнала и создавать подписанный файл дайджеста, который можно использовать для обеспечения того, чтобы файлы журналов не были изменены.

Варианты:

• false
• true

enable_logging

boolean

Запуск или остановка ведения журнала CloudTrail. Если остановлено, трассировка будет приостановлена и не будет записывать события или доставлять файлы журналов.

Варианты:

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

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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_global_events

aliases: include_global_service_events

boolean

Записывать вызовы API из глобальных служб, таких как IAM и STS.

Варианты:

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

is_multi_region_trail

boolean

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

Варианты:

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

kms_key_id

string

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

Значение может быть именем псевдонима с префиксом «alias/», полностью определенным ARN для псевдонима, полностью определенным ARN для ключа или глобально уникальным идентификатором.

Шифрование может быть отключено, установив kms_key_id="".

См. https://docs.aws.amazon.com/awscloudtrail/latest/userguide/encrypting-cloudtrail-log-files-with-aws-kms.html.

name

string

Имя для CloudTrail.

Имена уникальны в каждом регионе, если CloudTrail не является трассировкой нескольких регионов, в этом случае он уникален для каждой учетной записи.

По умолчанию: "default"

profile

aliases: aws_profile

string

Именованный профиль 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_tags

boolean

Если 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

aliases: aws_region, ec2_region

string

Регион 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.

s3_bucket_name

string

Существующее S3-хранилище, куда CloudTrail будет передавать файлы журналов.

Это хранилище должно существовать и иметь соответствующую политику.

См. https://docs.aws.amazon.com/awscloudtrail/latest/userguide/aggregating_logs_regions_bucket_policy.html.

Обязательно, когда state=present.

s3_key_prefix

string

Префикс ключа S3 для передаваемых файлов журналов. Косая черта в конце не обязательна и будет удалена.

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 для согласованности с AWS botocore SDK.

Псевдоним 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.

sns_topic_name

string

Имя темы SNS для отправки уведомлений при доставке файла журнала.

state

string

Добавить или удалить конфигурацию CloudTrail.

Следующие состояния сохранены для обратной совместимости: state=enabled и state=disabled.

state=enabled эквивалентно state=present.

state=disabled эквивалентно state=absent.

Варианты:

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

tags

aliases: resource_tags

dictionary

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

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

validate_certs

boolean

Когда установлено значение false, сертификаты SSL не будут проверяться для связи с API AWS.

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

Варианты:

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

exists

boolean

существует ли ресурс.

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

Пример: true

trail

complex

Детали ресурса CloudTrail.

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

Пример: "hash/dictionary of values"

cloud_watch_logs_log_group_arn

string

Полный ARN группы журналов CloudWatch Logs, куда доставляются события.

Возвращаемое значение: при успешном выполнении

Пример: "arn:aws:logs:us-east-1:123456789012:log-group:CloudTrail/DefaultLogGroup:*"

cloud_watch_logs_role_arn

string

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

Возвращаемое значение: при успешном выполнении

Пример: "arn:aws:iam::123456789012:role/CloudTrail_CloudWatchLogs_Role"

has_custom_event_selectors

boolean

Используются ли для этого трейла пользовательские селекторы событий?

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

Пример: false

has_insight_selectors

boolean

Используются ли для этого трейла селекторы инсайтов?

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

Пример: false

home_region

string

Регион, где трейл был первоначально создан и должен быть изменён.

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

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

include_global_service_events

boolean

Включаются ли в этот трейл события глобальных сервисов (IAM, STS)?

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

Пример: true

is_logging

boolean

Включено ли или приостановлено ведение журнала для трейла?

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

Пример: true

is_multi_region_trail

boolean

Относится ли трейл ко всем регионам или только к одному?

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

Пример: true

is_organization_trail

boolean

Указывает, создан ли трейл для всех аккаунтов в организации в Organizations или только для текущего аккаунта Amazon Web Services.

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

Пример: true

kms_key_id

string

Полный ARN ключа KMS, используемого для шифрования файлов журналов.

Возвращаемое значение: при успешном выполнении

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

log_file_validation_enabled

boolean

Включена ли валидация файлов журналов в трейле?

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

Пример: true

name

string

Имя ресурса CloudTrail.

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

Пример: "default"

s3_bucket_name

string

Имя ведра S3, куда доставляются файлы журналов.

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

Пример: "myBucket"

s3_key_prefix

string

Префикс ключа в ведре, куда доставляются файлы журналов (если есть).

Возвращаемое значение: при успешном выполнении

Пример: "myKeyPrefix"

sns_topic_arn

string

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

Возвращаемое значение: при успешном выполнении

Пример: "arn:aws:sns:us-east-1:123456789012:topic/myTopic"

sns_topic_name

string

Имя темы SNS, в которую отправляются уведомления о доставке журналов.

Возвращаемое значение: success при наличии

Пример: "myTopic"

tags

dictionary

Словарь тегов, применённых к этому ресурсу.

Возвращаемое значение: success

Пример: {"Name": "default", "environment": "dev"}

trail_arn

string

Полный ARN ресурса CloudTrail.

Возвращаемое значение: success

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