amazon.aws.ec2_snapshot 模块 – 从现有卷创建快照

注意

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

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

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

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

amazon.aws 1.0.0 中的新增功能

概要

• 从现有的 EBS 卷创建 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 保持一致，在 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
description 字符串	要应用于快照的描述。
device_name 字符串	要拍摄快照的已挂载卷的设备名称。
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 之后的一个版本中删除。
group_names 列表 / 元素=字符串 在 amazon.aws 6.1.0 中添加	要添加或删除的组。可能的值是 all。 与 user_ids 互斥。 选项 "all"
instance_id 字符串	具有要拍摄快照的已挂载卷的实例。
last_snapshot_min_age 整数	如果卷的最新快照的启动时间少于 last_snapshot_min_age 分钟前，则不会创建新的快照。 默认值： 0
modify_create_vol_permission 布尔值 在 amazon.aws 6.1.0 中添加	如果设置为true，则可以修改 ec2 快照的 createVolumePermissions。 选项 false true
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_create_vol_permission 布尔值 在 amazon.aws 6.1.0 中添加	是否应从快照 createVolumePermission 中删除未指定的组名或用户 ID。 当purge_create_vol_permission设置为True时，必须将modify_create_vol_permission设置为True。 选项 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 之后的一个版本中删除。
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 保持一致，别名aws_secret_access_key是在 5.1.0 版本中添加的。 别名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选项互斥。 别名aws_session_token和session_token是在 3.2.0 版本中添加的，参数在 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_id 字符串	要删除的快照 ID。
snapshot_tags 字典	要添加到快照的标签字典。 如果卷具有Name标签，则会自动将其添加到快照。 默认值：{}
state 字符串	是否添加或创建快照。 选项 "absent" "present" ← (默认)
user_ids 列表 / 元素=字符串 在 amazon.aws 6.1.0 中添加	要添加或删除的帐户用户 ID。 如果快照上的 createVolumePermission 当前设置为 Public，即group_names=all，除非modify_create_vol_permission设置为true，否则提供user_ids不会使 createVolumePermission 成为 Private。 与group_names互斥。
validate_certs 布尔值	设置为false时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置validate_certs=false，作为替代方案，请考虑设置aws_ca_bundle。 选项 false true ← (默认)
volume_id 字符串	从中拍摄快照的卷。
wait 布尔值	等待快照准备就绪。 选项 false true ← (默认)
wait_timeout 整数	等待放弃之前的时长（以秒为单位）。 默认值：600

备注

注意

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

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

示例

# Simple snapshot of volume using volume_id
- amazon.aws.ec2_snapshot:
    volume_id: vol-abcdef12
    description: snapshot of /data from DB123 taken 2013/11/28 12:18:32

# Snapshot of volume mounted on device_name attached to instance_id
- amazon.aws.ec2_snapshot:
    instance_id: i-12345678
    device_name: /dev/sdb1
    description: snapshot of /data from DB123 taken 2013/11/28 12:18:32

# Snapshot of volume with tagging
- amazon.aws.ec2_snapshot:
    instance_id: i-12345678
    device_name: /dev/sdb1
    snapshot_tags:
      frequency: hourly
      source: /data

# Remove a snapshot
- amazon.aws.ec2_snapshot:
    snapshot_id: snap-abcd1234
    state: absent

# Create a snapshot only if the most recent one is older than 1 hour
- amazon.aws.ec2_snapshot:
    volume_id: vol-abcdef12
    last_snapshot_min_age: 60

- name: Reset snapshot createVolumePermission (change permission to "Private")
  amazon.aws.ec2_snapshot:
    snapshot_id: snap-06a6f641234567890
    modify_create_vol_permission: true
    purge_create_vol_permission: true

- name: Modify snapshot createVolmePermission to add user IDs (specify purge_create_vol_permission=true to change permssion to "Private")
  amazon.aws.ec2_snapshot:
    snapshot_id: snap-06a6f641234567890
    modify_create_vol_permission: true
    user_ids:
      - '123456789012'
      - '098765432109'

- name: Modify snapshot createVolmePermission - remove all except specified user_ids
  amazon.aws.ec2_snapshot:
    snapshot_id: snap-06a6f641234567890
    modify_create_vol_permission: true
    purge_create_vol_permission: true
    user_ids:
      - '123456789012'

- name: Replace (purge existing) snapshot createVolmePermission annd add user IDs
  amazon.aws.ec2_snapshot:
    snapshot_id: snap-06a6f641234567890
    modify_create_vol_permission: true
    purge_create_vol_permission: true
    user_ids:
      - '111111111111'

- name: Modify snapshot createVolmePermission - make createVolumePermission "Public"
  amazon.aws.ec2_snapshot:
    snapshot_id: snap-06a6f641234567890
    modify_create_vol_permission: true
    purge_create_vol_permission: true
    group_names:
      - all

返回值

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

Key	描述
snapshot_id 字符串	快照的 ID。每个快照在创建时都会收到一个唯一的标识符。 返回：始终 示例："snap-01234567"
snapshots 列表 / 元素=字典	快照列表。 返回：始终
description 字符串	已应用于所有快照的 CreateSnapshotRequest 指定的描述。 返回：始终 示例：""
encrypted 布尔值	指示快照是否已加密。 返回：始终 示例：false
owner_id 字符串	创建此快照时使用的帐户 ID。 返回：始终 示例："123456"
progress 字符串	此快照完成的进度。 返回：始终 示例：""
snapshot_id 字符串	可用于描述此快照的快照 ID。 返回：始终 示例："snap-1234"
start_time 字符串	此快照启动的时间。对于由同一请求启动的所有快照，此时间相同。 返回：始终 示例："2024-05-07T14:29:24.523000+00:00"
state 字符串	快照的当前状态。 返回：始终 示例："pending"
tags 字典	与此快照关联的标签。 返回：始终 示例：{"Name": "instance-name"}
volume_id 字符串	用于创建快照的卷的 ID。 返回：始终 示例："vol-01234567"
volume_size 整数	卷的大小（以 GiB 为单位）。 返回：始终 示例：8
tags 字典	分配给快照的任何标签。 返回：始终 示例：{"Name": "instance-name"}
volume_id 字符串	用于创建快照的卷的 ID。 返回：始终 示例："vol-01234567"
volume_size 整数	卷的大小（以 GiB 为单位）。 返回：始终 示例：8

作者

• Will Thames (@willthames)

收藏链接

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