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 для проверки SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: пакет CA считывается со стороны «модуля» и может потребоваться явно скопировать его с контроллера, если он не запускается локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ «user_agent». См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации 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, чтобы вывести полный список, созданный во время выполнения книги задач.
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. Если не задан, используется значение переменной среды 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/ec2_asg_lifecycle_hook_module.html