community.aws.autoscaling_lifecycle_hook 模块 – 创建、删除或更新 AWS ASG 生命周期钩子

注意

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

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

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

要在 playbook 中使用它，请指定：community.aws.autoscaling_lifecycle_hook。

community.aws 1.0.0 中的新增功能

概要

• 当 state=present 且未找到给定的 Hook 时，将创建一个新的 Hook。

• 当 state=present 且找到 Hook 但当前参数和提供参数不同时，将更新现有 Hook。

• 当 state=absent 且找到 Hook 时，将删除该 Hook。

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

别名：ec2_asg_lifecycle_hook

要求

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

• 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 之后的一个版本中删除。
autoscaling_group_name 字符串 / 必填	要为其分配生命周期钩子的自动伸缩组的名称。
aws_ca_bundle 路径	验证 SSL 证书时使用的 CA Bundle 的位置。 还可以使用 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
default_result 字符串	定义自动伸缩组在生命周期钩子超时或发生意外错误时应采取的操作。 选项 "ABANDON" ← (默认) "CONTINUE"
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 之后的一个版本中移除。
heartbeat_timeout 整数	生命周期钩子超时前可以经过的时间量（以秒为单位）。当生命周期钩子超时时，自动伸缩将执行默认操作。您可以通过调用 RecordLifecycleActionHeartbeat 来防止生命周期钩子超时。 默认情况下，Amazon AWS 将使用 3600（1 小时）。
lifecycle_hook_name 字符串 / 必填	生命周期钩子的名称。
notification_meta_data 字符串	包含您希望在自动伸缩向通知目标发送消息时随时包含的附加信息。
notification_target_arn 字符串	自动伸缩将用于在实例处于生命周期钩子转换状态时通知您的通知目标的 ARN。 此目标可以是 SQS 队列或 SNS 主题。 如果指定空字符串，则将覆盖当前 ARN。
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 之后的一个版本中移除。
role_arn 字符串	允许自动伸缩组发布到指定通知目标的 IAM 角色的 ARN。
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 字符串	创建或删除生命周期钩子。 当 state=present 时，更新现有钩子，如果找不到则创建新钩子。 选项 "present" ← (默认) "absent"
transition 字符串	您要附加生命周期钩子的实例状态。 当 state=present 时必填。 选项 "autoscaling:EC2_INSTANCE_TERMINATING" "autoscaling:EC2_INSTANCE_LAUNCHING"
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: Create / Update lifecycle hook
  community.aws.autoscaling_lifecycle_hook:
    region: eu-central-1
    state: present
    autoscaling_group_name: example
    lifecycle_hook_name: example
    transition: autoscaling:EC2_INSTANCE_LAUNCHING
    heartbeat_timeout: 7000
    default_result: ABANDON

- name: Delete lifecycle hook
  community.aws.autoscaling_lifecycle_hook:
    region: eu-central-1
    state: absent
    autoscaling_group_name: example
    lifecycle_hook_name: example

返回值

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

键	描述
auto_scaling_group_name 字符串	自动伸缩组的唯一名称。 返回：成功 示例："myasg"
default_result 字符串	定义自动伸缩组在生命周期钩子超时或发生意外错误时应采取的操作。 返回：成功 示例："CONTINUE"
global_timeout 整数	实例可以在 Pending:Wait 或 Terminating:Wait 状态下保持的最长时间（以秒为单位）。 返回：成功 示例：172800
heartbeat_timeout 整数	生命周期钩子超时前可以经过的最长时间（以秒为单位）。 返回：成功 示例：3600
lifecycle_hook_name 字符串	生命周期钩子的名称。 返回：成功 示例："mylifecyclehook"
lifecycle_transition 字符串	应附加生命周期钩子的实例状态。 返回：成功 示例："autoscaling:EC2_INSTANCE_LAUNCHING"

作者

• Igor ‘Tsigankov’ Eyrich (@tsiganenok)

资源链接

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