Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. kafka
  6. getGroup
Viewing docs for bytepluscc v0.0.41
published on Thursday, Jul 16, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.kafka.getGroup

bytepluscc logo
Viewing docs for bytepluscc v0.0.41
published on Thursday, Jul 16, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::Kafka::Group

    Using getGroup

    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 getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>
    def get_group(id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(id: pulumi.Input[Optional[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]
    func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput

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

    public static class GetGroup 
{
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: bytepluscc:kafka/getGroup:getGroup
  arguments:
    # arguments dictionary
    data "bytepluscc_kafka_getgroup" "name" {
    # arguments
}

    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 string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getGroup Result

    The following output properties are available:

    BalanceAlgorithm string
    Algorithm for assigning partitions to consumers, specified by the consumer client. If using custom partition consumption, this field may be empty
    Description string
    Consumer group description, up to 128 characters
    GroupId string
    Consumer group ID to be created - Length: 3–128 characters - Can contain uppercase and lowercase letters, numbers, hyphens (-), special character (@), and underscores (_) - Must include at least one letter or number
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID
    ProtocolType string
    Consumer group protocol type - If using the standard Kafka consumer protocol, displays as consumer - If using another protocol type, displays the corresponding protocol name, for example, connect when using Kafka-Connector - If using custom partition consumption, this field may be empty
    State string
    Consumer group status - PreparingRebalance: preparing for consumption - CompletingRebalance: assigning partitions - Stable: consuming - Empty: not consuming - Dead: expired
    Tags List<Byteplus.GetGroupTag>
    Group tags
    BalanceAlgorithm string
    Algorithm for assigning partitions to consumers, specified by the consumer client. If using custom partition consumption, this field may be empty
    Description string
    Consumer group description, up to 128 characters
    GroupId string
    Consumer group ID to be created - Length: 3–128 characters - Can contain uppercase and lowercase letters, numbers, hyphens (-), special character (@), and underscores (_) - Must include at least one letter or number
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID
    ProtocolType string
    Consumer group protocol type - If using the standard Kafka consumer protocol, displays as consumer - If using another protocol type, displays the corresponding protocol name, for example, connect when using Kafka-Connector - If using custom partition consumption, this field may be empty
    State string
    Consumer group status - PreparingRebalance: preparing for consumption - CompletingRebalance: assigning partitions - Stable: consuming - Empty: not consuming - Dead: expired
    Tags []GetGroupTag
    Group tags
    balance_algorithm string
    Algorithm for assigning partitions to consumers, specified by the consumer client. If using custom partition consumption, this field may be empty
    description string
    Consumer group description, up to 128 characters
    group_id string
    Consumer group ID to be created - Length: 3–128 characters - Can contain uppercase and lowercase letters, numbers, hyphens (-), special character (@), and underscores (_) - Must include at least one letter or number
    id string
    Uniquely identifies the resource.
    instance_id string
    Instance ID
    protocol_type string
    Consumer group protocol type - If using the standard Kafka consumer protocol, displays as consumer - If using another protocol type, displays the corresponding protocol name, for example, connect when using Kafka-Connector - If using custom partition consumption, this field may be empty
    state string
    Consumer group status - PreparingRebalance: preparing for consumption - CompletingRebalance: assigning partitions - Stable: consuming - Empty: not consuming - Dead: expired
    tags list(object)
    Group tags
    balanceAlgorithm String
    Algorithm for assigning partitions to consumers, specified by the consumer client. If using custom partition consumption, this field may be empty
    description String
    Consumer group description, up to 128 characters
    groupId String
    Consumer group ID to be created - Length: 3–128 characters - Can contain uppercase and lowercase letters, numbers, hyphens (-), special character (@), and underscores (_) - Must include at least one letter or number
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID
    protocolType String
    Consumer group protocol type - If using the standard Kafka consumer protocol, displays as consumer - If using another protocol type, displays the corresponding protocol name, for example, connect when using Kafka-Connector - If using custom partition consumption, this field may be empty
    state String
    Consumer group status - PreparingRebalance: preparing for consumption - CompletingRebalance: assigning partitions - Stable: consuming - Empty: not consuming - Dead: expired
    tags List<GetGroupTag>
    Group tags
    balanceAlgorithm string
    Algorithm for assigning partitions to consumers, specified by the consumer client. If using custom partition consumption, this field may be empty
    description string
    Consumer group description, up to 128 characters
    groupId string
    Consumer group ID to be created - Length: 3–128 characters - Can contain uppercase and lowercase letters, numbers, hyphens (-), special character (@), and underscores (_) - Must include at least one letter or number
    id string
    Uniquely identifies the resource.
    instanceId string
    Instance ID
    protocolType string
    Consumer group protocol type - If using the standard Kafka consumer protocol, displays as consumer - If using another protocol type, displays the corresponding protocol name, for example, connect when using Kafka-Connector - If using custom partition consumption, this field may be empty
    state string
    Consumer group status - PreparingRebalance: preparing for consumption - CompletingRebalance: assigning partitions - Stable: consuming - Empty: not consuming - Dead: expired
    tags GetGroupTag[]
    Group tags
    balance_algorithm str
    Algorithm for assigning partitions to consumers, specified by the consumer client. If using custom partition consumption, this field may be empty
    description str
    Consumer group description, up to 128 characters
    group_id str
    Consumer group ID to be created - Length: 3–128 characters - Can contain uppercase and lowercase letters, numbers, hyphens (-), special character (@), and underscores (_) - Must include at least one letter or number
    id str
    Uniquely identifies the resource.
    instance_id str
    Instance ID
    protocol_type str
    Consumer group protocol type - If using the standard Kafka consumer protocol, displays as consumer - If using another protocol type, displays the corresponding protocol name, for example, connect when using Kafka-Connector - If using custom partition consumption, this field may be empty
    state str
    Consumer group status - PreparingRebalance: preparing for consumption - CompletingRebalance: assigning partitions - Stable: consuming - Empty: not consuming - Dead: expired
    tags Sequence[GetGroupTag]
    Group tags
    balanceAlgorithm String
    Algorithm for assigning partitions to consumers, specified by the consumer client. If using custom partition consumption, this field may be empty
    description String
    Consumer group description, up to 128 characters
    groupId String
    Consumer group ID to be created - Length: 3–128 characters - Can contain uppercase and lowercase letters, numbers, hyphens (-), special character (@), and underscores (_) - Must include at least one letter or number
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID
    protocolType String
    Consumer group protocol type - If using the standard Kafka consumer protocol, displays as consumer - If using another protocol type, displays the corresponding protocol name, for example, connect when using Kafka-Connector - If using custom partition consumption, this field may be empty
    state String
    Consumer group status - PreparingRebalance: preparing for consumption - CompletingRebalance: assigning partitions - Stable: consuming - Empty: not consuming - Dead: expired
    tags List<Property Map>
    Group tags

    Supporting Types

    GetGroupTag

    Key string
    Tag key
    Value string
    Tag value
    Key string
    Tag key
    Value string
    Tag value
    key string
    Tag key
    value string
    Tag value
    key String
    Tag key
    value String
    Tag value
    key string
    Tag key
    value string
    Tag value
    key str
    Tag key
    value str
    Tag value
    key String
    Tag key
    value String
    Tag value

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.41
    published on Thursday, Jul 16, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial