1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. tls
  5. Topic
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.tls.Topic

bytepluscc logo
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Log topic is the basic unit for log management in the log service. Log ingestion, search and analysis, and consumption are all performed at the log topic level.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as bytepluscc from "@byteplus/pulumi-bytepluscc";

const tlsTopicDemo = new bytepluscc.tls.Topic("TlsTopicDemo", {
    ttl: 187,
    hotTtl: 8,
    coldTtl: 79,
    archiveTtl: 100,
    shardCount: 2,
    autoSplit: true,
    maxSplitShard: 256,
    tags: [{
        key: "env",
        value: "test",
    }],
    timeKey: "time",
    timeFormat: "%Y-%m-%d %H:%M:%S",
    logPublicIp: false,
    topicName: "ccapi-test",
    description: "test",
    projectId: "c6fef4c1-041f-434e-b0f4-d5e9*****",
    enableHotTtl: false,
    allowConsume: false,
});

    import pulumi
import pulumi_bytepluscc as bytepluscc

tls_topic_demo = bytepluscc.tls.Topic("TlsTopicDemo",
    ttl=187,
    hot_ttl=8,
    cold_ttl=79,
    archive_ttl=100,
    shard_count=2,
    auto_split=True,
    max_split_shard=256,
    tags=[{
        "key": "env",
        "value": "test",
    }],
    time_key="time",
    time_format="%Y-%m-%d %H:%M:%S",
    log_public_ip=False,
    topic_name="ccapi-test",
    description="test",
    project_id="c6fef4c1-041f-434e-b0f4-d5e9*****",
    enable_hot_ttl=False,
    allow_consume=False)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tls.NewTopic(ctx, "TlsTopicDemo", &tls.TopicArgs{
			Ttl:           pulumi.Int(187),
			HotTtl:        pulumi.Int(8),
			ColdTtl:       pulumi.Int(79),
			ArchiveTtl:    pulumi.Int(100),
			ShardCount:    pulumi.Int(2),
			AutoSplit:     pulumi.Bool(true),
			MaxSplitShard: pulumi.Int(256),
			Tags: tls.TopicTagArray{
				&tls.TopicTagArgs{
					Key:   pulumi.String("env"),
					Value: pulumi.String("test"),
				},
			},
			TimeKey:      pulumi.String("time"),
			TimeFormat:   pulumi.String("%Y-%m-%d %H:%M:%S"),
			LogPublicIp:  pulumi.Bool(false),
			TopicName:    pulumi.String("ccapi-test"),
			Description:  pulumi.String("test"),
			ProjectId:    pulumi.String("c6fef4c1-041f-434e-b0f4-d5e9*****"),
			EnableHotTtl: pulumi.Bool(false),
			AllowConsume: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Bytepluscc = Byteplus.Pulumi.Bytepluscc;

return await Deployment.RunAsync(() => 
{
    var tlsTopicDemo = new Bytepluscc.Tls.Topic("TlsTopicDemo", new()
    {
        Ttl = 187,
        HotTtl = 8,
        ColdTtl = 79,
        ArchiveTtl = 100,
        ShardCount = 2,
        AutoSplit = true,
        MaxSplitShard = 256,
        Tags = new[]
        {
            new Bytepluscc.Tls.Inputs.TopicTagArgs
            {
                Key = "env",
                Value = "test",
            },
        },
        TimeKey = "time",
        TimeFormat = "%Y-%m-%d %H:%M:%S",
        LogPublicIp = false,
        TopicName = "ccapi-test",
        Description = "test",
        ProjectId = "c6fef4c1-041f-434e-b0f4-d5e9*****",
        EnableHotTtl = false,
        AllowConsume = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.byteplus.bytepluscc.tls.Topic;
import com.byteplus.bytepluscc.tls.TopicArgs;
import com.pulumi.bytepluscc.tls.inputs.TopicTagArgs;
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 tlsTopicDemo = new Topic("tlsTopicDemo", TopicArgs.builder()
            .ttl(187)
            .hotTtl(8)
            .coldTtl(79)
            .archiveTtl(100)
            .shardCount(2)
            .autoSplit(true)
            .maxSplitShard(256)
            .tags(TopicTagArgs.builder()
                .key("env")
                .value("test")
                .build())
            .timeKey("time")
            .timeFormat("%Y-%m-%d %H:%M:%S")
            .logPublicIp(false)
            .topicName("ccapi-test")
            .description("test")
            .projectId("c6fef4c1-041f-434e-b0f4-d5e9*****")
            .enableHotTtl(false)
            .allowConsume(false)
            .build());

    }
}

    resources:
  tlsTopicDemo:
    type: bytepluscc:tls:Topic
    name: TlsTopicDemo
    properties:
      ttl: 187
      hotTtl: 8
      coldTtl: 79
      archiveTtl: 100
      shardCount: 2
      autoSplit: true
      maxSplitShard: 256
      tags:
        - key: env
          value: test
      timeKey: time
      timeFormat: '%Y-%m-%d %H:%M:%S'
      logPublicIp: false
      topicName: ccapi-test
      description: test
      projectId: c6fef4c1-041f-434e-b0f4-d5e9*****
      enableHotTtl: false
      allowConsume: false

    Create Topic Resource

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

    Constructor syntax

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

@overload
def Topic(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          project_id: Optional[str] = None,
          topic_name: Optional[str] = None,
          shard_count: Optional[int] = None,
          log_public_ip: Optional[bool] = None,
          cold_ttl: Optional[int] = None,
          enable_hot_ttl: Optional[bool] = None,
          enable_tracking: Optional[bool] = None,
          hot_ttl: Optional[int] = None,
          allow_consume: Optional[bool] = None,
          max_split_shard: Optional[int] = None,
          description: Optional[str] = None,
          auto_split: Optional[bool] = None,
          tags: Optional[Sequence[TopicTagArgs]] = None,
          time_format: Optional[str] = None,
          time_key: Optional[str] = None,
          archive_ttl: Optional[int] = None,
          ttl: Optional[int] = None)
    func NewTopic(ctx *Context, name string, args TopicArgs, opts ...ResourceOption) (*Topic, error)
    public Topic(string name, TopicArgs args, CustomResourceOptions? opts = null)
    public Topic(String name, TopicArgs args)
public Topic(String name, TopicArgs args, CustomResourceOptions options)

    type: bytepluscc:tls:Topic
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 TopicArgs
    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 TopicArgs
    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 TopicArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TopicArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TopicArgs
    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 byteplusccTopicResource = new Bytepluscc.Tls.Topic("byteplusccTopicResource", new()
{
    ProjectId = "string",
    TopicName = "string",
    ShardCount = 0,
    LogPublicIp = false,
    ColdTtl = 0,
    EnableHotTtl = false,
    EnableTracking = false,
    HotTtl = 0,
    AllowConsume = false,
    MaxSplitShard = 0,
    Description = "string",
    AutoSplit = false,
    Tags = new[]
    {
        new Bytepluscc.Tls.Inputs.TopicTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    TimeFormat = "string",
    TimeKey = "string",
    ArchiveTtl = 0,
    Ttl = 0,
});

    example, err := tls.NewTopic(ctx, "byteplusccTopicResource", &tls.TopicArgs{
	ProjectId:      pulumi.String("string"),
	TopicName:      pulumi.String("string"),
	ShardCount:     pulumi.Int(0),
	LogPublicIp:    pulumi.Bool(false),
	ColdTtl:        pulumi.Int(0),
	EnableHotTtl:   pulumi.Bool(false),
	EnableTracking: pulumi.Bool(false),
	HotTtl:         pulumi.Int(0),
	AllowConsume:   pulumi.Bool(false),
	MaxSplitShard:  pulumi.Int(0),
	Description:    pulumi.String("string"),
	AutoSplit:      pulumi.Bool(false),
	Tags: tls.TopicTagArray{
		&tls.TopicTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	TimeFormat: pulumi.String("string"),
	TimeKey:    pulumi.String("string"),
	ArchiveTtl: pulumi.Int(0),
	Ttl:        pulumi.Int(0),
})

    var byteplusccTopicResource = new com.byteplus.bytepluscc.tls.Topic("byteplusccTopicResource", com.byteplus.bytepluscc.tls.TopicArgs.builder()
    .projectId("string")
    .topicName("string")
    .shardCount(0)
    .logPublicIp(false)
    .coldTtl(0)
    .enableHotTtl(false)
    .enableTracking(false)
    .hotTtl(0)
    .allowConsume(false)
    .maxSplitShard(0)
    .description("string")
    .autoSplit(false)
    .tags(TopicTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .timeFormat("string")
    .timeKey("string")
    .archiveTtl(0)
    .ttl(0)
    .build());

    bytepluscc_topic_resource = bytepluscc.tls.Topic("byteplusccTopicResource",
    project_id="string",
    topic_name="string",
    shard_count=0,
    log_public_ip=False,
    cold_ttl=0,
    enable_hot_ttl=False,
    enable_tracking=False,
    hot_ttl=0,
    allow_consume=False,
    max_split_shard=0,
    description="string",
    auto_split=False,
    tags=[{
        "key": "string",
        "value": "string",
    }],
    time_format="string",
    time_key="string",
    archive_ttl=0,
    ttl=0)

    const byteplusccTopicResource = new bytepluscc.tls.Topic("byteplusccTopicResource", {
    projectId: "string",
    topicName: "string",
    shardCount: 0,
    logPublicIp: false,
    coldTtl: 0,
    enableHotTtl: false,
    enableTracking: false,
    hotTtl: 0,
    allowConsume: false,
    maxSplitShard: 0,
    description: "string",
    autoSplit: false,
    tags: [{
        key: "string",
        value: "string",
    }],
    timeFormat: "string",
    timeKey: "string",
    archiveTtl: 0,
    ttl: 0,
});

    type: bytepluscc:tls:Topic
properties:
    allowConsume: false
    archiveTtl: 0
    autoSplit: false
    coldTtl: 0
    description: string
    enableHotTtl: false
    enableTracking: false
    hotTtl: 0
    logPublicIp: false
    maxSplitShard: 0
    projectId: string
    shardCount: 0
    tags:
        - key: string
          value: string
    timeFormat: string
    timeKey: string
    topicName: string
    ttl: 0

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

    ProjectId string
    Log project ID to which the log topic belongs.
    ShardCount int
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    TopicName string
    Log topic name.
    AllowConsume bool
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    ArchiveTtl int
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    AutoSplit bool
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    ColdTtl int
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    Description string
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    EnableHotTtl bool
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    EnableTracking bool
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    HotTtl int
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    LogPublicIp bool
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    MaxSplitShard int
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    Tags List<Byteplus.TopicTag>
    TimeFormat string
    Time format
    TimeKey string
    Time field name
    Ttl int
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.
    ProjectId string
    Log project ID to which the log topic belongs.
    ShardCount int
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    TopicName string
    Log topic name.
    AllowConsume bool
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    ArchiveTtl int
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    AutoSplit bool
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    ColdTtl int
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    Description string
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    EnableHotTtl bool
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    EnableTracking bool
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    HotTtl int
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    LogPublicIp bool
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    MaxSplitShard int
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    Tags []TopicTagArgs
    TimeFormat string
    Time format
    TimeKey string
    Time field name
    Ttl int
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.
    projectId String
    Log project ID to which the log topic belongs.
    shardCount Integer
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    topicName String
    Log topic name.
    allowConsume Boolean
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    archiveTtl Integer
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    autoSplit Boolean
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    coldTtl Integer
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    description String
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    enableHotTtl Boolean
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    enableTracking Boolean
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    hotTtl Integer
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    logPublicIp Boolean
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    maxSplitShard Integer
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    tags List<TopicTag>
    timeFormat String
    Time format
    timeKey String
    Time field name
    ttl Integer
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.
    projectId string
    Log project ID to which the log topic belongs.
    shardCount number
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    topicName string
    Log topic name.
    allowConsume boolean
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    archiveTtl number
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    autoSplit boolean
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    coldTtl number
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    description string
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    enableHotTtl boolean
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    enableTracking boolean
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    hotTtl number
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    logPublicIp boolean
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    maxSplitShard number
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    tags TopicTag[]
    timeFormat string
    Time format
    timeKey string
    Time field name
    ttl number
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.
    project_id str
    Log project ID to which the log topic belongs.
    shard_count int
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    topic_name str
    Log topic name.
    allow_consume bool
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    archive_ttl int
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    auto_split bool
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    cold_ttl int
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    description str
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    enable_hot_ttl bool
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    enable_tracking bool
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    hot_ttl int
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    log_public_ip bool
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    max_split_shard int
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    tags Sequence[TopicTagArgs]
    time_format str
    Time format
    time_key str
    Time field name
    ttl int
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.
    projectId String
    Log project ID to which the log topic belongs.
    shardCount Number
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    topicName String
    Log topic name.
    allowConsume Boolean
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    archiveTtl Number
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    autoSplit Boolean
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    coldTtl Number
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    description String
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    enableHotTtl Boolean
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    enableTracking Boolean
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    hotTtl Number
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    logPublicIp Boolean
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    maxSplitShard Number
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    tags List<Property Map>
    timeFormat String
    Time format
    timeKey String
    Time field name
    ttl Number
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.

    Outputs

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

    ConsumeTopic string
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    CreatedTime string
    Log topic creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    TopicId string
    Log topic ID.
    UpdatedTime string
    Log topic modification time.
    ConsumeTopic string
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    CreatedTime string
    Log topic creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    TopicId string
    Log topic ID.
    UpdatedTime string
    Log topic modification time.
    consumeTopic String
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    createdTime String
    Log topic creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    topicId String
    Log topic ID.
    updatedTime String
    Log topic modification time.
    consumeTopic string
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    createdTime string
    Log topic creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    topicId string
    Log topic ID.
    updatedTime string
    Log topic modification time.
    consume_topic str
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    created_time str
    Log topic creation time.
    id str
    The provider-assigned unique ID for this managed resource.
    topic_id str
    Log topic ID.
    updated_time str
    Log topic modification time.
    consumeTopic String
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    createdTime String
    Log topic creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    topicId String
    Log topic ID.
    updatedTime String
    Log topic modification time.

    Look up Existing Topic Resource

    Get an existing Topic 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?: TopicState, opts?: CustomResourceOptions): Topic
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_consume: Optional[bool] = None,
        archive_ttl: Optional[int] = None,
        auto_split: Optional[bool] = None,
        cold_ttl: Optional[int] = None,
        consume_topic: Optional[str] = None,
        created_time: Optional[str] = None,
        description: Optional[str] = None,
        enable_hot_ttl: Optional[bool] = None,
        enable_tracking: Optional[bool] = None,
        hot_ttl: Optional[int] = None,
        log_public_ip: Optional[bool] = None,
        max_split_shard: Optional[int] = None,
        project_id: Optional[str] = None,
        shard_count: Optional[int] = None,
        tags: Optional[Sequence[TopicTagArgs]] = None,
        time_format: Optional[str] = None,
        time_key: Optional[str] = None,
        topic_id: Optional[str] = None,
        topic_name: Optional[str] = None,
        ttl: Optional[int] = None,
        updated_time: Optional[str] = None) -> Topic
    func GetTopic(ctx *Context, name string, id IDInput, state *TopicState, opts ...ResourceOption) (*Topic, error)
    public static Topic Get(string name, Input<string> id, TopicState? state, CustomResourceOptions? opts = null)
    public static Topic get(String name, Output<String> id, TopicState state, CustomResourceOptions options)
    resources:  _:    type: bytepluscc:tls:Topic    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:
    AllowConsume bool
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    ArchiveTtl int
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    AutoSplit bool
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    ColdTtl int
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    ConsumeTopic string
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    CreatedTime string
    Log topic creation time.
    Description string
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    EnableHotTtl bool
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    EnableTracking bool
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    HotTtl int
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    LogPublicIp bool
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    MaxSplitShard int
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    ProjectId string
    Log project ID to which the log topic belongs.
    ShardCount int
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    Tags List<Byteplus.TopicTag>
    TimeFormat string
    Time format
    TimeKey string
    Time field name
    TopicId string
    Log topic ID.
    TopicName string
    Log topic name.
    Ttl int
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.
    UpdatedTime string
    Log topic modification time.
    AllowConsume bool
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    ArchiveTtl int
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    AutoSplit bool
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    ColdTtl int
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    ConsumeTopic string
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    CreatedTime string
    Log topic creation time.
    Description string
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    EnableHotTtl bool
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    EnableTracking bool
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    HotTtl int
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    LogPublicIp bool
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    MaxSplitShard int
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    ProjectId string
    Log project ID to which the log topic belongs.
    ShardCount int
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    Tags []TopicTagArgs
    TimeFormat string
    Time format
    TimeKey string
    Time field name
    TopicId string
    Log topic ID.
    TopicName string
    Log topic name.
    Ttl int
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.
    UpdatedTime string
    Log topic modification time.
    allowConsume Boolean
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    archiveTtl Integer
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    autoSplit Boolean
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    coldTtl Integer
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    consumeTopic String
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    createdTime String
    Log topic creation time.
    description String
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    enableHotTtl Boolean
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    enableTracking Boolean
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    hotTtl Integer
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    logPublicIp Boolean
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    maxSplitShard Integer
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    projectId String
    Log project ID to which the log topic belongs.
    shardCount Integer
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    tags List<TopicTag>
    timeFormat String
    Time format
    timeKey String
    Time field name
    topicId String
    Log topic ID.
    topicName String
    Log topic name.
    ttl Integer
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.
    updatedTime String
    Log topic modification time.
    allowConsume boolean
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    archiveTtl number
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    autoSplit boolean
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    coldTtl number
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    consumeTopic string
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    createdTime string
    Log topic creation time.
    description string
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    enableHotTtl boolean
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    enableTracking boolean
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    hotTtl number
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    logPublicIp boolean
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    maxSplitShard number
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    projectId string
    Log project ID to which the log topic belongs.
    shardCount number
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    tags TopicTag[]
    timeFormat string
    Time format
    timeKey string
    Time field name
    topicId string
    Log topic ID.
    topicName string
    Log topic name.
    ttl number
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.
    updatedTime string
    Log topic modification time.
    allow_consume bool
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    archive_ttl int
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    auto_split bool
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    cold_ttl int
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    consume_topic str
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    created_time str
    Log topic creation time.
    description str
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    enable_hot_ttl bool
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    enable_tracking bool
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    hot_ttl int
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    log_public_ip bool
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    max_split_shard int
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    project_id str
    Log project ID to which the log topic belongs.
    shard_count int
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    tags Sequence[TopicTagArgs]
    time_format str
    Time format
    time_key str
    Time field name
    topic_id str
    Log topic ID.
    topic_name str
    Log topic name.
    ttl int
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.
    updated_time str
    Log topic modification time.
    allowConsume Boolean
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    archiveTtl Number
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    autoSplit Boolean
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    coldTtl Number
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    consumeTopic String
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    createdTime String
    Log topic creation time.
    description String
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    enableHotTtl Boolean
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    enableTracking Boolean
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    hotTtl Number
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    logPublicIp Boolean
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    maxSplitShard Number
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    projectId String
    Log project ID to which the log topic belongs.
    shardCount Number
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    tags List<Property Map>
    timeFormat String
    Time format
    timeKey String
    Time field name
    topicId String
    Log topic ID.
    topicName String
    Log topic name.
    ttl Number
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.
    updatedTime String
    Log topic modification time.

    Supporting Types

    TopicTag, TopicTagArgs

    Key string
    User tag key.
    Value string
    User tag value.
    Key string
    User tag key.
    Value string
    User tag value.
    key String
    User tag key.
    value String
    User tag value.
    key string
    User tag key.
    value string
    User tag value.
    key str
    User tag key.
    value str
    User tag value.
    key String
    User tag key.
    value String
    User tag value.

    Import

    $ pulumi import bytepluscc:tls/topic:Topic example "topic_id"

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

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.21
    published on Thursday, Apr 2, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.