Модуль amazon.aws.cloudwatch_metric_alarm_info – сбор информации о тревогах для указанной метрики

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 botocore SDK.

action_prefix

строка

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

alarm_name_prefix

строка

Префикс имени тревоги. Позволяет получить сведения о тревогах, имена которых начинаются с этого префикса.

Нельзя использовать вместе с alarm_names.

alarm_names

список / элементы=строка

Имя метрики.

alarm_type

строка

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

По умолчанию модуль возвращает метрики тревог, но может возвращать составные тревоги, если alarm_type=CompositeAlarm.

Варианты:

• "CompositeAlarm"
• "MetricAlarm" ← (по умолчанию)

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.

children_of_alarm_name

строка

Если указано, возвращаются сведения о «дочерних» тревогах указанной тревоги.

debug_botocore_endpoint_logs

логическое значение

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

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

Варианты:

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

endpoint_url

псевдонимы: aws_endpoint_url

строка

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

Также можно использовать переменную среды AWS_URL.

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 и session_token.

region

псевдонимы: aws_region

строка

Регион AWS, который следует использовать.

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

Также можно использовать переменную среды AWS_REGION.

Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

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 botocore SDK.

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_value

строка

Если указано, возвращаются сведения только о тревогах, которые в данный момент находятся в указанном состоянии.

Варианты:

• "OK"
• "ALARM"
• "INSUFFICIENT_DATA"

validate_certs

логическое значение

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

Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого можно задать параметр aws_ca_bundle.

Варианты:

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

metric_alarms

list / elements=dictionary

Собранная информация об указанных сигналах метрик.

Возвращается: при успешном выполнении

actions_enabled

boolean

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

Возвращается: всегда

alarm_actions

list / elements=string

Действия, выполняемые при переходе этого сигнала в состояние ALARM из любого другого состояния.

Возвращается: всегда

alarm_arn

string

Имя ресурса Amazon (ARN) сигнала.

Возвращается: всегда

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

list / elements=string

Действия, выполняемые при переходе этого сигнала в состояние OK из любого другого состояния.

Возвращается: всегда

period

integer

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

Допустимые значения: 10, 30 и любое число, кратное 60.

Возвращается: всегда

state_reason

string

Текстовое объяснение состояния сигнала.

Возвращается: всегда

state_reason_data

string

Объяснение состояния сигнала в формате JSON.

Возвращается: всегда

state_updated_timestamp

string

Временная метка последнего обновления состояния сигнала.

Возвращается: всегда

state_value

string

Значение состояния сигнала.

Возвращается: всегда

statistic

string

Статистика для метрики, связанной с сигналом, кроме процентиля.

Возвращается: всегда

threshold

float

Значение для сравнения с указанной статистикой.

Возвращается: всегда

threshold_metric_id

string

Это идентификатор функции ANOMALY_DETECTION_BAND, используемой в качестве порогового значения для сигнала.

Возвращается: всегда

treat_missing_data

string

Задаёт способ обработки отсутствующих точек данных сигналом.

Возвращается: всегда

unit

string

Единица измерения, используемая при сохранении метрики

Возвращается: всегда