DATASOURCE::VOD::MessageCallbacks - Resource Orchestration Service

DATASOURCE::VOD::MessageCallbacks is used to query sets of event notification configurations.

Syntax

{
  "Type": "DATASOURCE::VOD::MessageCallbacks",
  "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

MessageCallbacks: the sets of event notification configurations.
AppIds: the application IDs.

Property	Type	Description	Constraint
AppIds	List	The application IDs.	None.
MessageCallbacks	List	The sets of event notification configurations.	None.
MnsQueueName	String	The name of the Simple Message Queue (formerly MNS) (SMQ) queue. This property is returned when the callback method is SMQ.	None.
EventTypeList	String	The callback event types.	None.
AuthKey	String	The authentication key. This property is returned when the callback method is HTTP.	None.
MnsEndpoint	String	The public endpoint of SMQ. This property is returned when the callback method is SMQ.	None.
AppId	String	The application ID.	None.
AuthSwitch	String	Indicates whether callback authentication is enabled. This property is returned when the callback method is HTTP.	None.
CallbackType	String	The callback method.	None.
CallbackUrl	String	The callback address. This property is returned when the callback method is HTTP.	None.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AppId:
    Type: String
    Description:
      en: The ID of the application.
    Required: false
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::VOD::MessageCallbacks
    Properties:
      AppId:
        Ref: AppId
Outputs:
  MessageCallbacks:
    Description: The list of message callbacks.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MessageCallbacks
  AppIds:
    Description: The list of app IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AppIds

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "AppId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the application."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VOD::MessageCallbacks",
      "Properties": {
        "AppId": {
          "Ref": "AppId"
        }
      }
    }
  },
  "Outputs": {
    "MessageCallbacks": {
      "Description": "The list of message callbacks.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MessageCallbacks"
        ]
      }
    },
    "AppIds": {
      "Description": "The list of app IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AppIds"
        ]
      }
    }
  }
}