volcenginecc.tls.getConsumerGroup

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getConsumerGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getConsumerGroup(args: GetConsumerGroupArgs, opts?: InvokeOptions): Promise<GetConsumerGroupResult>
function getConsumerGroupOutput(args: GetConsumerGroupOutputArgs, opts?: InvokeOptions): Output<GetConsumerGroupResult>

def get_consumer_group(id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetConsumerGroupResult
def get_consumer_group_output(id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetConsumerGroupResult]

func LookupConsumerGroup(ctx *Context, args *LookupConsumerGroupArgs, opts ...InvokeOption) (*LookupConsumerGroupResult, error)
func LookupConsumerGroupOutput(ctx *Context, args *LookupConsumerGroupOutputArgs, opts ...InvokeOption) LookupConsumerGroupResultOutput

> Note: This function is named LookupConsumerGroup in the Go SDK.

public static class GetConsumerGroup 
{
    public static Task<GetConsumerGroupResult> InvokeAsync(GetConsumerGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetConsumerGroupResult> Invoke(GetConsumerGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetConsumerGroupResult> getConsumerGroup(GetConsumerGroupArgs args, InvokeOptions options)
public static Output<GetConsumerGroupResult> getConsumerGroup(GetConsumerGroupArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:tls/getConsumerGroup:getConsumerGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getConsumerGroup Result

The following output properties are available:

ConsumerGroupName string: Consumer group name.
HeartbeatTtl int: Heartbeat timeout in seconds. Value range: 1~300.
Id string: Uniquely identifies the resource.
OrderedConsume bool: Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
ProjectId string: ID of the log project to which the consumer group belongs.
ProjectName string: Name of the log project to which the consumer group belongs.
TopicIdLists List<string>: List of log topic IDs to be consumed by the consumer group.

ConsumerGroupName string: Consumer group name.
HeartbeatTtl int: Heartbeat timeout in seconds. Value range: 1~300.
Id string: Uniquely identifies the resource.
OrderedConsume bool: Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
ProjectId string: ID of the log project to which the consumer group belongs.
ProjectName string: Name of the log project to which the consumer group belongs.
TopicIdLists []string: List of log topic IDs to be consumed by the consumer group.

consumerGroupName String: Consumer group name.
heartbeatTtl Integer: Heartbeat timeout in seconds. Value range: 1~300.
id String: Uniquely identifies the resource.
orderedConsume Boolean: Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
projectId String: ID of the log project to which the consumer group belongs.
projectName String: Name of the log project to which the consumer group belongs.
topicIdLists List<String>: List of log topic IDs to be consumed by the consumer group.

consumerGroupName string: Consumer group name.
heartbeatTtl number: Heartbeat timeout in seconds. Value range: 1~300.
id string: Uniquely identifies the resource.
orderedConsume boolean: Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
projectId string: ID of the log project to which the consumer group belongs.
projectName string: Name of the log project to which the consumer group belongs.
topicIdLists string[]: List of log topic IDs to be consumed by the consumer group.

consumer_group_name str: Consumer group name.
heartbeat_ttl int: Heartbeat timeout in seconds. Value range: 1~300.
id str: Uniquely identifies the resource.
ordered_consume bool: Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
project_id str: ID of the log project to which the consumer group belongs.
project_name str: Name of the log project to which the consumer group belongs.
topic_id_lists Sequence[str]: List of log topic IDs to be consumed by the consumer group.

consumerGroupName String: Consumer group name.
heartbeatTtl Number: Heartbeat timeout in seconds. Value range: 1~300.
id String: Uniquely identifies the resource.
orderedConsume Boolean: Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.
projectId String: ID of the log project to which the consumer group belongs.
projectName String: Name of the log project to which the consumer group belongs.
topicIdLists List<String>: List of log topic IDs to be consumed by the consumer group.

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.tls.getConsumerGroup

On this page

On this page

Using getConsumerGroup

getConsumerGroup Result

Package Details

On this page

On this page