ec2_asg_lifecycle_hook - Создание, удаление или обновление жизненных циклов AWS ASG.
Новая версия 2.5.
Описание
- При отсутствии указанного хука, создаст новый.
- Если хук найден, но предоставленные параметры отличаются, обновит существующий хук.
- Если состояние=absent и хук существует, удалит его.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- boto
- boto3>=1.4.4
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| autoscaling_group_name обязательно | Имя группы автоматического масштабирования, к которой нужно назначить хук жизненного цикла. | |
| aws_access_key | Значение по умолчанию: None | Ключ доступа AWS. Если не указан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key |
| aws_secret_key | Значение по умолчанию: None | Секретный ключ AWS. Если не указан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key |
| default_result |
| Определяет действие группы автоматического масштабирования при истечении времени ожидания хука жизненного цикла или при возникновении непредвиденной ошибки. Этот параметр может быть CONTINUE или ABANDON. |
| ec2_url | Значение по умолчанию: None | 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 (добавлено в 1.6) | Значение по умолчанию: None | Использует профиль 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 (добавлено в 1.6) | Значение по умолчанию: None | Токен безопасности AWS STS. Если не указан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token |
| state |
| Создание или удаление хука жизненного цикла. Present обновляет существующий хук или создаёт его, если он не найден. |
| transition обязательно |
| Состояние экземпляра, к которому вы хотите прикрепить хук жизненного цикла. |
| validate_certs (добавлено в 1.5) |
| При установке в «no», сертификаты 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/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
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- Игорь (Циганков) Эйрих (@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.5/modules/ec2_asg_lifecycle_hook_module.html