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],
  dlq_policy: typing.Union[IResolvable, DlqPolicyProperty] = None,
  filter_tag: typing.Union[str, IResolvable] = None,
  notify_content_format: typing.Union[str, IResolvable] = None,
  notify_strategy: typing.Union[str, IResolvable] = None,
  push_type: typing.Union[str, IResolvable] = None
)

Properties

endpoint^Required

endpoint: typing.Union[str, IResolvable]

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

Property endpoint: The message delivery endpoint.

The format varies based on the PushType value:

• If PushType is http: An HTTP/HTTPS callback URL, such as http:\/\/example.com\/callback or https:\/\/example.com\/callback.
• If PushType is queue: The ARN of the destination queue, in the format acs:mns:{RegionId}:{account ID}:queues\/{QueueName}.
• If PushType is dm: The endpoint for email push, in the fixed format smq-ep:dm:{account ID}:__dynamic. Replace {account ID} with your account ID.
• If PushType is dysms: The endpoint for SMS push, in the format smq-ep:dysms:{account ID}:{MobileNumber}.
• If PushType is kafka: The Kafka push endpoint.
• If PushType is fc: The endpoint for Function Compute, in the format acs:fc:{RegionId}:{account ID}:services\/{ServiceName}\/functions\/{FunctionName}.
• If PushType is eventbus: The endpoint for EventBridge, in the format acs:eventbridge:{RegionId}:{account ID}:eventbus\/{EventBusName}.

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.

dlq_policy^Optional

dlq_policy: typing.Union[IResolvable, DlqPolicyProperty]

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

Property dlqPolicy: Dead-letter queue policy.

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.

push_type^Optional

push_type: typing.Union[str, IResolvable]

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

Property pushType: Push type of the created subscription.