amazon.aws.cloudtrail 模块 – 管理 CloudTrail 创建、删除、更新

注意

此模块是 amazon.aws 集合 (版本 9.0.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定：amazon.aws.cloudtrail。

amazon.aws 5.0.0 中的新增功能

概要

• 创建、删除或更新 CloudTrail 配置。确保也启用了日志记录。

• 此模块最初添加到 community.aws 的 1.0.0 版本中。

要求

执行此模块的主机需要以下要求。

• python >= 3.6

• boto3 >= 1.28.0

• botocore >= 1.31.0

参数

参数	注释
access_key 别名：aws_access_key_id，aws_access_key，ec2_access_key 字符串	AWS 访问密钥 ID。 有关访问令牌的更多信息，请参阅 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 botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已被弃用，并将在 2024-12-01 后的某个版本中删除。 EC2_ACCESS_KEY 环境变量的支持已被弃用，并将在 2024-12-01 后的某个版本中删除。
aws_ca_bundle 路径	验证 SSL 证书时要使用的 CA 证书包的位置。 也可使用 AWS_CA_BUNDLE 环境变量。
aws_config 字典	用于修改 botocore 配置的字典。 参数可在 AWS 文档中找到 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。
cloudwatch_logs_log_group_arn 字符串	指定 CloudTrail 日志将交付到的有效 CloudWatch 日志组的完整 ARN。日志组应已存在。 请参阅 https://docs.aws.amazon.com/awscloudtrail/latest/userguide/send-cloudtrail-events-to-cloudwatch-logs.html。 当 cloudwatch_logs_role_arn 时需要。
cloudwatch_logs_role_arn 字符串	指定 IAM 角色的完整 ARN，该角色为 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 布尔值	使用 botocore.endpoint 记录器来解析在任务期间进行的唯一（而不是全部）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间进行的全部列表。 也可使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
enable_log_file_validation 别名：log_file_validation_enabled 布尔值	指定是否启用日志文件完整性验证。 CloudTrail 将为交付的每个日志文件创建一个哈希值，并生成一个签名摘要文件，用于确保日志文件未被篡改。 选项 false true
enable_logging 布尔值	启动或停止 CloudTrail 日志记录。如果停止，跟踪将暂停，不会记录事件或交付日志文件。 选项 false true ← (默认)
endpoint_url 别名：ec2_url、aws_endpoint_url、s3_url 字符串	连接到非默认 AWS 端点的 URL。虽然这可以用于连接到其他与 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 别名：include_global_service_events 布尔值	记录来自全球服务（例如 IAM 和 STS）的 API 调用。 选项 false true ← (默认)
is_multi_region_trail 布尔值	指定跟踪只属于一个区域还是存在于所有区域。 选项 false ← (默认) true
kms_key_id 字符串	指定用于加密 CloudTrail 传送日志的 KMS 密钥 ID。这也会启用日志文件加密。 该值可以是带有“alias/”前缀的别名，指向别名的完全限定 ARN，指向密钥的完全限定 ARN 或全局唯一标识符。 可以通过设置 kms_key_id="" 来禁用加密。 参见 https://docs.aws.amazon.com/awscloudtrail/latest/userguide/encrypting-cloudtrail-log-files-with-aws-kms.html。
name 字符串	CloudTrail 的名称。 除非 CloudTrail 是多区域跟踪，否则名称在每个区域内都是唯一的；如果是多区域跟踪，则在每个账户内都是唯一的。 默认值： "default"
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 选项互斥。
purge_tags 布尔值	如果 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、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 之后的一个版本中移除。
s3_bucket_name 字符串	CloudTrail 将在其传送日志文件的现有 S3 存储桶。 此存储桶应已存在并具有正确的策略。 参见 https://docs.aws.amazon.com/awscloudtrail/latest/userguide/aggregating_logs_regions_bucket_policy.html。 当 state=present 时为必需。
s3_key_prefix 字符串	已交付日志文件的 S3 密钥前缀。不需要尾部斜杠，它将被移除。
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 botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 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 选项互斥。 在 3.2.0 版本中添加了 aws_session_token 和 session_token 别名，在 6.0.0 版本中将参数名称从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已弃用，将在 2024-12-01 之后的一个版本中移除。 对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已弃用，将在 2024-12-01 之后的一个版本中移除。
sns_topic_name 字符串	在交付日志文件时发送通知的 SNS 主题名称。
state 字符串	添加或删除 CloudTrail 配置。 出于向后兼容性考虑，保留了以下状态：state=enabled 和 state=disabled。 state=enabled 等效于 state=present。 state=disabled 等效于 state=absent。 选项 "present" ← (默认) "absent" "enabled" "disabled"
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果没有设置 tags 参数，则不会修改标签。
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑改用 aws_ca_bundle。 选项 false true ← (默认)

注释

注意

• 在 4.0.0 版本中添加了 purge_tags 选项。

• 注意：对于模块，环境变量和配置文件是从 Ansible 的“主机”上下文读取的，而不是“控制器”上下文。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible 的“控制器”上下文读取的，而不是“主机”上下文。

• Ansible 使用的 AWS SDK (boto3) 也可能从其在 Ansible “主机” 上下文中的配置文件（通常为 ~/.aws/credentials）读取凭据和其他设置（例如区域）的默认值。更多信息，请参见 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

- name: create single region cloudtrail
  amazon.aws.cloudtrail:
    state: present
    name: default
    s3_bucket_name: mylogbucket
    s3_key_prefix: cloudtrail
    region: us-east-1

- name: create multi-region trail with validation and tags
  amazon.aws.cloudtrail:
    state: present
    name: default
    s3_bucket_name: mylogbucket
    region: us-east-1
    is_multi_region_trail: true
    enable_log_file_validation: true
    cloudwatch_logs_role_arn: "arn:aws:iam::123456789012:role/CloudTrail_CloudWatchLogs_Role"
    cloudwatch_logs_log_group_arn: "arn:aws:logs:us-east-1:123456789012:log-group:CloudTrail/DefaultLogGroup:*"
    kms_key_id: "alias/MyAliasName"
    tags:
      environment: dev
      Name: default

- name: show another valid kms_key_id
  amazon.aws.cloudtrail:
    state: present
    name: default
    s3_bucket_name: mylogbucket
    kms_key_id: "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012"
    # simply "12345678-1234-1234-1234-123456789012" would be valid too.

- name: pause logging the trail we just created
  amazon.aws.cloudtrail:
    state: present
    name: default
    enable_logging: false
    s3_bucket_name: mylogbucket
    region: us-east-1
    is_multi_region_trail: true
    enable_log_file_validation: true
    tags:
      environment: dev
      Name: default

- name: delete a trail
  amazon.aws.cloudtrail:
    state: absent
    name: default

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段：

Key	描述
exists 布尔值	资源是否存在。 返回值：始终返回 示例： true
trail complex	CloudTrail 资源详细信息。 返回值：始终返回 示例： "hash/dictionary of values"
cloud_watch_logs_log_group_arn 字符串	事件交付到的 CloudWatch Logs 日志组的完整 ARN。 返回值：存在时成功返回 示例： "arn:aws:logs:us-east-1:123456789012:log-group:CloudTrail/DefaultLogGroup:*"
cloud_watch_logs_role_arn 字符串	CloudTrail 用于交付事件的 IAM 角色的完整 ARN。 返回值：存在时成功返回 示例： "arn:aws:iam::123456789012:role/CloudTrail_CloudWatchLogs_Role"
has_custom_event_selectors 布尔值	此跟踪是否使用了任何自定义事件选择器。 返回值：成功返回 示例： false
has_insight_selectors 布尔值	此跟踪是否使用了任何洞察选择器。 返回值：成功返回 示例： false
home_region 字符串	跟踪最初创建并必须在其中进行编辑的区域。 返回值：成功返回 示例： "us-east-1"
include_global_service_events 布尔值	此跟踪是否记录全局服务（IAM、STS）。 返回值：成功返回 示例： true
is_logging 布尔值	跟踪的日志记录是否已开启或暂停。 返回值：成功返回 示例： true
is_multi_region_trail 布尔值	跟踪是否应用于所有区域或仅应用于一个区域。 返回值：成功返回 示例： true
is_organization_trail 布尔值	指定跟踪是为 Organizations 中的所有帐户创建的，还是仅为当前 Amazon Web Services 帐户创建的。 返回值：成功返回 示例： true
kms_key_id 字符串	用于加密日志文件的 KMS 密钥的完整 ARN。 返回值：存在时成功返回 示例： "arn:aws:kms::123456789012:key/12345678-1234-1234-1234-123456789012"
log_file_validation_enabled 布尔值	跟踪上是否启用了日志文件验证。 返回值：成功返回 示例： true
name 字符串	CloudTrail 资源的名称。 返回值：成功返回 示例： "default"
s3_bucket_name 字符串	交付日志文件的 S3 存储桶名称。 返回值：成功返回 示例： "myBucket"
s3_key_prefix 字符串	存储桶中交付日志文件的密钥前缀（如有）。 返回值：存在时成功返回 示例： "myKeyPrefix"
sns_topic_arn 字符串	发送日志交付通知的 SNS 主题的完整 ARN。 返回值：存在时成功返回 示例： "arn:aws:sns:us-east-1:123456789012:topic/myTopic"
sns_topic_name 字符串	发送日志交付通知的 SNS 主题名称。 返回值：存在时成功返回 示例： "myTopic"
tags 字典	应用于此资源的标签的哈希/字典。 返回值：成功返回 示例： {"Name": "default", "environment": "dev"}
trail_arn 字符串	CloudTrail 资源的完整 ARN。 返回值：成功返回 示例： "arn:aws:cloudtrail:us-east-1:123456789012:trail/default"

作者

• Ansible 核心团队

• Ted Timmons (@tedder)

• Daniel Shepherd (@shepdelacreme)

集合链接

• 问题追踪器
• 代码库（源代码）
• 通信