How to use the DATASOURCE::CMS::AlarmContacts data source to query information about alert contacts - Resource Orchestration Service

Syntax

{
  "Type": "DATASOURCE::CMS::AlarmContacts",
  "Properties": {
    "AlarmContactName": String,
    "RefreshOptions": String
  }
}

Properties

Property name

Type

Required

Update Allowed

Description

Constraints

AlarmContactName

String

No

Yes

The name of the alert contact.

None

RefreshOptions

String

No

Yes

The policy for refreshing the data source when the stack is updated.

Valid values:

Never (Default): Does not refresh the data source when the stack is updated.
Always: Always refreshes the data source when the stack is updated.

Return values

Fn::GetAtt

AlarmContactNames: A list of alert contact names.
AlarmContacts: A list of alert contact details.

Property Name	Type	Description	Constraints
AlarmContactNames	List	A list of alert contact names.	None
AlarmContacts	List	A list of alert contact details.	None
Lang	String	The language of the alert.	None
AlarmContactName	String	The name of the alert contact.	None
ChannelsStateDingWebHook	String	The status of the DingTalk chatbot is Normal.	None
ChannelsAliIm	String	The TradeManager account name used for alert notifications.	None
ChannelsMail	String	The email address used for alert notifications.	None
Describe	String	The description of the alert contact.	None
ChannelsSms	String	The mobile phone number used for alert notifications.	None
UpdateTime	String	The timestamp of the last update to the alert contact.	None
ContactGroups	List	A list of alert contact groups.	None
ChannelsStateMail	String	The status of the email channel.	None
ChannelsStateSms	String	The status of the text message channel.	None
ChannelsStateAliIm	String	The status of the TradeManager channel is Normal.	None
ChannelsDingWebHook	String	The status of the DingTalk chatbot channel is Normal.	None
CreateTime	String	The time when the alert contact was created.	Unit: milliseconds.

Examples

`YAML` format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AlarmContactName:
    Description: The name of the alert contact.
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      AlarmContactName:
        Ref: AlarmContactName
    Type: DATASOURCE::CMS::AlarmContacts
Outputs:
  AlarmContactNames:
    Description: The list of alarm contact names.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AlarmContactNames
  AlarmContacts:
    Description: The list of alarm contacts.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AlarmContacts

`JSON` format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "AlarmContactName": {
      "Type": "String",
      "Description": "The name of the alert contact."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::CMS::AlarmContacts",
      "Properties": {
        "AlarmContactName": {
          "Ref": "AlarmContactName"
        }
      }
    }
  },
  "Outputs": {
    "AlarmContactNames": {
      "Description": "The list of alarm contact names.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AlarmContactNames"
        ]
      }
    },
    "AlarmContacts": {
      "Description": "The list of alarm contacts.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AlarmContacts"
        ]
      }
    }
  }
}