ALIYUN::ARMS::AlertContact is used to create an alert contact.

Syntax

{
  "Type": "ALIYUN::ARMS::AlertContact",
  "Properties": {
    "DingRobotWebhookUrl": String,
    "PhoneNum": String,
    "RegionId": String,
    "SystemNoc": Boolean,
    "ProxyUserId": String,
    "ContactName": String,
    "Email": String
  }
}

Properties

Parameter Type Required Editable Description Constraint
DingRobotWebhookUrl String Not supported Supported DingTalk Webhook URL of the chatbot. DingTalk the custom keyword in robot security settings, enter "alarm".
Email String Not supported Supported Alert contact email None
PhoneNum String Not supported Supported Mobile phone number of the alarm contact You must specify at least one of the following three DingTalk: email address, mobile phone number, and Webhook URL of the contact information chatbot.
RegionId String No Released The region ID of the ApsaraDB for Redis instance. The default value is the region ID of the stack. Valid values:
  • cn-qingdao
  • cn-beijing
  • cn-shanghai
  • cn-hangzhou
  • cn-shenzhen
  • cn-hongkong
  • ap-southeast-1
SystemNoc Boolean Not supported Supported Receive System Notification None
ContactName String Yes Yes The name of the alert contact that you want to create. None

Return value

Fn::GetAtt

ContactId: The ID of the alarm contact.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "AlertContact": {
      "Type": "ALIYUN::ARMS::AlertContact",
      "Properties": {
        "ProxyUserId": {
          "Ref": "ProxyUserId"
        },
        "PhoneNum": {
          "Ref": "PhoneNum"
        },
        "RegionId": {
          "Ref": "RegionId"
        },
        "SystemNoc": {
          "Ref": "SystemNoc"
        },
        "DingRobotWebhookUrl": {
          "Ref": "DingRobotWebhookUrl"
        },
        "ContactName": {
          "Ref": "ContactName"
        },
        "Email": {
          "Ref": "Email"
        }
      }
    }
  },
  "Parameters": {
    "ProxyUserId": {
      "Type": "String",
      "Description": "Internal parameters"
    },
    "PhoneNum": {
      "Type": "String",
      "Description": "The phone number of the contact."
    },
    "RegionId": {
      "Type": "String",
      "Description": "Region ID. Default to region of stack.",
      "AllowedValues": [
        "cn-qingdao",
        "cn-beijing",
        "cn-shanghai",
        "cn-hangzhou",
        "cn-shenzhen",
        "cn-hongkong",
        "ap-southeast-1"
      ]
    },
    "SystemNoc": {
      "Type": "Boolean",
      "Description": "Specifies whether to receive system alerts.",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    },
    "DingRobotWebhookUrl": {
      "Type": "String",
      "Description": "The DingTalk Chatbot address of the contact."
    },
    "ContactName": {
      "Type": "String",
      "Description": "The name of the alert contact that you want to create."
    },
    "Email": {
      "Type": "String",
      "Description": "The email address of the contact."
    }
  },
  "Outputs": {
    "ContactId": {
      "Description": "The ID of the alert contact that you created.",
      "Value": {
        "Fn::GetAtt": [
          "AlertContact",
          "ContactId"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  AlertContact:
    Type: 'ALIYUN::ARMS::AlertContact'
    Properties:
      ProxyUserId:
        Ref: ProxyUserId
      PhoneNum:
        Ref: PhoneNum
      RegionId:
        Ref: RegionId
      SystemNoc:
        Ref: SystemNoc
      DingRobotWebhookUrl:
        Ref: DingRobotWebhookUrl
      ContactName:
        Ref: ContactName
      Email:
        Ref: Email
Parameters:
  ProxyUserId:
    Type: String
    Description: Internal parameters
  PhoneNum:
    Type: String
    Description: The phone number of the contact.
  RegionId:
    Type: String
    Description: Region ID. Default to region of stack.
    AllowedValues:
      -cn-qingdao
      -cn-beijing
      -cn-shanghai
      - cn-hangzhou
      -cn-shenzhen
      -cn-hongkong
      - ap-southeast-1
  SystemNoc:
    Type: Boolean
    Description: Specifies whether to receive system alerts.
    AllowedValues:
      - 'True'
      - 'true'
      - 'False'
      - 'false'
  DingRobotWebhookUrl:
    Type: String
    Description: The DingTalk Chatbot address of the contact.
  ContactName:
    Type: String
    Description: The name of the alert contact that you want to create.
  Email:
    Type: String
    Description: The email address of the contact.
Outputs:
  ContactId:
    Description: The ID of the alert contact that you created.
    Value:
      'Fn::GetAtt':
        -AlertContact
        -ContactId