Модуль amazon.aws.cloudwatch_metric_alarm_info — Получение информации об алертах для указанного метрика

Примечание

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

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

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

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

Новая версия в amazon.aws 5.0.0

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

Обзор

Получает информацию об алертах для заданного метрика.

Требования

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

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

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_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` или `EC2_ACCESS_KEY` в порядке убывания приоритета. Опции aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
action_prefix строка	Этот параметр можно использовать для фильтрации результатов операции только для тех срабатываний тревоги, которые используют определенное действие тревоги.
alarm_name_prefix строка	Префикс имени срабатывания тревоги для получения информации о срабатываниях тревоги, имена которых начинаются с этого префикса. Не может использоваться с `alarm_names`.
alarm_names список / элементы=строка	Имя метрики.
alarm_type строка	Укажите это, чтобы получить метрики тревог или составные срабатывания тревоги. Модуль по умолчанию возвращает метрики тревог, но может возвращать составные срабатывания тревоги, если `alarm_type=CompositeAlarm`. Варианты: `"CompositeAlarm"` `"MetricAlarm"` ← (по умолчанию)
aws_ca_bundle путь	Расположение файла CA Bundle для проверки SSL-сертификатов. Также может использоваться переменная среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
children_of_alarm_name строка	Если указано, возвращает информацию о тревогах-«потомках» для указанного имени тревоги.
debug_botocore_endpoint_logs булево	Используйте `botocore.endpoint` логгер для анализа уникальных (а не общих) `"resource:action"` API-вызовов, сделанных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте `aws_resource_action` обратный вызов для вывода в общий список, созданный во время выполнения плейбука. Также может использоваться переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только против AWS. Также могут использоваться переменные среды `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
parents_of_alarm_name строка	Если указано, возвращает информацию о тревогах-«родителях» для указанного имени тревоги.
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 и security_token.
region псевдонимы: aws_region, ec2_region строка	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.

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 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 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_value string	Если указано, возвращает информацию только об оповещениях, которые в данный момент находятся в указанном состоянии. Варианты: `"OK"` `"ALARM"` `"INSUFFICIENT_DATA"`
validate_certs boolean	При установке в `false`, сертификаты SSL не будут проверяться для связи с API AWS. Настройка validate_certs=false крайне не рекомендуется. В качестве альтернативы, рассмотрите настройку aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: describe the metric alarm based on alarm names
  amazon.aws.cloudwatch_metric_alarm_info:
    alarm_names:
      - my-test-alarm-1
      - my-test-alarm-2

- name: describe the metric alarm based alarm names and state value
  amazon.aws.cloudwatch_metric_alarm_info:
    alarm_names:
      - my-test-alarm-1
      - my-test-alarm-2
    state_value: OK

- name: describe the metric alarm based alarm names prefix
  amazon.aws.cloudwatch_metric_alarm_info:
    alarm_name_prefix: my-test-

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

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

Ключ	Описание
metric_alarms list / elements=dictionary	Собранная информация о заданных метриках тревог. Возвращается: при успехе
actions_enabled boolean	Указывает, следует ли выполнять действия во время любых изменений состояния тревоги. Возвращается: всегда
alarm_actions list / elements=string	Действия, которые необходимо выполнить, когда это оповещение переходит в состояние ALARM из любого другого состояния. Возвращается: всегда
alarm_arn string	Уникальное имя для тревоги. Возвращается: всегда
alarm_configuration_updated_timestamp string	Метка времени последнего обновления конфигурации тревоги. Возвращается: всегда
alarm_description string	Описание тревоги. Возвращается: всегда
alarm_name string	Уникальное имя для тревоги. Возвращается: всегда
comparison_operator string	Арифметическая операция, используемая при сравнении указанной статистики и порога. Возвращается: всегда
datapoints_to_alarm integer	Количество точек данных, которые должны быть нарушены, чтобы вызвать тревогу. Возвращается: всегда
dimensions list / elements=dictionary	Размеры для метрики. Возвращается: всегда
name string	Название измерения. Возвращается: всегда
value string	Значение измерения. Возвращается: всегда
evaluate_low_sample_count_percentile string	Используется только для тревог, основанных на процентилях. Если ignore, состояние тревоги не изменяется в периоды с слишком малым количеством точек данных, чтобы быть статистически значимыми. Если evaluate или этот параметр не используется, тревога всегда оценивается и, возможно, изменяет состояние. Возвращается: всегда
evaluation_period integer	Количество периодов, за которые данные сравниваются с указанным порогом. Возвращается: всегда
extended_statistic string	Процентильная статистика для метрики, связанной с тревогой. Возвращается: всегда
insufficient_data_actions list / elements=string	Действия, которые необходимо выполнить, когда это оповещение переходит в состояние INSUFFICIENT_DATA из любого другого состояния. Возвращается: всегда
metric_name string	Название отслеживаемой метрики (например, `CPUUtilization`). Возвращается: всегда
metrics list / elements=dictionary	Массив структур MetricDataQuery, используемых в тревоге, основанной на выражении математической метрики. Возвращается: всегда
namespace string	Название соответствующего пространства имен (`AWS/EC2`, `System/Linux`, и т.д.). Определяет категорию, в которой он будет отображаться в CloudWatch. Возвращается: всегда

ok_actions список / элементы=строка	Действия, которые будут выполнены, когда этот сигнал переходит в состояние OK из любого другого состояния. Возвращаемое значение: всегда
period целое число	Длительность, в секундах, используемая каждый раз при оценке метрики, указанной в MetricName. Допустимые значения: 10, 30 и любые кратные 60. Возвращаемое значение: всегда
state_reason строка	Текстовое объяснение состояния сигнала. Возвращаемое значение: всегда
state_reason_data строка	Объяснение состояния сигнала в формате JSON. Возвращаемое значение: всегда
state_updated_timestamp строка	Отметка времени последнего обновления состояния сигнала. Возвращаемое значение: всегда
state_value строка	Значение состояния сигнала. Возвращаемое значение: всегда
statistic строка	Статистика метрики, связанной с сигналом, помимо процентиля. Возвращаемое значение: всегда
threshold вещественное число	Значение для сравнения со значением заданной статистики. Возвращаемое значение: всегда
threshold_metric_id строка	Это идентификатор функции ANOMALY_DETECTION_BAND, используемой в качестве порога для сигнала. Возвращаемое значение: всегда
treat_missing_data строка	Устанавливает, как сигнал должен обрабатывать отсутствующие данные. Возвращаемое значение: всегда
unit строка	Единица измерения при хранении метрики Возвращаемое значение: всегда

Авторы

Mandar Vijay Kulkarni (@mandar242)

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

© 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/cloudwatch_metric_alarm_info_module.html