Queue

• Implements: com.aliyun.ros.cdk.mns.datasource.IQueue

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

Initializers

import com.aliyun.ros.cdk.mns.datasource.Queue;
Queue.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .queueName(java.lang.String)
    .queueName(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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: The name of the MNS queue.

refreshOptions^Optional

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

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.datasource.Queue;
Queue.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

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

attrActiveMessages^Required

public java.lang.Object getAttrActiveMessages();

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

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

attrCreateTime^Required

public java.lang.Object getAttrCreateTime();

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

Attribute CreateTime: The time when the queue was created.

attrDelayMessages^Required

public java.lang.Object getAttrDelayMessages();

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

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

attrDelaySeconds^Required

public java.lang.Object getAttrDelaySeconds();

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

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

attrInactiveMessages^Required

public java.lang.Object getAttrInactiveMessages();

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

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

attrLastModifyTime^Required

public java.lang.Object getAttrLastModifyTime();

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

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

attrLoggingEnabled^Required

public java.lang.Object getAttrLoggingEnabled();

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

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

attrMaximumMessageSize^Required

public java.lang.Object getAttrMaximumMessageSize();

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

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

attrMessageRetentionPeriod^Required

public java.lang.Object getAttrMessageRetentionPeriod();

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

attrPollingWaitSeconds^Required

public java.lang.Object getAttrPollingWaitSeconds();

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

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

attrQueueInternalUrl^Required

public java.lang.Object getAttrQueueInternalUrl();

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

Attribute QueueInternalUrl: The internal URL of the queue.

attrQueueName^Required

public java.lang.Object getAttrQueueName();

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

Attribute QueueName: The name of the MNS queue.

attrQueueUrl^Required

public java.lang.Object getAttrQueueUrl();

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

Attribute QueueUrl: The URL of the queue.

attrVisibilityTimeout^Required

public java.lang.Object getAttrVisibilityTimeout();

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

public QueueProps getProps();

• Type: QueueProps