metric-rule-template.yml

ROSTemplateFormatVersion: '2015-09-01'
Description:
  zh-cn: 创建CMS监控告警模板，支持多种服务类型与自定义指标，含告警等级设置与模板描述。
  en: Create CMS monitoring alarm templates, supporting various service types and
    custom metrics, including alarm level settings and template descriptions.
Parameters:
  MetricName:
    Type: String
    Description: The name of the metric. For more information, call DescribeMetricMetaList
      or see Preset metrics reference.
  Category:
    Type: String
    Description: |-
      The abbreviation of the service name. Valid values:
      ECS (including Alibaba Cloud and non-Alibaba Cloud hosts)
      RDS (ApsaraDB for RDS)
      ADS (AnalyticDB)
      SLB (Server Load Balancer)
      VPC (Virtual Private Cloud)
      APIGATEWAY (API Gateway)
      CDN
      CS (Container Service for Swarm)
      DCDN (Dynamic Route for CDN)
      DDoS (distributed denial of service)
      EIP (Elastic IP)
      ELASTICSEARCH (Elasticsearch)
      EMR (E-MapReduce)
      ESS (Auto Scaling)
      HBASE (ApsaraDB for HBase)
      IOT_EDGE (IoT Edge)
      K8S_POD (k8s pod)
      KVSTORE_SHARDING (ApsaraDB for Redis cluster version)
      KVSTORE_SPLITRW (ApsaraDB for Redis read/write splitting version)
      KVSTORE_STANDARD (ApsaraDB for Redis standard version)
      MEMCACHE (ApsaraDB for Memcache)
      MNS (Message Service)
      MONGODB (ApsaraDB for MongoDB replica set instances)
      MONGODB_CLUSTER (ApsaraDB for MongoDB cluster version)
      MONGODB_SHARDING (ApsaraDB for MongoDB sharded clusters)
      MQ_TOPIC (Message Service topic)
      OCS (original version of ApsaraDB for Memcache)
      OPENSEARCH (Open Search)
      OSS (Object Storage Service)
      POLARDB (ApsaraDB for POLARDB)
      PETADATA (HybridDB for MySQL)
      SCDN (Secure Content Delivery Network)
      SHAREBANDWIDTHPACKAGES (shared bandwidth package)
      SLS (Log Service)
      VPN (VPN Gateway)
  Namespace:
    Type: String
    Description: |-
      The data namespace of the service. For more information, call DescribeMetricMetaList
      or see Preset metrics reference.
  RuleName:
    Type: String
  Escalations:
    Type: Json
  Description:
    Type: String
    Description: The description of the alert template.
    Default: null
  RestVersion:
    Type: Number
    Description: |-
      The version of the alert template. Call DescribeMetricRuleTemplateList or DescribeMetricRuleTemplateAttribute
      to obtain information about the alert templates. The combination of version and ID
      uniquely identifies an alert template.
    Default: null
  TemplateId:
    Type: Number
    Description: The ID of the alert template.
    Default: null
  Name:
    Type: String
    Description: The name of the alert template.
    Default: test-alert-tpl
Resources:
  MetricRuleTemplate:
    Type: ALIYUN::CMS::MetricRuleTemplate
    Properties:
      AlertTemplates:
      - MetricName:
          Ref: MetricName
        Category:
          Ref: Category
        Namespace:
          Ref: Namespace
        RuleName:
          Ref: RuleName
        Escalations:
          Ref: Escalations
      Description:
        Ref: Description
      RestVersion:
        Ref: RestVersion
      TemplateId:
        Ref: TemplateId
      Name:
        Ref: Name
Outputs:
  Id:
    Description: Alarm template ID.
    Value:
      Fn::GetAtt:
      - MetricRuleTemplate
      - Id