ec2_asg_lifecycle_hook – Создание, удаление или обновление жизненных циклов AWS ASG

Новая версия 2.5.

Обзор
Требования
Параметры
Примечания
Примеры
Статус

Обзор

При отсутствии указанного хука, будет создан новый.
Если хук найден, но предоставленные параметры отличаются, будет обновлен существующий хук.
Если состояние = отсутствует и хук существует, он будет удален.

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

boto
boto3>=1.4.4
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
autoscaling_group_name - / обязательно		Имя группы автоматического масштабирования, к которой вы хотите назначить хук жизненного цикла.
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs логический добавлено в 2.8	Варианты: нет ← да	Использовать логгер botocore.endpoint для разбора уникальных (а не общих) API-вызовов «resource:action», сделанных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время выполнения плейбука. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
default_result -	Варианты: ОТКАЗ ← ПРОДОЛЖИТЬ	Определяет действие, которое должна выполнить группа автоматического масштабирования, когда истекает время ожидания хука жизненного цикла или возникает непредвиденная ошибка. Этот параметр может принимать значения ПРОДОЛЖИТЬ или ОТКАЗ.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не указан, используется значение переменной среды EC2_URL, если она существует.
heartbeat_timeout -	Значение по умолчанию: "3600 (1 час)"	Время в секундах, которое может пройти до истечения времени ожидания хука жизненного цикла. Когда время ожидания истекает, Auto Scaling выполняет действие по умолчанию. Вы можете предотвратить истечение времени ожидания хука жизненного цикла, вызвав RecordLifecycleActionHeartbeat.
lifecycle_hook_name - / обязательно		Имя хука жизненного цикла.
notification_meta_data -		Содержит дополнительную информацию, которую вы хотите включить всякий раз, когда Auto Scaling отправляет сообщение целевому объекту уведомления.
notification_target_arn -		ARN целевого объекта уведомления, который Auto Scaling будет использовать для уведомления вас, когда экземпляр находится в состоянии перехода для хука жизненного цикла. Этот целевой объект может быть либо очередью SQS, либо темой SNS. Если вы укажите пустую строку, это переопределяет текущий ARN.
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0.
region строка		AWS регион для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если она существует. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region Псевдонимы: aws_region, ec2_region
role_arn -		ARN роли IAM, которая позволяет группе автоматического масштабирования публиковать в указанный целевой объект уведомления.
security_token строка		Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
state -	Варианты: present ← absent	Создать или удалить хук жизненного цикла. Present обновляет существующий или создаёт, если он не найден.
transition - / обязательно	Варианты: autoscaling:EC2_INSTANCE_TERMINATING autoscaling:EC2_INSTANCE_LAUNCHING	Состояние экземпляра, к которому вы хотите прикрепить хук жизненного цикла.
validate_certs логический	Варианты: нет да ←	Если установлено значение «нет», сертификаты SSL для версий boto >= 2.6.0 не будут проверяться.

Примечания

Примечание

Если параметры не заданы в модуле, в порядке убывания приоритета могут использоваться следующие переменные среды AWS_URL или EC2_URL, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION
Ansible использует конфигурационный файл boto (как правило, ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания AWS региона, если он требуется, но это также может быть настроено в конфигурационном файле boto

Примеры

# Create / Update lifecycle hook
- ec2_asg_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

# Delete lifecycle hook
- ec2_asg_lifecycle_hook:
    region: eu-central-1
    state: absent
    autoscaling_group_name: example
    lifecycle_hook_name: example

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Данный модуль поддерживается сообществом Ansible. [community]

Авторы

Игорь ‘Тсиганков’ Эйрих (@tsiganenok) <tsiganenok@gmail.com>

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/ec2_asg_lifecycle_hook_module.html