Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции community.aws (версия 8.0.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля потребуются дополнительные зависимости. Подробнее см. Требования.

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

Новая функция в community.aws 1.0.0

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

Описание

  • Создаст новую метку, если state=present и метка не найдена.
  • Обновит существующую метку, если state=present и метка найдена, но текущие и предоставленные параметры отличаются.
  • Удалит метку, если state=absent и метка найдена.
  • До версии 5.0.0 этот модуль назывался community.aws.ec2_asg_lifecycle_hook. Использование не изменилось.

Псевдонимы: ec2_asg_lifecycle_hook

Требования

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

  • python >= 3.6
  • boto3 >= 1.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

Идентификатор ключа доступа AWS.

См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Переменные среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY также могут использоваться в порядке убывания приоритета.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

autoscaling_group_name

string / required

Название группы автомасштабирования, к которой вы хотите назначить хук жизненного цикла.

aws_ca_bundle

path

Расположение пакета CA, используемого при проверке SSL-сертификатов.

Переменная среды AWS_CA_BUNDLE также может использоваться.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

boolean

Использовать botocore.endpoint регистратор для анализа уникальных (а не общих) "resource:action" вызовов API, сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте aws_resource_action обратный вызов для вывода в общий список, сделанный во время playbook.

Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может использоваться.

Варианты:

  • false ← (по умолчанию)
  • true

default_result

string

Определяет действие, которое группа автомасштабирования должна выполнить, когда истекает время ожидания хука жизненного цикла или происходит непредвиденная ошибка.

Варианты:

  • "ABANDON" ← (по умолчанию)
  • "CONTINUE"

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS.

Переменные среды AWS_URL или EC2_URL также могут использоваться в порядке убывания приоритета.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

heartbeat_timeout

integer

Время в секундах, которое может пройти до истечения времени ожидания хука жизненного цикла. Когда время ожидания хука жизненного цикла истекает, Auto Scaling выполняет действие по умолчанию. Вы можете предотвратить истечение времени ожидания хука жизненного цикла, вызвав RecordLifecycleActionHeartbeat.

По умолчанию Amazon AWS будет использовать 3600 (1 час).

lifecycle_hook_name

string / required

Название хука жизненного цикла.

notification_meta_data

string

Содержит дополнительную информацию, которую вы хотите включить каждый раз, когда Auto Scaling отправляет сообщение целевому объекту уведомлений.

notification_target_arn

string

ARN целевого объекта уведомлений, который Auto Scaling будет использовать для уведомления вас, когда экземпляр находится в состоянии перехода для хука жизненного цикла.

Этот целевой объект может быть либо очередью SQS, либо темой SNS.

Если вы указываете пустую строку, это переопределяет текущий ARN.

profile

aliases: aws_profile

string

Именованный профиль AWS для использования для аутентификации.

См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Переменная среды AWS_PROFILE также может использоваться.

Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token.

region

aliases: aws_region, ec2_region

string

Регион AWS для использования.

Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется.

Переменные среды AWS_REGION или EC2_REGION также могут использоваться.

См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

role_arn

string

ARN роли IAM, которая позволяет группе автомасштабирования публиковать сообщения в указанный целевой объект уведомлений.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

строка

Секретный ключ доступа AWS.

Дополнительную информацию о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут использоваться переменные среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, или EC2_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile взаимоисключающие.

Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore.

Псевдоним ec2_secret_key устарел и будет удалён в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

строка

Токен сеанса AWS STS для использования с временными учетными данными.

Дополнительную информацию о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут использоваться переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры security_token и profile взаимоисключающие.

Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, при этом параметр был переименован из security_token в session_token в релизе 6.0.0.

Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

state

строка

Создать или удалить Lifecycle Hook.

Когда state=present обновляет существующий хук или создаёт новый, если его нет.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

transition

строка

Состояние экземпляра, к которому вы хотите прикрепить хук жизненного цикла.

Требуется, когда state=present.

Варианты:

  • "autoscaling:EC2_INSTANCE_TERMINATING"
  • "autoscaling:EC2_INSTANCE_LAUNCHING"

validate_certs

булево

При установке в false, сертификаты SSL для связи с API AWS не будут проверены.

Установка validate_certs=false категорически не рекомендуется. В качестве альтернативы, рассмотрите возможность установки aws_ca_bundle вместо этого.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не из контекста «контроллер». Поэтому файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не из контекста «хост».
  • Используемый Ansible SDK AWS (boto3) также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно ~/.aws/credentials). Дополнительную информацию см. в https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

- name: Create / Update lifecycle hook
  community.aws.autoscaling_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.autoscaling_lifecycle_hook:
    region: eu-central-1
    state: absent
    autoscaling_group_name: example
    lifecycle_hook_name: example

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ

Описание

auto_scaling_group_name

строка

Уникальное имя группы автоматического масштабирования.

Возвращается: успех

Пример: "myasg"

default_result

строка

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

Возвращается: успех

Пример: "CONTINUE"

global_timeout

целое число

Максимальное время в секундах, которое экземпляр может находиться в состоянии Pending:Wait или Terminating:Wait.

Возвращается: успех

Пример: 172800

heartbeat_timeout

целое число

Максимальное время в секундах, которое может пройти, прежде чем хук жизненного цикла истечёт.

Возвращается: успех

Пример: 3600

lifecycle_hook_name

строка

Имя хука жизненного цикла.

Возвращается: успех

Пример: "mylifecyclehook"

lifecycle_transition

строка

Состояние экземпляра, к которому должен быть прикреплён хук жизненного цикла.

Возвращается: успех

Пример: "autoscaling:EC2_INSTANCE_LAUNCHING"

Авторы

  • Игорь ‘Tsigankov’ Эйрих (@tsiganenok)

Ссылки на сборку

  • Система отслеживания задач
  • Репозиторий (источники)
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/autoscaling_lifecycle_hook_module.html

Spec-Zone.ru

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