Instance

The initial configurations of the ApsaraMQ for Kafka instance. The values must be valid JSON strings. The config supports the following parameters:

The number of partitions in a topic that is automatically created.

The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

The disk size of the instance. When modify this value, it only supports adjust to a greater value.

The disk type of the instance. 0: efficient cloud disk , 1: SSD.

(Available since v1.234.0) The default endpoint of the instance in domain name mode.

The max bandwidth of the instance. It will be ignored when deploy_type = 5. When modify this value, it only supports adjust to a greater value.

Specify whether to enable the flexible group creation feature. Default value: false. Valid values:

Specify whether to enable the automatic topic creation feature. Default value: disable. Valid values:

The EndPoint to access the kafka instance.

(Available since v1.214.1) The number of available groups.

(Available since v1.214.1) The number of used groups.

The max value of io of the instance. When modify this value, it only support adjust to a greater value.

The traffic specification of the instance. We recommend that you configure this parameter.

(Available since v1.214.1) The method that you use to purchase partitions.

The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.

Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.

The paid type of the instance. Support two type, "PrePaid": pre paid type instance, "PostPaid": post paid type instance. Default is PostPaid. When modify this value, it only support adjust from post pay to pre pay.

(Available since v1.214.1) The number of available partitions.

The number of partitions.

(Available since v1.214.1) The number of used partitions.

The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.

(Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.

The ID of security group for this instance. If the security group is empty, system will create a default one.

The zones among which you want to deploy the instance.

The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.

The spec type of the instance. Support two type, "normal": normal version instance, "professional": professional version instance. Default is normal. When modify this value, it only support adjust from normal to professional. Note only pre paid type instance support professional specific type.

(Available since v1.234.0) The SSL endpoint of the instance in domain name mode.

(Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.

The status of the instance.

A mapping of tags to assign to the resource.

(Available since v1.214.1) The number of available topics.

(Available since v1.214.1) The number of purchased topics.

The max num of topic can be creation of the instance. It has been deprecated since version 1.194.0 and using partition_num instead. Currently, its value only can be set to 50 when creating it, and finally depends on partition_num value: <topic_quota> = 1000 + <partition_num>. Therefore, you can update it by updating the partition_num, and it is the only updating path.

(Available since v1.214.1) The number of used topics.

The VPC ID of the instance.

The ID of attaching vswitch to instance.

The IDs of the vSwitches with which the instance is associated.

The zone ID of the instance. The value can be in zone x or region id-x format. NOTE: When the available zone is insufficient, another availability zone may be deployed.