Spec-Zone.ru › Ansible 2.7

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

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

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

Обзор

  • Если заданный хук не найден, он будет создан.
  • Если хук найден, но предоставленные параметры отличаются, будет обновлён существующий хук.
  • Если состояние=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.

Псевдонимы: ec2_access_key, access_key
aws_secret_key
-
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.

Псевдонимы: ec2_secret_key, secret_key
default_result
-
    Варианты:
  • ABANDON ←
  • CONTINUE
Определяет действие, которое должна выполнить группа автоматического масштабирования, когда истечёт время ожидания хука жизненного цикла или произойдёт непредвиденная ошибка. Этот параметр может быть CONTINUE или ABANDON.
ec2_url
-
Адрес для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует адреса EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
heartbeat_timeout
-
По умолчанию:
"3600 (1 час)"
Время в секундах, которое может пройти, прежде чем истечёт время ожидания хука жизненного цикла. Когда истечёт время ожидания, группа автоматического масштабирования выполнит действие по умолчанию. Вы можете предотвратить истечение времени ожидания хука, вызвав RecordLifecycleActionHeartbeat.
lifecycle_hook_name
- / обязательно
Имя хука жизненного цикла.
notification_meta_data
-
Содержит дополнительную информацию, которую вы хотите включить всякий раз, когда Auto Scaling отправляет сообщение целевому объекту уведомлений.
notification_target_arn
-
ARN целевого объекта уведомления, который Auto Scaling будет использовать для уведомления вас, когда экземпляр находится в состоянии перехода для хука жизненного цикла. Этот объект может быть очередью SQS или темой SNS. Если вы укажете пустую строку, это переопределит текущий ARN.
profile
-
добавлено в 1.6
Использует профиль 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
Токен безопасности 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
boolean
добавлено в 1.5
    Варианты:
  • no
  • yes ←
Если установлено в "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), если учетные данные не предоставлены. См. 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. [сообщество]

Авторы

  • Игорь (Цыганков) Эйрих (@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.7/modules/ec2_asg_lifecycle_hook_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API