Spec-Zone.ru › AWS CLI v2

[ aws . cloudwatch ]

put-composite-alarm

Описание

Создаёт или обновляет составной сигнал. При создании составного сигнала вы указываете выражение правила для сигнала, которое учитывает состояния сигналов других сигналов, которые вы создали. Составной сигнал переходит в состояние СИГНАЛ_ОШИБКИ только в том случае, если выполняются все условия правила.

Сигналы, указанные в выражении правила составного сигнала, могут включать сигналы метрики и другие составные сигналы. Выражение правила составного сигнала может включать до 100 подчинённых сигналов. Любой отдельный сигнал может быть включён в выражения правил до 150 составных сигналов.

Использование составных сигналов может уменьшить шум сигналов. Вы можете создать несколько сигналов метрики, а также создать составной сигнал и настроить оповещения только для составного сигнала. Например, вы можете создать составной сигнал, который переходит в состояние СИГНАЛ_ОШИБКИ только тогда, когда более одного из подчинённых сигналов метрики находятся в состоянии СИГНАЛ_ОШИБКИ.

Составные сигналы могут выполнять следующие действия:

  • Уведомлять темы Amazon SNS.
  • Вызывать функции Lambda.
  • Создавать OpsItems в Systems Manager Ops Center.
  • Создавать инциденты в Systems Manager Incident Manager.

Примечание

Возможно создание цикла или петли составных сигналов, где составной сигнал A зависит от составного сигнала B, а составной сигнал B также зависит от составного сигнала A. В этом сценарии вы не можете удалить какой-либо составной сигнал, который является частью цикла, потому что всегда есть составной сигнал, который зависит от этого сигнала, который вы хотите удалить.

Чтобы выйти из такой ситуации, необходимо разорвать цикл, изменив правило одного из составных сигналов в цикле, чтобы удалить зависимость, создающую цикл. Самое простое изменение, которое можно внести, чтобы разорвать цикл, — это изменить AlarmRule одного из сигналов на false.

Кроме того, оценка составных сигналов прекращается, если CloudWatch обнаруживает цикл в пути оценки.

Когда данная операция создаёт сигнал, состояние сигнала сразу устанавливается в INSUFFICIENT_DATA. Затем сигнал оценивается, и его состояние устанавливается соответствующим образом. После этого выполняются любые действия, связанные с новым состоянием. Для составного сигнала это начальное время после создания — единственный момент, когда сигнал может быть в состоянии INSUFFICIENT_DATA.

При обновлении существующего сигнала его состояние остаётся неизменным, но обновление полностью перезаписывает предыдущую конфигурацию сигнала.

Для использования этой операции вы должны быть авторизованы с разрешением cloudwatch:PutCompositeAlarm, которое ограничено *. Вы не можете создать составные сигналы, если ваше разрешение cloudwatch:PutCompositeAlarm имеет более узкий охват.

Если вы являетесь пользователем IAM, вам необходимо иметь iam:CreateServiceLinkedRole для создания составного сигнала с действиями Systems Manager OpsItem.

См. также: AWS API документацию

Синтаксис

  put-composite-alarm
[--actions-enabled | --no-actions-enabled]
[--alarm-actions <value>]
[--alarm-description <value>]
--alarm-name <value>
--alarm-rule <value>
[--insufficient-data-actions <value>]
[--ok-actions <value>]
[--tags <value>]
[--actions-suppressor <value>]
[--actions-suppressor-wait-period <value>]
[--actions-suppressor-extension-period <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--actions-enabled | --no-actions-enabled (boolean)

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

--alarm-actions (список)

Действия, которые нужно выполнить, когда эта тревога переходит в состояние ALARM из любого другого состояния. Каждое действие задается как Amazon Resource Name (ARN).

Допустимые значения:

Действия Amazon SNS:

``arn:aws:sns:region :account-id :sns-topic-name ``

Действия Lambda:

  • Вызов последней версии функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name ``
  • Вызов определенной версии функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name :version-number ``
  • Вызов функции с использованием псевдонима функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name :alias-name ``

Действия Systems Manager:

``arn:aws:ssm:region :account-id :opsitem:severity ``

Запуск оперативного расследования Amazon Q Developer

``arn:aws:aiops:region :account-id :investigation-group:investigation-group-id ``

(строка)

Синтаксис:

"string" "string" ...

--alarm-description (строка)

Описание составного уведомления.

--alarm-name (строка)

Имя составного уведомления. Это имя должно быть уникальным в данном регионе.

--alarm-rule (строка)

Выражение, указывающее, какие другие уведомления следует оценить для определения состояния этого составного уведомления. Для каждого уведомления, которое вы ссылаетесь, вы указываете функцию, которая определяет, должно ли это уведомление находиться в состоянии ТРЕВОГА, состояние НОРМА или состояние НЕДОСТАТОЧНЫЕ_ДАННЫЕ. Вы можете использовать операторы (И, ИЛИ и НЕ) для объединения нескольких функций в одном выражении. Вы можете использовать скобки для логического группирования функций в вашем выражении.

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

Функции могут включать следующие:

  • ALARM("*alarm-name* or *alarm-ARN* ") имеет значение ИСТИНА, если указанное уведомление находится в состоянии ТРЕВОГА.
  • OK("*alarm-name* or *alarm-ARN* ") имеет значение ИСТИНА, если указанное уведомление находится в состоянии НОРМА.
  • INSUFFICIENT_DATA("*alarm-name* or *alarm-ARN* ") имеет значение ИСТИНА, если указанное уведомление находится в состоянии НЕДОСТАТОЧНЫЕ_ДАННЫЕ.
  • TRUE всегда имеет значение ИСТИНА.
  • FALSE всегда имеет значение ЛОЖЬ.

ИСТИНА и ЛОЖЬ полезны для проверки сложной структуры AlarmRule и для проверки ваших действий по уведомлениям.

Имена уведомлений, указанные в AlarmRule, могут быть заключены в двойные кавычки («»), но не обязательно.

Вот несколько примеров AlarmRule :

  • ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh) указывает, что составное уведомление переходит в состояние ТРЕВОГА только в том случае, если оба уведомления CPUUtilizationTooHigh и DiskReadOpsTooHigh находятся в состоянии ТРЕВОГА.
  • ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress) указывает, что уведомление переходит в состояние ТРЕВОГА, если CPUUtilizationTooHigh находится в состоянии ТРЕВОГА, а DeploymentInProgress не находится в состоянии ТРЕВОГА. Этот пример уменьшает шум уведомлений во время известного периода развертывания.
  • (ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh) переходит в состояние ТРЕВОГА, если CPUUtilizationTooHigh ИЛИ DiskReadOpsTooHigh находятся в состоянии ТРЕВОГА, а NetworkOutTooHigh находится в состоянии НОРМА. Это еще один пример использования составного уведомления для предотвращения шума. Это правило гарантирует, что вы не получите уведомление по действию уведомления при высокой загрузке процессора или диска, если также происходит известная проблема с сетью.

AlarmRule может указать до 100 уведомлений-"потомков". Выражение AlarmRule может иметь до 500 элементов. Элементами являются уведомления-потомки, операторы ИСТИНА или ЛОЖЬ, и скобки.

--insufficient-data-actions (список)

Действия, которые нужно выполнить, когда эта тревога переходит в состояние INSUFFICIENT_DATA из любого другого состояния. Каждое действие задается как Amazon Resource Name (ARN).

Допустимые значения:

Действия Amazon SNS:

``arn:aws:sns:region :account-id :sns-topic-name ``

Действия Lambda:

  • Вызов последней версии функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name ``
  • Вызов определенной версии функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name :version-number ``
  • Вызов функции с использованием псевдонима функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name :alias-name ``

(строка)

Синтаксис:

"string" "string" ...

--ok-actions (список)

Действия, которые нужно выполнить, когда эта тревога переходит в состояние OK из любого другого состояния. Каждое действие задается как Amazon Resource Name (ARN).

Допустимые значения:

Действия Amazon SNS:

``arn:aws:sns:region :account-id :sns-topic-name ``

Действия Lambda:

  • Вызов последней версии функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name ``
  • Вызов определенной версии функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name :version-number ``
  • Вызов функции с использованием псевдонима функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name :alias-name ``

(строка)

Синтаксис:

"string" "string" ...

--tags (список)

Список пар ключ-значение для ассоциации с уведомлением. Вы можете ассоциировать до 50 тегов с уведомлением. Для возможности ассоциации тегов с уведомлением при создании уведомления, необходимо разрешение cloudwatch:TagResource.

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

Если вы используете эту операцию для обновления существующего уведомления, любые заданные вами теги в этом параметре игнорируются. Для изменения тегов существующего уведомления используйте TagResource или UntagResource.

(структура)

Пара ключ-значение, связанная с ресурсом CloudWatch.

Ключ -> (строка)

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

Значение -> (строка)

Значение для указанного ключа тега.

Сокращенный синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--actions-suppressor (строка)

Действия будут подавлены, если уведомление-подавитель находится в состоянии ALARM. ActionsSuppressor может быть именем уведомления или Amazon Resource Name (ARN) существующего уведомления.

--actions-suppressor-wait-period (целое число)

Максимальное время в секундах, которое составное уведомление ожидает, пока уведомление-подавитель перейдет в состояние ALARM. По истечении этого времени составное уведомление выполняет свои действия.

Предупреждение

WaitPeriod требуется только при указании ActionsSuppressor.

--actions-suppressor-extension-period (целое число)

Максимальное время в секундах, которое составное уведомление ожидает после того, как уведомление-подавитель выйдет из состояния ALARM. По истечении этого времени составное уведомление выполняет свои действия.

Предупреждение

ExtensionPeriod требуется только при указании ActionsSuppressor.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, заданному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения перепишут значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, выводит пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Общие параметры

--debug (boolean)

Включить отладку регистрации.

--endpoint-url (string)

Переопределить стандартный URL команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию, AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл с сертификатом CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка в формате base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и будет использовать содержимое файла напрямую независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Отключить вывод страниц CLI.

--cli-auto-prompt (boolean)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросить параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Более подробная информация представлена в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования, характерные для Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел "Использование кавычек со строками" в Руководстве пользователя AWS CLI.

Для создания составной сигнализации CloudWatch

В приведенном put-composite-alarm примере создается составная сигнализация с именем ProdAlarm в указанной учетной записи.

aws cloudwatch put-composite-alarm \
    --alarm-name ProdAlarm \
    --alarm-rule "ALARM(CPUUtilizationTooHigh) AND ALARM(MemUsageTooHigh)" \
    --alarm-actions arn:aws:sns:us-east-1:123456789012:demo \
    --actions-enabled

Эта команда не выводит никакого результата.

Дополнительная информация представлена в разделе "Создание составной сигнализации" в Руководстве пользователя Amazon CloudWatch.

Вывод

Нет

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

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