ConsumerGroup

• Implements: IConsumerGroup

This class encapsulates and extends the ROS resource type ALIYUN::SLS::ConsumerGroup.

Initializers

import com.aliyun.ros.cdk.sls.ConsumerGroup;
ConsumerGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .consumerGroup(java.lang.String)
    .consumerGroup(IResolvable)
    .logstore(java.lang.String)
    .logstore(IResolvable)
    .order(java.lang.Boolean)
    .order(IResolvable)
    .project(java.lang.String)
    .project(IResolvable)
    .timeout(java.lang.Number)
    .timeout(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

consumerGroup^Required

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

Property consumerGroup: The name of the consumer group.

The name must be unique in a project.

logstore^Required

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

Property logstore: The name of the Logstore.

order^Required

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

Property order: Specifies whether to consume data in sequence.

Valid values: true In a shard, data is consumed in ascending order based on the value of the *tag*:receive_time**** field. If a shard is split, data in the original shard is consumed first. Then, data in the new shards is consumed at the same time. If shards are merged, data in the original shards is consumed first. Then, data in the new shard is consumed. false Data in all shards is consumed at the same time. If a new shard is generated after a shard is split or after shards are merged, data in the new shard is immediately consumed.

project^Required

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

Property project: The name of the project.

timeout^Required

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

Property timeout: The timeout period.

If the server does not receive heartbeats from a consumer within the timeout period, the server deletes the consumer. Unit: seconds.

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.sls.ConsumerGroup;
ConsumerGroup.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

attrConsumerGroup^Required

public java.lang.Object getAttrConsumerGroup();

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

Attribute ConsumerGroup: The name of the consumer group.

attrLogstore^Required

public java.lang.Object getAttrLogstore();

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

Attribute Logstore: The name of the logstore to which this consumer group belongs.

attrProject^Required

public java.lang.Object getAttrProject();

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

Attribute Project: The name of the project to which the logstore belongs.

props^Required

public ConsumerGroupProps getProps();

• Type: ConsumerGroupProps