amazon.aws.cloudtrail_info 模块 – 收集 AWS Cloud Trail 中跟踪信息

注意

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

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

要安装它,请使用:ansible-galaxy collection install amazon.aws。要使用此模块,您需要其他要求,请参阅 要求 了解详情。

要在 playbook 中使用它,请指定:amazon.aws.cloudtrail_info

amazon.aws 5.0.0 中的新增功能

概要

  • 收集 AWS CloudTrail 中的跟踪信息。

要求

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

  • 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_IDAWS_ACCESS_KEYEC2_ACCESS_KEY 环境变量,优先级依次递减。

aws_access_keyprofile 选项是互斥的。

为了与 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

debug_botocore_endpoint_logs

布尔值

使用 botocore.endpoint 记录器来解析在任务期间进行的唯一(而不是总计)"resource:action" API 调用,并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间进行的总列表。

也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选项

  • false ← (默认)

  • true

endpoint_url

别名:ec2_url, aws_endpoint_url, s3_url

字符串

连接到的 URL,而不是默认的 AWS 端点。虽然这可以用于连接到其他兼容 AWS 的服务,但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。

也可以使用 AWS_URLEC2_URL 环境变量,优先级依次递减。

ec2_urls3_url 别名已弃用,将在 2024-12-01 之后的一个版本中移除。

EC2_URL 环境变量的支持已弃用,将在 2024-12-01 之后的一个版本中移除。

include_shadow_trails

布尔值

指定是否在响应中包含影子跟踪。

选项

  • false

  • true ← (默认)

profile

别名:aws_profile

字符串

用于身份验证的命名 AWS 配置文件。

有关命名配置文件的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html

也可以使用 AWS_PROFILE 环境变量。

profile 选项与 aws_access_keyaws_secret_keysecurity_token 选项互斥。

region

别名:aws_region, ec2_region

字符串

要使用的 AWS 区域。

对于诸如 IAM、Route53 和 CloudFront 之类的全球服务,会忽略 region

也可以使用 AWS_REGIONEC2_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之后的一个版本中移除。

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_KEYAWS_SECRET_KEYEC2_SECRET_KEY,优先级依次递减。

secret_keyprofile 选项互斥。

为了与 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_TOKENAWS_SECURITY_TOKENEC2_SECURITY_TOKEN,优先级依次递减。

security_tokenprofile 选项互斥。

在 3.2.0 版本中添加了 aws_session_tokensession_token 别名,在 6.0.0 版本中将参数名称从 security_token 重命名为 session_token

security_tokenaws_security_tokenaccess_token 别名已弃用,并将在2024-12-01之后的一个版本中移除。

对环境变量EC2_SECRET_KEYAWS_SECURITY_TOKEN的支持已弃用,并将在2024-12-01之后的一个版本中移除。

trail_names

列表 / 元素=字符串

指定要描述的跟踪的跟踪名称、跟踪 ARN 或两者。

如果指定空列表,则返回当前区域中跟踪的信息。

默认值:[]

validate_certs

布尔值

设置为false时,将不会验证与 AWS API 通信的 SSL 证书。

强烈建议不要设置validate_certs=false,作为替代方案,请考虑改为设置aws_ca_bundle

选项

  • false

  • true ← (默认)

备注

注意

  • 警告:对于模块,环境变量和配置文件是从 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

列表 / 元素=字典

跟踪对象的列表。每个元素都包含一个字典,其中包含与该 CloudTrail 相关的所有信息。

返回:始终

cloud_watch_logs_log_group_arn

字符串

指定一个 ARN,表示 CloudTrail 日志将交付到的日志组。

返回:成功

示例:"arn:aws:sns:us-east-2:123456789012:Mylog"

cloud_watch_logs_role_arn

字符串

指定 CloudWatch Logs 端点为写入用户的日志组而要假定的角色。

返回:成功

示例:"arn:aws:sns:us-east-2:123456789012:Mylog"

has_custom_event_selectors

布尔值

指定跟踪是否具有自定义事件选择器。

返回:成功

示例:true

has_insight_selectors

布尔值

指定跟踪是否在 InsightSelector 列表中指定了洞察类型。

返回:成功

示例:true

home_region

字符串

创建跟踪的区域。

返回:成功

示例:"us-east-1"

include_global_service_events

布尔值

如果为 True,则包括来自 AWS 全球服务(例如 IAM)的 AWS API 调用。

返回:成功

示例:true

is_logging

布尔值

CloudTrail 是否当前正在记录 AWS API 调用。

返回:成功

示例:true

is_multi_region_trail

布尔值

指定跟踪仅存在于一个区域还是存在于所有区域。

返回:成功

示例:true

is_organization_trail

布尔值

指定跟踪是否是组织跟踪。

返回:成功

示例:true

kms_key_id

字符串

指定加密 CloudTrail 传送的日志的 KMS 密钥 ID。

返回:成功

示例:"arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012"

latest_cloud_watch_logs_delivery_error

字符串

显示 CloudTrail 在尝试将日志交付到 CloudWatch Logs 时遇到的任何 CloudWatch Logs 错误。

返回:成功

latest_cloud_watch_logs_delivery_time

字符串

显示 CloudTrail 最后一次将日志交付到 CloudWatch Logs 的日期和时间。

返回:成功

latest_delivery_attempt_succeeded

字符串

指定 CloudTrail 最后一次成功尝试将日志文件交付到帐户的 Amazon S3 存储桶的日期和时间。

返回:成功

latest_delivery_attempt_time

字符串

指定 CloudTrail 最后一次尝试将日志文件交付到帐户的 Amazon S3 存储桶的日期和时间。

返回:成功

latest_delivery_error

字符串

显示 CloudTrail 在尝试将日志文件交付到指定的存储桶时遇到的任何 Amazon S3 错误。

返回:成功

latest_delivery_time

字符串

指定 CloudTrail 最后一次将日志文件交付到帐户的 Amazon S3 存储桶的日期和时间。

返回:成功

latest_digest_delivery_error

字符串

显示 CloudTrail 在尝试将摘要文件交付到指定的存储桶时遇到的任何 Amazon S3 错误。

返回:成功

latest_digest_delivery_time

字符串

指定 CloudTrail 最后一次将摘要文件交付到帐户的 Amazon S3 存储桶的日期和时间。

返回:成功

latest_notification_attempt_succeeded

字符串

指定 CloudTrail 最后一次成功尝试传送通知的日期和时间。

返回:成功

latest_notification_attempt_time

字符串

指定 CloudTrail 最后一次尝试传送通知的日期和时间。

返回:成功

latest_notification_error

字符串

显示 CloudTrail 在尝试发送通知时遇到的任何 Amazon SNS 错误。

返回:成功

log_file_validation_enabled

布尔值

指定是否启用了日志文件验证。

返回:成功

示例:true

name

字符串

跟踪的名称。

返回:成功

示例:"MyTrail"

resource_id

字符串

指定资源的 ARN。

返回:成功

s3_bucket_name

字符串

CloudTrail 将跟踪文件传送到的 Amazon S3 存储桶的名称。

返回:成功

示例:"aws-cloudtrail-logs-xxxx"

s3_key_prefix

字符串

Amazon S3 密钥前缀,位于指定用于日志文件传送的存储桶名称之后。

返回:成功

示例:"xxxx"

sns_topic_arn

字符串

CloudTrail 用于在传送日志文件时发送通知的 Amazon SNS 主题的 ARN。

返回:成功

示例:"arn:aws:sns:us-east-2:123456789012:MyTopic"

start_logging_time

字符串

指定 CloudTrail 最近一次开始为 AWS 帐户记录 API 调用的日期和时间。

返回:成功

stop_logging_time

字符串

指定 CloudTrail 最近一次停止为 AWS 帐户记录 API 调用的日期和时间。

返回:成功

tags

字典

分配给 CloudTrail 的任何标签。

返回:始终

示例:{"my_tag_key": "my_tag_value"}

trail_arn

字符串

指定跟踪的 ARN。

返回:成功

示例:"arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail"

作者

  • Gomathi Selvi Srinivasan (@GomathiselviS)