amazon.aws.autoscaling_instance 模块 – 管理与 AWS AutoScaling 组 (ASG) 关联的实例

注意

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

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

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

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

amazon.aws 9.0.0 中的新增功能

概要

• 管理与 AWS AutoScaling 组 (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 回调将输出到剧本期间进行的总计列表。 还可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
decrement_desired_capacity 布尔值	当 decrement_desired_capacity=True 时，分离实例、终止实例或将实例置于待机模式将减少 AutoScaling 组的目标容量。 选项 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之后的一个版本中移除。
group_name 字符串 / 必填	要管理的自动伸缩组的名称。
health 字符串	将实例的健康状态设置为特定状态。 选项 “健康” “不健康”
instance_ids 列表 / 元素=字符串	EC2 实例的 ID。 如果state 为 standby、detached 或 terminated 之一，则必填。
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 选项互斥。
protection 布尔值	设置缩容保护属性。 选项 false true
purge_instances 布尔值	除非state=present 或 state=attached，否则将被忽略。 如果purge_instances=True，则instance_ids 中不存在的任何实例都将被安排终止。 注意：在将任何新实例添加到自动伸缩组后，实例将被安排终止；如果wait=True，则在新的实例达到预期状态后，它们将被终止。 选项 false ← (默认) true
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之后的一个版本中移除。
respect_grace_period 布尔值	设置respect_grace_period=False 以忽略与修改health时相关的自动伸缩组的宽限期。 除非设置了health，否则将被忽略。 修改实例的健康状态时，AWS 默认情况下会遵守宽限期。 选项 false true ← (默认)
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 保持一致，别名 aws_secret_access_key 在 5.1.0 版本中添加。 别名 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之后的一个版本中移除。
state 字符串	实例的预期状态。 present - 实例应附加到自动伸缩组并处于服务中。 attached - 实例应附加到自动伸缩组。处于待机状态的实例将保持待机状态。 standby - 实例应置于待机状态。实例必须已经是自动伸缩组的一部分。 detached - 实例将从自动伸缩组中分离。 terminated - 实例将被终止。 注意：将实例添加到自动伸缩组或从待机状态将实例返回到服务时，所需容量将**始终**递增。如果实例总数超过组的最大大小，则操作将失败。 选项 "present" ← (默认) “attached” “terminated” “detached” “standby”
validate_certs 布尔值	设置为false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑改用 aws_ca_bundle。 选项 false true ← (默认)
wait 布尔值	当wait=True 时，将在返回之前等待实例达到请求的状态。 选项 false true ← (默认)
wait_timeout 整数	等待实例达到所需状态的最大时间。 默认值：120

备注

注意

• 警告：对于模块，环境变量和配置文件是从 Ansible 的“主机”上下文读取的，而不是“控制器”上下文。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible 的“控制器”上下文读取的，而不是“主机”上下文。

• Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible “主机”上下文中的配置文件（通常为~/.aws/credentials）读取凭据和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

返回值

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

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

资源链接

• 问题追踪
• 代码仓库
• 通信