Skip to content

ConsumerGroup

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

Initializers 

import ros_cdk_sls
ros_cdk_sls.ConsumerGroup(
  scope: Construct,
  id: str,
  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],
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No 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.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

consumer_groupRequired

  • 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

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

Property logstore: The name of the Logstore.

orderRequired

  • 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

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

Property project: The name of the project.

timeoutRequired

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

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_sls
ros_cdk_sls.ConsumerGroup.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_consumer_group ros_cdk_core.IResolvable Attribute ConsumerGroup: The name of the consumer group.
attr_logstore ros_cdk_core.IResolvable Attribute Logstore: The name of the logstore to which this consumer group belongs.
attr_project ros_cdk_core.IResolvable Attribute Project: The name of the project to which the logstore belongs.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_consumer_groupRequired 

attr_consumer_group: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ConsumerGroup: The name of the consumer group.

attr_logstoreRequired 

attr_logstore: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_projectRequired 

attr_project: IResolvable
  • Type: ros_cdk_core.IResolvable

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