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. |
dlqPolicy | @alicloud/ros-cdk-core.IResolvable | DlqPolicyProperty | Property dlqPolicy: Dead-letter queue policy. |
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: The maximum time to live (TTL) for a message in the queue. |
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. |
tags | TagsProperty[] | Property tags: Tags to attach to 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. |
queueNameRequired
public readonly queueName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property queueName: Queue name.
delaySecondsOptional
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
dlqPolicyOptional
public readonly dlqPolicy: IResolvable | DlqPolicyProperty;
- Type: @alicloud/ros-cdk-core.IResolvable | DlqPolicyProperty
Property dlqPolicy: Dead-letter queue policy.
loggingEnabledOptional
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
maximumMessageSizeOptional
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).
messageRetentionPeriodOptional
public readonly messageRetentionPeriod: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
Property messageRetentionPeriod: The maximum time to live (TTL) for a message in the queue.
After the specified period, the message is deleted, regardless of whether it has been retrieved. Valid values: 60 to 604800. Unit: seconds. Default value: 345600.
pollingWaitSecondsOptional
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)
tagsOptional
public readonly tags: TagsProperty[];
- Type: TagsProperty[]
Property tags: Tags to attach to Queue.
Max support 20 tags to add during create Queue. Each tag with two properties Key and Value, and Key is required.
visibilityTimeoutOptional
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)