ALIYUN::VOD::MessageCallback リソースタイプ - ROS

ALIYUN::VOD::MessageCallback は、イベント通知のコールバックメソッド、コールバック URL、およびイベントタイプを構成するために使用されます。

構文

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

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
MnsEndpoint	String	いいえ	はい	メッセージサービス (MNS) キューのパブリックエンドポイント。	CallbackType が MNS に設定されている場合は、このプロパティを指定する必要があります。詳細については、「エンドポイント」をご参照ください。
CallbackUrl	String	いいえ	はい	コールバック URL。	CallbackType が HTTP に設定されている場合は、このプロパティを指定する必要があります。コールバック URL の長さは最大 256 バイトです。サポートされるコールバック URL は 1 つだけです。
AuthSwitch	String	いいえ	はい	HTTP コールバック認証のスイッチ。	このプロパティは、CallbackType が HTTP に設定されている場合に有効になります。有効な値： on：HTTP コールバック認証を有効にします。 off：HTTP コールバック認証を無効にします。
AppId	String	いいえ	いいえ	アプリケーション ID。	このプロパティを空のままにすると、デフォルトのアプリケーション ID `app-1000000` が使用されます。
CallbackType	String	はい	はい	コールバックメソッド。	有効な値： HTTP MNS
EventTypeList	String	いいえ	はい	コールバックイベントのタイプ。	このプロパティを null に設定すると、すべてのメッセージ通知が無効になります。このプロパティを ALL に設定すると、すべてのメッセージ通知が有効になります。特定のメッセージ通知を有効にする構成を指定することもできます。複数のイベントタイプはコンマ (,) で区切ります。指定できるイベントタイプの詳細については、「イベント通知」をご参照ください。説明 AIMediaAuditComplete や AIMediaDNAComplete などのすべての AI 関連イベントのタイプは AIComplete です。
MnsQueueName	String	いいえ	はい	MNS キューの名前。	CallbackType が MNS に設定されている場合は、このプロパティを指定する必要があります。
AuthKey	String	いいえ	はい	認証キー。	キーの長さは最大 32 文字で、大文字、小文字、および数字を含める必要があります。 CallbackType が HTTP に設定されている場合は、このプロパティを指定できます。

戻り値

Fn::GetAtt

MnsEndpoint：MNS キューのパブリックエンドポイント。
CallbackUrl：コールバック URL。
AuthSwitch：HTTP コールバック認証のスイッチ。
AppId：アプリケーション ID。
CallbackType：コールバックメソッド。
EventTypeList：コールバックイベントのタイプ。
MnsQueueName：MNS キューの名前。
AuthKey：認証キー。

例

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"
        ]
      }
    }
  }
}