ALIYUN::ARMS::AlertContactGroup is used to create an alert contact group.

Syntax

{
  "Type": "ALIYUN::ARMS::AlertContactGroup",
  "Properties": {
    "ContactIds": List,
    "ProxyUserId": String,
    "RegionId": String,
    "ContactGroupName": String
  }
}

Properties

Parameter Type Required Editable Description Constraint
ContactIds List Yes Yes The ID of the contact for the alert contact group. Separate multiple contact IDs with spaces. None
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
ContactGroupName String Yes Yes The name of the alert contact group that you want to create. None

Return value

Fn::GetAtt

ContactGroupId: The ID of the alarm contact group.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "AlertContactGroup": {
      "Type": "ALIYUN::ARMS::AlertContactGroup",
      "Properties": {
        "ContactIds": {
          "Ref": "ContactIds"
        },
        "ProxyUserId": {
          "Ref": "ProxyUserId"
        },
        "RegionId": {
          "Ref": "RegionId"
        },
        "ContactGroupName": {
          "Ref": "ContactGroupName"
        }
      }
    }
  },
  "Parameters": {
    "ContactIds": {
      "Type": "Json",
      "Description": "The list of alert contact ID. "
    },
    "ProxyUserId": {
      "Type": "String",
      "Description": "Internal parameters"
    },
    "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"
      ]
    },
    "ContactGroupName": {
      "Type": "String",
      "Description": "The name of the alert contact group that you want to create."
    }
  },
  "Outputs": {
    "ContactGroupId": {
      "Description": "The ID of the alert contact group that you created.",
      "Value": {
        "Fn::GetAtt": [
          "AlertContactGroup",
          "ContactGroupId"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  AlertContactGroup:
    Type: 'ALIYUN::ARMS::AlertContactGroup'
    Properties:
      ContactIds:
        Ref: ContactIds
      ProxyUserId:
        Ref: ProxyUserId
      RegionId:
        Ref: RegionId
      ContactGroupName:
        Ref: ContactGroupName
Parameters:
  ContactIds:
    Type: Json
    Description: 'The list of alert contact ID. '
  ProxyUserId:
    Type: String
    Description: Internal parameters
  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
  ContactGroupName:
    Type: String
    Description: The name of the alert contact group that you want to create.
Outputs:
  ContactGroupId:
    Description: The ID of the alert contact group that you created.
    Value:
      'Fn::GetAtt':
        -AlertContactGroup
        -ContactGroupId