amazon.aws.autoscaling_group_info 模块 – 收集 AWS 中 EC2 自动伸缩组（ASG）的信息
注意
此模块是 amazon.aws 集合（版本 9.0.0）的一部分。
如果您使用的是 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install amazon.aws。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定： amazon.aws.autoscaling_group_info。
amazon.aws 5.0.0 中的新增功能
概要
收集 AWS 中 EC2 自动伸缩组（ASG）的信息。
在 5.0.0 版本之前，此模块名为 community.aws.ec2_asg_info。用法没有改变。
此模块最初在 1.0.0 版本中添加到
community.aws中。
别名：ec2_asg_info
要求
执行此模块的主机需要满足以下要求。
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
参数
参数 |
注释 |
|---|---|
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 和 profile 选项是互斥的。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
验证 SSL 证书时要使用的 CA 包的位置。 也可以使用 |
|
用于修改 botocore 配置的字典。 参数可以在 AWS 文档中找到 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。 |
|
使用 也可以使用 选择
|
|
要连接到的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他 AWS 兼容服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以使用 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
您要搜索的自动伸缩组的前缀或名称。 注意：这是一个正则表达式匹配，带有隐式的 ‘^’（字符串开头）。附加 ‘$’ 以进行完全名称匹配。 |
|
用于身份验证的命名 AWS 配置文件。 有关命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。 |
|
要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全局服务，将忽略 region。 也可以使用 有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。 别名 对 |
|
AWS 密钥。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级降序使用 secret_key 和 profile 选项是互斥的。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 别名 ec2_secret_key 已被弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
用于临时凭证的 AWS STS 会话令牌。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级降序使用 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 之后的版本中删除。 对 |
|
用于匹配正在搜索的自动伸缩组的标签字典/哈希，格式为 { tag1_name: 'tag1_value', tag2_name: 'tag2_value' }。 |
|
设置为 强烈建议不要设置 *validate_certs=false*，作为替代方案，请考虑设置 *aws_ca_bundle*。 选择
|
说明
注意
注意： 对于模块，环境变量和配置文件是从 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: Find all groups
amazon.aws.autoscaling_group_info:
register: asgs
- name: Find a group with matching name/prefix
amazon.aws.autoscaling_group_info:
name: public-webserver-asg
register: asgs
- name: Find a group with matching tags
amazon.aws.autoscaling_group_info:
tags:
project: webapp
env: production
register: asgs
- name: Find a group with matching name/prefix and tags
amazon.aws.autoscaling_group_info:
name: myproject
tags:
env: production
register: asgs
- name: Fail if no groups are found
amazon.aws.autoscaling_group_info:
name: public-webserver-asg
register: asgs
failed_when: "{{ asgs.results | length == 0 }}"
- name: Fail if more than 1 group is found
amazon.aws.autoscaling_group_info:
name: public-webserver-asg
register: asgs
failed_when: "{{ asgs.results | length > 1 }}"
返回值
通用返回值在此处有文档记录：这里，以下是此模块独有的字段
键 |
描述 |
|---|---|
自动伸缩组的列表。 返回值： 始终 |
|
ASG 的 Amazon 资源名称。 返回值： 成功 示例： |
|
自动伸缩组的名称。 返回值： 成功 示例： |
|
为此 ASG 启用的可用区列表。 返回值： 成功 示例： |
|
此 ASG 的创建日期和时间，格式为 ISO 8601。 返回值： 成功 示例： |
|
默认冷却时间（以秒为单位）。 返回值： 成功 示例： |
|
此组中应运行的 EC2 实例数量。 返回值： 成功 示例： |
|
为组启用的指标。 返回值： 成功 示例： |
|
指标的粒度。唯一有效的值是 1Minute。 返回值： 成功 示例： |
|
指标的名称。 返回值： 成功 示例： |
|
在新的 EC2 实例投入使用后，自动伸缩开始检查其运行状况的时间长度（以秒为单位）。 返回值： 成功 示例： |
|
您想要从中获取运行状况状态的服务，为 “EC2” 或 “ELB” 之一。 返回值： 成功 示例： |
|
与 ASG 关联的 EC2 实例及其状态的列表。 返回值： 成功 示例： |
|
实例的可用区。 返回值： 成功 示例： |
|
实例的上次报告的运行状况。 返回值： 成功 示例： |
|
实例的 ID。 返回值： 成功 示例： |
|
正在运行的实例的实例类型大小。 返回值： 成功 示例： |
|
EC2 启动模板，用于配置实例的基础。 返回值： 成功 |
|
启动模板的 ID。 返回值： 成功 |
|
启动模板的名称。 返回值： 成功 |
|
要使用的启动模板的特定版本。 返回值： 成功 |
|
当前生命周期状态的描述。 返回值： 成功 |
|
指示实例在缩减时是否受到 Amazon EC2 Auto Scaling 的保护，免于终止。 返回值： 成功 |
|
与 ASG 关联的启动配置的名称。与 launch_configuration_name 相同，为与 amazon.aws.autoscaling_group 模块兼容而提供。 返回值： 成功 示例： |
|
与 ASG 关联的启动配置的名称。 返回值： 成功 示例： |
|
ASG 的生命周期挂钩列表。 返回值： 成功 示例： |
|
附加到 ASG 的负载均衡器名称的列表。 返回值： 成功 示例： |
|
组的最大大小。 返回值： 成功 示例： |
|
组的最小大小。 返回值： 成功 示例： |
|
新实例是否受自动缩减保护。 返回值： 成功 示例： |
|
实例启动到的置放群组（如果有）。 返回值： 成功 示例： |
|
自动伸缩组用于代表您调用其他 Amazon Web Services 的服务相关角色的 ARN。 返回值： 成功 示例： |
|
当 DeleteAutoScalingGroup 正在进行时，组的当前状态。 返回值： 成功 示例： |
|
与组关联的已暂停进程。 返回值： 成功 示例: |
|
被暂停进程的名称。 返回值： 成功 |
|
进程被暂停的原因。 返回值： 成功 |
|
ASG 的标签列表，以及每个标签是否在启动时传播到实例。 返回值： 成功 示例: |
|
ASG 填充的目标组的 ARN 列表。 返回值： 成功 示例: |
|
ASG 填充的目标组的名称列表。 返回值： 成功 示例: |
|
该组的终止策略列表。 返回值： 成功 示例: |
|
与此 Auto Scaling 组关联的流量源。 返回值： 成功 示例: |
|
标识流量源。 返回值： 成功 |
|
为 Identifier 的值提供额外的上下文。 返回值： 成功 |
|
一个或多个子网 ID（如果适用），用逗号分隔。 返回值： 成功 示例: |