Модуль amazon.aws.route53_health_check — управление проверками работоспособности в DNS-службе Amazon Route 53

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.route53_health_check.

Добавлено в amazon.aws 5.0.0

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

Краткое описание

Создаёт и удаляет проверки работоспособности DNS в службе Amazon Route 53.
При обновлении существующих проверок работоспособности учитываются только port, resource_path, string_match и request_interval.
Этот модуль впервые добавлен в community.aws в выпуске 1.0.0.

Требования

Следующие требования должны быть выполнены на узле, на котором запускается этот модуль.

python >= 3.6
boto3 >= 1.35.0
botocore >= 1.35.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа 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` в порядке убывания приоритета. Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.
aws_ca_bundle путь	Путь к пакету сертификатов CA, используемому для проверки сертификатов SSL. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Описание параметров доступно в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
child_health_checks список / элементы=строка добавлено в amazon.aws 6.3.0	Дочерние проверки работоспособности, используемые для вычисляемой проверки работоспособности. В этом параметре указываются идентификаторы дочерних проверок работоспособности.
debug_botocore_endpoint_logs логический	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общих) вызовов API `"resource:action"`, выполненных во время задачи, и выводить их набор в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в ходе плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
disabled логический добавлено в community.aws 2.1.0	Отключает выполнение проверок работоспособности в Route 53. Подробную информацию о точных последствиях см. в документации AWS: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/health-checks-creating-values.html При создании новой проверки работоспособности значение по умолчанию — `true`. Варианты: `false` `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
failure_threshold целое число	Количество последовательных проверок работоспособности, которые конечная точка должна пройти или не пройти, чтобы Amazon Route 53 изменил её текущий статус с неработоспособного на работоспособный или наоборот. При создании по умолчанию используется `3`, если значение не указано. Варианты: `1` `2` `3` `4` `5` `6` `7` `8` `9` `10`
fqdn строка	Доменное имя проверяемой конечной точки. Необходимо указать этот параметр или `ip_address`. Если указаны оба параметра, `fqdn` используется в заголовке `Host:` HTTP-запроса.
health_check_id псевдонимы: id строка добавлено в community.aws 4.1.0	Идентификатор проверки работоспособности, которую нужно обновить или удалить. Если указан этот параметр, проверку работоспособности можно обновить или удалить, используя идентификатор в качестве уникального идентификатора.
health_check_name псевдонимы: name строка добавлено в community.aws 4.1.0	Имя проверки работоспособности. Используется вместе с `use_unique_names` для задания/использования `health_check_name` в качестве уникального идентификатора.
health_threshold целое число добавлено в amazon.aws 6.3.0	Минимальное количество исправных дочерних проверок работоспособности, необходимое для того, чтобы вычисляемая проверка работоспособности считалась исправной. По умолчанию: `1`
ip_address строка	IP-адрес проверяемой конечной точки. Необходимо указать этот параметр или `fqdn`. IP-адреса должны быть общедоступными и доступными для маршрутизации.
measure_latency логический добавлено в amazon.aws 5.4.0	Включает или отключает графики задержки для мониторинга задержки между средствами проверки работоспособности в нескольких регионах Amazon Web Services и вашей конечной точкой. Значение `measure_latency` неизменяемо и не может быть изменено после создания проверки работоспособности. См. https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/monitoring-health-check-latency.html Варианты: `false` `true`
port целое число	Порт конечной точки, на котором Amazon Route 53 будет выполнять проверки работоспособности. Обязателен для проверок TCP.
profile псевдонимы: aws_profile строка	Именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.
purge_tags логический	Если задано значение `purge_tags=true` и указан `tags`, существующие теги ресурса будут удалены, чтобы в точности соответствовать заданному параметру `tags`. Если параметр `tags` не задан, теги не будут изменены, даже если указано `purge_tags=True`. Ключи тегов, начинающиеся с `aws:`, зарезервированы Amazon и не могут быть изменены. Поэтому при обработке параметра `purge_tags` они будут игнорироваться. Дополнительную информацию см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Варианты: `false` `true` ← (по умолчанию)
region псевдонимы: aws_region строка	Регион AWS, который следует использовать. Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительную информацию см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
request_interval целое число	Количество секунд между получением Amazon Route 53 ответа от конечной точки и отправкой следующего запроса проверки работоспособности. Варианты: `10` `30` ← (по умолчанию)
resource_path строка	Путь, который Amazon Route 53 должен запрашивать при выполнении проверок работоспособности. Это может быть любое значение, для которого конечная точка в исправном состоянии возвращает код состояния HTTP 2xx или 3xx, например файл /docs/route53-health-check.html. Взаимоисключающий с `type='TCP'`. Путь должен начинаться с / Максимум 255 символов.
secret_key псевдонимы: aws_secret_access_key, aws_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` в порядке убывания приоритета. Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.
session_token псевдонимы: aws_session_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`. Параметры session_token и profile взаимоисключающие.
state строка	Задаёт выполняемое действие. Варианты: `"present"` ← (по умолчанию) `"absent"`
string_match строка	Если тип проверки — HTTP_STR_MATCH или HTTP_STR_MATCH, указывает строку, которую Amazon Route 53 должен искать в теле ответа указанного ресурса. Если строка найдена в первых 5120 байтах тела ответа, Amazon Route 53 считает ресурс работоспособным.
tags псевдонимы: resource_tags словарь	Словарь с тегами, которые нужно применить к ресурсу. Если параметр `tags` не задан, теги не будут изменены.
type строка	Тип создаваемой проверки работоспособности, определяющий, как Amazon Route 53 устанавливает, исправна ли конечная точка. После создания проверки работоспособности её тип нельзя изменить. Вариант `CALCULATED` добавлен в версии 6.3.0. Варианты: `"HTTP"` `"HTTPS"` `"HTTP_STR_MATCH"` `"HTTPS_STR_MATCH"` `"TCP"` `"CALCULATED"`
use_unique_names логический добавлено в community.aws 4.1.0	Используется вместе с `health_check_name` для задания/использования `health_check_name` в качестве уникального идентификатора. Варианты: `false` `true`
validate_certs логический	Если задано значение `false`, сертификаты SSL не будут проверяться при обмене данными с API AWS. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность задать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Create a health check for host1.example.com and use it in record
  amazon.aws.route53_health_check:
    state: present
    fqdn: host1.example.com
    type: HTTP_STR_MATCH
    resource_path: /
    string_match: "Hello"
    request_interval: 10
    failure_threshold: 2
  register: my_health_check

- amazon.aws.route53:
    action: create
    zone: "example.com"
    type: CNAME
    record: "www.example.com"
    value: host1.example.com
    ttl: 30
    # Routing policy
    identifier: "host1@www"
    weight: 100
    health_check: "{{ my_health_check.health_check.id }}"

- name: create a simple health check with health_check_name as unique identifier
  amazon.aws.route53_health_check:
    state: present
    health_check_name: ansible
    fqdn: ansible.com
    port: 443
    type: HTTPS
    use_unique_names: true

- name: create a TCP health check with latency graphs enabled
  amazon.aws.route53_health_check:
    state: present
    health_check_name: ansible
    fqdn: ansible.com
    port: 443
    type: HTTPS
    use_unique_names: true
    measure_latency: true

- name: Delete health check
  amazon.aws.route53_health_check:
    state: absent
    fqdn: host1.example.com

- name: Update Health check by ID - update ip_address
  amazon.aws.route53_health_check:
    id: 12345678-abcd-abcd-abcd-0fxxxxxxxxxx
    ip_address: 1.2.3.4

- name: Update Health check by ID - update port
  amazon.aws.route53_health_check:
    id: 12345678-abcd-abcd-abcd-0fxxxxxxxxxx
    ip_address: 8080

- name: Delete Health check by ID
  amazon.aws.route53_health_check:
    state: absent
    id: 12345678-abcd-abcd-abcd-0fxxxxxxxxxx

Возвращаемые значения

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

Ключ	Описание
health_check dictionary	Информация о проверке работоспособности. Возвращается: при успешном выполнении
action string	Действие, выполненное модулем. Возвращается: если изменение выполнено или должно быть выполнено. Пример: `"updated"`
health_check_config dictionary	Подробная информация о проверке работоспособности. Может содержать дополнительные значения, относящиеся к функциям проверок работоспособности Route 53, которые пока не поддерживаются этим модулем. Возвращается: если проверка работоспособности существует.
disabled boolean	Отключена ли проверка работоспособности. Возвращается: если проверка работоспособности существует. Пример: `false`
enable_sni boolean	Позволяет конечной точке отвечать на запросы HTTPS-проверки работоспособности с использованием соответствующего сертификата SSL/TLS. Возвращается: если проверка работоспособности существует. Пример: `false`
failure_threshold integer	Количество последовательных проверок работоспособности, которые конечная точка должна пройти или не пройти, чтобы Amazon Route 53 изменил её текущий статус с неработоспособного на работоспособный или наоборот. Возвращается: если проверка работоспособности существует. Пример: `3`
fully_qualified_domain_name string	Полное доменное имя (FQDN), настроенное для проверки работоспособности. Возвращается: если проверка работоспособности существует и настроено полное доменное имя (FQDN). Пример: `"updated"`
inverted boolean	Указывает, нужно ли инвертировать статус проверки работоспособности в Amazon Route 53. Возвращается: если проверка работоспособности существует. Пример: `false`
ip_address string	IPv4- или IPv6-адрес конечной точки, к которой будет отправлен запрос. Возвращается: если проверка работоспособности существует и настроен конкретный IP-адрес. Пример: `""`
measure_latency boolean	Включение или отключение графиков задержки для мониторинга задержки между проверяющими узлами в нескольких регионах Amazon Web Services и конечной точкой. Возвращается: если проверка работоспособности существует. Пример: `false`
port string	Порт конечной точки, к которому будет обращаться проверка работоспособности. Возвращается: если проверка работоспособности существует. Пример: `"updated"`
request_interval integer	Интервал в секундах между запросами проверки работоспособности. Возвращается: если проверка работоспособности существует. Пример: `30`
resource_path string	Путь URI, к которому обращаются при выполнении проверки работоспособности на основе HTTP/HTTPS. Возвращается: если проверка работоспособности существует и настроен путь к ресурсу. Пример: `"/healthz"`
search_string string	Строка, которая должна присутствовать в ответе, чтобы проверка работоспособности считалась успешной. Возвращается: если проверка работоспособности существует и настроена строка поиска. Пример: `"ALIVE"`
type string	Тип проверки работоспособности. Возвращается: если проверка работоспособности существует. Пример: `"HTTPS_STR_MATCH"`
health_check_version integer	Номер версии проверки работоспособности. Возвращается: если проверка работоспособности существует. Пример: `14`
id string	Уникальный идентификатор проверки работоспособности, присвоенный AWS. Возвращается: если проверка работоспособности существует. Пример: `"50ec8a13-9623-4c66-9834-dd8c5aedc9ba"`
tags dictionary	Словарь, содержащий теги проверки работоспособности. Возвращается: если проверка работоспособности существует. Пример: `{"my_key": "my_value"}`

Авторы

zimbatm (@zimbatm)

Ссылки на коллекцию

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