DATASOURCE::VOD::MessageCallback - Resource Orchestration Service

DATASOURCE::VOD::MessageCallback is used to query a set of event notification configurations.

Syntax

{
  "Type": "DATASOURCE::VOD::MessageCallback",
  "Properties": {
    "AppId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

AppId

String

Yes

The application ID.

None.

RefreshOptions

String

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

Never (default): does not refresh data source resources when the stack is updated.
Always: refreshes data source resources when the stack is updated.

Return values

Fn::GetAtt

MnsEndpoint: the public endpoint of Simple Message Queue (formerly MNS) (SMQ). This property is returned when the callback method is SMQ.
CallbackUrl: the callback address. This property is returned when the callback method is HTTP.
AuthSwitch: indicates whether callback authentication is enabled. This property is returned when the callback method is HTTP.
AppId: the application ID.
CallbackType: the callback method.
EventTypeList: the callback event types.
MnsQueueName: the name of the SMQ queue.
AuthKey: the authentication key.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AppId:
    Type: String
    Description:
      en: The ID of the application.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::VOD::MessageCallback
    Properties:
      AppId:
        Ref: AppId
Outputs:
  MnsEndpoint:
    Description: The public endpoint of MNS. This parameter is returned only for MNS callbacks.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MnsEndpoint
  CallbackUrl:
    Description: The callback URL. This parameter is returned only for HTTP callbacks.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CallbackUrl
  AuthSwitch:
    Description: 'Indicates whether callback authentication is enabled. This parameter is returned only for HTTP callbacks. '
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AuthSwitch
  AppId:
    Description: The ID of the application.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AppId
  CallbackType:
    Description: The callback method.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CallbackType
  EventTypeList:
    Description: The type of the callback event.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EventTypeList
  MnsQueueName:
    Description: The name of the Message Service (MNS) queue. This parameter is returned only for MNS callbacks.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MnsQueueName
  AuthKey:
    Description: The cryptographic key. This parameter is returned only for HTTP callbacks.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AuthKey

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "AppId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the application."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VOD::MessageCallback",
      "Properties": {
        "AppId": {
          "Ref": "AppId"
        }
      }
    }
  },
  "Outputs": {
    "MnsEndpoint": {
      "Description": "The public endpoint of MNS. This parameter is returned only for MNS callbacks.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MnsEndpoint"
        ]
      }
    },
    "CallbackUrl": {
      "Description": "The callback URL. This parameter is returned only for HTTP callbacks.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CallbackUrl"
        ]
      }
    },
    "AuthSwitch": {
      "Description": "Indicates whether callback authentication is enabled. This parameter is returned only for HTTP callbacks. ",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AuthSwitch"
        ]
      }
    },
    "AppId": {
      "Description": "The ID of the application.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AppId"
        ]
      }
    },
    "CallbackType": {
      "Description": "The callback method.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CallbackType"
        ]
      }
    },
    "EventTypeList": {
      "Description": "The type of the callback event.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EventTypeList"
        ]
      }
    },
    "MnsQueueName": {
      "Description": "The name of the Message Service (MNS) queue. This parameter is returned only for MNS callbacks.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MnsQueueName"
        ]
      }
    },
    "AuthKey": {
      "Description": "The cryptographic key. This parameter is returned only for HTTP callbacks.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AuthKey"
        ]
      }
    }
  }
}