QueueProps

Properties for defining a Queue.

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

Initializer

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

Properties

Name	Type	Description
instanceId	string | @alicloud/ros-cdk-core.IResolvable	Property instanceId: InstanceId.
queueName	string | @alicloud/ros-cdk-core.IResolvable	Property queueName: The name of the queue.
virtualHost	string | @alicloud/ros-cdk-core.IResolvable	Property virtualHost: The name of the virtual host.
autoDeleteState	boolean | @alicloud/ros-cdk-core.IResolvable	Property autoDeleteState: Specifies whether the Auto Delete attribute is configured.
autoExpireState	number | @alicloud/ros-cdk-core.IResolvable	Property autoExpireState: The validity period after which the queue is automatically deleted.
deadLetterExchange	string | @alicloud/ros-cdk-core.IResolvable	Property deadLetterExchange: The dead-letter exchange.
deadLetterRoutingKey	string | @alicloud/ros-cdk-core.IResolvable	Property deadLetterRoutingKey: The dead letter routing key.
exclusiveState	boolean | @alicloud/ros-cdk-core.IResolvable	Property exclusiveState: Specifies whether the queue is an exclusive queue.
maximumPriority	number | @alicloud/ros-cdk-core.IResolvable	Property maximumPriority: The priority function is not supported.
maxLength	number | @alicloud/ros-cdk-core.IResolvable	Property maxLength: The maximum number of messages that can be stored in the queue.
messageTtl	number | @alicloud/ros-cdk-core.IResolvable	Property messageTtl: The message TTL of the queue If a message is retained in the Queue longer than the configured message lifetime, the message expires.

---

instanceId^Required

public readonly instanceId: string | IResolvable;

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

Property instanceId: InstanceId.

---

queueName^Required

public readonly queueName: string | IResolvable;

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

Property queueName: The name of the queue.

---

virtualHost^Required

public readonly virtualHost: string | IResolvable;

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

Property virtualHost: The name of the virtual host.

---

autoDeleteState^Optional

public readonly autoDeleteState: boolean | IResolvable;

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

Property autoDeleteState: Specifies whether the Auto Delete attribute is configured.

Valid values: true: The Auto Delete attribute is configured. The queue is automatically deleted after the last subscription from consumers to this queue is canceled. false: The Auto Delete attribute is not configured.

---

autoExpireState^Optional

public readonly autoExpireState: number | IResolvable;

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

Property autoExpireState: The validity period after which the queue is automatically deleted.

If the queue is not accessed within a specified period of time, it is automatically deleted.

---

deadLetterExchange^Optional

public readonly deadLetterExchange: string | IResolvable;

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

Property deadLetterExchange: The dead-letter exchange.

A dead-letter exchange is used to receive rejected messages. If a consumer rejects a message that cannot be retried, this message is routed to a specified dead-letter exchange. Then, the dead-letter exchange routes the message to the queue that is bound to the dead-letter exchange.

---

deadLetterRoutingKey^Optional

public readonly deadLetterRoutingKey: string | IResolvable;

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

Property deadLetterRoutingKey: The dead letter routing key.

---

exclusiveState^Optional

public readonly exclusiveState: boolean | IResolvable;

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

Property exclusiveState: Specifies whether the queue is an exclusive queue.

Valid values: true: The queue is an exclusive queue. It can be used only for the connection that declares the exclusive queue. After the connection is closed, the exclusive queue is automatically deleted. false: The Auto Delete attribute is not configured.

---

maximumPriority^Optional

public readonly maximumPriority: number | IResolvable;

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

Property maximumPriority: The priority function is not supported.

---

maxLength^Optional

public readonly maxLength: number | IResolvable;

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

Property maxLength: The maximum number of messages that can be stored in the queue.

If this threshold is exceeded, the earliest messages that are routed to the queue are discarded.

---

messageTtl^Optional

public readonly messageTtl: number | IResolvable;

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

Property messageTtl: The message TTL of the queue If a message is retained in the Queue longer than the configured message lifetime, the message expires.

The value of message lifetime must be a non-negative integer, up to 1 day. The unit is milliseconds

---