All Products
Search

This Product

    Resource Orchestration Service:ALIYUN::ARMS::AlertContactGroup

    Document Center

    Resource Orchestration Service:ALIYUN::ARMS::AlertContactGroup

    Last Updated:Jul 25, 2024

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

    Syntax

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

    Properties

    Property

    Type

    Required

    Editable

    Description

    Constraint

    ContactGroupName

    String

    Yes

    Yes

    The name of the alert contact group.

    None.

    ContactIds

    List

    Yes

    Yes

    The IDs of contacts within the alert contact group.

    Separate multiple contact IDs with spaces.

    RegionId

    String

    No

    No

    The region ID of the alert contact group. By default, the region ID of the stack is used.

    Valid values:

    • cn-qingdao

    • cn-beijing

    • cn-shanghai

    • cn-hangzhou

    • cn-shenzhen

    • cn-hongkong

    • ap-southeast-1

    Return values

    Fn::GetAtt

    ContactGroupId: the ID of the alert contact group.

    Examples

    YAML format

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ContactIds:
    Type: Json
    Description: 'The list of alert contact ID. '
Resources:
  AlertContactGroup:
    Type: ALIYUN::ARMS::AlertContactGroup
    Properties:
      ContactIds:
        Ref: ContactIds
      ContactGroupName: TestContactGroup
Outputs:
  ContactGroupId:
    Description: The ID of the alert contact group that you created.
    Value:
      Fn::GetAtt:
        - AlertContactGroup
        - ContactGroupId

    JSON format

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ContactIds": {
      "Type": "Json",
      "Description": "The list of alert contact ID. "
    }
  },
  "Resources": {
    "AlertContactGroup": {
      "Type": "ALIYUN::ARMS::AlertContactGroup",
      "Properties": {
        "ContactIds": {
          "Ref": "ContactIds"
        },
        "ContactGroupName": "TestContactGroup"
      }
    }
  },
  "Outputs": {
    "ContactGroupId": {
      "Description": "The ID of the alert contact group that you created.",
      "Value": {
        "Fn::GetAtt": [
          "AlertContactGroup",
          "ContactGroupId"
        ]
      }
    }
  }
}