amazon.aws.autoscaling_instance_info 模块 – 描述与 AWS 自动伸缩组 (ASG) 关联的实例

注意

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

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

要安装它，请使用： ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，请参阅 要求 了解详情。

要在 playbook 中使用它，请指定： amazon.aws.autoscaling_instance_info。

amazon.aws 9.0.0 中的新增功能

概要

  • 描述与 AWS 自动伸缩组 (ASG) 关联的实例。

要求

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

  • 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

字符串

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

也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次递减。

ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的一个版本中删除。

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

group_name

字符串

要管理的自动伸缩组的名称。

group_name 和 instance_ids 是互斥的。

instance_ids

列表 / 元素=字符串

EC2 实例的 ID。

group_name 和 instance_ids 是互斥的。

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。

示例

- name: Describe all instances in a region
  amazon.aws.autoscaling_instance_info:
  register: instances

- name: Describe a specific instance
  amazon.aws.autoscaling_instance_info:
    instance_ids:
      - "i-123456789abcdef01"
  register: instances

- name: Describe the instances attached to a specific Auto Scaling Group
  amazon.aws.autoscaling_instance_info:
    group_name: example-asg
  register: instances

返回值

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

键

描述

auto_scaling_instances

列表 / 元素=字符串

附加到自动伸缩组的EC2实例的描述。

返回：始终

availability_zone

字符串

实例所在的可用区。

返回：始终

示例： "us-east-1a"

health_status

字符串

实例最后报告的运行状况。

返回：始终

示例： "Healthy"

instance_id

字符串

实例的ID。

返回：始终

示例： "i-123456789abcdef01"

instance_type

字符串

实例的实例类型。

返回：始终

示例： "t3.micro"

launch_configuration_name

字符串

启动实例时使用的启动配置的名称。

返回：当实例使用自动伸缩启动配置启动时。

示例： "ansible-test-49630214-mchappel-thinkpadt14gen3-asg-instance-1"

launch_template

字典

启动实例时使用的启动模板的描述。

返回：当实例使用自动伸缩启动模板启动时。

launch_template_id

字符串

启动实例时使用的启动模板的ID。

返回：始终

示例： "12345678-abcd-ef12-2345-6789abcdef01"

launch_template_name

字符串

启动实例时使用的启动模板的名称。

返回：始终

示例： "example-launch-configuration"

version

字符串

启动实例时使用的启动模板的版本。

返回：始终

示例： "$Default"

lifecycle_state

字符串

实例的生命周期状态。

返回：始终

示例： "InService"

protected_from_scale_in

布尔值

自动伸缩组缩容时，实例是否受到保护而不会被终止。

返回：始终

示例： false

作者

  • Mark Chappell (@tremble)