published on Thursday, Apr 2, 2026 by Byteplus
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:
- Compute
Spec string - Instance compute specification.
- Subnet
Id 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.
- Vpc
Id string - Private network (VPC) ID where the instance is located.
- Zone
Id 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.
- Charge
Info Byteplus.Instance Charge Info - Billing type and related billing information for the Kafka instance.
- Eip
Id string - EIP ID.
- Instance
Description string - Brief description of the Kafka instance. Length must be between 1 and 128 characters.
- Instance
Name 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.
- Ip
White List<string>Lists - 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 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.
- Partition
Number int - Number of partitions.
- Project
Name string - 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 string - Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
-
List<Byteplus.
Instance Tag> - User
Name 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.
- User
Password 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 string - Instance compute specification.
- Subnet
Id 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.
- Vpc
Id string - Private network (VPC) ID where the instance is located.
- Zone
Id 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.
- Charge
Info InstanceCharge Info Args - Billing type and related billing information for the Kafka instance.
- Eip
Id string - EIP ID.
- Instance
Description string - Brief description of the Kafka instance. Length must be between 1 and 128 characters.
- Instance
Name 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.
- Ip
White []stringLists - 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 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.
- Partition
Number int - Number of partitions.
- Project
Name string - 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 string - Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
-
[]Instance
Tag Args - User
Name 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.
- User
Password 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 String - Instance compute specification.
- subnet
Id 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.
- vpc
Id String - Private network (VPC) ID where the instance is located.
- zone
Id 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.
- charge
Info InstanceCharge Info - Billing type and related billing information for the Kafka instance.
- eip
Id String - EIP ID.
- instance
Description String - Brief description of the Kafka instance. Length must be between 1 and 128 characters.
- instance
Name 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.
- ip
White List<String>Lists - 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 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.
- partition
Number Integer - Number of partitions.
- project
Name String - IAM project to which the currently created Kafka instance belongs.
- storage
Space Integer - Instance storage space, measured in GiB, must be specified as a multiple of 100.
- storage
Type String - Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
-
List<Instance
Tag> - user
Name 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.
- user
Password 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 string - Instance compute specification.
- subnet
Id 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.
- vpc
Id string - Private network (VPC) ID where the instance is located.
- zone
Id 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.
- charge
Info InstanceCharge Info - Billing type and related billing information for the Kafka instance.
- eip
Id string - EIP ID.
- instance
Description string - Brief description of the Kafka instance. Length must be between 1 and 128 characters.
- instance
Name 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.
- ip
White string[]Lists - 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 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.
- partition
Number number - Number of partitions.
- project
Name string - IAM project to which the currently created Kafka instance belongs.
- storage
Space number - Instance storage space, measured in GiB, must be specified as a multiple of 100.
- storage
Type string - Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
-
Instance
Tag[] - user
Name 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.
- user
Password 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 InstanceCharge Info Args - 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_ Sequence[str]lists - 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.
-
Sequence[Instance
Tag Args] - 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: !@#$%^&*()_+-=
- compute
Spec String - Instance compute specification.
- subnet
Id 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.
- vpc
Id String - Private network (VPC) ID where the instance is located.
- zone
Id 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.
- charge
Info Property Map - Billing type and related billing information for the Kafka instance.
- eip
Id String - EIP ID.
- instance
Description String - Brief description of the Kafka instance. Length must be between 1 and 128 characters.
- instance
Name 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.
- ip
White List<String>Lists - 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 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.
- partition
Number Number - Number of partitions.
- project
Name String - IAM project to which the currently created Kafka instance belongs.
- storage
Space Number - Instance storage space, measured in GiB, must be specified as a multiple of 100.
- storage
Type String - Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
- List<Property Map>
- user
Name 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.
- user
Password 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:
- Account
Id string - Main account ID for creating the instance.
- Connection
Infos List<Byteplus.Instance Connection Info> - Created
Time 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.
- Instance
Id string - Kafka instance ID.
- Instance
Status 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
- Private
Domain boolOn Public - Whether to enable public network domain resolution.
- Topics List<string>
- List of topics under a Kafka instance
- Usable
Group intNumber - The remaining number of available consumer groups for the current instance.
- Usable
Partition intNumber - Number of available partitions remaining for the current instance.
- Used
Group intNumber - Number of consumer groups (Group) currently created in the instance.
- Used
Partition intNumber - Number of partitions currently used by the instance.
- Used
Storage intSpace - Used storage space of the instance, measured in GiB.
- Used
Topic intNumber - Number of topics created in the current instance.
- Account
Id string - Main account ID for creating the instance.
- Connection
Infos []InstanceConnection Info - Created
Time 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.
- Instance
Id string - Kafka instance ID.
- Instance
Status 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
- Private
Domain boolOn Public - Whether to enable public network domain resolution.
- Topics []string
- List of topics under a Kafka instance
- Usable
Group intNumber - The remaining number of available consumer groups for the current instance.
- Usable
Partition intNumber - Number of available partitions remaining for the current instance.
- Used
Group intNumber - Number of consumer groups (Group) currently created in the instance.
- Used
Partition intNumber - Number of partitions currently used by the instance.
- Used
Storage intSpace - Used storage space of the instance, measured in GiB.
- Used
Topic intNumber - Number of topics created in the current instance.
- account
Id String - Main account ID for creating the instance.
- connection
Infos List<InstanceConnection Info> - created
Time 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.
- instance
Id String - Kafka instance ID.
- instance
Status 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
- private
Domain BooleanOn Public - Whether to enable public network domain resolution.
- topics List<String>
- List of topics under a Kafka instance
- usable
Group IntegerNumber - The remaining number of available consumer groups for the current instance.
- usable
Partition IntegerNumber - Number of available partitions remaining for the current instance.
- used
Group IntegerNumber - Number of consumer groups (Group) currently created in the instance.
- used
Partition IntegerNumber - Number of partitions currently used by the instance.
- used
Storage IntegerSpace - Used storage space of the instance, measured in GiB.
- used
Topic IntegerNumber - Number of topics created in the current instance.
- account
Id string - Main account ID for creating the instance.
- connection
Infos InstanceConnection Info[] - created
Time 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.
- instance
Id string - Kafka instance ID.
- instance
Status 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
- private
Domain booleanOn Public - Whether to enable public network domain resolution.
- topics string[]
- List of topics under a Kafka instance
- usable
Group numberNumber - The remaining number of available consumer groups for the current instance.
- usable
Partition numberNumber - Number of available partitions remaining for the current instance.
- used
Group numberNumber - Number of consumer groups (Group) currently created in the instance.
- used
Partition numberNumber - Number of partitions currently used by the instance.
- used
Storage numberSpace - Used storage space of the instance, measured in GiB.
- used
Topic numberNumber - Number of topics created in the current instance.
- account_
id str - Main account ID for creating the instance.
- connection_
infos Sequence[InstanceConnection Info] - 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_ boolon_ public - Whether to enable public network domain resolution.
- topics Sequence[str]
- List of topics under a Kafka instance
- usable_
group_ intnumber - The remaining number of available consumer groups for the current instance.
- usable_
partition_ intnumber - Number of available partitions remaining for the current instance.
- used_
group_ intnumber - Number of consumer groups (Group) currently created in the instance.
- used_
partition_ intnumber - Number of partitions currently used by the instance.
- used_
storage_ intspace - Used storage space of the instance, measured in GiB.
- used_
topic_ intnumber - Number of topics created in the current instance.
- account
Id String - Main account ID for creating the instance.
- connection
Infos List<Property Map> - created
Time 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.
- instance
Id String - Kafka instance ID.
- instance
Status 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
- private
Domain BooleanOn Public - Whether to enable public network domain resolution.
- topics List<String>
- List of topics under a Kafka instance
- usable
Group NumberNumber - The remaining number of available consumer groups for the current instance.
- usable
Partition NumberNumber - Number of available partitions remaining for the current instance.
- used
Group NumberNumber - Number of consumer groups (Group) currently created in the instance.
- used
Partition NumberNumber - Number of partitions currently used by the instance.
- used
Storage NumberSpace - Used storage space of the instance, measured in GiB.
- used
Topic NumberNumber - 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) -> Instancefunc GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)resources: _: type: 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.
- Account
Id string - Main account ID for creating the instance.
- Charge
Info Byteplus.Instance Charge Info - Billing type and related billing information for the Kafka instance.
- Compute
Spec string - Instance compute specification.
- Connection
Infos List<Byteplus.Instance Connection Info> - Created
Time string - Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
- Eip
Id string - EIP ID.
- Instance
Description string - Brief description of the Kafka instance. Length must be between 1 and 128 characters.
- Instance
Id string - Kafka instance ID.
- Instance
Name 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.
- Instance
Status 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
- Ip
White List<string>Lists - 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 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.
- Partition
Number int - Number of partitions.
- Private
Domain boolOn Public - Whether to enable public network domain resolution.
- Project
Name string - 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 string - Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
- Subnet
Id string - VPC subnet ID where the instance is located.
-
List<Byteplus.
Instance Tag> - Topics List<string>
- List of topics under a Kafka instance
- Usable
Group intNumber - The remaining number of available consumer groups for the current instance.
- Usable
Partition intNumber - Number of available partitions remaining for the current instance.
- Used
Group intNumber - Number of consumer groups (Group) currently created in the instance.
- Used
Partition intNumber - Number of partitions currently used by the instance.
- Used
Storage intSpace - Used storage space of the instance, measured in GiB.
- Used
Topic intNumber - Number of topics created in the current instance.
- User
Name 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.
- User
Password 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.
- Vpc
Id string - Private network (VPC) ID where the instance is located.
- Zone
Id 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 string - Main account ID for creating the instance.
- Charge
Info InstanceCharge Info Args - Billing type and related billing information for the Kafka instance.
- Compute
Spec string - Instance compute specification.
- Connection
Infos []InstanceConnection Info Args - Created
Time string - Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
- Eip
Id string - EIP ID.
- Instance
Description string - Brief description of the Kafka instance. Length must be between 1 and 128 characters.
- Instance
Id string - Kafka instance ID.
- Instance
Name 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.
- Instance
Status 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
- Ip
White []stringLists - 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 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.
- Partition
Number int - Number of partitions.
- Private
Domain boolOn Public - Whether to enable public network domain resolution.
- Project
Name string - 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 string - Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
- Subnet
Id string - VPC subnet ID where the instance is located.
-
[]Instance
Tag Args - Topics []string
- List of topics under a Kafka instance
- Usable
Group intNumber - The remaining number of available consumer groups for the current instance.
- Usable
Partition intNumber - Number of available partitions remaining for the current instance.
- Used
Group intNumber - Number of consumer groups (Group) currently created in the instance.
- Used
Partition intNumber - Number of partitions currently used by the instance.
- Used
Storage intSpace - Used storage space of the instance, measured in GiB.
- Used
Topic intNumber - Number of topics created in the current instance.
- User
Name 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.
- User
Password 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.
- Vpc
Id string - Private network (VPC) ID where the instance is located.
- Zone
Id 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 String - Main account ID for creating the instance.
- charge
Info InstanceCharge Info - Billing type and related billing information for the Kafka instance.
- compute
Spec String - Instance compute specification.
- connection
Infos List<InstanceConnection Info> - created
Time String - Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
- eip
Id String - EIP ID.
- instance
Description String - Brief description of the Kafka instance. Length must be between 1 and 128 characters.
- instance
Id String - Kafka instance ID.
- instance
Name 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.
- instance
Status 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
- ip
White List<String>Lists - 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 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.
- partition
Number Integer - Number of partitions.
- private
Domain BooleanOn Public - Whether to enable public network domain resolution.
- project
Name String - IAM project to which the currently created Kafka instance belongs.
- storage
Space Integer - Instance storage space, measured in GiB, must be specified as a multiple of 100.
- storage
Type String - Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
- subnet
Id String - VPC subnet ID where the instance is located.
-
List<Instance
Tag> - topics List<String>
- List of topics under a Kafka instance
- usable
Group IntegerNumber - The remaining number of available consumer groups for the current instance.
- usable
Partition IntegerNumber - Number of available partitions remaining for the current instance.
- used
Group IntegerNumber - Number of consumer groups (Group) currently created in the instance.
- used
Partition IntegerNumber - Number of partitions currently used by the instance.
- used
Storage IntegerSpace - Used storage space of the instance, measured in GiB.
- used
Topic IntegerNumber - Number of topics created in the current instance.
- user
Name 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.
- user
Password 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.
- vpc
Id String - Private network (VPC) ID where the instance is located.
- zone
Id 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 string - Main account ID for creating the instance.
- charge
Info InstanceCharge Info - Billing type and related billing information for the Kafka instance.
- compute
Spec string - Instance compute specification.
- connection
Infos InstanceConnection Info[] - created
Time string - Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
- eip
Id string - EIP ID.
- instance
Description string - Brief description of the Kafka instance. Length must be between 1 and 128 characters.
- instance
Id string - Kafka instance ID.
- instance
Name 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.
- instance
Status 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
- ip
White string[]Lists - 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 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.
- partition
Number number - Number of partitions.
- private
Domain booleanOn Public - Whether to enable public network domain resolution.
- project
Name string - IAM project to which the currently created Kafka instance belongs.
- storage
Space number - Instance storage space, measured in GiB, must be specified as a multiple of 100.
- storage
Type string - Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
- subnet
Id string - VPC subnet ID where the instance is located.
-
Instance
Tag[] - topics string[]
- List of topics under a Kafka instance
- usable
Group numberNumber - The remaining number of available consumer groups for the current instance.
- usable
Partition numberNumber - Number of available partitions remaining for the current instance.
- used
Group numberNumber - Number of consumer groups (Group) currently created in the instance.
- used
Partition numberNumber - Number of partitions currently used by the instance.
- used
Storage numberSpace - Used storage space of the instance, measured in GiB.
- used
Topic numberNumber - Number of topics created in the current instance.
- user
Name 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.
- user
Password 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.
- vpc
Id string - Private network (VPC) ID where the instance is located.
- zone
Id 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 InstanceCharge Info Args - Billing type and related billing information for the Kafka instance.
- compute_
spec str - Instance compute specification.
- connection_
infos Sequence[InstanceConnection Info Args] - 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_ Sequence[str]lists - 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_ boolon_ public - 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.
-
Sequence[Instance
Tag Args] - topics Sequence[str]
- List of topics under a Kafka instance
- usable_
group_ intnumber - The remaining number of available consumer groups for the current instance.
- usable_
partition_ intnumber - Number of available partitions remaining for the current instance.
- used_
group_ intnumber - Number of consumer groups (Group) currently created in the instance.
- used_
partition_ intnumber - Number of partitions currently used by the instance.
- used_
storage_ intspace - Used storage space of the instance, measured in GiB.
- used_
topic_ intnumber - 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.
- account
Id String - Main account ID for creating the instance.
- charge
Info Property Map - Billing type and related billing information for the Kafka instance.
- compute
Spec String - Instance compute specification.
- connection
Infos List<Property Map> - created
Time String - Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
- eip
Id String - EIP ID.
- instance
Description String - Brief description of the Kafka instance. Length must be between 1 and 128 characters.
- instance
Id String - Kafka instance ID.
- instance
Name 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.
- instance
Status 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
- ip
White List<String>Lists - 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 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.
- partition
Number Number - Number of partitions.
- private
Domain BooleanOn Public - Whether to enable public network domain resolution.
- project
Name String - IAM project to which the currently created Kafka instance belongs.
- storage
Space Number - Instance storage space, measured in GiB, must be specified as a multiple of 100.
- storage
Type String - Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
- subnet
Id String - VPC subnet ID where the instance is located.
- List<Property Map>
- topics List<String>
- List of topics under a Kafka instance
- usable
Group NumberNumber - The remaining number of available consumer groups for the current instance.
- usable
Partition NumberNumber - Number of available partitions remaining for the current instance.
- used
Group NumberNumber - Number of consumer groups (Group) currently created in the instance.
- used
Partition NumberNumber - Number of partitions currently used by the instance.
- used
Storage NumberSpace - Used storage space of the instance, measured in GiB.
- used
Topic NumberNumber - Number of topics created in the current instance.
- user
Name 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.
- user
Password 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.
- vpc
Id String - Private network (VPC) ID where the instance is located.
- zone
Id 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
- 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 stringTime - Expiration time for the subscription instance.
- Charge
Start stringTime - Instance billing start time.
- Charge
Status string - Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired
- Charge
Type string - Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.
- Overdue
Reclaim stringTime - Estimated release time after the instance is stopped due to overdue payment.
- Overdue
Time string - Instance suspension time due to overdue payment.
- Period int
- Purchase duration for subscription-based instances.
- Period
Unit 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 stringTime - Expiration time for the subscription instance.
- Charge
Start stringTime - Instance billing start time.
- Charge
Status string - Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired
- Charge
Type string - Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.
- Overdue
Reclaim stringTime - Estimated release time after the instance is stopped due to overdue payment.
- Overdue
Time string - Instance suspension time due to overdue payment.
- Period int
- Purchase duration for subscription-based instances.
- Period
Unit string - The lifecycle unit for subscription-based instances, specifying purchase by month (Month/Monthly) or by year (Year/Yearly).
- auto
Renew Boolean - 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 StringTime - Expiration time for the subscription instance.
- charge
Start StringTime - Instance billing start time.
- charge
Status String - Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired
- charge
Type String - Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.
- overdue
Reclaim StringTime - Estimated release time after the instance is stopped due to overdue payment.
- overdue
Time String - Instance suspension time due to overdue payment.
- period Integer
- Purchase duration for subscription-based instances.
- period
Unit String - The lifecycle unit for subscription-based instances, specifying purchase by month (Month/Monthly) or by year (Year/Yearly).
- auto
Renew boolean - 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 stringTime - Expiration time for the subscription instance.
- charge
Start stringTime - Instance billing start time.
- charge
Status string - Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired
- charge
Type string - Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.
- overdue
Reclaim stringTime - Estimated release time after the instance is stopped due to overdue payment.
- overdue
Time string - Instance suspension time due to overdue payment.
- period number
- Purchase duration for subscription-based instances.
- period
Unit 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_ strtime - Expiration time for the subscription instance.
- charge_
start_ strtime - 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_ strtime - 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).
- auto
Renew Boolean - 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 StringTime - Expiration time for the subscription instance.
- charge
Start StringTime - Instance billing start time.
- charge
Status String - Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired
- charge
Type String - Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.
- overdue
Reclaim StringTime - Estimated release time after the instance is stopped due to overdue payment.
- overdue
Time String - Instance suspension time due to overdue payment.
- period Number
- Purchase duration for subscription-based instances.
- period
Unit String - The lifecycle unit for subscription-based instances, specifying purchase by month (Month/Monthly) or by year (Year/Yearly).
InstanceConnectionInfo, InstanceConnectionInfoArgs
- Endpoint
Type 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.
- Internal
Endpoint string - Instance private network access domain name.
- Network
Type string - Network type for the access point. Unified as PrivateNetwork.
- Public
Endpoint string - Public access domain name for the instance.
- Endpoint
Type 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.
- Internal
Endpoint string - Instance private network access domain name.
- Network
Type string - Network type for the access point. Unified as PrivateNetwork.
- Public
Endpoint string - Public access domain name for the instance.
- endpoint
Type 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.
- internal
Endpoint String - Instance private network access domain name.
- network
Type String - Network type for the access point. Unified as PrivateNetwork.
- public
Endpoint String - Public access domain name for the instance.
- endpoint
Type 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.
- internal
Endpoint string - Instance private network access domain name.
- network
Type string - Network type for the access point. Unified as PrivateNetwork.
- public
Endpoint 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.
- endpoint
Type 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.
- internal
Endpoint String - Instance private network access domain name.
- network
Type String - Network type for the access point. Unified as PrivateNetwork.
- public
Endpoint String - Public access domain name for the instance.
InstanceTag, InstanceTagArgs
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
byteplusccTerraform Provider.
published on Thursday, Apr 2, 2026 by Byteplus
