1. Packages
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. bmq
  6. Instance
Viewing docs for bytepluscc v0.0.25
published on Thursday, May 7, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.bmq.Instance

bytepluscc logo
Viewing docs for bytepluscc v0.0.25
published on Thursday, May 7, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    The cloud-native messaging engine is 100% compatible with the Apache Kafka protocol. It is a fully managed, high-throughput, low-latency, highly available, highly scalable, and highly stable distributed messaging engine service built on cloud-native architecture. It supports flexible, dynamic scaling and integrated stream-batch processing, delivering enterprise-grade, real-time stream data processing at large scale. It helps you build the ‘central nervous system’ for data processing and is widely used in scenarios such as log collection, data aggregation, and offline data analysis.

    Example Usage

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

const bMQInstanceDemo = new byteplus.index.BmqInstance("BMQInstanceDemo", {
    name: "BMQInstanceDemo",
    billingType: "POST",
    projectName: "default",
    specification: "bmq.standard",
    vpcId: "vpc-miltj87lh2ww5smt1bxxxxx",
    messageRetention: 1,
    endpoints: {
        "public": {
            eipId: "eip-3nriu2y2ufwu8931exxxxx",
        },
        overlay: {
            vpcIds: ["vpc-miltj87lh2ww5smt1bxxxxx"],
        },
    },
    securityGroupIdList: ["sg-3nqnz9en1ucxs931eaxxxxx"],
    subnetIdList: ["subnet-w02wsq25fitc865ykaxxxxx"],
    zoneIdList: ["cn-beijing-a"],
    tags: [{
        key: "env",
        type: "CUSTOM",
        value: "test",
    }],
});

    import pulumi
import pulumi_byteplus as byteplus

b_mq_instance_demo = byteplus.index.BmqInstance("BMQInstanceDemo",
    name=BMQInstanceDemo,
    billing_type=POST,
    project_name=default,
    specification=bmq.standard,
    vpc_id=vpc-miltj87lh2ww5smt1bxxxxx,
    message_retention=1,
    endpoints={
        public: {
            eipId: eip-3nriu2y2ufwu8931exxxxx,
        },
        overlay: {
            vpcIds: [vpc-miltj87lh2ww5smt1bxxxxx],
        },
    },
    security_group_id_list=[sg-3nqnz9en1ucxs931eaxxxxx],
    subnet_id_list=[subnet-w02wsq25fitc865ykaxxxxx],
    zone_id_list=[cn-beijing-a],
    tags=[{
        key: env,
        type: CUSTOM,
        value: test,
    }])

    package main

import (
	"github.com/pulumi/pulumi-byteplus/sdk/go/byteplus"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := byteplus.NewBmqInstance(ctx, "BMQInstanceDemo", &byteplus.BmqInstanceArgs{
			Name:             "BMQInstanceDemo",
			BillingType:      "POST",
			ProjectName:      "default",
			Specification:    "bmq.standard",
			VpcId:            "vpc-miltj87lh2ww5smt1bxxxxx",
			MessageRetention: 1,
			Endpoints: map[string]interface{}{
				"public": map[string]interface{}{
					"eipId": "eip-3nriu2y2ufwu8931exxxxx",
				},
				"overlay": map[string]interface{}{
					"vpcIds": []string{
						"vpc-miltj87lh2ww5smt1bxxxxx",
					},
				},
			},
			SecurityGroupIdList: []string{
				"sg-3nqnz9en1ucxs931eaxxxxx",
			},
			SubnetIdList: []string{
				"subnet-w02wsq25fitc865ykaxxxxx",
			},
			ZoneIdList: []string{
				"cn-beijing-a",
			},
			Tags: []map[string]interface{}{
				map[string]interface{}{
					"key":   "env",
					"type":  "CUSTOM",
					"value": "test",
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var bMQInstanceDemo = new Byteplus.Index.BmqInstance("BMQInstanceDemo", new()
    {
        Name = "BMQInstanceDemo",
        BillingType = "POST",
        ProjectName = "default",
        Specification = "bmq.standard",
        VpcId = "vpc-miltj87lh2ww5smt1bxxxxx",
        MessageRetention = 1,
        Endpoints = 
        {
            { "public", 
            {
                { "eipId", "eip-3nriu2y2ufwu8931exxxxx" },
            } },
            { "overlay", 
            {
                { "vpcIds", new[]
                {
                    "vpc-miltj87lh2ww5smt1bxxxxx",
                } },
            } },
        },
        SecurityGroupIdList = new[]
        {
            "sg-3nqnz9en1ucxs931eaxxxxx",
        },
        SubnetIdList = new[]
        {
            "subnet-w02wsq25fitc865ykaxxxxx",
        },
        ZoneIdList = new[]
        {
            "cn-beijing-a",
        },
        Tags = new[]
        {
            
            {
                { "key", "env" },
                { "type", "CUSTOM" },
                { "value", "test" },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.byteplus.bmqInstance;
import com.pulumi.byteplus.bmqInstanceArgs;
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 BmqInstance("bMQInstanceDemo", BmqInstanceArgs.builder()
            .name("BMQInstanceDemo")
            .billingType("POST")
            .projectName("default")
            .specification("bmq.standard")
            .vpcId("vpc-miltj87lh2ww5smt1bxxxxx")
            .messageRetention(1)
            .endpoints(Map.ofEntries(
                Map.entry("public", Map.of("eipId", "eip-3nriu2y2ufwu8931exxxxx")),
                Map.entry("overlay", Map.of("vpcIds", List.of("vpc-miltj87lh2ww5smt1bxxxxx")))
            ))
            .securityGroupIdList(List.of("sg-3nqnz9en1ucxs931eaxxxxx"))
            .subnetIdList(List.of("subnet-w02wsq25fitc865ykaxxxxx"))
            .zoneIdList(List.of("cn-beijing-a"))
            .tags(List.of(Map.ofEntries(
                Map.entry("key", "env"),
                Map.entry("type", "CUSTOM"),
                Map.entry("value", "test")
            )))
            .build());

    }
}

    resources:
  bMQInstanceDemo:
    type: byteplus:bmqInstance
    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
      securityGroupIdList:
        - sg-3nqnz9en1ucxs931eaxxxxx
      subnetIdList:
        - subnet-w02wsq25fitc865ykaxxxxx
      zoneIdList:
        - 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: bytepluscc: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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var instanceResource = new Bytepluscc.Bmq.Instance("instanceResource", new()
{
    ProjectName = "string",
    ZoneIdLists = new[]
    {
        "string",
    },
    BillingType = "string",
    VpcId = "string",
    SubnetIdLists = new[]
    {
        "string",
    },
    Specification = "string",
    SecurityGroupIdLists = new[]
    {
        "string",
    },
    Name = "string",
    EipId = "string",
    MessageRetention = 0,
    Endpoints = new Bytepluscc.Bmq.Inputs.InstanceEndpointsArgs
    {
        Overlay = new Bytepluscc.Bmq.Inputs.InstanceEndpointsOverlayArgs
        {
            Address = "string",
            EipId = "string",
            Plain = "string",
            PlainPort = 0,
            Sasl = "string",
            SaslPort = 0,
            Ssl = "string",
            SslPort = 0,
            Status = "string",
            VpcIds = new[]
            {
                "string",
            },
        },
        Public = new Bytepluscc.Bmq.Inputs.InstanceEndpointsPublicArgs
        {
            Address = "string",
            EipId = "string",
            Plain = "string",
            PlainPort = 0,
            Sasl = "string",
            SaslPort = 0,
            Ssl = "string",
            SslPort = 0,
            Status = "string",
            VpcIds = new[]
            {
                "string",
            },
        },
    },
    AutoRenew = "string",
    Tags = new[]
    {
        new Bytepluscc.Bmq.Inputs.InstanceTagArgs
        {
            Key = "string",
            Type = "string",
            Value = "string",
        },
    },
    Times = 0,
    Description = "string",
    BillingPeriod = "string",
});

    example, err := bmq.NewInstance(ctx, "instanceResource", &bmq.InstanceArgs{
	ProjectName: pulumi.String("string"),
	ZoneIdLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	BillingType: pulumi.String("string"),
	VpcId:       pulumi.String("string"),
	SubnetIdLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	Specification: pulumi.String("string"),
	SecurityGroupIdLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:             pulumi.String("string"),
	EipId:            pulumi.String("string"),
	MessageRetention: pulumi.Int(0),
	Endpoints: &bmq.InstanceEndpointsArgs{
		Overlay: &bmq.InstanceEndpointsOverlayArgs{
			Address:   pulumi.String("string"),
			EipId:     pulumi.String("string"),
			Plain:     pulumi.String("string"),
			PlainPort: pulumi.Int(0),
			Sasl:      pulumi.String("string"),
			SaslPort:  pulumi.Int(0),
			Ssl:       pulumi.String("string"),
			SslPort:   pulumi.Int(0),
			Status:    pulumi.String("string"),
			VpcIds: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		Public: &bmq.InstanceEndpointsPublicArgs{
			Address:   pulumi.String("string"),
			EipId:     pulumi.String("string"),
			Plain:     pulumi.String("string"),
			PlainPort: pulumi.Int(0),
			Sasl:      pulumi.String("string"),
			SaslPort:  pulumi.Int(0),
			Ssl:       pulumi.String("string"),
			SslPort:   pulumi.Int(0),
			Status:    pulumi.String("string"),
			VpcIds: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	AutoRenew: pulumi.String("string"),
	Tags: bmq.InstanceTagArray{
		&bmq.InstanceTagArgs{
			Key:   pulumi.String("string"),
			Type:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	Times:         pulumi.Int(0),
	Description:   pulumi.String("string"),
	BillingPeriod: pulumi.String("string"),
})

    var instanceResource = new com.byteplus.bytepluscc.bmq.Instance("instanceResource", com.byteplus.bytepluscc.bmq.InstanceArgs.builder()
    .projectName("string")
    .zoneIdLists("string")
    .billingType("string")
    .vpcId("string")
    .subnetIdLists("string")
    .specification("string")
    .securityGroupIdLists("string")
    .name("string")
    .eipId("string")
    .messageRetention(0)
    .endpoints(InstanceEndpointsArgs.builder()
        .overlay(InstanceEndpointsOverlayArgs.builder()
            .address("string")
            .eipId("string")
            .plain("string")
            .plainPort(0)
            .sasl("string")
            .saslPort(0)
            .ssl("string")
            .sslPort(0)
            .status("string")
            .vpcIds("string")
            .build())
        .public_(InstanceEndpointsPublicArgs.builder()
            .address("string")
            .eipId("string")
            .plain("string")
            .plainPort(0)
            .sasl("string")
            .saslPort(0)
            .ssl("string")
            .sslPort(0)
            .status("string")
            .vpcIds("string")
            .build())
        .build())
    .autoRenew("string")
    .tags(InstanceTagArgs.builder()
        .key("string")
        .type("string")
        .value("string")
        .build())
    .times(0)
    .description("string")
    .billingPeriod("string")
    .build());

    instance_resource = bytepluscc.bmq.Instance("instanceResource",
    project_name="string",
    zone_id_lists=["string"],
    billing_type="string",
    vpc_id="string",
    subnet_id_lists=["string"],
    specification="string",
    security_group_id_lists=["string"],
    name="string",
    eip_id="string",
    message_retention=0,
    endpoints={
        "overlay": {
            "address": "string",
            "eip_id": "string",
            "plain": "string",
            "plain_port": 0,
            "sasl": "string",
            "sasl_port": 0,
            "ssl": "string",
            "ssl_port": 0,
            "status": "string",
            "vpc_ids": ["string"],
        },
        "public": {
            "address": "string",
            "eip_id": "string",
            "plain": "string",
            "plain_port": 0,
            "sasl": "string",
            "sasl_port": 0,
            "ssl": "string",
            "ssl_port": 0,
            "status": "string",
            "vpc_ids": ["string"],
        },
    },
    auto_renew="string",
    tags=[{
        "key": "string",
        "type": "string",
        "value": "string",
    }],
    times=0,
    description="string",
    billing_period="string")

    const instanceResource = new bytepluscc.bmq.Instance("instanceResource", {
    projectName: "string",
    zoneIdLists: ["string"],
    billingType: "string",
    vpcId: "string",
    subnetIdLists: ["string"],
    specification: "string",
    securityGroupIdLists: ["string"],
    name: "string",
    eipId: "string",
    messageRetention: 0,
    endpoints: {
        overlay: {
            address: "string",
            eipId: "string",
            plain: "string",
            plainPort: 0,
            sasl: "string",
            saslPort: 0,
            ssl: "string",
            sslPort: 0,
            status: "string",
            vpcIds: ["string"],
        },
        "public": {
            address: "string",
            eipId: "string",
            plain: "string",
            plainPort: 0,
            sasl: "string",
            saslPort: 0,
            ssl: "string",
            sslPort: 0,
            status: "string",
            vpcIds: ["string"],
        },
    },
    autoRenew: "string",
    tags: [{
        key: "string",
        type: "string",
        value: "string",
    }],
    times: 0,
    description: "string",
    billingPeriod: "string",
});

    type: bytepluscc:bmq:Instance
properties:
    autoRenew: string
    billingPeriod: string
    billingType: string
    description: string
    eipId: string
    endpoints:
        overlay:
            address: string
            eipId: string
            plain: string
            plainPort: 0
            sasl: string
            saslPort: 0
            ssl: string
            sslPort: 0
            status: string
            vpcIds:
                - string
        public:
            address: string
            eipId: string
            plain: string
            plainPort: 0
            sasl: string
            saslPort: 0
            ssl: string
            sslPort: 0
            status: string
            vpcIds:
                - string
    messageRetention: 0
    name: string
    projectName: string
    securityGroupIdLists:
        - string
    specification: string
    subnetIdLists:
        - string
    tags:
        - key: string
          type: string
          value: string
    times: 0
    vpcId: string
    zoneIdLists:
        - string

    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:

    BillingType string
    Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
    Name string
    Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
    ProjectName string
    Project name to which the instance belongs
    SecurityGroupIdLists List<string>
    List of security groups used by the instance
    Specification string
    Instance specification
    SubnetIdLists List<string>
    List of subnets used by the instance
    VpcId string
    VPC ID where the instance is located
    ZoneIdLists List<string>
    List of availability zones where the instance is located
    AutoRenew string
    Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
    BillingPeriod string
    Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
    Description string
    Instance description statement
    EipId string
    Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
    Endpoints Byteplus.InstanceEndpoints
    Response data for all instance endpoints
    MessageRetention int
    Message retention period for all topics under the instance, in hours
    Tags List<Byteplus.InstanceTag>
    Times int
    Purchase duration for subscription instances, in months
    BillingType string
    Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
    Name string
    Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
    ProjectName string
    Project name to which the instance belongs
    SecurityGroupIdLists []string
    List of security groups used by the instance
    Specification string
    Instance specification
    SubnetIdLists []string
    List of subnets used by the instance
    VpcId string
    VPC ID where the instance is located
    ZoneIdLists []string
    List of availability zones where the instance is located
    AutoRenew string
    Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
    BillingPeriod string
    Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
    Description string
    Instance description statement
    EipId string
    Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
    Endpoints InstanceEndpointsArgs
    Response data for all instance endpoints
    MessageRetention int
    Message retention period for all topics under the instance, in hours
    Tags []InstanceTagArgs
    Times int
    Purchase duration for subscription instances, in months
    billingType String
    Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
    name String
    Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
    projectName String
    Project name to which the instance belongs
    securityGroupIdLists List<String>
    List of security groups used by the instance
    specification String
    Instance specification
    subnetIdLists List<String>
    List of subnets used by the instance
    vpcId String
    VPC ID where the instance is located
    zoneIdLists List<String>
    List of availability zones where the instance is located
    autoRenew String
    Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
    billingPeriod String
    Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
    description String
    Instance description statement
    eipId String
    Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
    endpoints InstanceEndpoints
    Response data for all instance endpoints
    messageRetention Integer
    Message retention period for all topics under the instance, in hours
    tags List<InstanceTag>
    times Integer
    Purchase duration for subscription instances, in months
    billingType string
    Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
    name string
    Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
    projectName string
    Project name to which the instance belongs
    securityGroupIdLists string[]
    List of security groups used by the instance
    specification string
    Instance specification
    subnetIdLists string[]
    List of subnets used by the instance
    vpcId string
    VPC ID where the instance is located
    zoneIdLists string[]
    List of availability zones where the instance is located
    autoRenew string
    Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
    billingPeriod string
    Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
    description string
    Instance description statement
    eipId string
    Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
    endpoints InstanceEndpoints
    Response data for all instance endpoints
    messageRetention number
    Message retention period for all topics under the instance, in hours
    tags InstanceTag[]
    times number
    Purchase duration for subscription instances, in months
    billing_type str
    Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
    name str
    Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
    project_name str
    Project name to which the instance belongs
    security_group_id_lists Sequence[str]
    List of security groups used by the instance
    specification str
    Instance specification
    subnet_id_lists Sequence[str]
    List of subnets used by the instance
    vpc_id str
    VPC ID where the instance is located
    zone_id_lists Sequence[str]
    List of availability zones where the instance is located
    auto_renew str
    Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
    billing_period str
    Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
    description str
    Instance description statement
    eip_id str
    Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
    endpoints InstanceEndpointsArgs
    Response data for all instance endpoints
    message_retention int
    Message retention period for all topics under the instance, in hours
    tags Sequence[InstanceTagArgs]
    times int
    Purchase duration for subscription instances, in months
    billingType String
    Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
    name String
    Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
    projectName String
    Project name to which the instance belongs
    securityGroupIdLists List<String>
    List of security groups used by the instance
    specification String
    Instance specification
    subnetIdLists List<String>
    List of subnets used by the instance
    vpcId String
    VPC ID where the instance is located
    zoneIdLists List<String>
    List of availability zones where the instance is located
    autoRenew String
    Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
    billingPeriod String
    Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
    description String
    Instance description statement
    eipId String
    Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
    endpoints Property Map
    Response data for all instance endpoints
    messageRetention Number
    Message retention period for all topics under the instance, in hours
    tags List<Property Map>
    times Number
    Purchase duration for subscription instances, in months

    Outputs

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

    CreatedTime string
    Instance creation time
    ExpirationTime string
    Instance expiration time
    GroupLimit int
    Maximum number of consumer groups per instance
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Instance ID
    PartitionLimit int
    Maximum number of partitions per instance
    ResourceTags List<Byteplus.InstanceResourceTag>
    Resources Byteplus.InstanceResources
    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
    TopicLimit int
    Maximum number of topics per instance
    CreatedTime string
    Instance creation time
    ExpirationTime string
    Instance expiration time
    GroupLimit int
    Maximum number of consumer groups per instance
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Instance ID
    PartitionLimit int
    Maximum number of partitions per instance
    ResourceTags []InstanceResourceTag
    Resources InstanceResources
    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
    TopicLimit int
    Maximum number of topics per instance
    createdTime String
    Instance creation time
    expirationTime String
    Instance expiration time
    groupLimit Integer
    Maximum number of consumer groups per instance
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Instance ID
    partitionLimit Integer
    Maximum number of partitions per instance
    resourceTags List<InstanceResourceTag>
    resources InstanceResources
    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
    topicLimit Integer
    Maximum number of topics per instance
    createdTime string
    Instance creation time
    expirationTime string
    Instance expiration time
    groupLimit number
    Maximum number of consumer groups per instance
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    Instance ID
    partitionLimit number
    Maximum number of partitions per instance
    resourceTags InstanceResourceTag[]
    resources InstanceResources
    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
    topicLimit 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
    resource_tags Sequence[InstanceResourceTag]
    resources InstanceResources
    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
    createdTime String
    Instance creation time
    expirationTime String
    Instance expiration time
    groupLimit Number
    Maximum number of consumer groups per instance
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Instance ID
    partitionLimit Number
    Maximum number of partitions per instance
    resourceTags 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
    topicLimit 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) -> Instance
    func 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: bytepluscc: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.
    The following state arguments are supported:
    AutoRenew string
    Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
    BillingPeriod string
    Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
    BillingType string
    Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
    CreatedTime string
    Instance creation time
    Description string
    Instance description statement
    EipId string
    Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
    Endpoints Byteplus.InstanceEndpoints
    Response data for all instance endpoints
    ExpirationTime string
    Instance expiration time
    GroupLimit int
    Maximum number of consumer groups per instance
    InstanceId string
    Instance ID
    MessageRetention int
    Message retention period for all topics under the instance, in hours
    Name string
    Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
    PartitionLimit int
    Maximum number of partitions per instance
    ProjectName string
    Project name to which the instance belongs
    ResourceTags List<Byteplus.InstanceResourceTag>
    Resources Byteplus.InstanceResources
    Instance resource statistics response data
    SecurityGroupIdLists List<string>
    List of security groups 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
    SubnetIdLists List<string>
    List of subnets used by the instance
    Tags List<Byteplus.InstanceTag>
    Times int
    Purchase duration for subscription instances, in months
    TopicLimit int
    Maximum number of topics per instance
    VpcId string
    VPC ID where the instance is located
    ZoneIdLists List<string>
    List of availability zones where the instance is located
    AutoRenew string
    Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
    BillingPeriod string
    Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
    BillingType string
    Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
    CreatedTime string
    Instance creation time
    Description string
    Instance description statement
    EipId string
    Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
    Endpoints InstanceEndpointsArgs
    Response data for all instance endpoints
    ExpirationTime string
    Instance expiration time
    GroupLimit int
    Maximum number of consumer groups per instance
    InstanceId string
    Instance ID
    MessageRetention int
    Message retention period for all topics under the instance, in hours
    Name string
    Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
    PartitionLimit int
    Maximum number of partitions per instance
    ProjectName string
    Project name to which the instance belongs
    ResourceTags []InstanceResourceTagArgs
    Resources InstanceResourcesArgs
    Instance resource statistics response data
    SecurityGroupIdLists []string
    List of security groups 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
    SubnetIdLists []string
    List of subnets used by the instance
    Tags []InstanceTagArgs
    Times int
    Purchase duration for subscription instances, in months
    TopicLimit int
    Maximum number of topics per instance
    VpcId string
    VPC ID where the instance is located
    ZoneIdLists []string
    List of availability zones where the instance is located
    autoRenew String
    Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
    billingPeriod String
    Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
    billingType String
    Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
    createdTime String
    Instance creation time
    description String
    Instance description statement
    eipId String
    Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
    endpoints InstanceEndpoints
    Response data for all instance endpoints
    expirationTime String
    Instance expiration time
    groupLimit Integer
    Maximum number of consumer groups per instance
    instanceId String
    Instance ID
    messageRetention Integer
    Message retention period for all topics under the instance, in hours
    name String
    Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
    partitionLimit Integer
    Maximum number of partitions per instance
    projectName String
    Project name to which the instance belongs
    resourceTags List<InstanceResourceTag>
    resources InstanceResources
    Instance resource statistics response data
    securityGroupIdLists List<String>
    List of security groups 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
    subnetIdLists List<String>
    List of subnets used by the instance
    tags List<InstanceTag>
    times Integer
    Purchase duration for subscription instances, in months
    topicLimit Integer
    Maximum number of topics per instance
    vpcId String
    VPC ID where the instance is located
    zoneIdLists List<String>
    List of availability zones where the instance is located
    autoRenew string
    Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
    billingPeriod string
    Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
    billingType string
    Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
    createdTime string
    Instance creation time
    description string
    Instance description statement
    eipId string
    Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
    endpoints InstanceEndpoints
    Response data for all instance endpoints
    expirationTime string
    Instance expiration time
    groupLimit number
    Maximum number of consumer groups per instance
    instanceId string
    Instance ID
    messageRetention number
    Message retention period for all topics under the instance, in hours
    name string
    Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
    partitionLimit number
    Maximum number of partitions per instance
    projectName string
    Project name to which the instance belongs
    resourceTags InstanceResourceTag[]
    resources InstanceResources
    Instance resource statistics response data
    securityGroupIdLists string[]
    List of security groups 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
    subnetIdLists string[]
    List of subnets used by the instance
    tags InstanceTag[]
    times number
    Purchase duration for subscription instances, in months
    topicLimit number
    Maximum number of topics per instance
    vpcId string
    VPC ID where the instance is located
    zoneIdLists string[]
    List of availability zones where the instance is located
    auto_renew str
    Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
    billing_period str
    Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
    billing_type str
    Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
    created_time str
    Instance creation time
    description str
    Instance description statement
    eip_id str
    Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
    endpoints InstanceEndpointsArgs
    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
    Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
    partition_limit int
    Maximum number of partitions per instance
    project_name str
    Project name to which the instance belongs
    resource_tags Sequence[InstanceResourceTagArgs]
    resources InstanceResourcesArgs
    Instance resource statistics response data
    security_group_id_lists Sequence[str]
    List of security groups 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_lists Sequence[str]
    List of subnets used by the instance
    tags Sequence[InstanceTagArgs]
    times int
    Purchase duration for 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_lists Sequence[str]
    List of availability zones where the instance is located
    autoRenew String
    Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
    billingPeriod String
    Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
    billingType String
    Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
    createdTime String
    Instance creation time
    description String
    Instance description statement
    eipId String
    Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
    endpoints Property Map
    Response data for all instance endpoints
    expirationTime String
    Instance expiration time
    groupLimit Number
    Maximum number of consumer groups per instance
    instanceId String
    Instance ID
    messageRetention Number
    Message retention period for all topics under the instance, in hours
    name String
    Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
    partitionLimit Number
    Maximum number of partitions per instance
    projectName String
    Project name to which the instance belongs
    resourceTags List<Property Map>
    resources Property Map
    Instance resource statistics response data
    securityGroupIdLists List<String>
    List of security groups 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
    subnetIdLists List<String>
    List of subnets used by the instance
    tags List<Property Map>
    times Number
    Purchase duration for subscription instances, in months
    topicLimit Number
    Maximum number of topics per instance
    vpcId String
    VPC ID where the instance is located
    zoneIdLists List<String>
    List of availability zones where the instance is located

    Supporting Types

    InstanceEndpoints, InstanceEndpointsArgs

    Overlay Byteplus.InstanceEndpointsOverlay
    Instance private network access endpoint response data
    Public Byteplus.InstanceEndpointsPublic
    Instance public access endpoint response data
    Overlay InstanceEndpointsOverlay
    Instance private network access endpoint response data
    Public InstanceEndpointsPublic
    Instance public access endpoint response data
    overlay InstanceEndpointsOverlay
    Instance private network access endpoint response data
    public_ InstanceEndpointsPublic
    Instance public access endpoint response data
    overlay InstanceEndpointsOverlay
    Instance private network access endpoint response data
    public InstanceEndpointsPublic
    Instance public access endpoint response data
    overlay InstanceEndpointsOverlay
    Instance private network access endpoint response data
    public InstanceEndpointsPublic
    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
    EipId string
    ID of the EIP bound to the instance
    Plain string
    Private network Plain endpoint
    PlainPort int
    Standard endpoint port
    Sasl string
    Private network SASL authentication endpoint
    SaslPort int
    Authentication endpoint port
    Ssl string
    Encrypted endpoint
    SslPort int
    Encrypted endpoint port
    Status string
    Endpoint status
    VpcIds List<string>
    List of VPC IDs associated with the sales zone network
    Address string
    Domain mapping address
    EipId string
    ID of the EIP bound to the instance
    Plain string
    Private network Plain endpoint
    PlainPort int
    Standard endpoint port
    Sasl string
    Private network SASL authentication endpoint
    SaslPort int
    Authentication endpoint port
    Ssl string
    Encrypted endpoint
    SslPort int
    Encrypted endpoint port
    Status string
    Endpoint status
    VpcIds []string
    List of VPC IDs associated with the sales zone network
    address String
    Domain mapping address
    eipId String
    ID of the EIP bound to the instance
    plain String
    Private network Plain endpoint
    plainPort Integer
    Standard endpoint port
    sasl String
    Private network SASL authentication endpoint
    saslPort Integer
    Authentication endpoint port
    ssl String
    Encrypted endpoint
    sslPort Integer
    Encrypted endpoint port
    status String
    Endpoint status
    vpcIds List<String>
    List of VPC IDs associated with the sales zone network
    address string
    Domain mapping address
    eipId string
    ID of the EIP bound to the instance
    plain string
    Private network Plain endpoint
    plainPort number
    Standard endpoint port
    sasl string
    Private network SASL authentication endpoint
    saslPort number
    Authentication endpoint port
    ssl string
    Encrypted endpoint
    sslPort number
    Encrypted endpoint port
    status string
    Endpoint status
    vpcIds 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 endpoint
    plain_port int
    Standard endpoint port
    sasl str
    Private network SASL authentication endpoint
    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
    eipId String
    ID of the EIP bound to the instance
    plain String
    Private network Plain endpoint
    plainPort Number
    Standard endpoint port
    sasl String
    Private network SASL authentication endpoint
    saslPort Number
    Authentication endpoint port
    ssl String
    Encrypted endpoint
    sslPort Number
    Encrypted endpoint port
    status String
    Endpoint status
    vpcIds List<String>
    List of VPC IDs associated with the sales zone network

    InstanceEndpointsPublic, InstanceEndpointsPublicArgs

    Address string
    Domain mapping address
    EipId string
    ID of the EIP bound to the instance
    Plain string
    Private network Plain endpoint
    PlainPort int
    Standard endpoint port
    Sasl string
    Private network SASL authentication endpoint
    SaslPort int
    Authentication endpoint port
    Ssl string
    Encrypted endpoint
    SslPort int
    Encrypted endpoint port
    Status string
    Endpoint status
    VpcIds List<string>
    List of VPC IDs associated with the sales zone network
    Address string
    Domain mapping address
    EipId string
    ID of the EIP bound to the instance
    Plain string
    Private network Plain endpoint
    PlainPort int
    Standard endpoint port
    Sasl string
    Private network SASL authentication endpoint
    SaslPort int
    Authentication endpoint port
    Ssl string
    Encrypted endpoint
    SslPort int
    Encrypted endpoint port
    Status string
    Endpoint status
    VpcIds []string
    List of VPC IDs associated with the sales zone network
    address String
    Domain mapping address
    eipId String
    ID of the EIP bound to the instance
    plain String
    Private network Plain endpoint
    plainPort Integer
    Standard endpoint port
    sasl String
    Private network SASL authentication endpoint
    saslPort Integer
    Authentication endpoint port
    ssl String
    Encrypted endpoint
    sslPort Integer
    Encrypted endpoint port
    status String
    Endpoint status
    vpcIds List<String>
    List of VPC IDs associated with the sales zone network
    address string
    Domain mapping address
    eipId string
    ID of the EIP bound to the instance
    plain string
    Private network Plain endpoint
    plainPort number
    Standard endpoint port
    sasl string
    Private network SASL authentication endpoint
    saslPort number
    Authentication endpoint port
    ssl string
    Encrypted endpoint
    sslPort number
    Encrypted endpoint port
    status string
    Endpoint status
    vpcIds 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 endpoint
    plain_port int
    Standard endpoint port
    sasl str
    Private network SASL authentication endpoint
    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
    eipId String
    ID of the EIP bound to the instance
    plain String
    Private network Plain endpoint
    plainPort Number
    Standard endpoint port
    sasl String
    Private network SASL authentication endpoint
    saslPort Number
    Authentication endpoint port
    ssl String
    Encrypted endpoint
    sslPort Number
    Encrypted endpoint port
    status String
    Endpoint status
    vpcIds List<String>
    List of VPC IDs associated with the sales zone network

    InstanceResourceTag, InstanceResourceTagArgs

    TagKvs List<Byteplus.InstanceResourceTagTagKv>
    Type string
    Tag type. Options: CUSTOM: custom tag. SYSTEM: system tag
    TagKvs []InstanceResourceTagTagKv
    Type string
    Tag type. Options: CUSTOM: custom tag. SYSTEM: system tag
    tagKvs List<InstanceResourceTagTagKv>
    type String
    Tag type. Options: CUSTOM: custom tag. SYSTEM: system tag
    tagKvs InstanceResourceTagTagKv[]
    type string
    Tag type. Options: CUSTOM: custom tag. SYSTEM: system tag
    tag_kvs Sequence[InstanceResourceTagTagKv]
    type str
    Tag type. Options: CUSTOM: custom tag. SYSTEM: system tag
    tagKvs List<Property Map>
    type String
    Tag type. Options: CUSTOM: custom tag. SYSTEM: system tag

    InstanceResourceTagTagKv, InstanceResourceTagTagKvArgs

    Key string
    Tag key
    Type string
    Type of instance tag. Possible values: CUSTOM: Custom tag. SYSTEM: System tag
    Value string
    Tag value
    Key string
    Tag key
    Type string
    Type of instance tag. Possible values: CUSTOM: Custom tag. SYSTEM: System tag
    Value string
    Tag value
    key String
    Tag key
    type String
    Type of instance tag. Possible values: CUSTOM: Custom tag. SYSTEM: System tag
    value String
    Tag value
    key string
    Tag key
    type string
    Type of instance tag. Possible values: CUSTOM: Custom tag. SYSTEM: System tag
    value string
    Tag value
    key str
    Tag key
    type str
    Type of instance tag. Possible values: CUSTOM: Custom tag. SYSTEM: System tag
    value str
    Tag value
    key String
    Tag key
    type String
    Type of instance tag. Possible values: CUSTOM: Custom tag. SYSTEM: System tag
    value String
    Tag value

    InstanceResources, InstanceResourcesArgs

    Storage Byteplus.InstanceResourcesStorage
    Resource statistics response data
    Storage InstanceResourcesStorage
    Resource statistics response data
    storage InstanceResourcesStorage
    Resource statistics response data
    storage InstanceResourcesStorage
    Resource statistics response data
    storage InstanceResourcesStorage
    Resource statistics response data
    storage Property Map
    Resource statistics response data

    InstanceResourcesStorage, InstanceResourcesStorageArgs

    Size int
    Resource size
    Unit string
    Resource unit
    Size int
    Resource size
    Unit string
    Resource unit
    size Integer
    Resource size
    unit String
    Resource unit
    size number
    Resource size
    unit string
    Resource unit
    size int
    Resource size
    unit str
    Resource unit
    size Number
    Resource size
    unit String
    Resource unit

    InstanceTag, InstanceTagArgs

    Key string
    Tag key
    Type string
    Type of instance tag. Possible values: CUSTOM: Custom tag. SYSTEM: System tag
    Value string
    Tag value
    Key string
    Tag key
    Type string
    Type of instance tag. Possible values: CUSTOM: Custom tag. SYSTEM: System tag
    Value string
    Tag value
    key String
    Tag key
    type String
    Type of instance tag. Possible values: CUSTOM: Custom tag. SYSTEM: System tag
    value String
    Tag value
    key string
    Tag key
    type string
    Type of instance tag. Possible values: CUSTOM: Custom tag. SYSTEM: System tag
    value string
    Tag value
    key str
    Tag key
    type str
    Type of instance tag. Possible values: CUSTOM: Custom tag. SYSTEM: System tag
    value str
    Tag value
    key String
    Tag key
    type String
    Type of instance tag. Possible values: CUSTOM: Custom tag. SYSTEM: System tag
    value String
    Tag value

    Import

    $ pulumi import bytepluscc:bmq/instance:Instance example "instance_id"

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

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.25
    published on Thursday, May 7, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.