ConsumerGroup

This class encapsulates and extends the ROS resource type ALIYUN::ROCKETMQ5::ConsumerGroup, which is used to create a consumer group in ApsaraMQ for RocketMQ 5.0.

Initializers

import com.aliyun.ros.cdk.rocketmq5.ConsumerGroup;
ConsumerGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .consumeRetryPolicy(IResolvable)
    .consumeRetryPolicy(ConsumeRetryPolicyProperty)
    .consumerGroupId(java.lang.String)
    .consumerGroupId(IResolvable)
    .deliveryOrderType(java.lang.String)
    .deliveryOrderType(IResolvable)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
//  .remark(java.lang.String)
//  .remark(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.
consumeRetryPolicy	com.aliyun.ros.cdk.core.IResolvable OR ConsumeRetryPolicyProperty	Property consumeRetryPolicy: The consumption retry policy of the consumer group to be created.
consumerGroupId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property consumerGroupId: The ID of the consumer group to be created.
deliveryOrderType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property deliveryOrderType: Delivery sequence of the consumer group to be created.
instanceId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property instanceId: The ID of the instance.
remark	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property remark: The remark of the consumer group to be created.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

consumeRetryPolicy^Required

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

Property consumeRetryPolicy: The consumption retry policy of the consumer group to be created.

---

consumerGroupId^Required

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

Property consumerGroupId: The ID of the consumer group to be created.

Used to identify consumer groups, globally unique. The value description is as follows: Character limitation: supports letters a~z or A-Z, numbers 0-9, underscore (_), dash (-) and percent sign (%). Length limit: 1-60 characters.

---

deliveryOrderType^Required

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

Property deliveryOrderType: Delivery sequence of the consumer group to be created.

---

instanceId^Required

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

Property instanceId: The ID of the instance.

---

remark^Optional

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

Property remark: The remark of the consumer group to be created.

---

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.

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

---

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

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

---

isConstruct

import com.aliyun.ros.cdk.rocketmq5.ConsumerGroup;
ConsumerGroup.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• 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.
attrConsumerGroupId	com.aliyun.ros.cdk.core.IResolvable	Attribute ConsumerGroupId: The ID of the consumer group.
attrDeliveryOrderType	com.aliyun.ros.cdk.core.IResolvable	Attribute DeliveryOrderType: Delivery sequence of consumer group.
attrInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute InstanceId: The ID of the instance.

---

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

---

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

---

attrConsumerGroupId^Required

public IResolvable getAttrConsumerGroupId();

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

Attribute ConsumerGroupId: The ID of the consumer group.

---

attrDeliveryOrderType^Required

public IResolvable getAttrDeliveryOrderType();

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

Attribute DeliveryOrderType: Delivery sequence of consumer group.

---

attrInstanceId^Required

public IResolvable getAttrInstanceId();

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

Attribute InstanceId: The ID of the instance.

---