1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. rocketmq
  6. Topic
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.rocketmq.Topic

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    In a RocketMQ instance, a Topic is the basic unit for sending and consuming messages. RocketMQ Message Queue categorizes and manages different types of messages using Topics. Producers send messages to RocketMQ Topics, and consumers consume messages by subscribing to those Topics.

    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.

    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
    Instance ID.
    MessageType int
    Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
    QueueNumber int
    Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
    TopicName string
    Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.
    AccessPolicies List<Volcengine.TopicAccessPolicy>
    Description string
    Topic description, length: 0–128 characters.
    InstanceId string
    Instance ID.
    MessageType int
    Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
    QueueNumber int
    Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
    TopicName string
    Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.
    AccessPolicies []TopicAccessPolicyArgs
    Description string
    Topic description, length: 0–128 characters.
    instanceId String
    Instance ID.
    messageType Integer
    Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
    queueNumber Integer
    Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
    topicName String
    Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.
    accessPolicies List<TopicAccessPolicy>
    description String
    Topic description, length: 0–128 characters.
    instanceId string
    Instance ID.
    messageType number
    Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
    queueNumber number
    Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
    topicName string
    Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.
    accessPolicies TopicAccessPolicy[]
    description string
    Topic description, length: 0–128 characters.
    instance_id str
    Instance ID.
    message_type int
    Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
    queue_number int
    Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
    topic_name str
    Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.
    access_policies Sequence[TopicAccessPolicyArgs]
    description str
    Topic description, length: 0–128 characters.
    instanceId String
    Instance ID.
    messageType Number
    Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
    queueNumber Number
    Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
    topicName String
    Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.
    accessPolicies List<Property Map>
    description String
    Topic description, length: 0–128 characters.

    Outputs

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

    CreatedTime string
    Topic creation time.
    GroupsInfos List<Volcengine.TopicGroupsInfo>
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceName string
    Instance name.
    QueuesInfos List<Volcengine.TopicQueuesInfo>
    ReadAccessPolicies List<Volcengine.TopicReadAccessPolicy>
    ServiceStatus string
    Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
    CreatedTime string
    Topic creation time.
    GroupsInfos []TopicGroupsInfo
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceName string
    Instance name.
    QueuesInfos []TopicQueuesInfo
    ReadAccessPolicies []TopicReadAccessPolicy
    ServiceStatus string
    Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
    createdTime String
    Topic creation time.
    groupsInfos List<TopicGroupsInfo>
    id String
    The provider-assigned unique ID for this managed resource.
    instanceName String
    Instance name.
    queuesInfos List<TopicQueuesInfo>
    readAccessPolicies List<TopicReadAccessPolicy>
    serviceStatus String
    Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
    createdTime string
    Topic creation time.
    groupsInfos TopicGroupsInfo[]
    id string
    The provider-assigned unique ID for this managed resource.
    instanceName string
    Instance name.
    queuesInfos TopicQueuesInfo[]
    readAccessPolicies TopicReadAccessPolicy[]
    serviceStatus string
    Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
    created_time str
    Topic creation time.
    groups_infos Sequence[TopicGroupsInfo]
    id str
    The provider-assigned unique ID for this managed resource.
    instance_name str
    Instance name.
    queues_infos Sequence[TopicQueuesInfo]
    read_access_policies Sequence[TopicReadAccessPolicy]
    service_status str
    Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
    createdTime String
    Topic creation time.
    groupsInfos List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    instanceName String
    Instance name.
    queuesInfos List<Property Map>
    readAccessPolicies List<Property Map>
    serviceStatus String
    Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.

    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 creation time.
    Description string
    Topic description, length: 0–128 characters.
    GroupsInfos List<Volcengine.TopicGroupsInfo>
    InstanceId string
    Instance ID.
    InstanceName string
    Instance name.
    MessageType int
    Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
    QueueNumber int
    Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
    QueuesInfos List<Volcengine.TopicQueuesInfo>
    ReadAccessPolicies List<Volcengine.TopicReadAccessPolicy>
    ServiceStatus string
    Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
    TopicName string
    Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.
    AccessPolicies []TopicAccessPolicyArgs
    CreatedTime string
    Topic creation time.
    Description string
    Topic description, length: 0–128 characters.
    GroupsInfos []TopicGroupsInfoArgs
    InstanceId string
    Instance ID.
    InstanceName string
    Instance name.
    MessageType int
    Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
    QueueNumber int
    Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
    QueuesInfos []TopicQueuesInfoArgs
    ReadAccessPolicies []TopicReadAccessPolicyArgs
    ServiceStatus string
    Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
    TopicName string
    Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.
    accessPolicies List<TopicAccessPolicy>
    createdTime String
    Topic creation time.
    description String
    Topic description, length: 0–128 characters.
    groupsInfos List<TopicGroupsInfo>
    instanceId String
    Instance ID.
    instanceName String
    Instance name.
    messageType Integer
    Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
    queueNumber Integer
    Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
    queuesInfos List<TopicQueuesInfo>
    readAccessPolicies List<TopicReadAccessPolicy>
    serviceStatus String
    Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
    topicName String
    Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.
    accessPolicies TopicAccessPolicy[]
    createdTime string
    Topic creation time.
    description string
    Topic description, length: 0–128 characters.
    groupsInfos TopicGroupsInfo[]
    instanceId string
    Instance ID.
    instanceName string
    Instance name.
    messageType number
    Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
    queueNumber number
    Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
    queuesInfos TopicQueuesInfo[]
    readAccessPolicies TopicReadAccessPolicy[]
    serviceStatus string
    Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
    topicName string
    Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.
    access_policies Sequence[TopicAccessPolicyArgs]
    created_time str
    Topic creation time.
    description str
    Topic description, length: 0–128 characters.
    groups_infos Sequence[TopicGroupsInfoArgs]
    instance_id str
    Instance ID.
    instance_name str
    Instance name.
    message_type int
    Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
    queue_number int
    Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
    queues_infos Sequence[TopicQueuesInfoArgs]
    read_access_policies Sequence[TopicReadAccessPolicyArgs]
    service_status str
    Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
    topic_name str
    Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.
    accessPolicies List<Property Map>
    createdTime String
    Topic creation time.
    description String
    Topic description, length: 0–128 characters.
    groupsInfos List<Property Map>
    instanceId String
    Instance ID.
    instanceName String
    Instance name.
    messageType Number
    Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
    queueNumber Number
    Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
    queuesInfos List<Property Map>
    readAccessPolicies List<Property Map>
    serviceStatus String
    Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
    topicName String
    Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.

    Supporting Types

    TopicAccessPolicy, TopicAccessPolicyArgs

    AccessKey string
    AccessKey of the RocketMQ key.
    Authority string
    User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.
    AccessKey string
    AccessKey of the RocketMQ key.
    Authority string
    User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.
    accessKey String
    AccessKey of the RocketMQ key.
    authority String
    User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.
    accessKey string
    AccessKey of the RocketMQ key.
    authority string
    User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.
    access_key str
    AccessKey of the RocketMQ key.
    authority str
    User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.
    accessKey String
    AccessKey of the RocketMQ key.
    authority String
    User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.

    TopicGroupsInfo, TopicGroupsInfoArgs

    GroupId string
    Group ID of the consumer group.
    MessageModel string
    Consumption mode. The values are as follows: Clustering: cluster consumption mode. Broadcasting: broadcast consumption mode.
    SubString string
    Subscription rule. This field contains the exact string specified by the consumer group when subscribing to this Topic, usually * or TAG1 || TAG2.
    GroupId string
    Group ID of the consumer group.
    MessageModel string
    Consumption mode. The values are as follows: Clustering: cluster consumption mode. Broadcasting: broadcast consumption mode.
    SubString string
    Subscription rule. This field contains the exact string specified by the consumer group when subscribing to this Topic, usually * or TAG1 || TAG2.
    groupId String
    Group ID of the consumer group.
    messageModel String
    Consumption mode. The values are as follows: Clustering: cluster consumption mode. Broadcasting: broadcast consumption mode.
    subString String
    Subscription rule. This field contains the exact string specified by the consumer group when subscribing to this Topic, usually * or TAG1 || TAG2.
    groupId string
    Group ID of the consumer group.
    messageModel string
    Consumption mode. The values are as follows: Clustering: cluster consumption mode. Broadcasting: broadcast consumption mode.
    subString string
    Subscription rule. This field contains the exact string specified by the consumer group when subscribing to this Topic, usually * or TAG1 || TAG2.
    group_id str
    Group ID of the consumer group.
    message_model str
    Consumption mode. The values are as follows: Clustering: cluster consumption mode. Broadcasting: broadcast consumption mode.
    sub_string str
    Subscription rule. This field contains the exact string specified by the consumer group when subscribing to this Topic, usually * or TAG1 || TAG2.
    groupId String
    Group ID of the consumer group.
    messageModel String
    Consumption mode. The values are as follows: Clustering: cluster consumption mode. Broadcasting: broadcast consumption mode.
    subString String
    Subscription rule. This field contains the exact string specified by the consumer group when subscribing to this Topic, usually * or TAG1 || TAG2.

    TopicQueuesInfo, TopicQueuesInfoArgs

    EndOffset int
    The maximum offset of the current queue, which is the offset of the next message. The position of the latest message is EndOffset - 1.
    LastUpdateTimestamp int
    The time of the most recent message written to this queue.
    MessageCount int
    The number of messages in the current queue. EndOffset is the offset of the next message, so MessageCount = EndOffset - StartOffset.
    QueueId string
    Queue ID.
    StartOffset int
    The earliest message offset in the current queue.
    EndOffset int
    The maximum offset of the current queue, which is the offset of the next message. The position of the latest message is EndOffset - 1.
    LastUpdateTimestamp int
    The time of the most recent message written to this queue.
    MessageCount int
    The number of messages in the current queue. EndOffset is the offset of the next message, so MessageCount = EndOffset - StartOffset.
    QueueId string
    Queue ID.
    StartOffset int
    The earliest message offset in the current queue.
    endOffset Integer
    The maximum offset of the current queue, which is the offset of the next message. The position of the latest message is EndOffset - 1.
    lastUpdateTimestamp Integer
    The time of the most recent message written to this queue.
    messageCount Integer
    The number of messages in the current queue. EndOffset is the offset of the next message, so MessageCount = EndOffset - StartOffset.
    queueId String
    Queue ID.
    startOffset Integer
    The earliest message offset in the current queue.
    endOffset number
    The maximum offset of the current queue, which is the offset of the next message. The position of the latest message is EndOffset - 1.
    lastUpdateTimestamp number
    The time of the most recent message written to this queue.
    messageCount number
    The number of messages in the current queue. EndOffset is the offset of the next message, so MessageCount = EndOffset - StartOffset.
    queueId string
    Queue ID.
    startOffset number
    The earliest message offset in the current queue.
    end_offset int
    The maximum offset of the current queue, which is the offset of the next message. The position of the latest message is EndOffset - 1.
    last_update_timestamp int
    The time of the most recent message written to this queue.
    message_count int
    The number of messages in the current queue. EndOffset is the offset of the next message, so MessageCount = EndOffset - StartOffset.
    queue_id str
    Queue ID.
    start_offset int
    The earliest message offset in the current queue.
    endOffset Number
    The maximum offset of the current queue, which is the offset of the next message. The position of the latest message is EndOffset - 1.
    lastUpdateTimestamp Number
    The time of the most recent message written to this queue.
    messageCount Number
    The number of messages in the current queue. EndOffset is the offset of the next message, so MessageCount = EndOffset - StartOffset.
    queueId String
    Queue ID.
    startOffset Number
    The earliest message offset in the current queue.

    TopicReadAccessPolicy, TopicReadAccessPolicyArgs

    AccessKey string
    AccessKey of the RocketMQ key.
    Authority string
    User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.
    AccessKey string
    AccessKey of the RocketMQ key.
    Authority string
    User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.
    accessKey String
    AccessKey of the RocketMQ key.
    authority String
    User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.
    accessKey string
    AccessKey of the RocketMQ key.
    authority string
    User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.
    access_key str
    AccessKey of the RocketMQ key.
    authority str
    User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.
    accessKey String
    AccessKey of the RocketMQ key.
    authority String
    User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.

    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.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.