Skip to content

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

Name Type Description
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: InstanceId.
queue_name typing.Union[str, ros_cdk_core.IResolvable] Property queueName: The name of the queue.
virtual_host typing.Union[str, ros_cdk_core.IResolvable] Property virtualHost: The name of the virtual host.
auto_delete_state typing.Union[bool, ros_cdk_core.IResolvable] Property autoDeleteState: Specifies whether the Auto Delete attribute is configured.
auto_expire_state typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property autoExpireState: The validity period after which the queue is automatically deleted.
dead_letter_exchange typing.Union[str, ros_cdk_core.IResolvable] Property deadLetterExchange: The dead-letter exchange.
dead_letter_routing_key typing.Union[str, ros_cdk_core.IResolvable] Property deadLetterRoutingKey: The dead letter routing key.
exclusive_state typing.Union[bool, ros_cdk_core.IResolvable] Property exclusiveState: Specifies whether the queue is an exclusive queue.
maximum_priority typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maximumPriority: The priority function is not supported.
max_length typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maxLength: The maximum number of messages that can be stored in the queue.
message_ttl 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.

instance_idRequired 

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

Property instanceId: InstanceId.

queue_nameRequired 

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

Property queueName: The name of the queue.

virtual_hostRequired 

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

Property virtualHost: The name of the virtual host.

auto_delete_stateOptional 

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_stateOptional 

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

dead_letter_exchangeOptional 

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_keyOptional 

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

Property deadLetterRoutingKey: The dead letter routing key.

exclusive_stateOptional 

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. 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.

maximum_priorityOptional 

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

Property maximumPriority: The priority function is not supported.

max_lengthOptional 

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

message_ttlOptional 

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