Queue

• Implements: IQueue

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

Initializers

import com.aliyun.ros.cdk.amqp.Queue;
Queue.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
    .queueName(java.lang.String)
    .queueName(IResolvable)
    .virtualHost(java.lang.String)
    .virtualHost(IResolvable)
//  .autoDeleteState(java.lang.Boolean)
//  .autoDeleteState(IResolvable)
//  .autoExpireState(java.lang.Number)
//  .autoExpireState(IResolvable)
//  .deadLetterExchange(java.lang.String)
//  .deadLetterExchange(IResolvable)
//  .deadLetterRoutingKey(java.lang.String)
//  .deadLetterRoutingKey(IResolvable)
//  .exclusiveState(java.lang.Boolean)
//  .exclusiveState(IResolvable)
//  .maximumPriority(java.lang.Number)
//  .maximumPriority(IResolvable)
//  .maxLength(java.lang.Number)
//  .maxLength(IResolvable)
//  .messageTtl(java.lang.Number)
//  .messageTtl(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

instanceId^Required

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

Property instanceId: InstanceId.

queueName^Required

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

Property queueName: The name of the queue to create.

• The queue name can contain only letters, digits, hyphens (-), underscores (_), periods (.), number signs (#), forward slashes (/), and at signs (@). The name must be 1 to 255 characters in length.
• After a queue is created, its name cannot be changed. To change the name, delete the queue and create a new one.

virtualHost^Required

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

Property virtualHost: The name of the vhost to which the queue belongs.

The name can contain only letters, digits, hyphens (-), underscores (_), periods (.), number signs (#), forward slashes (/), and at signs (@). The name must be 1 to 255 characters in length.

autoDeleteState^Optional

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

Property autoDeleteState: Specifies whether the Auto Delete attribute is configured.

Valid values: true: The Auto Delete attribute is configured. The queue is automatically deleted after the last subscription from consumers to this queue is canceled. false: The Auto Delete attribute is not configured.

autoExpireState^Optional

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

Property autoExpireState: The auto-expiration time for the queue.

The queue is automatically deleted if it is not accessed within the specified time period. Unit: milliseconds.

This feature must be enabled before you can use this parameter. To enable the feature, .

deadLetterExchange^Optional

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

Property deadLetterExchange: The dead-letter exchange.

A dead-letter exchange is used to receive rejected messages. If a consumer rejects a message that cannot be retried, this message is routed to a specified dead-letter exchange. Then, the dead-letter exchange routes the message to the queue that is bound to the dead-letter exchange.

deadLetterRoutingKey^Optional

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

Property deadLetterRoutingKey: The dead-letter routing key.

The key can contain only letters, digits, hyphens (-), underscores (_), periods (.), number signs (#), forward slashes (/), and at signs (@). The key must be 1 to 255 characters in length.

exclusiveState^Optional

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

Property exclusiveState: Specifies whether the queue is an exclusive queue.

Valid values:

• true: The queue is an exclusive queue. An exclusive queue can be used only by the connection that declares it. The queue is automatically deleted after the connection is closed.
• false: The queue is not an exclusive queue.

maximumPriority^Optional

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

Property maximumPriority: The priority of the queue.

The recommended value is an integer from 1 to 10.

This parameter is used for message priority. It is supported only by dedicated instances and can be used only after the message priority feature is enabled. To enable the feature, .

maxLength^Optional

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

Property maxLength: This parameter is not supported in the current version.

The maximum number of messages that can be stored in the queue. If this limit is exceeded, the earliest messages in the queue are deleted.

messageTtl^Optional

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

Property messageTtl: The message TTL of the queue If a message is retained in the Queue longer than the configured message lifetime, the message expires.

The value of message lifetime must be a non-negative integer, up to 1 day. The unit is milliseconds

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.amqp.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

attrQueueName^Required

public java.lang.Object getAttrQueueName();

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

Attribute QueueName: The name of the queue.

props^Required

public QueueProps getProps();

• Type: QueueProps