Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. rocketmq
  5. RocketMQTopic
Volcengine v0.0.29 published on Tuesday, Apr 29, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.rocketmq.RocketMQTopic

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.29 published on Tuesday, Apr 29, 2025 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage rocketmq topic

    Example Usage

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

const fooZones = volcengine.ecs.Zones({});
const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
    vpcName: "acc-test-vpc",
    cidrBlock: "172.16.0.0/16",
});
const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
    subnetName: "acc-test-subnet",
    cidrBlock: "172.16.0.0/24",
    zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
    vpcId: fooVpc.id,
});
const fooRocketMQInstance = new volcengine.rocketmq.RocketMQInstance("fooRocketMQInstance", {
    zoneIds: [fooZones.then(fooZones => fooZones.zones?.[0]?.id)],
    subnetId: fooSubnet.id,
    version: "4.8",
    computeSpec: "rocketmq.n1.x2.micro",
    storageSpace: 300,
    autoScaleQueue: true,
    fileReservedTime: 10,
    instanceName: "acc-test-rocketmq",
    instanceDescription: "acc-test",
    projectName: "default",
    chargeInfo: {
        chargeType: "PostPaid",
    },
    tags: [{
        key: "k1",
        value: "v1",
    }],
});
const fooRocketMQAccessKey = new volcengine.rocketmq.RocketMQAccessKey("fooRocketMQAccessKey", {
    instanceId: fooRocketMQInstance.id,
    description: "acc-test-key",
    allAuthority: "SUB",
});
const fooRocketMQTopic = new volcengine.rocketmq.RocketMQTopic("fooRocketMQTopic", {
    instanceId: fooRocketMQInstance.id,
    topicName: "acc-test-rocketmq-topic",
    description: "acc-test",
    queueNumber: 2,
    messageType: 1,
    accessPolicies: [{
        accessKey: fooRocketMQAccessKey.accessKey,
        authority: "PUB",
    }],
});

    import pulumi
import pulumi_volcengine as volcengine

foo_zones = volcengine.ecs.zones()
foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id=foo_zones.zones[0].id,
    vpc_id=foo_vpc.id)
foo_rocket_mq_instance = volcengine.rocketmq.RocketMQInstance("fooRocketMQInstance",
    zone_ids=[foo_zones.zones[0].id],
    subnet_id=foo_subnet.id,
    version="4.8",
    compute_spec="rocketmq.n1.x2.micro",
    storage_space=300,
    auto_scale_queue=True,
    file_reserved_time=10,
    instance_name="acc-test-rocketmq",
    instance_description="acc-test",
    project_name="default",
    charge_info=volcengine.rocketmq.RocketMQInstanceChargeInfoArgs(
        charge_type="PostPaid",
    ),
    tags=[volcengine.rocketmq.RocketMQInstanceTagArgs(
        key="k1",
        value="v1",
    )])
foo_rocket_mq_access_key = volcengine.rocketmq.RocketMQAccessKey("fooRocketMQAccessKey",
    instance_id=foo_rocket_mq_instance.id,
    description="acc-test-key",
    all_authority="SUB")
foo_rocket_mq_topic = volcengine.rocketmq.RocketMQTopic("fooRocketMQTopic",
    instance_id=foo_rocket_mq_instance.id,
    topic_name="acc-test-rocketmq-topic",
    description="acc-test",
    queue_number=2,
    message_type=1,
    access_policies=[volcengine.rocketmq.RocketMQTopicAccessPolicyArgs(
        access_key=foo_rocket_mq_access_key.access_key,
        authority="PUB",
    )])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooZones, err := ecs.Zones(ctx, nil, nil)
		if err != nil {
			return err
		}
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.String(fooZones.Zones[0].Id),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		fooRocketMQInstance, err := rocketmq.NewRocketMQInstance(ctx, "fooRocketMQInstance", &rocketmq.RocketMQInstanceArgs{
			ZoneIds: pulumi.StringArray{
				pulumi.String(fooZones.Zones[0].Id),
			},
			SubnetId:            fooSubnet.ID(),
			Version:             pulumi.String("4.8"),
			ComputeSpec:         pulumi.String("rocketmq.n1.x2.micro"),
			StorageSpace:        pulumi.Int(300),
			AutoScaleQueue:      pulumi.Bool(true),
			FileReservedTime:    pulumi.Int(10),
			InstanceName:        pulumi.String("acc-test-rocketmq"),
			InstanceDescription: pulumi.String("acc-test"),
			ProjectName:         pulumi.String("default"),
			ChargeInfo: &rocketmq.RocketMQInstanceChargeInfoArgs{
				ChargeType: pulumi.String("PostPaid"),
			},
			Tags: rocketmq.RocketMQInstanceTagArray{
				&rocketmq.RocketMQInstanceTagArgs{
					Key:   pulumi.String("k1"),
					Value: pulumi.String("v1"),
				},
			},
		})
		if err != nil {
			return err
		}
		fooRocketMQAccessKey, err := rocketmq.NewRocketMQAccessKey(ctx, "fooRocketMQAccessKey", &rocketmq.RocketMQAccessKeyArgs{
			InstanceId:   fooRocketMQInstance.ID(),
			Description:  pulumi.String("acc-test-key"),
			AllAuthority: pulumi.String("SUB"),
		})
		if err != nil {
			return err
		}
		_, err = rocketmq.NewRocketMQTopic(ctx, "fooRocketMQTopic", &rocketmq.RocketMQTopicArgs{
			InstanceId:  fooRocketMQInstance.ID(),
			TopicName:   pulumi.String("acc-test-rocketmq-topic"),
			Description: pulumi.String("acc-test"),
			QueueNumber: pulumi.Int(2),
			MessageType: pulumi.Int(1),
			AccessPolicies: rocketmq.RocketMQTopicAccessPolicyArray{
				&rocketmq.RocketMQTopicAccessPolicyArgs{
					AccessKey: fooRocketMQAccessKey.AccessKey,
					Authority: pulumi.String("PUB"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var fooZones = Volcengine.Ecs.Zones.Invoke();

    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });

    var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
        VpcId = fooVpc.Id,
    });

    var fooRocketMQInstance = new Volcengine.Rocketmq.RocketMQInstance("fooRocketMQInstance", new()
    {
        ZoneIds = new[]
        {
            fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
        },
        SubnetId = fooSubnet.Id,
        Version = "4.8",
        ComputeSpec = "rocketmq.n1.x2.micro",
        StorageSpace = 300,
        AutoScaleQueue = true,
        FileReservedTime = 10,
        InstanceName = "acc-test-rocketmq",
        InstanceDescription = "acc-test",
        ProjectName = "default",
        ChargeInfo = new Volcengine.Rocketmq.Inputs.RocketMQInstanceChargeInfoArgs
        {
            ChargeType = "PostPaid",
        },
        Tags = new[]
        {
            new Volcengine.Rocketmq.Inputs.RocketMQInstanceTagArgs
            {
                Key = "k1",
                Value = "v1",
            },
        },
    });

    var fooRocketMQAccessKey = new Volcengine.Rocketmq.RocketMQAccessKey("fooRocketMQAccessKey", new()
    {
        InstanceId = fooRocketMQInstance.Id,
        Description = "acc-test-key",
        AllAuthority = "SUB",
    });

    var fooRocketMQTopic = new Volcengine.Rocketmq.RocketMQTopic("fooRocketMQTopic", new()
    {
        InstanceId = fooRocketMQInstance.Id,
        TopicName = "acc-test-rocketmq-topic",
        Description = "acc-test",
        QueueNumber = 2,
        MessageType = 1,
        AccessPolicies = new[]
        {
            new Volcengine.Rocketmq.Inputs.RocketMQTopicAccessPolicyArgs
            {
                AccessKey = fooRocketMQAccessKey.AccessKey,
                Authority = "PUB",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.ZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.rocketmq.RocketMQInstance;
import com.pulumi.volcengine.rocketmq.RocketMQInstanceArgs;
import com.pulumi.volcengine.rocketmq.inputs.RocketMQInstanceChargeInfoArgs;
import com.pulumi.volcengine.rocketmq.inputs.RocketMQInstanceTagArgs;
import com.pulumi.volcengine.rocketmq.RocketMQAccessKey;
import com.pulumi.volcengine.rocketmq.RocketMQAccessKeyArgs;
import com.pulumi.volcengine.rocketmq.RocketMQTopic;
import com.pulumi.volcengine.rocketmq.RocketMQTopicArgs;
import com.pulumi.volcengine.rocketmq.inputs.RocketMQTopicAccessPolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var fooZones = EcsFunctions.Zones();

        var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());

        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
            .vpcId(fooVpc.id())
            .build());

        var fooRocketMQInstance = new RocketMQInstance("fooRocketMQInstance", RocketMQInstanceArgs.builder()        
            .zoneIds(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
            .subnetId(fooSubnet.id())
            .version("4.8")
            .computeSpec("rocketmq.n1.x2.micro")
            .storageSpace(300)
            .autoScaleQueue(true)
            .fileReservedTime(10)
            .instanceName("acc-test-rocketmq")
            .instanceDescription("acc-test")
            .projectName("default")
            .chargeInfo(RocketMQInstanceChargeInfoArgs.builder()
                .chargeType("PostPaid")
                .build())
            .tags(RocketMQInstanceTagArgs.builder()
                .key("k1")
                .value("v1")
                .build())
            .build());

        var fooRocketMQAccessKey = new RocketMQAccessKey("fooRocketMQAccessKey", RocketMQAccessKeyArgs.builder()        
            .instanceId(fooRocketMQInstance.id())
            .description("acc-test-key")
            .allAuthority("SUB")
            .build());

        var fooRocketMQTopic = new RocketMQTopic("fooRocketMQTopic", RocketMQTopicArgs.builder()        
            .instanceId(fooRocketMQInstance.id())
            .topicName("acc-test-rocketmq-topic")
            .description("acc-test")
            .queueNumber(2)
            .messageType(1)
            .accessPolicies(RocketMQTopicAccessPolicyArgs.builder()
                .accessKey(fooRocketMQAccessKey.accessKey())
                .authority("PUB")
                .build())
            .build());

    }
}

    resources:
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
  fooSubnet:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.0.0/24
      zoneId: ${fooZones.zones[0].id}
      vpcId: ${fooVpc.id}
  fooRocketMQInstance:
    type: volcengine:rocketmq:RocketMQInstance
    properties:
      zoneIds:
        - ${fooZones.zones[0].id}
      subnetId: ${fooSubnet.id}
      version: '4.8'
      computeSpec: rocketmq.n1.x2.micro
      storageSpace: 300
      autoScaleQueue: true
      fileReservedTime: 10
      instanceName: acc-test-rocketmq
      instanceDescription: acc-test
      projectName: default
      chargeInfo:
        chargeType: PostPaid
      tags:
        - key: k1
          value: v1
  fooRocketMQAccessKey:
    type: volcengine:rocketmq:RocketMQAccessKey
    properties:
      instanceId: ${fooRocketMQInstance.id}
      description: acc-test-key
      allAuthority: SUB
  fooRocketMQTopic:
    type: volcengine:rocketmq:RocketMQTopic
    properties:
      instanceId: ${fooRocketMQInstance.id}
      topicName: acc-test-rocketmq-topic
      description: acc-test
      queueNumber: 2
      messageType: 1
      accessPolicies:
        - accessKey: ${fooRocketMQAccessKey.accessKey}
          authority: PUB
variables:
  fooZones:
    fn::invoke:
      Function: volcengine:ecs:Zones
      Arguments: {}

    Create RocketMQTopic Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RocketMQTopic(name: string, args: RocketMQTopicArgs, opts?: CustomResourceOptions);
    @overload
def RocketMQTopic(resource_name: str,
                  args: RocketMQTopicArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def RocketMQTopic(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[RocketMQTopicAccessPolicyArgs]] = None,
                  description: Optional[str] = None)
    func NewRocketMQTopic(ctx *Context, name string, args RocketMQTopicArgs, opts ...ResourceOption) (*RocketMQTopic, error)
    public RocketMQTopic(string name, RocketMQTopicArgs args, CustomResourceOptions? opts = null)
    public RocketMQTopic(String name, RocketMQTopicArgs args)
public RocketMQTopic(String name, RocketMQTopicArgs args, CustomResourceOptions options)

    type: volcengine:rocketmq:RocketMQTopic
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 RocketMQTopicArgs
    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 RocketMQTopicArgs
    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 RocketMQTopicArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RocketMQTopicArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RocketMQTopicArgs
    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 rocketMQTopicResource = new Volcengine.Rocketmq.RocketMQTopic("rocketMQTopicResource", new()
{
    InstanceId = "string",
    MessageType = 0,
    QueueNumber = 0,
    TopicName = "string",
    AccessPolicies = new[]
    {
        new Volcengine.Rocketmq.Inputs.RocketMQTopicAccessPolicyArgs
        {
            AccessKey = "string",
            Authority = "string",
        },
    },
    Description = "string",
});

    example, err := rocketmq.NewRocketMQTopic(ctx, "rocketMQTopicResource", &rocketmq.RocketMQTopicArgs{
	InstanceId:  pulumi.String("string"),
	MessageType: pulumi.Int(0),
	QueueNumber: pulumi.Int(0),
	TopicName:   pulumi.String("string"),
	AccessPolicies: rocketmq.RocketMQTopicAccessPolicyArray{
		&rocketmq.RocketMQTopicAccessPolicyArgs{
			AccessKey: pulumi.String("string"),
			Authority: pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
})

    var rocketMQTopicResource = new RocketMQTopic("rocketMQTopicResource", RocketMQTopicArgs.builder()
    .instanceId("string")
    .messageType(0)
    .queueNumber(0)
    .topicName("string")
    .accessPolicies(RocketMQTopicAccessPolicyArgs.builder()
        .accessKey("string")
        .authority("string")
        .build())
    .description("string")
    .build());

    rocket_mq_topic_resource = volcengine.rocketmq.RocketMQTopic("rocketMQTopicResource",
    instance_id="string",
    message_type=0,
    queue_number=0,
    topic_name="string",
    access_policies=[{
        "access_key": "string",
        "authority": "string",
    }],
    description="string")

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

    type: volcengine:rocketmq:RocketMQTopic
properties:
    accessPolicies:
        - accessKey: string
          authority: string
    description: string
    instanceId: string
    messageType: 0
    queueNumber: 0
    topicName: string

    RocketMQTopic 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 RocketMQTopic resource accepts the following input properties:

    InstanceId string
    The id of rocketmq instance.
    MessageType int
    The type of the message. Valid values: 0: Regular message, 1: Transaction message, 2: Partition order message, 3: Global sequential message, 4: Delay message.
    QueueNumber int
    The maximum number of queues for the current topic, which cannot exceed the remaining available queues for the current rocketmq instance.
    TopicName string
    The name of the rocketmq topic.
    AccessPolicies List<RocketMQTopicAccessPolicy>
    The access policies of the rocketmq topic. This field can only be added or modified. Deleting this field is invalid.
    Description string
    The description of the rocketmq topic.
    InstanceId string
    The id of rocketmq instance.
    MessageType int
    The type of the message. Valid values: 0: Regular message, 1: Transaction message, 2: Partition order message, 3: Global sequential message, 4: Delay message.
    QueueNumber int
    The maximum number of queues for the current topic, which cannot exceed the remaining available queues for the current rocketmq instance.
    TopicName string
    The name of the rocketmq topic.
    AccessPolicies []RocketMQTopicAccessPolicyArgs
    The access policies of the rocketmq topic. This field can only be added or modified. Deleting this field is invalid.
    Description string
    The description of the rocketmq topic.
    instanceId String
    The id of rocketmq instance.
    messageType Integer
    The type of the message. Valid values: 0: Regular message, 1: Transaction message, 2: Partition order message, 3: Global sequential message, 4: Delay message.
    queueNumber Integer
    The maximum number of queues for the current topic, which cannot exceed the remaining available queues for the current rocketmq instance.
    topicName String
    The name of the rocketmq topic.
    accessPolicies List<RocketMQTopicAccessPolicy>
    The access policies of the rocketmq topic. This field can only be added or modified. Deleting this field is invalid.
    description String
    The description of the rocketmq topic.
    instanceId string
    The id of rocketmq instance.
    messageType number
    The type of the message. Valid values: 0: Regular message, 1: Transaction message, 2: Partition order message, 3: Global sequential message, 4: Delay message.
    queueNumber number
    The maximum number of queues for the current topic, which cannot exceed the remaining available queues for the current rocketmq instance.
    topicName string
    The name of the rocketmq topic.
    accessPolicies RocketMQTopicAccessPolicy[]
    The access policies of the rocketmq topic. This field can only be added or modified. Deleting this field is invalid.
    description string
    The description of the rocketmq topic.
    instance_id str
    The id of rocketmq instance.
    message_type int
    The type of the message. Valid values: 0: Regular message, 1: Transaction message, 2: Partition order message, 3: Global sequential message, 4: Delay message.
    queue_number int
    The maximum number of queues for the current topic, which cannot exceed the remaining available queues for the current rocketmq instance.
    topic_name str
    The name of the rocketmq topic.
    access_policies Sequence[RocketMQTopicAccessPolicyArgs]
    The access policies of the rocketmq topic. This field can only be added or modified. Deleting this field is invalid.
    description str
    The description of the rocketmq topic.
    instanceId String
    The id of rocketmq instance.
    messageType Number
    The type of the message. Valid values: 0: Regular message, 1: Transaction message, 2: Partition order message, 3: Global sequential message, 4: Delay message.
    queueNumber Number
    The maximum number of queues for the current topic, which cannot exceed the remaining available queues for the current rocketmq instance.
    topicName String
    The name of the rocketmq topic.
    accessPolicies List<Property Map>
    The access policies of the rocketmq topic. This field can only be added or modified. Deleting this field is invalid.
    description String
    The description of the rocketmq topic.

    Outputs

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

    Groups List<RocketMQTopicGroup>
    The groups information of the rocketmq topic.
    Id string
    The provider-assigned unique ID for this managed resource.
    Queues List<RocketMQTopicQueue>
    The queues information of the rocketmq topic.
    Groups []RocketMQTopicGroup
    The groups information of the rocketmq topic.
    Id string
    The provider-assigned unique ID for this managed resource.
    Queues []RocketMQTopicQueue
    The queues information of the rocketmq topic.
    groups List<RocketMQTopicGroup>
    The groups information of the rocketmq topic.
    id String
    The provider-assigned unique ID for this managed resource.
    queues List<RocketMQTopicQueue>
    The queues information of the rocketmq topic.
    groups RocketMQTopicGroup[]
    The groups information of the rocketmq topic.
    id string
    The provider-assigned unique ID for this managed resource.
    queues RocketMQTopicQueue[]
    The queues information of the rocketmq topic.
    groups Sequence[RocketMQTopicGroup]
    The groups information of the rocketmq topic.
    id str
    The provider-assigned unique ID for this managed resource.
    queues Sequence[RocketMQTopicQueue]
    The queues information of the rocketmq topic.
    groups List<Property Map>
    The groups information of the rocketmq topic.
    id String
    The provider-assigned unique ID for this managed resource.
    queues List<Property Map>
    The queues information of the rocketmq topic.

    Look up Existing RocketMQTopic Resource

    Get an existing RocketMQTopic 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?: RocketMQTopicState, opts?: CustomResourceOptions): RocketMQTopic
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_policies: Optional[Sequence[RocketMQTopicAccessPolicyArgs]] = None,
        description: Optional[str] = None,
        groups: Optional[Sequence[RocketMQTopicGroupArgs]] = None,
        instance_id: Optional[str] = None,
        message_type: Optional[int] = None,
        queue_number: Optional[int] = None,
        queues: Optional[Sequence[RocketMQTopicQueueArgs]] = None,
        topic_name: Optional[str] = None) -> RocketMQTopic
    func GetRocketMQTopic(ctx *Context, name string, id IDInput, state *RocketMQTopicState, opts ...ResourceOption) (*RocketMQTopic, error)
    public static RocketMQTopic Get(string name, Input<string> id, RocketMQTopicState? state, CustomResourceOptions? opts = null)
    public static RocketMQTopic get(String name, Output<String> id, RocketMQTopicState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:rocketmq:RocketMQTopic    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<RocketMQTopicAccessPolicy>
    The access policies of the rocketmq topic. This field can only be added or modified. Deleting this field is invalid.
    Description string
    The description of the rocketmq topic.
    Groups List<RocketMQTopicGroup>
    The groups information of the rocketmq topic.
    InstanceId string
    The id of rocketmq instance.
    MessageType int
    The type of the message. Valid values: 0: Regular message, 1: Transaction message, 2: Partition order message, 3: Global sequential message, 4: Delay message.
    QueueNumber int
    The maximum number of queues for the current topic, which cannot exceed the remaining available queues for the current rocketmq instance.
    Queues List<RocketMQTopicQueue>
    The queues information of the rocketmq topic.
    TopicName string
    The name of the rocketmq topic.
    AccessPolicies []RocketMQTopicAccessPolicyArgs
    The access policies of the rocketmq topic. This field can only be added or modified. Deleting this field is invalid.
    Description string
    The description of the rocketmq topic.
    Groups []RocketMQTopicGroupArgs
    The groups information of the rocketmq topic.
    InstanceId string
    The id of rocketmq instance.
    MessageType int
    The type of the message. Valid values: 0: Regular message, 1: Transaction message, 2: Partition order message, 3: Global sequential message, 4: Delay message.
    QueueNumber int
    The maximum number of queues for the current topic, which cannot exceed the remaining available queues for the current rocketmq instance.
    Queues []RocketMQTopicQueueArgs
    The queues information of the rocketmq topic.
    TopicName string
    The name of the rocketmq topic.
    accessPolicies List<RocketMQTopicAccessPolicy>
    The access policies of the rocketmq topic. This field can only be added or modified. Deleting this field is invalid.
    description String
    The description of the rocketmq topic.
    groups List<RocketMQTopicGroup>
    The groups information of the rocketmq topic.
    instanceId String
    The id of rocketmq instance.
    messageType Integer
    The type of the message. Valid values: 0: Regular message, 1: Transaction message, 2: Partition order message, 3: Global sequential message, 4: Delay message.
    queueNumber Integer
    The maximum number of queues for the current topic, which cannot exceed the remaining available queues for the current rocketmq instance.
    queues List<RocketMQTopicQueue>
    The queues information of the rocketmq topic.
    topicName String
    The name of the rocketmq topic.
    accessPolicies RocketMQTopicAccessPolicy[]
    The access policies of the rocketmq topic. This field can only be added or modified. Deleting this field is invalid.
    description string
    The description of the rocketmq topic.
    groups RocketMQTopicGroup[]
    The groups information of the rocketmq topic.
    instanceId string
    The id of rocketmq instance.
    messageType number
    The type of the message. Valid values: 0: Regular message, 1: Transaction message, 2: Partition order message, 3: Global sequential message, 4: Delay message.
    queueNumber number
    The maximum number of queues for the current topic, which cannot exceed the remaining available queues for the current rocketmq instance.
    queues RocketMQTopicQueue[]
    The queues information of the rocketmq topic.
    topicName string
    The name of the rocketmq topic.
    access_policies Sequence[RocketMQTopicAccessPolicyArgs]
    The access policies of the rocketmq topic. This field can only be added or modified. Deleting this field is invalid.
    description str
    The description of the rocketmq topic.
    groups Sequence[RocketMQTopicGroupArgs]
    The groups information of the rocketmq topic.
    instance_id str
    The id of rocketmq instance.
    message_type int
    The type of the message. Valid values: 0: Regular message, 1: Transaction message, 2: Partition order message, 3: Global sequential message, 4: Delay message.
    queue_number int
    The maximum number of queues for the current topic, which cannot exceed the remaining available queues for the current rocketmq instance.
    queues Sequence[RocketMQTopicQueueArgs]
    The queues information of the rocketmq topic.
    topic_name str
    The name of the rocketmq topic.
    accessPolicies List<Property Map>
    The access policies of the rocketmq topic. This field can only be added or modified. Deleting this field is invalid.
    description String
    The description of the rocketmq topic.
    groups List<Property Map>
    The groups information of the rocketmq topic.
    instanceId String
    The id of rocketmq instance.
    messageType Number
    The type of the message. Valid values: 0: Regular message, 1: Transaction message, 2: Partition order message, 3: Global sequential message, 4: Delay message.
    queueNumber Number
    The maximum number of queues for the current topic, which cannot exceed the remaining available queues for the current rocketmq instance.
    queues List<Property Map>
    The queues information of the rocketmq topic.
    topicName String
    The name of the rocketmq topic.

    Supporting Types

    RocketMQTopicAccessPolicy, RocketMQTopicAccessPolicyArgs

    AccessKey string
    The access key of the rocketmq key.
    Authority string
    The authority of the rocketmq key for the current topic. Valid values: ALL, PUB, SUB, DENY. Default is DENY.
    AccessKey string
    The access key of the rocketmq key.
    Authority string
    The authority of the rocketmq key for the current topic. Valid values: ALL, PUB, SUB, DENY. Default is DENY.
    accessKey String
    The access key of the rocketmq key.
    authority String
    The authority of the rocketmq key for the current topic. Valid values: ALL, PUB, SUB, DENY. Default is DENY.
    accessKey string
    The access key of the rocketmq key.
    authority string
    The authority of the rocketmq key for the current topic. Valid values: ALL, PUB, SUB, DENY. Default is DENY.
    access_key str
    The access key of the rocketmq key.
    authority str
    The authority of the rocketmq key for the current topic. Valid values: ALL, PUB, SUB, DENY. Default is DENY.
    accessKey String
    The access key of the rocketmq key.
    authority String
    The authority of the rocketmq key for the current topic. Valid values: ALL, PUB, SUB, DENY. Default is DENY.

    RocketMQTopicGroup, RocketMQTopicGroupArgs

    GroupId string
    The id of the rocketmq group.
    MessageModel string
    The message model of the rocketmq group.
    SubString string
    The sub string of the rocketmq group.
    GroupId string
    The id of the rocketmq group.
    MessageModel string
    The message model of the rocketmq group.
    SubString string
    The sub string of the rocketmq group.
    groupId String
    The id of the rocketmq group.
    messageModel String
    The message model of the rocketmq group.
    subString String
    The sub string of the rocketmq group.
    groupId string
    The id of the rocketmq group.
    messageModel string
    The message model of the rocketmq group.
    subString string
    The sub string of the rocketmq group.
    group_id str
    The id of the rocketmq group.
    message_model str
    The message model of the rocketmq group.
    sub_string str
    The sub string of the rocketmq group.
    groupId String
    The id of the rocketmq group.
    messageModel String
    The message model of the rocketmq group.
    subString String
    The sub string of the rocketmq group.

    RocketMQTopicQueue, RocketMQTopicQueueArgs

    EndOffset int
    The end offset of the rocketmq queue.
    LastUpdateTimestamp int
    The last update timestamp of the rocketmq queue.
    MessageCount int
    The message count of the rocketmq queue.
    QueueId string
    The id of the rocketmq queue.
    StartOffset int
    The start offset of the rocketmq queue.
    EndOffset int
    The end offset of the rocketmq queue.
    LastUpdateTimestamp int
    The last update timestamp of the rocketmq queue.
    MessageCount int
    The message count of the rocketmq queue.
    QueueId string
    The id of the rocketmq queue.
    StartOffset int
    The start offset of the rocketmq queue.
    endOffset Integer
    The end offset of the rocketmq queue.
    lastUpdateTimestamp Integer
    The last update timestamp of the rocketmq queue.
    messageCount Integer
    The message count of the rocketmq queue.
    queueId String
    The id of the rocketmq queue.
    startOffset Integer
    The start offset of the rocketmq queue.
    endOffset number
    The end offset of the rocketmq queue.
    lastUpdateTimestamp number
    The last update timestamp of the rocketmq queue.
    messageCount number
    The message count of the rocketmq queue.
    queueId string
    The id of the rocketmq queue.
    startOffset number
    The start offset of the rocketmq queue.
    end_offset int
    The end offset of the rocketmq queue.
    last_update_timestamp int
    The last update timestamp of the rocketmq queue.
    message_count int
    The message count of the rocketmq queue.
    queue_id str
    The id of the rocketmq queue.
    start_offset int
    The start offset of the rocketmq queue.
    endOffset Number
    The end offset of the rocketmq queue.
    lastUpdateTimestamp Number
    The last update timestamp of the rocketmq queue.
    messageCount Number
    The message count of the rocketmq queue.
    queueId String
    The id of the rocketmq queue.
    startOffset Number
    The start offset of the rocketmq queue.

    Import

    RocketmqTopic can be imported using the instance_id:topic_name, e.g.

    $ pulumi import volcengine:rocketmq/rocketMQTopic:RocketMQTopic default resource_id

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.29 published on Tuesday, Apr 29, 2025 by Volcengine
    volcengine/pulumi-volcengine