1. Packages
  2. Volcengine
  3. API Docs
  4. tls
  5. getShards
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.tls.getShards

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of tls shards

    Example Usage

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

const default = volcengine.tls.getShards({
    topicId: "edf051ed-3c46-49ba-9339-bea628fedc15",
});

    import pulumi
import pulumi_volcengine as volcengine

default = volcengine.tls.get_shards(topic_id="edf051ed-3c46-49ba-9339-bea628fedc15")

    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.GetShards(ctx, &tls.GetShardsArgs{
			TopicId: "edf051ed-3c46-49ba-9339-bea628fedc15",
		}, 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.GetShards.Invoke(new()
    {
        TopicId = "edf051ed-3c46-49ba-9339-bea628fedc15",
    });

});

    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.GetShardsArgs;
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.getShards(GetShardsArgs.builder()
            .topicId("edf051ed-3c46-49ba-9339-bea628fedc15")
            .build());

    }
}

    variables:
  default:
    fn::invoke:
      Function: volcengine:tls:getShards
      Arguments:
        topicId: edf051ed-3c46-49ba-9339-bea628fedc15

    Using getShards

    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 getShards(args: GetShardsArgs, opts?: InvokeOptions): Promise<GetShardsResult>
function getShardsOutput(args: GetShardsOutputArgs, opts?: InvokeOptions): Output<GetShardsResult>
    def get_shards(output_file: Optional[str] = None,
               topic_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetShardsResult
def get_shards_output(output_file: Optional[pulumi.Input[str]] = None,
               topic_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetShardsResult]
    func GetShards(ctx *Context, args *GetShardsArgs, opts ...InvokeOption) (*GetShardsResult, error)
func GetShardsOutput(ctx *Context, args *GetShardsOutputArgs, opts ...InvokeOption) GetShardsResultOutput

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

    public static class GetShards 
{
    public static Task<GetShardsResult> InvokeAsync(GetShardsArgs args, InvokeOptions? opts = null)
    public static Output<GetShardsResult> Invoke(GetShardsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetShardsResult> getShards(GetShardsArgs args, InvokeOptions options)
public static Output<GetShardsResult> getShards(GetShardsArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:tls/getShards:getShards
  arguments:
    # arguments dictionary

    The following arguments are supported:

    TopicId string
    The id of topic.
    OutputFile string
    File name where to save data source results.
    TopicId string
    The id of topic.
    OutputFile string
    File name where to save data source results.
    topicId String
    The id of topic.
    outputFile String
    File name where to save data source results.
    topicId string
    The id of topic.
    outputFile string
    File name where to save data source results.
    topic_id str
    The id of topic.
    output_file str
    File name where to save data source results.
    topicId String
    The id of topic.
    outputFile String
    File name where to save data source results.

    getShards Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Shards List<GetShardsShard>
    The collection of query.
    TopicId string
    The ID of topic.
    TotalCount int
    The total count of query.
    OutputFile string
    Id string
    The provider-assigned unique ID for this managed resource.
    Shards []GetShardsShard
    The collection of query.
    TopicId string
    The ID of topic.
    TotalCount int
    The total count of query.
    OutputFile string
    id String
    The provider-assigned unique ID for this managed resource.
    shards List<GetShardsShard>
    The collection of query.
    topicId String
    The ID of topic.
    totalCount Integer
    The total count of query.
    outputFile String
    id string
    The provider-assigned unique ID for this managed resource.
    shards GetShardsShard[]
    The collection of query.
    topicId string
    The ID of topic.
    totalCount number
    The total count of query.
    outputFile string
    id str
    The provider-assigned unique ID for this managed resource.
    shards Sequence[GetShardsShard]
    The collection of query.
    topic_id str
    The ID of topic.
    total_count int
    The total count of query.
    output_file str
    id String
    The provider-assigned unique ID for this managed resource.
    shards List<Property Map>
    The collection of query.
    topicId String
    The ID of topic.
    totalCount Number
    The total count of query.
    outputFile String

    Supporting Types

    GetShardsShard

    ExclusiveEndKey string
    The end key info.
    InclusiveBeginKey string
    The begin key info.
    ModifyTime string
    The modify time.
    ShardId int
    The id of shard.
    Status string
    The status of shard.
    StopWriteTime string
    The stop write time.
    TopicId string
    The id of topic.
    ExclusiveEndKey string
    The end key info.
    InclusiveBeginKey string
    The begin key info.
    ModifyTime string
    The modify time.
    ShardId int
    The id of shard.
    Status string
    The status of shard.
    StopWriteTime string
    The stop write time.
    TopicId string
    The id of topic.
    exclusiveEndKey String
    The end key info.
    inclusiveBeginKey String
    The begin key info.
    modifyTime String
    The modify time.
    shardId Integer
    The id of shard.
    status String
    The status of shard.
    stopWriteTime String
    The stop write time.
    topicId String
    The id of topic.
    exclusiveEndKey string
    The end key info.
    inclusiveBeginKey string
    The begin key info.
    modifyTime string
    The modify time.
    shardId number
    The id of shard.
    status string
    The status of shard.
    stopWriteTime string
    The stop write time.
    topicId string
    The id of topic.
    exclusive_end_key str
    The end key info.
    inclusive_begin_key str
    The begin key info.
    modify_time str
    The modify time.
    shard_id int
    The id of shard.
    status str
    The status of shard.
    stop_write_time str
    The stop write time.
    topic_id str
    The id of topic.
    exclusiveEndKey String
    The end key info.
    inclusiveBeginKey String
    The begin key info.
    modifyTime String
    The modify time.
    shardId Number
    The id of shard.
    status String
    The status of shard.
    stopWriteTime String
    The stop write time.
    topicId String
    The id of topic.

    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.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate