Queue

This class encapsulates and extends the ROS resource type DATASOURCE::MNS::Queue, which is used to query the information about a created queue.

Initializers

from ros_cdk_mns import datasource
datasource.Queue(
  scope: Construct,
  id: str,
  queue_name: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, 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: The name of the MNS queue.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

queue_name^Required

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

Property queueName: The name of the MNS queue.

---

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

---

enable_resource_property_constraint^Optional

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

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

---

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

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

---

is_construct

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

Return whether the given object is a Construct.

x^Required

• 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_active_messages	ros_cdk_core.IResolvable	Attribute ActiveMessages: The total number of active messages in the queue.
attr_create_time	ros_cdk_core.IResolvable	Attribute CreateTime: The time when the queue was created.
attr_delay_messages	ros_cdk_core.IResolvable	Attribute DelayMessages: The total number of delayed messages in the queue.
attr_delay_seconds	ros_cdk_core.IResolvable	Attribute DelaySeconds: The delay time after which all messages that are sent to the queue can be consumed.
attr_inactive_messages	ros_cdk_core.IResolvable	Attribute InactiveMessages: The total number of inactive messages in the queue.
attr_last_modify_time	ros_cdk_core.IResolvable	Attribute LastModifyTime: The most recent time when the queue was modified.
attr_logging_enabled	ros_cdk_core.IResolvable	Attribute LoggingEnabled: Specifies whether to enable the log management feature.
attr_maximum_message_size	ros_cdk_core.IResolvable	Attribute MaximumMessageSize: The maximum size of a message that can be sent to the queue.
attr_message_retention_period	ros_cdk_core.IResolvable	Attribute MessageRetentionPeriod: The maximum lifetime of a message in the queue.
attr_polling_wait_seconds	ros_cdk_core.IResolvable	Attribute PollingWaitSeconds: The maximum time period that a ReceiveMessage request can wait till a message is in the queue.
attr_queue_internal_url	ros_cdk_core.IResolvable	Attribute QueueInternalUrl: The internal URL of the queue.
attr_queue_name	ros_cdk_core.IResolvable	Attribute QueueName: The name of the MNS queue.
attr_queue_url	ros_cdk_core.IResolvable	Attribute QueueUrl: The URL of the queue.
attr_visibility_timeout	ros_cdk_core.IResolvable	Attribute VisibilityTimeout: The duration for which a message stays in the Inactive state after it is consumed from the queue.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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_active_messages^Required

attr_active_messages: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ActiveMessages: The total number of active messages in the queue.

---

attr_create_time^Required

attr_create_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CreateTime: The time when the queue was created.

---

attr_delay_messages^Required

attr_delay_messages: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute DelayMessages: The total number of delayed messages in the queue.

---

attr_delay_seconds^Required

attr_delay_seconds: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute DelaySeconds: The delay time after which all messages that are sent to the queue can be consumed.

---

attr_inactive_messages^Required

attr_inactive_messages: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InactiveMessages: The total number of inactive messages in the queue.

---

attr_last_modify_time^Required

attr_last_modify_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute LastModifyTime: The most recent time when the queue was modified.

---

attr_logging_enabled^Required

attr_logging_enabled: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute LoggingEnabled: Specifies whether to enable the log management feature.

---

attr_maximum_message_size^Required

attr_maximum_message_size: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute MaximumMessageSize: The maximum size of a message that can be sent to the queue.

---

attr_message_retention_period^Required

attr_message_retention_period: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute MessageRetentionPeriod: The maximum lifetime of a message in the queue.

After the time that is specified by this parameter expires, the message is deleted, regardless of whether the message has been consumed.

---

attr_polling_wait_seconds^Required

attr_polling_wait_seconds: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute PollingWaitSeconds: The maximum time period that a ReceiveMessage request can wait till a message is in the queue.

---

attr_queue_internal_url^Required

attr_queue_internal_url: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute QueueInternalUrl: The internal URL of the queue.

---

attr_queue_name^Required

attr_queue_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute QueueName: The name of the MNS queue.

---

attr_queue_url^Required

attr_queue_url: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute QueueUrl: The URL of the queue.

---

attr_visibility_timeout^Required

attr_visibility_timeout: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute VisibilityTimeout: The duration for which a message stays in the Inactive state after it is consumed from the queue.

---