Skip to content

Queue

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

Initializers 

import { datasource } from '@alicloud/ros-cdk-mns'
new datasource.Queue(scope: Construct, id: string, props: QueueProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props QueueProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

  • Type: boolean

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public toString(): string

Returns a string representation of this construct.

synthesize 

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct 

import { datasource } from '@alicloud/ros-cdk-mns'
datasource.Queue.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrActiveMessages @alicloud/ros-cdk-core.IResolvable Attribute ActiveMessages: The total number of active messages in the queue.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The time when the queue was created.
attrDelayMessages @alicloud/ros-cdk-core.IResolvable Attribute DelayMessages: The total number of delayed messages in the queue.
attrDelaySeconds @alicloud/ros-cdk-core.IResolvable Attribute DelaySeconds: The delay time after which all messages that are sent to the queue can be consumed.
attrInactiveMessages @alicloud/ros-cdk-core.IResolvable Attribute InactiveMessages: The total number of inactive messages in the queue.
attrLastModifyTime @alicloud/ros-cdk-core.IResolvable Attribute LastModifyTime: The most recent time when the queue was modified.
attrLoggingEnabled @alicloud/ros-cdk-core.IResolvable Attribute LoggingEnabled: Specifies whether to enable the log management feature.
attrMaximumMessageSize @alicloud/ros-cdk-core.IResolvable Attribute MaximumMessageSize: The maximum size of a message that can be sent to the queue.
attrMessageRetentionPeriod @alicloud/ros-cdk-core.IResolvable Attribute MessageRetentionPeriod: The maximum lifetime of a message in the queue.
attrPollingWaitSeconds @alicloud/ros-cdk-core.IResolvable Attribute PollingWaitSeconds: The maximum time period that a ReceiveMessage request can wait till a message is in the queue.
attrQueueInternalUrl @alicloud/ros-cdk-core.IResolvable Attribute QueueInternalUrl: The internal URL of the queue.
attrQueueName @alicloud/ros-cdk-core.IResolvable Attribute QueueName: The name of the MNS queue.
attrQueueUrl @alicloud/ros-cdk-core.IResolvable Attribute QueueUrl: The URL of the queue.
attrVisibilityTimeout @alicloud/ros-cdk-core.IResolvable Attribute VisibilityTimeout: The duration for which a message stays in the Inactive state after it is consumed from the queue.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrActiveMessagesRequired 

public readonly attrActiveMessages: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The time when the queue was created.

attrDelayMessagesRequired 

public readonly attrDelayMessages: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrDelaySecondsRequired 

public readonly attrDelaySeconds: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrInactiveMessagesRequired 

public readonly attrInactiveMessages: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrLastModifyTimeRequired 

public readonly attrLastModifyTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrLoggingEnabledRequired 

public readonly attrLoggingEnabled: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrMaximumMessageSizeRequired 

public readonly attrMaximumMessageSize: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrMessageRetentionPeriodRequired 

public readonly attrMessageRetentionPeriod: IResolvable;
  • Type: @alicloud/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.

attrPollingWaitSecondsRequired 

public readonly attrPollingWaitSeconds: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrQueueInternalUrlRequired 

public readonly attrQueueInternalUrl: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute QueueInternalUrl: The internal URL of the queue.

attrQueueNameRequired 

public readonly attrQueueName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute QueueName: The name of the MNS queue.

attrQueueUrlRequired 

public readonly attrQueueUrl: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute QueueUrl: The URL of the queue.

attrVisibilityTimeoutRequired 

public readonly attrVisibilityTimeout: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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