Topic

volcenginecc v0.0.11, Dec 4 25

volcenginecc v0.0.11 published on Thursday, Dec 4, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc v0.0.11 published on Thursday, Dec 4, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  kafkaTopicDemo:
    type: volcenginecc:kafka:Topic
    name: KafkaTopicDemo
    properties:
      accessPolicies:
        - user_name: KafkaTopicDemo-A
          access_policy: Pub
        - user_name: KafkaTopicDemo-B
          access_policy: Sub
        - user_name: KafkaTopicDemo-C
          access_policy: PubSub
      allAuthority: true
      cleanupPolicies:
        - delete
        - compact
      description: KafkaTopicDemo
      instanceId: kafka-c****f
      parameters: '{"LogRetentionHours":"3","MessageMaxByte":"2","MinInsyncReplicaNumber":"1"}'
      partitionNumber: 1
      replicaNumber: 1
      topicName: KafkaTopicDemo
      tags:
        - key: env
          value: test

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,
          instance_id: Optional[str] = None,
          partition_number: Optional[int] = None,
          topic_name: Optional[str] = None,
          access_policies: Optional[Sequence[TopicAccessPolicyArgs]] = None,
          all_authority: Optional[bool] = None,
          cleanup_policies: Optional[Sequence[str]] = None,
          description: Optional[str] = None,
          parameters: Optional[str] = None,
          replica_number: Optional[int] = None,
          tags: Optional[Sequence[TopicTagArgs]] = 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: volcenginecc:kafka: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 topicResource = new Volcenginecc.Kafka.Topic("topicResource", new()
{
    InstanceId = "string",
    PartitionNumber = 0,
    TopicName = "string",
    AccessPolicies = new[]
    {
        new Volcenginecc.Kafka.Inputs.TopicAccessPolicyArgs
        {
            AccessPolicy = "string",
            UserName = "string",
        },
    },
    AllAuthority = false,
    CleanupPolicies = new[]
    {
        "string",
    },
    Description = "string",
    Parameters = "string",
    ReplicaNumber = 0,
    Tags = new[]
    {
        new Volcenginecc.Kafka.Inputs.TopicTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
});

example, err := kafka.NewTopic(ctx, "topicResource", &kafka.TopicArgs{
	InstanceId:      pulumi.String("string"),
	PartitionNumber: pulumi.Int(0),
	TopicName:       pulumi.String("string"),
	AccessPolicies: kafka.TopicAccessPolicyArray{
		&kafka.TopicAccessPolicyArgs{
			AccessPolicy: pulumi.String("string"),
			UserName:     pulumi.String("string"),
		},
	},
	AllAuthority: pulumi.Bool(false),
	CleanupPolicies: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description:   pulumi.String("string"),
	Parameters:    pulumi.String("string"),
	ReplicaNumber: pulumi.Int(0),
	Tags: kafka.TopicTagArray{
		&kafka.TopicTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
})

var topicResource = new com.volcengine.volcenginecc.kafka.Topic("topicResource", com.volcengine.volcenginecc.kafka.TopicArgs.builder()
    .instanceId("string")
    .partitionNumber(0)
    .topicName("string")
    .accessPolicies(TopicAccessPolicyArgs.builder()
        .accessPolicy("string")
        .userName("string")
        .build())
    .allAuthority(false)
    .cleanupPolicies("string")
    .description("string")
    .parameters("string")
    .replicaNumber(0)
    .tags(TopicTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .build());

topic_resource = volcenginecc.kafka.Topic("topicResource",
    instance_id="string",
    partition_number=0,
    topic_name="string",
    access_policies=[{
        "access_policy": "string",
        "user_name": "string",
    }],
    all_authority=False,
    cleanup_policies=["string"],
    description="string",
    parameters="string",
    replica_number=0,
    tags=[{
        "key": "string",
        "value": "string",
    }])

const topicResource = new volcenginecc.kafka.Topic("topicResource", {
    instanceId: "string",
    partitionNumber: 0,
    topicName: "string",
    accessPolicies: [{
        accessPolicy: "string",
        userName: "string",
    }],
    allAuthority: false,
    cleanupPolicies: ["string"],
    description: "string",
    parameters: "string",
    replicaNumber: 0,
    tags: [{
        key: "string",
        value: "string",
    }],
});

type: volcenginecc:kafka:Topic
properties:
    accessPolicies:
        - accessPolicy: string
          userName: string
    allAuthority: false
    cleanupPolicies:
        - string
    description: string
    instanceId: string
    parameters: string
    partitionNumber: 0
    replicaNumber: 0
    tags:
        - key: string
          value: string
    topicName: string

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:

InstanceId string: 实例 ID。
PartitionNumber int: Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
TopicName string: 待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
AccessPolicies List<Volcengine.TopicAccessPolicy>
AllAuthority bool: 待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
CleanupPolicies List<string>: Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
Description string: Topic 的描述信息。长度不超过 128 个字符。
Parameters string: Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
ReplicaNumber int: Topic 副本个数。可设置为为 2 或 3，默认值为 3。
Tags List<Volcengine.TopicTag>

InstanceId string: 实例 ID。
PartitionNumber int: Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
TopicName string: 待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
AccessPolicies []TopicAccessPolicyArgs
AllAuthority bool: 待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
CleanupPolicies []string: Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
Description string: Topic 的描述信息。长度不超过 128 个字符。
Parameters string: Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
ReplicaNumber int: Topic 副本个数。可设置为为 2 或 3，默认值为 3。
Tags []TopicTagArgs

instanceId String: 实例 ID。
partitionNumber Integer: Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
topicName String: 待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
accessPolicies List<TopicAccessPolicy>
allAuthority Boolean: 待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
cleanupPolicies List<String>: Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
description String: Topic 的描述信息。长度不超过 128 个字符。
parameters String: Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
replicaNumber Integer: Topic 副本个数。可设置为为 2 或 3，默认值为 3。
tags List<TopicTag>

instanceId string: 实例 ID。
partitionNumber number: Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
topicName string: 待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
accessPolicies TopicAccessPolicy[]
allAuthority boolean: 待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
cleanupPolicies string[]: Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
description string: Topic 的描述信息。长度不超过 128 个字符。
parameters string: Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
replicaNumber number: Topic 副本个数。可设置为为 2 或 3，默认值为 3。
tags TopicTag[]

instance_id str: 实例 ID。
partition_number int: Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
topic_name str: 待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
access_policies Sequence[TopicAccessPolicyArgs]
all_authority bool: 待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
cleanup_policies Sequence[str]: Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
description str: Topic 的描述信息。长度不超过 128 个字符。
parameters str: Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
replica_number int: Topic 副本个数。可设置为为 2 或 3，默认值为 3。
tags Sequence[TopicTagArgs]

instanceId String: 实例 ID。
partitionNumber Number: Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
topicName String: 待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
accessPolicies List<Property Map>
allAuthority Boolean: 待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
cleanupPolicies List<String>: Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
description String: Topic 的描述信息。长度不超过 128 个字符。
parameters String: Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
replicaNumber Number: Topic 副本个数。可设置为为 2 或 3，默认值为 3。
tags List<Property Map>

Outputs

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

CreatedTime string: Topic 的创建时间。
Id string: The provider-assigned unique ID for this managed resource.
LogRetentionHours int: 消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
Status string: Topic 的状态。
UsedStoragePercentageInInstance double: 当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
UsedStorageSpaceInBytes int: 当前 Topic 已使用的总存储空间大小。

CreatedTime string: Topic 的创建时间。
Id string: The provider-assigned unique ID for this managed resource.
LogRetentionHours int: 消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
Status string: Topic 的状态。
UsedStoragePercentageInInstance float64: 当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
UsedStorageSpaceInBytes int: 当前 Topic 已使用的总存储空间大小。

createdTime String: Topic 的创建时间。
id String: The provider-assigned unique ID for this managed resource.
logRetentionHours Integer: 消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
status String: Topic 的状态。
usedStoragePercentageInInstance Double: 当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
usedStorageSpaceInBytes Integer: 当前 Topic 已使用的总存储空间大小。

createdTime string: Topic 的创建时间。
id string: The provider-assigned unique ID for this managed resource.
logRetentionHours number: 消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
status string: Topic 的状态。
usedStoragePercentageInInstance number: 当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
usedStorageSpaceInBytes number: 当前 Topic 已使用的总存储空间大小。

created_time str: Topic 的创建时间。
id str: The provider-assigned unique ID for this managed resource.
log_retention_hours int: 消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
status str: Topic 的状态。
used_storage_percentage_in_instance float: 当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
used_storage_space_in_bytes int: 当前 Topic 已使用的总存储空间大小。

createdTime String: Topic 的创建时间。
id String: The provider-assigned unique ID for this managed resource.
logRetentionHours Number: 消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
status String: Topic 的状态。
usedStoragePercentageInInstance Number: 当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
usedStorageSpaceInBytes Number: 当前 Topic 已使用的总存储空间大小。

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,
        access_policies: Optional[Sequence[TopicAccessPolicyArgs]] = None,
        all_authority: Optional[bool] = None,
        cleanup_policies: Optional[Sequence[str]] = None,
        created_time: Optional[str] = None,
        description: Optional[str] = None,
        instance_id: Optional[str] = None,
        log_retention_hours: Optional[int] = None,
        parameters: Optional[str] = None,
        partition_number: Optional[int] = None,
        replica_number: Optional[int] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[TopicTagArgs]] = None,
        topic_name: Optional[str] = None,
        used_storage_percentage_in_instance: Optional[float] = None,
        used_storage_space_in_bytes: Optional[int] = 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: volcenginecc:kafka: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:

AccessPolicies List<Volcengine.TopicAccessPolicy>
AllAuthority bool: 待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
CleanupPolicies List<string>: Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
CreatedTime string: Topic 的创建时间。
Description string: Topic 的描述信息。长度不超过 128 个字符。
InstanceId string: 实例 ID。
LogRetentionHours int: 消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
Parameters string: Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
PartitionNumber int: Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
ReplicaNumber int: Topic 副本个数。可设置为为 2 或 3，默认值为 3。
Status string: Topic 的状态。
Tags List<Volcengine.TopicTag>
TopicName string: 待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
UsedStoragePercentageInInstance double: 当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
UsedStorageSpaceInBytes int: 当前 Topic 已使用的总存储空间大小。

AccessPolicies []TopicAccessPolicyArgs
AllAuthority bool: 待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
CleanupPolicies []string: Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
CreatedTime string: Topic 的创建时间。
Description string: Topic 的描述信息。长度不超过 128 个字符。
InstanceId string: 实例 ID。
LogRetentionHours int: 消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
Parameters string: Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
PartitionNumber int: Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
ReplicaNumber int: Topic 副本个数。可设置为为 2 或 3，默认值为 3。
Status string: Topic 的状态。
Tags []TopicTagArgs
TopicName string: 待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
UsedStoragePercentageInInstance float64: 当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
UsedStorageSpaceInBytes int: 当前 Topic 已使用的总存储空间大小。

accessPolicies List<TopicAccessPolicy>
allAuthority Boolean: 待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
cleanupPolicies List<String>: Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
createdTime String: Topic 的创建时间。
description String: Topic 的描述信息。长度不超过 128 个字符。
instanceId String: 实例 ID。
logRetentionHours Integer: 消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
parameters String: Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
partitionNumber Integer: Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
replicaNumber Integer: Topic 副本个数。可设置为为 2 或 3，默认值为 3。
status String: Topic 的状态。
tags List<TopicTag>
topicName String: 待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
usedStoragePercentageInInstance Double: 当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
usedStorageSpaceInBytes Integer: 当前 Topic 已使用的总存储空间大小。

accessPolicies TopicAccessPolicy[]
allAuthority boolean: 待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
cleanupPolicies string[]: Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
createdTime string: Topic 的创建时间。
description string: Topic 的描述信息。长度不超过 128 个字符。
instanceId string: 实例 ID。
logRetentionHours number: 消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
parameters string: Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
partitionNumber number: Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
replicaNumber number: Topic 副本个数。可设置为为 2 或 3，默认值为 3。
status string: Topic 的状态。
tags TopicTag[]
topicName string: 待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
usedStoragePercentageInInstance number: 当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
usedStorageSpaceInBytes number: 当前 Topic 已使用的总存储空间大小。

access_policies Sequence[TopicAccessPolicyArgs]
all_authority bool: 待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
cleanup_policies Sequence[str]: Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
created_time str: Topic 的创建时间。
description str: Topic 的描述信息。长度不超过 128 个字符。
instance_id str: 实例 ID。
log_retention_hours int: 消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
parameters str: Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
partition_number int: Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
replica_number int: Topic 副本个数。可设置为为 2 或 3，默认值为 3。
status str: Topic 的状态。
tags Sequence[TopicTagArgs]
topic_name str: 待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
used_storage_percentage_in_instance float: 当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
used_storage_space_in_bytes int: 当前 Topic 已使用的总存储空间大小。

accessPolicies List<Property Map>
allAuthority Boolean: 待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
cleanupPolicies List<String>: Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
createdTime String: Topic 的创建时间。
description String: Topic 的描述信息。长度不超过 128 个字符。
instanceId String: 实例 ID。
logRetentionHours Number: 消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
parameters String: Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
partitionNumber Number: Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
replicaNumber Number: Topic 副本个数。可设置为为 2 或 3，默认值为 3。
status String: Topic 的状态。
tags List<Property Map>
topicName String: 待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
usedStoragePercentageInInstance Number: 当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
usedStorageSpaceInBytes Number: 当前 Topic 已使用的总存储空间大小。

Supporting Types

TopicAccessPolicy, TopicAccessPolicyArgs

AccessPolicy string: SASL 用户对于当前 Topic 的访问权限。PubSub：拥有发布、订阅权限。Pub：拥有发布权限。Sub：拥有订阅权限。
UserName string: SASL 用户名称。

AccessPolicy string: SASL 用户对于当前 Topic 的访问权限。PubSub：拥有发布、订阅权限。Pub：拥有发布权限。Sub：拥有订阅权限。
UserName string: SASL 用户名称。

accessPolicy String: SASL 用户对于当前 Topic 的访问权限。PubSub：拥有发布、订阅权限。Pub：拥有发布权限。Sub：拥有订阅权限。
userName String: SASL 用户名称。

accessPolicy string: SASL 用户对于当前 Topic 的访问权限。PubSub：拥有发布、订阅权限。Pub：拥有发布权限。Sub：拥有订阅权限。
userName string: SASL 用户名称。

access_policy str: SASL 用户对于当前 Topic 的访问权限。PubSub：拥有发布、订阅权限。Pub：拥有发布权限。Sub：拥有订阅权限。
user_name str: SASL 用户名称。

accessPolicy String: SASL 用户对于当前 Topic 的访问权限。PubSub：拥有发布、订阅权限。Pub：拥有发布权限。Sub：拥有订阅权限。
userName String: SASL 用户名称。

TopicTag, TopicTagArgs

Key string: 标签键。
Value string: 标签值。

Key string: 标签键。
Value string: 标签值。

key String: 标签键。
value String: 标签值。

key string: 标签键。
value string: 标签值。

key str: 标签键。
value str: 标签值。

key String: 标签键。
value String: 标签值。

Import

$ pulumi import volcenginecc:kafka/topic:Topic example "instance_id|topic_name"

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

Package Details

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

volcenginecc v0.0.11 published on Thursday, Dec 4, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.kafka.Topic

On this page

On this page

Example Usage

Create Topic Resource

Constructor syntax

Parameters

Constructor example

Topic Resource Properties

Inputs

Outputs

Look up Existing Topic Resource

Supporting Types

TopicAccessPolicy, TopicAccessPolicyArgs

TopicTag, TopicTagArgs

Import

Package Details

On this page

On this page