amazon.aws.ec2_spot_instance_info 模块 – 收集有关 EC2 定时实例请求的信息

注意

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

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

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

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

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。
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_DescribeSpotInstanceRequests.html。默认值： `{}`
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。默认值： `[]`
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.

- name: describe the Spot Instance requests based on request IDs
  amazon.aws.ec2_spot_instance_info:
    spot_instance_request_ids:
      - sir-12345678

- name: describe the Spot Instance requests and filter results based on instance type
  amazon.aws.ec2_spot_instance_info:
    spot_instance_request_ids:
      - sir-12345678
      - sir-13579246
      - sir-87654321
    filters:
      launch.instance-type: t3.medium

- name: describe the Spot requests filtered using multiple filters
  amazon.aws.ec2_spot_instance_info:
    filters:
      state: active
      launch.block-device-mapping.device-name: /dev/sdb

返回值 

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

键	描述
spot_request 列表 / 元素=字典	收集到的有关指定竞价型实例请求的信息。返回：成功时示例： {"create_time": "2021-09-01T21:05:57+00:00", "instance_id": "i-08877936b801ac475", "instance_interruption_behavior": "terminate", "launch_specification": {"ebs_optimized": false, "image_id": "ami-0443305dabd4be2bc", "instance_type": "t2.medium", "key_name": "zuul", "monitoring": {"enabled": false}, "placement": {"availability_zone": "us-east-2b"}, "security_groups": [{"group_id": "sg-01f9833207d53b937", "group_name": "default"}], "subnet_id": "subnet-07d906b8358869bda"}, "launched_availability_zone": "us-east-2b", "product_description": "Linux/UNIX", "spot_instance_request_id": "sir-c3cp9jsk", "spot_price": "0.046400", "state": "active", "status": {"code": "fulfilled", "message": "Your spot request is fulfilled.", "update_time": "2021-09-01T21:05:59+00:00"}, "tags": {}, "type": "one-time", "valid_until": "2021-09-08T21:05:57+00:00"}
create_time 字符串	创建竞价型实例请求的日期和时间。返回：始终
instance_id 字符串	如果已启动实例以满足竞价型实例请求，则为实例 ID。返回：实例存在时
instance_interruption_behavior 字符串	中断竞价型实例时的行为。返回：始终
launch_specification 字典	启动实例的其他信息。返回：始终
ebs_optimized 布尔值	指示实例是否针对 EBS I/O 进行了优化。返回：始终
image_id 字符串	AMI 的 ID。返回：始终
instance_type 字符串	实例类型。返回：始终
key_name 字符串	密钥对的名称。返回：始终
monitoring 字典	描述实例的监控。返回：始终
enabled 布尔值	指示是否启用了详细监控。返回：始终
placement 字典	实例的放置信息。返回：始终
availability_zone 字符串	可用区的名称。返回：始终
security_groups 列表 / 元素=字典	安全组列表。返回：始终
group_id 字符串	安全组的 ID。返回：始终
group_name 字符串	安全组的名称。返回：始终
subnet_id 字符串	子网的 ID。返回：在启动实例时创建网络接口时
launched_availability_zone 字符串	启动请求的可用区。返回：始终
product_description 字符串	与竞价型实例关联的产品描述。返回：始终
spot_instance_request_id 字符串	竞价型实例请求的 ID。返回：始终
spot_price 字符串	您愿意为竞价型实例支付的每小时最高价格。返回：始终
state 字符串	竞价型实例请求的状态。返回：始终
status 字典	有关竞价型实例请求状态的额外信息。返回：始终
code 字符串	状态代码。有关代码，请参阅 https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html#spot-instance-request-status-understand。返回：始终
message 字符串	状态代码的描述。返回：始终
update_time 字符串	最新状态更新的日期和时间（UTC 格式）。返回：始终
tags 列表 / 元素=字典	与资源关联的标签列表。返回：始终
key 字符串	标签的键。返回：始终
value 字符串	标签的值。返回：始终
type 字符串	竞价型实例请求类型。返回：始终
valid_until 字符串	请求的结束日期（UTC 格式）。返回：始终

作者

Mandar Vijay Kulkarni (@mandar242)