1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. kafka
  5. Instance
Viewing docs for volcenginecc v0.0.28
published on Thursday, Mar 26, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.kafka.Instance

volcenginecc logo
Viewing docs for volcenginecc v0.0.28
published on Thursday, Mar 26, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    消息队列 Kafka版是一款基于 Apache Kafka 构建的分布式消息中间件服务，具备高吞吐、高可扩展性等特性，提供流式数据的发布/订阅和多副本存储机制，广泛应用于日志压缩收集、流式数据处理、消息解耦、流量削峰去谷等应用场景。

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  kafkaInstanceDemo:
    type: volcenginecc:kafka:Instance
    name: KafkaInstanceDemo
    properties:
      chargeInfo:
        charge_type: PostPaid
        auto_renew: false
      computeSpec: kafka.20xrate.hw
      eipId: eip-****
      instanceDescription: CCAPI-TEST
      instanceName: CCAPI-TEST
      subnetId: subnet-****
      ipWhiteLists:
        - acl-****
      parameters: '{"LogRetentionHours":"1","MessageMaxByte":"2","MessageTimestampType":"CreateTime","OffsetRetentionMinutes":"10","AutoDeleteGroup":"False"}'
      partitionNumber: 350
      storageSpace: 300
      storageType: ESSD_PL0
      tags:
        - key: env
          value: test
      version: 2.8.2
      vpcId: vpc-****
      zoneId: cn-beijing-a
      projectName: default

    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,
             subnet_id: Optional[str] = None,
             compute_spec: Optional[str] = None,
             zone_id: Optional[str] = None,
             vpc_id: Optional[str] = None,
             version: Optional[str] = None,
             instance_name: Optional[str] = None,
             ip_white_lists: Optional[Sequence[str]] = None,
             parameters: Optional[str] = None,
             partition_number: Optional[int] = None,
             project_name: Optional[str] = None,
             storage_space: Optional[int] = None,
             storage_type: Optional[str] = None,
             need_rebalance: Optional[bool] = None,
             tags: Optional[Sequence[InstanceTagArgs]] = None,
             user_name: Optional[str] = None,
             user_password: Optional[str] = None,
             charge_info: Optional[InstanceChargeInfoArgs] = None,
             instance_description: Optional[str] = None,
             eip_id: Optional[str] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

    type: volcenginecc:kafka: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 exampleinstanceResourceResourceFromKafkainstance = new Volcenginecc.Kafka.Instance("exampleinstanceResourceResourceFromKafkainstance", new()
{
    SubnetId = "string",
    ComputeSpec = "string",
    ZoneId = "string",
    VpcId = "string",
    Version = "string",
    InstanceName = "string",
    IpWhiteLists = new[]
    {
        "string",
    },
    Parameters = "string",
    PartitionNumber = 0,
    ProjectName = "string",
    StorageSpace = 0,
    StorageType = "string",
    NeedRebalance = false,
    Tags = new[]
    {
        new Volcenginecc.Kafka.Inputs.InstanceTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    UserName = "string",
    UserPassword = "string",
    ChargeInfo = new Volcenginecc.Kafka.Inputs.InstanceChargeInfoArgs
    {
        AutoRenew = false,
        ChargeExpireTime = "string",
        ChargeStartTime = "string",
        ChargeStatus = "string",
        ChargeType = "string",
        OverdueReclaimTime = "string",
        OverdueTime = "string",
        Period = 0,
        PeriodUnit = "string",
    },
    InstanceDescription = "string",
    EipId = "string",
});

    example, err := kafka.NewInstance(ctx, "exampleinstanceResourceResourceFromKafkainstance", &kafka.InstanceArgs{
	SubnetId:     pulumi.String("string"),
	ComputeSpec:  pulumi.String("string"),
	ZoneId:       pulumi.String("string"),
	VpcId:        pulumi.String("string"),
	Version:      pulumi.String("string"),
	InstanceName: pulumi.String("string"),
	IpWhiteLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	Parameters:      pulumi.String("string"),
	PartitionNumber: pulumi.Int(0),
	ProjectName:     pulumi.String("string"),
	StorageSpace:    pulumi.Int(0),
	StorageType:     pulumi.String("string"),
	NeedRebalance:   pulumi.Bool(false),
	Tags: kafka.InstanceTagArray{
		&kafka.InstanceTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	UserName:     pulumi.String("string"),
	UserPassword: pulumi.String("string"),
	ChargeInfo: &kafka.InstanceChargeInfoArgs{
		AutoRenew:          pulumi.Bool(false),
		ChargeExpireTime:   pulumi.String("string"),
		ChargeStartTime:    pulumi.String("string"),
		ChargeStatus:       pulumi.String("string"),
		ChargeType:         pulumi.String("string"),
		OverdueReclaimTime: pulumi.String("string"),
		OverdueTime:        pulumi.String("string"),
		Period:             pulumi.Int(0),
		PeriodUnit:         pulumi.String("string"),
	},
	InstanceDescription: pulumi.String("string"),
	EipId:               pulumi.String("string"),
})

    var exampleinstanceResourceResourceFromKafkainstance = new com.volcengine.volcenginecc.kafka.Instance("exampleinstanceResourceResourceFromKafkainstance", com.volcengine.volcenginecc.kafka.InstanceArgs.builder()
    .subnetId("string")
    .computeSpec("string")
    .zoneId("string")
    .vpcId("string")
    .version("string")
    .instanceName("string")
    .ipWhiteLists("string")
    .parameters("string")
    .partitionNumber(0)
    .projectName("string")
    .storageSpace(0)
    .storageType("string")
    .needRebalance(false)
    .tags(InstanceTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .userName("string")
    .userPassword("string")
    .chargeInfo(InstanceChargeInfoArgs.builder()
        .autoRenew(false)
        .chargeExpireTime("string")
        .chargeStartTime("string")
        .chargeStatus("string")
        .chargeType("string")
        .overdueReclaimTime("string")
        .overdueTime("string")
        .period(0)
        .periodUnit("string")
        .build())
    .instanceDescription("string")
    .eipId("string")
    .build());

    exampleinstance_resource_resource_from_kafkainstance = volcenginecc.kafka.Instance("exampleinstanceResourceResourceFromKafkainstance",
    subnet_id="string",
    compute_spec="string",
    zone_id="string",
    vpc_id="string",
    version="string",
    instance_name="string",
    ip_white_lists=["string"],
    parameters="string",
    partition_number=0,
    project_name="string",
    storage_space=0,
    storage_type="string",
    need_rebalance=False,
    tags=[{
        "key": "string",
        "value": "string",
    }],
    user_name="string",
    user_password="string",
    charge_info={
        "auto_renew": False,
        "charge_expire_time": "string",
        "charge_start_time": "string",
        "charge_status": "string",
        "charge_type": "string",
        "overdue_reclaim_time": "string",
        "overdue_time": "string",
        "period": 0,
        "period_unit": "string",
    },
    instance_description="string",
    eip_id="string")

    const exampleinstanceResourceResourceFromKafkainstance = new volcenginecc.kafka.Instance("exampleinstanceResourceResourceFromKafkainstance", {
    subnetId: "string",
    computeSpec: "string",
    zoneId: "string",
    vpcId: "string",
    version: "string",
    instanceName: "string",
    ipWhiteLists: ["string"],
    parameters: "string",
    partitionNumber: 0,
    projectName: "string",
    storageSpace: 0,
    storageType: "string",
    needRebalance: false,
    tags: [{
        key: "string",
        value: "string",
    }],
    userName: "string",
    userPassword: "string",
    chargeInfo: {
        autoRenew: false,
        chargeExpireTime: "string",
        chargeStartTime: "string",
        chargeStatus: "string",
        chargeType: "string",
        overdueReclaimTime: "string",
        overdueTime: "string",
        period: 0,
        periodUnit: "string",
    },
    instanceDescription: "string",
    eipId: "string",
});

    type: volcenginecc:kafka:Instance
properties:
    chargeInfo:
        autoRenew: false
        chargeExpireTime: string
        chargeStartTime: string
        chargeStatus: string
        chargeType: string
        overdueReclaimTime: string
        overdueTime: string
        period: 0
        periodUnit: string
    computeSpec: string
    eipId: string
    instanceDescription: string
    instanceName: string
    ipWhiteLists:
        - string
    needRebalance: false
    parameters: string
    partitionNumber: 0
    projectName: string
    storageSpace: 0
    storageType: string
    subnetId: string
    tags:
        - key: string
          value: string
    userName: string
    userPassword: string
    version: string
    vpcId: string
    zoneId: 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:

    ComputeSpec string
    实例的计算规格。
    SubnetId string
    实例所在的 VPC 子网 ID。
    Version string
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    VpcId string
    实例所在的私有网络 (VPC) ID。
    ZoneId string
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。
    ChargeInfo Volcengine.InstanceChargeInfo
    Kafka 实例的计费类型等计费信息。
    EipId string
    EIP 的 ID。
    InstanceDescription string
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    InstanceName string
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    IpWhiteLists List<string>
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    NeedRebalance bool
    是否开启再均衡。
    Parameters string
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    PartitionNumber int
    分区数量。
    ProjectName string
    当前创建的 Kafka 实例所属的 IAM 项目。
    StorageSpace int
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    StorageType string
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    Tags List<Volcengine.InstanceTag>
    UserName string
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    UserPassword string
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。
    ComputeSpec string
    实例的计算规格。
    SubnetId string
    实例所在的 VPC 子网 ID。
    Version string
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    VpcId string
    实例所在的私有网络 (VPC) ID。
    ZoneId string
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。
    ChargeInfo InstanceChargeInfoArgs
    Kafka 实例的计费类型等计费信息。
    EipId string
    EIP 的 ID。
    InstanceDescription string
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    InstanceName string
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    IpWhiteLists []string
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    NeedRebalance bool
    是否开启再均衡。
    Parameters string
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    PartitionNumber int
    分区数量。
    ProjectName string
    当前创建的 Kafka 实例所属的 IAM 项目。
    StorageSpace int
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    StorageType string
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    Tags []InstanceTagArgs
    UserName string
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    UserPassword string
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。
    computeSpec String
    实例的计算规格。
    subnetId String
    实例所在的 VPC 子网 ID。
    version String
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    vpcId String
    实例所在的私有网络 (VPC) ID。
    zoneId String
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。
    chargeInfo InstanceChargeInfo
    Kafka 实例的计费类型等计费信息。
    eipId String
    EIP 的 ID。
    instanceDescription String
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    instanceName String
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    ipWhiteLists List<String>
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    needRebalance Boolean
    是否开启再均衡。
    parameters String
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    partitionNumber Integer
    分区数量。
    projectName String
    当前创建的 Kafka 实例所属的 IAM 项目。
    storageSpace Integer
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    storageType String
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    tags List<InstanceTag>
    userName String
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    userPassword String
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。
    computeSpec string
    实例的计算规格。
    subnetId string
    实例所在的 VPC 子网 ID。
    version string
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    vpcId string
    实例所在的私有网络 (VPC) ID。
    zoneId string
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。
    chargeInfo InstanceChargeInfo
    Kafka 实例的计费类型等计费信息。
    eipId string
    EIP 的 ID。
    instanceDescription string
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    instanceName string
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    ipWhiteLists string[]
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    needRebalance boolean
    是否开启再均衡。
    parameters string
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    partitionNumber number
    分区数量。
    projectName string
    当前创建的 Kafka 实例所属的 IAM 项目。
    storageSpace number
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    storageType string
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    tags InstanceTag[]
    userName string
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    userPassword string
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。
    compute_spec str
    实例的计算规格。
    subnet_id str
    实例所在的 VPC 子网 ID。
    version str
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    vpc_id str
    实例所在的私有网络 (VPC) ID。
    zone_id str
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。
    charge_info InstanceChargeInfoArgs
    Kafka 实例的计费类型等计费信息。
    eip_id str
    EIP 的 ID。
    instance_description str
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    instance_name str
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    ip_white_lists Sequence[str]
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    need_rebalance bool
    是否开启再均衡。
    parameters str
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    partition_number int
    分区数量。
    project_name str
    当前创建的 Kafka 实例所属的 IAM 项目。
    storage_space int
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    storage_type str
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    tags Sequence[InstanceTagArgs]
    user_name str
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    user_password str
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。
    computeSpec String
    实例的计算规格。
    subnetId String
    实例所在的 VPC 子网 ID。
    version String
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    vpcId String
    实例所在的私有网络 (VPC) ID。
    zoneId String
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。
    chargeInfo Property Map
    Kafka 实例的计费类型等计费信息。
    eipId String
    EIP 的 ID。
    instanceDescription String
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    instanceName String
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    ipWhiteLists List<String>
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    needRebalance Boolean
    是否开启再均衡。
    parameters String
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    partitionNumber Number
    分区数量。
    projectName String
    当前创建的 Kafka 实例所属的 IAM 项目。
    storageSpace Number
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    storageType String
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    tags List<Property Map>
    userName String
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    userPassword String
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。

    Outputs

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

    AccountId string
    创建实例的主账号 ID。
    ConnectionInfos List<Volcengine.InstanceConnectionInfo>
    CreatedTime string
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Kafka 实例的 ID。
    InstanceStatus string
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    PrivateDomainOnPublic bool
    是否开启公网解析。
    Topics List<string>
    一个 Kafka 实例下的 Topic 列表
    UsableGroupNumber int
    当前实例剩余可用消费组个数。
    UsablePartitionNumber int
    当前实例剩余可用分区数。
    UsedGroupNumber int
    当前实例已经创建的消费组(Group)个数。
    UsedPartitionNumber int
    当前实例已经使用的分区个数。
    UsedStorageSpace int
    实例已用储空间，单位为 GiB。
    UsedTopicNumber int
    当前实例已创建的 Topic 个数。
    AccountId string
    创建实例的主账号 ID。
    ConnectionInfos []InstanceConnectionInfo
    CreatedTime string
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Kafka 实例的 ID。
    InstanceStatus string
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    PrivateDomainOnPublic bool
    是否开启公网解析。
    Topics []string
    一个 Kafka 实例下的 Topic 列表
    UsableGroupNumber int
    当前实例剩余可用消费组个数。
    UsablePartitionNumber int
    当前实例剩余可用分区数。
    UsedGroupNumber int
    当前实例已经创建的消费组(Group)个数。
    UsedPartitionNumber int
    当前实例已经使用的分区个数。
    UsedStorageSpace int
    实例已用储空间，单位为 GiB。
    UsedTopicNumber int
    当前实例已创建的 Topic 个数。
    accountId String
    创建实例的主账号 ID。
    connectionInfos List<InstanceConnectionInfo>
    createdTime String
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Kafka 实例的 ID。
    instanceStatus String
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    privateDomainOnPublic Boolean
    是否开启公网解析。
    topics List<String>
    一个 Kafka 实例下的 Topic 列表
    usableGroupNumber Integer
    当前实例剩余可用消费组个数。
    usablePartitionNumber Integer
    当前实例剩余可用分区数。
    usedGroupNumber Integer
    当前实例已经创建的消费组(Group)个数。
    usedPartitionNumber Integer
    当前实例已经使用的分区个数。
    usedStorageSpace Integer
    实例已用储空间，单位为 GiB。
    usedTopicNumber Integer
    当前实例已创建的 Topic 个数。
    accountId string
    创建实例的主账号 ID。
    connectionInfos InstanceConnectionInfo[]
    createdTime string
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    Kafka 实例的 ID。
    instanceStatus string
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    privateDomainOnPublic boolean
    是否开启公网解析。
    topics string[]
    一个 Kafka 实例下的 Topic 列表
    usableGroupNumber number
    当前实例剩余可用消费组个数。
    usablePartitionNumber number
    当前实例剩余可用分区数。
    usedGroupNumber number
    当前实例已经创建的消费组(Group)个数。
    usedPartitionNumber number
    当前实例已经使用的分区个数。
    usedStorageSpace number
    实例已用储空间，单位为 GiB。
    usedTopicNumber number
    当前实例已创建的 Topic 个数。
    account_id str
    创建实例的主账号 ID。
    connection_infos Sequence[InstanceConnectionInfo]
    created_time str
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    Kafka 实例的 ID。
    instance_status str
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    private_domain_on_public bool
    是否开启公网解析。
    topics Sequence[str]
    一个 Kafka 实例下的 Topic 列表
    usable_group_number int
    当前实例剩余可用消费组个数。
    usable_partition_number int
    当前实例剩余可用分区数。
    used_group_number int
    当前实例已经创建的消费组(Group)个数。
    used_partition_number int
    当前实例已经使用的分区个数。
    used_storage_space int
    实例已用储空间，单位为 GiB。
    used_topic_number int
    当前实例已创建的 Topic 个数。
    accountId String
    创建实例的主账号 ID。
    connectionInfos List<Property Map>
    createdTime String
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Kafka 实例的 ID。
    instanceStatus String
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    privateDomainOnPublic Boolean
    是否开启公网解析。
    topics List<String>
    一个 Kafka 实例下的 Topic 列表
    usableGroupNumber Number
    当前实例剩余可用消费组个数。
    usablePartitionNumber Number
    当前实例剩余可用分区数。
    usedGroupNumber Number
    当前实例已经创建的消费组(Group)个数。
    usedPartitionNumber Number
    当前实例已经使用的分区个数。
    usedStorageSpace Number
    实例已用储空间，单位为 GiB。
    usedTopicNumber 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,
        account_id: Optional[str] = None,
        charge_info: Optional[InstanceChargeInfoArgs] = None,
        compute_spec: Optional[str] = None,
        connection_infos: Optional[Sequence[InstanceConnectionInfoArgs]] = None,
        created_time: Optional[str] = None,
        eip_id: Optional[str] = None,
        instance_description: Optional[str] = None,
        instance_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_status: Optional[str] = None,
        ip_white_lists: Optional[Sequence[str]] = None,
        need_rebalance: Optional[bool] = None,
        parameters: Optional[str] = None,
        partition_number: Optional[int] = None,
        private_domain_on_public: Optional[bool] = None,
        project_name: Optional[str] = None,
        storage_space: Optional[int] = None,
        storage_type: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Sequence[InstanceTagArgs]] = None,
        topics: Optional[Sequence[str]] = None,
        usable_group_number: Optional[int] = None,
        usable_partition_number: Optional[int] = None,
        used_group_number: Optional[int] = None,
        used_partition_number: Optional[int] = None,
        used_storage_space: Optional[int] = None,
        used_topic_number: Optional[int] = None,
        user_name: Optional[str] = None,
        user_password: Optional[str] = None,
        version: Optional[str] = None,
        vpc_id: Optional[str] = None,
        zone_id: Optional[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: volcenginecc:kafka: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:
    AccountId string
    创建实例的主账号 ID。
    ChargeInfo Volcengine.InstanceChargeInfo
    Kafka 实例的计费类型等计费信息。
    ComputeSpec string
    实例的计算规格。
    ConnectionInfos List<Volcengine.InstanceConnectionInfo>
    CreatedTime string
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    EipId string
    EIP 的 ID。
    InstanceDescription string
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    InstanceId string
    Kafka 实例的 ID。
    InstanceName string
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    InstanceStatus string
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    IpWhiteLists List<string>
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    NeedRebalance bool
    是否开启再均衡。
    Parameters string
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    PartitionNumber int
    分区数量。
    PrivateDomainOnPublic bool
    是否开启公网解析。
    ProjectName string
    当前创建的 Kafka 实例所属的 IAM 项目。
    StorageSpace int
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    StorageType string
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    SubnetId string
    实例所在的 VPC 子网 ID。
    Tags List<Volcengine.InstanceTag>
    Topics List<string>
    一个 Kafka 实例下的 Topic 列表
    UsableGroupNumber int
    当前实例剩余可用消费组个数。
    UsablePartitionNumber int
    当前实例剩余可用分区数。
    UsedGroupNumber int
    当前实例已经创建的消费组(Group)个数。
    UsedPartitionNumber int
    当前实例已经使用的分区个数。
    UsedStorageSpace int
    实例已用储空间，单位为 GiB。
    UsedTopicNumber int
    当前实例已创建的 Topic 个数。
    UserName string
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    UserPassword string
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。
    Version string
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    VpcId string
    实例所在的私有网络 (VPC) ID。
    ZoneId string
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。
    AccountId string
    创建实例的主账号 ID。
    ChargeInfo InstanceChargeInfoArgs
    Kafka 实例的计费类型等计费信息。
    ComputeSpec string
    实例的计算规格。
    ConnectionInfos []InstanceConnectionInfoArgs
    CreatedTime string
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    EipId string
    EIP 的 ID。
    InstanceDescription string
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    InstanceId string
    Kafka 实例的 ID。
    InstanceName string
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    InstanceStatus string
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    IpWhiteLists []string
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    NeedRebalance bool
    是否开启再均衡。
    Parameters string
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    PartitionNumber int
    分区数量。
    PrivateDomainOnPublic bool
    是否开启公网解析。
    ProjectName string
    当前创建的 Kafka 实例所属的 IAM 项目。
    StorageSpace int
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    StorageType string
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    SubnetId string
    实例所在的 VPC 子网 ID。
    Tags []InstanceTagArgs
    Topics []string
    一个 Kafka 实例下的 Topic 列表
    UsableGroupNumber int
    当前实例剩余可用消费组个数。
    UsablePartitionNumber int
    当前实例剩余可用分区数。
    UsedGroupNumber int
    当前实例已经创建的消费组(Group)个数。
    UsedPartitionNumber int
    当前实例已经使用的分区个数。
    UsedStorageSpace int
    实例已用储空间，单位为 GiB。
    UsedTopicNumber int
    当前实例已创建的 Topic 个数。
    UserName string
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    UserPassword string
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。
    Version string
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    VpcId string
    实例所在的私有网络 (VPC) ID。
    ZoneId string
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。
    accountId String
    创建实例的主账号 ID。
    chargeInfo InstanceChargeInfo
    Kafka 实例的计费类型等计费信息。
    computeSpec String
    实例的计算规格。
    connectionInfos List<InstanceConnectionInfo>
    createdTime String
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    eipId String
    EIP 的 ID。
    instanceDescription String
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    instanceId String
    Kafka 实例的 ID。
    instanceName String
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    instanceStatus String
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    ipWhiteLists List<String>
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    needRebalance Boolean
    是否开启再均衡。
    parameters String
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    partitionNumber Integer
    分区数量。
    privateDomainOnPublic Boolean
    是否开启公网解析。
    projectName String
    当前创建的 Kafka 实例所属的 IAM 项目。
    storageSpace Integer
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    storageType String
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    subnetId String
    实例所在的 VPC 子网 ID。
    tags List<InstanceTag>
    topics List<String>
    一个 Kafka 实例下的 Topic 列表
    usableGroupNumber Integer
    当前实例剩余可用消费组个数。
    usablePartitionNumber Integer
    当前实例剩余可用分区数。
    usedGroupNumber Integer
    当前实例已经创建的消费组(Group)个数。
    usedPartitionNumber Integer
    当前实例已经使用的分区个数。
    usedStorageSpace Integer
    实例已用储空间，单位为 GiB。
    usedTopicNumber Integer
    当前实例已创建的 Topic 个数。
    userName String
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    userPassword String
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。
    version String
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    vpcId String
    实例所在的私有网络 (VPC) ID。
    zoneId String
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。
    accountId string
    创建实例的主账号 ID。
    chargeInfo InstanceChargeInfo
    Kafka 实例的计费类型等计费信息。
    computeSpec string
    实例的计算规格。
    connectionInfos InstanceConnectionInfo[]
    createdTime string
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    eipId string
    EIP 的 ID。
    instanceDescription string
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    instanceId string
    Kafka 实例的 ID。
    instanceName string
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    instanceStatus string
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    ipWhiteLists string[]
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    needRebalance boolean
    是否开启再均衡。
    parameters string
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    partitionNumber number
    分区数量。
    privateDomainOnPublic boolean
    是否开启公网解析。
    projectName string
    当前创建的 Kafka 实例所属的 IAM 项目。
    storageSpace number
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    storageType string
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    subnetId string
    实例所在的 VPC 子网 ID。
    tags InstanceTag[]
    topics string[]
    一个 Kafka 实例下的 Topic 列表
    usableGroupNumber number
    当前实例剩余可用消费组个数。
    usablePartitionNumber number
    当前实例剩余可用分区数。
    usedGroupNumber number
    当前实例已经创建的消费组(Group)个数。
    usedPartitionNumber number
    当前实例已经使用的分区个数。
    usedStorageSpace number
    实例已用储空间，单位为 GiB。
    usedTopicNumber number
    当前实例已创建的 Topic 个数。
    userName string
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    userPassword string
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。
    version string
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    vpcId string
    实例所在的私有网络 (VPC) ID。
    zoneId string
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。
    account_id str
    创建实例的主账号 ID。
    charge_info InstanceChargeInfoArgs
    Kafka 实例的计费类型等计费信息。
    compute_spec str
    实例的计算规格。
    connection_infos Sequence[InstanceConnectionInfoArgs]
    created_time str
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    eip_id str
    EIP 的 ID。
    instance_description str
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    instance_id str
    Kafka 实例的 ID。
    instance_name str
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    instance_status str
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    ip_white_lists Sequence[str]
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    need_rebalance bool
    是否开启再均衡。
    parameters str
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    partition_number int
    分区数量。
    private_domain_on_public bool
    是否开启公网解析。
    project_name str
    当前创建的 Kafka 实例所属的 IAM 项目。
    storage_space int
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    storage_type str
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    subnet_id str
    实例所在的 VPC 子网 ID。
    tags Sequence[InstanceTagArgs]
    topics Sequence[str]
    一个 Kafka 实例下的 Topic 列表
    usable_group_number int
    当前实例剩余可用消费组个数。
    usable_partition_number int
    当前实例剩余可用分区数。
    used_group_number int
    当前实例已经创建的消费组(Group)个数。
    used_partition_number int
    当前实例已经使用的分区个数。
    used_storage_space int
    实例已用储空间，单位为 GiB。
    used_topic_number int
    当前实例已创建的 Topic 个数。
    user_name str
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    user_password str
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。
    version str
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    vpc_id str
    实例所在的私有网络 (VPC) ID。
    zone_id str
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。
    accountId String
    创建实例的主账号 ID。
    chargeInfo Property Map
    Kafka 实例的计费类型等计费信息。
    computeSpec String
    实例的计算规格。
    connectionInfos List<Property Map>
    createdTime String
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    eipId String
    EIP 的 ID。
    instanceDescription String
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    instanceId String
    Kafka 实例的 ID。
    instanceName String
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    instanceStatus String
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    ipWhiteLists List<String>
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    needRebalance Boolean
    是否开启再均衡。
    parameters String
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    partitionNumber Number
    分区数量。
    privateDomainOnPublic Boolean
    是否开启公网解析。
    projectName String
    当前创建的 Kafka 实例所属的 IAM 项目。
    storageSpace Number
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    storageType String
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    subnetId String
    实例所在的 VPC 子网 ID。
    tags List<Property Map>
    topics List<String>
    一个 Kafka 实例下的 Topic 列表
    usableGroupNumber Number
    当前实例剩余可用消费组个数。
    usablePartitionNumber Number
    当前实例剩余可用分区数。
    usedGroupNumber Number
    当前实例已经创建的消费组(Group)个数。
    usedPartitionNumber Number
    当前实例已经使用的分区个数。
    usedStorageSpace Number
    实例已用储空间，单位为 GiB。
    usedTopicNumber Number
    当前实例已创建的 Topic 个数。
    userName String
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    userPassword String
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。
    version String
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    vpcId String
    实例所在的私有网络 (VPC) ID。
    zoneId String
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。

    Supporting Types

    InstanceChargeInfo, InstanceChargeInfoArgs

    AutoRenew bool
    包年包月实例到期后是否自动续费，true-自动续费 false(默认)-不自动续费,到期实例关停。
    ChargeExpireTime string
    包年包月实例的到期时间。
    ChargeStartTime string
    实例的计费开始时间。
    ChargeStatus string
    实例的计费状态，支持的类型包括: Normal-正常, Overdue-按量计费欠费, Expired-包年包月到期
    ChargeType string
    实例的计费类型，支持的类型包括: PostPaid-按量付费, PrePaid-包年包月。
    OverdueReclaimTime string
    实例欠费关停后的预计释放时间。
    OverdueTime string
    实例的欠费关停时间。
    Period int
    包年包月类型实例的购买时长。
    PeriodUnit string
    包年包月类型实例的生命周期单位，即指定以月（Month/Monthly）或以年（Year/Yearly）为单位购买。
    AutoRenew bool
    包年包月实例到期后是否自动续费，true-自动续费 false(默认)-不自动续费,到期实例关停。
    ChargeExpireTime string
    包年包月实例的到期时间。
    ChargeStartTime string
    实例的计费开始时间。
    ChargeStatus string
    实例的计费状态，支持的类型包括: Normal-正常, Overdue-按量计费欠费, Expired-包年包月到期
    ChargeType string
    实例的计费类型，支持的类型包括: PostPaid-按量付费, PrePaid-包年包月。
    OverdueReclaimTime string
    实例欠费关停后的预计释放时间。
    OverdueTime string
    实例的欠费关停时间。
    Period int
    包年包月类型实例的购买时长。
    PeriodUnit string
    包年包月类型实例的生命周期单位，即指定以月（Month/Monthly）或以年（Year/Yearly）为单位购买。
    autoRenew Boolean
    包年包月实例到期后是否自动续费，true-自动续费 false(默认)-不自动续费,到期实例关停。
    chargeExpireTime String
    包年包月实例的到期时间。
    chargeStartTime String
    实例的计费开始时间。
    chargeStatus String
    实例的计费状态，支持的类型包括: Normal-正常, Overdue-按量计费欠费, Expired-包年包月到期
    chargeType String
    实例的计费类型，支持的类型包括: PostPaid-按量付费, PrePaid-包年包月。
    overdueReclaimTime String
    实例欠费关停后的预计释放时间。
    overdueTime String
    实例的欠费关停时间。
    period Integer
    包年包月类型实例的购买时长。
    periodUnit String
    包年包月类型实例的生命周期单位，即指定以月（Month/Monthly）或以年（Year/Yearly）为单位购买。
    autoRenew boolean
    包年包月实例到期后是否自动续费，true-自动续费 false(默认)-不自动续费,到期实例关停。
    chargeExpireTime string
    包年包月实例的到期时间。
    chargeStartTime string
    实例的计费开始时间。
    chargeStatus string
    实例的计费状态，支持的类型包括: Normal-正常, Overdue-按量计费欠费, Expired-包年包月到期
    chargeType string
    实例的计费类型，支持的类型包括: PostPaid-按量付费, PrePaid-包年包月。
    overdueReclaimTime string
    实例欠费关停后的预计释放时间。
    overdueTime string
    实例的欠费关停时间。
    period number
    包年包月类型实例的购买时长。
    periodUnit string
    包年包月类型实例的生命周期单位，即指定以月（Month/Monthly）或以年（Year/Yearly）为单位购买。
    auto_renew bool
    包年包月实例到期后是否自动续费，true-自动续费 false(默认)-不自动续费,到期实例关停。
    charge_expire_time str
    包年包月实例的到期时间。
    charge_start_time str
    实例的计费开始时间。
    charge_status str
    实例的计费状态，支持的类型包括: Normal-正常, Overdue-按量计费欠费, Expired-包年包月到期
    charge_type str
    实例的计费类型，支持的类型包括: PostPaid-按量付费, PrePaid-包年包月。
    overdue_reclaim_time str
    实例欠费关停后的预计释放时间。
    overdue_time str
    实例的欠费关停时间。
    period int
    包年包月类型实例的购买时长。
    period_unit str
    包年包月类型实例的生命周期单位，即指定以月（Month/Monthly）或以年（Year/Yearly）为单位购买。
    autoRenew Boolean
    包年包月实例到期后是否自动续费，true-自动续费 false(默认)-不自动续费,到期实例关停。
    chargeExpireTime String
    包年包月实例的到期时间。
    chargeStartTime String
    实例的计费开始时间。
    chargeStatus String
    实例的计费状态，支持的类型包括: Normal-正常, Overdue-按量计费欠费, Expired-包年包月到期
    chargeType String
    实例的计费类型，支持的类型包括: PostPaid-按量付费, PrePaid-包年包月。
    overdueReclaimTime String
    实例欠费关停后的预计释放时间。
    overdueTime String
    实例的欠费关停时间。
    period Number
    包年包月类型实例的购买时长。
    periodUnit String
    包年包月类型实例的生命周期单位，即指定以月（Month/Monthly）或以年（Year/Yearly）为单位购买。

    InstanceConnectionInfo, InstanceConnectionInfoArgs

    EndpointType string
    实例的接入点类型。PLAINTEXT：默认接入点。SASLPLAINTEXT：SASL接入点（私网）。SASLSSL：SASL接入点（公网）。未开启公网访问时，不提供此接入点。
    InternalEndpoint string
    实例私网访问域名。
    NetworkType string
    接入点的网络类型。统一为 PrivateNetwork。
    PublicEndpoint string
    实例公网访问域名。
    EndpointType string
    实例的接入点类型。PLAINTEXT：默认接入点。SASLPLAINTEXT：SASL接入点（私网）。SASLSSL：SASL接入点（公网）。未开启公网访问时，不提供此接入点。
    InternalEndpoint string
    实例私网访问域名。
    NetworkType string
    接入点的网络类型。统一为 PrivateNetwork。
    PublicEndpoint string
    实例公网访问域名。
    endpointType String
    实例的接入点类型。PLAINTEXT：默认接入点。SASLPLAINTEXT：SASL接入点（私网）。SASLSSL：SASL接入点（公网）。未开启公网访问时，不提供此接入点。
    internalEndpoint String
    实例私网访问域名。
    networkType String
    接入点的网络类型。统一为 PrivateNetwork。
    publicEndpoint String
    实例公网访问域名。
    endpointType string
    实例的接入点类型。PLAINTEXT：默认接入点。SASLPLAINTEXT：SASL接入点（私网）。SASLSSL：SASL接入点（公网）。未开启公网访问时，不提供此接入点。
    internalEndpoint string
    实例私网访问域名。
    networkType string
    接入点的网络类型。统一为 PrivateNetwork。
    publicEndpoint string
    实例公网访问域名。
    endpoint_type str
    实例的接入点类型。PLAINTEXT：默认接入点。SASLPLAINTEXT：SASL接入点（私网）。SASLSSL：SASL接入点（公网）。未开启公网访问时，不提供此接入点。
    internal_endpoint str
    实例私网访问域名。
    network_type str
    接入点的网络类型。统一为 PrivateNetwork。
    public_endpoint str
    实例公网访问域名。
    endpointType String
    实例的接入点类型。PLAINTEXT：默认接入点。SASLPLAINTEXT：SASL接入点（私网）。SASLSSL：SASL接入点（公网）。未开启公网访问时，不提供此接入点。
    internalEndpoint String
    实例私网访问域名。
    networkType String
    接入点的网络类型。统一为 PrivateNetwork。
    publicEndpoint String
    实例公网访问域名。

    InstanceTag, InstanceTagArgs

    Key string
    标签的键。
    Value string
    标签的值。
    Key string
    标签的键。
    Value string
    标签的值。
    key String
    标签的键。
    value String
    标签的值。
    key string
    标签的键。
    value string
    标签的值。
    key str
    标签的键。
    value str
    标签的值。
    key String
    标签的键。
    value String
    标签的值。

    Import

    $ pulumi import volcenginecc:kafka/instance:Instance example "instance_id"

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.28
    published on Thursday, Mar 26, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.