SubscriptionProps

Properties for defining a Subscription.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-mns-subscription

Initializer

import { SubscriptionProps } from '@alicloud/ros-cdk-mns'
const subscriptionProps: SubscriptionProps = { ... }

Properties

Name	Type	Description
endpoint	string | @alicloud/ros-cdk-core.IResolvable	Property endpoint: Terminal address of the message recipient for the created subscription.
subscriptionName	string | @alicloud/ros-cdk-core.IResolvable	Property subscriptionName: Subscription name.
topicName	string | @alicloud/ros-cdk-core.IResolvable	Property topicName: Topic name.
filterTag	string | @alicloud/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.
notifyContentFormat	string | @alicloud/ros-cdk-core.IResolvable	Property notifyContentFormat: Format of the message content pushed to the endpoint.
notifyStrategy	string | @alicloud/ros-cdk-core.IResolvable	Property notifyStrategy: Retry policy that will be applied when an error occurs during message push to the endpoint.

---

endpoint^Required

public readonly endpoint: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property endpoint: Terminal address of the message recipient for the created subscription.

Currently, four types of endpoints are supported: 1. HttpEndpoint, which must be prefixed with "http:\/\/"; 2. QueueEndpoint, in the format of acs:mns:{REGION}:{AccountID}:queues\/{QueueName}; 3. MailEndpoint, in the format of mail:directmail:{MailAddress}; 4. SmsEndpoint, in the format of sms:directsms:anonymous or sms:directsms:{Phone}.

---

subscriptionName^Required

public readonly subscriptionName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property subscriptionName: Subscription name.

---

topicName^Required

public readonly topicName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property topicName: Topic name.

---

filterTag^Optional

public readonly filterTag: string | IResolvable;

• Type: string | @alicloud/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.

---

notifyContentFormat^Optional

public readonly notifyContentFormat: string | IResolvable;

• Type: string | @alicloud/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.

---

notifyStrategy^Optional

public readonly notifyStrategy: string | IResolvable;

• Type: string | @alicloud/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.

---