Module mns

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.

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.

Resources

Resource Queue

class Queue extends CustomResource

constructor

new Queue(name: string, args?: QueueArgs, opts?: pulumi.CustomResourceOptions)

Create a Queue resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: QueueState, opts?: pulumi.CustomResourceOptions): Queue

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Queue

Returns true if the given object is an instance of Queue. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property delaySeconds

public delaySeconds: pulumi.Output<number | undefined>;

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.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property maximumMessageSize

public maximumMessageSize: pulumi.Output<number | undefined>;

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.

property messageRetentionPeriod

public messageRetentionPeriod: pulumi.Output<number | undefined>;

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.

property name

public name: pulumi.Output<string>;

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 .

property pollingWaitSeconds

public pollingWaitSeconds: pulumi.Output<number | undefined>;

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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property visibilityTimeout

public visibilityTimeout: pulumi.Output<number | undefined>;

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.

Resource Topic

class Topic extends CustomResource

constructor

new Topic(name: string, args?: TopicArgs, opts?: pulumi.CustomResourceOptions)

Create a Topic resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TopicState, opts?: pulumi.CustomResourceOptions): Topic

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Topic

Returns true if the given object is an instance of Topic. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property loggingEnabled

public loggingEnabled: pulumi.Output<boolean | undefined>;

Is logging enabled? true or false. Default value to false.

property maximumMessageSize

public maximumMessageSize: pulumi.Output<number | undefined>;

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.

property name

public name: pulumi.Output<string>;

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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource TopicSubscription

class TopicSubscription extends CustomResource

constructor

new TopicSubscription(name: string, args: TopicSubscriptionArgs, opts?: pulumi.CustomResourceOptions)

Create a TopicSubscription resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TopicSubscriptionState, opts?: pulumi.CustomResourceOptions): TopicSubscription

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is TopicSubscription

Returns true if the given object is an instance of TopicSubscription. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property endpoint

public endpoint: pulumi.Output<string>;

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}

property filterTag

public filterTag: pulumi.Output<string | undefined>;

The length should be shorter than 16.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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.

property notifyContentFormat

public notifyContentFormat: pulumi.Output<string | undefined>;

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

property notifyStrategy

public notifyStrategy: pulumi.Output<string | undefined>;

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 .

property topicName

public topicName: pulumi.Output<string>;

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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getQueues

getQueues(args?: GetQueuesArgs, opts?: pulumi.InvokeOptions): Promise<GetQueuesResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const queues = pulumi.output(alicloud.mns.getQueues({
    namePrefix: "tf-",
}, { async: true }));

export const firstQueueId = queues.queues[0].id;

Function getTopics

getTopics(args?: GetTopicsArgs, opts?: pulumi.InvokeOptions): Promise<GetTopicsResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const topics = pulumi.output(alicloud.mns.getTopics({
    namePrefix: "tf-",
}, { async: true }));

export const firstTopicId = topics.topics[0].id;

Function getTopicSubscriptions

getTopicSubscriptions(args: GetTopicSubscriptionsArgs, opts?: pulumi.InvokeOptions): Promise<GetTopicSubscriptionsResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const subscriptions = pulumi.output(alicloud.mns.getTopicSubscriptions({
    namePrefix: "tf-",
    topicName: "topicName",
}, { async: true }));

export const firstTopicSubscriptionId = subscriptions.subscriptions[0].id;

Others

interface GetQueuesArgs

interface GetQueuesArgs

A collection of arguments for invoking getQueues.

property namePrefix

namePrefix?: undefined | string;

A string to filter resulting queues by their name prefixs.

property outputFile

outputFile?: undefined | string;

interface GetQueuesResult

interface GetQueuesResult

A collection of values returned by getQueues.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property namePrefix

namePrefix?: undefined | string;

property names

names: string[];

A list of queue names.

property outputFile

outputFile?: undefined | string;

property queues

queues: GetQueuesQueue[];

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

interface GetTopicsArgs

interface GetTopicsArgs

A collection of arguments for invoking getTopics.

property namePrefix

namePrefix?: undefined | string;

A string to filter resulting topics by their name prefixs.

property outputFile

outputFile?: undefined | string;

interface GetTopicsResult

interface GetTopicsResult

A collection of values returned by getTopics.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property namePrefix

namePrefix?: undefined | string;

property names

names: string[];

A list of topic names.

property outputFile

outputFile?: undefined | string;

property topics

topics: GetTopicsTopic[];

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

interface GetTopicSubscriptionsArgs

interface GetTopicSubscriptionsArgs

A collection of arguments for invoking getTopicSubscriptions.

property namePrefix

namePrefix?: undefined | string;

A string to filter resulting subscriptions of the topic by their name prefixs.

property outputFile

outputFile?: undefined | string;

property topicName

topicName: string;

interface GetTopicSubscriptionsResult

interface GetTopicSubscriptionsResult

A collection of values returned by getTopicSubscriptions.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property namePrefix

namePrefix?: undefined | string;

property names

names: string[];

A list of subscription names.

property outputFile

outputFile?: undefined | string;

property subscriptions

subscriptions: GetTopicSubscriptionsSubscription[];

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

property topicName

topicName: string;

interface QueueArgs

interface QueueArgs

The set of arguments for constructing a Queue resource.

property delaySeconds

delaySeconds?: pulumi.Input<number>;

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.

property maximumMessageSize

maximumMessageSize?: pulumi.Input<number>;

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.

property messageRetentionPeriod

messageRetentionPeriod?: pulumi.Input<number>;

property name

name?: pulumi.Input<string>;

property pollingWaitSeconds

pollingWaitSeconds?: pulumi.Input<number>;

property visibilityTimeout

visibilityTimeout?: pulumi.Input<number>;

interface QueueState

interface QueueState

Input properties used for looking up and filtering Queue resources.

property delaySeconds

delaySeconds?: pulumi.Input<number>;

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.

property maximumMessageSize

maximumMessageSize?: pulumi.Input<number>;

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.

property messageRetentionPeriod

messageRetentionPeriod?: pulumi.Input<number>;

property name

name?: pulumi.Input<string>;

property pollingWaitSeconds

pollingWaitSeconds?: pulumi.Input<number>;

property visibilityTimeout

visibilityTimeout?: pulumi.Input<number>;

interface TopicArgs

interface TopicArgs

The set of arguments for constructing a Topic resource.

property loggingEnabled

loggingEnabled?: pulumi.Input<boolean>;

Is logging enabled? true or false. Default value to false.

property maximumMessageSize

maximumMessageSize?: pulumi.Input<number>;

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.

property name

name?: pulumi.Input<string>;

interface TopicState

interface TopicState

Input properties used for looking up and filtering Topic resources.

property loggingEnabled

loggingEnabled?: pulumi.Input<boolean>;

Is logging enabled? true or false. Default value to false.

property maximumMessageSize

maximumMessageSize?: pulumi.Input<number>;

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.

property name

name?: pulumi.Input<string>;

interface TopicSubscriptionArgs

interface TopicSubscriptionArgs

The set of arguments for constructing a TopicSubscription resource.

property endpoint

endpoint: pulumi.Input<string>;

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}

property filterTag

filterTag?: pulumi.Input<string>;

The length should be shorter than 16.

property name

name?: pulumi.Input<string>;

property notifyContentFormat

notifyContentFormat?: pulumi.Input<string>;

property notifyStrategy

notifyStrategy?: pulumi.Input<string>;

property topicName

topicName: pulumi.Input<string>;

interface TopicSubscriptionState

interface TopicSubscriptionState

Input properties used for looking up and filtering TopicSubscription resources.

property endpoint

endpoint?: pulumi.Input<string>;

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}

property filterTag

filterTag?: pulumi.Input<string>;

The length should be shorter than 16.

property name

name?: pulumi.Input<string>;

property notifyContentFormat

notifyContentFormat?: pulumi.Input<string>;

property notifyStrategy

notifyStrategy?: pulumi.Input<string>;

property topicName

topicName?: pulumi.Input<string>;

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module mns

Resources

Functions

Others

Resources

Functions

Example Usage

Example Usage

Example Usage

Others