amazon.aws.ec2_launch_template_info 模块 – 收集启动模板和版本信息

注意

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

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

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

要在剧本中使用它，请指定： amazon.aws.ec2_launch_template_info。

amazon.aws 9.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 回调将输出到剧本期间进行的总列表。

也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选项

  • false ← (默认)

  • true

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 之后的一个版本中移除。

filters

字典

要应用的过滤器字典。每个字典项由一个过滤器键和一个过滤器值组成。

有关可能的过滤器，请参见 https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html。

过滤器名称和值区分大小写。

默认值： {}

launch_template_ids

列表 / 元素=字符串

启动模板的 ID。

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 之后的发行版中删除。

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: Gather information about a launch template
  amazon.aws.ec2_launch_template_info:
    launch_template_ids:
      - 'lt-01238c059e3466abc'

- name: Gather information launch template using name
  amazon.aws.ec2_launch_template_info:
    filters:
      launch-template-name: my-test-launch-template

返回值

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

键

描述

launch_templates

列表 / 元素=字典

启动模板列表。

返回：始终

create_time

字符串

创建启动模板的时间。

返回：始终

created_by

字符串

创建启动模板的主体。

返回：始终

default_version_number

整数

启动模板默认版本的版本号。

返回：始终

latest_version_number

整数

启动模板最新版本的版本号。

返回：始终

launch_template_id

字符串

启动模板的 ID。

返回：始终

launch_template_name

字符串

启动模板的名称。

返回：始终

tags

字典

分配给镜像的标签字典。

返回：当创建 AMI 或 AMI 已存在时

示例：{"Env": "devel", "Name": "nat-server"}

versions

列表 / 元素=字典

启动模板的所有可用版本。

返回：始终

create_time

字符串

创建版本的时间。

返回：始终

created_by

字符串

创建版本的主体。

返回：始终

default_version

布尔值

指示版本是否为默认版本。

返回：始终

launch_template_data

字典

关于启动模板的信息。

返回：始终

block_device_mappings

列表 / 元素=字典

块设备映射。

返回：如果适用

device_name

字符串

设备名称。

返回：始终

ebs

字符串

关于 EBS 卷的块设备的信息。

返回：如果适用

delete_on_termination

布尔值

指示在实例终止时是否删除 EBS 卷。

返回：始终

encrypted

布尔值

指示 EBS 卷是否已加密。

返回：始终

iops

整数

卷支持的每秒 I/O 操作数 (IOPS)。

返回：始终

kms_key_id

整数

用于加密的密钥管理服务 (KMS) CMK 的 ARN。

返回：始终

snapshot_id

字符串

快照的 ID。

返回：始终

throughput

整数

卷支持的吞吐量（以 MiB/s 为单位）。

返回：始终

volume_size

整数

卷的大小（以 GiB 为单位）。

返回：始终

volume_type

字符串

卷类型。

返回：始终

no_device

字符串

要从块设备映射中省略设备，请指定空字符串。

返回：成功

virtual_name

字符串

虚拟设备名称。

返回：始终

cpu_options

字典

实例的 CPU 选项。

返回：如果适用

amd_sev_snp

整数

指示实例是否已启用 AMD SEV-SNP。

返回：如果适用

core_count

整数

实例的 CPU 内核数。

返回：如果适用

threads_per_core

整数

每个 CPU 内核的线程数。

返回：如果适用

disable_api_termination

布尔值

如果设置为 true，则表示无法使用 Amazon EC2 控制台、命令行工具或 API 终止实例。

返回：如果适用

ebs_optimized

布尔值

指示实例是否针对 Amazon EBS I/O 进行了优化。

返回：始终

enclave_options

字典

指示实例是否已启用 Amazon Web Services Nitro Enclaves。

返回：如果适用

enabled

布尔值

如果此参数设置为 true，则表示实例已启用 Amazon Web Services Nitro Enclaves。

返回：始终

iam_instance_profile

字典

IAM 实例配置文件。

返回：如果适用

arn

字符串

实例配置文件的 Amazon 资源名称 (ARN)。

返回：始终

name

字符串

实例配置文件的名称。

返回：始终

image_id

字符串

AMI 的 ID 或 Systems Manager 参数。

返回：如果适用

instance_initiated_shutdown_behavior

字符串

指示从实例启动关闭时实例是否停止或终止。

返回：如果适用

instance_type

字符串

实例类型。

返回：如果适用

kernel_id

字符串

内核的 ID。

返回：如果适用

key_name

字符串

密钥对的名称。

返回：如果适用

metadata_options

字典

实例的元数据选项。

返回：如果适用

http_endpoint

字符串

启用或禁用实例上的 HTTP 元数据端点。

返回：如果适用

http_protocol_ipv6

字符串

启用或禁用实例元数据服务的 IPv6 端点。

返回：如果适用

http_put_response_hop_limit

整数

实例元数据请求所需的 HTTP PUT 响应跳数限制。

返回：如果适用

http_tokens

字符串

指示是否需要 IMDSv2。

返回：如果适用

instance_metadata_tags

字符串

设置为启用以允许从实例元数据访问实例标签。

返回：如果适用

state

字符串

元数据选项更改的状态。

返回：如果适用

monitoring

字典

实例的监控。

返回：如果适用

enabled

布尔值

指示是否启用了详细监控。否则，启用基本监控。

返回：始终

network_interfaces

列表 / 元素=字典

网络接口。

返回：如果适用

associate_carrier_ip_address

布尔值

指示是否为新的网络接口关联一个承载 IP 地址到 eth0。

返回：始终

associate_public_ip_address

布尔值

指示是否为新的网络接口关联一个公有 IPv4 地址到 eth0。

返回：始终

connection_tracking_specification

字典

安全组连接跟踪规范，允许您设置弹性网络接口上连接跟踪的超时时间。

返回：如果适用

tcp_established_timeout

整数

已建立状态下空闲 TCP 连接的超时时间（以秒为单位）。

返回：始终

udp_stream_timeout

整数

空闲 UDP 流的超时时间（以秒为单位），这些流被分类为流，并且已经经历了多个请求-响应事务。

返回：始终

udp_timeout

整数

空闲 UDP 流的超时时间（以秒为单位），这些流仅在一个方向上看到流量或只有一个请求-响应事务。

返回：始终

delete_on_termination

布尔值

指示实例终止时是否删除网络接口。

返回：始终

description

字符串

网络接口的描述。

返回：始终

device_index

整数

网络接口附件的设备索引。

返回：始终

ena_srd_specification

字典

包含从您的启动模板启动的实例的 ENA Express 设置。

返回：如果适用

ena_srd_enabled

布尔值

指示网络接口是否启用了 ENA Express。

返回：始终

ena_srd_udp_specification

字典

为 UDP 网络流量配置 ENA Express。

返回：始终

ena_srd_udp_enabled

布尔值

指示进出实例的 UDP 流量是否使用 ENA Express。

返回：始终

groups

列表 / 元素=字符串

一个或多个安全组的 ID。

返回：如果适用

interface_type

字符串

网络接口的类型。

返回：始终

ipv4_prefix_count

整数

Amazon Web Services 自动分配给网络接口的 IPv4 前缀数量。

返回：如果适用

ipv4_prefixes

列表 / 元素=字典

分配给网络接口的 IPv4 前缀列表。

返回：如果适用

ipv4_prefix

字符串

分配给网络接口的 IPv4 分配前缀。

返回：始终

ipv6_address_count

整数

网络接口的 IPv6 地址数量。

返回：如果适用

ipv6_addresses

列表 / 元素=字典

网络接口的 IPv6 地址。

返回：如果适用

ipv6_address

字符串

IPv6 地址。

返回：始终

is_primary_ipv6

布尔值

确定与网络接口关联的 IPv6 地址是否为主 IPv6 地址。

返回：始终

ipv6_prefix_count

整数

Amazon Web Services 自动分配给网络接口的 IPv6 前缀数量。

返回：如果适用

ipv6_prefixes

列表 / 元素=字典

分配给网络接口的 IPv6 前缀列表。

返回：如果适用

ipv6_prefix

字符串

分配给网络接口的 IPv6 分配前缀。

返回：始终

network_card_index

整数

网卡索引。

返回：如果适用

network_interface_id

字符串

网络接口的 ID。

返回：始终

primary_ipv6

字符串

网络接口的主 IPv6 地址。

返回：如果适用

private_ip_address

字符串

网络接口的主私有 IPv4 地址。

返回：如果适用

private_ip_addresses

列表 / 元素=字符串

私有 IPv4 地址列表。

返回：如果适用

primary

布尔值

指示私有 IPv4 地址是否为主私有 IPv4 地址。

返回：始终

private_ip_address

布尔值

私有 IPv4 地址。

返回：始终

secondary_private_ip_address_count

整数

网络接口的辅助私有 IPv4 地址数量。

返回：如果适用

subnet_id

字符串

网络接口的子网 ID。

返回：始终

placement

字典

实例的放置位置。

返回：如果适用

affinity

字符串

专用主机上实例的亲和性设置。

返回：如果适用

availability_zone

字符串

实例的可用区。

返回：如果适用

group_id

字符串

放置组的组 ID。

返回：如果适用

group_name

字符串

实例的放置组名称。

返回：如果适用

host_id

字符串

实例的专用主机 ID。

返回：如果适用

host_resource_group_arn

字符串

要启动实例的主机资源组的 ARN。

返回：如果适用

partition_number

整数

实例应在其上启动的分区号。

返回：如果适用

tenancy

字符串

实例的租户。

返回：如果适用

ram_disk_id

字符串

RAM 磁盘的 ID（如果适用）。

返回：如果适用

security_group_ids

列表 / 元素=字符串

安全组 ID。

返回：如果适用

security_groups

列表 / 元素=字符串

安全组名称。

返回：如果适用

tag_specifications

列表 / 元素=字典

应用于在实例启动期间创建的资源的标签。

返回：如果适用

resource_type

字符串

要标记的资源类型。

返回：始终

tags

列表 / 元素=字典

资源的标签。

返回：成功

key

字符串

标签的键。

返回：始终

value

字符串

标签的值。

返回：始终

user_data

字符串

实例的用户数据。

返回：如果适用

launch_template_id

字符串

启动模板的 ID。

返回：始终

launch_template_name

字符串

启动模板的名称。

返回：始终

version_description

字符串

版本的描述。

返回：始终

version_number

整数

版本号。

返回：始终

作者

  • Aubin Bikouo (@abikouo)