QueueProps

Properties for defining a Queue.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-mns-queue

Initializer

import { QueueProps } from '@alicloud/ros-cdk-mns'
const queueProps: QueueProps = { ... }

Properties

Name	Type	Description
queueName	string | @alicloud/ros-cdk-core.IResolvable	Property queueName: Queue name.
delaySeconds	number | @alicloud/ros-cdk-core.IResolvable	Property delaySeconds: It is measured in seconds.
loggingEnabled	boolean | @alicloud/ros-cdk-core.IResolvable	Property loggingEnabled: Whether to enable log management.
maximumMessageSize	number | @alicloud/ros-cdk-core.IResolvable	Property maximumMessageSize: Maximum body length of a message sent to the queue, measured in bytes.
messageRetentionPeriod	number | @alicloud/ros-cdk-core.IResolvable	Property messageRetentionPeriod: Maximum lifetime of the message in the queue, measured in seconds.
pollingWaitSeconds	number | @alicloud/ros-cdk-core.IResolvable	Property pollingWaitSeconds: It is the maximum time that a ReceiveMessage request could be waiting for any incoming messages, while there are no message in the queue.
visibilityTimeout	number | @alicloud/ros-cdk-core.IResolvable	Property visibilityTimeout: Duration in which a message stays in Inactive status after it is consumed from the queue.

---

queueName^Required

public readonly queueName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property queueName: Queue name.

---

delaySeconds^Optional

public readonly delaySeconds: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property delaySeconds: It is measured in seconds.

All messages sent to the queue can be consumed until the DelaySeconds expires. An integer between 0 and 604800 (7 days). The default value is 0

---

loggingEnabled^Optional

public readonly loggingEnabled: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property loggingEnabled: Whether to enable log management.

"true" indicates that log management is enabled, whereas "false" indicates that log management is disabled. The default value is false

---

maximumMessageSize^Optional

public readonly maximumMessageSize: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property maximumMessageSize: Maximum body length of a message sent to the queue, measured in bytes.

An integer between 1024 (1K) and 65536 (64K). The default value is 65536 (64K).

---

messageRetentionPeriod^Optional

public readonly messageRetentionPeriod: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property messageRetentionPeriod: Maximum lifetime of the message in the queue, measured in seconds.

After the time specified by this parameter expires, the message will be deleted no matter whether it has been consumed or not. An integer between 60 (1 minute) and 1296000 (15 days). The default value is 345600 (4 days)

---

pollingWaitSeconds^Optional

public readonly pollingWaitSeconds: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property pollingWaitSeconds: It is the maximum time that a ReceiveMessage request could be waiting for any incoming messages, while there are no message in the queue.

Measured in seconds. An integer between 0 and 30 seconds. The default value is 0 (seconds)

---

visibilityTimeout^Optional

public readonly visibilityTimeout: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property visibilityTimeout: Duration in which a message stays in Inactive status after it is consumed from the queue.

Measured in seconds. An integer between 1 and 43200 (12 hours). The default value is 30 (seconds)

---