community.aws.autoscaling_launch_config_find 模块 – 查找 AWS Auto Scaling 启动配置

注意

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

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

要安装它,请使用:ansible-galaxy collection install community.aws。您需要满足其他要求才能使用此模块,请参阅 要求 以了解详细信息。

要在 playbook 中使用它,请指定:community.aws.autoscaling_launch_config_find

community.aws 1.0.0 中的新增功能

概要

  • 返回与给定名称匹配的启动配置列表,以及其他有用的信息。

  • 结果可以排序和切片。

  • 基于 Tom Bamford https://github.com/tombamford 的工作。

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

别名:ec2_lc_find

要求

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

  • 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 回调来输出 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_URLEC2_URL 环境变量,优先级递减。

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

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

limit

整数

要显示的结果数。

对应于 Python 切片表示法,如 list[:limit]。

name_regex

字符串 / 必需

要匹配的启动配置。

它将被编译为正则表达式。

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 保持一致,aws_secret_access_key 别名在 5.1.0 版本中添加。

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_order

字符串

结果的排序顺序。

选项

  • "ascending" ← (默认)

  • "descending"

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: Search for the Launch Configurations that start with "app"
  community.aws.autoscaling_launch_config_find:
    name_regex: app.*
    sort_order: descending
    limit: 2

返回值

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

描述

arn

字符串

AMI 的名称

返回: 找到启动配置时

示例: "arn:aws:autoscaling:eu-west-1:12345:launchConfiguration:d82f050e-e315:launchConfigurationName/yourproject"

associate_public_address

布尔值

是否分配公有地址

返回: 找到启动配置时

示例: true

block_device_mappings

列表 / 元素=字符串

启动配置块设备映射属性

返回: 找到启动配置时

示例: []

列表 / 元素=字符串

启动配置经典链接 vpc 安全组属性

返回: 找到启动配置时

示例: []

created_time

字符串

创建时间

返回: 找到启动配置时

示例: "2016-06-29T14:59:22.222000+00:00"

ebs_optimized

布尔值

启动配置 EBS 优化属性

返回: 找到启动配置时

示例: false

image_id

字符串

AMI ID

返回: 找到启动配置时

示例: "ami-0d75df7e"

instance_monitoring

字符串

启动配置实例监控属性

返回: 找到启动配置时

示例: "{'Enabled': False}"

instance_type

字符串

ec2 实例的类型

返回: 找到启动配置时

示例: "t2.small"

kernel_id

字符串

要使用的启动配置内核

返回: 找到启动配置时

示例: ""

keyname

字符串

启动配置 ssh 密钥

返回: 找到启动配置时

示例: "mykey"

name

字符串

启动配置的名称

返回: 找到启动配置时

示例: "myapp-v123"

ram_disk_id

字符串

启动配置 ram 磁盘属性

返回: 找到启动配置时

示例: ""

security_groups

列表 / 元素=字符串

启动配置安全组

返回: 找到启动配置时

示例: []

user_data

字符串

用于启动实例的用户数据

返回: 找到启动配置时

示例: "ZXhwb3J0IENMT1VE"

作者

  • Jose Armesto (@fiunchinho)