1. Packages
  2. Volcengine
  3. API Docs
  4. tls
  5. Shard
Volcengine v0.0.45 published on Tuesday, Feb 10, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.tls.Shard

volcengine logo
Volcengine v0.0.45 published on Tuesday, Feb 10, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Provides a resource to manage tls shard

    Example Usage

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

const foo = new volcengine.tls.Shard("foo", {
    number: 2,
    shardId: 1,
    topicId: "176b62c7-c482-4a6e-b983-4697fda9294a",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.tls.Shard("foo",
    number=2,
    shard_id=1,
    topic_id="176b62c7-c482-4a6e-b983-4697fda9294a")

    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.NewShard(ctx, "foo", &tls.ShardArgs{
			Number:  pulumi.Int(2),
			ShardId: pulumi.Int(1),
			TopicId: pulumi.String("176b62c7-c482-4a6e-b983-4697fda9294a"),
		})
		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.Shard("foo", new()
    {
        Number = 2,
        ShardId = 1,
        TopicId = "176b62c7-c482-4a6e-b983-4697fda9294a",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.tls.Shard;
import com.pulumi.volcengine.tls.ShardArgs;
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 Shard("foo", ShardArgs.builder()        
            .number(2)
            .shardId(1)
            .topicId("176b62c7-c482-4a6e-b983-4697fda9294a")
            .build());

    }
}

    resources:
  foo:
    type: volcengine:tls:Shard
    properties:
      number: 2
      shardId: 1
      topicId: 176b62c7-c482-4a6e-b983-4697fda9294a

    Create Shard Resource

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

    Constructor syntax

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

@overload
def Shard(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          number: Optional[int] = None,
          shard_id: Optional[int] = None,
          topic_id: Optional[str] = None)
    func NewShard(ctx *Context, name string, args ShardArgs, opts ...ResourceOption) (*Shard, error)
    public Shard(string name, ShardArgs args, CustomResourceOptions? opts = null)
    public Shard(String name, ShardArgs args)
public Shard(String name, ShardArgs args, CustomResourceOptions options)

    type: volcengine:tls:Shard
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 ShardArgs
    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 ShardArgs
    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 ShardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ShardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ShardArgs
    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 shardResource = new Volcengine.Tls.Shard("shardResource", new()
{
    Number = 0,
    ShardId = 0,
    TopicId = "string",
});

    example, err := tls.NewShard(ctx, "shardResource", &tls.ShardArgs{
	Number:  pulumi.Int(0),
	ShardId: pulumi.Int(0),
	TopicId: pulumi.String("string"),
})

    var shardResource = new Shard("shardResource", ShardArgs.builder()
    .number(0)
    .shardId(0)
    .topicId("string")
    .build());

    shard_resource = volcengine.tls.Shard("shardResource",
    number=0,
    shard_id=0,
    topic_id="string")

    const shardResource = new volcengine.tls.Shard("shardResource", {
    number: 0,
    shardId: 0,
    topicId: "string",
});

    type: volcengine:tls:Shard
properties:
    number: 0
    shardId: 0
    topicId: string

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

    Number int
    The number of splits. Must be a non-zero even number, such as 2, 4, 8, or 16.
    ShardId int
    The ID of the shard to split.
    TopicId string
    The ID of the topic.
    Number int
    The number of splits. Must be a non-zero even number, such as 2, 4, 8, or 16.
    ShardId int
    The ID of the shard to split.
    TopicId string
    The ID of the topic.
    number Integer
    The number of splits. Must be a non-zero even number, such as 2, 4, 8, or 16.
    shardId Integer
    The ID of the shard to split.
    topicId String
    The ID of the topic.
    number number
    The number of splits. Must be a non-zero even number, such as 2, 4, 8, or 16.
    shardId number
    The ID of the shard to split.
    topicId string
    The ID of the topic.
    number int
    The number of splits. Must be a non-zero even number, such as 2, 4, 8, or 16.
    shard_id int
    The ID of the shard to split.
    topic_id str
    The ID of the topic.
    number Number
    The number of splits. Must be a non-zero even number, such as 2, 4, 8, or 16.
    shardId Number
    The ID of the shard to split.
    topicId String
    The ID of the topic.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Shards List<ShardShard>
    The collection of shards after split.
    Id string
    The provider-assigned unique ID for this managed resource.
    Shards []ShardShard
    The collection of shards after split.
    id String
    The provider-assigned unique ID for this managed resource.
    shards List<ShardShard>
    The collection of shards after split.
    id string
    The provider-assigned unique ID for this managed resource.
    shards ShardShard[]
    The collection of shards after split.
    id str
    The provider-assigned unique ID for this managed resource.
    shards Sequence[ShardShard]
    The collection of shards after split.
    id String
    The provider-assigned unique ID for this managed resource.
    shards List<Property Map>
    The collection of shards after split.

    Look up Existing Shard Resource

    Get an existing Shard 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?: ShardState, opts?: CustomResourceOptions): Shard
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        number: Optional[int] = None,
        shard_id: Optional[int] = None,
        shards: Optional[Sequence[ShardShardArgs]] = None,
        topic_id: Optional[str] = None) -> Shard
    func GetShard(ctx *Context, name string, id IDInput, state *ShardState, opts ...ResourceOption) (*Shard, error)
    public static Shard Get(string name, Input<string> id, ShardState? state, CustomResourceOptions? opts = null)
    public static Shard get(String name, Output<String> id, ShardState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:tls:Shard    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:
    Number int
    The number of splits. Must be a non-zero even number, such as 2, 4, 8, or 16.
    ShardId int
    The ID of the shard to split.
    Shards List<ShardShard>
    The collection of shards after split.
    TopicId string
    The ID of the topic.
    Number int
    The number of splits. Must be a non-zero even number, such as 2, 4, 8, or 16.
    ShardId int
    The ID of the shard to split.
    Shards []ShardShardArgs
    The collection of shards after split.
    TopicId string
    The ID of the topic.
    number Integer
    The number of splits. Must be a non-zero even number, such as 2, 4, 8, or 16.
    shardId Integer
    The ID of the shard to split.
    shards List<ShardShard>
    The collection of shards after split.
    topicId String
    The ID of the topic.
    number number
    The number of splits. Must be a non-zero even number, such as 2, 4, 8, or 16.
    shardId number
    The ID of the shard to split.
    shards ShardShard[]
    The collection of shards after split.
    topicId string
    The ID of the topic.
    number int
    The number of splits. Must be a non-zero even number, such as 2, 4, 8, or 16.
    shard_id int
    The ID of the shard to split.
    shards Sequence[ShardShardArgs]
    The collection of shards after split.
    topic_id str
    The ID of the topic.
    number Number
    The number of splits. Must be a non-zero even number, such as 2, 4, 8, or 16.
    shardId Number
    The ID of the shard to split.
    shards List<Property Map>
    The collection of shards after split.
    topicId String
    The ID of the topic.

    Supporting Types

    ShardShard, ShardShardArgs

    ExclusiveEndKey string
    The exclusive end key of the shard.
    InclusiveBeginKey string
    The inclusive begin key of the shard.
    ModifyTime string
    The modification time of the shard.
    ShardId int
    The ID of the shard to split.
    Status string
    The status of the shard.
    StopWriteTime string
    The stop write time of the shard.
    TopicId string
    The ID of the topic.
    ExclusiveEndKey string
    The exclusive end key of the shard.
    InclusiveBeginKey string
    The inclusive begin key of the shard.
    ModifyTime string
    The modification time of the shard.
    ShardId int
    The ID of the shard to split.
    Status string
    The status of the shard.
    StopWriteTime string
    The stop write time of the shard.
    TopicId string
    The ID of the topic.
    exclusiveEndKey String
    The exclusive end key of the shard.
    inclusiveBeginKey String
    The inclusive begin key of the shard.
    modifyTime String
    The modification time of the shard.
    shardId Integer
    The ID of the shard to split.
    status String
    The status of the shard.
    stopWriteTime String
    The stop write time of the shard.
    topicId String
    The ID of the topic.
    exclusiveEndKey string
    The exclusive end key of the shard.
    inclusiveBeginKey string
    The inclusive begin key of the shard.
    modifyTime string
    The modification time of the shard.
    shardId number
    The ID of the shard to split.
    status string
    The status of the shard.
    stopWriteTime string
    The stop write time of the shard.
    topicId string
    The ID of the topic.
    exclusive_end_key str
    The exclusive end key of the shard.
    inclusive_begin_key str
    The inclusive begin key of the shard.
    modify_time str
    The modification time of the shard.
    shard_id int
    The ID of the shard to split.
    status str
    The status of the shard.
    stop_write_time str
    The stop write time of the shard.
    topic_id str
    The ID of the topic.
    exclusiveEndKey String
    The exclusive end key of the shard.
    inclusiveBeginKey String
    The inclusive begin key of the shard.
    modifyTime String
    The modification time of the shard.
    shardId Number
    The ID of the shard to split.
    status String
    The status of the shard.
    stopWriteTime String
    The stop write time of the shard.
    topicId String
    The ID of the topic.

    Import

    The TlsShard is not support import.

    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.45 published on Tuesday, Feb 10, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate