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

access_key

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

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

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

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

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

Варианты:

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

enable_log_file_validation

псевдонимы: log_file_validation_enabled

boolean

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

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

Варианты:

• false
• true

enable_logging

boolean

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

Варианты:

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

endpoint_url

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

string

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

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

include_global_events

псевдонимы: include_global_service_events

boolean

Записывать вызовы API глобальных сервисов, например IAM и STS.

Варианты:

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

is_multi_region_trail

boolean

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

Варианты:

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

kms_key_id

string

Указывает идентификатор ключа 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

псевдонимы: 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 и session_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

псевдонимы: aws_region

string

Используемый регион AWS.

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

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

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

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

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

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

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с AWS SDK botocore.

session_token

псевдонимы: aws_session_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.

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

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

псевдонимы: 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

Используются ли для этой трассы селекторы Insight.

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

Пример: 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, на которую отправляются уведомления о доставке журналов.

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

Пример: "myTopic"

tags

dictionary

хеш/словарь тегов, назначенных этому ресурсу

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

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

trail_arn

string

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

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

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