amazon.aws.ec2_snapshot_info 模块 – 收集 AWS 中 EC2 卷快照信息

注意

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

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

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

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

amazon.aws 1.0.0 中的新增功能

概要

• 收集 AWS 中 EC2 卷快照信息。

需求

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

• 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 保持一致，aws_access_key_id 别名是在 5.1.0 版本中添加的。 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_URL 或 EC2_URL 环境变量。 ec2_url 和 s3_url 别名已弃用，并将在 2024-12-01 之后的发行版中删除。 EC2_URL 环境变量的支持已弃用，并将在 2024-12-01 之后的发行版中删除。
filters 字典	要应用的过滤器字典。每个字典项包含一个过滤器键和一个过滤器值。有关可能的过滤器，请参阅 https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html。过滤器名称和值区分大小写。 默认值： {}
max_results 整数	分页输出中返回的快照结果的最大数量。 仅使用时，将仅返回单个页面以及 next_token_id 响应元素。 可以通过使用返回的 next_token_id 值发送另一个请求来查看初始请求的其余结果。 此值可以在 5 到 1000 之间；如果 next_token_id 的值大于 1000，则仅返回 1000 个结果。 如果不使用此参数，则 DescribeSnapshots 返回所有结果。 此参数与 snapshot_ids 互斥。
next_token_id 字符串	包含先前分页请求返回的值，其中使用了max_results，并且结果超过了该参数的值。 分页从先前返回next_token_id 值的结果末尾继续。 此参数与snapshot_ids互斥。
owner_ids 列表 / 元素=字符串	如果指定一个或多个快照所有者，则只返回来自指定所有者且您有权访问的快照。 默认值： []
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选项互斥。
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 之后的一个版本中删除。
restorable_by_user_ids 列表 / 元素=字符串	如果指定可恢复用户的列表，则只返回对这些用户具有创建快照权限的快照。 默认值： []
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 之后的一个版本中删除。
snapshot_ids 列表 / 元素=字符串	如果指定一个或多个快照 ID，则只返回具有指定 ID 的快照。 默认值： []
validate_certs 布尔值	设置为false时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置validate_certs=false，作为替代方案，请考虑改为设置aws_ca_bundle。 选项 false true ← (默认)

注释

注意

• 默认情况下，模块将返回所有快照，包括公共快照。要将结果限制为帐户拥有的快照，请使用过滤器owner-id。

• 警告：对于模块，环境变量和配置文件是从 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 snapshots, including public ones
- amazon.aws.ec2_snapshot_info:

# Gather information about all snapshots owned by the account 123456789012
- amazon.aws.ec2_snapshot_info:
    filters:
      owner-id: 123456789012

# Or alternatively...
- amazon.aws.ec2_snapshot_info:
    owner_ids:
      - 123456789012

# Gather information about a particular snapshot using ID
- amazon.aws.ec2_snapshot_info:
    filters:
      snapshot-id: snap-00112233

# Or alternatively...
- amazon.aws.ec2_snapshot_info:
    snapshot_ids:
      - snap-00112233

# Gather information about any snapshot with a tag key Name and value Example
- amazon.aws.ec2_snapshot_info:
    filters:
      "tag:Name": Example

# Gather information about any snapshot with an error status
- amazon.aws.ec2_snapshot_info:
    filters:
      status: error

返回值

此处记录了常见的返回值 此处，以下是此模块独有的字段

Key	描述
next_token_id 字符串	包含先前分页请求返回的值，其中使用了max_results，并且结果超过了该参数的值。 当没有更多结果返回时，此值为 null。 返回：当在输入中设置选项max_results时
snapshots 列表 / 元素=字典	检索到的快照列表及其各自的信息。 返回：成功
create_volume_permissions 列表 / 元素=字典	具有从快照创建卷的权限的用户和组。 如果快照上的创建卷权限为“私有”，则模块将返回空列表。 返回：成功 示例： [{"group": "all"}]
data_encryption_key_id 字符串	快照的数据加密密钥标识符。此值是唯一标识符，对应于用于加密原始卷或快照副本的数据加密密钥。 返回：始终 示例： "arn:aws:kms:ap-southeast-2:123456789012:key/74c9742a-a1b2-45cb-b3fe-abcdef123456"
description 字符串	快照的描述。 返回：始终 示例： "My important backup"
encrypted 布尔值	指示快照是否已加密。 返回：始终 示例： true
kms_key_id 字符串	用于保护父卷的卷加密密钥的 AWS 密钥管理服务 (AWS KMS) 客户主密钥 (CMK) 的完整 ARN。 返回：成功 示例： "74c9742a-a1b2-45cb-b3fe-abcdef123456"
owner_id 字符串	EBS 快照所有者的 AWS 帐户 ID。 返回：始终 示例： "123456789012"
progress 字符串	快照的进度（百分比）。 返回：始终 示例： "100%"
snapshot_id 字符串	快照的 ID。每个快照在创建时都会收到唯一的标识符。 返回：始终 示例： "snap-01234567"
start_time 字符串	启动快照的时间戳。 返回：始终 示例： "2015-02-12T02:14:02+00:00"
state 字符串	快照状态（已完成、挂起或错误）。 返回：始终 示例： "completed"
state_message 字符串	加密的 Amazon EBS 快照是异步复制的。如果快照复制操作失败（例如，如果未获得正确的 AWS 密钥管理服务 (AWS KMS) 权限），则此字段将显示错误状态详细信息，以帮助您诊断错误发生的原因。 返回：成功
storage_tier 字符串	存储快照的存储层。 返回：始终 示例： "standard"
tags 字典	分配给快照的任何标签。 返回：始终 示例： {"my_tag_key": "my_tag_value"}
volume_id 字符串	用于创建快照的卷的 ID。 返回：始终 示例： "vol-01234567"
volume_size 整数	卷的大小（以 GiB 为单位）。 返回：始终 示例： 8

作者

• Rob White (@wimnat)

• Aubin Bikouo (@abikouo)

资源链接

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