1. Packages
  2. Volcengine
  3. API Docs
  4. tls
  5. getCheckPoints
Volcengine v0.0.45 published on Tuesday, Feb 10, 2026 by Volcengine
volcengine logo
Volcengine v0.0.45 published on Tuesday, Feb 10, 2026 by Volcengine

    Use this data source to query detailed information of tls check points

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@pulumi/volcengine";
    
    const default = volcengine.tls.getCheckPoints({
        consumerGroupName: "tf-consumer-group",
        projectId: "7a8ac13e-8e3e-4392-ae77-aea8efa49bbf",
        shardId: "0",
        topicId: "33124cc3-15c4-4cdc-9a8a-cc64a9d593dd",
    });
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    default = volcengine.tls.get_check_points(consumer_group_name="tf-consumer-group",
        project_id="7a8ac13e-8e3e-4392-ae77-aea8efa49bbf",
        shard_id="0",
        topic_id="33124cc3-15c4-4cdc-9a8a-cc64a9d593dd")
    
    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.GetCheckPoints(ctx, &tls.GetCheckPointsArgs{
    			ConsumerGroupName: pulumi.StringRef("tf-consumer-group"),
    			ProjectId:         "7a8ac13e-8e3e-4392-ae77-aea8efa49bbf",
    			ShardId:           "0",
    			TopicId:           "33124cc3-15c4-4cdc-9a8a-cc64a9d593dd",
    		}, nil)
    		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 @default = Volcengine.Tls.GetCheckPoints.Invoke(new()
        {
            ConsumerGroupName = "tf-consumer-group",
            ProjectId = "7a8ac13e-8e3e-4392-ae77-aea8efa49bbf",
            ShardId = "0",
            TopicId = "33124cc3-15c4-4cdc-9a8a-cc64a9d593dd",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.tls.TlsFunctions;
    import com.pulumi.volcengine.tls.inputs.GetCheckPointsArgs;
    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) {
            final var default = TlsFunctions.getCheckPoints(GetCheckPointsArgs.builder()
                .consumerGroupName("tf-consumer-group")
                .projectId("7a8ac13e-8e3e-4392-ae77-aea8efa49bbf")
                .shardId("0")
                .topicId("33124cc3-15c4-4cdc-9a8a-cc64a9d593dd")
                .build());
    
        }
    }
    
    variables:
      default:
        fn::invoke:
          Function: volcengine:tls:getCheckPoints
          Arguments:
            consumerGroupName: tf-consumer-group
            projectId: 7a8ac13e-8e3e-4392-ae77-aea8efa49bbf
            shardId: '0'
            topicId: 33124cc3-15c4-4cdc-9a8a-cc64a9d593dd
    

    Using getCheckPoints

    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 getCheckPoints(args: GetCheckPointsArgs, opts?: InvokeOptions): Promise<GetCheckPointsResult>
    function getCheckPointsOutput(args: GetCheckPointsOutputArgs, opts?: InvokeOptions): Output<GetCheckPointsResult>
    def get_check_points(consumer_group_name: Optional[str] = None,
                         output_file: Optional[str] = None,
                         project_id: Optional[str] = None,
                         shard_id: Optional[str] = None,
                         topic_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetCheckPointsResult
    def get_check_points_output(consumer_group_name: Optional[pulumi.Input[str]] = None,
                         output_file: Optional[pulumi.Input[str]] = None,
                         project_id: Optional[pulumi.Input[str]] = None,
                         shard_id: Optional[pulumi.Input[str]] = None,
                         topic_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetCheckPointsResult]
    func GetCheckPoints(ctx *Context, args *GetCheckPointsArgs, opts ...InvokeOption) (*GetCheckPointsResult, error)
    func GetCheckPointsOutput(ctx *Context, args *GetCheckPointsOutputArgs, opts ...InvokeOption) GetCheckPointsResultOutput

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

    public static class GetCheckPoints 
    {
        public static Task<GetCheckPointsResult> InvokeAsync(GetCheckPointsArgs args, InvokeOptions? opts = null)
        public static Output<GetCheckPointsResult> Invoke(GetCheckPointsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCheckPointsResult> getCheckPoints(GetCheckPointsArgs args, InvokeOptions options)
    public static Output<GetCheckPointsResult> getCheckPoints(GetCheckPointsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcengine:tls/getCheckPoints:getCheckPoints
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ProjectId string
    The ID of the project.
    ShardId string
    The ID of the shard.
    TopicId string
    The ID of the topic.
    ConsumerGroupName string
    The name of the consumer group.
    OutputFile string
    File name where to save data source results.
    ProjectId string
    The ID of the project.
    ShardId string
    The ID of the shard.
    TopicId string
    The ID of the topic.
    ConsumerGroupName string
    The name of the consumer group.
    OutputFile string
    File name where to save data source results.
    projectId String
    The ID of the project.
    shardId String
    The ID of the shard.
    topicId String
    The ID of the topic.
    consumerGroupName String
    The name of the consumer group.
    outputFile String
    File name where to save data source results.
    projectId string
    The ID of the project.
    shardId string
    The ID of the shard.
    topicId string
    The ID of the topic.
    consumerGroupName string
    The name of the consumer group.
    outputFile string
    File name where to save data source results.
    project_id str
    The ID of the project.
    shard_id str
    The ID of the shard.
    topic_id str
    The ID of the topic.
    consumer_group_name str
    The name of the consumer group.
    output_file str
    File name where to save data source results.
    projectId String
    The ID of the project.
    shardId String
    The ID of the shard.
    topicId String
    The ID of the topic.
    consumerGroupName String
    The name of the consumer group.
    outputFile String
    File name where to save data source results.

    getCheckPoints Result

    The following output properties are available:

    CheckPoints List<GetCheckPointsCheckPoint>
    The list of checkpoints.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    ShardId string
    The ID of the shard.
    TopicId string
    ConsumerGroupName string
    OutputFile string
    CheckPoints []GetCheckPointsCheckPoint
    The list of checkpoints.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    ShardId string
    The ID of the shard.
    TopicId string
    ConsumerGroupName string
    OutputFile string
    checkPoints List<GetCheckPointsCheckPoint>
    The list of checkpoints.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    shardId String
    The ID of the shard.
    topicId String
    consumerGroupName String
    outputFile String
    checkPoints GetCheckPointsCheckPoint[]
    The list of checkpoints.
    id string
    The provider-assigned unique ID for this managed resource.
    projectId string
    shardId string
    The ID of the shard.
    topicId string
    consumerGroupName string
    outputFile string
    check_points Sequence[GetCheckPointsCheckPoint]
    The list of checkpoints.
    id str
    The provider-assigned unique ID for this managed resource.
    project_id str
    shard_id str
    The ID of the shard.
    topic_id str
    consumer_group_name str
    output_file str
    checkPoints List<Property Map>
    The list of checkpoints.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    shardId String
    The ID of the shard.
    topicId String
    consumerGroupName String
    outputFile String

    Supporting Types

    GetCheckPointsCheckPoint

    Checkpoint string
    The checkpoint value.
    ShardId int
    The ID of the shard.
    Checkpoint string
    The checkpoint value.
    ShardId int
    The ID of the shard.
    checkpoint String
    The checkpoint value.
    shardId Integer
    The ID of the shard.
    checkpoint string
    The checkpoint value.
    shardId number
    The ID of the shard.
    checkpoint str
    The checkpoint value.
    shard_id int
    The ID of the shard.
    checkpoint String
    The checkpoint value.
    shardId Number
    The ID of the shard.

    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.45 published on Tuesday, Feb 10, 2026 by Volcengine
      Meet Neo: Your AI Platform Teammate