ConsumerGroup

This class encapsulates and extends the ROS resource type DATASOURCE::ROCKETMQ5::ConsumerGroup.

Initializers

import com.aliyun.ros.cdk.rocketmq5.datasource.ConsumerGroup;
ConsumerGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .consumerGroupId(java.lang.String)
    .consumerGroupId(IResolvable)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
consumerGroupId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property consumerGroupId: The ID of the consumer group.
instanceId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property instanceId: The ID of the instance to which the consumer group belongs.
refreshOptions	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

consumerGroupId^Required

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

Property consumerGroupId: The ID of the consumer group.

---

instanceId^Required

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

Property instanceId: The ID of the instance to which the consumer group belongs.

---

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

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.datasource.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.
attrConsumeRetryPolicy	com.aliyun.ros.cdk.core.IResolvable	Attribute ConsumeRetryPolicy: The consumption retry policy that you want to configure for the consumer group.
attrConsumerGroupId	com.aliyun.ros.cdk.core.IResolvable	Attribute ConsumerGroupId: The ID of the consumer group.
attrCreateTime	com.aliyun.ros.cdk.core.IResolvable	Attribute CreateTime: The time when the consumer group was created.
attrDeliveryOrderType	com.aliyun.ros.cdk.core.IResolvable	Attribute DeliveryOrderType: The message delivery order of the consumer group.
attrInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute InstanceId: The ID of the RocketMQ instance.
attrRemark	com.aliyun.ros.cdk.core.IResolvable	Attribute Remark: The remarks on the consumer group.
attrStatus	com.aliyun.ros.cdk.core.IResolvable	Attribute Status: The state of the consumer group.
attrUpdateTime	com.aliyun.ros.cdk.core.IResolvable	Attribute UpdateTime: The time when the consumer group was last updated.

---

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

---

attrConsumeRetryPolicy^Required

public IResolvable getAttrConsumeRetryPolicy();

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

Attribute ConsumeRetryPolicy: The consumption retry policy that you want to configure for the consumer group.

---

attrConsumerGroupId^Required

public IResolvable getAttrConsumerGroupId();

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

Attribute ConsumerGroupId: The ID of the consumer group.

---

attrCreateTime^Required

public IResolvable getAttrCreateTime();

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

Attribute CreateTime: The time when the consumer group was created.

---

attrDeliveryOrderType^Required

public IResolvable getAttrDeliveryOrderType();

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

Attribute DeliveryOrderType: The message delivery order of the consumer group.

---

attrInstanceId^Required

public IResolvable getAttrInstanceId();

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

Attribute InstanceId: The ID of the RocketMQ instance.

---

attrRemark^Required

public IResolvable getAttrRemark();

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

Attribute Remark: The remarks on the consumer group.

---

attrStatus^Required

public IResolvable getAttrStatus();

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

Attribute Status: The state of the consumer group.

---

attrUpdateTime^Required

public IResolvable getAttrUpdateTime();

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

Attribute UpdateTime: The time when the consumer group was last updated.

---