amazon.aws.ec2_ami 模块 – 在 EC2 中创建或销毁镜像 (AMI)

注意

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

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

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

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

amazon.aws 1.0.0 中的新增功能

概要 

注册或注销 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_access_key_id 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 ec2_access_key 别名已弃用，将在 2024-12-01 之后的一个版本中删除。 `EC2_ACCESS_KEY` 环境变量的支持已弃用，将在 2024-12-01 之后的一个版本中删除。
architecture 字符串	要注册的镜像的目标架构。默认值： `"x86_64"`
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。
billing_products 列表 / 元素=字符串	有效的计费代码列表。AWS Marketplace 供应商应将其与有效的帐户一起使用。
boot_mode 字符串 amazon.aws 5.5.0 中新增	AMI 的启动模式。有关更多详细信息，请参阅 AWS 文档 https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html。对 `uefi-preferred` 的支持已在 8.2.0 版本中添加。选项 `"legacy-bios"` `"uefi"` `"uefi-preferred"`
debug_botocore_endpoint_logs 布尔值	使用 `botocore.endpoint` 日志记录器来解析在任务期间进行的唯一（而不是总计）`"resource:action"` API 调用，并将该集合输出到任务结果中的 resource_actions 密钥。使用 `aws_resource_action` 回调将输出到 playbook 期间进行的总列表。也可以使用 `ANSIBLE_DEBUG_BOTOCORE_LOGS` 环境变量。选项 `false` ← (默认值) `true`
delete_snapshot 布尔值	注销 AMI 时删除快照。选项 `false` ← (默认值) `true`
description 字符串	描述 AMI 内容和用途的人类可读字符串。默认值： `""`
device_mapping 列表 / 元素=字典	具有自定义配置的设备哈希/字典列表（相同的块设备映射参数）。
delete_on_termination 布尔值	实例终止时是否应自动删除设备。选项 `false` `true`
device_name 字符串 / 必需	设备名称。例如 `/dev/sda`。
encrypted 布尔值	卷是否应加密。选项 `false` `true`
iops 整数	使用 `device_mapping.volume_type=io1` 时，这将设置为此卷预配的 IOPS 数量。
no_device 布尔值	抑制 AMI 的块设备映射中包含的指定设备。选项 `false` `true`
snapshot_id 字符串	快照的 ID。
virtual_name 字符串	设备的虚拟名称。有关更多详细信息，请参阅 AWS 文档 https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html。
volume_size 别名：size 整数	卷的大小（以 GiB 为单位）。
volume_type 字符串	卷类型。未设置时默认为`gp2`。
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 之后的发行版中移除。
enhanced_networking 布尔值	表示是否启用具有 ENA 的增强型网络的布尔值。选项 `false` `true`
image_id 字符串	要取消注册的镜像 ID。
image_location 字符串	AMI 使用的镜像的 S3 位置。
instance_id 字符串	从中创建 AMI 的实例 ID。
kernel_id 字符串	要注册的镜像的目标内核 ID。
launch_permissions 字典	AMI 的启动权限。如果要修改现有启动权限，则必须传递所有所需的启动权限（仅传递组将删除所有用户）。
group_names 列表 / 元素=字符串	组名称列表。
org_arns 列表 / 元素=字符串 amazon.aws 6.5.0 版本中新增	组织的 Amazon 资源名称 (ARN) 列表。
org_unit_arns 列表 / 元素=字符串 amazon.aws 6.5.0 版本中新增	组织单位 (OU) 的 Amazon 资源名称 (ARN) 列表。
user_ids 列表 / 元素=字符串	账户 ID 列表。
name 字符串	新 AMI 的名称。
no_reboot 布尔值	指示捆绑过程不应尝试在捆绑之前关闭实例的标志。如果此标志为`true`，则保持文件系统完整性的责任留给实例的所有者。选项 `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_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` ← (默认)
ramdisk_id 字符串	RAM 磁盘的 ID。
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 之后的发行版中移除。
root_device_name 字符串	要注册的镜像的根设备名称。
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 之后的发行版中移除。
sriov_net_support 字符串	设置为 simple 以启用使用 Intel 82599 虚拟函数接口的增强型网络，用于 AMI 和从 AMI 启动的任何实例。
state 字符串	注册或取消注册 AMI。选项 `"absent"` `"present"` ← (默认)
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。如果没有设置`tags`参数，则不会修改标签。
tpm_support 字符串 amazon.aws 5.5.0 中新增	设置为`v2.0`以启用可信平台模块 (TPM) 支持。如果镜像配置为支持 NitroTPM，则值为`v2.0`。需要将`boot_mode`设置为`uefi`。需要与 Nitro 兼容的实例类型。有关更多详细信息，请参阅 AWS 文档 https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html。
uefi_data 字符串 amazon.aws 5.5.0 中新增	非易失性 UEFI 变量存储的 Base64 表示。有关更多详细信息，请参阅 AWS 文档 https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html。
validate_certs 布尔值	设置为`false`时，将不会验证与 AWS API 通信的 SSL 证书。强烈建议不要设置validate_certs=false，作为替代方案，请考虑改为设置aws_ca_bundle。选项 `false` `true` ← (默认)
virtualization_type 字符串	要注册的镜像的虚拟化类型。默认值： `"hvm"`
wait 布尔值	等待 AMI 状态变为“可用”后再返回。选项 `false` ← (默认值) `true`
wait_timeout 整数	wait 超时之前等待的时间（以秒为单位）。默认值： `1200`

备注 

注意

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

- name: Basic AMI Creation
  amazon.aws.ec2_ami:
    instance_id: i-xxxxxx
    wait: true
    name: newtest
    tags:
      Name: newtest
      Service: TestService

- name: Basic AMI Creation, without waiting
  amazon.aws.ec2_ami:
    instance_id: i-xxxxxx
    wait: false
    name: newtest

- name: AMI Registration from EBS Snapshot
  amazon.aws.ec2_ami:
    name: newtest
    state: present
    architecture: x86_64
    virtualization_type: hvm
    root_device_name: /dev/xvda
    device_mapping:
      - device_name: /dev/xvda
        volume_size: 8
        snapshot_id: snap-xxxxxxxx
        delete_on_termination: true
        volume_type: gp2

- name: AMI Creation, with a custom root-device size and another EBS attached
  amazon.aws.ec2_ami:
    instance_id: i-xxxxxx
    name: newtest
    device_mapping:
      - device_name: /dev/sda1
        size: XXX
        delete_on_termination: true
        volume_type: gp2
      - device_name: /dev/sdb
        size: YYY
        delete_on_termination: false
        volume_type: gp2

- name: AMI Creation, excluding a volume attached at /dev/sdb
  amazon.aws.ec2_ami:
    instance_id: i-xxxxxx
    name: newtest
    device_mapping:
      - device_name: /dev/sda1
        size: XXX
        delete_on_termination: true
        volume_type: gp2
      - device_name: /dev/sdb
        no_device: true

- name: AMI Creation with boot_mode and tpm_support
  amazon.aws.ec2_ami:
    name: newtest
    state: present
    architecture: x86_64
    virtualization_type: hvm
    root_device_name: /dev/sda1
    device_mapping:
      - device_name: /dev/sda1
        snapshot_id: "{{ snapshot_id }}"
    wait: true
    region: us-east-1
    boot_mode: uefi
    uefi_data: data_file.bin
    tpm_support: v2.0

- name: Deregister/Delete AMI (keep associated snapshots)
  amazon.aws.ec2_ami:
    image_id: "{{ instance.image_id }}"
    delete_snapshot: false
    state: absent

- name: Deregister AMI (delete associated snapshots too)
  amazon.aws.ec2_ami:
    image_id: "{{ instance.image_id }}"
    delete_snapshot: true
    state: absent

- name: Update AMI Launch Permissions, making it public
  amazon.aws.ec2_ami:
    image_id: "{{ instance.image_id }}"
    state: present
    launch_permissions:
      group_names: ['all']

- name: Allow AMI to be launched by another account
  amazon.aws.ec2_ami:
    image_id: "{{ instance.image_id }}"
    state: present
    launch_permissions:
      user_ids: ['123456789012']

- name: Update AMI Launch Permissions, share AMI across an Organization and Organizational Units
  amazon.aws.ec2_ami:
    image_id: "{{ instance.image_id }}"
    state: present
    launch_permissions:
      org_arns: ['arn:aws:organizations::123456789012:organization/o-123ab4cdef']
      org_unit_arns: ['arn:aws:organizations::123456789012:ou/o-123example/ou-1234-5example']

返回值 

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

键	描述
architecture 字符串	镜像架构。返回：当AMI创建或已存在时示例： `"x86_64"`
block_device_mapping 字典	与镜像关联的块设备映射。返回：当AMI创建或已存在时示例： `{"/dev/sda1": {"delete_on_termination": true, "encrypted": false, "size": 10, "snapshot_id": "snap-1a03b80e7", "volume_type": "standard"}}`
creationDate 字符串	镜像的创建日期。返回：当AMI创建或已存在时示例： `"2015-10-15T22:43:44.000Z"`
description 字符串	镜像描述。返回：当AMI创建或已存在时示例： `"nat-server"`
enhanced_networking 布尔值	指定是否启用了具有 ENA 的增强型网络。返回：当AMI创建或已存在时示例： `true`
hypervisor 字符串	虚拟机监控程序类型。返回：当AMI创建或已存在时示例： `"xen"`
image_id 字符串	镜像ID。返回：当AMI创建或已存在时示例： `"ami-1234abcd"`
image_owner_alias 字符串	所有者别名 (amazon \| aws-marketplace)。返回：当AMI创建或已存在时示例： `"amazon"`
image_type 字符串	镜像类型。返回：当AMI创建或已存在时示例： `"machine"`
is_public 布尔值	镜像是否公开。返回：当AMI创建或已存在时示例： `false`
kernel_id 字符串	与镜像关联的内核（如有）。仅适用于机器镜像。返回：当AMI创建或已存在时示例： `"aki-88aa75e1"`
launch_permission 列表 / 元素=字符串	允许其他帐户访问AMI的权限。返回：当AMI创建或已存在时示例： `[{"group": "all"}]`
location 字符串	镜像位置。返回：当AMI创建或已存在时示例： `"123456789012/nat-server"`
name 字符串	镜像的AMI名称。返回：当AMI创建或已存在时示例： `"nat-server"`
ownerId 字符串	镜像所有者。返回：当AMI创建或已存在时示例： `"123456789012"`
platform 字符串	镜像平台。返回：当AMI创建或已存在时示例： `"Windows"`
product_codes 列表 / 元素=字符串	与AMI关联的任何产品代码。返回：当AMI创建或已存在时示例： `[]`
ramdisk_id 字符串	与镜像关联的RAM磁盘（如有）。仅适用于机器镜像。返回：当AMI创建或已存在时
root_device_name 字符串	镜像的根设备名称。返回：当AMI创建或已存在时示例： `"/dev/sda1"`
root_device_type 字符串	镜像的根设备类型。返回：当AMI创建或已存在时示例： `"ebs"`
snapshots_deleted 列表 / 元素=字符串	注销镜像后删除的快照 ID 列表。返回：AMI 注销后，如果 `delete_snapshot=true` 示例： `["snap-fbcccb8f", "snap-cfe7cdb4"]`
sriov_net_support 字符串	指定是否启用了具有 Intel 82599 虚拟功能接口的增强型网络。返回：当AMI创建或已存在时示例： `"simple"`
state 字符串	镜像状态。返回：当AMI创建或已存在时示例： `"available"`
state_reason 字典	状态更改的原因。返回：当AMI创建或已存在时示例： `{"Code": "string", "Message": "string"}`
tags 字典	分配给镜像的标签字典。返回：当AMI创建或已存在时示例： `{"Env": "devel", "Name": "nat-server"}`
virtualization_type 字符串	镜像虚拟化类型。返回：当AMI创建或已存在时示例： `"hvm"`

作者

Evan Duffield (@scicoin-project)
Constantin Bugneac (@Constantin07)
Ross Williams (@gunzy83)
Willem van Ketwich (@wilvk)