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

Примечание

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

Если вы используете пакет 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.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.
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.
child_health_checks list / elements=string добавлено в amazon.aws 6.3.0	Дочерние проверки работоспособности, используемые для рассчитанной проверки работоспособности. Этот параметр принимает идентификаторы дочерних проверок работоспособности.
debug_botocore_endpoint_logs boolean	Использовать `botocore.endpoint` регистратор для анализа уникальных (а не общих) `"resource:action"` вызовов API, выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте `aws_resource_action` обратный вызов для вывода в общий список, сделанный во время выполнения playbook. Переменная окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS` также может использоваться. Варианты: `false` ← (по умолчанию) `true`
disabled boolean добавлено в 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 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.
failure_threshold integer	Количество последовательных проверок работоспособности, которые конечная точка должна пройти или не пройти, чтобы Amazon Route 53 изменил текущий статус конечной точки с неработоспособной на работоспособную или наоборот. По умолчанию будет `3`, если не указано при создании. Варианты: `1` `2` `3` `4` `5` `6` `7` `8` `9` `10`
fqdn string	Доменное имя конечной точки для проверки. Необходимо указать либо этот параметр, либо `ip_address`. Если указаны оба, то `fqdn` используется в заголовке `Host:` HTTP-запроса.
health_check_id aliases: id string добавлено в community.aws 4.1.0	Идентификатор проверки работоспособности для обновления или удаления. Если указан, проверка работоспособности может быть обновлена или удалена на основе идентификатора как уникального идентификатора.
health_check_name aliases: name string добавлено в community.aws 4.1.0	Имя проверки работоспособности. Используется вместе с `use_unique_names` для установки/использования `health_check_name` в качестве уникального идентификатора.
health_threshold integer добавлено в amazon.aws 6.3.0	Минимальное количество исправных дочерних проверок работоспособности для того, чтобы рассчитанная проверка работоспособности считалась исправной. По умолчанию: `1`
ip_address string	IP-адрес конечной точки для проверки. Необходимо указать либо этот параметр, либо `fqdn`. IP-адреса должны быть публично маршрутизируемыми.

measure_latency boolean added in 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 integer	Порт конечного пункта, на котором Amazon Route 53 должен выполнять проверки состояния. Требуется для проверок TCP.
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.
purge_tags boolean	Если 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 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.
request_interval integer	Количество секунд между получением ответа от вашего конечного пункта Amazon Route 53 и отправкой следующего запроса проверки состояния. Варианты: `10` `30` ← (по умолчанию)
resource_path string	Путь, который Amazon Route 53 должен запросить при выполнении проверок состояния. Путь может быть любым значением, для которого ваш конечный пункт вернёт код состояния HTTP 2xx или 3xx при работоспособности конечного пункта, например, файл /docs/route53-health-check.html. Несовместимо с `type='TCP'`. Путь должен начинаться с / Максимальная длина 255 символов.
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	Секретный ключ доступа 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 botocore AWS. Псевдоним 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 string	Токен сессии 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 string	Определяет действие, которое нужно выполнить. Варианты: `"present"` ← (по умолчанию) `"absent"`
string_match string	Если тип проверки — HTTP_STR_MATCH или HTTP_STR_MATCH, строка, которую Amazon Route 53 должен искать в теле ответа со указанного ресурса. Если строка присутствует в первых 5120 байтах тела ответа, Amazon Route 53 считает ресурс работоспособным.

END_OF_DOCUMENT_MARKER

метки псевдонимы: resource_tags словарь	Словарь, представляющий метки, которые должны быть применены к ресурсу. Если параметр метки не задан, метки не будут изменены.
тип строка	Тип проверки работоспособности, который вы хотите создать, что указывает, как Amazon Route 53 определяет, является ли конечная точка работоспособной. После создания проверки работоспособности тип изменить нельзя. Выбор `CALCULATED` был добавлен в версии 6.3.0. Варианты: `"HTTP"` `"HTTPS"` `"HTTP_STR_MATCH"` `"HTTPS_STR_MATCH"` `"TCP"` `"CALCULATED"`
использовать_уникальные_имена логическое добавлено в community.aws 4.1.0	Используется вместе с `health_check_name`, чтобы установить/использовать `health_check_name` в качестве уникального идентификатора. Варианты: `false` `true`
проверять_сертификаты логическое	При установке в `false`, сертификаты SSL не будут проверяться для связи с API AWS. Установка проверять_сертификаты=false настоятельно не рекомендуется; вместо этого рассмотрите возможность установки aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Поддержка tags и purge_tags была добавлена в релизе 2.1.0.
Предупреждение: Для модулей переменные окружения и файлы конфигурации считываются из контекста Ansible «хост», а не из контекста «контроллер». В связи с этим файлы может потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются из контекста Ansible «контроллер», а не из контекста «хост».
AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из файлов конфигурации в контексте 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 словарь	Информация о проверке работоспособности. Возвращается: успешно
action строка	Выполненное модулем действие. Возвращается: При внесении или предстоящем изменении. Пример: `"updated"`
health_check_config словарь	Подробная информация о проверке работоспособности. Может содержать дополнительные значения, связанные с функциями проверок работоспособности Route 53, которые пока не поддерживаются данным модулем. Возвращается: При наличии проверки работоспособности.
disabled логическое значение	Указание на то, отключена ли проверка работоспособности. Возвращается: При наличии проверки работоспособности. Пример: `false`
enable_sni логическое значение	Это позволяет ответному узлу обрабатывать запросы проверки работоспособности HTTPS с соответствующим сертификатом SSL/TLS. Возвращается: При наличии проверки работоспособности. Пример: `false`
failure_threshold целое число	Количество последовательных проверок работоспособности, которые должен пройти или не пройти ответный узел для того, чтобы Amazon Route 53 изменил текущий статус узла с неисправного на исправный или наоборот. Возвращается: При наличии проверки работоспособности. Пример: `3`
fully_qualified_domain_name строка	FQDN, настроенный для проверки работоспособности. Возвращается: При наличии проверки работоспособности и настроенного FQDN. Пример: `"updated"`
inverted логическое значение	Указывает, нужно ли Amazon Route 53 инвертировать статус проверки работоспособности. Возвращается: При наличии проверки работоспособности. Пример: `false`
ip_address строка	IP-адрес IPv4 или IPv6 целевого узла для запроса. Возвращается: При наличии проверки работоспособности и настроенного IP-адреса. Пример: `""`
measure_latency логическое значение	Включает/отключает графики задержки для мониторинга задержки между проверяющими работоспособность в нескольких регионах Amazon Web Services и целевым узлом. Возвращается: При наличии проверки работоспособности. Пример: `false`
port строка	Порт на целевом узле, который будет запрашиваться проверкой работоспособности. Возвращается: При наличии проверки работоспособности. Пример: `"updated"`
request_interval целое число	Количество секунд между запросами проверки работоспособности. Возвращается: При наличии проверки работоспособности. Пример: `30`
resource_path строка	Путь URI для запроса при выполнении проверки работоспособности на основе HTTP/HTTPS. Возвращается: При наличии проверки работоспособности и настроенного пути к ресурсу. Пример: `"/healthz"`
search_string строка	Строка, которая должна присутствовать в ответе для успешной проверки работоспособности. Возвращается: При наличии проверки работоспособности и настроенной строки поиска. Пример: `"ALIVE"`
type строка	Тип проверки работоспособности. Возвращается: При наличии проверки работоспособности. Пример: `"HTTPS_STR_MATCH"`

health_check_version целое число	Номер версии проверки работоспособности. Возвращается: При существовании проверки работоспособности. Пример: `14`
id строка	Уникальный идентификатор, назначенный AWS для проверки работоспособности. Возвращается: При существовании проверки работоспособности. Пример: `"50ec8a13-9623-4c66-9834-dd8c5aedc9ba"`
tags словарь	Словарь, представляющий метки проверки работоспособности. Возвращается: При существовании проверки работоспособности. Пример: `{"my_key": "my_value"}`

Авторы

zimbatm (@zimbatm)

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

© 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/amazon/aws/route53_health_check_module.html