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。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

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

community.aws 1.0.0 中的新功能

概要 

当 state=present 且未找到给定挂钩时，将创建新挂钩。
当 state=present 且找到挂钩，但当前参数与提供的参数不同时，将更新现有挂钩。
当 state=absent 且找到挂钩时，将删除该挂钩。
在 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 保持一致，aws_access_key_id 别名已在 5.1.0 版本中添加。 ec2_access_key 别名已弃用，将在 2024-12-01 之后的版本中删除。对 `EC2_ACCESS_KEY` 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
autoscaling_group_name 字符串 / 必需	要向其分配生命周期挂钩的 Auto Scaling 组的名称。
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`
default_result 字符串	定义生命周期挂钩超时或发生意外故障时，Auto Scaling 组应采取的操作。选择 `"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 整数	生命周期挂钩超时前可以经过的时间量（以秒为单位）。当生命周期挂钩超时时，Auto Scaling 将执行默认操作。您可以通过调用 RecordLifecycleActionHeartbeat 来防止生命周期挂钩超时。默认情况下，Amazon AWS 将使用 `3600`（1 小时）。
lifecycle_hook_name 字符串 / 必需	生命周期挂钩的名称。
notification_meta_data 字符串	包含您希望在 Auto Scaling 向通知目标发送消息时包含的附加信息。
notification_target_arn 字符串	Auto Scaling 将用来在实例处于生命周期挂钩的转换状态时通知您的通知目标的 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，允许 Auto Scaling 组发布到指定的通知目标。
secret_key 别名：aws_secret_access_key, aws_secret_key, ec2_secret_key 字符串	AWS secret access key。有关访问令牌的更多信息，请参阅 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 字符串	定义生命周期挂钩超时或发生意外故障时，Auto Scaling 组应采取的操作。返回：成功示例： `"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)