Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. tls
  5. ConsumerGroup
Volcengine v0.0.33 published on Monday, Jun 30, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.tls.ConsumerGroup

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.33 published on Monday, Jun 30, 2025 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage tls consumer group

    Example Usage

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

const foo = new volcengine.tls.ConsumerGroup("foo", {
    consumerGroupName: "tf-test-consumer-group",
    heartbeatTtl: 120,
    orderedConsume: false,
    projectId: "17ba378d-de43-495e-8906-03aexxxxxx",
    topicIdLists: ["0ed72ac8-9531-4967-b216-ac30xxxxxx"],
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.tls.ConsumerGroup("foo",
    consumer_group_name="tf-test-consumer-group",
    heartbeat_ttl=120,
    ordered_consume=False,
    project_id="17ba378d-de43-495e-8906-03aexxxxxx",
    topic_id_lists=["0ed72ac8-9531-4967-b216-ac30xxxxxx"])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/tls"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tls.NewConsumerGroup(ctx, "foo", &tls.ConsumerGroupArgs{
			ConsumerGroupName: pulumi.String("tf-test-consumer-group"),
			HeartbeatTtl:      pulumi.Int(120),
			OrderedConsume:    pulumi.Bool(false),
			ProjectId:         pulumi.String("17ba378d-de43-495e-8906-03aexxxxxx"),
			TopicIdLists: pulumi.StringArray{
				pulumi.String("0ed72ac8-9531-4967-b216-ac30xxxxxx"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = new Volcengine.Tls.ConsumerGroup("foo", new()
    {
        ConsumerGroupName = "tf-test-consumer-group",
        HeartbeatTtl = 120,
        OrderedConsume = false,
        ProjectId = "17ba378d-de43-495e-8906-03aexxxxxx",
        TopicIdLists = new[]
        {
            "0ed72ac8-9531-4967-b216-ac30xxxxxx",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.tls.ConsumerGroup;
import com.pulumi.volcengine.tls.ConsumerGroupArgs;
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 foo = new ConsumerGroup("foo", ConsumerGroupArgs.builder()        
            .consumerGroupName("tf-test-consumer-group")
            .heartbeatTtl(120)
            .orderedConsume(false)
            .projectId("17ba378d-de43-495e-8906-03aexxxxxx")
            .topicIdLists("0ed72ac8-9531-4967-b216-ac30xxxxxx")
            .build());

    }
}

    resources:
  foo:
    type: volcengine:tls:ConsumerGroup
    properties:
      consumerGroupName: tf-test-consumer-group
      heartbeatTtl: 120
      orderedConsume: false
      projectId: 17ba378d-de43-495e-8906-03aexxxxxx
      topicIdLists:
        - 0ed72ac8-9531-4967-b216-ac30xxxxxx

    Create ConsumerGroup Resource

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

    Constructor syntax

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

@overload
def ConsumerGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  consumer_group_name: Optional[str] = None,
                  heartbeat_ttl: Optional[int] = None,
                  ordered_consume: Optional[bool] = None,
                  project_id: Optional[str] = None,
                  topic_id_lists: Optional[Sequence[str]] = None)
    func NewConsumerGroup(ctx *Context, name string, args ConsumerGroupArgs, opts ...ResourceOption) (*ConsumerGroup, error)
    public ConsumerGroup(string name, ConsumerGroupArgs args, CustomResourceOptions? opts = null)
    public ConsumerGroup(String name, ConsumerGroupArgs args)
public ConsumerGroup(String name, ConsumerGroupArgs args, CustomResourceOptions options)

    type: volcengine:tls:ConsumerGroup
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 ConsumerGroupArgs
    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 ConsumerGroupArgs
    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 ConsumerGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConsumerGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConsumerGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var consumerGroupResource = new Volcengine.Tls.ConsumerGroup("consumerGroupResource", new()
{
    ConsumerGroupName = "string",
    HeartbeatTtl = 0,
    OrderedConsume = false,
    ProjectId = "string",
    TopicIdLists = new[]
    {
        "string",
    },
});

    example, err := tls.NewConsumerGroup(ctx, "consumerGroupResource", &tls.ConsumerGroupArgs{
	ConsumerGroupName: pulumi.String("string"),
	HeartbeatTtl:      pulumi.Int(0),
	OrderedConsume:    pulumi.Bool(false),
	ProjectId:         pulumi.String("string"),
	TopicIdLists: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var consumerGroupResource = new ConsumerGroup("consumerGroupResource", ConsumerGroupArgs.builder()
    .consumerGroupName("string")
    .heartbeatTtl(0)
    .orderedConsume(false)
    .projectId("string")
    .topicIdLists("string")
    .build());

    consumer_group_resource = volcengine.tls.ConsumerGroup("consumerGroupResource",
    consumer_group_name="string",
    heartbeat_ttl=0,
    ordered_consume=False,
    project_id="string",
    topic_id_lists=["string"])

    const consumerGroupResource = new volcengine.tls.ConsumerGroup("consumerGroupResource", {
    consumerGroupName: "string",
    heartbeatTtl: 0,
    orderedConsume: false,
    projectId: "string",
    topicIdLists: ["string"],
});

    type: volcengine:tls:ConsumerGroup
properties:
    consumerGroupName: string
    heartbeatTtl: 0
    orderedConsume: false
    projectId: string
    topicIdLists:
        - string

    ConsumerGroup 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 ConsumerGroup resource accepts the following input properties:

    ConsumerGroupName string
    The name of the consumer group.
    HeartbeatTtl int
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    OrderedConsume bool
    Whether to consume in sequence.
    ProjectId string
    The log project ID to which the consumption group belongs.
    TopicIdLists List<string>
    The list of log topic ids to be consumed by the consumer group.
    ConsumerGroupName string
    The name of the consumer group.
    HeartbeatTtl int
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    OrderedConsume bool
    Whether to consume in sequence.
    ProjectId string
    The log project ID to which the consumption group belongs.
    TopicIdLists []string
    The list of log topic ids to be consumed by the consumer group.
    consumerGroupName String
    The name of the consumer group.
    heartbeatTtl Integer
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    orderedConsume Boolean
    Whether to consume in sequence.
    projectId String
    The log project ID to which the consumption group belongs.
    topicIdLists List<String>
    The list of log topic ids to be consumed by the consumer group.
    consumerGroupName string
    The name of the consumer group.
    heartbeatTtl number
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    orderedConsume boolean
    Whether to consume in sequence.
    projectId string
    The log project ID to which the consumption group belongs.
    topicIdLists string[]
    The list of log topic ids to be consumed by the consumer group.
    consumer_group_name str
    The name of the consumer group.
    heartbeat_ttl int
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    ordered_consume bool
    Whether to consume in sequence.
    project_id str
    The log project ID to which the consumption group belongs.
    topic_id_lists Sequence[str]
    The list of log topic ids to be consumed by the consumer group.
    consumerGroupName String
    The name of the consumer group.
    heartbeatTtl Number
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    orderedConsume Boolean
    Whether to consume in sequence.
    projectId String
    The log project ID to which the consumption group belongs.
    topicIdLists List<String>
    The list of log topic ids to be consumed by the consumer group.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConsumerGroup 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 ConsumerGroup Resource

    Get an existing ConsumerGroup 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?: ConsumerGroupState, opts?: CustomResourceOptions): ConsumerGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        consumer_group_name: Optional[str] = None,
        heartbeat_ttl: Optional[int] = None,
        ordered_consume: Optional[bool] = None,
        project_id: Optional[str] = None,
        topic_id_lists: Optional[Sequence[str]] = None) -> ConsumerGroup
    func GetConsumerGroup(ctx *Context, name string, id IDInput, state *ConsumerGroupState, opts ...ResourceOption) (*ConsumerGroup, error)
    public static ConsumerGroup Get(string name, Input<string> id, ConsumerGroupState? state, CustomResourceOptions? opts = null)
    public static ConsumerGroup get(String name, Output<String> id, ConsumerGroupState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:tls:ConsumerGroup    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:
    ConsumerGroupName string
    The name of the consumer group.
    HeartbeatTtl int
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    OrderedConsume bool
    Whether to consume in sequence.
    ProjectId string
    The log project ID to which the consumption group belongs.
    TopicIdLists List<string>
    The list of log topic ids to be consumed by the consumer group.
    ConsumerGroupName string
    The name of the consumer group.
    HeartbeatTtl int
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    OrderedConsume bool
    Whether to consume in sequence.
    ProjectId string
    The log project ID to which the consumption group belongs.
    TopicIdLists []string
    The list of log topic ids to be consumed by the consumer group.
    consumerGroupName String
    The name of the consumer group.
    heartbeatTtl Integer
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    orderedConsume Boolean
    Whether to consume in sequence.
    projectId String
    The log project ID to which the consumption group belongs.
    topicIdLists List<String>
    The list of log topic ids to be consumed by the consumer group.
    consumerGroupName string
    The name of the consumer group.
    heartbeatTtl number
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    orderedConsume boolean
    Whether to consume in sequence.
    projectId string
    The log project ID to which the consumption group belongs.
    topicIdLists string[]
    The list of log topic ids to be consumed by the consumer group.
    consumer_group_name str
    The name of the consumer group.
    heartbeat_ttl int
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    ordered_consume bool
    Whether to consume in sequence.
    project_id str
    The log project ID to which the consumption group belongs.
    topic_id_lists Sequence[str]
    The list of log topic ids to be consumed by the consumer group.
    consumerGroupName String
    The name of the consumer group.
    heartbeatTtl Number
    The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
    orderedConsume Boolean
    Whether to consume in sequence.
    projectId String
    The log project ID to which the consumption group belongs.
    topicIdLists List<String>
    The list of log topic ids to be consumed by the consumer group.

    Import

    ConsumerGroup can be imported using the id, e.g.

    $ pulumi import volcengine:tls/consumerGroup:ConsumerGroup default resource_id

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.33 published on Monday, Jun 30, 2025 by Volcengine
    volcengine/pulumi-volcengine