amazon.aws.autoscaling_instance_refresh 模块 – 在 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_instance_refresh。

community.aws 3.2.0 中的新增功能

概要

• 在 AWS 中启动或取消 EC2 自动伸缩组实例刷新。

• 可与 amazon.aws.autoscaling_instance_refresh_info 一起使用以跟踪后续进度。

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

别名：ec2_asg_instance_refresh

需求

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

• 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 字符串 / 必需	您要搜索的自动伸缩组的名称。
preferences 字典	与实例刷新请求关联的一组首选项。 如果未提供，则使用默认值。 对于 preferences.min_healthy_percentage，默认值为 90。 对于preferences.instance_warmup，默认情况下使用自动伸缩组健康检查宽限期指定的数值。 当state=cancelled时，无法指定此参数。
instance_warmup 整数	新启动的实例配置完成并可投入使用所需的时间（秒）。 在此期间，Amazon EC2 Auto Scaling不会立即进行下一个替换操作。 默认情况下使用为该组定义的健康检查宽限期数值。
max_healthy_percentage 整数 在 amazon.aws 9.0.0 版本中添加	指定在替换实例时，组中可以处于服务中且处于健康状态或待处理状态的最大百分比，以支持您的工作负载。 该值表示为自动伸缩组目标容量的百分比。 取值范围为100到200。 如果指定此参数，则还必须指定preferences.min_healthy_percentage，并且两者之间的差值不能大于100。
min_healthy_percentage 整数	在实例刷新期间，ASG 中必须保持健康状态的总容量百分比，以允许操作继续。 向上取整到最接近的整数。 取值范围为0到100。 默认值：90
skip_matching 布尔值 在 amazon.aws 9.0.0 版本中添加	指示是否启用跳过匹配。 如果启用（true），则 Amazon EC2 Auto Scaling 将跳过替换与所需配置匹配的实例。 选项 false true
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 之后的发行版中移除。
state 字符串 / 必需	ASG 的所需状态。 选项 "started" "cancelled"
strategy 字符串	用于实例刷新的策略。唯一有效的值是Rolling。 滚动更新是指将更新应用于自动伸缩组中的所有实例，直到所有实例都已更新为止。 由于健康检查失败，或者实例处于待机状态或受保护免受缩容的影响，滚动更新可能会失败。 如果滚动更新过程失败，则不会将任何已替换的实例回滚到其之前的配置。 默认值："Rolling"
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: Start a refresh
  amazon.aws.autoscaling_instance_refresh:
    name: some-asg
    state: started

- name: Cancel a refresh
  amazon.aws.autoscaling_instance_refresh:
    name: some-asg
    state: cancelled

- name: Start a refresh and pass preferences
  amazon.aws.autoscaling_instance_refresh:
    name: some-asg
    state: started
    preferences:
      min_healthy_percentage: 91
      instance_warmup: 60
      skip_matching: true

返回值

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

键	描述
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"

作者

• Dan Khersonsky (@danquixote)

相关链接

• 问题追踪器
• 代码仓库
• 沟通