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。用法没有改变。

• 此模块最初添加到 community.aws 的 1.0.0 版本中。

别名：ec2_asg_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_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 字符串	连接到非默认 AWS 端点的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 还可以按优先级递减的顺序使用 AWS_URL 或 EC2_URL 环境变量。 ec2_url 和 s3_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_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_secret_access_key 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 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 选项互斥。 别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，参数名称在 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 之后的一个版本中移除。
标签 字典	格式为 {tag1_name: ‘tag1_value’, tag2_name: ‘tag2_value’} 的标签字典/哈希表，用于匹配您正在搜索的自动伸缩组。
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: 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 }}"

返回值

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

键	描述
results 列表 / 元素=字典	自动伸缩组列表。 返回：始终
auto_scaling_group_arn 字符串	ASG 的 Amazon 资源名称。 返回：成功 示例："arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:10787c52-0bcb-427d-82ba-c8e4b008ed2e:autoScalingGroupName/dev11"
auto_scaling_group_name 字符串	自动伸缩组的名称。 返回：成功 示例："public-webapp-production-1"
availability_zones 列表 / 元素=字符串	为此 ASG启用的可用区列表。 返回：成功 示例：["us-west-2a", "us-west-2b", "us-west-2a"]
created_time 字符串	创建此 ASG 的日期和时间，采用 ISO 8601 格式。 返回：成功 示例："2015-11-25T00:05:36.309Z"
default_cooldown 整数	默认冷却时间（秒）。 返回：成功 示例：300
desired_capacity 整数	此组中应运行的 EC2 实例数量。 返回：成功 示例：3
enabled_metrics 列表 / 元素=字典	为该组启用的指标。 返回：成功 示例：[{"granularity": "1Minute", "metric": "GroupAndWarmPoolTotalCapacity"}]
granularity 字符串	指标的粒度。唯一有效值为 1Minute。 返回：成功 示例："1Minute"
metric 字符串	指标名称。 返回：成功 示例："GroupAndWarmPoolTotalCapacity"
health_check_grace_period 整数	新的 EC2 实例投入使用后，自动伸缩开始检查其运行状况的时间长度（秒）。 返回：成功 示例：300
health_check_type 字符串	您想要获取运行状况状态的服务，“EC2”或“ELB”之一。 返回：成功 示例："ELB"
instances 列表 / 元素=字典	与 ASG 关联的 EC2 实例及其状态的列表。 返回：成功 示例：[{"availability_zone": "us-west-2a", "health_status": "Healthy", "instance_id": "i-es22ad25", "launch_configuration_name": "public-webapp-production-1", "launch_template": {"launch_template_id": "lt-0b19eb00123456789", "launch_template_name": "test-template", "version": "1"}, "lifecycle_state": "InService", "protected_from_scale_in": "false"}]
availability_zone 字符串	实例的可用区。 返回：成功 示例："ap-southeast-2a"
health_status 字符串	实例最后报告的运行状况状态。 返回：成功 示例："Healthy"
instance_id 字符串	实例的 ID。 返回：成功 示例："i-012345678"
instance_type 字符串	正在运行的实例的实例类型大小。 返回：成功 示例："t2.micro"
launch_template 字典	用于基于实例配置的 EC2 启动模板。 返回：成功
launch_template_id 字符串	启动模板的 ID。 返回：成功
launch_template_name 字符串	启动模板的名称。 返回：成功
version 整数	要使用的启动模板的特定版本。 返回：成功
lifecycle_state 字符串	当前生命周期状态的描述。 返回：成功
protected_from_scale_in 布尔值	指示在缩减时实例是否受 Amazon EC2 Auto Scaling 保护免于终止。 返回：成功
launch_config_name 字符串	与 ASG 关联的启动配置的名称。与 launch_configuration_name 相同，为了与 amazon.aws.autoscaling_group 模块兼容而提供。 返回：成功 示例："public-webapp-production-1"
launch_configuration_name 字符串	与 ASG 关联的启动配置的名称。 返回：成功 示例："public-webapp-production-1"
lifecycle_hooks 列表 / 元素=字符串	ASG 的生命周期挂钩列表。 返回：成功 示例：[{"AutoScalingGroupName": "public-webapp-production-1", "DefaultResult": "ABANDON", "GlobalTimeout": 172800, "HeartbeatTimeout": 3600, "LifecycleHookName": "instance-launch", "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING"}, {"AutoScalingGroupName": "public-webapp-production-1", "DefaultResult": "ABANDON", "GlobalTimeout": 172800, "HeartbeatTimeout": 3600, "LifecycleHookName": "instance-terminate", "LifecycleTransition": "autoscaling:EC2_INSTANCE_TERMINATING"}]
load_balancer_names 列表 / 元素=字符串	附加到自动伸缩组的负载均衡器名称列表。 返回：成功 示例： ["elb-webapp-prod"]
max_size 整数	组的最大大小。 返回：成功 示例：3
min_size 整数	组的最小大小。 返回：成功 示例： 1
new_instances_protected_from_scale_in 布尔值	新实例是否受保护，免受自动缩容的影响。 返回：成功 示例： false
placement_group 字符串	实例启动时所在的放置组（如有）。 返回：成功 示例： "None"
service_linked_role_arn 字符串	自动伸缩组代表您调用其他亚马逊网络服务时使用的服务关联角色的 ARN。 返回：成功 示例： "arn:aws:iam::721234567890:role/aws-service-role/autoscaling.amazonaws.com/AWSServiceRoleForAutoScaling"
status 字符串	DeleteAutoScalingGroup 正在进行时，组的当前状态。 返回：成功 示例： "None"
suspended_processes 列表 / 元素=字典	与该组关联的已暂停进程。 返回：成功 示例： [{"process_name": "AddToLoadBalancer", "suspension_reason": "User suspended at 2018-08-30T14:11:58Z"}]
process_name 字符串	已暂停进程的名称。 返回：成功
suspension_reason 字符串	暂停进程的原因。 返回：成功
标签 列表 / 元素=字符串	ASG 的标签列表，以及每个标签是否在启动时传播到实例。 返回：成功 示例： [{"key": "Name", "propagate_at_launch": "true", "resource_id": "public-webapp-production-1", "resource_type": "auto-scaling-group", "value": "public-webapp-production-1"}, {"key": "env", "propagate_at_launch": "true", "resource_id": "public-webapp-production-1", "resource_type": "auto-scaling-group", "value": "production"}]
target_group_arns 列表 / 元素=字符串	ASG填充的目标组的ARN列表。 返回：成功 示例： ["arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:targetgroup/target-group-host-hello/1a2b3c4d5e6f1a2b", "arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:targetgroup/target-group-path-world/abcd1234abcd1234"]
target_group_names 列表 / 元素=字符串	ASG填充的目标组的名称列表。 返回：成功 示例： ["target-group-host-hello", "target-group-path-world"]
termination_policies 列表 / 元素=字符串	组的终止策略列表。 返回：成功 示例： ["Default"]
traffic_sources 列表 / 元素=字符串	与该自动伸缩组关联的流量来源。 返回：成功 示例： [{"identifier": "arn:aws:elasticloadbalancing:us-west-2:721234567890:targetgroup/Check-Exter-A4XXXXXXXXXX/8aXXXXXXXXXXXXXX", "type": "elbv2"}]
identifier 字符串	标识流量来源。 返回：成功
type 字符串	为 Identifier 的值提供附加上下文。 返回：成功
vpc_zone_identifier 字符串	一个或多个子网 ID（如果适用），用逗号分隔。 返回：成功 示例： "subnet-0352db1247ae60b40,subnet-01f266bb9928ddaee"

作者

• Rob White (@wimnat)

集合链接

• 问题追踪器
• 代码库 (源代码)
• 沟通