published on Thursday, Apr 23, 2026 by Volcengine
published on Thursday, Apr 23, 2026 by Volcengine
The cloud-native messaging engine is 100% compatible with the Apache Kafka protocol. It offers a fully managed, high-throughput, low-latency, highly available, highly scalable, and highly stable distributed messaging engine service based on cloud-native architecture. Supports flexible and dynamic scaling, integrated stream and batch processing, and provides enterprise-grade real-time stream data processing capabilities for large-scale data. Helps you build the ‘central nervous system’ for data processing, widely used in scenarios such as log collection, data aggregation, and offline data analysis.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
const bMQInstanceDemo = new volcenginecc.bmq.Instance("BMQInstanceDemo", {
name: "BMQInstanceDemo",
billingType: "POST",
projectName: "default",
specification: "bmq.standard",
vpcId: "vpc-miltj87lh2ww5smt1bxxxxx",
messageRetention: 1,
endpoints: {
"public": {
eipId: "eip-3nriu2y2ufwu8931exxxxx",
},
overlay: {
vpcIds: ["vpc-miltj87lh2ww5smt1bxxxxx"],
},
},
securityGroupIdLists: ["sg-3nqnz9en1ucxs931eaxxxxx"],
subnetIdLists: ["subnet-w02wsq25fitc865ykaxxxxx"],
zoneIdLists: ["cn-beijing-a"],
tags: [{
key: "env",
type: "CUSTOM",
value: "test",
}],
});
import pulumi
import pulumi_volcenginecc as volcenginecc
b_mq_instance_demo = volcenginecc.bmq.Instance("BMQInstanceDemo",
name="BMQInstanceDemo",
billing_type="POST",
project_name="default",
specification="bmq.standard",
vpc_id="vpc-miltj87lh2ww5smt1bxxxxx",
message_retention=1,
endpoints={
"public": {
"eip_id": "eip-3nriu2y2ufwu8931exxxxx",
},
"overlay": {
"vpc_ids": ["vpc-miltj87lh2ww5smt1bxxxxx"],
},
},
security_group_id_lists=["sg-3nqnz9en1ucxs931eaxxxxx"],
subnet_id_lists=["subnet-w02wsq25fitc865ykaxxxxx"],
zone_id_lists=["cn-beijing-a"],
tags=[{
"key": "env",
"type": "CUSTOM",
"value": "test",
}])
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/bmq"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := bmq.NewInstance(ctx, "BMQInstanceDemo", &bmq.InstanceArgs{
Name: pulumi.String("BMQInstanceDemo"),
BillingType: pulumi.String("POST"),
ProjectName: pulumi.String("default"),
Specification: pulumi.String("bmq.standard"),
VpcId: pulumi.String("vpc-miltj87lh2ww5smt1bxxxxx"),
MessageRetention: pulumi.Int(1),
Endpoints: &bmq.InstanceEndpointsArgs{
Public: &bmq.InstanceEndpointsPublicArgs{
EipId: pulumi.String("eip-3nriu2y2ufwu8931exxxxx"),
},
Overlay: &bmq.InstanceEndpointsOverlayArgs{
VpcIds: pulumi.StringArray{
pulumi.String("vpc-miltj87lh2ww5smt1bxxxxx"),
},
},
},
SecurityGroupIdLists: pulumi.StringArray{
pulumi.String("sg-3nqnz9en1ucxs931eaxxxxx"),
},
SubnetIdLists: pulumi.StringArray{
pulumi.String("subnet-w02wsq25fitc865ykaxxxxx"),
},
ZoneIdLists: pulumi.StringArray{
pulumi.String("cn-beijing-a"),
},
Tags: bmq.InstanceTagArray{
&bmq.InstanceTagArgs{
Key: pulumi.String("env"),
Type: pulumi.String("CUSTOM"),
Value: pulumi.String("test"),
},
},
})
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 bMQInstanceDemo = new Volcenginecc.Bmq.Instance("BMQInstanceDemo", new()
{
Name = "BMQInstanceDemo",
BillingType = "POST",
ProjectName = "default",
Specification = "bmq.standard",
VpcId = "vpc-miltj87lh2ww5smt1bxxxxx",
MessageRetention = 1,
Endpoints = new Volcenginecc.Bmq.Inputs.InstanceEndpointsArgs
{
Public = new Volcenginecc.Bmq.Inputs.InstanceEndpointsPublicArgs
{
EipId = "eip-3nriu2y2ufwu8931exxxxx",
},
Overlay = new Volcenginecc.Bmq.Inputs.InstanceEndpointsOverlayArgs
{
VpcIds = new[]
{
"vpc-miltj87lh2ww5smt1bxxxxx",
},
},
},
SecurityGroupIdLists = new[]
{
"sg-3nqnz9en1ucxs931eaxxxxx",
},
SubnetIdLists = new[]
{
"subnet-w02wsq25fitc865ykaxxxxx",
},
ZoneIdLists = new[]
{
"cn-beijing-a",
},
Tags = new[]
{
new Volcenginecc.Bmq.Inputs.InstanceTagArgs
{
Key = "env",
Type = "CUSTOM",
Value = "test",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.bmq.Instance;
import com.volcengine.volcenginecc.bmq.InstanceArgs;
import com.pulumi.volcenginecc.bmq.inputs.InstanceEndpointsArgs;
import com.pulumi.volcenginecc.bmq.inputs.InstanceEndpointsPublicArgs;
import com.pulumi.volcenginecc.bmq.inputs.InstanceEndpointsOverlayArgs;
import com.pulumi.volcenginecc.bmq.inputs.InstanceTagArgs;
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) {
var bMQInstanceDemo = new Instance("bMQInstanceDemo", InstanceArgs.builder()
.name("BMQInstanceDemo")
.billingType("POST")
.projectName("default")
.specification("bmq.standard")
.vpcId("vpc-miltj87lh2ww5smt1bxxxxx")
.messageRetention(1)
.endpoints(InstanceEndpointsArgs.builder()
.public_(InstanceEndpointsPublicArgs.builder()
.eipId("eip-3nriu2y2ufwu8931exxxxx")
.build())
.overlay(InstanceEndpointsOverlayArgs.builder()
.vpcIds("vpc-miltj87lh2ww5smt1bxxxxx")
.build())
.build())
.securityGroupIdLists("sg-3nqnz9en1ucxs931eaxxxxx")
.subnetIdLists("subnet-w02wsq25fitc865ykaxxxxx")
.zoneIdLists("cn-beijing-a")
.tags(InstanceTagArgs.builder()
.key("env")
.type("CUSTOM")
.value("test")
.build())
.build());
}
}
resources:
bMQInstanceDemo:
type: volcenginecc:bmq:Instance
name: BMQInstanceDemo
properties:
name: BMQInstanceDemo
billingType: POST
projectName: default
specification: bmq.standard
vpcId: vpc-miltj87lh2ww5smt1bxxxxx
messageRetention: 1
endpoints:
public:
eipId: eip-3nriu2y2ufwu8931exxxxx
overlay:
vpcIds:
- vpc-miltj87lh2ww5smt1bxxxxx
securityGroupIdLists:
- sg-3nqnz9en1ucxs931eaxxxxx
subnetIdLists:
- subnet-w02wsq25fitc865ykaxxxxx
zoneIdLists:
- cn-beijing-a
tags:
- key: env
type: CUSTOM
value: test
Create Instance Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);@overload
def Instance(resource_name: str,
args: InstanceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Instance(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_name: Optional[str] = None,
zone_id_lists: Optional[Sequence[str]] = None,
billing_type: Optional[str] = None,
vpc_id: Optional[str] = None,
subnet_id_lists: Optional[Sequence[str]] = None,
specification: Optional[str] = None,
security_group_id_lists: Optional[Sequence[str]] = None,
name: Optional[str] = None,
eip_id: Optional[str] = None,
message_retention: Optional[int] = None,
endpoints: Optional[InstanceEndpointsArgs] = None,
auto_renew: Optional[str] = None,
tags: Optional[Sequence[InstanceTagArgs]] = None,
times: Optional[int] = None,
description: Optional[str] = None,
billing_period: Optional[str] = None)func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)
type: volcenginecc:bmq:Instance
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 InstanceArgs
- 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 InstanceArgs
- 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 InstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Instance 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 Instance resource accepts the following input properties:
- Billing
Type string - Instance billing method. Options: POST—pay-as-you-go; MIX—yearly/monthly subscription
- Name string
- Custom BMQ instance name. Constraints: must consist of lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- Project
Name string - Project name associated with the instance
- Security
Group List<string>Id Lists - Security group list used by the instance
- Specification string
- Instance specification
- Subnet
Id List<string>Lists - Subnet list used by the instance
- Vpc
Id string - VPC ID where the instance is located
- Zone
Id List<string>Lists - List of availability zones for the instance
- Auto
Renew string - Enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal.
- Billing
Period string - Unit of purchase duration. Options: MONTHLY—monthly subscription; YEARLY—yearly subscription
- Description string
- Instance description
- Eip
Id string - Whether public access is enabled for the instance. If public access is required, configure the ID of a public IP in the same region
- Endpoints
Volcengine.
Instance Endpoints - Response data for all instance endpoints
- Message
Retention int - Message retention period for all Topics under the instance, in hours
-
List<Volcengine.
Instance Tag> - Times int
- Purchase duration for yearly/monthly subscription instances, in months
- Billing
Type string - Instance billing method. Options: POST—pay-as-you-go; MIX—yearly/monthly subscription
- Name string
- Custom BMQ instance name. Constraints: must consist of lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- Project
Name string - Project name associated with the instance
- Security
Group []stringId Lists - Security group list used by the instance
- Specification string
- Instance specification
- Subnet
Id []stringLists - Subnet list used by the instance
- Vpc
Id string - VPC ID where the instance is located
- Zone
Id []stringLists - List of availability zones for the instance
- Auto
Renew string - Enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal.
- Billing
Period string - Unit of purchase duration. Options: MONTHLY—monthly subscription; YEARLY—yearly subscription
- Description string
- Instance description
- Eip
Id string - Whether public access is enabled for the instance. If public access is required, configure the ID of a public IP in the same region
- Endpoints
Instance
Endpoints Args - Response data for all instance endpoints
- Message
Retention int - Message retention period for all Topics under the instance, in hours
-
[]Instance
Tag Args - Times int
- Purchase duration for yearly/monthly subscription instances, in months
- billing
Type String - Instance billing method. Options: POST—pay-as-you-go; MIX—yearly/monthly subscription
- name String
- Custom BMQ instance name. Constraints: must consist of lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- project
Name String - Project name associated with the instance
- security
Group List<String>Id Lists - Security group list used by the instance
- specification String
- Instance specification
- subnet
Id List<String>Lists - Subnet list used by the instance
- vpc
Id String - VPC ID where the instance is located
- zone
Id List<String>Lists - List of availability zones for the instance
- auto
Renew String - Enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal.
- billing
Period String - Unit of purchase duration. Options: MONTHLY—monthly subscription; YEARLY—yearly subscription
- description String
- Instance description
- eip
Id String - Whether public access is enabled for the instance. If public access is required, configure the ID of a public IP in the same region
- endpoints
Instance
Endpoints - Response data for all instance endpoints
- message
Retention Integer - Message retention period for all Topics under the instance, in hours
-
List<Instance
Tag> - times Integer
- Purchase duration for yearly/monthly subscription instances, in months
- billing
Type string - Instance billing method. Options: POST—pay-as-you-go; MIX—yearly/monthly subscription
- name string
- Custom BMQ instance name. Constraints: must consist of lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- project
Name string - Project name associated with the instance
- security
Group string[]Id Lists - Security group list used by the instance
- specification string
- Instance specification
- subnet
Id string[]Lists - Subnet list used by the instance
- vpc
Id string - VPC ID where the instance is located
- zone
Id string[]Lists - List of availability zones for the instance
- auto
Renew string - Enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal.
- billing
Period string - Unit of purchase duration. Options: MONTHLY—monthly subscription; YEARLY—yearly subscription
- description string
- Instance description
- eip
Id string - Whether public access is enabled for the instance. If public access is required, configure the ID of a public IP in the same region
- endpoints
Instance
Endpoints - Response data for all instance endpoints
- message
Retention number - Message retention period for all Topics under the instance, in hours
-
Instance
Tag[] - times number
- Purchase duration for yearly/monthly subscription instances, in months
- billing_
type str - Instance billing method. Options: POST—pay-as-you-go; MIX—yearly/monthly subscription
- name str
- Custom BMQ instance name. Constraints: must consist of lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- project_
name str - Project name associated with the instance
- security_
group_ Sequence[str]id_ lists - Security group list used by the instance
- specification str
- Instance specification
- subnet_
id_ Sequence[str]lists - Subnet list used by the instance
- vpc_
id str - VPC ID where the instance is located
- zone_
id_ Sequence[str]lists - List of availability zones for the instance
- auto_
renew str - Enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal.
- billing_
period str - Unit of purchase duration. Options: MONTHLY—monthly subscription; YEARLY—yearly subscription
- description str
- Instance description
- eip_
id str - Whether public access is enabled for the instance. If public access is required, configure the ID of a public IP in the same region
- endpoints
Instance
Endpoints Args - Response data for all instance endpoints
- message_
retention int - Message retention period for all Topics under the instance, in hours
-
Sequence[Instance
Tag Args] - times int
- Purchase duration for yearly/monthly subscription instances, in months
- billing
Type String - Instance billing method. Options: POST—pay-as-you-go; MIX—yearly/monthly subscription
- name String
- Custom BMQ instance name. Constraints: must consist of lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- project
Name String - Project name associated with the instance
- security
Group List<String>Id Lists - Security group list used by the instance
- specification String
- Instance specification
- subnet
Id List<String>Lists - Subnet list used by the instance
- vpc
Id String - VPC ID where the instance is located
- zone
Id List<String>Lists - List of availability zones for the instance
- auto
Renew String - Enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal.
- billing
Period String - Unit of purchase duration. Options: MONTHLY—monthly subscription; YEARLY—yearly subscription
- description String
- Instance description
- eip
Id String - Whether public access is enabled for the instance. If public access is required, configure the ID of a public IP in the same region
- endpoints Property Map
- Response data for all instance endpoints
- message
Retention Number - Message retention period for all Topics under the instance, in hours
- List<Property Map>
- times Number
- Purchase duration for yearly/monthly subscription instances, in months
Outputs
All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:
- Created
Time string - Instance creation time
- Expiration
Time string - Instance expiration time
- Group
Limit int - Maximum number of consumer groups per instance
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Id string - Instance ID
- Partition
Limit int - Maximum number of partitions per instance
-
List<Volcengine.
Instance Resource Tag> - Resources
Volcengine.
Instance Resources - Instance resource statistics response data
- Status string
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- Topic
Limit int - Maximum number of Topics per instance
- Created
Time string - Instance creation time
- Expiration
Time string - Instance expiration time
- Group
Limit int - Maximum number of consumer groups per instance
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Id string - Instance ID
- Partition
Limit int - Maximum number of partitions per instance
-
[]Instance
Resource Tag - Resources
Instance
Resources - Instance resource statistics response data
- Status string
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- Topic
Limit int - Maximum number of Topics per instance
- created
Time String - Instance creation time
- expiration
Time String - Instance expiration time
- group
Limit Integer - Maximum number of consumer groups per instance
- id String
- The provider-assigned unique ID for this managed resource.
- instance
Id String - Instance ID
- partition
Limit Integer - Maximum number of partitions per instance
-
List<Instance
Resource Tag> - resources
Instance
Resources - Instance resource statistics response data
- status String
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- topic
Limit Integer - Maximum number of Topics per instance
- created
Time string - Instance creation time
- expiration
Time string - Instance expiration time
- group
Limit number - Maximum number of consumer groups per instance
- id string
- The provider-assigned unique ID for this managed resource.
- instance
Id string - Instance ID
- partition
Limit number - Maximum number of partitions per instance
-
Instance
Resource Tag[] - resources
Instance
Resources - Instance resource statistics response data
- status string
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- topic
Limit number - Maximum number of Topics per instance
- created_
time str - Instance creation time
- expiration_
time str - Instance expiration time
- group_
limit int - Maximum number of consumer groups per instance
- id str
- The provider-assigned unique ID for this managed resource.
- instance_
id str - Instance ID
- partition_
limit int - Maximum number of partitions per instance
-
Sequence[Instance
Resource Tag] - resources
Instance
Resources - Instance resource statistics response data
- status str
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- topic_
limit int - Maximum number of Topics per instance
- created
Time String - Instance creation time
- expiration
Time String - Instance expiration time
- group
Limit Number - Maximum number of consumer groups per instance
- id String
- The provider-assigned unique ID for this managed resource.
- instance
Id String - Instance ID
- partition
Limit Number - Maximum number of partitions per instance
- List<Property Map>
- resources Property Map
- Instance resource statistics response data
- status String
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- topic
Limit Number - Maximum number of Topics per instance
Look up Existing Instance Resource
Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auto_renew: Optional[str] = None,
billing_period: Optional[str] = None,
billing_type: Optional[str] = None,
created_time: Optional[str] = None,
description: Optional[str] = None,
eip_id: Optional[str] = None,
endpoints: Optional[InstanceEndpointsArgs] = None,
expiration_time: Optional[str] = None,
group_limit: Optional[int] = None,
instance_id: Optional[str] = None,
message_retention: Optional[int] = None,
name: Optional[str] = None,
partition_limit: Optional[int] = None,
project_name: Optional[str] = None,
resource_tags: Optional[Sequence[InstanceResourceTagArgs]] = None,
resources: Optional[InstanceResourcesArgs] = None,
security_group_id_lists: Optional[Sequence[str]] = None,
specification: Optional[str] = None,
status: Optional[str] = None,
subnet_id_lists: Optional[Sequence[str]] = None,
tags: Optional[Sequence[InstanceTagArgs]] = None,
times: Optional[int] = None,
topic_limit: Optional[int] = None,
vpc_id: Optional[str] = None,
zone_id_lists: Optional[Sequence[str]] = None) -> Instancefunc GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)resources: _: type: volcenginecc:bmq:Instance 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.
- Auto
Renew string - Enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal.
- Billing
Period string - Unit of purchase duration. Options: MONTHLY—monthly subscription; YEARLY—yearly subscription
- Billing
Type string - Instance billing method. Options: POST—pay-as-you-go; MIX—yearly/monthly subscription
- Created
Time string - Instance creation time
- Description string
- Instance description
- Eip
Id string - Whether public access is enabled for the instance. If public access is required, configure the ID of a public IP in the same region
- Endpoints
Volcengine.
Instance Endpoints - Response data for all instance endpoints
- Expiration
Time string - Instance expiration time
- Group
Limit int - Maximum number of consumer groups per instance
- Instance
Id string - Instance ID
- Message
Retention int - Message retention period for all Topics under the instance, in hours
- Name string
- Custom BMQ instance name. Constraints: must consist of lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- Partition
Limit int - Maximum number of partitions per instance
- Project
Name string - Project name associated with the instance
-
List<Volcengine.
Instance Resource Tag> - Resources
Volcengine.
Instance Resources - Instance resource statistics response data
- Security
Group List<string>Id Lists - Security group list used by the instance
- Specification string
- Instance specification
- Status string
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- Subnet
Id List<string>Lists - Subnet list used by the instance
-
List<Volcengine.
Instance Tag> - Times int
- Purchase duration for yearly/monthly subscription instances, in months
- Topic
Limit int - Maximum number of Topics per instance
- Vpc
Id string - VPC ID where the instance is located
- Zone
Id List<string>Lists - List of availability zones for the instance
- Auto
Renew string - Enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal.
- Billing
Period string - Unit of purchase duration. Options: MONTHLY—monthly subscription; YEARLY—yearly subscription
- Billing
Type string - Instance billing method. Options: POST—pay-as-you-go; MIX—yearly/monthly subscription
- Created
Time string - Instance creation time
- Description string
- Instance description
- Eip
Id string - Whether public access is enabled for the instance. If public access is required, configure the ID of a public IP in the same region
- Endpoints
Instance
Endpoints Args - Response data for all instance endpoints
- Expiration
Time string - Instance expiration time
- Group
Limit int - Maximum number of consumer groups per instance
- Instance
Id string - Instance ID
- Message
Retention int - Message retention period for all Topics under the instance, in hours
- Name string
- Custom BMQ instance name. Constraints: must consist of lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- Partition
Limit int - Maximum number of partitions per instance
- Project
Name string - Project name associated with the instance
-
[]Instance
Resource Tag Args - Resources
Instance
Resources Args - Instance resource statistics response data
- Security
Group []stringId Lists - Security group list used by the instance
- Specification string
- Instance specification
- Status string
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- Subnet
Id []stringLists - Subnet list used by the instance
-
[]Instance
Tag Args - Times int
- Purchase duration for yearly/monthly subscription instances, in months
- Topic
Limit int - Maximum number of Topics per instance
- Vpc
Id string - VPC ID where the instance is located
- Zone
Id []stringLists - List of availability zones for the instance
- auto
Renew String - Enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal.
- billing
Period String - Unit of purchase duration. Options: MONTHLY—monthly subscription; YEARLY—yearly subscription
- billing
Type String - Instance billing method. Options: POST—pay-as-you-go; MIX—yearly/monthly subscription
- created
Time String - Instance creation time
- description String
- Instance description
- eip
Id String - Whether public access is enabled for the instance. If public access is required, configure the ID of a public IP in the same region
- endpoints
Instance
Endpoints - Response data for all instance endpoints
- expiration
Time String - Instance expiration time
- group
Limit Integer - Maximum number of consumer groups per instance
- instance
Id String - Instance ID
- message
Retention Integer - Message retention period for all Topics under the instance, in hours
- name String
- Custom BMQ instance name. Constraints: must consist of lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- partition
Limit Integer - Maximum number of partitions per instance
- project
Name String - Project name associated with the instance
-
List<Instance
Resource Tag> - resources
Instance
Resources - Instance resource statistics response data
- security
Group List<String>Id Lists - Security group list used by the instance
- specification String
- Instance specification
- status String
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- subnet
Id List<String>Lists - Subnet list used by the instance
-
List<Instance
Tag> - times Integer
- Purchase duration for yearly/monthly subscription instances, in months
- topic
Limit Integer - Maximum number of Topics per instance
- vpc
Id String - VPC ID where the instance is located
- zone
Id List<String>Lists - List of availability zones for the instance
- auto
Renew string - Enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal.
- billing
Period string - Unit of purchase duration. Options: MONTHLY—monthly subscription; YEARLY—yearly subscription
- billing
Type string - Instance billing method. Options: POST—pay-as-you-go; MIX—yearly/monthly subscription
- created
Time string - Instance creation time
- description string
- Instance description
- eip
Id string - Whether public access is enabled for the instance. If public access is required, configure the ID of a public IP in the same region
- endpoints
Instance
Endpoints - Response data for all instance endpoints
- expiration
Time string - Instance expiration time
- group
Limit number - Maximum number of consumer groups per instance
- instance
Id string - Instance ID
- message
Retention number - Message retention period for all Topics under the instance, in hours
- name string
- Custom BMQ instance name. Constraints: must consist of lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- partition
Limit number - Maximum number of partitions per instance
- project
Name string - Project name associated with the instance
-
Instance
Resource Tag[] - resources
Instance
Resources - Instance resource statistics response data
- security
Group string[]Id Lists - Security group list used by the instance
- specification string
- Instance specification
- status string
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- subnet
Id string[]Lists - Subnet list used by the instance
-
Instance
Tag[] - times number
- Purchase duration for yearly/monthly subscription instances, in months
- topic
Limit number - Maximum number of Topics per instance
- vpc
Id string - VPC ID where the instance is located
- zone
Id string[]Lists - List of availability zones for the instance
- auto_
renew str - Enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal.
- billing_
period str - Unit of purchase duration. Options: MONTHLY—monthly subscription; YEARLY—yearly subscription
- billing_
type str - Instance billing method. Options: POST—pay-as-you-go; MIX—yearly/monthly subscription
- created_
time str - Instance creation time
- description str
- Instance description
- eip_
id str - Whether public access is enabled for the instance. If public access is required, configure the ID of a public IP in the same region
- endpoints
Instance
Endpoints Args - Response data for all instance endpoints
- expiration_
time str - Instance expiration time
- group_
limit int - Maximum number of consumer groups per instance
- instance_
id str - Instance ID
- message_
retention int - Message retention period for all Topics under the instance, in hours
- name str
- Custom BMQ instance name. Constraints: must consist of lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- partition_
limit int - Maximum number of partitions per instance
- project_
name str - Project name associated with the instance
-
Sequence[Instance
Resource Tag Args] - resources
Instance
Resources Args - Instance resource statistics response data
- security_
group_ Sequence[str]id_ lists - Security group list used by the instance
- specification str
- Instance specification
- status str
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- subnet_
id_ Sequence[str]lists - Subnet list used by the instance
-
Sequence[Instance
Tag Args] - times int
- Purchase duration for yearly/monthly subscription instances, in months
- topic_
limit int - Maximum number of Topics per instance
- vpc_
id str - VPC ID where the instance is located
- zone_
id_ Sequence[str]lists - List of availability zones for the instance
- auto
Renew String - Enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal.
- billing
Period String - Unit of purchase duration. Options: MONTHLY—monthly subscription; YEARLY—yearly subscription
- billing
Type String - Instance billing method. Options: POST—pay-as-you-go; MIX—yearly/monthly subscription
- created
Time String - Instance creation time
- description String
- Instance description
- eip
Id String - Whether public access is enabled for the instance. If public access is required, configure the ID of a public IP in the same region
- endpoints Property Map
- Response data for all instance endpoints
- expiration
Time String - Instance expiration time
- group
Limit Number - Maximum number of consumer groups per instance
- instance
Id String - Instance ID
- message
Retention Number - Message retention period for all Topics under the instance, in hours
- name String
- Custom BMQ instance name. Constraints: must consist of lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- partition
Limit Number - Maximum number of partitions per instance
- project
Name String - Project name associated with the instance
- List<Property Map>
- resources Property Map
- Instance resource statistics response data
- security
Group List<String>Id Lists - Security group list used by the instance
- specification String
- Instance specification
- status String
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- subnet
Id List<String>Lists - Subnet list used by the instance
- List<Property Map>
- times Number
- Purchase duration for yearly/monthly subscription instances, in months
- topic
Limit Number - Maximum number of Topics per instance
- vpc
Id String - VPC ID where the instance is located
- zone
Id List<String>Lists - List of availability zones for the instance
Supporting Types
InstanceEndpoints, InstanceEndpointsArgs
- Overlay
Volcengine.
Instance Endpoints Overlay - Instance private network access endpoint response data
- Public
Volcengine.
Instance Endpoints Public - Instance public access endpoint response data
- Overlay
Instance
Endpoints Overlay - Instance private network access endpoint response data
- Public
Instance
Endpoints Public - Instance public access endpoint response data
- overlay
Instance
Endpoints Overlay - Instance private network access endpoint response data
- public_
Instance
Endpoints Public - Instance public access endpoint response data
- overlay
Instance
Endpoints Overlay - Instance private network access endpoint response data
- public
Instance
Endpoints Public - Instance public access endpoint response data
- overlay
Instance
Endpoints Overlay - Instance private network access endpoint response data
- public
Instance
Endpoints Public - Instance public access endpoint response data
- overlay Property Map
- Instance private network access endpoint response data
- public Property Map
- Instance public access endpoint response data
InstanceEndpointsOverlay, InstanceEndpointsOverlayArgs
- Address string
- Domain mapping address
- Eip
Id string - ID of the EIP bound to the instance
- Plain string
- Private network Plain access point
- Plain
Port int - Standard endpoint port
- Sasl string
- Private network SASL authentication access point
- Sasl
Port int - Authentication endpoint port
- Ssl string
- Encrypted endpoint
- Ssl
Port int - Encrypted endpoint port
- Status string
- Endpoint status
- Vpc
Ids List<string> - List of VPC IDs associated with the sales zone network
- Address string
- Domain mapping address
- Eip
Id string - ID of the EIP bound to the instance
- Plain string
- Private network Plain access point
- Plain
Port int - Standard endpoint port
- Sasl string
- Private network SASL authentication access point
- Sasl
Port int - Authentication endpoint port
- Ssl string
- Encrypted endpoint
- Ssl
Port int - Encrypted endpoint port
- Status string
- Endpoint status
- Vpc
Ids []string - List of VPC IDs associated with the sales zone network
- address String
- Domain mapping address
- eip
Id String - ID of the EIP bound to the instance
- plain String
- Private network Plain access point
- plain
Port Integer - Standard endpoint port
- sasl String
- Private network SASL authentication access point
- sasl
Port Integer - Authentication endpoint port
- ssl String
- Encrypted endpoint
- ssl
Port Integer - Encrypted endpoint port
- status String
- Endpoint status
- vpc
Ids List<String> - List of VPC IDs associated with the sales zone network
- address string
- Domain mapping address
- eip
Id string - ID of the EIP bound to the instance
- plain string
- Private network Plain access point
- plain
Port number - Standard endpoint port
- sasl string
- Private network SASL authentication access point
- sasl
Port number - Authentication endpoint port
- ssl string
- Encrypted endpoint
- ssl
Port number - Encrypted endpoint port
- status string
- Endpoint status
- vpc
Ids string[] - List of VPC IDs associated with the sales zone network
- address str
- Domain mapping address
- eip_
id str - ID of the EIP bound to the instance
- plain str
- Private network Plain access point
- plain_
port int - Standard endpoint port
- sasl str
- Private network SASL authentication access point
- sasl_
port int - Authentication endpoint port
- ssl str
- Encrypted endpoint
- ssl_
port int - Encrypted endpoint port
- status str
- Endpoint status
- vpc_
ids Sequence[str] - List of VPC IDs associated with the sales zone network
- address String
- Domain mapping address
- eip
Id String - ID of the EIP bound to the instance
- plain String
- Private network Plain access point
- plain
Port Number - Standard endpoint port
- sasl String
- Private network SASL authentication access point
- sasl
Port Number - Authentication endpoint port
- ssl String
- Encrypted endpoint
- ssl
Port Number - Encrypted endpoint port
- status String
- Endpoint status
- vpc
Ids List<String> - List of VPC IDs associated with the sales zone network
InstanceEndpointsPublic, InstanceEndpointsPublicArgs
- Address string
- Domain mapping address
- Eip
Id string - ID of the EIP bound to the instance
- Plain string
- Private network Plain access point
- Plain
Port int - Standard endpoint port
- Sasl string
- Private network SASL authentication access point
- Sasl
Port int - Authentication endpoint port
- Ssl string
- Encrypted endpoint
- Ssl
Port int - Encrypted endpoint port
- Status string
- Endpoint status
- Vpc
Ids List<string> - List of VPC IDs associated with the sales zone network
- Address string
- Domain mapping address
- Eip
Id string - ID of the EIP bound to the instance
- Plain string
- Private network Plain access point
- Plain
Port int - Standard endpoint port
- Sasl string
- Private network SASL authentication access point
- Sasl
Port int - Authentication endpoint port
- Ssl string
- Encrypted endpoint
- Ssl
Port int - Encrypted endpoint port
- Status string
- Endpoint status
- Vpc
Ids []string - List of VPC IDs associated with the sales zone network
- address String
- Domain mapping address
- eip
Id String - ID of the EIP bound to the instance
- plain String
- Private network Plain access point
- plain
Port Integer - Standard endpoint port
- sasl String
- Private network SASL authentication access point
- sasl
Port Integer - Authentication endpoint port
- ssl String
- Encrypted endpoint
- ssl
Port Integer - Encrypted endpoint port
- status String
- Endpoint status
- vpc
Ids List<String> - List of VPC IDs associated with the sales zone network
- address string
- Domain mapping address
- eip
Id string - ID of the EIP bound to the instance
- plain string
- Private network Plain access point
- plain
Port number - Standard endpoint port
- sasl string
- Private network SASL authentication access point
- sasl
Port number - Authentication endpoint port
- ssl string
- Encrypted endpoint
- ssl
Port number - Encrypted endpoint port
- status string
- Endpoint status
- vpc
Ids string[] - List of VPC IDs associated with the sales zone network
- address str
- Domain mapping address
- eip_
id str - ID of the EIP bound to the instance
- plain str
- Private network Plain access point
- plain_
port int - Standard endpoint port
- sasl str
- Private network SASL authentication access point
- sasl_
port int - Authentication endpoint port
- ssl str
- Encrypted endpoint
- ssl_
port int - Encrypted endpoint port
- status str
- Endpoint status
- vpc_
ids Sequence[str] - List of VPC IDs associated with the sales zone network
- address String
- Domain mapping address
- eip
Id String - ID of the EIP bound to the instance
- plain String
- Private network Plain access point
- plain
Port Number - Standard endpoint port
- sasl String
- Private network SASL authentication access point
- sasl
Port Number - Authentication endpoint port
- ssl String
- Encrypted endpoint
- ssl
Port Number - Encrypted endpoint port
- status String
- Endpoint status
- vpc
Ids List<String> - List of VPC IDs associated with the sales zone network
InstanceResourceTag, InstanceResourceTagArgs
- Tag
Kvs List<Volcengine.Instance Resource Tag Tag Kv> - Type string
- Tag type. Options: CUSTOM—custom tag; SYSTEM—system tag
- Tag
Kvs []InstanceResource Tag Tag Kv - Type string
- Tag type. Options: CUSTOM—custom tag; SYSTEM—system tag
- tag
Kvs List<InstanceResource Tag Tag Kv> - type String
- Tag type. Options: CUSTOM—custom tag; SYSTEM—system tag
- tag
Kvs InstanceResource Tag Tag Kv[] - type string
- Tag type. Options: CUSTOM—custom tag; SYSTEM—system tag
- tag_
kvs Sequence[InstanceResource Tag Tag Kv] - type str
- Tag type. Options: CUSTOM—custom tag; SYSTEM—system tag
- tag
Kvs List<Property Map> - type String
- Tag type. Options: CUSTOM—custom tag; SYSTEM—system tag
InstanceResourceTagTagKv, InstanceResourceTagTagKvArgs
InstanceResources, InstanceResourcesArgs
- Storage
Volcengine.
Instance Resources Storage - Resource statistics response data
- Storage
Instance
Resources Storage - Resource statistics response data
- storage
Instance
Resources Storage - Resource statistics response data
- storage
Instance
Resources Storage - Resource statistics response data
- storage
Instance
Resources Storage - Resource statistics response data
- storage Property Map
- Resource statistics response data
InstanceResourcesStorage, InstanceResourcesStorageArgs
InstanceTag, InstanceTagArgs
Import
$ pulumi import volcenginecc:bmq/instance:Instance example "instance_id"
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
volcengineccTerraform Provider.
published on Thursday, Apr 23, 2026 by Volcengine
