Queue

• Implements: IQueue

This class encapsulates and extends the ROS resource type ALIYUN::MNS::Queue.

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,
  dlq_policy: typing.Union[IResolvable, DlqPolicyProperty] = 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,
  tags: typing.List[TagsProperty] = None,
  visibility_timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

queue_name^Required

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

Property queueName: Queue name.

delay_seconds^Optional

• 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

dlq_policy^Optional

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

Property dlqPolicy: Dead-letter queue policy.

logging_enabled^Optional

• 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_size^Optional

• 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_period^Optional

• 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_seconds^Optional

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

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags to attach to Queue.

Max support 20 tags to add during create Queue. Each tag with two properties Key and Value, and Key is required.

visibility_timeout^Optional

• 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_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

from_queue_arn

import ros_cdk_mns
ros_cdk_mns.Queue.from_queue_arn(
  scope: Construct,
  id: str,
  attr_arn_with_slash: str
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

attr_arn_with_slash^Required

• Type: str

from_queue_attributes

import ros_cdk_mns
ros_cdk_mns.Queue.from_queue_attributes(
  scope: Construct,
  id: str,
  attr_arn_with_slash: typing.Union[str, IResolvable],
  attr_queue_name: typing.Union[str, IResolvable] = None,
  attr_queue_url: typing.Union[str, IResolvable] = None
)

Import an existing queue.

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

attr_arn_with_slash^Required

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

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

attr_queue_name^Optional

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

Attribute QueueName: Queue name.

attr_queue_url^Optional

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

Attribute QueueUrl: URL of created queue.

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_arn_with_slash^Required

attr_arn_with_slash: typing.Union[str, IResolvable]

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

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

attr_queue_name^Required

attr_queue_name: typing.Union[str, IResolvable]

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

Attribute QueueName: Queue name.

attr_queue_url^Required

attr_queue_url: typing.Union[str, IResolvable]

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

Attribute QueueUrl: URL of created queue.

props^Required

props: QueueProps

• Type: QueueProps