Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. CkafkaConsumerGroup
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.CkafkaConsumerGroup

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Provides a resource to create a ckafka consumer_group

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";

const consumerGroup = new tencentcloud.CkafkaConsumerGroup("consumerGroup", {
    groupName: "GroupName",
    instanceId: "InstanceId",
    topicNameLists: ["xxxxxx"],
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

consumer_group = tencentcloud.CkafkaConsumerGroup("consumerGroup",
    group_name="GroupName",
    instance_id="InstanceId",
    topic_name_lists=["xxxxxx"])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewCkafkaConsumerGroup(ctx, "consumerGroup", &tencentcloud.CkafkaConsumerGroupArgs{
			GroupName:  pulumi.String("GroupName"),
			InstanceId: pulumi.String("InstanceId"),
			TopicNameLists: pulumi.StringArray{
				pulumi.String("xxxxxx"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var consumerGroup = new Tencentcloud.CkafkaConsumerGroup("consumerGroup", new()
    {
        GroupName = "GroupName",
        InstanceId = "InstanceId",
        TopicNameLists = new[]
        {
            "xxxxxx",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.CkafkaConsumerGroup;
import com.pulumi.tencentcloud.CkafkaConsumerGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var consumerGroup = new CkafkaConsumerGroup("consumerGroup", CkafkaConsumerGroupArgs.builder()
            .groupName("GroupName")
            .instanceId("InstanceId")
            .topicNameLists("xxxxxx")
            .build());

    }
}

    resources:
  consumerGroup:
    type: tencentcloud:CkafkaConsumerGroup
    properties:
      groupName: GroupName
      instanceId: InstanceId
      topicNameLists:
        - xxxxxx

    Create CkafkaConsumerGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CkafkaConsumerGroup(name: string, args: CkafkaConsumerGroupArgs, opts?: CustomResourceOptions);
    @overload
def CkafkaConsumerGroup(resource_name: str,
                        args: CkafkaConsumerGroupArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def CkafkaConsumerGroup(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        group_name: Optional[str] = None,
                        instance_id: Optional[str] = None,
                        ckafka_consumer_group_id: Optional[str] = None,
                        topic_name_lists: Optional[Sequence[str]] = None)
    func NewCkafkaConsumerGroup(ctx *Context, name string, args CkafkaConsumerGroupArgs, opts ...ResourceOption) (*CkafkaConsumerGroup, error)
    public CkafkaConsumerGroup(string name, CkafkaConsumerGroupArgs args, CustomResourceOptions? opts = null)
    public CkafkaConsumerGroup(String name, CkafkaConsumerGroupArgs args)
public CkafkaConsumerGroup(String name, CkafkaConsumerGroupArgs args, CustomResourceOptions options)

    type: tencentcloud:CkafkaConsumerGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CkafkaConsumerGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CkafkaConsumerGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CkafkaConsumerGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CkafkaConsumerGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CkafkaConsumerGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    CkafkaConsumerGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CkafkaConsumerGroup resource accepts the following input properties:

    GroupName string
    GroupName.
    InstanceId string
    InstanceId.
    CkafkaConsumerGroupId string
    ID of the resource.
    TopicNameLists List<string>
    array of topic names.
    GroupName string
    GroupName.
    InstanceId string
    InstanceId.
    CkafkaConsumerGroupId string
    ID of the resource.
    TopicNameLists []string
    array of topic names.
    groupName String
    GroupName.
    instanceId String
    InstanceId.
    ckafkaConsumerGroupId String
    ID of the resource.
    topicNameLists List<String>
    array of topic names.
    groupName string
    GroupName.
    instanceId string
    InstanceId.
    ckafkaConsumerGroupId string
    ID of the resource.
    topicNameLists string[]
    array of topic names.
    group_name str
    GroupName.
    instance_id str
    InstanceId.
    ckafka_consumer_group_id str
    ID of the resource.
    topic_name_lists Sequence[str]
    array of topic names.
    groupName String
    GroupName.
    instanceId String
    InstanceId.
    ckafkaConsumerGroupId String
    ID of the resource.
    topicNameLists List<String>
    array of topic names.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CkafkaConsumerGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CkafkaConsumerGroup Resource

    Get an existing CkafkaConsumerGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CkafkaConsumerGroupState, opts?: CustomResourceOptions): CkafkaConsumerGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ckafka_consumer_group_id: Optional[str] = None,
        group_name: Optional[str] = None,
        instance_id: Optional[str] = None,
        topic_name_lists: Optional[Sequence[str]] = None) -> CkafkaConsumerGroup
    func GetCkafkaConsumerGroup(ctx *Context, name string, id IDInput, state *CkafkaConsumerGroupState, opts ...ResourceOption) (*CkafkaConsumerGroup, error)
    public static CkafkaConsumerGroup Get(string name, Input<string> id, CkafkaConsumerGroupState? state, CustomResourceOptions? opts = null)
    public static CkafkaConsumerGroup get(String name, Output<String> id, CkafkaConsumerGroupState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:CkafkaConsumerGroup    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CkafkaConsumerGroupId string
    ID of the resource.
    GroupName string
    GroupName.
    InstanceId string
    InstanceId.
    TopicNameLists List<string>
    array of topic names.
    CkafkaConsumerGroupId string
    ID of the resource.
    GroupName string
    GroupName.
    InstanceId string
    InstanceId.
    TopicNameLists []string
    array of topic names.
    ckafkaConsumerGroupId String
    ID of the resource.
    groupName String
    GroupName.
    instanceId String
    InstanceId.
    topicNameLists List<String>
    array of topic names.
    ckafkaConsumerGroupId string
    ID of the resource.
    groupName string
    GroupName.
    instanceId string
    InstanceId.
    topicNameLists string[]
    array of topic names.
    ckafka_consumer_group_id str
    ID of the resource.
    group_name str
    GroupName.
    instance_id str
    InstanceId.
    topic_name_lists Sequence[str]
    array of topic names.
    ckafkaConsumerGroupId String
    ID of the resource.
    groupName String
    GroupName.
    instanceId String
    InstanceId.
    topicNameLists List<String>
    array of topic names.

    Import

    ckafka consumer_group can be imported using the id, e.g.

    $ pulumi import tencentcloud:index/ckafkaConsumerGroup:CkafkaConsumerGroup consumer_group consumer_group_id

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud