1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. bmq
  5. Instance
bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
bytepluscc logo
bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus

    云原生消息引擎 100% 兼容 Apache Kafka 协议,基于云原生的全托管、高吞吐、低时延、高可用、高可扩展性、高稳定性的分布式消息引擎服务,支持灵活动态扩缩容和流批一体计算,提供企业级大数据量级的实时流数据处理能力,帮助您构建数据处理的“中枢神经系统”,广泛应用于日志收集、数据聚合、离线数据分析等业务场景。

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as bytepluscc from "@byteplus/pulumi-bytepluscc";
    
    const bMQInstanceDemo = new bytepluscc.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_bytepluscc as bytepluscc
    
    b_mq_instance_demo = bytepluscc.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/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/bmq"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    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 Bytepluscc = Byteplus.Pulumi.Bytepluscc;
    
    return await Deployment.RunAsync(() => 
    {
        var bMQInstanceDemo = new Bytepluscc.Bmq.Instance("BMQInstanceDemo", new()
        {
            Name = "BMQInstanceDemo",
            BillingType = "POST",
            ProjectName = "default",
            Specification = "bmq.standard",
            VpcId = "vpc-miltj87lh2ww5smt1bxxxxx",
            MessageRetention = 1,
            Endpoints = new Bytepluscc.Bmq.Inputs.InstanceEndpointsArgs
            {
                Public = new Bytepluscc.Bmq.Inputs.InstanceEndpointsPublicArgs
                {
                    EipId = "eip-3nriu2y2ufwu8931exxxxx",
                },
                Overlay = new Bytepluscc.Bmq.Inputs.InstanceEndpointsOverlayArgs
                {
                    VpcIds = new[]
                    {
                        "vpc-miltj87lh2ww5smt1bxxxxx",
                    },
                },
            },
            SecurityGroupIdLists = new[]
            {
                "sg-3nqnz9en1ucxs931eaxxxxx",
            },
            SubnetIdLists = new[]
            {
                "subnet-w02wsq25fitc865ykaxxxxx",
            },
            ZoneIdLists = new[]
            {
                "cn-beijing-a",
            },
            Tags = new[]
            {
                new Bytepluscc.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.byteplus.bytepluscc.bmq.Instance;
    import com.byteplus.bytepluscc.bmq.InstanceArgs;
    import com.pulumi.bytepluscc.bmq.inputs.InstanceEndpointsArgs;
    import com.pulumi.bytepluscc.bmq.inputs.InstanceEndpointsPublicArgs;
    import com.pulumi.bytepluscc.bmq.inputs.InstanceEndpointsOverlayArgs;
    import com.pulumi.bytepluscc.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: bytepluscc: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: 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
    实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
    Name string
    自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
    ProjectName string
    实例所属项目名称。
    SecurityGroupIdLists List<string>
    实例使用安全组列表。
    Specification string
    实例规格。
    SubnetIdLists List<string>
    实例使用的子网列表。
    VpcId string
    实例所在VPC ID。
    ZoneIdLists List<string>
    实例所在可用区列表。
    AutoRenew string
    是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
    BillingPeriod string
    购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
    Description string
    实例的描述语句。
    EipId string
    实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
    Endpoints Byteplus.InstanceEndpoints
    实例所有接入点响应数据。
    MessageRetention int
    实例下所有 Topic 的消息保留时长,单位为小时。
    Tags List<Byteplus.InstanceTag>
    Times int
    包年包月类型实例的购买时长,单位为月。
    BillingType string
    实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
    Name string
    自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
    ProjectName string
    实例所属项目名称。
    SecurityGroupIdLists []string
    实例使用安全组列表。
    Specification string
    实例规格。
    SubnetIdLists []string
    实例使用的子网列表。
    VpcId string
    实例所在VPC ID。
    ZoneIdLists []string
    实例所在可用区列表。
    AutoRenew string
    是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
    BillingPeriod string
    购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
    Description string
    实例的描述语句。
    EipId string
    实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
    Endpoints InstanceEndpointsArgs
    实例所有接入点响应数据。
    MessageRetention int
    实例下所有 Topic 的消息保留时长,单位为小时。
    Tags []InstanceTagArgs
    Times int
    包年包月类型实例的购买时长,单位为月。
    billingType String
    实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
    name String
    自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
    projectName String
    实例所属项目名称。
    securityGroupIdLists List<String>
    实例使用安全组列表。
    specification String
    实例规格。
    subnetIdLists List<String>
    实例使用的子网列表。
    vpcId String
    实例所在VPC ID。
    zoneIdLists List<String>
    实例所在可用区列表。
    autoRenew String
    是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
    billingPeriod String
    购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
    description String
    实例的描述语句。
    eipId String
    实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
    endpoints InstanceEndpoints
    实例所有接入点响应数据。
    messageRetention Integer
    实例下所有 Topic 的消息保留时长,单位为小时。
    tags List<InstanceTag>
    times Integer
    包年包月类型实例的购买时长,单位为月。
    billingType string
    实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
    name string
    自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
    projectName string
    实例所属项目名称。
    securityGroupIdLists string[]
    实例使用安全组列表。
    specification string
    实例规格。
    subnetIdLists string[]
    实例使用的子网列表。
    vpcId string
    实例所在VPC ID。
    zoneIdLists string[]
    实例所在可用区列表。
    autoRenew string
    是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
    billingPeriod string
    购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
    description string
    实例的描述语句。
    eipId string
    实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
    endpoints InstanceEndpoints
    实例所有接入点响应数据。
    messageRetention number
    实例下所有 Topic 的消息保留时长,单位为小时。
    tags InstanceTag[]
    times number
    包年包月类型实例的购买时长,单位为月。
    billing_type str
    实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
    name str
    自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
    project_name str
    实例所属项目名称。
    security_group_id_lists Sequence[str]
    实例使用安全组列表。
    specification str
    实例规格。
    subnet_id_lists Sequence[str]
    实例使用的子网列表。
    vpc_id str
    实例所在VPC ID。
    zone_id_lists Sequence[str]
    实例所在可用区列表。
    auto_renew str
    是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
    billing_period str
    购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
    description str
    实例的描述语句。
    eip_id str
    实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
    endpoints InstanceEndpointsArgs
    实例所有接入点响应数据。
    message_retention int
    实例下所有 Topic 的消息保留时长,单位为小时。
    tags Sequence[InstanceTagArgs]
    times int
    包年包月类型实例的购买时长,单位为月。
    billingType String
    实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
    name String
    自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
    projectName String
    实例所属项目名称。
    securityGroupIdLists List<String>
    实例使用安全组列表。
    specification String
    实例规格。
    subnetIdLists List<String>
    实例使用的子网列表。
    vpcId String
    实例所在VPC ID。
    zoneIdLists List<String>
    实例所在可用区列表。
    autoRenew String
    是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
    billingPeriod String
    购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
    description String
    实例的描述语句。
    eipId String
    实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
    endpoints Property Map
    实例所有接入点响应数据。
    messageRetention Number
    实例下所有 Topic 的消息保留时长,单位为小时。
    tags List<Property Map>
    times Number
    包年包月类型实例的购买时长,单位为月。

    Outputs

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

    CreatedTime string
    实例的创建时间。
    ExpirationTime string
    实例过期时间。
    GroupLimit int
    实例消费组数量上限。
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    实例ID。
    PartitionLimit int
    实例分区数量上限。
    ResourceTags List<Byteplus.InstanceResourceTag>
    Resources Byteplus.InstanceResources
    实例资源统计响应数据。
    Status string
    实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
    TopicLimit int
    实例Topic数量上限。
    CreatedTime string
    实例的创建时间。
    ExpirationTime string
    实例过期时间。
    GroupLimit int
    实例消费组数量上限。
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    实例ID。
    PartitionLimit int
    实例分区数量上限。
    ResourceTags []InstanceResourceTag
    Resources InstanceResources
    实例资源统计响应数据。
    Status string
    实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
    TopicLimit int
    实例Topic数量上限。
    createdTime String
    实例的创建时间。
    expirationTime String
    实例过期时间。
    groupLimit Integer
    实例消费组数量上限。
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    实例ID。
    partitionLimit Integer
    实例分区数量上限。
    resourceTags List<InstanceResourceTag>
    resources InstanceResources
    实例资源统计响应数据。
    status String
    实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
    topicLimit Integer
    实例Topic数量上限。
    createdTime string
    实例的创建时间。
    expirationTime string
    实例过期时间。
    groupLimit number
    实例消费组数量上限。
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    实例ID。
    partitionLimit number
    实例分区数量上限。
    resourceTags InstanceResourceTag[]
    resources InstanceResources
    实例资源统计响应数据。
    status string
    实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
    topicLimit number
    实例Topic数量上限。
    created_time str
    实例的创建时间。
    expiration_time str
    实例过期时间。
    group_limit int
    实例消费组数量上限。
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    实例ID。
    partition_limit int
    实例分区数量上限。
    resource_tags Sequence[InstanceResourceTag]
    resources InstanceResources
    实例资源统计响应数据。
    status str
    实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
    topic_limit int
    实例Topic数量上限。
    createdTime String
    实例的创建时间。
    expirationTime String
    实例过期时间。
    groupLimit Number
    实例消费组数量上限。
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    实例ID。
    partitionLimit Number
    实例分区数量上限。
    resourceTags List<Property Map>
    resources Property Map
    实例资源统计响应数据。
    status String
    实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
    topicLimit Number
    实例Topic数量上限。

    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
    是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
    BillingPeriod string
    购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
    BillingType string
    实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
    CreatedTime string
    实例的创建时间。
    Description string
    实例的描述语句。
    EipId string
    实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
    Endpoints Byteplus.InstanceEndpoints
    实例所有接入点响应数据。
    ExpirationTime string
    实例过期时间。
    GroupLimit int
    实例消费组数量上限。
    InstanceId string
    实例ID。
    MessageRetention int
    实例下所有 Topic 的消息保留时长,单位为小时。
    Name string
    自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
    PartitionLimit int
    实例分区数量上限。
    ProjectName string
    实例所属项目名称。
    ResourceTags List<Byteplus.InstanceResourceTag>
    Resources Byteplus.InstanceResources
    实例资源统计响应数据。
    SecurityGroupIdLists List<string>
    实例使用安全组列表。
    Specification string
    实例规格。
    Status string
    实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
    SubnetIdLists List<string>
    实例使用的子网列表。
    Tags List<Byteplus.InstanceTag>
    Times int
    包年包月类型实例的购买时长,单位为月。
    TopicLimit int
    实例Topic数量上限。
    VpcId string
    实例所在VPC ID。
    ZoneIdLists List<string>
    实例所在可用区列表。
    AutoRenew string
    是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
    BillingPeriod string
    购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
    BillingType string
    实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
    CreatedTime string
    实例的创建时间。
    Description string
    实例的描述语句。
    EipId string
    实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
    Endpoints InstanceEndpointsArgs
    实例所有接入点响应数据。
    ExpirationTime string
    实例过期时间。
    GroupLimit int
    实例消费组数量上限。
    InstanceId string
    实例ID。
    MessageRetention int
    实例下所有 Topic 的消息保留时长,单位为小时。
    Name string
    自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
    PartitionLimit int
    实例分区数量上限。
    ProjectName string
    实例所属项目名称。
    ResourceTags []InstanceResourceTagArgs
    Resources InstanceResourcesArgs
    实例资源统计响应数据。
    SecurityGroupIdLists []string
    实例使用安全组列表。
    Specification string
    实例规格。
    Status string
    实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
    SubnetIdLists []string
    实例使用的子网列表。
    Tags []InstanceTagArgs
    Times int
    包年包月类型实例的购买时长,单位为月。
    TopicLimit int
    实例Topic数量上限。
    VpcId string
    实例所在VPC ID。
    ZoneIdLists []string
    实例所在可用区列表。
    autoRenew String
    是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
    billingPeriod String
    购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
    billingType String
    实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
    createdTime String
    实例的创建时间。
    description String
    实例的描述语句。
    eipId String
    实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
    endpoints InstanceEndpoints
    实例所有接入点响应数据。
    expirationTime String
    实例过期时间。
    groupLimit Integer
    实例消费组数量上限。
    instanceId String
    实例ID。
    messageRetention Integer
    实例下所有 Topic 的消息保留时长,单位为小时。
    name String
    自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
    partitionLimit Integer
    实例分区数量上限。
    projectName String
    实例所属项目名称。
    resourceTags List<InstanceResourceTag>
    resources InstanceResources
    实例资源统计响应数据。
    securityGroupIdLists List<String>
    实例使用安全组列表。
    specification String
    实例规格。
    status String
    实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
    subnetIdLists List<String>
    实例使用的子网列表。
    tags List<InstanceTag>
    times Integer
    包年包月类型实例的购买时长,单位为月。
    topicLimit Integer
    实例Topic数量上限。
    vpcId String
    实例所在VPC ID。
    zoneIdLists List<String>
    实例所在可用区列表。
    autoRenew string
    是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
    billingPeriod string
    购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
    billingType string
    实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
    createdTime string
    实例的创建时间。
    description string
    实例的描述语句。
    eipId string
    实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
    endpoints InstanceEndpoints
    实例所有接入点响应数据。
    expirationTime string
    实例过期时间。
    groupLimit number
    实例消费组数量上限。
    instanceId string
    实例ID。
    messageRetention number
    实例下所有 Topic 的消息保留时长,单位为小时。
    name string
    自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
    partitionLimit number
    实例分区数量上限。
    projectName string
    实例所属项目名称。
    resourceTags InstanceResourceTag[]
    resources InstanceResources
    实例资源统计响应数据。
    securityGroupIdLists string[]
    实例使用安全组列表。
    specification string
    实例规格。
    status string
    实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
    subnetIdLists string[]
    实例使用的子网列表。
    tags InstanceTag[]
    times number
    包年包月类型实例的购买时长,单位为月。
    topicLimit number
    实例Topic数量上限。
    vpcId string
    实例所在VPC ID。
    zoneIdLists string[]
    实例所在可用区列表。
    auto_renew str
    是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
    billing_period str
    购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
    billing_type str
    实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
    created_time str
    实例的创建时间。
    description str
    实例的描述语句。
    eip_id str
    实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
    endpoints InstanceEndpointsArgs
    实例所有接入点响应数据。
    expiration_time str
    实例过期时间。
    group_limit int
    实例消费组数量上限。
    instance_id str
    实例ID。
    message_retention int
    实例下所有 Topic 的消息保留时长,单位为小时。
    name str
    自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
    partition_limit int
    实例分区数量上限。
    project_name str
    实例所属项目名称。
    resource_tags Sequence[InstanceResourceTagArgs]
    resources InstanceResourcesArgs
    实例资源统计响应数据。
    security_group_id_lists Sequence[str]
    实例使用安全组列表。
    specification str
    实例规格。
    status str
    实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
    subnet_id_lists Sequence[str]
    实例使用的子网列表。
    tags Sequence[InstanceTagArgs]
    times int
    包年包月类型实例的购买时长,单位为月。
    topic_limit int
    实例Topic数量上限。
    vpc_id str
    实例所在VPC ID。
    zone_id_lists Sequence[str]
    实例所在可用区列表。
    autoRenew String
    是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
    billingPeriod String
    购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
    billingType String
    实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
    createdTime String
    实例的创建时间。
    description String
    实例的描述语句。
    eipId String
    实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
    endpoints Property Map
    实例所有接入点响应数据。
    expirationTime String
    实例过期时间。
    groupLimit Number
    实例消费组数量上限。
    instanceId String
    实例ID。
    messageRetention Number
    实例下所有 Topic 的消息保留时长,单位为小时。
    name String
    自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
    partitionLimit Number
    实例分区数量上限。
    projectName String
    实例所属项目名称。
    resourceTags List<Property Map>
    resources Property Map
    实例资源统计响应数据。
    securityGroupIdLists List<String>
    实例使用安全组列表。
    specification String
    实例规格。
    status String
    实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
    subnetIdLists List<String>
    实例使用的子网列表。
    tags List<Property Map>
    times Number
    包年包月类型实例的购买时长,单位为月。
    topicLimit Number
    实例Topic数量上限。
    vpcId String
    实例所在VPC ID。
    zoneIdLists List<String>
    实例所在可用区列表。

    Supporting Types

    InstanceEndpoints, InstanceEndpointsArgs

    Overlay Byteplus.InstanceEndpointsOverlay
    实例私网访问接入点响应数据。
    Public Byteplus.InstanceEndpointsPublic
    实例公网访问接入点响应数据。
    Overlay InstanceEndpointsOverlay
    实例私网访问接入点响应数据。
    Public InstanceEndpointsPublic
    实例公网访问接入点响应数据。
    overlay InstanceEndpointsOverlay
    实例私网访问接入点响应数据。
    public_ InstanceEndpointsPublic
    实例公网访问接入点响应数据。
    overlay InstanceEndpointsOverlay
    实例私网访问接入点响应数据。
    public InstanceEndpointsPublic
    实例公网访问接入点响应数据。
    overlay InstanceEndpointsOverlay
    实例私网访问接入点响应数据。
    public InstanceEndpointsPublic
    实例公网访问接入点响应数据。
    overlay Property Map
    实例私网访问接入点响应数据。
    public Property Map
    实例公网访问接入点响应数据。

    InstanceEndpointsOverlay, InstanceEndpointsOverlayArgs

    Address string
    域名映射地址。
    EipId string
    实例绑定的EIP的ID。
    Plain string
    私网Plain接入点。
    PlainPort int
    普通接入点端口。
    Sasl string
    私网SASL认证接入点。
    SaslPort int
    认证接入点端口。
    Ssl string
    加密接入点。
    SslPort int
    加密接入点端口。
    Status string
    接入点状态。
    VpcIds List<string>
    售卖区网络关联的VPC ID列表。
    Address string
    域名映射地址。
    EipId string
    实例绑定的EIP的ID。
    Plain string
    私网Plain接入点。
    PlainPort int
    普通接入点端口。
    Sasl string
    私网SASL认证接入点。
    SaslPort int
    认证接入点端口。
    Ssl string
    加密接入点。
    SslPort int
    加密接入点端口。
    Status string
    接入点状态。
    VpcIds []string
    售卖区网络关联的VPC ID列表。
    address String
    域名映射地址。
    eipId String
    实例绑定的EIP的ID。
    plain String
    私网Plain接入点。
    plainPort Integer
    普通接入点端口。
    sasl String
    私网SASL认证接入点。
    saslPort Integer
    认证接入点端口。
    ssl String
    加密接入点。
    sslPort Integer
    加密接入点端口。
    status String
    接入点状态。
    vpcIds List<String>
    售卖区网络关联的VPC ID列表。
    address string
    域名映射地址。
    eipId string
    实例绑定的EIP的ID。
    plain string
    私网Plain接入点。
    plainPort number
    普通接入点端口。
    sasl string
    私网SASL认证接入点。
    saslPort number
    认证接入点端口。
    ssl string
    加密接入点。
    sslPort number
    加密接入点端口。
    status string
    接入点状态。
    vpcIds string[]
    售卖区网络关联的VPC ID列表。
    address str
    域名映射地址。
    eip_id str
    实例绑定的EIP的ID。
    plain str
    私网Plain接入点。
    plain_port int
    普通接入点端口。
    sasl str
    私网SASL认证接入点。
    sasl_port int
    认证接入点端口。
    ssl str
    加密接入点。
    ssl_port int
    加密接入点端口。
    status str
    接入点状态。
    vpc_ids Sequence[str]
    售卖区网络关联的VPC ID列表。
    address String
    域名映射地址。
    eipId String
    实例绑定的EIP的ID。
    plain String
    私网Plain接入点。
    plainPort Number
    普通接入点端口。
    sasl String
    私网SASL认证接入点。
    saslPort Number
    认证接入点端口。
    ssl String
    加密接入点。
    sslPort Number
    加密接入点端口。
    status String
    接入点状态。
    vpcIds List<String>
    售卖区网络关联的VPC ID列表。

    InstanceEndpointsPublic, InstanceEndpointsPublicArgs

    Address string
    域名映射地址。
    EipId string
    实例绑定的EIP的ID。
    Plain string
    私网Plain接入点。
    PlainPort int
    普通接入点端口。
    Sasl string
    私网SASL认证接入点。
    SaslPort int
    认证接入点端口。
    Ssl string
    加密接入点。
    SslPort int
    加密接入点端口。
    Status string
    接入点状态。
    VpcIds List<string>
    售卖区网络关联的VPC ID列表。
    Address string
    域名映射地址。
    EipId string
    实例绑定的EIP的ID。
    Plain string
    私网Plain接入点。
    PlainPort int
    普通接入点端口。
    Sasl string
    私网SASL认证接入点。
    SaslPort int
    认证接入点端口。
    Ssl string
    加密接入点。
    SslPort int
    加密接入点端口。
    Status string
    接入点状态。
    VpcIds []string
    售卖区网络关联的VPC ID列表。
    address String
    域名映射地址。
    eipId String
    实例绑定的EIP的ID。
    plain String
    私网Plain接入点。
    plainPort Integer
    普通接入点端口。
    sasl String
    私网SASL认证接入点。
    saslPort Integer
    认证接入点端口。
    ssl String
    加密接入点。
    sslPort Integer
    加密接入点端口。
    status String
    接入点状态。
    vpcIds List<String>
    售卖区网络关联的VPC ID列表。
    address string
    域名映射地址。
    eipId string
    实例绑定的EIP的ID。
    plain string
    私网Plain接入点。
    plainPort number
    普通接入点端口。
    sasl string
    私网SASL认证接入点。
    saslPort number
    认证接入点端口。
    ssl string
    加密接入点。
    sslPort number
    加密接入点端口。
    status string
    接入点状态。
    vpcIds string[]
    售卖区网络关联的VPC ID列表。
    address str
    域名映射地址。
    eip_id str
    实例绑定的EIP的ID。
    plain str
    私网Plain接入点。
    plain_port int
    普通接入点端口。
    sasl str
    私网SASL认证接入点。
    sasl_port int
    认证接入点端口。
    ssl str
    加密接入点。
    ssl_port int
    加密接入点端口。
    status str
    接入点状态。
    vpc_ids Sequence[str]
    售卖区网络关联的VPC ID列表。
    address String
    域名映射地址。
    eipId String
    实例绑定的EIP的ID。
    plain String
    私网Plain接入点。
    plainPort Number
    普通接入点端口。
    sasl String
    私网SASL认证接入点。
    saslPort Number
    认证接入点端口。
    ssl String
    加密接入点。
    sslPort Number
    加密接入点端口。
    status String
    接入点状态。
    vpcIds List<String>
    售卖区网络关联的VPC ID列表。

    InstanceResourceTag, InstanceResourceTagArgs

    TagKvs List<Byteplus.InstanceResourceTagTagKv>
    Type string
    标签类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
    TagKvs []InstanceResourceTagTagKv
    Type string
    标签类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
    tagKvs List<InstanceResourceTagTagKv>
    type String
    标签类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
    tagKvs InstanceResourceTagTagKv[]
    type string
    标签类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
    tag_kvs Sequence[InstanceResourceTagTagKv]
    type str
    标签类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
    tagKvs List<Property Map>
    type String
    标签类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。

    InstanceResourceTagTagKv, InstanceResourceTagTagKvArgs

    Key string
    标签键。
    Type string
    实例标签的类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
    Value string
    标签值。
    Key string
    标签键。
    Type string
    实例标签的类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
    Value string
    标签值。
    key String
    标签键。
    type String
    实例标签的类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
    value String
    标签值。
    key string
    标签键。
    type string
    实例标签的类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
    value string
    标签值。
    key str
    标签键。
    type str
    实例标签的类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
    value str
    标签值。
    key String
    标签键。
    type String
    实例标签的类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
    value String
    标签值。

    InstanceResources, InstanceResourcesArgs

    Storage Byteplus.InstanceResourcesStorage
    资源统计响应数据。
    Storage InstanceResourcesStorage
    资源统计响应数据。
    storage InstanceResourcesStorage
    资源统计响应数据。
    storage InstanceResourcesStorage
    资源统计响应数据。
    storage InstanceResourcesStorage
    资源统计响应数据。
    storage Property Map
    资源统计响应数据。

    InstanceResourcesStorage, InstanceResourcesStorageArgs

    Size int
    资源大小。
    Unit string
    资源单位。
    Size int
    资源大小。
    Unit string
    资源单位。
    size Integer
    资源大小。
    unit String
    资源单位。
    size number
    资源大小。
    unit string
    资源单位。
    size int
    资源大小。
    unit str
    资源单位。
    size Number
    资源大小。
    unit String
    资源单位。

    InstanceTag, InstanceTagArgs

    Key string
    标签键。
    Type string
    实例标签的类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
    Value string
    标签值。
    Key string
    标签键。
    Type string
    实例标签的类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
    Value string
    标签值。
    key String
    标签键。
    type String
    实例标签的类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
    value String
    标签值。
    key string
    标签键。
    type string
    实例标签的类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
    value string
    标签值。
    key str
    标签键。
    type str
    实例标签的类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
    value str
    标签值。
    key String
    标签键。
    type String
    实例标签的类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
    value String
    标签值。

    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
    bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
      Meet Neo: Your AI Platform Teammate