community.aws.autoscaling_launch_config_info 模块 – 收集有关 AWS 自动伸缩启动配置的信息

注意

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

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

要安装它,请使用:ansible-galaxy collection install community.aws。您需要进一步的要求才能使用此模块,有关详细信息,请参见 要求

要在剧本中使用它,请指定:community.aws.autoscaling_launch_config_info

community.aws 1.0.0 中的新增功能

概要

  • 收集有关 AWS 自动伸缩启动配置的信息。

  • 在 5.0.0 版本之前,此模块名为 community.aws.ec2_lc_info。用法没有改变。

别名:ec2_lc_info

要求

执行此模块的主机需要以下要求。

  • 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_IDAWS_ACCESS_KEYEC2_ACCESS_KEY 环境变量,优先级依次降低。

aws_access_keyprofile 选项是互斥的。

为了与 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

字符串

要连接的 URL,而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务,但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。

还可以使用 AWS_URLEC2_URL 环境变量,优先级依次降低。

ec2_urls3_url 别名已弃用,将在 2024-12-01 之后的版本中删除。

EC2_URL 环境变量的支持已弃用,将在 2024-12-01 之后的版本中删除。

name

列表 / 元素=字符串

要匹配的名称或名称列表。

默认值: []

profile

别名:aws_profile

字符串

用于身份验证的已命名 AWS 配置文件。

有关命名配置文件的更多信息,请参见 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html

也可以使用 AWS_PROFILE 环境变量。

profile 选项与 aws_access_keyaws_secret_keysecurity_token 选项互斥。

region

别名: aws_region, ec2_region

字符串

要使用的 AWS 区域。

对于 IAM、Route53 和 CloudFront 等全局服务,将忽略 region

也可以使用 AWS_REGIONEC2_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_KEYAWS_SECRET_KEYEC2_SECRET_KEY 环境变量。

secret_keyprofile 选项互斥。

为了与 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_TOKENAWS_SECURITY_TOKENEC2_SECURITY_TOKEN 环境变量。

security_tokenprofile 选项互斥。

别名 aws_session_tokensession_token 在 3.2.0 版本中添加,参数在 6.0.0 版本中从 security_token 重命名为 session_token

security_tokenaws_security_tokenaccess_token 别名已弃用,将在 2024-12-01 之后的版本中删除。

EC2_SECRET_KEYAWS_SECURITY_TOKEN 环境变量的支持已弃用,将在 2024-12-01 之后的版本中删除。

sort

字符串

用于对结果进行排序的可选属性。

选项

  • "launch_configuration_name"

  • "image_id"

  • "created_time"

  • "instance_type"

  • "kernel_id"

  • "ramdisk_id"

  • "key_name"

sort_end

integer

结束排序的结果(排序时)。

对应于 Python 切片表示法。

sort_order

字符串

对结果进行排序的顺序。

仅当指定 ‘sort’ 参数时使用。

选项

  • "ascending" ← (默认)

  • "descending"

sort_start

integer

开始排序的结果(排序时)。

对应于 Python 切片表示法。

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 all launch configurations
  community.aws.autoscaling_launch_config_info:

- name: Gather information about launch configuration with name "example"
  community.aws.autoscaling_launch_config_info:
    name: example

- name: Gather information sorted by created_time from most recent to least recent
  community.aws.autoscaling_launch_config_info:
    sort: created_time
    sort_order: descending

返回值

常见的返回值记录在此处,以下是此模块独有的字段

描述

block_device_mapping

列表 / 元素=字符串

启动配置实例的块设备映射。

返回: 始终

示例: ["[{ 'device_name': '/dev/xvda':", " 'ebs': { 'delete_on_termination': true", " 'volume_size': 8", " 'volume_type': 'gp2' }]"]

字符串

经典链接 vpc_id 中指定的 VPC 的一个或多个安全组的 ID。

返回: 始终

created_time

字符串

启动配置的创建日期和时间。

返回: 始终

示例: "2016-05-27T13:47:44.216000+00:00"

ebs_optimized

布尔值

EBS I/O 已优化 true 或未优化 false

返回: 始终

示例: "true,"

image_id

字符串

Amazon 系统映像 (AMI) 的 ID。

返回: 始终

示例: "ami-12345678"

instance_monitoring

字典

是否使用详细监控启动。

返回: 始终

示例: "{ 'enabled': true }"

instance_type

字符串

实例类型。

返回: 始终

示例: "t2.micro"

kernel_id

字符串

与 AMI 关联的内核 ID。

返回: 始终

key_name

字符串

密钥对的名称。

返回: 始终

示例: "user_app"

launch_configuration_arn

字符串

启动配置的 Amazon 资源名称 (ARN)。

返回: 始终

示例: "arn:aws:autoscaling:us-east-1:123456798012:launchConfiguration:ba785e3a-dd42-6f02-4585-ea1a2b458b3d:launchConfigurationName/lc-app"

launch_configuration_name

字符串

启动配置的名称。

返回: 始终

示例: "lc-app"

ramdisk_id

字符串

与 AMI 关联的 RAM 磁盘 ID。

返回: 始终

security_groups

列表 / 元素=字符串

要关联的安全组。

返回: 始终

示例: ["[ 'web' ]"]

user_data

字符串

可用的用户数据。

返回: 始终

作者

  • Loïc Latreille (@psykotox)