Queue

• Implements: IQueue

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

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)
//  .dlqPolicy(IResolvable)
//  .dlqPolicy(DlqPolicyProperty)
//  .loggingEnabled(java.lang.Boolean)
//  .loggingEnabled(IResolvable)
//  .maximumMessageSize(java.lang.Number)
//  .maximumMessageSize(IResolvable)
//  .messageRetentionPeriod(java.lang.Number)
//  .messageRetentionPeriod(IResolvable)
//  .pollingWaitSeconds(java.lang.Number)
//  .pollingWaitSeconds(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .visibilityTimeout(java.lang.Number)
//  .visibilityTimeout(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

queueName^Required

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

Property queueName: Queue name.

delaySeconds^Optional

• 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

dlqPolicy^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR DlqPolicyProperty

Property dlqPolicy: Dead-letter queue policy.

loggingEnabled^Optional

• 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

maximumMessageSize^Optional

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

messageRetentionPeriod^Optional

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

Property messageRetentionPeriod: The maximum time to live (TTL) for a message in the queue.

After the specified period, the message is deleted, regardless of whether it has been retrieved. Valid values: 60 to 604800. Unit: seconds. Default value: 345600.

pollingWaitSeconds^Optional

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

tags^Optional

• Type: java.util.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.

visibilityTimeout^Optional

• 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

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

fromQueueArn

import com.aliyun.ros.cdk.mns.Queue;
Queue.fromQueueArn(Construct scope, java.lang.String id, java.lang.String attrArnWithSlash)

scope^Required

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

id^Required

• Type: java.lang.String

attrArnWithSlash^Required

• Type: java.lang.String

fromQueueAttributes

import com.aliyun.ros.cdk.mns.Queue;
Queue.fromQueueAttributes(Construct scope, java.lang.String id, QueueAttributes attrs)

Import an existing queue.

scope^Required

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

id^Required

• Type: java.lang.String

attrs^Required

• Type: QueueAttributes

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrArnWithSlash^Required

public java.lang.Object getAttrArnWithSlash();

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

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

attrQueueName^Required

public java.lang.Object getAttrQueueName();

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

Attribute QueueName: Queue name.

attrQueueUrl^Required

public java.lang.Object getAttrQueueUrl();

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

Attribute QueueUrl: URL of created queue.

props^Required

public QueueProps getProps();

• Type: QueueProps