Skip to content

QueueProps

Properties for defining a Queue.

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

Initializer 

import ros_cdk_mns
ros_cdk_mns.QueueProps(
  queue_name: typing.Union[str, IResolvable],
  delay_seconds: typing.Union[typing.Union[int, float], IResolvable] = None,
  logging_enabled: typing.Union[bool, IResolvable] = None,
  maximum_message_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  message_retention_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  polling_wait_seconds: typing.Union[typing.Union[int, float], IResolvable] = None,
  visibility_timeout: typing.Union[typing.Union[int, float], IResolvable] = None
)

Properties

Name Type Description
queue_name typing.Union[str, ros_cdk_core.IResolvable] Property queueName: Queue name.
delay_seconds typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property delaySeconds: It is measured in seconds.
logging_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property loggingEnabled: Whether to enable log management.
maximum_message_size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maximumMessageSize: Maximum body length of a message sent to the queue, measured in bytes.
message_retention_period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property messageRetentionPeriod: Maximum lifetime of the message in the queue, measured in seconds.
polling_wait_seconds typing.Union[typing.Union[int, float], 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.
visibility_timeout typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property visibilityTimeout: Duration in which a message stays in Inactive status after it is consumed from the queue.

queue_nameRequired 

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

Property queueName: Queue name.

delay_secondsOptional 

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

logging_enabledOptional 

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

maximum_message_sizeOptional 

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

message_retention_periodOptional 

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

polling_wait_secondsOptional 

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

visibility_timeoutOptional 

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