Skip to content

ConsumerGroup

  • Implements: com.aliyun.ros.cdk.rocketmq5.datasource.IConsumerGroup

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.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

consumerGroupIdRequired

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

Property consumerGroupId: The ID of the consumer group.


instanceIdRequired

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

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


refreshOptionsOptional

  • 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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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.

sessionRequired

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

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

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

addCount

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

countRequired

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

addDependency

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

nameRequired

  • Type: java.lang.String

setMetadata

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

keyRequired

  • Type: java.lang.String

valueRequired

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

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ConsumeRetryPolicy: The consumption retry policy that you want to configure for the consumer group.
attrConsumerGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ConsumerGroupId: The ID of the consumer group.
attrCreateTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The time when the consumer group was created.
attrDeliveryOrderType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DeliveryOrderType: The message delivery order of the consumer group.
attrInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: The ID of the RocketMQ instance.
attrRemark java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Remark: The remarks on the consumer group.
attrStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Status: The state of the consumer group.
attrUpdateTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute UpdateTime: The time when the consumer group was last updated.
props ConsumerGroupProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

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.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrConsumeRetryPolicyRequired

public java.lang.Object getAttrConsumeRetryPolicy();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrConsumerGroupIdRequired

public java.lang.Object getAttrConsumerGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ConsumerGroupId: The ID of the consumer group.


attrCreateTimeRequired

public java.lang.Object getAttrCreateTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrDeliveryOrderTypeRequired

public java.lang.Object getAttrDeliveryOrderType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrInstanceIdRequired

public java.lang.Object getAttrInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The ID of the RocketMQ instance.


attrRemarkRequired

public java.lang.Object getAttrRemark();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Remark: The remarks on the consumer group.


attrStatusRequired

public java.lang.Object getAttrStatus();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Status: The state of the consumer group.


attrUpdateTimeRequired

public java.lang.Object getAttrUpdateTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


propsRequired

public ConsumerGroupProps getProps();