amazon.aws.ec2_spot_instance 模块 – 请求、停止、重启或取消竞价型实例

注意

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

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

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

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

amazon.aws 2.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。
client_token 字符串	如果适用，您在启动实例时提供的幂等性令牌。
count 整数	要启动的实例数量。 默认值： 1
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 后的某个版本中删除。
interruption 字符串	中断竞价型实例时的行为。 选项 "hibernate" "stop" "terminate" ← (默认)
launch_group 字符串	竞价型请求的启动组，请参阅 https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-spot-instances-work.html#spot-launch-group。
launch_specification 字典	启动规范。
block_device_mappings 列表 / 元素=字典	要添加到新实例的卷的哈希/字典列表。
device_name 字符串	设备名称（例如，/dev/sdh 或 xvdh）。
ebs 字典	启动实例时用于自动设置 EBS 卷的参数，请参见 https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.request_spot_instances。
no_device 字符串	要从块设备映射中省略设备，请指定空字符串。
virtual_name 字符串	虚拟设备名称
ebs_optimized 布尔值	实例是否使用优化的 EBS 卷，请参见 https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html。 选项 false ← (默认) true
iam_instance_profile 字典	IAM 实例配置文件。
arn 字符串	实例配置文件的 Amazon 资源名称 (ARN)。 只能指定 launch_specification.iam_instance_profile.arn 或 launch_specification.iam_instance_profile.name 之一。
name 字符串	实例配置文件的名称。 只能指定 launch_specification.iam_instance_profile.arn 或 launch_specification.iam_instance_profile.name 之一。
image_id 字符串	AMI 的 ID。
instance_type 字符串	实例使用的实例类型，请参见 https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html。 创建新实例时必填。
kernel_id 字符串	内核的 ID。
key_name 字符串	在实例上使用的密钥。 要使用此参数，SSH 密钥必须已存在于 AWS 中。 可以使用 amazon.aws.ec2_key 模块创建/删除密钥。
monitoring 字典	指示为实例启用了基本监控还是详细监控。
enabled 布尔值	指示是否启用了详细监控。否则，将启用基本监控。 选项 false ← (默认) true
network_interfaces 列表 / 元素=字典	一个或多个网络接口。如果指定网络接口，则必须使用网络接口指定子网 ID 和安全组 ID。 默认值： []
associate_carrier_ip_address 布尔值	指示是否将运营商 IP 地址分配给网络接口。 选项 false true
associate_public_ip_address 布尔值	指示是否将公共 IPv4 地址分配给在 VPC 中启动的实例。 选项 false true
delete_on_termination 布尔值	如果设置为 true，则在终止实例时删除接口。只有在启动实例时创建新的网络接口时，才能指定 true。 选项 false true
description 字符串	网络接口的描述。仅在启动实例时创建网络接口时适用。
device_index 整数	网络接口在连接顺序中的位置。主网络接口的设备索引为 0。 如果在启动实例时指定网络接口，则必须指定设备索引。
groups 列表 / 元素=字符串	网络接口的安全组 ID。仅在启动实例时创建网络接口时适用。
interface_type 字符串	网络接口的类型。 选项 "interface" "efa"
ipv4_prefix_count 整数	要自动分配给网络接口的 IPv4 委派前缀的数量
ipv4_prefixes 列表 / 元素=字典	要分配给网络接口的一个或多个 IPv4 委派前缀。
ipv6_address_count 整数	要分配给网络接口的 IPv6 地址数量
ipv6_addresses 列表 / 元素=字典	要分配给网络接口的一个或多个 IPv6 地址。
ipv6address 字符串	IPv6 地址。
ipv6_prefix_count 整数	要自动分配给网络接口的 IPv6 委派前缀的数量
ipv6_prefixes 列表 / 元素=字典	要分配给网络接口的一个或多个 IPv6 委派前缀
network_card_index 整数	网卡的索引。
network_interface_id 字符串	网络接口的 ID。
private_ip_address 字符串	网络接口的私有 IPv4 地址
private_ip_addresses 列表 / 元素=字典	要分配给网络接口的一个或多个私有 IPv4 地址
secondary_private_ip_address_count 整数	辅助私有 IPv4 地址的数量。
subnet_id 字符串	与网络接口关联的子网的 ID
placement 字典	实例的放置信息。
availability_zone 字符串	可用区。
group_name 字符串	放置组的名称。
tenancy 字符串	宿主的租用类型 选项 "default" ← (默认) "dedicated" "host"
ramdisk_id 字符串	RAM 磁盘的 ID。
security_group_ids 列表 / 元素=字符串	要与实例一起使用的安全组 ID（或 ID 列表）。
security_groups 列表 / 元素=字符串	要与实例一起使用的安全组名称（或组名称列表）。 仅在 EC2 Classic 中受支持。要在 VPC 中启动，请使用 launch_specification.security_group_ids。
subnet_id 字符串	要在其中启动实例的子网的 ID。
user_data 字符串	实例的 base64 编码用户数据。用户数据限制为 16 KB。
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 之后的一个版本中删除。
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 之后的一个版本中删除。
spot_instance_request_ids 列表 / 元素=字符串	包含要取消的竞价请求 ID 的字符串列表
spot_price 字符串	要出价的最高竞价价格。如果未设置，则请求常规按需实例。 将使用此最高出价发出竞价请求。当满足请求时，将启动实例。
spot_type 字符串	竞价请求的类型。 中断后，persistent 竞价实例将在再次有能力满足请求时启动。 选项 "one-time" ← (默认) "persistent"
state 字符串	竞价请求是否应创建或删除。 当 state=present 时，需要 launch_specification 参数。 当 state=absent 时，需要 spot_instance_request_ids 参数。 选项 "absent" "present" ← (默认)
tags 字典	用于在创建时标记竞价型实例请求的键值对字典。
terminate_instances 布尔值 在 amazon.aws 5.4.0 版本中添加	布尔值，用于设置是否终止与竞价型请求关联的实例。 仅当 state=absent 时可以使用。 选项 false ← (默认) true
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)
zone_group 字符串	竞价型请求的逻辑分组名称。 请求中的所有竞价型实例都在同一个可用区启动。

注释

注意

• 注意：对于模块，环境变量和配置文件是从 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: Simple Spot Request Creation
  amazon.aws.ec2_spot_instance:
    launch_specification:
      image_id: ami-123456789
      key_name: my-keypair
      instance_type: t2.medium

- name: Spot Request Creation with more options
  amazon.aws.ec2_spot_instance:
    launch_specification:
      image_id: ami-123456789
      key_name: my-keypair
      instance_type: t2.medium
      subnet_id: subnet-12345678
      block_device_mappings:
        - device_name: /dev/sdb
          ebs:
            delete_on_termination: true
            volume_type: gp3
            volume_size: 5
        - device_name: /dev/sdc
          ebs:
            delete_on_termination: true
            volume_type: io2
            volume_size: 30
      network_interfaces:
        - associate_public_ip_address: false
          delete_on_termination: true
          device_index: 0
      placement:
        availability_zone: us-west-2a
      monitoring:
        enabled: false
    spot_price: 0.002
    tags:
      Environment: Testing

- name: Spot Request Termination
  amazon.aws.ec2_spot_instance:
    spot_instance_request_ids: ['sir-12345678', 'sir-abcdefgh']
    state: absent

返回值

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

键	描述
cancelled_spot_request 字符串	已取消的竞价型实例请求的详细信息。 返回：取消成功时 示例： "Spot requests with IDs: sir-1234abcd have been cancelled"
spot_request 字典	创建后竞价型实例请求的详细信息。 返回：成功时 示例： {"create_time": "2021-08-23T22:59:12+00:00", "instance_interruption_behavior": "terminate", "launch_specification": {"block_device_mappings": [{"device_name": "/dev/sdb", "ebs": {"delete_on_termination": true, "volume_size": 5, "volume_type": "gp3"}}], "ebs_optimized": false, "iam_instance_profile": {"arn": "arn:aws:iam::EXAMPLE:instance-profile/myinstanceprofile"}, "image_id": "ami-083ac7c7ecf9bb9b0", "instance_type": "t2.small", "key_name": "mykey", "monitoring": {"enabled": false}, "network_interfaces": [{"associate_public_ip_address": false, "delete_on_termination": true, "device_index": 0}], "placement": {"availability_zone": "us-west-2a", "tenancy": "default"}, "security_groups": [{"group_name": "default"}]}, "product_description": "Linux/UNIX", "spot_instance_request_id": "sir-1234abcd", "spot_price": "0.00600", "state": "open", "status": {"code": "pending-evaluation", "message": "Your Spot request has been submitted for review, and is pending evaluation.", "update_time": "2021-08-23T22:59:12+00:00"}, "tags": {}, "type": "one-time"}

作者

• Sri Rachana Achyuthuni (@srirachanaachyuthuni)

集合链接

• 问题追踪器
• 代码仓库
• 通信