QueueProps

Properties for defining a Queue.

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

Initializer

import ros_cdk_amqp
ros_cdk_amqp.QueueProps(
  instance_id: typing.Union[str, IResolvable],
  queue_name: typing.Union[str, IResolvable],
  virtual_host: typing.Union[str, IResolvable],
  auto_delete_state: typing.Union[bool, IResolvable] = None,
  auto_expire_state: typing.Union[typing.Union[int, float], IResolvable] = None,
  dead_letter_exchange: typing.Union[str, IResolvable] = None,
  dead_letter_routing_key: typing.Union[str, IResolvable] = None,
  exclusive_state: typing.Union[bool, IResolvable] = None,
  maximum_priority: typing.Union[typing.Union[int, float], IResolvable] = None,
  max_length: typing.Union[typing.Union[int, float], IResolvable] = None,
  message_ttl: typing.Union[typing.Union[int, float], IResolvable] = None
)

Properties

instance_id^Required

instance_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceId: InstanceId.

queue_name^Required

queue_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property queueName: The name of the queue to create.

• The queue name can contain only letters, digits, hyphens (-), underscores (_), periods (.), number signs (#), forward slashes (/), and at signs (@). The name must be 1 to 255 characters in length.
• After a queue is created, its name cannot be changed. To change the name, delete the queue and create a new one.

virtual_host^Required

virtual_host: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property virtualHost: The name of the vhost to which the queue belongs.

The name can contain only letters, digits, hyphens (-), underscores (_), periods (.), number signs (#), forward slashes (/), and at signs (@). The name must be 1 to 255 characters in length.

auto_delete_state^Optional

auto_delete_state: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, 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.

auto_expire_state^Optional

auto_expire_state: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property autoExpireState: The auto-expiration time for the queue.

The queue is automatically deleted if it is not accessed within the specified time period. Unit: milliseconds.

This feature must be enabled before you can use this parameter. To enable the feature, .

dead_letter_exchange^Optional

dead_letter_exchange: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

dead_letter_routing_key^Optional

dead_letter_routing_key: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property deadLetterRoutingKey: The dead-letter routing key.

The key can contain only letters, digits, hyphens (-), underscores (_), periods (.), number signs (#), forward slashes (/), and at signs (@). The key must be 1 to 255 characters in length.

exclusive_state^Optional

exclusive_state: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

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

Valid values:

• true: The queue is an exclusive queue. An exclusive queue can be used only by the connection that declares it. The queue is automatically deleted after the connection is closed.
• false: The queue is not an exclusive queue.

maximum_priority^Optional

maximum_priority: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property maximumPriority: The priority of the queue.

The recommended value is an integer from 1 to 10.

This parameter is used for message priority. It is supported only by dedicated instances and can be used only after the message priority feature is enabled. To enable the feature, .

max_length^Optional

max_length: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property maxLength: This parameter is not supported in the current version.

The maximum number of messages that can be stored in the queue. If this limit is exceeded, the earliest messages in the queue are deleted.

message_ttl^Optional

message_ttl: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], 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