Skip to content

ConsumerGroupProps

Properties for defining a ConsumerGroup.

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

Initializer 

import ros_cdk_sls
ros_cdk_sls.ConsumerGroupProps(
  consumer_group: typing.Union[str, IResolvable],
  logstore: typing.Union[str, IResolvable],
  order: typing.Union[bool, IResolvable],
  project: typing.Union[str, IResolvable],
  timeout: typing.Union[typing.Union[int, float], IResolvable]
)

Properties

Name Type Description
consumer_group typing.Union[str, ros_cdk_core.IResolvable] Property consumerGroup: The name of the consumer group.
logstore typing.Union[str, ros_cdk_core.IResolvable] Property logstore: The name of the Logstore.
order typing.Union[bool, ros_cdk_core.IResolvable] Property order: Specifies whether to consume data in sequence.
project typing.Union[str, ros_cdk_core.IResolvable] Property project: The name of the project.
timeout typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property timeout: The timeout period.

consumer_groupRequired 

consumer_group: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property consumerGroup: The name of the consumer group.

The name must be unique in a project.

logstoreRequired 

logstore: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property logstore: The name of the Logstore.

orderRequired 

order: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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 

project: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property project: The name of the project.

timeoutRequired 

timeout: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.