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 com.aliyun.ros.cdk.mns.Queue;
Queue.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .queueName(java.lang.String)
    .queueName(IResolvable)
//  .delaySeconds(java.lang.Number)
//  .delaySeconds(IResolvable)
//  .loggingEnabled(java.lang.Boolean)
//  .loggingEnabled(IResolvable)
//  .maximumMessageSize(java.lang.Number)
//  .maximumMessageSize(IResolvable)
//  .messageRetentionPeriod(java.lang.Number)
//  .messageRetentionPeriod(IResolvable)
//  .pollingWaitSeconds(java.lang.Number)
//  .pollingWaitSeconds(IResolvable)
//  .visibilityTimeout(java.lang.Number)
//  .visibilityTimeout(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
queueName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property queueName: Queue name.
delaySeconds java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property delaySeconds: It is measured in seconds.
loggingEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property loggingEnabled: Whether to enable log management.
maximumMessageSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property maximumMessageSize: Maximum body length of a message sent to the queue, measured in bytes.
messageRetentionPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property messageRetentionPeriod: Maximum lifetime of the message in the queue, measured in seconds.
pollingWaitSeconds java.lang.Number OR com.aliyun.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.
visibilityTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property visibilityTimeout: Duration in which a message stays in Inactive status after it is consumed from the queue.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

queueNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property queueName: Queue name.

delaySecondsOptional

  • Type: java.lang.Number OR com.aliyun.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

loggingEnabledOptional

  • Type: java.lang.Boolean OR com.aliyun.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

maximumMessageSizeOptional

  • Type: java.lang.Number OR com.aliyun.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).

messageRetentionPeriodOptional

  • Type: java.lang.Number OR com.aliyun.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)

pollingWaitSecondsOptional

  • Type: java.lang.Number OR com.aliyun.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)

visibilityTimeoutOptional

  • Type: java.lang.Number OR com.aliyun.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)

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 java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

import com.aliyun.ros.cdk.mns.Queue;
Queue.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrArnWithSlash com.aliyun.ros.cdk.core.IResolvable Attribute ARN.WithSlash: The ARN: acs:mns:$region:$accountid:/queues/$queueName.
attrQueueName com.aliyun.ros.cdk.core.IResolvable Attribute QueueName: Queue name.
attrQueueUrl com.aliyun.ros.cdk.core.IResolvable Attribute QueueUrl: URL of created queue.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrArnWithSlashRequired 

public IResolvable getAttrArnWithSlash();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrQueueNameRequired 

public IResolvable getAttrQueueName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute QueueName: Queue name.

attrQueueUrlRequired 

public IResolvable getAttrQueueUrl();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute QueueUrl: URL of created queue.