SubscriptionProps
Properties for defining a Subscription
.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-mns-subscription
Initializer
import ros_cdk_mns
ros_cdk_mns.SubscriptionProps(
endpoint: typing.Union[str, IResolvable],
subscription_name: typing.Union[str, IResolvable],
topic_name: typing.Union[str, IResolvable],
filter_tag: typing.Union[str, IResolvable] = None,
notify_content_format: typing.Union[str, IResolvable] = None,
notify_strategy: typing.Union[str, IResolvable] = None
)
Properties
Name | Type | Description |
---|---|---|
endpoint |
typing.Union[str, ros_cdk_core.IResolvable] |
Property endpoint: Terminal address of the message recipient for the created subscription. |
subscription_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property subscriptionName: Subscription name. |
topic_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property topicName: Topic name. |
filter_tag |
typing.Union[str, ros_cdk_core.IResolvable] |
Property filterTag: Message filter tag in the created subscription (Only messages with consistent tags are pushed.) The value is a string of no more than 16 characters. The default value is no message filter. |
notify_content_format |
typing.Union[str, ros_cdk_core.IResolvable] |
Property notifyContentFormat: Format of the message content pushed to the endpoint. |
notify_strategy |
typing.Union[str, ros_cdk_core.IResolvable] |
Property notifyStrategy: Retry policy that will be applied when an error occurs during message push to the endpoint. |
endpoint
Required
endpoint: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property endpoint: Terminal address of the message recipient for the created subscription.
Currently, four types of endpoints are supported:
- HttpEndpoint, which must be prefixed with "http://";
- QueueEndpoint, in the format of acs:mns:{REGION}:{AccountID}:queues/{QueueName};
- MailEndpoint, in the format of mail:directmail:{MailAddress};
- SmsEndpoint, in the format of sms:directsms:anonymous or sms:directsms:{Phone}.
subscription_name
Required
subscription_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property subscriptionName: Subscription name.
topic_name
Required
topic_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property topicName: Topic name.
filter_tag
Optional
filter_tag: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property filterTag: Message filter tag in the created subscription (Only messages with consistent tags are pushed.) The value is a string of no more than 16 characters. The default value is no message filter.
notify_content_format
Optional
notify_content_format: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property notifyContentFormat: Format of the message content pushed to the endpoint.
XML, JSON, or SIMPLIFIED; default value: XML. For details about message formats, refer to Basic Concepts/NotifyContentFormat.
notify_strategy
Optional
notify_strategy: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property notifyStrategy: Retry policy that will be applied when an error occurs during message push to the endpoint.
BACKOFF_RETRY or EXPONENTIAL_DECAY_RETRY; default value: BACKOFF_RETRY. For details about retry policies, refer to Basic Concepts/NotifyStrategy.