Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. rocketmq
  6. Topic
Viewing docs for volcenginecc v0.0.50
published on Monday, Jul 20, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.rocketmq.Topic

volcenginecc logo
Viewing docs for volcenginecc v0.0.50
published on Monday, Jul 20, 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

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

const rocketMQTopicDemo = new volcenginecc.rocketmq.Topic("RocketMQTopicDemo", {
    instanceId: "rocketmq-cnngxxxxx3c2d",
    topicName: "ccapi-test-test-2",
    messageType: 0,
    description: "this is a test",
    queueNumber: 6,
    accessPolicies: [{
        access_key: "TPl1xxxxxxblh5Gpxa79",
        authority: "ALL",
    }],
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

rocket_mq_topic_demo = volcenginecc.rocketmq.Topic("RocketMQTopicDemo",
    instance_id="rocketmq-cnngxxxxx3c2d",
    topic_name="ccapi-test-test-2",
    message_type=0,
    description="this is a test",
    queue_number=6,
    access_policies=[{
        "access_key": "TPl1xxxxxxblh5Gpxa79",
        "authority": "ALL",
    }])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/rocketmq"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rocketmq.NewTopic(ctx, "RocketMQTopicDemo", &rocketmq.TopicArgs{
			InstanceId:  pulumi.String("rocketmq-cnngxxxxx3c2d"),
			TopicName:   pulumi.String("ccapi-test-test-2"),
			MessageType: pulumi.Int(0),
			Description: pulumi.String("this is a test"),
			QueueNumber: pulumi.Int(6),
			AccessPolicies: rocketmq.TopicAccessPolicyArray{
				&rocketmq.TopicAccessPolicyArgs{
					Access_key: "TPl1xxxxxxblh5Gpxa79",
					Authority:  pulumi.String("ALL"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;

return await Deployment.RunAsync(() => 
{
    var rocketMQTopicDemo = new Volcenginecc.Rocketmq.Topic("RocketMQTopicDemo", new()
    {
        InstanceId = "rocketmq-cnngxxxxx3c2d",
        TopicName = "ccapi-test-test-2",
        MessageType = 0,
        Description = "this is a test",
        QueueNumber = 6,
        AccessPolicies = new[]
        {
            new Volcenginecc.Rocketmq.Inputs.TopicAccessPolicyArgs
            {
                Access_key = "TPl1xxxxxxblh5Gpxa79",
                Authority = "ALL",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.rocketmq.Topic;
import com.volcengine.volcenginecc.rocketmq.TopicArgs;
import com.pulumi.volcenginecc.rocketmq.inputs.TopicAccessPolicyArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var rocketMQTopicDemo = new Topic("rocketMQTopicDemo", TopicArgs.builder()
            .instanceId("rocketmq-cnngxxxxx3c2d")
            .topicName("ccapi-test-test-2")
            .messageType(0)
            .description("this is a test")
            .queueNumber(6)
            .accessPolicies(TopicAccessPolicyArgs.builder()
                .access_key("TPl1xxxxxxblh5Gpxa79")
                .authority("ALL")
                .build())
            .build());

    }
}

    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

    pulumi {
  required_providers {
    volcenginecc = {
      source = "pulumi/volcenginecc"
    }
  }
}

resource "volcenginecc_rocketmq_topic" "RocketMQTopicDemo" {
  instance_id  = "rocketmq-cnngxxxxx3c2d"
  topic_name   = "ccapi-test-test-2"
  message_type = 0
  description  = "this is a test"
  queue_number = 6
  access_policies {
    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.


    resource "volcenginecc_rocketmq_topic" "name" {
    # resource properties
}

    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"),
})

    resource "volcenginecc_rocketmq_topic" "volcengineccTopicResource" {
  lifecycle {
    create_before_destroy = true
  }
  instance_id  = "string"
  message_type = 0
  queue_number = 0
  topic_name   = "string"
  access_policies {
    access_key = "string"
    authority  = "string"
  }
  description = "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(com.pulumi.volcenginecc.rocketmq.inputs.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
    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>
    Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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
    Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    Description string
    Topic description, length: 0–128 characters.
    instance_id string
    Instance ID.
    message_type 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.
    queue_number 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.
    topic_name 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 list(object)
    Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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>
    Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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[]
    Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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]
    Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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>
    Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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>
    Consumer group information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceName string
    Instance name.
    QueuesInfos List<Volcengine.TopicQueuesInfo>
    Queue information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    ReadAccessPolicies List<Volcengine.TopicReadAccessPolicy>
    Permissions for each RocketMQ key on the current Topic, permission field Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    ServiceStatus string
    Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
    CreatedTime string
    Topic creation time.
    GroupsInfos []TopicGroupsInfo
    Consumer group information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceName string
    Instance name.
    QueuesInfos []TopicQueuesInfo
    Queue information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    ReadAccessPolicies []TopicReadAccessPolicy
    Permissions for each RocketMQ key on the current Topic, permission field Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    ServiceStatus string
    Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
    created_time string
    Topic creation time.
    groups_infos list(object)
    Consumer group information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    id string
    The provider-assigned unique ID for this managed resource.
    instance_name string
    Instance name.
    queues_infos list(object)
    Queue information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    read_access_policies list(object)
    Permissions for each RocketMQ key on the current Topic, permission field Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    service_status string
    Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
    createdTime String
    Topic creation time.
    groupsInfos List<TopicGroupsInfo>
    Consumer group information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceName String
    Instance name.
    queuesInfos List<TopicQueuesInfo>
    Queue information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    readAccessPolicies List<TopicReadAccessPolicy>
    Permissions for each RocketMQ key on the current Topic, permission field Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    serviceStatus String
    Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
    createdTime string
    Topic creation time.
    groupsInfos TopicGroupsInfo[]
    Consumer group information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceName string
    Instance name.
    queuesInfos TopicQueuesInfo[]
    Queue information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    readAccessPolicies TopicReadAccessPolicy[]
    Permissions for each RocketMQ key on the current Topic, permission field Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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]
    Consumer group information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_name str
    Instance name.
    queues_infos Sequence[TopicQueuesInfo]
    Queue information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    read_access_policies Sequence[TopicReadAccessPolicy]
    Permissions for each RocketMQ key on the current Topic, permission field Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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>
    Consumer group information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceName String
    Instance name.
    queuesInfos List<Property Map>
    Queue information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    readAccessPolicies List<Property Map>
    Permissions for each RocketMQ key on the current Topic, permission field Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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}
    import {
  to = volcenginecc_rocketmq_topic.example
  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>
    Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    CreatedTime string
    Topic creation time.
    Description string
    Topic description, length: 0–128 characters.
    GroupsInfos List<Volcengine.TopicGroupsInfo>
    Consumer group information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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>
    Queue information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    ReadAccessPolicies List<Volcengine.TopicReadAccessPolicy>
    Permissions for each RocketMQ key on the current Topic, permission field Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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
    Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    CreatedTime string
    Topic creation time.
    Description string
    Topic description, length: 0–128 characters.
    GroupsInfos []TopicGroupsInfoArgs
    Consumer group information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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
    Queue information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    ReadAccessPolicies []TopicReadAccessPolicyArgs
    Permissions for each RocketMQ key on the current Topic, permission field Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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 list(object)
    Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    created_time string
    Topic creation time.
    description string
    Topic description, length: 0–128 characters.
    groups_infos list(object)
    Consumer group information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    instance_id string
    Instance ID.
    instance_name string
    Instance name.
    message_type 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.
    queue_number 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.
    queues_infos list(object)
    Queue information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    read_access_policies list(object)
    Permissions for each RocketMQ key on the current Topic, permission field Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    service_status string
    Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
    topic_name 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>
    Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    createdTime String
    Topic creation time.
    description String
    Topic description, length: 0–128 characters.
    groupsInfos List<TopicGroupsInfo>
    Consumer group information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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>
    Queue information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    readAccessPolicies List<TopicReadAccessPolicy>
    Permissions for each RocketMQ key on the current Topic, permission field Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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[]
    Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    createdTime string
    Topic creation time.
    description string
    Topic description, length: 0–128 characters.
    groupsInfos TopicGroupsInfo[]
    Consumer group information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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[]
    Queue information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    readAccessPolicies TopicReadAccessPolicy[]
    Permissions for each RocketMQ key on the current Topic, permission field Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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]
    Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    created_time str
    Topic creation time.
    description str
    Topic description, length: 0–128 characters.
    groups_infos Sequence[TopicGroupsInfoArgs]
    Consumer group information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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]
    Queue information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    read_access_policies Sequence[TopicReadAccessPolicyArgs]
    Permissions for each RocketMQ key on the current Topic, permission field Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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>
    Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    createdTime String
    Topic creation time.
    description String
    Topic description, length: 0–128 characters.
    groupsInfos List<Property Map>
    Consumer group information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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>
    Queue information list. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    readAccessPolicies List<Property Map>
    Permissions for each RocketMQ key on the current Topic, permission field Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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.
    access_key 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.
    group_id string
    Group ID of the consumer group.
    message_model string
    Consumption mode. The values are as follows: Clustering: cluster consumption mode. Broadcasting: broadcast consumption mode.
    sub_string 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.
    end_offset 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.
    last_update_timestamp number
    The time of the most recent message written to this queue.
    message_count number
    The number of messages in the current queue. EndOffset is the offset of the next message, so MessageCount = EndOffset - StartOffset.
    queue_id string
    Queue ID.
    start_offset number
    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.
    access_key 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.50
    published on Monday, Jul 20, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial