volcenginecc.rocketmq.Topic

volcenginecc v0.0.24, Mar 9 26

Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 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:
  rocketMQTopicDemo:
    type: volcenginecc:rocketmq:Topic
    name: RocketMQTopicDemo
    properties:
      instanceId: rocketmq-cnngxxxxx3c2d
      topicName: ccapi-test-test-2
      messageType: 0
      description: this is a test
      queueNumber: 6
      accessPolicies:
        - access_key: TPl1xxxxxxblh5Gpxa79
          authority: ALL

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,
          message_type: Optional[int] = None,
          queue_number: Optional[int] = None,
          topic_name: Optional[str] = None,
          access_policies: Optional[Sequence[TopicAccessPolicyArgs]] = None,
          description: Optional[str] = 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:rocketmq: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 volcengineccTopicResource = new Volcenginecc.Rocketmq.Topic("volcengineccTopicResource", new()
{
    InstanceId = "string",
    MessageType = 0,
    QueueNumber = 0,
    TopicName = "string",
    AccessPolicies = new[]
    {
        new Volcenginecc.Rocketmq.Inputs.TopicAccessPolicyArgs
        {
            AccessKey = "string",
            Authority = "string",
        },
    },
    Description = "string",
});

example, err := rocketmq.NewTopic(ctx, "volcengineccTopicResource", &rocketmq.TopicArgs{
	InstanceId:  pulumi.String("string"),
	MessageType: pulumi.Int(0),
	QueueNumber: pulumi.Int(0),
	TopicName:   pulumi.String("string"),
	AccessPolicies: rocketmq.TopicAccessPolicyArray{
		&rocketmq.TopicAccessPolicyArgs{
			AccessKey: pulumi.String("string"),
			Authority: pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
})

var volcengineccTopicResource = new com.volcengine.volcenginecc.rocketmq.Topic("volcengineccTopicResource", com.volcengine.volcenginecc.rocketmq.TopicArgs.builder()
    .instanceId("string")
    .messageType(0)
    .queueNumber(0)
    .topicName("string")
    .accessPolicies(TopicAccessPolicyArgs.builder()
        .accessKey("string")
        .authority("string")
        .build())
    .description("string")
    .build());

volcenginecc_topic_resource = volcenginecc.rocketmq.Topic("volcengineccTopicResource",
    instance_id="string",
    message_type=0,
    queue_number=0,
    topic_name="string",
    access_policies=[{
        "access_key": "string",
        "authority": "string",
    }],
    description="string")

const volcengineccTopicResource = new volcenginecc.rocketmq.Topic("volcengineccTopicResource", {
    instanceId: "string",
    messageType: 0,
    queueNumber: 0,
    topicName: "string",
    accessPolicies: [{
        accessKey: "string",
        authority: "string",
    }],
    description: "string",
});

type: volcenginecc:rocketmq:Topic
properties:
    accessPolicies:
        - accessKey: string
          authority: string
    description: string
    instanceId: string
    messageType: 0
    queueNumber: 0
    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。
MessageType int: 消息类型。设置此参数表示根据指定的消息类型筛选 Topic 列表。取值说明如下：0：普通消息。1：事务消息。2：分区顺序消息。3：全局顺序消息。4：延时消息。
QueueNumber int: 设置当前 Topic 的队列数量，最大不可超过当前实例剩余可用队列数。每个实例规格的队列数量限制请参考产品规格。在 4.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数和计算规格有关，n3 及以下规格的队列数默认为 6，n3 以上规格的队列数默认是 broker 组数的两倍。队列数建议设置为计算节点数的倍数，否则可能造成不同 Broker 之间数据不均衡。例如规格 rocketmq.n3.x2.medium 的计算节点数为 3，队列数建议设置为 3 的倍数，即 3、6、9 等。在 5.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数默认是 broker 组数的两倍。非顺序场景性能不受队列个数影响，更多队列仅用于提升顺序消费并发性能。
TopicName string: Topic 的名称。命名规则如下：长度为 3~100 个字符。只能包含英文、数字、连字符（-）以及下划线（）。Topic 名称中不可包含以下保留字符或特殊前缀。保留字符：RMQSYSTRANSOPHALFTOPIC、BenchmarkTest、TBW102、OFFSETMOVEDEVENT、SELFTESTTOPIC、RMQSYSTRANSHALFTOPIC、SCHEDULETOPICXXXX、RMQSYSTRACETOPIC。特殊前缀：rocketmq-broker-、%RETRY%、rmqsys_、%DLQ%。
AccessPolicies List<Volcengine.TopicAccessPolicy>
Description string: Topic 的描述信息，长度为 0~128 个字符。

InstanceId string: 实例 ID。
MessageType int: 消息类型。设置此参数表示根据指定的消息类型筛选 Topic 列表。取值说明如下：0：普通消息。1：事务消息。2：分区顺序消息。3：全局顺序消息。4：延时消息。
QueueNumber int: 设置当前 Topic 的队列数量，最大不可超过当前实例剩余可用队列数。每个实例规格的队列数量限制请参考产品规格。在 4.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数和计算规格有关，n3 及以下规格的队列数默认为 6，n3 以上规格的队列数默认是 broker 组数的两倍。队列数建议设置为计算节点数的倍数，否则可能造成不同 Broker 之间数据不均衡。例如规格 rocketmq.n3.x2.medium 的计算节点数为 3，队列数建议设置为 3 的倍数，即 3、6、9 等。在 5.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数默认是 broker 组数的两倍。非顺序场景性能不受队列个数影响，更多队列仅用于提升顺序消费并发性能。
TopicName string: Topic 的名称。命名规则如下：长度为 3~100 个字符。只能包含英文、数字、连字符（-）以及下划线（）。Topic 名称中不可包含以下保留字符或特殊前缀。保留字符：RMQSYSTRANSOPHALFTOPIC、BenchmarkTest、TBW102、OFFSETMOVEDEVENT、SELFTESTTOPIC、RMQSYSTRANSHALFTOPIC、SCHEDULETOPICXXXX、RMQSYSTRACETOPIC。特殊前缀：rocketmq-broker-、%RETRY%、rmqsys_、%DLQ%。
AccessPolicies []TopicAccessPolicyArgs
Description string: Topic 的描述信息，长度为 0~128 个字符。

instanceId String: 实例 ID。
messageType Integer: 消息类型。设置此参数表示根据指定的消息类型筛选 Topic 列表。取值说明如下：0：普通消息。1：事务消息。2：分区顺序消息。3：全局顺序消息。4：延时消息。
queueNumber Integer: 设置当前 Topic 的队列数量，最大不可超过当前实例剩余可用队列数。每个实例规格的队列数量限制请参考产品规格。在 4.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数和计算规格有关，n3 及以下规格的队列数默认为 6，n3 以上规格的队列数默认是 broker 组数的两倍。队列数建议设置为计算节点数的倍数，否则可能造成不同 Broker 之间数据不均衡。例如规格 rocketmq.n3.x2.medium 的计算节点数为 3，队列数建议设置为 3 的倍数，即 3、6、9 等。在 5.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数默认是 broker 组数的两倍。非顺序场景性能不受队列个数影响，更多队列仅用于提升顺序消费并发性能。
topicName String: Topic 的名称。命名规则如下：长度为 3~100 个字符。只能包含英文、数字、连字符（-）以及下划线（）。Topic 名称中不可包含以下保留字符或特殊前缀。保留字符：RMQSYSTRANSOPHALFTOPIC、BenchmarkTest、TBW102、OFFSETMOVEDEVENT、SELFTESTTOPIC、RMQSYSTRANSHALFTOPIC、SCHEDULETOPICXXXX、RMQSYSTRACETOPIC。特殊前缀：rocketmq-broker-、%RETRY%、rmqsys_、%DLQ%。
accessPolicies List<TopicAccessPolicy>
description String: Topic 的描述信息，长度为 0~128 个字符。

instanceId string: 实例 ID。
messageType number: 消息类型。设置此参数表示根据指定的消息类型筛选 Topic 列表。取值说明如下：0：普通消息。1：事务消息。2：分区顺序消息。3：全局顺序消息。4：延时消息。
queueNumber number: 设置当前 Topic 的队列数量，最大不可超过当前实例剩余可用队列数。每个实例规格的队列数量限制请参考产品规格。在 4.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数和计算规格有关，n3 及以下规格的队列数默认为 6，n3 以上规格的队列数默认是 broker 组数的两倍。队列数建议设置为计算节点数的倍数，否则可能造成不同 Broker 之间数据不均衡。例如规格 rocketmq.n3.x2.medium 的计算节点数为 3，队列数建议设置为 3 的倍数，即 3、6、9 等。在 5.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数默认是 broker 组数的两倍。非顺序场景性能不受队列个数影响，更多队列仅用于提升顺序消费并发性能。
topicName string: Topic 的名称。命名规则如下：长度为 3~100 个字符。只能包含英文、数字、连字符（-）以及下划线（）。Topic 名称中不可包含以下保留字符或特殊前缀。保留字符：RMQSYSTRANSOPHALFTOPIC、BenchmarkTest、TBW102、OFFSETMOVEDEVENT、SELFTESTTOPIC、RMQSYSTRANSHALFTOPIC、SCHEDULETOPICXXXX、RMQSYSTRACETOPIC。特殊前缀：rocketmq-broker-、%RETRY%、rmqsys_、%DLQ%。
accessPolicies TopicAccessPolicy[]
description string: Topic 的描述信息，长度为 0~128 个字符。

instance_id str: 实例 ID。
message_type int: 消息类型。设置此参数表示根据指定的消息类型筛选 Topic 列表。取值说明如下：0：普通消息。1：事务消息。2：分区顺序消息。3：全局顺序消息。4：延时消息。
queue_number int: 设置当前 Topic 的队列数量，最大不可超过当前实例剩余可用队列数。每个实例规格的队列数量限制请参考产品规格。在 4.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数和计算规格有关，n3 及以下规格的队列数默认为 6，n3 以上规格的队列数默认是 broker 组数的两倍。队列数建议设置为计算节点数的倍数，否则可能造成不同 Broker 之间数据不均衡。例如规格 rocketmq.n3.x2.medium 的计算节点数为 3，队列数建议设置为 3 的倍数，即 3、6、9 等。在 5.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数默认是 broker 组数的两倍。非顺序场景性能不受队列个数影响，更多队列仅用于提升顺序消费并发性能。
topic_name str: Topic 的名称。命名规则如下：长度为 3~100 个字符。只能包含英文、数字、连字符（-）以及下划线（）。Topic 名称中不可包含以下保留字符或特殊前缀。保留字符：RMQSYSTRANSOPHALFTOPIC、BenchmarkTest、TBW102、OFFSETMOVEDEVENT、SELFTESTTOPIC、RMQSYSTRANSHALFTOPIC、SCHEDULETOPICXXXX、RMQSYSTRACETOPIC。特殊前缀：rocketmq-broker-、%RETRY%、rmqsys_、%DLQ%。
access_policies Sequence[TopicAccessPolicyArgs]
description str: Topic 的描述信息，长度为 0~128 个字符。

instanceId String: 实例 ID。
messageType Number: 消息类型。设置此参数表示根据指定的消息类型筛选 Topic 列表。取值说明如下：0：普通消息。1：事务消息。2：分区顺序消息。3：全局顺序消息。4：延时消息。
queueNumber Number: 设置当前 Topic 的队列数量，最大不可超过当前实例剩余可用队列数。每个实例规格的队列数量限制请参考产品规格。在 4.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数和计算规格有关，n3 及以下规格的队列数默认为 6，n3 以上规格的队列数默认是 broker 组数的两倍。队列数建议设置为计算节点数的倍数，否则可能造成不同 Broker 之间数据不均衡。例如规格 rocketmq.n3.x2.medium 的计算节点数为 3，队列数建议设置为 3 的倍数，即 3、6、9 等。在 5.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数默认是 broker 组数的两倍。非顺序场景性能不受队列个数影响，更多队列仅用于提升顺序消费并发性能。
topicName String: Topic 的名称。命名规则如下：长度为 3~100 个字符。只能包含英文、数字、连字符（-）以及下划线（）。Topic 名称中不可包含以下保留字符或特殊前缀。保留字符：RMQSYSTRANSOPHALFTOPIC、BenchmarkTest、TBW102、OFFSETMOVEDEVENT、SELFTESTTOPIC、RMQSYSTRANSHALFTOPIC、SCHEDULETOPICXXXX、RMQSYSTRACETOPIC。特殊前缀：rocketmq-broker-、%RETRY%、rmqsys_、%DLQ%。
accessPolicies List<Property Map>
description String: Topic 的描述信息，长度为 0~128 个字符。

Outputs

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

CreatedTime string: Topic 创建时间。
GroupsInfos List<Volcengine.TopicGroupsInfo>
Id string: The provider-assigned unique ID for this managed resource.
InstanceName string: 实例名称。
QueuesInfos List<Volcengine.TopicQueuesInfo>
ReadAccessPolicies List<Volcengine.TopicReadAccessPolicy>
ServiceStatus string: 服务状态。Creating：创建中，Running：运行中，Deleting：删除中，Abnormal：异常，Updating：更新中。

CreatedTime string: Topic 创建时间。
GroupsInfos []TopicGroupsInfo
Id string: The provider-assigned unique ID for this managed resource.
InstanceName string: 实例名称。
QueuesInfos []TopicQueuesInfo
ReadAccessPolicies []TopicReadAccessPolicy
ServiceStatus string: 服务状态。Creating：创建中，Running：运行中，Deleting：删除中，Abnormal：异常，Updating：更新中。

createdTime String: Topic 创建时间。
groupsInfos List<TopicGroupsInfo>
id String: The provider-assigned unique ID for this managed resource.
instanceName String: 实例名称。
queuesInfos List<TopicQueuesInfo>
readAccessPolicies List<TopicReadAccessPolicy>
serviceStatus String: 服务状态。Creating：创建中，Running：运行中，Deleting：删除中，Abnormal：异常，Updating：更新中。

createdTime string: Topic 创建时间。
groupsInfos TopicGroupsInfo[]
id string: The provider-assigned unique ID for this managed resource.
instanceName string: 实例名称。
queuesInfos TopicQueuesInfo[]
readAccessPolicies TopicReadAccessPolicy[]
serviceStatus string: 服务状态。Creating：创建中，Running：运行中，Deleting：删除中，Abnormal：异常，Updating：更新中。

created_time str: Topic 创建时间。
groups_infos Sequence[TopicGroupsInfo]
id str: The provider-assigned unique ID for this managed resource.
instance_name str: 实例名称。
queues_infos Sequence[TopicQueuesInfo]
read_access_policies Sequence[TopicReadAccessPolicy]
service_status str: 服务状态。Creating：创建中，Running：运行中，Deleting：删除中，Abnormal：异常，Updating：更新中。

createdTime String: Topic 创建时间。
groupsInfos List<Property Map>
id String: The provider-assigned unique ID for this managed resource.
instanceName String: 实例名称。
queuesInfos List<Property Map>
readAccessPolicies List<Property Map>
serviceStatus String: 服务状态。Creating：创建中，Running：运行中，Deleting：删除中，Abnormal：异常，Updating：更新中。

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,
        created_time: Optional[str] = None,
        description: Optional[str] = None,
        groups_infos: Optional[Sequence[TopicGroupsInfoArgs]] = None,
        instance_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        message_type: Optional[int] = None,
        queue_number: Optional[int] = None,
        queues_infos: Optional[Sequence[TopicQueuesInfoArgs]] = None,
        read_access_policies: Optional[Sequence[TopicReadAccessPolicyArgs]] = None,
        service_status: Optional[str] = None,
        topic_name: 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: volcenginecc:rocketmq: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>
CreatedTime string: Topic 创建时间。
Description string: Topic 的描述信息，长度为 0~128 个字符。
GroupsInfos List<Volcengine.TopicGroupsInfo>
InstanceId string: 实例 ID。
InstanceName string: 实例名称。
MessageType int: 消息类型。设置此参数表示根据指定的消息类型筛选 Topic 列表。取值说明如下：0：普通消息。1：事务消息。2：分区顺序消息。3：全局顺序消息。4：延时消息。
QueueNumber int: 设置当前 Topic 的队列数量，最大不可超过当前实例剩余可用队列数。每个实例规格的队列数量限制请参考产品规格。在 4.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数和计算规格有关，n3 及以下规格的队列数默认为 6，n3 以上规格的队列数默认是 broker 组数的两倍。队列数建议设置为计算节点数的倍数，否则可能造成不同 Broker 之间数据不均衡。例如规格 rocketmq.n3.x2.medium 的计算节点数为 3，队列数建议设置为 3 的倍数，即 3、6、9 等。在 5.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数默认是 broker 组数的两倍。非顺序场景性能不受队列个数影响，更多队列仅用于提升顺序消费并发性能。
QueuesInfos List<Volcengine.TopicQueuesInfo>
ReadAccessPolicies List<Volcengine.TopicReadAccessPolicy>
ServiceStatus string: 服务状态。Creating：创建中，Running：运行中，Deleting：删除中，Abnormal：异常，Updating：更新中。
TopicName string: Topic 的名称。命名规则如下：长度为 3~100 个字符。只能包含英文、数字、连字符（-）以及下划线（）。Topic 名称中不可包含以下保留字符或特殊前缀。保留字符：RMQSYSTRANSOPHALFTOPIC、BenchmarkTest、TBW102、OFFSETMOVEDEVENT、SELFTESTTOPIC、RMQSYSTRANSHALFTOPIC、SCHEDULETOPICXXXX、RMQSYSTRACETOPIC。特殊前缀：rocketmq-broker-、%RETRY%、rmqsys_、%DLQ%。

AccessPolicies []TopicAccessPolicyArgs
CreatedTime string: Topic 创建时间。
Description string: Topic 的描述信息，长度为 0~128 个字符。
GroupsInfos []TopicGroupsInfoArgs
InstanceId string: 实例 ID。
InstanceName string: 实例名称。
MessageType int: 消息类型。设置此参数表示根据指定的消息类型筛选 Topic 列表。取值说明如下：0：普通消息。1：事务消息。2：分区顺序消息。3：全局顺序消息。4：延时消息。
QueueNumber int: 设置当前 Topic 的队列数量，最大不可超过当前实例剩余可用队列数。每个实例规格的队列数量限制请参考产品规格。在 4.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数和计算规格有关，n3 及以下规格的队列数默认为 6，n3 以上规格的队列数默认是 broker 组数的两倍。队列数建议设置为计算节点数的倍数，否则可能造成不同 Broker 之间数据不均衡。例如规格 rocketmq.n3.x2.medium 的计算节点数为 3，队列数建议设置为 3 的倍数，即 3、6、9 等。在 5.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数默认是 broker 组数的两倍。非顺序场景性能不受队列个数影响，更多队列仅用于提升顺序消费并发性能。
QueuesInfos []TopicQueuesInfoArgs
ReadAccessPolicies []TopicReadAccessPolicyArgs
ServiceStatus string: 服务状态。Creating：创建中，Running：运行中，Deleting：删除中，Abnormal：异常，Updating：更新中。
TopicName string: Topic 的名称。命名规则如下：长度为 3~100 个字符。只能包含英文、数字、连字符（-）以及下划线（）。Topic 名称中不可包含以下保留字符或特殊前缀。保留字符：RMQSYSTRANSOPHALFTOPIC、BenchmarkTest、TBW102、OFFSETMOVEDEVENT、SELFTESTTOPIC、RMQSYSTRANSHALFTOPIC、SCHEDULETOPICXXXX、RMQSYSTRACETOPIC。特殊前缀：rocketmq-broker-、%RETRY%、rmqsys_、%DLQ%。

accessPolicies List<TopicAccessPolicy>
createdTime String: Topic 创建时间。
description String: Topic 的描述信息，长度为 0~128 个字符。
groupsInfos List<TopicGroupsInfo>
instanceId String: 实例 ID。
instanceName String: 实例名称。
messageType Integer: 消息类型。设置此参数表示根据指定的消息类型筛选 Topic 列表。取值说明如下：0：普通消息。1：事务消息。2：分区顺序消息。3：全局顺序消息。4：延时消息。
queueNumber Integer: 设置当前 Topic 的队列数量，最大不可超过当前实例剩余可用队列数。每个实例规格的队列数量限制请参考产品规格。在 4.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数和计算规格有关，n3 及以下规格的队列数默认为 6，n3 以上规格的队列数默认是 broker 组数的两倍。队列数建议设置为计算节点数的倍数，否则可能造成不同 Broker 之间数据不均衡。例如规格 rocketmq.n3.x2.medium 的计算节点数为 3，队列数建议设置为 3 的倍数，即 3、6、9 等。在 5.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数默认是 broker 组数的两倍。非顺序场景性能不受队列个数影响，更多队列仅用于提升顺序消费并发性能。
queuesInfos List<TopicQueuesInfo>
readAccessPolicies List<TopicReadAccessPolicy>
serviceStatus String: 服务状态。Creating：创建中，Running：运行中，Deleting：删除中，Abnormal：异常，Updating：更新中。
topicName String: Topic 的名称。命名规则如下：长度为 3~100 个字符。只能包含英文、数字、连字符（-）以及下划线（）。Topic 名称中不可包含以下保留字符或特殊前缀。保留字符：RMQSYSTRANSOPHALFTOPIC、BenchmarkTest、TBW102、OFFSETMOVEDEVENT、SELFTESTTOPIC、RMQSYSTRANSHALFTOPIC、SCHEDULETOPICXXXX、RMQSYSTRACETOPIC。特殊前缀：rocketmq-broker-、%RETRY%、rmqsys_、%DLQ%。

accessPolicies TopicAccessPolicy[]
createdTime string: Topic 创建时间。
description string: Topic 的描述信息，长度为 0~128 个字符。
groupsInfos TopicGroupsInfo[]
instanceId string: 实例 ID。
instanceName string: 实例名称。
messageType number: 消息类型。设置此参数表示根据指定的消息类型筛选 Topic 列表。取值说明如下：0：普通消息。1：事务消息。2：分区顺序消息。3：全局顺序消息。4：延时消息。
queueNumber number: 设置当前 Topic 的队列数量，最大不可超过当前实例剩余可用队列数。每个实例规格的队列数量限制请参考产品规格。在 4.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数和计算规格有关，n3 及以下规格的队列数默认为 6，n3 以上规格的队列数默认是 broker 组数的两倍。队列数建议设置为计算节点数的倍数，否则可能造成不同 Broker 之间数据不均衡。例如规格 rocketmq.n3.x2.medium 的计算节点数为 3，队列数建议设置为 3 的倍数，即 3、6、9 等。在 5.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数默认是 broker 组数的两倍。非顺序场景性能不受队列个数影响，更多队列仅用于提升顺序消费并发性能。
queuesInfos TopicQueuesInfo[]
readAccessPolicies TopicReadAccessPolicy[]
serviceStatus string: 服务状态。Creating：创建中，Running：运行中，Deleting：删除中，Abnormal：异常，Updating：更新中。
topicName string: Topic 的名称。命名规则如下：长度为 3~100 个字符。只能包含英文、数字、连字符（-）以及下划线（）。Topic 名称中不可包含以下保留字符或特殊前缀。保留字符：RMQSYSTRANSOPHALFTOPIC、BenchmarkTest、TBW102、OFFSETMOVEDEVENT、SELFTESTTOPIC、RMQSYSTRANSHALFTOPIC、SCHEDULETOPICXXXX、RMQSYSTRACETOPIC。特殊前缀：rocketmq-broker-、%RETRY%、rmqsys_、%DLQ%。

access_policies Sequence[TopicAccessPolicyArgs]
created_time str: Topic 创建时间。
description str: Topic 的描述信息，长度为 0~128 个字符。
groups_infos Sequence[TopicGroupsInfoArgs]
instance_id str: 实例 ID。
instance_name str: 实例名称。
message_type int: 消息类型。设置此参数表示根据指定的消息类型筛选 Topic 列表。取值说明如下：0：普通消息。1：事务消息。2：分区顺序消息。3：全局顺序消息。4：延时消息。
queue_number int: 设置当前 Topic 的队列数量，最大不可超过当前实例剩余可用队列数。每个实例规格的队列数量限制请参考产品规格。在 4.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数和计算规格有关，n3 及以下规格的队列数默认为 6，n3 以上规格的队列数默认是 broker 组数的两倍。队列数建议设置为计算节点数的倍数，否则可能造成不同 Broker 之间数据不均衡。例如规格 rocketmq.n3.x2.medium 的计算节点数为 3，队列数建议设置为 3 的倍数，即 3、6、9 等。在 5.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数默认是 broker 组数的两倍。非顺序场景性能不受队列个数影响，更多队列仅用于提升顺序消费并发性能。
queues_infos Sequence[TopicQueuesInfoArgs]
read_access_policies Sequence[TopicReadAccessPolicyArgs]
service_status str: 服务状态。Creating：创建中，Running：运行中，Deleting：删除中，Abnormal：异常，Updating：更新中。
topic_name str: Topic 的名称。命名规则如下：长度为 3~100 个字符。只能包含英文、数字、连字符（-）以及下划线（）。Topic 名称中不可包含以下保留字符或特殊前缀。保留字符：RMQSYSTRANSOPHALFTOPIC、BenchmarkTest、TBW102、OFFSETMOVEDEVENT、SELFTESTTOPIC、RMQSYSTRANSHALFTOPIC、SCHEDULETOPICXXXX、RMQSYSTRACETOPIC。特殊前缀：rocketmq-broker-、%RETRY%、rmqsys_、%DLQ%。

accessPolicies List<Property Map>
createdTime String: Topic 创建时间。
description String: Topic 的描述信息，长度为 0~128 个字符。
groupsInfos List<Property Map>
instanceId String: 实例 ID。
instanceName String: 实例名称。
messageType Number: 消息类型。设置此参数表示根据指定的消息类型筛选 Topic 列表。取值说明如下：0：普通消息。1：事务消息。2：分区顺序消息。3：全局顺序消息。4：延时消息。
queueNumber Number: 设置当前 Topic 的队列数量，最大不可超过当前实例剩余可用队列数。每个实例规格的队列数量限制请参考产品规格。在 4.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数和计算规格有关，n3 及以下规格的队列数默认为 6，n3 以上规格的队列数默认是 broker 组数的两倍。队列数建议设置为计算节点数的倍数，否则可能造成不同 Broker 之间数据不均衡。例如规格 rocketmq.n3.x2.medium 的计算节点数为 3，队列数建议设置为 3 的倍数，即 3、6、9 等。在 5.x 版本实例中创建 Topic 时，请参考以下说明设置队列数：全局顺序类型的 Topic 队列数默认为 1。其他类型 Topic 的队列数默认是 broker 组数的两倍。非顺序场景性能不受队列个数影响，更多队列仅用于提升顺序消费并发性能。
queuesInfos List<Property Map>
readAccessPolicies List<Property Map>
serviceStatus String: 服务状态。Creating：创建中，Running：运行中，Deleting：删除中，Abnormal：异常，Updating：更新中。
topicName String: Topic 的名称。命名规则如下：长度为 3~100 个字符。只能包含英文、数字、连字符（-）以及下划线（）。Topic 名称中不可包含以下保留字符或特殊前缀。保留字符：RMQSYSTRANSOPHALFTOPIC、BenchmarkTest、TBW102、OFFSETMOVEDEVENT、SELFTESTTOPIC、RMQSYSTRANSHALFTOPIC、SCHEDULETOPICXXXX、RMQSYSTRACETOPIC。特殊前缀：rocketmq-broker-、%RETRY%、rmqsys_、%DLQ%。

Supporting Types

TopicAccessPolicy, TopicAccessPolicyArgs

AccessKey string: RocketMQ 密钥的 AccessKey。
Authority string: 用户对于当前Topic的访问权限。ALL：拥有发布、订阅权限。PUB：拥有发布权限。SUB：拥有订阅权限。DENY：不具备发布或订阅权限。

AccessKey string: RocketMQ 密钥的 AccessKey。
Authority string: 用户对于当前Topic的访问权限。ALL：拥有发布、订阅权限。PUB：拥有发布权限。SUB：拥有订阅权限。DENY：不具备发布或订阅权限。

accessKey String: RocketMQ 密钥的 AccessKey。
authority String: 用户对于当前Topic的访问权限。ALL：拥有发布、订阅权限。PUB：拥有发布权限。SUB：拥有订阅权限。DENY：不具备发布或订阅权限。

accessKey string: RocketMQ 密钥的 AccessKey。
authority string: 用户对于当前Topic的访问权限。ALL：拥有发布、订阅权限。PUB：拥有发布权限。SUB：拥有订阅权限。DENY：不具备发布或订阅权限。

access_key str: RocketMQ 密钥的 AccessKey。
authority str: 用户对于当前Topic的访问权限。ALL：拥有发布、订阅权限。PUB：拥有发布权限。SUB：拥有订阅权限。DENY：不具备发布或订阅权限。

accessKey String: RocketMQ 密钥的 AccessKey。
authority String: 用户对于当前Topic的访问权限。ALL：拥有发布、订阅权限。PUB：拥有发布权限。SUB：拥有订阅权限。DENY：不具备发布或订阅权限。

TopicGroupsInfo, TopicGroupsInfoArgs

GroupId string: 消费组的 Group ID。
MessageModel string: 消费模式。取值说明如下：Clustering：集群消费模式。Broadcasting：广播消费模式。
SubString string: 订阅的规则，此字段直接透传消费组订阅此 Topic 时指定的字符串，一般为 * 或 TAG1 || TAG2。

GroupId string: 消费组的 Group ID。
MessageModel string: 消费模式。取值说明如下：Clustering：集群消费模式。Broadcasting：广播消费模式。
SubString string: 订阅的规则，此字段直接透传消费组订阅此 Topic 时指定的字符串，一般为 * 或 TAG1 || TAG2。

groupId String: 消费组的 Group ID。
messageModel String: 消费模式。取值说明如下：Clustering：集群消费模式。Broadcasting：广播消费模式。
subString String: 订阅的规则，此字段直接透传消费组订阅此 Topic 时指定的字符串，一般为 * 或 TAG1 || TAG2。

groupId string: 消费组的 Group ID。
messageModel string: 消费模式。取值说明如下：Clustering：集群消费模式。Broadcasting：广播消费模式。
subString string: 订阅的规则，此字段直接透传消费组订阅此 Topic 时指定的字符串，一般为 * 或 TAG1 || TAG2。

group_id str: 消费组的 Group ID。
message_model str: 消费模式。取值说明如下：Clustering：集群消费模式。Broadcasting：广播消费模式。
sub_string str: 订阅的规则，此字段直接透传消费组订阅此 Topic 时指定的字符串，一般为 * 或 TAG1 || TAG2。

groupId String: 消费组的 Group ID。
messageModel String: 消费模式。取值说明如下：Clustering：集群消费模式。Broadcasting：广播消费模式。
subString String: 订阅的规则，此字段直接透传消费组订阅此 Topic 时指定的字符串，一般为 * 或 TAG1 || TAG2。

TopicQueuesInfo, TopicQueuesInfoArgs

EndOffset int: 当前队列的最大偏移量，即下一条消息的偏移量，当前最新消息的位置为 EndOffset - 1。
LastUpdateTimestamp int: 该队列最近一次消息写入的时间。
MessageCount int: 当前队列队列内的消息个数。EndOffset 为下一条消息的偏移量，所以 MessageCount=EndOffset-StartOffset。
QueueId string: 队列的编号 ID。
StartOffset int: 当前队列最早消息的偏移量。

EndOffset int: 当前队列的最大偏移量，即下一条消息的偏移量，当前最新消息的位置为 EndOffset - 1。
LastUpdateTimestamp int: 该队列最近一次消息写入的时间。
MessageCount int: 当前队列队列内的消息个数。EndOffset 为下一条消息的偏移量，所以 MessageCount=EndOffset-StartOffset。
QueueId string: 队列的编号 ID。
StartOffset int: 当前队列最早消息的偏移量。

endOffset Integer: 当前队列的最大偏移量，即下一条消息的偏移量，当前最新消息的位置为 EndOffset - 1。
lastUpdateTimestamp Integer: 该队列最近一次消息写入的时间。
messageCount Integer: 当前队列队列内的消息个数。EndOffset 为下一条消息的偏移量，所以 MessageCount=EndOffset-StartOffset。
queueId String: 队列的编号 ID。
startOffset Integer: 当前队列最早消息的偏移量。

endOffset number: 当前队列的最大偏移量，即下一条消息的偏移量，当前最新消息的位置为 EndOffset - 1。
lastUpdateTimestamp number: 该队列最近一次消息写入的时间。
messageCount number: 当前队列队列内的消息个数。EndOffset 为下一条消息的偏移量，所以 MessageCount=EndOffset-StartOffset。
queueId string: 队列的编号 ID。
startOffset number: 当前队列最早消息的偏移量。

end_offset int: 当前队列的最大偏移量，即下一条消息的偏移量，当前最新消息的位置为 EndOffset - 1。
last_update_timestamp int: 该队列最近一次消息写入的时间。
message_count int: 当前队列队列内的消息个数。EndOffset 为下一条消息的偏移量，所以 MessageCount=EndOffset-StartOffset。
queue_id str: 队列的编号 ID。
start_offset int: 当前队列最早消息的偏移量。

endOffset Number: 当前队列的最大偏移量，即下一条消息的偏移量，当前最新消息的位置为 EndOffset - 1。
lastUpdateTimestamp Number: 该队列最近一次消息写入的时间。
messageCount Number: 当前队列队列内的消息个数。EndOffset 为下一条消息的偏移量，所以 MessageCount=EndOffset-StartOffset。
queueId String: 队列的编号 ID。
startOffset Number: 当前队列最早消息的偏移量。

TopicReadAccessPolicy, TopicReadAccessPolicyArgs

AccessKey string: RocketMQ 密钥的 AccessKey。
Authority string: 用户对于当前Topic的访问权限。ALL：拥有发布、订阅权限。PUB：拥有发布权限。SUB：拥有订阅权限。DENY：不具备发布或订阅权限。

AccessKey string: RocketMQ 密钥的 AccessKey。
Authority string: 用户对于当前Topic的访问权限。ALL：拥有发布、订阅权限。PUB：拥有发布权限。SUB：拥有订阅权限。DENY：不具备发布或订阅权限。

accessKey String: RocketMQ 密钥的 AccessKey。
authority String: 用户对于当前Topic的访问权限。ALL：拥有发布、订阅权限。PUB：拥有发布权限。SUB：拥有订阅权限。DENY：不具备发布或订阅权限。

accessKey string: RocketMQ 密钥的 AccessKey。
authority string: 用户对于当前Topic的访问权限。ALL：拥有发布、订阅权限。PUB：拥有发布权限。SUB：拥有订阅权限。DENY：不具备发布或订阅权限。

access_key str: RocketMQ 密钥的 AccessKey。
authority str: 用户对于当前Topic的访问权限。ALL：拥有发布、订阅权限。PUB：拥有发布权限。SUB：拥有订阅权限。DENY：不具备发布或订阅权限。

accessKey String: RocketMQ 密钥的 AccessKey。
authority String: 用户对于当前Topic的访问权限。ALL：拥有发布、订阅权限。PUB：拥有发布权限。SUB：拥有订阅权限。DENY：不具备发布或订阅权限。

Import

$ pulumi import volcenginecc:rocketmq/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.

Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.rocketmq.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

TopicGroupsInfo, TopicGroupsInfoArgs

TopicQueuesInfo, TopicQueuesInfoArgs

TopicReadAccessPolicy, TopicReadAccessPolicyArgs

Import

Package Details

On this page

On this page