Skip to content

MessageCallbackProps

Properties for defining a MessageCallback.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-vod-messagecallback

Initializer

import ros_cdk_vod
ros_cdk_vod.MessageCallbackProps(
  callback_type: typing.Union[str, IResolvable],
  app_id: typing.Union[str, IResolvable] = None,
  auth_key: typing.Union[str, IResolvable] = None,
  auth_switch: typing.Union[str, IResolvable] = None,
  callback_url: typing.Union[str, IResolvable] = None,
  event_type_list: typing.Union[str, IResolvable] = None,
  mns_endpoint: typing.Union[str, IResolvable] = None,
  mns_queue_name: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
callback_type typing.Union[str, ros_cdk_core.IResolvable] Property callbackType: Callback method.
app_id typing.Union[str, ros_cdk_core.IResolvable] Property appId: App ID.
auth_key typing.Union[str, ros_cdk_core.IResolvable] Property authKey: Authentication Key, up to 32 characters, must contain both uppercase and lowercase letters and numbers.
auth_switch typing.Union[str, ros_cdk_core.IResolvable] Property authSwitch: The authentication switch of the HTTP callback, this parameter is valid when the callback method is set to HTTP.
callback_url typing.Union[str, ros_cdk_core.IResolvable] Property callbackUrl: Callback address.
event_type_list typing.Union[str, ros_cdk_core.IResolvable] Property eventTypeList: Callback event type.
mns_endpoint typing.Union[str, ros_cdk_core.IResolvable] Property mnsEndpoint: This parameter needs to be set when the callback method is MNS for the message queue public network endpoint.
mns_queue_name typing.Union[str, ros_cdk_core.IResolvable] Property mnsQueueName: The name of the message queue, which can be viewed in the queue list by logging in to the message service console.

callback_typeRequired

callback_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property callbackType: Callback method.


app_idOptional

app_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property appId: App ID.

If it is not passed, it is the ID of the default application of the system, with a fixed value: app-1000000.


auth_keyOptional

auth_key: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property authKey: Authentication Key, up to 32 characters, must contain both uppercase and lowercase letters and numbers.

This parameter can be set when the callback method is HTTP.


auth_switchOptional

auth_switch: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property authSwitch: The authentication switch of the HTTP callback, this parameter is valid when the callback method is set to HTTP.


callback_urlOptional

callback_url: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property callbackUrl: Callback address.

When the callback method is HTTP, this parameter needs to be set. The length of the callback address URL cannot exceed 256 bytes, and setting multiple callback addresses is not supported.


event_type_listOptional

event_type_list: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property eventTypeList: Callback event type.

When the value is empty, all message notifications are turned off, and when the value is ALL, all message notifications are turned on. You can also specify to enable certain message notifications, and use a comma (,) to separate multiple event types.


mns_endpointOptional

mns_endpoint: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property mnsEndpoint: This parameter needs to be set when the callback method is MNS for the message queue public network endpoint.

You can log in to the message service console and click the Get Endpoint button in the upper right corner to get it.


mns_queue_nameOptional

mns_queue_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property mnsQueueName: The name of the message queue, which can be viewed in the queue list by logging in to the message service console.

When the callback method is MNS, this parameter needs to be set.