Class Queue

Inheritance

System.Object

Resource

CustomResource

Queue

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.AliCloud.Mns

Assembly: Pulumi.AliCloud.dll

Syntax

public class Queue : CustomResource

Constructors

Queue(String, QueueArgs, CustomResourceOptions)

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

Declaration

public Queue(string name, QueueArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
QueueArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

DelaySeconds

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.

Declaration

public Output<int?> DelaySeconds { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

MaximumMessageSize

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.

Declaration

public Output<int?> MaximumMessageSize { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

MessageRetentionPeriod

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.

Declaration

public Output<int?> MessageRetentionPeriod { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

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 .

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

PollingWaitSeconds

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.

Declaration

public Output<int?> PollingWaitSeconds { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

VisibilityTimeout

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.

Declaration

public Output<int?> VisibilityTimeout { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Methods

Get(String, Input<String>, QueueState, CustomResourceOptions)

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

Declaration

public static Queue Get(string name, Input<string> id, QueueState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
QueueState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Queue