MessageCallback

• Implements: IMessageCallback

This class encapsulates and extends the ROS resource type ALIYUN::VOD::MessageCallback, which is used to configure the callback method, callback URL, and event types for event notifications.

Initializers

import ros_cdk_vod
ros_cdk_vod.MessageCallback(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

callback_type^Required

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

Property callbackType: Callback method.

app_id^Optional

• 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_key^Optional

• 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_switch^Optional

• 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_url^Optional

• 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_list^Optional

• 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_endpoint^Optional

• 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_name^Optional

• 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.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_vod
ros_cdk_vod.MessageCallback.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_app_id^Required

attr_app_id: typing.Union[str, IResolvable]

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

Attribute AppId: appid.

attr_auth_key^Required

attr_auth_key: typing.Union[str, IResolvable]

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

Attribute AuthKey: auth key.

attr_auth_switch^Required

attr_auth_switch: typing.Union[str, IResolvable]

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

Attribute AuthSwitch: auth swith.

attr_callback_type^Required

attr_callback_type: typing.Union[str, IResolvable]

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

Attribute CallbackType: callback type.

attr_callback_url^Required

attr_callback_url: typing.Union[str, IResolvable]

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

Attribute CallbackUrl: url.

attr_event_type_list^Required

attr_event_type_list: typing.Union[str, IResolvable]

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

Attribute EventTypeList: event type.

attr_mns_endpoint^Required

attr_mns_endpoint: typing.Union[str, IResolvable]

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

Attribute MnsEndpoint: mns endpoint.

attr_mns_queue_name^Required

attr_mns_queue_name: typing.Union[str, IResolvable]

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

Attribute MnsQueueName: queue name.

props^Required

props: MessageCallbackProps

• Type: MessageCallbackProps