Subscription

• Implements: ISubscription

This class encapsulates and extends the ROS resource type ALIYUN::MNS::Subscription.

Initializers

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

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

endpoint^Required

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

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

subscription_name^Required

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

Property subscriptionName: Subscription name.

topic_name^Required

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

Property topicName: Topic name.

dlq_policy^Optional

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

Property dlqPolicy: Dead-letter queue policy.

filter_tag^Optional

• 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

• 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

• 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

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

Property pushType: Push type of the created subscription.

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_mns
ros_cdk_mns.Subscription.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_subscription_name^Required

attr_subscription_name: typing.Union[str, IResolvable]

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

Attribute SubscriptionName: Subscription name.

attr_subscription_url^Required

attr_subscription_url: typing.Union[str, IResolvable]

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

Attribute SubscriptionUrl: URL of created subscription.

attr_topic_name^Required

attr_topic_name: typing.Union[str, IResolvable]

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

Attribute TopicName: Topic name.

props^Required

props: SubscriptionProps

• Type: SubscriptionProps