ALIYUN::VOD::MessageCallback - 资源编排

ALIYUN::VOD::MessageCallback类型用于设置事件通知的回调方式、回调地址、事件类型。

语法

{
  "Type": "ALIYUN::VOD::MessageCallback",
  "Properties": {
    "MnsEndpoint": String,
    "CallbackUrl": String,
    "AuthSwitch": String,
    "AppId": String,
    "CallbackType": String,
    "EventTypeList": String,
    "MnsQueueName": String,
    "AuthKey": String
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
MnsEndpoint	String	否	是	消息队列公网Endpoint。	回调方式为MNS时，需设置此参数。更多信息，请参见Endpoint。
CallbackUrl	String	否	是	回调地址。	回调方式为HTTP时，需设置此参数。回调地址URL的长度不能超过256个字节，不支持设置多个回调地址。
AuthSwitch	String	否	是	HTTP回调的鉴权开关。	回调方式设置为HTTP时，此参数有效。取值： on：启用HTTP回调的鉴权开关。 off：不启用HTTP回调的鉴权开关。
AppId	String	否	否	应用ID。	不传时为系统默认应用的ID，取固定值：`app-1000000`。
CallbackType	String	是	是	回调方式。	取值： HTTP MNS
EventTypeList	String	否	是	回调事件类型。	取值为空时关闭所有消息通知，取值为ALL时开启全部消息通知。也可指定开启某些消息通知，多个事件类型之间使用半角逗号（,）分隔。可设置的事件类型取值，请参见概述。说明所有AI相关事件即AIMediaAuditComplete、AIMediaDNAComplete等取值都为AIComplete。
MnsQueueName	String	否	是	消息队列名称。	回调方式为MNS时，需设置此参数。
AuthKey	String	否	是	鉴权Key。	最长32位，必须同时包含大小写字母和数字。回调方式为HTTP时，可设置此参数。

返回值

Fn::GetAtt

MnsEndpoint：消息队列公网Endpoint。
CallbackUrl：回调地址。
AuthSwitch：HTTP回调的鉴权开关。
AppId：应用ID。
CallbackType：回调方式。
EventTypeList：回调事件类型。
MnsQueueName：消息队列名称。
AuthKey：鉴权Key。

示例

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  ExtensionResource:
    Type: 'ALIYUN::VOD::MessageCallback'
    Properties:
      CallbackType:
        Ref: CallbackType
Parameters:
  CallbackType:
    Type: String
    Description:
      en: Callback method.
Outputs:
  MnsQueueName:
    Description: queue name.
    Value:
      'Fn::GetAtt':
        - ExtensionResource
        - MnsQueueName
  EventTypeList:
    Description: event type.
    Value:
      'Fn::GetAtt':
        - ExtensionResource
        - EventTypeList
  AuthKey:
    Description: auth key.
    Value:
      'Fn::GetAtt':
        - ExtensionResource
        - AuthKey
  MnsEndpoint:
    Description: mns endpoint.
    Value:
      'Fn::GetAtt':
        - ExtensionResource
        - MnsEndpoint
  AppId:
    Description: appid.
    Value:
      'Fn::GetAtt':
        - ExtensionResource
        - AppId
  AuthSwitch:
    Description: auth swith.
    Value:
      'Fn::GetAtt':
        - ExtensionResource
        - AuthSwitch
  CallbackType:
    Description: callback type.
    Value:
      'Fn::GetAtt':
        - ExtensionResource
        - CallbackType
  CallbackUrl:
    Description: url.
    Value:
      'Fn::GetAtt':
        - ExtensionResource
        - CallbackUrl

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::VOD::MessageCallback",
      "Properties": {
        "CallbackType": {
          "Ref": "CallbackType"
        }
      }
    }
  },
  "Parameters": {
    "CallbackType": {
      "Type": "String",
      "Description": {
        "en": "Callback method."
      }
    }
  },
  "Outputs": {
    "MnsQueueName": {
      "Description": "queue name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "MnsQueueName"
        ]
      }
    },
    "EventTypeList": {
      "Description": "event type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "EventTypeList"
        ]
      }
    },
    "AuthKey": {
      "Description": "auth key.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "AuthKey"
        ]
      }
    },
    "MnsEndpoint": {
      "Description": "mns endpoint.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "MnsEndpoint"
        ]
      }
    },
    "AppId": {
      "Description": "appid.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "AppId"
        ]
      }
    },
    "AuthSwitch": {
      "Description": "auth swith.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "AuthSwitch"
        ]
      }
    },
    "CallbackType": {
      "Description": "callback type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CallbackType"
        ]
      }
    },
    "CallbackUrl": {
      "Description": "url.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CallbackUrl"
        ]
      }
    }
  }
}