Skip to content

ConsumerGroupProps

Properties for defining a ConsumerGroup.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-sls-consumergroup

Initializer 

import { ConsumerGroupProps } from '@alicloud/ros-cdk-sls'
const consumerGroupProps: ConsumerGroupProps = { ... }

Properties

Name Type Description
consumerGroup string | @alicloud/ros-cdk-core.IResolvable Property consumerGroup: The name of the consumer group.
logstore string | @alicloud/ros-cdk-core.IResolvable Property logstore: The name of the Logstore.
order boolean | @alicloud/ros-cdk-core.IResolvable Property order: Specifies whether to consume data in sequence.
project string | @alicloud/ros-cdk-core.IResolvable Property project: The name of the project.
timeout number | @alicloud/ros-cdk-core.IResolvable Property timeout: The timeout period.

consumerGroupRequired 

public readonly consumerGroup: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property consumerGroup: The name of the consumer group.

The name must be unique in a project.

logstoreRequired 

public readonly logstore: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property logstore: The name of the Logstore.

orderRequired 

public readonly order: boolean | IResolvable;
  • Type: boolean | @alicloud/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.

projectRequired 

public readonly project: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property project: The name of the project.

timeoutRequired 

public readonly timeout: number | IResolvable;
  • Type: number | @alicloud/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.