MessageCallback

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 an event notification.

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
)

Name	Type	Description
`scope`	`ros_cdk_core.Construct`	No description.
`id`	`str`	No 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.
`enable_resource_property_constraint`	`bool`	No description.

`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

Name	Description
`to_string`	Returns a string representation of this construct.
`synthesize`	Allows this construct to emit artifacts into the cloud assembly during synthesis.
`add_condition`	No description.
`add_count`	No description.
`add_dependency`	No description.
`add_resource_desc`	No description.
`apply_removal_policy`	No description.
`get_att`	No description.
`set_metadata`	No description.

`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

`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

Name	Description
`is_construct`	Return whether the given object is a Construct.

`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

Name	Type	Description
`node`	`ros_cdk_core.ConstructNode`	The construct tree node associated with this construct.
`ref`	`str`	No description.
`stack`	`ros_cdk_core.Stack`	The stack in which this resource is defined.
`resource`	`ros_cdk_core.RosResource`	No description.
`attr_app_id`	`ros_cdk_core.IResolvable`	Attribute AppId: appid.
`attr_auth_key`	`ros_cdk_core.IResolvable`	Attribute AuthKey: auth key.
`attr_auth_switch`	`ros_cdk_core.IResolvable`	Attribute AuthSwitch: auth swith.
`attr_callback_type`	`ros_cdk_core.IResolvable`	Attribute CallbackType: callback type.
`attr_callback_url`	`ros_cdk_core.IResolvable`	Attribute CallbackUrl: url.
`attr_event_type_list`	`ros_cdk_core.IResolvable`	Attribute EventTypeList: event type.
`attr_mns_endpoint`	`ros_cdk_core.IResolvable`	Attribute MnsEndpoint: mns endpoint.
`attr_mns_queue_name`	`ros_cdk_core.IResolvable`	Attribute MnsQueueName: queue name.

`node`^Required

node: ConstructNode

Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

`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: IResolvable

Type: ros_cdk_core.IResolvable

Attribute AppId: appid.

`attr_auth_key`^Required

attr_auth_key: IResolvable

Type: ros_cdk_core.IResolvable

Attribute AuthKey: auth key.

`attr_auth_switch`^Required

attr_auth_switch: IResolvable

Type: ros_cdk_core.IResolvable

Attribute AuthSwitch: auth swith.

`attr_callback_type`^Required

attr_callback_type: IResolvable

Type: ros_cdk_core.IResolvable

Attribute CallbackType: callback type.

`attr_callback_url`^Required

attr_callback_url: IResolvable

Type: ros_cdk_core.IResolvable

Attribute CallbackUrl: url.

`attr_event_type_list`^Required

attr_event_type_list: IResolvable

Type: ros_cdk_core.IResolvable

Attribute EventTypeList: event type.

`attr_mns_endpoint`^Required

attr_mns_endpoint: IResolvable

Type: ros_cdk_core.IResolvable

Attribute MnsEndpoint: mns endpoint.

`attr_mns_queue_name`^Required

attr_mns_queue_name: IResolvable

Type: ros_cdk_core.IResolvable

Attribute MnsQueueName: queue name.

MessageCallback

Initializers

scopeRequired

idRequired

callback_typeRequired

app_idOptional

auth_keyOptional

auth_switchOptional

callback_urlOptional

event_type_listOptional

mns_endpointOptional

mns_queue_nameOptional

enable_resource_property_constraintOptional

Methods

to_string

synthesize

add_condition

add_count

add_dependency

add_resource_desc

apply_removal_policy

get_att

set_metadata