ALIYUN::CMS::EventRule を使用してイベントアラートルールを作成または変更する - Resource Orchestration Service

ALIYUN::CMS::EventRule は、イベントをトリガーとするアラートルールの作成または変更に使用します。指定されたルール名が存在しない場合は、新しいイベントをトリガーとするアラートルールが作成されます。指定されたルール名が既に存在する場合は、該当するイベントをトリガーとするアラートルールが変更されます。

構文

{
  "Type": "ALIYUN::CMS::EventRule",
  "Properties": {
    "Description": String,
    "EventType": String,
    "EventPattern": List,
    "State": String,
    "SilenceTime": Integer,
    "RuleName": String,
    "GroupId": String
  }
}

プロパティ

プロパティ	型	必須	編集可能	説明	制約
EventPattern	List	はい	はい	イベントパターンのプロパティです。	イベントパターンのプロパティは最大 50 個まで指定できます。詳細については、「EventPattern のプロパティ」をご参照ください。
RuleName	String	はい	いいえ	アラートルールの名称です。	なし。
Description	String	いいえ	はい	アラートルールの説明です。	なし。
EventType	String	いいえ	はい	アラートルールのタイプです。	有効な値： SYSTEM CUSTOM
GroupId	String	いいえ	はい	アプリケーショングループの ID です。	なし。
SilenceTime	Integer	いいえ	いいえ	通知のサイレンスタイムです。	単位：秒。
State	String	いいえ	はい	アラートルールのステータスです。	有効な値： ENABLED DISABLED

EventPattern の構文

"EventPattern": [
  {
    "StatusList": List,
    "NameList": List,
    "Product": String,
    "EventTypeList": List,
    "LevelList": List,
    "KeywordFilter": Map,
    "SQLFilter": String,
    "CustomFilters": String
  }
]

EventPattern のプロパティ

プロパティ	型	必須	編集可能	説明	制約
EventTypeList	List	いいえ	はい	イベントタイプです。	アスタリスク (*) はすべてのタイプを表します。
LevelList	List	いいえ	はい	イベントのアラートレベルです。	有効な値： CRITICAL WARN INFO アスタリスク (*) はすべてのレベルを表します。
KeywordFilter	Map	いいえ	いいえ	キーワードフィルターです。	詳細については、「KeywordFilter のプロパティ」をご参照ください。
NameList	List	いいえ	はい	イベントの名称です。	なし。
Product	String	いいえ	はい	プロダクトタイプです。	なし。
StatusList	List	いいえ	はい	イベントのステータスです。	なし。
SQLFilter	String	いいえ	いいえ	指定された SQL ステートメントに基づいてログをフィルター処理するかどうかを指定します。	指定された条件が満たされた場合、アラートがトリガーされます。
CustomFilters	String	いいえ	いいえ	カスタムフィルター条件です。	なし。

KeywordFilter の構文

"KeywordFilter": 
  {
    "Keywords": List,
    "Relation": String
  }

KeywordFilter のプロパティ

プロパティ

型

必須

編集可能

説明

制約

Keywords

List

いいえ

イベントの内容と照合するキーワードのリストです。

なし。

Relation

String

いいえ

複数のキーワード間の論理関係です。

有効な値：

OR：イベントが指定されたキーワードのいずれかを含む場合に一致します。
NOT：イベントが指定されたキーワードのいずれも含まない場合に一致します。

戻り値

Fn::GetAtt

Data：アラートルールによって影響を受ける行数です。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Description: Test CMS EventRule
Parameters:
  RuleName:
    Type: String
    Default: mytest
  EventTypeList:
    Type: Json
    Default:
      - '*'
  LevelList:
    Type: Json
    Default:
      - WARN
Resources:
  EventRule:
    Type: ALIYUN::CMS::EventRule
    Properties:
      RuleName:
        Ref: RuleName
      EventPattern:
        - EventTypeList:
            Ref: EventTypeList
          LevelList:
            Ref: LevelList
          Product: ADS
Outputs:
  Data:
    Value:
      Fn::GetAtt:
        - EventRule
        - Data

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "Test CMS EventRule",
  "Parameters": {
    "RuleName": {
      "Type": "String",
      "Default": "mytest"
    },
    "EventTypeList": {
      "Type": "Json",
      "Default": [
        "*"
      ]
    },
    "LevelList": {
      "Type": "Json",
      "Default": [
        "WARN"
      ]
    }
  },
  "Resources": {
    "EventRule": {
      "Type": "ALIYUN::CMS::EventRule",
      "Properties": {
        "RuleName": {
          "Ref": "RuleName"
        },
        "EventPattern": [
          {
            "EventTypeList": {
              "Ref": "EventTypeList"
            },
            "LevelList": {
              "Ref": "LevelList"
            },
            "Product": "ADS"
          }
        ]
      }
    }
  },
  "Outputs": {
    "Data": {
      "Value": {
        "Fn::GetAtt": [
          "EventRule",
          "Data"
        ]
      }
    }
  }
}