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

Примечание

Этот плагин входит в коллекцию community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в книге задач укажите: community.aws.ec2_asg_lifecycle_hook.

Новое в версии 1.0.0: из community.aws

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

Описание

Создаст новую метку, когда state=present и метка не найдена.
Обновит существующую метку, когда state=present и метка найдена, но текущие и заданные параметры отличаются.
Удалит метку, когда state=absent и метка найдена.

Требования

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

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. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_access_key и profile устарело и будет исключено после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение файла CA Bundle для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: CA Bundle читается на стороне модуля и, возможно, требует явного копирования с контроллера, если он не выполняется локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Дополнительную информацию о конфигурации boto можно найти по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_secret_key и profile устарело и будет исключено после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs логический тип	Варианты: нет ← да	Используйте логирования botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
default_result строка	Варианты: ABANDON ← CONTINUE	Определяет действие, которое должна выполнить группа автоматического масштабирования, когда таймаут метки жизненного цикла истекает или происходит непредвиденная ошибка.
ec2_url строка		URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. псевдонимы: aws_endpoint_url, endpoint_url
heartbeat_timeout целое число		Время в секундах, которое может пройти, прежде чем метка жизненного цикла истечет. Когда метка жизненного цикла истекает, Auto Scaling выполняет действие по умолчанию. Вы можете предотвратить истечение таймаута метки жизненного цикла, вызвав RecordLifecycleActionHeartbeat. По умолчанию Amazon AWS использует 3600 (1 час).
lifecycle_hook_name строка / обязательно		Имя метки жизненного цикла.
notification_meta_data строка		Содержит дополнительную информацию, которую вы хотите включать всякий раз, когда Auto Scaling отправляет сообщение целевому объекту уведомления.
notification_target_arn строка		ARN целевого объекта уведомления, который Auto Scaling будет использовать для уведомления вас, когда экземпляр находится в состоянии перехода для метки жизненного цикла. Этот объект может быть либо очередью SQS, либо темой SNS. Если вы укажете пустую строку, это переопределит текущий ARN.
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределит aws_access_key, aws_secret_key и security_token, и поддержка их одновременного использования с profile устарела. aws_access_key, aws_secret_key и security_token будут взаимно исключающими с profile после 2022-06-01. псевдонимы: aws_profile
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 security token. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и будет исключено после 2022-06-01. псевдонимы: aws_security_token, access_token
state строка	Варианты: present ← absent	Создание или удаление метки жизненного цикла. При state=present обновляет существующую метку или создает новую, если она не найдена.
transition строка	Варианты: autoscaling:EC2_INSTANCE_TERMINATING autoscaling:EC2_INSTANCE_LAUNCHING	Состояние экземпляра, к которому вы хотите прикрепить метку жизненного цикла. Требуется, когда state=present.
validate_certs логический тип	Варианты: нет да ←	При установке в "нет", SSL-сертификаты не будут проверены для версий boto >= 2.6.0.

Примечания

Примечание

Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE.
Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto

Примеры

- name: Create / Update lifecycle hook
  community.aws.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

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

Авторы

Игорь ‘Тсиганков’ Эйрих (@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.10/collections/community/aws/ec2_asg_lifecycle_hook_module.html