Модуль community.aws.autoscaling_lifecycle_hook — создание, удаление или обновление хуков жизненного цикла AWS ASG

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: 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.34.0
botocore >= 1.34.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key string	Идентификатор ключа доступа AWS. Дополнительную информацию о токенах доступа см. в документации 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` — в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS botocore SDK.
autoscaling_group_name string / обязательный	Имя группы Auto Scaling, которой нужно назначить хук жизненного цикла.
aws_ca_bundle path	Путь к пакету сертификатов ЦС, используемому для проверки SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config dictionary	Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs boolean	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общих) вызовов API `"resource:action"`, выполненных во время задачи, и записывать их набор в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в ходе плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
default_result string	Определяет действие, которое должна выполнить группа Auto Scaling по истечении времени ожидания хука жизненного цикла или при возникновении непредвиденной ошибки. Варианты: `"ABANDON"` ← (по умолчанию) `"CONTINUE"`
endpoint_url псевдонимы: aws_endpoint_url string	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим службам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
heartbeat_timeout integer	Время в секундах, которое может пройти до истечения времени ожидания хука жизненного цикла. По истечении этого времени Auto Scaling выполняет действие по умолчанию. Чтобы предотвратить истечение времени ожидания хука жизненного цикла, можно вызвать RecordLifecycleActionHeartbeat. По умолчанию Amazon AWS использует `3600` (1 час).
lifecycle_hook_name string / обязательный	Имя хука жизненного цикла.
notification_meta_data string	Дополнительные сведения, которые нужно включать каждый раз, когда Auto Scaling отправляет сообщение целевому объекту уведомления.
notification_target_arn string	ARN целевого объекта уведомления, который Auto Scaling будет использовать, чтобы уведомлять вас о переходе экземпляра в состояние, связанное с хуком жизненного цикла. Целевым объектом может быть очередь SQS или тема SNS. Если указать пустую строку, текущий ARN будет заменён.
profile псевдонимы: aws_profile string	Именованный профиль AWS, используемый для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и session_token.
region псевдонимы: aws_region string	Регион AWS, который нужно использовать. Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительную информацию см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
role_arn string	ARN роли IAM, которая разрешает группе Auto Scaling публиковать данные в указанный целевой объект уведомления.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key string	Секретный ключ доступа 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` — в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS botocore SDK.
session_token псевдонимы: aws_session_token string	Токен сеанса 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`. Параметры session_token и profile являются взаимоисключающими.
state string	Создать или удалить хук жизненного цикла. Если указано state=present, обновляет существующий хук или создаёт новый, если хук не найден. Варианты: `"present"` ← (по умолчанию) `"absent"`
transition string	Состояние экземпляра, к которому нужно привязать хук жизненного цикла. Обязательный параметр, если указано state=present. Варианты: `"autoscaling:EC2_INSTANCE_TERMINATING"` `"autoscaling:EC2_INSTANCE_LAUNCHING"`
validate_certs boolean	Если задано значение `false`, SSL-сертификаты при обмене данными с API AWS проверяться не будут. Настоятельно не рекомендуется устанавливать 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 string	Уникальное имя группы Auto Scaling. Возвращается: success Пример: `"myasg"`
default_result string	Определяет действие, которое должна выполнить группа Auto Scaling по истечении времени ожидания хука жизненного цикла или при возникновении непредвиденной ошибки. Возвращается: success Пример: `"CONTINUE"`
global_timeout integer	Максимальное время в секундах, в течение которого экземпляр может находиться в состоянии `Pending:Wait` или `Terminating:Wait`. Возвращается: success Пример: `172800`
heartbeat_timeout integer	Максимальное время в секундах, которое может пройти до истечения времени ожидания хука жизненного цикла. Возвращается: success Пример: `3600`
lifecycle_hook_name string	Имя хука жизненного цикла. Возвращается: success Пример: `"mylifecyclehook"`
lifecycle_transition string	Состояние экземпляра, к которому следует привязать хук жизненного цикла. Возвращается: success Пример: `"autoscaling:EC2_INSTANCE_LAUNCHING"`

Авторы

Igor ‘Tsigankov’ Eyrich (@tsiganenok)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/autoscaling_lifecycle_hook_module.html