This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

mns¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

class pulumi_alicloud.mns.AwaitableGetQueuesResult(id=None, name_prefix=None, names=None, output_file=None, queues=None)¶

class pulumi_alicloud.mns.AwaitableGetTopicSubscriptionsResult(id=None, name_prefix=None, names=None, output_file=None, subscriptions=None, topic_name=None)¶

class pulumi_alicloud.mns.AwaitableGetTopicsResult(id=None, name_prefix=None, names=None, output_file=None, topics=None)¶

class pulumi_alicloud.mns.GetQueuesResult(id=None, name_prefix=None, names=None, output_file=None, queues=None)¶

A collection of values returned by getQueues.

id = None¶: The provider-assigned unique ID for this managed resource.

names = None¶: A list of queue names.

queues = None¶: A list of queues. Each element contains the following attributes:

class pulumi_alicloud.mns.GetTopicSubscriptionsResult(id=None, name_prefix=None, names=None, output_file=None, subscriptions=None, topic_name=None)¶

A collection of values returned by getTopicSubscriptions.

id = None¶: The provider-assigned unique ID for this managed resource.

names = None¶: A list of subscription names.

subscriptions = None¶: A list of subscriptions. Each element contains the following attributes:

class pulumi_alicloud.mns.GetTopicsResult(id=None, name_prefix=None, names=None, output_file=None, topics=None)¶

A collection of values returned by getTopics.

id = None¶: The provider-assigned unique ID for this managed resource.

names = None¶: A list of topic names.

topics = None¶: A list of topics. Each element contains the following attributes:

class pulumi_alicloud.mns.Queue(resource_name, opts=None, delay_seconds=None, maximum_message_size=None, message_retention_period=None, name=None, polling_wait_seconds=None, visibility_timeout=None, __props__=None, __name__=None, __opts__=None)¶

Create a Queue resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[float] delay_seconds: This attribute defines the length of time, in seconds, after which every message sent to the queue is dequeued. Valid value range: 0-604800 seconds, i.e., 0 to 7 days. Default value to 0. :param pulumi.Input[float] maximum_message_size: This indicates the maximum length, in bytes, of any message body sent to the queue. Valid value range: 1024-65536, i.e., 1K to 64K. Default value to 65536. :param pulumi.Input[float] message_retention_period: Messages are deleted from the queue after a specified length of time, whether they have been activated or not. This attribute defines the viability period, in seconds, for every message in the queue. Valid value range: 60-604800 seconds, i.e., 1 minutes to 7 days. Default value to 345600. :param pulumi.Input[str] name: Two queues on a single account in the same region cannot have the same name. A queue name must start with an English letter or a digit, and can contain English letters, digits, and hyphens, with the length not exceeding 256 characters . :param pulumi.Input[float] polling_wait_seconds: Long polling is measured in seconds. When this attribute is set to 0, long polling is disabled. When it is not set to 0, long polling is enabled and message dequeue requests will be processed only when valid messages are received or when long polling times out. Valid value range: 0-30 seconds. Default value to 0. :param pulumi.Input[float] visibility_timeout: The VisibilityTimeout attribute of the queue. A dequeued messages will change from active (visible) status to inactive (invisible) status, and this attribute defines the length of time, in seconds, that messages remain invisible. Messages return to active status after the set period. Valid value range: 1-43200 seconds, i.e., 1 seconds to 12 hours. Default value to 30.

delay_seconds: pulumi.Output[float] = None¶: This attribute defines the length of time, in seconds, after which every message sent to the queue is dequeued. Valid value range: 0-604800 seconds, i.e., 0 to 7 days. Default value to 0.

maximum_message_size: pulumi.Output[float] = None¶: This indicates the maximum length, in bytes, of any message body sent to the queue. Valid value range: 1024-65536, i.e., 1K to 64K. Default value to 65536.

message_retention_period: pulumi.Output[float] = None¶: Messages are deleted from the queue after a specified length of time, whether they have been activated or not. This attribute defines the viability period, in seconds, for every message in the queue. Valid value range: 60-604800 seconds, i.e., 1 minutes to 7 days. Default value to 345600.

name: pulumi.Output[str] = None¶: Two queues on a single account in the same region cannot have the same name. A queue name must start with an English letter or a digit, and can contain English letters, digits, and hyphens, with the length not exceeding 256 characters .

polling_wait_seconds: pulumi.Output[float] = None¶: Long polling is measured in seconds. When this attribute is set to 0, long polling is disabled. When it is not set to 0, long polling is enabled and message dequeue requests will be processed only when valid messages are received or when long polling times out. Valid value range: 0-30 seconds. Default value to 0.

visibility_timeout: pulumi.Output[float] = None¶: The VisibilityTimeout attribute of the queue. A dequeued messages will change from active (visible) status to inactive (invisible) status, and this attribute defines the length of time, in seconds, that messages remain invisible. Messages return to active status after the set period. Valid value range: 1-43200 seconds, i.e., 1 seconds to 12 hours. Default value to 30.

static get(resource_name, id, opts=None, delay_seconds=None, maximum_message_size=None, message_retention_period=None, name=None, polling_wait_seconds=None, visibility_timeout=None)¶

Get an existing Queue resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
delay_seconds (pulumi.Input[float]) – This attribute defines the length of time, in seconds, after which every message sent to the queue is dequeued. Valid value range: 0-604800 seconds, i.e., 0 to 7 days. Default value to 0.
maximum_message_size (pulumi.Input[float]) – This indicates the maximum length, in bytes, of any message body sent to the queue. Valid value range: 1024-65536, i.e., 1K to 64K. Default value to 65536.
message_retention_period (pulumi.Input[float]) – Messages are deleted from the queue after a specified length of time, whether they have been activated or not. This attribute defines the viability period, in seconds, for every message in the queue. Valid value range: 60-604800 seconds, i.e., 1 minutes to 7 days. Default value to 345600.
name (pulumi.Input[str]) – Two queues on a single account in the same region cannot have the same name. A queue name must start with an English letter or a digit, and can contain English letters, digits, and hyphens, with the length not exceeding 256 characters .
polling_wait_seconds (pulumi.Input[float]) – Long polling is measured in seconds. When this attribute is set to 0, long polling is disabled. When it is not set to 0, long polling is enabled and message dequeue requests will be processed only when valid messages are received or when long polling times out. Valid value range: 0-30 seconds. Default value to 0.
visibility_timeout (pulumi.Input[float]) – The VisibilityTimeout attribute of the queue. A dequeued messages will change from active (visible) status to inactive (invisible) status, and this attribute defines the length of time, in seconds, that messages remain invisible. Messages return to active status after the set period. Valid value range: 1-43200 seconds, i.e., 1 seconds to 12 hours. Default value to 30.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.mns.Topic(resource_name, opts=None, logging_enabled=None, maximum_message_size=None, name=None, __props__=None, __name__=None, __opts__=None)¶

Create a Topic resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] logging_enabled: Is logging enabled? true or false. Default value to false. :param pulumi.Input[float] maximum_message_size: This indicates the maximum length, in bytes, of any message body sent to the topic. Valid value range: 1024-65536, i.e., 1K to 64K. Default value to 65536. :param pulumi.Input[str] name: Two topics on a single account in the same region cannot have the same name. A topic name must start with an English letter or a digit, and can contain English letters, digits, and hyphens, with the length not exceeding 256 characters.

logging_enabled: pulumi.Output[bool] = None¶: Is logging enabled? true or false. Default value to false.

maximum_message_size: pulumi.Output[float] = None¶: This indicates the maximum length, in bytes, of any message body sent to the topic. Valid value range: 1024-65536, i.e., 1K to 64K. Default value to 65536.

name: pulumi.Output[str] = None¶: Two topics on a single account in the same region cannot have the same name. A topic name must start with an English letter or a digit, and can contain English letters, digits, and hyphens, with the length not exceeding 256 characters.

static get(resource_name, id, opts=None, logging_enabled=None, maximum_message_size=None, name=None)¶

Get an existing Topic resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
logging_enabled (pulumi.Input[bool]) – Is logging enabled? true or false. Default value to false.
maximum_message_size (pulumi.Input[float]) – This indicates the maximum length, in bytes, of any message body sent to the topic. Valid value range: 1024-65536, i.e., 1K to 64K. Default value to 65536.
name (pulumi.Input[str]) – Two topics on a single account in the same region cannot have the same name. A topic name must start with an English letter or a digit, and can contain English letters, digits, and hyphens, with the length not exceeding 256 characters.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.mns.TopicSubscription(resource_name, opts=None, endpoint=None, filter_tag=None, name=None, notify_content_format=None, notify_strategy=None, topic_name=None, __props__=None, __name__=None, __opts__=None)¶

Create a TopicSubscription resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] endpoint: The endpoint has three format. Available values format:

- HTTP Format: http://xxx.com/xxx
- Queue Format: acs:mns:{REGION}:{AccountID}:queues/{QueueName}
- Email Format: mail:directmail:{MailAddress}

Parameters

filter_tag (pulumi.Input[str]) – The length should be shorter than 16.
name (pulumi.Input[str]) – Two topics subscription on a single account in the same topic cannot have the same name. A topic subscription name must start with an English letter or a digit, and can contain English letters, digits, and hyphens, with the length not exceeding 256 characters.
notify_content_format (pulumi.Input[str]) – The NotifyContentFormat attribute of Subscription. This attribute specifies the content format of the messages pushed to users. The valid values: ‘SIMPLIFIED’, ‘XML’ and ‘JSON’. Default to ‘SIMPLIFIED’.
notify_strategy (pulumi.Input[str]) – The NotifyStrategy attribute of Subscription. This attribute specifies the retry strategy when message sending fails. the attribute has two value EXPONENTIAL_DECAY_RETR or BACKOFF_RETRY. Default value to BACKOFF_RETRY .
topic_name (pulumi.Input[str]) – The topic which The subscription belongs to was named with the name.A topic name must start with an English letter or a digit, and can contain English letters, digits, and hyphens, with the length not exceeding 256 characters.

endpoint: pulumi.Output[str] = None¶

The endpoint has three format. Available values format:

HTTP Format: http://xxx.com/xxx
Queue Format: acs:mns:{REGION}:{AccountID}:queues/{QueueName}
Email Format: mail:directmail:{MailAddress}

filter_tag: pulumi.Output[str] = None¶: The length should be shorter than 16.

name: pulumi.Output[str] = None¶: Two topics subscription on a single account in the same topic cannot have the same name. A topic subscription name must start with an English letter or a digit, and can contain English letters, digits, and hyphens, with the length not exceeding 256 characters.

notify_content_format: pulumi.Output[str] = None¶: The NotifyContentFormat attribute of Subscription. This attribute specifies the content format of the messages pushed to users. The valid values: ‘SIMPLIFIED’, ‘XML’ and ‘JSON’. Default to ‘SIMPLIFIED’.

notify_strategy: pulumi.Output[str] = None¶: The NotifyStrategy attribute of Subscription. This attribute specifies the retry strategy when message sending fails. the attribute has two value EXPONENTIAL_DECAY_RETR or BACKOFF_RETRY. Default value to BACKOFF_RETRY .

topic_name: pulumi.Output[str] = None¶: The topic which The subscription belongs to was named with the name.A topic name must start with an English letter or a digit, and can contain English letters, digits, and hyphens, with the length not exceeding 256 characters.

static get(resource_name, id, opts=None, endpoint=None, filter_tag=None, name=None, notify_content_format=None, notify_strategy=None, topic_name=None)¶

Get an existing TopicSubscription resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
endpoint (pulumi.Input[str]) – The endpoint has three format. Available values format:

- HTTP Format: http://xxx.com/xxx
- Queue Format: acs:mns:{REGION}:{AccountID}:queues/{QueueName}
- Email Format: mail:directmail:{MailAddress}

Parameters

filter_tag (pulumi.Input[str]) – The length should be shorter than 16.
name (pulumi.Input[str]) – Two topics subscription on a single account in the same topic cannot have the same name. A topic subscription name must start with an English letter or a digit, and can contain English letters, digits, and hyphens, with the length not exceeding 256 characters.
notify_content_format (pulumi.Input[str]) – The NotifyContentFormat attribute of Subscription. This attribute specifies the content format of the messages pushed to users. The valid values: ‘SIMPLIFIED’, ‘XML’ and ‘JSON’. Default to ‘SIMPLIFIED’.
notify_strategy (pulumi.Input[str]) – The NotifyStrategy attribute of Subscription. This attribute specifies the retry strategy when message sending fails. the attribute has two value EXPONENTIAL_DECAY_RETR or BACKOFF_RETRY. Default value to BACKOFF_RETRY .
topic_name (pulumi.Input[str]) – The topic which The subscription belongs to was named with the name.A topic name must start with an English letter or a digit, and can contain English letters, digits, and hyphens, with the length not exceeding 256 characters.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_alicloud.mns.get_queues(name_prefix=None, output_file=None, opts=None)¶

This data source provides a list of MNS queues in an Alibaba Cloud account according to the specified parameters.

import pulumi
import pulumi_alicloud as alicloud

queues = alicloud.mns.get_queues(name_prefix="tf-")
pulumi.export("firstQueueId", queues.queues[0]["id"])

Parameters: name_prefix (str) – A string to filter resulting queues by their name prefixs.

pulumi_alicloud.mns.get_topic_subscriptions(name_prefix=None, output_file=None, topic_name=None, opts=None)¶

This data source provides a list of MNS topic subscriptions in an Alibaba Cloud account according to the specified parameters.

import pulumi
import pulumi_alicloud as alicloud

subscriptions = alicloud.mns.get_topic_subscriptions(name_prefix="tf-",
    topic_name="topic_name")
pulumi.export("firstTopicSubscriptionId", subscriptions.subscriptions[0]["id"])

Parameters

name_prefix (str) – A string to filter resulting subscriptions of the topic by their name prefixs.
topic_name (str) – Two topics on a single account in the same region cannot have the same name. A topic name must start with an English letter or a digit, and can contain English letters, digits, and hyphens, with the length not exceeding 256 characters.

pulumi_alicloud.mns.get_topics(name_prefix=None, output_file=None, opts=None)¶

This data source provides a list of MNS topics in an Alibaba Cloud account according to the specified parameters.

import pulumi
import pulumi_alicloud as alicloud

topics = alicloud.mns.get_topics(name_prefix="tf-")
pulumi.export("firstTopicId", topics.topics[0]["id"])

Parameters: name_prefix (str) – A string to filter resulting topics by their name prefixs.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

mns¶

On This Page