1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. kafka
  5. Instance
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
bytepluscc logo
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus

    Kafka Message Queue is a distributed messaging middleware service built on Apache Kafka. It features high throughput and scalability, provides stream data publishing/subscription and multi-replica storage mechanisms, and is widely used in log compression and collection, stream data processing, message decoupling, and traffic peak shaving scenarios.

    Example Usage

    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    resources:
      kafkaInstanceDemo:
        type: bytepluscc: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: bytepluscc: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 Bytepluscc.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 Bytepluscc.Kafka.Inputs.InstanceTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
        UserName = "string",
        UserPassword = "string",
        ChargeInfo = new Bytepluscc.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.byteplus.bytepluscc.kafka.Instance("exampleinstanceResourceResourceFromKafkainstance", com.byteplus.bytepluscc.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 = bytepluscc.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 bytepluscc.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: bytepluscc: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
    Instance compute specification.
    SubnetId string
    VPC subnet ID where the instance is located.
    Version string
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    VpcId string
    Private network (VPC) ID where the instance is located.
    ZoneId string
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.
    ChargeInfo Byteplus.InstanceChargeInfo
    Billing type and related billing information for the Kafka instance.
    EipId string
    EIP ID.
    InstanceDescription string
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    InstanceName string
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    IpWhiteLists List<string>
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    NeedRebalance bool
    Whether to enable rebalancing.
    Parameters string
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    PartitionNumber int
    Number of partitions.
    ProjectName string
    IAM project to which the currently created Kafka instance belongs.
    StorageSpace int
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    StorageType string
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    Tags List<Byteplus.InstanceTag>
    UserName string
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    UserPassword string
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=
    ComputeSpec string
    Instance compute specification.
    SubnetId string
    VPC subnet ID where the instance is located.
    Version string
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    VpcId string
    Private network (VPC) ID where the instance is located.
    ZoneId string
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.
    ChargeInfo InstanceChargeInfoArgs
    Billing type and related billing information for the Kafka instance.
    EipId string
    EIP ID.
    InstanceDescription string
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    InstanceName string
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    IpWhiteLists []string
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    NeedRebalance bool
    Whether to enable rebalancing.
    Parameters string
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    PartitionNumber int
    Number of partitions.
    ProjectName string
    IAM project to which the currently created Kafka instance belongs.
    StorageSpace int
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    StorageType string
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    Tags []InstanceTagArgs
    UserName string
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    UserPassword string
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=
    computeSpec String
    Instance compute specification.
    subnetId String
    VPC subnet ID where the instance is located.
    version String
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    vpcId String
    Private network (VPC) ID where the instance is located.
    zoneId String
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.
    chargeInfo InstanceChargeInfo
    Billing type and related billing information for the Kafka instance.
    eipId String
    EIP ID.
    instanceDescription String
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    instanceName String
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    ipWhiteLists List<String>
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    needRebalance Boolean
    Whether to enable rebalancing.
    parameters String
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    partitionNumber Integer
    Number of partitions.
    projectName String
    IAM project to which the currently created Kafka instance belongs.
    storageSpace Integer
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    storageType String
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    tags List<InstanceTag>
    userName String
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    userPassword String
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=
    computeSpec string
    Instance compute specification.
    subnetId string
    VPC subnet ID where the instance is located.
    version string
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    vpcId string
    Private network (VPC) ID where the instance is located.
    zoneId string
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.
    chargeInfo InstanceChargeInfo
    Billing type and related billing information for the Kafka instance.
    eipId string
    EIP ID.
    instanceDescription string
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    instanceName string
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    ipWhiteLists string[]
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    needRebalance boolean
    Whether to enable rebalancing.
    parameters string
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    partitionNumber number
    Number of partitions.
    projectName string
    IAM project to which the currently created Kafka instance belongs.
    storageSpace number
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    storageType string
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    tags InstanceTag[]
    userName string
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    userPassword string
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=
    compute_spec str
    Instance compute specification.
    subnet_id str
    VPC subnet ID where the instance is located.
    version str
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    vpc_id str
    Private network (VPC) ID where the instance is located.
    zone_id str
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.
    charge_info InstanceChargeInfoArgs
    Billing type and related billing information for the Kafka instance.
    eip_id str
    EIP ID.
    instance_description str
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    instance_name str
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    ip_white_lists Sequence[str]
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    need_rebalance bool
    Whether to enable rebalancing.
    parameters str
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    partition_number int
    Number of partitions.
    project_name str
    IAM project to which the currently created Kafka instance belongs.
    storage_space int
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    storage_type str
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    tags Sequence[InstanceTagArgs]
    user_name str
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    user_password str
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=
    computeSpec String
    Instance compute specification.
    subnetId String
    VPC subnet ID where the instance is located.
    version String
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    vpcId String
    Private network (VPC) ID where the instance is located.
    zoneId String
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.
    chargeInfo Property Map
    Billing type and related billing information for the Kafka instance.
    eipId String
    EIP ID.
    instanceDescription String
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    instanceName String
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    ipWhiteLists List<String>
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    needRebalance Boolean
    Whether to enable rebalancing.
    parameters String
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    partitionNumber Number
    Number of partitions.
    projectName String
    IAM project to which the currently created Kafka instance belongs.
    storageSpace Number
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    storageType String
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    tags List<Property Map>
    userName String
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    userPassword String
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=

    Outputs

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

    AccountId string
    Main account ID for creating the instance.
    ConnectionInfos List<Byteplus.InstanceConnectionInfo>
    CreatedTime string
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Kafka instance ID.
    InstanceStatus string
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    PrivateDomainOnPublic bool
    Whether to enable public network domain resolution.
    Topics List<string>
    List of topics under a Kafka instance
    UsableGroupNumber int
    The remaining number of available consumer groups for the current instance.
    UsablePartitionNumber int
    Number of available partitions remaining for the current instance.
    UsedGroupNumber int
    Number of consumer groups (Group) currently created in the instance.
    UsedPartitionNumber int
    Number of partitions currently used by the instance.
    UsedStorageSpace int
    Used storage space of the instance, measured in GiB.
    UsedTopicNumber int
    Number of topics created in the current instance.
    AccountId string
    Main account ID for creating the instance.
    ConnectionInfos []InstanceConnectionInfo
    CreatedTime string
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Kafka instance ID.
    InstanceStatus string
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    PrivateDomainOnPublic bool
    Whether to enable public network domain resolution.
    Topics []string
    List of topics under a Kafka instance
    UsableGroupNumber int
    The remaining number of available consumer groups for the current instance.
    UsablePartitionNumber int
    Number of available partitions remaining for the current instance.
    UsedGroupNumber int
    Number of consumer groups (Group) currently created in the instance.
    UsedPartitionNumber int
    Number of partitions currently used by the instance.
    UsedStorageSpace int
    Used storage space of the instance, measured in GiB.
    UsedTopicNumber int
    Number of topics created in the current instance.
    accountId String
    Main account ID for creating the instance.
    connectionInfos List<InstanceConnectionInfo>
    createdTime String
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Kafka instance ID.
    instanceStatus String
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    privateDomainOnPublic Boolean
    Whether to enable public network domain resolution.
    topics List<String>
    List of topics under a Kafka instance
    usableGroupNumber Integer
    The remaining number of available consumer groups for the current instance.
    usablePartitionNumber Integer
    Number of available partitions remaining for the current instance.
    usedGroupNumber Integer
    Number of consumer groups (Group) currently created in the instance.
    usedPartitionNumber Integer
    Number of partitions currently used by the instance.
    usedStorageSpace Integer
    Used storage space of the instance, measured in GiB.
    usedTopicNumber Integer
    Number of topics created in the current instance.
    accountId string
    Main account ID for creating the instance.
    connectionInfos InstanceConnectionInfo[]
    createdTime string
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    Kafka instance ID.
    instanceStatus string
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    privateDomainOnPublic boolean
    Whether to enable public network domain resolution.
    topics string[]
    List of topics under a Kafka instance
    usableGroupNumber number
    The remaining number of available consumer groups for the current instance.
    usablePartitionNumber number
    Number of available partitions remaining for the current instance.
    usedGroupNumber number
    Number of consumer groups (Group) currently created in the instance.
    usedPartitionNumber number
    Number of partitions currently used by the instance.
    usedStorageSpace number
    Used storage space of the instance, measured in GiB.
    usedTopicNumber number
    Number of topics created in the current instance.
    account_id str
    Main account ID for creating the instance.
    connection_infos Sequence[InstanceConnectionInfo]
    created_time str
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    Kafka instance ID.
    instance_status str
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    private_domain_on_public bool
    Whether to enable public network domain resolution.
    topics Sequence[str]
    List of topics under a Kafka instance
    usable_group_number int
    The remaining number of available consumer groups for the current instance.
    usable_partition_number int
    Number of available partitions remaining for the current instance.
    used_group_number int
    Number of consumer groups (Group) currently created in the instance.
    used_partition_number int
    Number of partitions currently used by the instance.
    used_storage_space int
    Used storage space of the instance, measured in GiB.
    used_topic_number int
    Number of topics created in the current instance.
    accountId String
    Main account ID for creating the instance.
    connectionInfos List<Property Map>
    createdTime String
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Kafka instance ID.
    instanceStatus String
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    privateDomainOnPublic Boolean
    Whether to enable public network domain resolution.
    topics List<String>
    List of topics under a Kafka instance
    usableGroupNumber Number
    The remaining number of available consumer groups for the current instance.
    usablePartitionNumber Number
    Number of available partitions remaining for the current instance.
    usedGroupNumber Number
    Number of consumer groups (Group) currently created in the instance.
    usedPartitionNumber Number
    Number of partitions currently used by the instance.
    usedStorageSpace Number
    Used storage space of the instance, measured in GiB.
    usedTopicNumber Number
    Number of topics created in the current instance.

    Look up Existing Instance Resource

    Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            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: bytepluscc: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
    Main account ID for creating the instance.
    ChargeInfo Byteplus.InstanceChargeInfo
    Billing type and related billing information for the Kafka instance.
    ComputeSpec string
    Instance compute specification.
    ConnectionInfos List<Byteplus.InstanceConnectionInfo>
    CreatedTime string
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    EipId string
    EIP ID.
    InstanceDescription string
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    InstanceId string
    Kafka instance ID.
    InstanceName string
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    InstanceStatus string
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    IpWhiteLists List<string>
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    NeedRebalance bool
    Whether to enable rebalancing.
    Parameters string
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    PartitionNumber int
    Number of partitions.
    PrivateDomainOnPublic bool
    Whether to enable public network domain resolution.
    ProjectName string
    IAM project to which the currently created Kafka instance belongs.
    StorageSpace int
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    StorageType string
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    SubnetId string
    VPC subnet ID where the instance is located.
    Tags List<Byteplus.InstanceTag>
    Topics List<string>
    List of topics under a Kafka instance
    UsableGroupNumber int
    The remaining number of available consumer groups for the current instance.
    UsablePartitionNumber int
    Number of available partitions remaining for the current instance.
    UsedGroupNumber int
    Number of consumer groups (Group) currently created in the instance.
    UsedPartitionNumber int
    Number of partitions currently used by the instance.
    UsedStorageSpace int
    Used storage space of the instance, measured in GiB.
    UsedTopicNumber int
    Number of topics created in the current instance.
    UserName string
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    UserPassword string
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=
    Version string
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    VpcId string
    Private network (VPC) ID where the instance is located.
    ZoneId string
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.
    AccountId string
    Main account ID for creating the instance.
    ChargeInfo InstanceChargeInfoArgs
    Billing type and related billing information for the Kafka instance.
    ComputeSpec string
    Instance compute specification.
    ConnectionInfos []InstanceConnectionInfoArgs
    CreatedTime string
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    EipId string
    EIP ID.
    InstanceDescription string
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    InstanceId string
    Kafka instance ID.
    InstanceName string
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    InstanceStatus string
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    IpWhiteLists []string
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    NeedRebalance bool
    Whether to enable rebalancing.
    Parameters string
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    PartitionNumber int
    Number of partitions.
    PrivateDomainOnPublic bool
    Whether to enable public network domain resolution.
    ProjectName string
    IAM project to which the currently created Kafka instance belongs.
    StorageSpace int
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    StorageType string
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    SubnetId string
    VPC subnet ID where the instance is located.
    Tags []InstanceTagArgs
    Topics []string
    List of topics under a Kafka instance
    UsableGroupNumber int
    The remaining number of available consumer groups for the current instance.
    UsablePartitionNumber int
    Number of available partitions remaining for the current instance.
    UsedGroupNumber int
    Number of consumer groups (Group) currently created in the instance.
    UsedPartitionNumber int
    Number of partitions currently used by the instance.
    UsedStorageSpace int
    Used storage space of the instance, measured in GiB.
    UsedTopicNumber int
    Number of topics created in the current instance.
    UserName string
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    UserPassword string
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=
    Version string
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    VpcId string
    Private network (VPC) ID where the instance is located.
    ZoneId string
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.
    accountId String
    Main account ID for creating the instance.
    chargeInfo InstanceChargeInfo
    Billing type and related billing information for the Kafka instance.
    computeSpec String
    Instance compute specification.
    connectionInfos List<InstanceConnectionInfo>
    createdTime String
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    eipId String
    EIP ID.
    instanceDescription String
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    instanceId String
    Kafka instance ID.
    instanceName String
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    instanceStatus String
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    ipWhiteLists List<String>
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    needRebalance Boolean
    Whether to enable rebalancing.
    parameters String
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    partitionNumber Integer
    Number of partitions.
    privateDomainOnPublic Boolean
    Whether to enable public network domain resolution.
    projectName String
    IAM project to which the currently created Kafka instance belongs.
    storageSpace Integer
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    storageType String
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    subnetId String
    VPC subnet ID where the instance is located.
    tags List<InstanceTag>
    topics List<String>
    List of topics under a Kafka instance
    usableGroupNumber Integer
    The remaining number of available consumer groups for the current instance.
    usablePartitionNumber Integer
    Number of available partitions remaining for the current instance.
    usedGroupNumber Integer
    Number of consumer groups (Group) currently created in the instance.
    usedPartitionNumber Integer
    Number of partitions currently used by the instance.
    usedStorageSpace Integer
    Used storage space of the instance, measured in GiB.
    usedTopicNumber Integer
    Number of topics created in the current instance.
    userName String
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    userPassword String
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=
    version String
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    vpcId String
    Private network (VPC) ID where the instance is located.
    zoneId String
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.
    accountId string
    Main account ID for creating the instance.
    chargeInfo InstanceChargeInfo
    Billing type and related billing information for the Kafka instance.
    computeSpec string
    Instance compute specification.
    connectionInfos InstanceConnectionInfo[]
    createdTime string
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    eipId string
    EIP ID.
    instanceDescription string
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    instanceId string
    Kafka instance ID.
    instanceName string
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    instanceStatus string
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    ipWhiteLists string[]
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    needRebalance boolean
    Whether to enable rebalancing.
    parameters string
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    partitionNumber number
    Number of partitions.
    privateDomainOnPublic boolean
    Whether to enable public network domain resolution.
    projectName string
    IAM project to which the currently created Kafka instance belongs.
    storageSpace number
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    storageType string
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    subnetId string
    VPC subnet ID where the instance is located.
    tags InstanceTag[]
    topics string[]
    List of topics under a Kafka instance
    usableGroupNumber number
    The remaining number of available consumer groups for the current instance.
    usablePartitionNumber number
    Number of available partitions remaining for the current instance.
    usedGroupNumber number
    Number of consumer groups (Group) currently created in the instance.
    usedPartitionNumber number
    Number of partitions currently used by the instance.
    usedStorageSpace number
    Used storage space of the instance, measured in GiB.
    usedTopicNumber number
    Number of topics created in the current instance.
    userName string
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    userPassword string
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=
    version string
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    vpcId string
    Private network (VPC) ID where the instance is located.
    zoneId string
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.
    account_id str
    Main account ID for creating the instance.
    charge_info InstanceChargeInfoArgs
    Billing type and related billing information for the Kafka instance.
    compute_spec str
    Instance compute specification.
    connection_infos Sequence[InstanceConnectionInfoArgs]
    created_time str
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    eip_id str
    EIP ID.
    instance_description str
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    instance_id str
    Kafka instance ID.
    instance_name str
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    instance_status str
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    ip_white_lists Sequence[str]
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    need_rebalance bool
    Whether to enable rebalancing.
    parameters str
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    partition_number int
    Number of partitions.
    private_domain_on_public bool
    Whether to enable public network domain resolution.
    project_name str
    IAM project to which the currently created Kafka instance belongs.
    storage_space int
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    storage_type str
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    subnet_id str
    VPC subnet ID where the instance is located.
    tags Sequence[InstanceTagArgs]
    topics Sequence[str]
    List of topics under a Kafka instance
    usable_group_number int
    The remaining number of available consumer groups for the current instance.
    usable_partition_number int
    Number of available partitions remaining for the current instance.
    used_group_number int
    Number of consumer groups (Group) currently created in the instance.
    used_partition_number int
    Number of partitions currently used by the instance.
    used_storage_space int
    Used storage space of the instance, measured in GiB.
    used_topic_number int
    Number of topics created in the current instance.
    user_name str
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    user_password str
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=
    version str
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    vpc_id str
    Private network (VPC) ID where the instance is located.
    zone_id str
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.
    accountId String
    Main account ID for creating the instance.
    chargeInfo Property Map
    Billing type and related billing information for the Kafka instance.
    computeSpec String
    Instance compute specification.
    connectionInfos List<Property Map>
    createdTime String
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    eipId String
    EIP ID.
    instanceDescription String
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    instanceId String
    Kafka instance ID.
    instanceName String
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    instanceStatus String
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    ipWhiteLists List<String>
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    needRebalance Boolean
    Whether to enable rebalancing.
    parameters String
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    partitionNumber Number
    Number of partitions.
    privateDomainOnPublic Boolean
    Whether to enable public network domain resolution.
    projectName String
    IAM project to which the currently created Kafka instance belongs.
    storageSpace Number
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    storageType String
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    subnetId String
    VPC subnet ID where the instance is located.
    tags List<Property Map>
    topics List<String>
    List of topics under a Kafka instance
    usableGroupNumber Number
    The remaining number of available consumer groups for the current instance.
    usablePartitionNumber Number
    Number of available partitions remaining for the current instance.
    usedGroupNumber Number
    Number of consumer groups (Group) currently created in the instance.
    usedPartitionNumber Number
    Number of partitions currently used by the instance.
    usedStorageSpace Number
    Used storage space of the instance, measured in GiB.
    usedTopicNumber Number
    Number of topics created in the current instance.
    userName String
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    userPassword String
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=
    version String
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    vpcId String
    Private network (VPC) ID where the instance is located.
    zoneId String
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.

    Supporting Types

    InstanceChargeInfo, InstanceChargeInfoArgs

    AutoRenew bool
    Whether to automatically renew the subscription instance after expiration. true - auto renewal; false (default) - no auto renewal, instance will be stopped upon expiration.
    ChargeExpireTime string
    Expiration time for the subscription instance.
    ChargeStartTime string
    Instance billing start time.
    ChargeStatus string
    Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired
    ChargeType string
    Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.
    OverdueReclaimTime string
    Estimated release time after the instance is stopped due to overdue payment.
    OverdueTime string
    Instance suspension time due to overdue payment.
    Period int
    Purchase duration for subscription-based instances.
    PeriodUnit string
    The lifecycle unit for subscription-based instances, specifying purchase by month (Month/Monthly) or by year (Year/Yearly).
    AutoRenew bool
    Whether to automatically renew the subscription instance after expiration. true - auto renewal; false (default) - no auto renewal, instance will be stopped upon expiration.
    ChargeExpireTime string
    Expiration time for the subscription instance.
    ChargeStartTime string
    Instance billing start time.
    ChargeStatus string
    Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired
    ChargeType string
    Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.
    OverdueReclaimTime string
    Estimated release time after the instance is stopped due to overdue payment.
    OverdueTime string
    Instance suspension time due to overdue payment.
    Period int
    Purchase duration for subscription-based instances.
    PeriodUnit string
    The lifecycle unit for subscription-based instances, specifying purchase by month (Month/Monthly) or by year (Year/Yearly).
    autoRenew Boolean
    Whether to automatically renew the subscription instance after expiration. true - auto renewal; false (default) - no auto renewal, instance will be stopped upon expiration.
    chargeExpireTime String
    Expiration time for the subscription instance.
    chargeStartTime String
    Instance billing start time.
    chargeStatus String
    Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired
    chargeType String
    Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.
    overdueReclaimTime String
    Estimated release time after the instance is stopped due to overdue payment.
    overdueTime String
    Instance suspension time due to overdue payment.
    period Integer
    Purchase duration for subscription-based instances.
    periodUnit String
    The lifecycle unit for subscription-based instances, specifying purchase by month (Month/Monthly) or by year (Year/Yearly).
    autoRenew boolean
    Whether to automatically renew the subscription instance after expiration. true - auto renewal; false (default) - no auto renewal, instance will be stopped upon expiration.
    chargeExpireTime string
    Expiration time for the subscription instance.
    chargeStartTime string
    Instance billing start time.
    chargeStatus string
    Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired
    chargeType string
    Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.
    overdueReclaimTime string
    Estimated release time after the instance is stopped due to overdue payment.
    overdueTime string
    Instance suspension time due to overdue payment.
    period number
    Purchase duration for subscription-based instances.
    periodUnit string
    The lifecycle unit for subscription-based instances, specifying purchase by month (Month/Monthly) or by year (Year/Yearly).
    auto_renew bool
    Whether to automatically renew the subscription instance after expiration. true - auto renewal; false (default) - no auto renewal, instance will be stopped upon expiration.
    charge_expire_time str
    Expiration time for the subscription instance.
    charge_start_time str
    Instance billing start time.
    charge_status str
    Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired
    charge_type str
    Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.
    overdue_reclaim_time str
    Estimated release time after the instance is stopped due to overdue payment.
    overdue_time str
    Instance suspension time due to overdue payment.
    period int
    Purchase duration for subscription-based instances.
    period_unit str
    The lifecycle unit for subscription-based instances, specifying purchase by month (Month/Monthly) or by year (Year/Yearly).
    autoRenew Boolean
    Whether to automatically renew the subscription instance after expiration. true - auto renewal; false (default) - no auto renewal, instance will be stopped upon expiration.
    chargeExpireTime String
    Expiration time for the subscription instance.
    chargeStartTime String
    Instance billing start time.
    chargeStatus String
    Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired
    chargeType String
    Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.
    overdueReclaimTime String
    Estimated release time after the instance is stopped due to overdue payment.
    overdueTime String
    Instance suspension time due to overdue payment.
    period Number
    Purchase duration for subscription-based instances.
    periodUnit String
    The lifecycle unit for subscription-based instances, specifying purchase by month (Month/Monthly) or by year (Year/Yearly).

    InstanceConnectionInfo, InstanceConnectionInfoArgs

    EndpointType string
    Instance endpoint type. PLAINTEXT: default endpoint. SASLPLAINTEXT: SASL endpoint (private network). SASLSSL: SASL endpoint (public network). If public access is not enabled, this endpoint is not provided.
    InternalEndpoint string
    Instance private network access domain name.
    NetworkType string
    Network type for the access point. Unified as PrivateNetwork.
    PublicEndpoint string
    Public access domain name for the instance.
    EndpointType string
    Instance endpoint type. PLAINTEXT: default endpoint. SASLPLAINTEXT: SASL endpoint (private network). SASLSSL: SASL endpoint (public network). If public access is not enabled, this endpoint is not provided.
    InternalEndpoint string
    Instance private network access domain name.
    NetworkType string
    Network type for the access point. Unified as PrivateNetwork.
    PublicEndpoint string
    Public access domain name for the instance.
    endpointType String
    Instance endpoint type. PLAINTEXT: default endpoint. SASLPLAINTEXT: SASL endpoint (private network). SASLSSL: SASL endpoint (public network). If public access is not enabled, this endpoint is not provided.
    internalEndpoint String
    Instance private network access domain name.
    networkType String
    Network type for the access point. Unified as PrivateNetwork.
    publicEndpoint String
    Public access domain name for the instance.
    endpointType string
    Instance endpoint type. PLAINTEXT: default endpoint. SASLPLAINTEXT: SASL endpoint (private network). SASLSSL: SASL endpoint (public network). If public access is not enabled, this endpoint is not provided.
    internalEndpoint string
    Instance private network access domain name.
    networkType string
    Network type for the access point. Unified as PrivateNetwork.
    publicEndpoint string
    Public access domain name for the instance.
    endpoint_type str
    Instance endpoint type. PLAINTEXT: default endpoint. SASLPLAINTEXT: SASL endpoint (private network). SASLSSL: SASL endpoint (public network). If public access is not enabled, this endpoint is not provided.
    internal_endpoint str
    Instance private network access domain name.
    network_type str
    Network type for the access point. Unified as PrivateNetwork.
    public_endpoint str
    Public access domain name for the instance.
    endpointType String
    Instance endpoint type. PLAINTEXT: default endpoint. SASLPLAINTEXT: SASL endpoint (private network). SASLSSL: SASL endpoint (public network). If public access is not enabled, this endpoint is not provided.
    internalEndpoint String
    Instance private network access domain name.
    networkType String
    Network type for the access point. Unified as PrivateNetwork.
    publicEndpoint String
    Public access domain name for the instance.

    InstanceTag, InstanceTagArgs

    Key string
    Tag key.
    Value string
    Tag value.
    Key string
    Tag key.
    Value string
    Tag value.
    key String
    Tag key.
    value String
    Tag value.
    key string
    Tag key.
    value string
    Tag value.
    key str
    Tag key.
    value str
    Tag value.
    key String
    Tag key.
    value String
    Tag value.

    Import

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

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

    Package Details

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