amazon.aws.autoscaling_instance_refresh_info 模块 – 收集有关 AWS 中 EC2 自动伸缩组 (ASG) 实例刷新的信息

注意

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

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

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

要在剧本中使用它，请指定： amazon.aws.autoscaling_instance_refresh_info。

community.aws 3.2.0 中的新增功能

概要

• 描述一个或多个实例刷新。

• 您可以通过查看 instance_refreshes.status 返回值来确定请求的状态。

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

别名：ec2_asg_instance_refresh_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 回调将输出到剧本期间进行的总列表。 也可以使用 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 之后的一个版本中删除。
ids 列表 / 元素=字符串	一个或多个实例刷新 ID。 默认值： []
max_records 整数	此调用要返回的项目最大数量。默认值为 50，最大值为 100。
name 字符串 / 必需	自动伸缩组的名称。
next_token 字符串	要返回的下一组项目的令牌。（您从之前的调用中收到此令牌。）
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。

示例

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Find an refresh by ASG name
  amazon.aws.autoscaling_instance_refresh_info:
    name: somename-asg

- name: Find an refresh by ASG name and one or more refresh-IDs
  amazon.aws.autoscaling_instance_refresh_info:
    name: somename-asg
    ids: ['some-id-123']
  register: asgs

- name: Find an refresh by ASG name and set max_records
  amazon.aws.autoscaling_instance_refresh_info:
    name: somename-asg
    max_records: 4
  register: asgs

- name: Find an refresh by ASG name and NextToken, if received from a previous call
  amazon.aws.autoscaling_instance_refresh_info:
    name: somename-asg
    next_token: 'some-token-123'
  register: asgs

返回值

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

键	描述
instance_refreshes 复杂类型	实例刷新的列表。 返回：始终
auto_scaling_group_name 字符串	自动伸缩组的名称。 返回：成功 示例："public-webapp-production-1"
end_time 字符串	此 ASG 创建的日期和时间，采用 ISO 8601 格式。 返回：成功 示例："2015-11-25T00:05:36.309Z"
instance_refresh_id 字符串	实例刷新 ID。 返回：成功 示例："08b91cf7-8fa6-48af-b6a6-d227f40f1b9b"
instances_to_update 整数	要更新的实例数量。 返回：成功 示例：5
percentage_complete 整数	完成百分比 返回：成功 示例：100
preferences 字典	实例刷新的首选项。 返回：始终 示例：{"AlarmSpecification": {"Alarms": ["my-alarm"]}, "AutoRollback": true, "InstanceWarmup": 200, "MinHealthyPercentage": 90, "ScaleInProtectedInstances": "Ignore", "SkipMatching": false, "StandbyInstances": "Ignore"}
start_time 字符串	此 ASG 创建的日期和时间，采用 ISO 8601 格式。 返回：成功 示例："2015-11-25T00:05:36.309Z"
status 字符串	DeleteAutoScalingGroup 正在进行时组的当前状态。 以下是可能的狀態： Pending - 请求已创建，但操作尚未开始。 InProgress - 操作正在进行中。 Successful - 操作成功完成。 Failed - 操作未能完成。您可以使用状态原因和缩放活动进行故障排除。 Cancelling - 正在取消正在进行的操作。取消不会回滚已完成的任何替换，但会阻止启动新的替换。 Cancelled - 操作已取消。 返回：成功 示例："Pending"
next_token 字符串	指示响应包含比单个响应中可以返回的更多项目的字符串。 返回：始终

作者

• Dan Khersonsky (@danquixote)

集合链接

• 问题跟踪器
• 代码库（源代码）
• 通信