Skip to content

Queue

This class encapsulates and extends the ROS resource type ALIYUN::MNS::Queue, which is used to create a queue to contain messages.

Queues can be classified into standard and delayed queues.

Initializers 

import ros_cdk_mns
ros_cdk_mns.Queue(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No 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.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

queue_nameRequired

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

Property queueName: Queue name.

delay_secondsOptional

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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)

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_mns
ros_cdk_mns.Queue.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_arn_with_slash ros_cdk_core.IResolvable Attribute ARN.WithSlash: The ARN: acs:mns:$region:$accountid:/queues/$queueName.
attr_queue_name ros_cdk_core.IResolvable Attribute QueueName: Queue name.
attr_queue_url ros_cdk_core.IResolvable Attribute QueueUrl: URL of created queue.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_arn_with_slashRequired 

attr_arn_with_slash: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ARN.WithSlash: The ARN: acs:mns:$region:$accountid:/queues/$queueName.

attr_queue_nameRequired 

attr_queue_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute QueueName: Queue name.

attr_queue_urlRequired 

attr_queue_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute QueueUrl: URL of created queue.