Skip to content

IQueue

  • Extends: ros_cdk_core.IResource

  • Implemented By: ros_cdk_mns.datasource.Queue, ros_cdk_mns.datasource.IQueue

Represents a Queue.

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node for this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
stack ros_cdk_core.Stack The stack in which this resource is defined.
attr_active_messages typing.Union[str, ros_cdk_core.IResolvable] Attribute ActiveMessages: The total number of active messages in the queue.
attr_create_time typing.Union[str, ros_cdk_core.IResolvable] Attribute CreateTime: The time when the queue was created.
attr_delay_messages typing.Union[str, ros_cdk_core.IResolvable] Attribute DelayMessages: The total number of delayed messages in the queue.
attr_delay_seconds typing.Union[str, 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 typing.Union[str, ros_cdk_core.IResolvable] Attribute InactiveMessages: The total number of inactive messages in the queue.
attr_last_modify_time typing.Union[str, ros_cdk_core.IResolvable] Attribute LastModifyTime: The most recent time when the queue was modified.
attr_logging_enabled typing.Union[str, ros_cdk_core.IResolvable] Attribute LoggingEnabled: Specifies whether to enable the log management feature.
attr_maximum_message_size typing.Union[str, ros_cdk_core.IResolvable] Attribute MaximumMessageSize: The maximum size of a message that can be sent to the queue.
attr_message_retention_period typing.Union[str, ros_cdk_core.IResolvable] Attribute MessageRetentionPeriod: The maximum lifetime of a message in the queue.
attr_polling_wait_seconds typing.Union[str, 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 typing.Union[str, ros_cdk_core.IResolvable] Attribute QueueInternalUrl: The internal URL of the queue.
attr_queue_name typing.Union[str, ros_cdk_core.IResolvable] Attribute QueueName: The name of the MNS queue.
attr_queue_url typing.Union[str, ros_cdk_core.IResolvable] Attribute QueueUrl: The URL of the queue.
attr_visibility_timeout typing.Union[str, ros_cdk_core.IResolvable] Attribute VisibilityTimeout: The duration for which a message stays in the Inactive state after it is consumed from the queue.
props QueueProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node for this construct.


envRequired

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.


stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


attr_active_messagesRequired

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

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


attr_create_timeRequired

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

Attribute CreateTime: The time when the queue was created.


attr_delay_messagesRequired

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

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


attr_delay_secondsRequired

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

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


attr_inactive_messagesRequired

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

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


attr_last_modify_timeRequired

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

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


attr_logging_enabledRequired

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

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


attr_maximum_message_sizeRequired

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

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


attr_message_retention_periodRequired

attr_message_retention_period: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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_secondsRequired

attr_polling_wait_seconds: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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_urlRequired

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

Attribute QueueInternalUrl: The internal URL of the queue.


attr_queue_nameRequired

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

Attribute QueueName: The name of the MNS queue.


attr_queue_urlRequired

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

Attribute QueueUrl: The URL of the queue.


attr_visibility_timeoutRequired

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

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


propsRequired

props: QueueProps