getTopics

Volcengine v0.0.46, Feb 27 26

Viewing docs for Volcengine v0.0.46
published on Friday, Feb 27, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

Viewing docs for Volcengine v0.0.46
published on Friday, Feb 27, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

Example Usage

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

const default = volcengine.tls.getTopics({
    projectId: "bdb87e4d-7dad-4b96-ac43-e1b09e9dc8ac",
    topicId: "9b756385-1dfb-4306-a094-0c88e04b34a5",
});

import pulumi
import pulumi_volcengine as volcengine

default = volcengine.tls.get_topics(project_id="bdb87e4d-7dad-4b96-ac43-e1b09e9dc8ac",
    topic_id="9b756385-1dfb-4306-a094-0c88e04b34a5")

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.GetTopics(ctx, &tls.GetTopicsArgs{
			ProjectId: "bdb87e4d-7dad-4b96-ac43-e1b09e9dc8ac",
			TopicId:   pulumi.StringRef("9b756385-1dfb-4306-a094-0c88e04b34a5"),
		}, 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.GetTopics.Invoke(new()
    {
        ProjectId = "bdb87e4d-7dad-4b96-ac43-e1b09e9dc8ac",
        TopicId = "9b756385-1dfb-4306-a094-0c88e04b34a5",
    });

});

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.GetTopicsArgs;
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.getTopics(GetTopicsArgs.builder()
            .projectId("bdb87e4d-7dad-4b96-ac43-e1b09e9dc8ac")
            .topicId("9b756385-1dfb-4306-a094-0c88e04b34a5")
            .build());

    }
}

variables:
  default:
    fn::invoke:
      Function: volcengine:tls:getTopics
      Arguments:
        projectId: bdb87e4d-7dad-4b96-ac43-e1b09e9dc8ac
        topicId: 9b756385-1dfb-4306-a094-0c88e04b34a5

Using getTopics

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 getTopics(args: GetTopicsArgs, opts?: InvokeOptions): Promise<GetTopicsResult>
function getTopicsOutput(args: GetTopicsOutputArgs, opts?: InvokeOptions): Output<GetTopicsResult>

def get_topics(name_regex: Optional[str] = None,
               output_file: Optional[str] = None,
               project_id: Optional[str] = None,
               tags: Optional[Sequence[GetTopicsTag]] = None,
               topic_id: Optional[str] = None,
               topic_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetTopicsResult
def get_topics_output(name_regex: Optional[pulumi.Input[str]] = None,
               output_file: Optional[pulumi.Input[str]] = None,
               project_id: Optional[pulumi.Input[str]] = None,
               tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetTopicsTagArgs]]]] = None,
               topic_id: Optional[pulumi.Input[str]] = None,
               topic_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetTopicsResult]

func GetTopics(ctx *Context, args *GetTopicsArgs, opts ...InvokeOption) (*GetTopicsResult, error)
func GetTopicsOutput(ctx *Context, args *GetTopicsOutputArgs, opts ...InvokeOption) GetTopicsResultOutput

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

public static class GetTopics 
{
    public static Task<GetTopicsResult> InvokeAsync(GetTopicsArgs args, InvokeOptions? opts = null)
    public static Output<GetTopicsResult> Invoke(GetTopicsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTopicsResult> getTopics(GetTopicsArgs args, InvokeOptions options)
public static Output<GetTopicsResult> getTopics(GetTopicsArgs args, InvokeOptions options)

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

The following arguments are supported:

ProjectId string: The project id of tls topic.
NameRegex string: A Name Regex of tls topic.
OutputFile string: File name where to save data source results.
Tags List<GetTopicsTag>: Tags.
TopicId string: The id of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
TopicName string: The name of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.

ProjectId string: The project id of tls topic.
NameRegex string: A Name Regex of tls topic.
OutputFile string: File name where to save data source results.
Tags []GetTopicsTag: Tags.
TopicId string: The id of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
TopicName string: The name of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.

projectId String: The project id of tls topic.
nameRegex String: A Name Regex of tls topic.
outputFile String: File name where to save data source results.
tags List<GetTopicsTag>: Tags.
topicId String: The id of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
topicName String: The name of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.

projectId string: The project id of tls topic.
nameRegex string: A Name Regex of tls topic.
outputFile string: File name where to save data source results.
tags GetTopicsTag[]: Tags.
topicId string: The id of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
topicName string: The name of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.

project_id str: The project id of tls topic.
name_regex str: A Name Regex of tls topic.
output_file str: File name where to save data source results.
tags Sequence[GetTopicsTag]: Tags.
topic_id str: The id of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
topic_name str: The name of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.

projectId String: The project id of tls topic.
nameRegex String: A Name Regex of tls topic.
outputFile String: File name where to save data source results.
tags List<Property Map>: Tags.
topicId String: The id of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
topicName String: The name of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.

getTopics Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
ProjectId string: The project id of the tls topic.
TlsTopics List<GetTopicsTlsTopic>: The collection of tls topic query.
TotalCount int: The total count of tls topic query.
NameRegex string
OutputFile string
Tags List<GetTopicsTag>: Tags.
TopicId string: The ID of the tls topic.
TopicName string: The name of the tls topic.

Id string: The provider-assigned unique ID for this managed resource.
ProjectId string: The project id of the tls topic.
TlsTopics []GetTopicsTlsTopic: The collection of tls topic query.
TotalCount int: The total count of tls topic query.
NameRegex string
OutputFile string
Tags []GetTopicsTag: Tags.
TopicId string: The ID of the tls topic.
TopicName string: The name of the tls topic.

id String: The provider-assigned unique ID for this managed resource.
projectId String: The project id of the tls topic.
tlsTopics List<GetTopicsTlsTopic>: The collection of tls topic query.
totalCount Integer: The total count of tls topic query.
nameRegex String
outputFile String
tags List<GetTopicsTag>: Tags.
topicId String: The ID of the tls topic.
topicName String: The name of the tls topic.

id string: The provider-assigned unique ID for this managed resource.
projectId string: The project id of the tls topic.
tlsTopics GetTopicsTlsTopic[]: The collection of tls topic query.
totalCount number: The total count of tls topic query.
nameRegex string
outputFile string
tags GetTopicsTag[]: Tags.
topicId string: The ID of the tls topic.
topicName string: The name of the tls topic.

id str: The provider-assigned unique ID for this managed resource.
project_id str: The project id of the tls topic.
tls_topics Sequence[GetTopicsTlsTopic]: The collection of tls topic query.
total_count int: The total count of tls topic query.
name_regex str
output_file str
tags Sequence[GetTopicsTag]: Tags.
topic_id str: The ID of the tls topic.
topic_name str: The name of the tls topic.

id String: The provider-assigned unique ID for this managed resource.
projectId String: The project id of the tls topic.
tlsTopics List<Property Map>: The collection of tls topic query.
totalCount Number: The total count of tls topic query.
nameRegex String
outputFile String
tags List<Property Map>: Tags.
topicId String: The ID of the tls topic.
topicName String: The name of the tls topic.

Supporting Types

GetTopicsTag

Key string: The Key of Tags.
Value string: The Value of Tags.

Key string: The Key of Tags.
Value string: The Value of Tags.

key String: The Key of Tags.
value String: The Value of Tags.

key string: The Key of Tags.
value string: The Value of Tags.

key str: The Key of Tags.
value str: The Value of Tags.

key String: The Key of Tags.
value String: The Value of Tags.

GetTopicsTlsTopic

ArchiveTtl int: Archive storage duration, valid when enable_hot_ttl is true.
AutoSplit bool: Whether to enable automatic partition splitting function of the tls topic.
ColdTtl int: Infrequent storage duration, valid when enable_hot_ttl is true.
CreateTime string: The create time of the tls topic.
Description string: The description of the tls topic.
EnableHotTtl bool: Whether to enable tiered storage.
EnableTracking bool: Whether to enable WebTracking function of the tls topic.
EncryptConf GetTopicsTlsTopicEncryptConf: Data encryption configuration.
HotTtl int: Standard storage duration, valid when enable_hot_ttl is true.
Id string: The ID of the tls topic.
LogPublicIp bool: Whether to enable the function of recording public IP.
MaxSplitShard int: The max count of shards in the tls topic.
ModifyTime string: The modify time of the tls topic.
ProjectId string: The project id of tls topic.
ShardCount int: The count of shards in the tls topic.
Tags List<GetTopicsTlsTopicTag>: Tags.
TimeFormat string: The format of the time field.
TimeKey string: The name of the time field.
TopicId string: The id of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
TopicName string: The name of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
Ttl int: The data storage time of the tls topic. Unit: Day.

ArchiveTtl int: Archive storage duration, valid when enable_hot_ttl is true.
AutoSplit bool: Whether to enable automatic partition splitting function of the tls topic.
ColdTtl int: Infrequent storage duration, valid when enable_hot_ttl is true.
CreateTime string: The create time of the tls topic.
Description string: The description of the tls topic.
EnableHotTtl bool: Whether to enable tiered storage.
EnableTracking bool: Whether to enable WebTracking function of the tls topic.
EncryptConf GetTopicsTlsTopicEncryptConf: Data encryption configuration.
HotTtl int: Standard storage duration, valid when enable_hot_ttl is true.
Id string: The ID of the tls topic.
LogPublicIp bool: Whether to enable the function of recording public IP.
MaxSplitShard int: The max count of shards in the tls topic.
ModifyTime string: The modify time of the tls topic.
ProjectId string: The project id of tls topic.
ShardCount int: The count of shards in the tls topic.
Tags []GetTopicsTlsTopicTag: Tags.
TimeFormat string: The format of the time field.
TimeKey string: The name of the time field.
TopicId string: The id of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
TopicName string: The name of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
Ttl int: The data storage time of the tls topic. Unit: Day.

archiveTtl Integer: Archive storage duration, valid when enable_hot_ttl is true.
autoSplit Boolean: Whether to enable automatic partition splitting function of the tls topic.
coldTtl Integer: Infrequent storage duration, valid when enable_hot_ttl is true.
createTime String: The create time of the tls topic.
description String: The description of the tls topic.
enableHotTtl Boolean: Whether to enable tiered storage.
enableTracking Boolean: Whether to enable WebTracking function of the tls topic.
encryptConf GetTopicsTlsTopicEncryptConf: Data encryption configuration.
hotTtl Integer: Standard storage duration, valid when enable_hot_ttl is true.
id String: The ID of the tls topic.
logPublicIp Boolean: Whether to enable the function of recording public IP.
maxSplitShard Integer: The max count of shards in the tls topic.
modifyTime String: The modify time of the tls topic.
projectId String: The project id of tls topic.
shardCount Integer: The count of shards in the tls topic.
tags List<GetTopicsTlsTopicTag>: Tags.
timeFormat String: The format of the time field.
timeKey String: The name of the time field.
topicId String: The id of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
topicName String: The name of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
ttl Integer: The data storage time of the tls topic. Unit: Day.

archiveTtl number: Archive storage duration, valid when enable_hot_ttl is true.
autoSplit boolean: Whether to enable automatic partition splitting function of the tls topic.
coldTtl number: Infrequent storage duration, valid when enable_hot_ttl is true.
createTime string: The create time of the tls topic.
description string: The description of the tls topic.
enableHotTtl boolean: Whether to enable tiered storage.
enableTracking boolean: Whether to enable WebTracking function of the tls topic.
encryptConf GetTopicsTlsTopicEncryptConf: Data encryption configuration.
hotTtl number: Standard storage duration, valid when enable_hot_ttl is true.
id string: The ID of the tls topic.
logPublicIp boolean: Whether to enable the function of recording public IP.
maxSplitShard number: The max count of shards in the tls topic.
modifyTime string: The modify time of the tls topic.
projectId string: The project id of tls topic.
shardCount number: The count of shards in the tls topic.
tags GetTopicsTlsTopicTag[]: Tags.
timeFormat string: The format of the time field.
timeKey string: The name of the time field.
topicId string: The id of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
topicName string: The name of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
ttl number: The data storage time of the tls topic. Unit: Day.

archive_ttl int: Archive storage duration, valid when enable_hot_ttl is true.
auto_split bool: Whether to enable automatic partition splitting function of the tls topic.
cold_ttl int: Infrequent storage duration, valid when enable_hot_ttl is true.
create_time str: The create time of the tls topic.
description str: The description of the tls topic.
enable_hot_ttl bool: Whether to enable tiered storage.
enable_tracking bool: Whether to enable WebTracking function of the tls topic.
encrypt_conf GetTopicsTlsTopicEncryptConf: Data encryption configuration.
hot_ttl int: Standard storage duration, valid when enable_hot_ttl is true.
id str: The ID of the tls topic.
log_public_ip bool: Whether to enable the function of recording public IP.
max_split_shard int: The max count of shards in the tls topic.
modify_time str: The modify time of the tls topic.
project_id str: The project id of tls topic.
shard_count int: The count of shards in the tls topic.
tags Sequence[GetTopicsTlsTopicTag]: Tags.
time_format str: The format of the time field.
time_key str: The name of the time field.
topic_id str: The id of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
topic_name str: The name of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
ttl int: The data storage time of the tls topic. Unit: Day.

archiveTtl Number: Archive storage duration, valid when enable_hot_ttl is true.
autoSplit Boolean: Whether to enable automatic partition splitting function of the tls topic.
coldTtl Number: Infrequent storage duration, valid when enable_hot_ttl is true.
createTime String: The create time of the tls topic.
description String: The description of the tls topic.
enableHotTtl Boolean: Whether to enable tiered storage.
enableTracking Boolean: Whether to enable WebTracking function of the tls topic.
encryptConf Property Map: Data encryption configuration.
hotTtl Number: Standard storage duration, valid when enable_hot_ttl is true.
id String: The ID of the tls topic.
logPublicIp Boolean: Whether to enable the function of recording public IP.
maxSplitShard Number: The max count of shards in the tls topic.
modifyTime String: The modify time of the tls topic.
projectId String: The project id of tls topic.
shardCount Number: The count of shards in the tls topic.
tags List<Property Map>: Tags.
timeFormat String: The format of the time field.
timeKey String: The name of the time field.
topicId String: The id of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
topicName String: The name of tls topic. This field supports fuzzy queries. It is not supported to specify both TopicName and TopicId at the same time.
ttl Number: The data storage time of the tls topic. Unit: Day.

GetTopicsTlsTopicEncryptConf

Enable bool: Whether to enable data encryption.
EncryptType string: The encryption type.
UserCmkInfo GetTopicsTlsTopicEncryptConfUserCmkInfo: The user custom key.

Enable bool: Whether to enable data encryption.
EncryptType string: The encryption type.
UserCmkInfo GetTopicsTlsTopicEncryptConfUserCmkInfo: The user custom key.

enable Boolean: Whether to enable data encryption.
encryptType String: The encryption type.
userCmkInfo GetTopicsTlsTopicEncryptConfUserCmkInfo: The user custom key.

enable boolean: Whether to enable data encryption.
encryptType string: The encryption type.
userCmkInfo GetTopicsTlsTopicEncryptConfUserCmkInfo: The user custom key.

enable bool: Whether to enable data encryption.
encrypt_type str: The encryption type.
user_cmk_info GetTopicsTlsTopicEncryptConfUserCmkInfo: The user custom key.

enable Boolean: Whether to enable data encryption.
encryptType String: The encryption type.
userCmkInfo Property Map: The user custom key.

GetTopicsTlsTopicEncryptConfUserCmkInfo

RegionId string: The key region.
Trn string: The key trn.
UserCmkId string: The key id.

RegionId string: The key region.
Trn string: The key trn.
UserCmkId string: The key id.

regionId String: The key region.
trn String: The key trn.
userCmkId String: The key id.

regionId string: The key region.
trn string: The key trn.
userCmkId string: The key id.

region_id str: The key region.
trn str: The key trn.
user_cmk_id str: The key id.

regionId String: The key region.
trn String: The key trn.
userCmkId String: The key id.

GetTopicsTlsTopicTag

Key string: The Key of Tags.
Value string: The Value of Tags.

Key string: The Key of Tags.
Value string: The Value of Tags.

key String: The Key of Tags.
value String: The Value of Tags.

key string: The Key of Tags.
value string: The Value of Tags.

key str: The Key of Tags.
value str: The Value of Tags.

key String: The Key of Tags.
value String: The Value of Tags.

Package Details

Repository: volcengine volcengine/pulumi-volcengine
License: Apache-2.0
Notes: This Pulumi package is based on the volcengine Terraform Provider.

Viewing docs for Volcengine v0.0.46
published on Friday, Feb 27, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

volcengine.tls.getTopics

On this page

On this page

Example Usage

Using getTopics

getTopics Result

Supporting Types

GetTopicsTag

GetTopicsTlsTopic

GetTopicsTlsTopicEncryptConf

GetTopicsTlsTopicEncryptConfUserCmkInfo

GetTopicsTlsTopicTag

Package Details

On this page

On this page