Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. alikafka
  5. Instance
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.alikafka.Instance

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

Import

AliKafka instance can be imported using the id, e.g.

$ pulumi import alicloud:alikafka/instance:Instance instance <id>
Copy

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,
             disk_type: Optional[int] = None,
             vswitch_id: Optional[str] = None,
             deploy_type: Optional[int] = None,
             disk_size: Optional[int] = None,
             paid_type: Optional[str] = None,
             security_group: Optional[str] = None,
             enable_auto_group: Optional[bool] = None,
             enable_auto_topic: Optional[str] = None,
             io_max: Optional[int] = None,
             io_max_spec: Optional[str] = None,
             kms_key_id: Optional[str] = None,
             name: Optional[str] = None,
             config: Optional[str] = None,
             partition_num: Optional[int] = None,
             resource_group_id: Optional[str] = None,
             eip_max: Optional[int] = None,
             selected_zones: Optional[Sequence[str]] = None,
             service_version: Optional[str] = None,
             spec_type: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None,
             topic_quota: Optional[int] = None,
             vpc_id: Optional[str] = None,
             default_topic_partition_num: Optional[int] = None,
             vswitch_ids: Optional[Sequence[str]] = None,
             zone_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: alicloud:alikafka:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. InstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. InstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. InstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. InstanceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var instanceResource = new AliCloud.AliKafka.Instance("instanceResource", new()
{
    DiskType = 0,
    VswitchId = "string",
    DeployType = 0,
    DiskSize = 0,
    PaidType = "string",
    SecurityGroup = "string",
    EnableAutoGroup = false,
    EnableAutoTopic = "string",
    IoMax = 0,
    IoMaxSpec = "string",
    KmsKeyId = "string",
    Name = "string",
    Config = "string",
    PartitionNum = 0,
    ResourceGroupId = "string",
    EipMax = 0,
    SelectedZones = new[]
    {
        "string",
    },
    ServiceVersion = "string",
    SpecType = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VpcId = "string",
    DefaultTopicPartitionNum = 0,
    VswitchIds = new[]
    {
        "string",
    },
    ZoneId = "string",
});
Copy
example, err := alikafka.NewInstance(ctx, "instanceResource", &alikafka.InstanceArgs{
	DiskType:        pulumi.Int(0),
	VswitchId:       pulumi.String("string"),
	DeployType:      pulumi.Int(0),
	DiskSize:        pulumi.Int(0),
	PaidType:        pulumi.String("string"),
	SecurityGroup:   pulumi.String("string"),
	EnableAutoGroup: pulumi.Bool(false),
	EnableAutoTopic: pulumi.String("string"),
	IoMax:           pulumi.Int(0),
	IoMaxSpec:       pulumi.String("string"),
	KmsKeyId:        pulumi.String("string"),
	Name:            pulumi.String("string"),
	Config:          pulumi.String("string"),
	PartitionNum:    pulumi.Int(0),
	ResourceGroupId: pulumi.String("string"),
	EipMax:          pulumi.Int(0),
	SelectedZones: pulumi.StringArray{
		pulumi.String("string"),
	},
	ServiceVersion: pulumi.String("string"),
	SpecType:       pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VpcId:                    pulumi.String("string"),
	DefaultTopicPartitionNum: pulumi.Int(0),
	VswitchIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	ZoneId: pulumi.String("string"),
})
Copy
var instanceResource = new Instance("instanceResource", InstanceArgs.builder()
    .diskType(0)
    .vswitchId("string")
    .deployType(0)
    .diskSize(0)
    .paidType("string")
    .securityGroup("string")
    .enableAutoGroup(false)
    .enableAutoTopic("string")
    .ioMax(0)
    .ioMaxSpec("string")
    .kmsKeyId("string")
    .name("string")
    .config("string")
    .partitionNum(0)
    .resourceGroupId("string")
    .eipMax(0)
    .selectedZones("string")
    .serviceVersion("string")
    .specType("string")
    .tags(Map.of("string", "string"))
    .vpcId("string")
    .defaultTopicPartitionNum(0)
    .vswitchIds("string")
    .zoneId("string")
    .build());
Copy
instance_resource = alicloud.alikafka.Instance("instanceResource",
    disk_type=0,
    vswitch_id="string",
    deploy_type=0,
    disk_size=0,
    paid_type="string",
    security_group="string",
    enable_auto_group=False,
    enable_auto_topic="string",
    io_max=0,
    io_max_spec="string",
    kms_key_id="string",
    name="string",
    config="string",
    partition_num=0,
    resource_group_id="string",
    eip_max=0,
    selected_zones=["string"],
    service_version="string",
    spec_type="string",
    tags={
        "string": "string",
    },
    vpc_id="string",
    default_topic_partition_num=0,
    vswitch_ids=["string"],
    zone_id="string")
Copy
const instanceResource = new alicloud.alikafka.Instance("instanceResource", {
    diskType: 0,
    vswitchId: "string",
    deployType: 0,
    diskSize: 0,
    paidType: "string",
    securityGroup: "string",
    enableAutoGroup: false,
    enableAutoTopic: "string",
    ioMax: 0,
    ioMaxSpec: "string",
    kmsKeyId: "string",
    name: "string",
    config: "string",
    partitionNum: 0,
    resourceGroupId: "string",
    eipMax: 0,
    selectedZones: ["string"],
    serviceVersion: "string",
    specType: "string",
    tags: {
        string: "string",
    },
    vpcId: "string",
    defaultTopicPartitionNum: 0,
    vswitchIds: ["string"],
    zoneId: "string",
});
Copy
type: alicloud:alikafka:Instance
properties:
    config: string
    defaultTopicPartitionNum: 0
    deployType: 0
    diskSize: 0
    diskType: 0
    eipMax: 0
    enableAutoGroup: false
    enableAutoTopic: string
    ioMax: 0
    ioMaxSpec: string
    kmsKeyId: string
    name: string
    paidType: string
    partitionNum: 0
    resourceGroupId: string
    securityGroup: string
    selectedZones:
        - string
    serviceVersion: string
    specType: string
    tags:
        string: string
    vpcId: string
    vswitchId: string
    vswitchIds:
        - string
    zoneId: string
Copy

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:

DeployType This property is required. int
The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

  • 4: eip/vpc instance
  • 5: vpc instance.
DiskSize This property is required. int
The disk size of the instance. When modify this value, it only supports adjust to a greater value.
DiskType
This property is required.
Changes to this property will trigger replacement.
int
The disk type of the instance. 0: efficient cloud disk , 1: SSD.
VswitchId
This property is required.
Changes to this property will trigger replacement.
string
The ID of attaching vswitch to instance.
Config string
The initial configurations of the ApsaraMQ for Kafka instance. The values must be valid JSON strings. The config supports the following parameters:

  • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
DefaultTopicPartitionNum int
The number of partitions in a topic that is automatically created.
EipMax int
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.
EnableAutoGroup bool
Specify whether to enable the flexible group creation feature. Default value: false. Valid values:
EnableAutoTopic string
Specify whether to enable the automatic topic creation feature. Default value: disable. Valid values:
IoMax int
The max value of io of the instance. When modify this value, it only support adjust to a greater value.
IoMaxSpec string
The traffic specification of the instance. We recommend that you configure this parameter.

  • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
  • For more information about the valid values, see Billing.
KmsKeyId Changes to this property will trigger replacement. string
The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
Name string
Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
PaidType string
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.
PartitionNum int
The number of partitions.
ResourceGroupId string
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
SecurityGroup Changes to this property will trigger replacement. string
The ID of security group for this instance. If the security group is empty, system will create a default one.
SelectedZones List<string>
The zones among which you want to deploy the instance.
ServiceVersion string
The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
SpecType string
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.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
TopicQuota int
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.

Deprecated: Attribute topic_quota has been deprecated since 1.194.0 and it will be removed in the next future. Using new attribute partition_num instead.

VpcId Changes to this property will trigger replacement. string
The VPC ID of the instance.
VswitchIds List<string>
The IDs of the vSwitches with which the instance is associated.
ZoneId Changes to this property will trigger replacement. string
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.
DeployType This property is required. int
The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

  • 4: eip/vpc instance
  • 5: vpc instance.
DiskSize This property is required. int
The disk size of the instance. When modify this value, it only supports adjust to a greater value.
DiskType
This property is required.
Changes to this property will trigger replacement.
int
The disk type of the instance. 0: efficient cloud disk , 1: SSD.
VswitchId
This property is required.
Changes to this property will trigger replacement.
string
The ID of attaching vswitch to instance.
Config string
The initial configurations of the ApsaraMQ for Kafka instance. The values must be valid JSON strings. The config supports the following parameters:

  • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
DefaultTopicPartitionNum int
The number of partitions in a topic that is automatically created.
EipMax int
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.
EnableAutoGroup bool
Specify whether to enable the flexible group creation feature. Default value: false. Valid values:
EnableAutoTopic string
Specify whether to enable the automatic topic creation feature. Default value: disable. Valid values:
IoMax int
The max value of io of the instance. When modify this value, it only support adjust to a greater value.
IoMaxSpec string
The traffic specification of the instance. We recommend that you configure this parameter.

  • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
  • For more information about the valid values, see Billing.
KmsKeyId Changes to this property will trigger replacement. string
The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
Name string
Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
PaidType string
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.
PartitionNum int
The number of partitions.
ResourceGroupId string
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
SecurityGroup Changes to this property will trigger replacement. string
The ID of security group for this instance. If the security group is empty, system will create a default one.
SelectedZones []string
The zones among which you want to deploy the instance.
ServiceVersion string
The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
SpecType string
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.
Tags map[string]string
A mapping of tags to assign to the resource.
TopicQuota int
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.

Deprecated: Attribute topic_quota has been deprecated since 1.194.0 and it will be removed in the next future. Using new attribute partition_num instead.

VpcId Changes to this property will trigger replacement. string
The VPC ID of the instance.
VswitchIds []string
The IDs of the vSwitches with which the instance is associated.
ZoneId Changes to this property will trigger replacement. string
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.
deployType This property is required. Integer
The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

  • 4: eip/vpc instance
  • 5: vpc instance.
diskSize This property is required. Integer
The disk size of the instance. When modify this value, it only supports adjust to a greater value.
diskType
This property is required.
Changes to this property will trigger replacement.
Integer
The disk type of the instance. 0: efficient cloud disk , 1: SSD.
vswitchId
This property is required.
Changes to this property will trigger replacement.
String
The ID of attaching vswitch to instance.
config String
The initial configurations of the ApsaraMQ for Kafka instance. The values must be valid JSON strings. The config supports the following parameters:

  • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
defaultTopicPartitionNum Integer
The number of partitions in a topic that is automatically created.
eipMax Integer
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.
enableAutoGroup Boolean
Specify whether to enable the flexible group creation feature. Default value: false. Valid values:
enableAutoTopic String
Specify whether to enable the automatic topic creation feature. Default value: disable. Valid values:
ioMax Integer
The max value of io of the instance. When modify this value, it only support adjust to a greater value.
ioMaxSpec String
The traffic specification of the instance. We recommend that you configure this parameter.

  • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
  • For more information about the valid values, see Billing.
kmsKeyId Changes to this property will trigger replacement. String
The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
name String
Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
paidType String
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.
partitionNum Integer
The number of partitions.
resourceGroupId String
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
securityGroup Changes to this property will trigger replacement. String
The ID of security group for this instance. If the security group is empty, system will create a default one.
selectedZones List<String>
The zones among which you want to deploy the instance.
serviceVersion String
The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
specType String
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.
tags Map<String,String>
A mapping of tags to assign to the resource.
topicQuota Integer
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.

Deprecated: Attribute topic_quota has been deprecated since 1.194.0 and it will be removed in the next future. Using new attribute partition_num instead.

vpcId Changes to this property will trigger replacement. String
The VPC ID of the instance.
vswitchIds List<String>
The IDs of the vSwitches with which the instance is associated.
zoneId Changes to this property will trigger replacement. String
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.
deployType This property is required. number
The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

  • 4: eip/vpc instance
  • 5: vpc instance.
diskSize This property is required. number
The disk size of the instance. When modify this value, it only supports adjust to a greater value.
diskType
This property is required.
Changes to this property will trigger replacement.
number
The disk type of the instance. 0: efficient cloud disk , 1: SSD.
vswitchId
This property is required.
Changes to this property will trigger replacement.
string
The ID of attaching vswitch to instance.
config string
The initial configurations of the ApsaraMQ for Kafka instance. The values must be valid JSON strings. The config supports the following parameters:

  • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
defaultTopicPartitionNum number
The number of partitions in a topic that is automatically created.
eipMax number
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.
enableAutoGroup boolean
Specify whether to enable the flexible group creation feature. Default value: false. Valid values:
enableAutoTopic string
Specify whether to enable the automatic topic creation feature. Default value: disable. Valid values:
ioMax number
The max value of io of the instance. When modify this value, it only support adjust to a greater value.
ioMaxSpec string
The traffic specification of the instance. We recommend that you configure this parameter.

  • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
  • For more information about the valid values, see Billing.
kmsKeyId Changes to this property will trigger replacement. string
The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
name string
Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
paidType string
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.
partitionNum number
The number of partitions.
resourceGroupId string
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
securityGroup Changes to this property will trigger replacement. string
The ID of security group for this instance. If the security group is empty, system will create a default one.
selectedZones string[]
The zones among which you want to deploy the instance.
serviceVersion string
The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
specType string
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.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
topicQuota number
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.

Deprecated: Attribute topic_quota has been deprecated since 1.194.0 and it will be removed in the next future. Using new attribute partition_num instead.

vpcId Changes to this property will trigger replacement. string
The VPC ID of the instance.
vswitchIds string[]
The IDs of the vSwitches with which the instance is associated.
zoneId Changes to this property will trigger replacement. string
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.
deploy_type This property is required. int
The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

  • 4: eip/vpc instance
  • 5: vpc instance.
disk_size This property is required. int
The disk size of the instance. When modify this value, it only supports adjust to a greater value.
disk_type
This property is required.
Changes to this property will trigger replacement.
int
The disk type of the instance. 0: efficient cloud disk , 1: SSD.
vswitch_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of attaching vswitch to instance.
config str
The initial configurations of the ApsaraMQ for Kafka instance. The values must be valid JSON strings. The config supports the following parameters:

  • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
default_topic_partition_num int
The number of partitions in a topic that is automatically created.
eip_max int
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.
enable_auto_group bool
Specify whether to enable the flexible group creation feature. Default value: false. Valid values:
enable_auto_topic str
Specify whether to enable the automatic topic creation feature. Default value: disable. Valid values:
io_max int
The max value of io of the instance. When modify this value, it only support adjust to a greater value.
io_max_spec str
The traffic specification of the instance. We recommend that you configure this parameter.

  • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
  • For more information about the valid values, see Billing.
kms_key_id Changes to this property will trigger replacement. str
The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
name str
Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
str
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.
partition_num int
The number of partitions.
resource_group_id str
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
security_group Changes to this property will trigger replacement. str
The ID of security group for this instance. If the security group is empty, system will create a default one.
selected_zones Sequence[str]
The zones among which you want to deploy the instance.
service_version str
The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
spec_type str
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.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
topic_quota int
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.

Deprecated: Attribute topic_quota has been deprecated since 1.194.0 and it will be removed in the next future. Using new attribute partition_num instead.

vpc_id Changes to this property will trigger replacement. str
The VPC ID of the instance.
vswitch_ids Sequence[str]
The IDs of the vSwitches with which the instance is associated.
zone_id Changes to this property will trigger replacement. str
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.
deployType This property is required. Number
The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

  • 4: eip/vpc instance
  • 5: vpc instance.
diskSize This property is required. Number
The disk size of the instance. When modify this value, it only supports adjust to a greater value.
diskType
This property is required.
Changes to this property will trigger replacement.
Number
The disk type of the instance. 0: efficient cloud disk , 1: SSD.
vswitchId
This property is required.
Changes to this property will trigger replacement.
String
The ID of attaching vswitch to instance.
config String
The initial configurations of the ApsaraMQ for Kafka instance. The values must be valid JSON strings. The config supports the following parameters:

  • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
defaultTopicPartitionNum Number
The number of partitions in a topic that is automatically created.
eipMax Number
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.
enableAutoGroup Boolean
Specify whether to enable the flexible group creation feature. Default value: false. Valid values:
enableAutoTopic String
Specify whether to enable the automatic topic creation feature. Default value: disable. Valid values:
ioMax Number
The max value of io of the instance. When modify this value, it only support adjust to a greater value.
ioMaxSpec String
The traffic specification of the instance. We recommend that you configure this parameter.

  • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
  • For more information about the valid values, see Billing.
kmsKeyId Changes to this property will trigger replacement. String
The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
name String
Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
paidType String
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.
partitionNum Number
The number of partitions.
resourceGroupId String
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
securityGroup Changes to this property will trigger replacement. String
The ID of security group for this instance. If the security group is empty, system will create a default one.
selectedZones List<String>
The zones among which you want to deploy the instance.
serviceVersion String
The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
specType String
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.
tags Map<String>
A mapping of tags to assign to the resource.
topicQuota Number
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.

Deprecated: Attribute topic_quota has been deprecated since 1.194.0 and it will be removed in the next future. Using new attribute partition_num instead.

vpcId Changes to this property will trigger replacement. String
The VPC ID of the instance.
vswitchIds List<String>
The IDs of the vSwitches with which the instance is associated.
zoneId Changes to this property will trigger replacement. String
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.

Outputs

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

DomainEndpoint string
(Available since v1.234.0) The default endpoint of the instance in domain name mode.
EndPoint string
The EndPoint to access the kafka instance.
GroupLeft int
(Available since v1.214.1) The number of available groups.
GroupUsed int
(Available since v1.214.1) The number of used groups.
Id string
The provider-assigned unique ID for this managed resource.
IsPartitionBuy int
(Available since v1.214.1) The method that you use to purchase partitions.
PartitionLeft int
(Available since v1.214.1) The number of available partitions.
PartitionUsed int
(Available since v1.214.1) The number of used partitions.
SaslDomainEndpoint string
(Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
SslDomainEndpoint string
(Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
SslEndpoint string
(Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
Status int
The status of the instance.
TopicLeft int
(Available since v1.214.1) The number of available topics.
TopicNumOfBuy int
(Available since v1.214.1) The number of purchased topics.
TopicUsed int
(Available since v1.214.1) The number of used topics.
DomainEndpoint string
(Available since v1.234.0) The default endpoint of the instance in domain name mode.
EndPoint string
The EndPoint to access the kafka instance.
GroupLeft int
(Available since v1.214.1) The number of available groups.
GroupUsed int
(Available since v1.214.1) The number of used groups.
Id string
The provider-assigned unique ID for this managed resource.
IsPartitionBuy int
(Available since v1.214.1) The method that you use to purchase partitions.
PartitionLeft int
(Available since v1.214.1) The number of available partitions.
PartitionUsed int
(Available since v1.214.1) The number of used partitions.
SaslDomainEndpoint string
(Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
SslDomainEndpoint string
(Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
SslEndpoint string
(Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
Status int
The status of the instance.
TopicLeft int
(Available since v1.214.1) The number of available topics.
TopicNumOfBuy int
(Available since v1.214.1) The number of purchased topics.
TopicUsed int
(Available since v1.214.1) The number of used topics.
domainEndpoint String
(Available since v1.234.0) The default endpoint of the instance in domain name mode.
endPoint String
The EndPoint to access the kafka instance.
groupLeft Integer
(Available since v1.214.1) The number of available groups.
groupUsed Integer
(Available since v1.214.1) The number of used groups.
id String
The provider-assigned unique ID for this managed resource.
isPartitionBuy Integer
(Available since v1.214.1) The method that you use to purchase partitions.
partitionLeft Integer
(Available since v1.214.1) The number of available partitions.
partitionUsed Integer
(Available since v1.214.1) The number of used partitions.
saslDomainEndpoint String
(Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
sslDomainEndpoint String
(Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
sslEndpoint String
(Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
status Integer
The status of the instance.
topicLeft Integer
(Available since v1.214.1) The number of available topics.
topicNumOfBuy Integer
(Available since v1.214.1) The number of purchased topics.
topicUsed Integer
(Available since v1.214.1) The number of used topics.
domainEndpoint string
(Available since v1.234.0) The default endpoint of the instance in domain name mode.
endPoint string
The EndPoint to access the kafka instance.
groupLeft number
(Available since v1.214.1) The number of available groups.
groupUsed number
(Available since v1.214.1) The number of used groups.
id string
The provider-assigned unique ID for this managed resource.
isPartitionBuy number
(Available since v1.214.1) The method that you use to purchase partitions.
partitionLeft number
(Available since v1.214.1) The number of available partitions.
partitionUsed number
(Available since v1.214.1) The number of used partitions.
saslDomainEndpoint string
(Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
sslDomainEndpoint string
(Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
sslEndpoint string
(Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
status number
The status of the instance.
topicLeft number
(Available since v1.214.1) The number of available topics.
topicNumOfBuy number
(Available since v1.214.1) The number of purchased topics.
topicUsed number
(Available since v1.214.1) The number of used topics.
domain_endpoint str
(Available since v1.234.0) The default endpoint of the instance in domain name mode.
end_point str
The EndPoint to access the kafka instance.
group_left int
(Available since v1.214.1) The number of available groups.
group_used int
(Available since v1.214.1) The number of used groups.
id str
The provider-assigned unique ID for this managed resource.
is_partition_buy int
(Available since v1.214.1) The method that you use to purchase partitions.
partition_left int
(Available since v1.214.1) The number of available partitions.
partition_used int
(Available since v1.214.1) The number of used partitions.
sasl_domain_endpoint str
(Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
ssl_domain_endpoint str
(Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
ssl_endpoint str
(Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
status int
The status of the instance.
topic_left int
(Available since v1.214.1) The number of available topics.
topic_num_of_buy int
(Available since v1.214.1) The number of purchased topics.
topic_used int
(Available since v1.214.1) The number of used topics.
domainEndpoint String
(Available since v1.234.0) The default endpoint of the instance in domain name mode.
endPoint String
The EndPoint to access the kafka instance.
groupLeft Number
(Available since v1.214.1) The number of available groups.
groupUsed Number
(Available since v1.214.1) The number of used groups.
id String
The provider-assigned unique ID for this managed resource.
isPartitionBuy Number
(Available since v1.214.1) The method that you use to purchase partitions.
partitionLeft Number
(Available since v1.214.1) The number of available partitions.
partitionUsed Number
(Available since v1.214.1) The number of used partitions.
saslDomainEndpoint String
(Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
sslDomainEndpoint String
(Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
sslEndpoint String
(Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
status Number
The status of the instance.
topicLeft Number
(Available since v1.214.1) The number of available topics.
topicNumOfBuy Number
(Available since v1.214.1) The number of purchased topics.
topicUsed Number
(Available since v1.214.1) The number of used topics.

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,
        config: Optional[str] = None,
        default_topic_partition_num: Optional[int] = None,
        deploy_type: Optional[int] = None,
        disk_size: Optional[int] = None,
        disk_type: Optional[int] = None,
        domain_endpoint: Optional[str] = None,
        eip_max: Optional[int] = None,
        enable_auto_group: Optional[bool] = None,
        enable_auto_topic: Optional[str] = None,
        end_point: Optional[str] = None,
        group_left: Optional[int] = None,
        group_used: Optional[int] = None,
        io_max: Optional[int] = None,
        io_max_spec: Optional[str] = None,
        is_partition_buy: Optional[int] = None,
        kms_key_id: Optional[str] = None,
        name: Optional[str] = None,
        paid_type: Optional[str] = None,
        partition_left: Optional[int] = None,
        partition_num: Optional[int] = None,
        partition_used: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        sasl_domain_endpoint: Optional[str] = None,
        security_group: Optional[str] = None,
        selected_zones: Optional[Sequence[str]] = None,
        service_version: Optional[str] = None,
        spec_type: Optional[str] = None,
        ssl_domain_endpoint: Optional[str] = None,
        ssl_endpoint: Optional[str] = None,
        status: Optional[int] = None,
        tags: Optional[Mapping[str, str]] = None,
        topic_left: Optional[int] = None,
        topic_num_of_buy: Optional[int] = None,
        topic_quota: Optional[int] = None,
        topic_used: Optional[int] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        vswitch_ids: Optional[Sequence[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: alicloud:alikafka:Instance    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Config string
The initial configurations of the ApsaraMQ for Kafka instance. The values must be valid JSON strings. The config supports the following parameters:

  • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
DefaultTopicPartitionNum int
The number of partitions in a topic that is automatically created.
DeployType int
The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

  • 4: eip/vpc instance
  • 5: vpc instance.
DiskSize int
The disk size of the instance. When modify this value, it only supports adjust to a greater value.
DiskType Changes to this property will trigger replacement. int
The disk type of the instance. 0: efficient cloud disk , 1: SSD.
DomainEndpoint string
(Available since v1.234.0) The default endpoint of the instance in domain name mode.
EipMax int
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.
EnableAutoGroup bool
Specify whether to enable the flexible group creation feature. Default value: false. Valid values:
EnableAutoTopic string
Specify whether to enable the automatic topic creation feature. Default value: disable. Valid values:
EndPoint string
The EndPoint to access the kafka instance.
GroupLeft int
(Available since v1.214.1) The number of available groups.
GroupUsed int
(Available since v1.214.1) The number of used groups.
IoMax int
The max value of io of the instance. When modify this value, it only support adjust to a greater value.
IoMaxSpec string
The traffic specification of the instance. We recommend that you configure this parameter.

  • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
  • For more information about the valid values, see Billing.
IsPartitionBuy int
(Available since v1.214.1) The method that you use to purchase partitions.
KmsKeyId Changes to this property will trigger replacement. string
The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
Name string
Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
PaidType string
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.
PartitionLeft int
(Available since v1.214.1) The number of available partitions.
PartitionNum int
The number of partitions.
PartitionUsed int
(Available since v1.214.1) The number of used partitions.
ResourceGroupId string
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
SaslDomainEndpoint string
(Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
SecurityGroup Changes to this property will trigger replacement. string
The ID of security group for this instance. If the security group is empty, system will create a default one.
SelectedZones List<string>
The zones among which you want to deploy the instance.
ServiceVersion string
The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
SpecType string
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.
SslDomainEndpoint string
(Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
SslEndpoint string
(Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
Status int
The status of the instance.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
TopicLeft int
(Available since v1.214.1) The number of available topics.
TopicNumOfBuy int
(Available since v1.214.1) The number of purchased topics.
TopicQuota int
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.

Deprecated: Attribute topic_quota has been deprecated since 1.194.0 and it will be removed in the next future. Using new attribute partition_num instead.

TopicUsed int
(Available since v1.214.1) The number of used topics.
VpcId Changes to this property will trigger replacement. string
The VPC ID of the instance.
VswitchId Changes to this property will trigger replacement. string
The ID of attaching vswitch to instance.
VswitchIds List<string>
The IDs of the vSwitches with which the instance is associated.
ZoneId Changes to this property will trigger replacement. string
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.
Config string
The initial configurations of the ApsaraMQ for Kafka instance. The values must be valid JSON strings. The config supports the following parameters:

  • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
DefaultTopicPartitionNum int
The number of partitions in a topic that is automatically created.
DeployType int
The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

  • 4: eip/vpc instance
  • 5: vpc instance.
DiskSize int
The disk size of the instance. When modify this value, it only supports adjust to a greater value.
DiskType Changes to this property will trigger replacement. int
The disk type of the instance. 0: efficient cloud disk , 1: SSD.
DomainEndpoint string
(Available since v1.234.0) The default endpoint of the instance in domain name mode.
EipMax int
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.
EnableAutoGroup bool
Specify whether to enable the flexible group creation feature. Default value: false. Valid values:
EnableAutoTopic string
Specify whether to enable the automatic topic creation feature. Default value: disable. Valid values:
EndPoint string
The EndPoint to access the kafka instance.
GroupLeft int
(Available since v1.214.1) The number of available groups.
GroupUsed int
(Available since v1.214.1) The number of used groups.
IoMax int
The max value of io of the instance. When modify this value, it only support adjust to a greater value.
IoMaxSpec string
The traffic specification of the instance. We recommend that you configure this parameter.

  • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
  • For more information about the valid values, see Billing.
IsPartitionBuy int
(Available since v1.214.1) The method that you use to purchase partitions.
KmsKeyId Changes to this property will trigger replacement. string
The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
Name string
Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
PaidType string
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.
PartitionLeft int
(Available since v1.214.1) The number of available partitions.
PartitionNum int
The number of partitions.
PartitionUsed int
(Available since v1.214.1) The number of used partitions.
ResourceGroupId string
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
SaslDomainEndpoint string
(Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
SecurityGroup Changes to this property will trigger replacement. string
The ID of security group for this instance. If the security group is empty, system will create a default one.
SelectedZones []string
The zones among which you want to deploy the instance.
ServiceVersion string
The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
SpecType string
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.
SslDomainEndpoint string
(Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
SslEndpoint string
(Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
Status int
The status of the instance.
Tags map[string]string
A mapping of tags to assign to the resource.
TopicLeft int
(Available since v1.214.1) The number of available topics.
TopicNumOfBuy int
(Available since v1.214.1) The number of purchased topics.
TopicQuota int
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.

Deprecated: Attribute topic_quota has been deprecated since 1.194.0 and it will be removed in the next future. Using new attribute partition_num instead.

TopicUsed int
(Available since v1.214.1) The number of used topics.
VpcId Changes to this property will trigger replacement. string
The VPC ID of the instance.
VswitchId Changes to this property will trigger replacement. string
The ID of attaching vswitch to instance.
VswitchIds []string
The IDs of the vSwitches with which the instance is associated.
ZoneId Changes to this property will trigger replacement. string
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.
config String
The initial configurations of the ApsaraMQ for Kafka instance. The values must be valid JSON strings. The config supports the following parameters:

  • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
defaultTopicPartitionNum Integer
The number of partitions in a topic that is automatically created.
deployType Integer
The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

  • 4: eip/vpc instance
  • 5: vpc instance.
diskSize Integer
The disk size of the instance. When modify this value, it only supports adjust to a greater value.
diskType Changes to this property will trigger replacement. Integer
The disk type of the instance. 0: efficient cloud disk , 1: SSD.
domainEndpoint String
(Available since v1.234.0) The default endpoint of the instance in domain name mode.
eipMax Integer
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.
enableAutoGroup Boolean
Specify whether to enable the flexible group creation feature. Default value: false. Valid values:
enableAutoTopic String
Specify whether to enable the automatic topic creation feature. Default value: disable. Valid values:
endPoint String
The EndPoint to access the kafka instance.
groupLeft Integer
(Available since v1.214.1) The number of available groups.
groupUsed Integer
(Available since v1.214.1) The number of used groups.
ioMax Integer
The max value of io of the instance. When modify this value, it only support adjust to a greater value.
ioMaxSpec String
The traffic specification of the instance. We recommend that you configure this parameter.

  • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
  • For more information about the valid values, see Billing.
isPartitionBuy Integer
(Available since v1.214.1) The method that you use to purchase partitions.
kmsKeyId Changes to this property will trigger replacement. String
The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
name String
Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
paidType String
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.
partitionLeft Integer
(Available since v1.214.1) The number of available partitions.
partitionNum Integer
The number of partitions.
partitionUsed Integer
(Available since v1.214.1) The number of used partitions.
resourceGroupId String
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
saslDomainEndpoint String
(Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
securityGroup Changes to this property will trigger replacement. String
The ID of security group for this instance. If the security group is empty, system will create a default one.
selectedZones List<String>
The zones among which you want to deploy the instance.
serviceVersion String
The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
specType String
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.
sslDomainEndpoint String
(Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
sslEndpoint String
(Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
status Integer
The status of the instance.
tags Map<String,String>
A mapping of tags to assign to the resource.
topicLeft Integer
(Available since v1.214.1) The number of available topics.
topicNumOfBuy Integer
(Available since v1.214.1) The number of purchased topics.
topicQuota Integer
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.

Deprecated: Attribute topic_quota has been deprecated since 1.194.0 and it will be removed in the next future. Using new attribute partition_num instead.

topicUsed Integer
(Available since v1.214.1) The number of used topics.
vpcId Changes to this property will trigger replacement. String
The VPC ID of the instance.
vswitchId Changes to this property will trigger replacement. String
The ID of attaching vswitch to instance.
vswitchIds List<String>
The IDs of the vSwitches with which the instance is associated.
zoneId Changes to this property will trigger replacement. String
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.
config string
The initial configurations of the ApsaraMQ for Kafka instance. The values must be valid JSON strings. The config supports the following parameters:

  • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
defaultTopicPartitionNum number
The number of partitions in a topic that is automatically created.
deployType number
The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

  • 4: eip/vpc instance
  • 5: vpc instance.
diskSize number
The disk size of the instance. When modify this value, it only supports adjust to a greater value.
diskType Changes to this property will trigger replacement. number
The disk type of the instance. 0: efficient cloud disk , 1: SSD.
domainEndpoint string
(Available since v1.234.0) The default endpoint of the instance in domain name mode.
eipMax number
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.
enableAutoGroup boolean
Specify whether to enable the flexible group creation feature. Default value: false. Valid values:
enableAutoTopic string
Specify whether to enable the automatic topic creation feature. Default value: disable. Valid values:
endPoint string
The EndPoint to access the kafka instance.
groupLeft number
(Available since v1.214.1) The number of available groups.
groupUsed number
(Available since v1.214.1) The number of used groups.
ioMax number
The max value of io of the instance. When modify this value, it only support adjust to a greater value.
ioMaxSpec string
The traffic specification of the instance. We recommend that you configure this parameter.

  • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
  • For more information about the valid values, see Billing.
isPartitionBuy number
(Available since v1.214.1) The method that you use to purchase partitions.
kmsKeyId Changes to this property will trigger replacement. string
The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
name string
Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
paidType string
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.
partitionLeft number
(Available since v1.214.1) The number of available partitions.
partitionNum number
The number of partitions.
partitionUsed number
(Available since v1.214.1) The number of used partitions.
resourceGroupId string
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
saslDomainEndpoint string
(Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
securityGroup Changes to this property will trigger replacement. string
The ID of security group for this instance. If the security group is empty, system will create a default one.
selectedZones string[]
The zones among which you want to deploy the instance.
serviceVersion string
The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
specType string
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.
sslDomainEndpoint string
(Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
sslEndpoint string
(Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
status number
The status of the instance.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
topicLeft number
(Available since v1.214.1) The number of available topics.
topicNumOfBuy number
(Available since v1.214.1) The number of purchased topics.
topicQuota number
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.

Deprecated: Attribute topic_quota has been deprecated since 1.194.0 and it will be removed in the next future. Using new attribute partition_num instead.

topicUsed number
(Available since v1.214.1) The number of used topics.
vpcId Changes to this property will trigger replacement. string
The VPC ID of the instance.
vswitchId Changes to this property will trigger replacement. string
The ID of attaching vswitch to instance.
vswitchIds string[]
The IDs of the vSwitches with which the instance is associated.
zoneId Changes to this property will trigger replacement. string
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.
config str
The initial configurations of the ApsaraMQ for Kafka instance. The values must be valid JSON strings. The config supports the following parameters:

  • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
default_topic_partition_num int
The number of partitions in a topic that is automatically created.
deploy_type int
The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

  • 4: eip/vpc instance
  • 5: vpc instance.
disk_size int
The disk size of the instance. When modify this value, it only supports adjust to a greater value.
disk_type Changes to this property will trigger replacement. int
The disk type of the instance. 0: efficient cloud disk , 1: SSD.
domain_endpoint str
(Available since v1.234.0) The default endpoint of the instance in domain name mode.
eip_max int
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.
enable_auto_group bool
Specify whether to enable the flexible group creation feature. Default value: false. Valid values:
enable_auto_topic str
Specify whether to enable the automatic topic creation feature. Default value: disable. Valid values:
end_point str
The EndPoint to access the kafka instance.
group_left int
(Available since v1.214.1) The number of available groups.
group_used int
(Available since v1.214.1) The number of used groups.
io_max int
The max value of io of the instance. When modify this value, it only support adjust to a greater value.
io_max_spec str
The traffic specification of the instance. We recommend that you configure this parameter.

  • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
  • For more information about the valid values, see Billing.
is_partition_buy int
(Available since v1.214.1) The method that you use to purchase partitions.
kms_key_id Changes to this property will trigger replacement. str
The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
name str
Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
paid_type str
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.
partition_left int
(Available since v1.214.1) The number of available partitions.
partition_num int
The number of partitions.
partition_used int
(Available since v1.214.1) The number of used partitions.
resource_group_id str
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
sasl_domain_endpoint str
(Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
security_group Changes to this property will trigger replacement. str
The ID of security group for this instance. If the security group is empty, system will create a default one.
selected_zones Sequence[str]
The zones among which you want to deploy the instance.
service_version str
The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
spec_type str
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.
ssl_domain_endpoint str
(Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
ssl_endpoint str
(Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
status int
The status of the instance.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
topic_left int
(Available since v1.214.1) The number of available topics.
topic_num_of_buy int
(Available since v1.214.1) The number of purchased topics.
topic_quota int
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.

Deprecated: Attribute topic_quota has been deprecated since 1.194.0 and it will be removed in the next future. Using new attribute partition_num instead.

topic_used int
(Available since v1.214.1) The number of used topics.
vpc_id Changes to this property will trigger replacement. str
The VPC ID of the instance.
vswitch_id Changes to this property will trigger replacement. str
The ID of attaching vswitch to instance.
vswitch_ids Sequence[str]
The IDs of the vSwitches with which the instance is associated.
zone_id Changes to this property will trigger replacement. str
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.
config String
The initial configurations of the ApsaraMQ for Kafka instance. The values must be valid JSON strings. The config supports the following parameters:

  • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
defaultTopicPartitionNum Number
The number of partitions in a topic that is automatically created.
deployType Number
The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

  • 4: eip/vpc instance
  • 5: vpc instance.
diskSize Number
The disk size of the instance. When modify this value, it only supports adjust to a greater value.
diskType Changes to this property will trigger replacement. Number
The disk type of the instance. 0: efficient cloud disk , 1: SSD.
domainEndpoint String
(Available since v1.234.0) The default endpoint of the instance in domain name mode.
eipMax Number
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.
enableAutoGroup Boolean
Specify whether to enable the flexible group creation feature. Default value: false. Valid values:
enableAutoTopic String
Specify whether to enable the automatic topic creation feature. Default value: disable. Valid values:
endPoint String
The EndPoint to access the kafka instance.
groupLeft Number
(Available since v1.214.1) The number of available groups.
groupUsed Number
(Available since v1.214.1) The number of used groups.
ioMax Number
The max value of io of the instance. When modify this value, it only support adjust to a greater value.
ioMaxSpec String
The traffic specification of the instance. We recommend that you configure this parameter.

  • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
  • For more information about the valid values, see Billing.
isPartitionBuy Number
(Available since v1.214.1) The method that you use to purchase partitions.
kmsKeyId Changes to this property will trigger replacement. String
The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
name String
Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
paidType String
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.
partitionLeft Number
(Available since v1.214.1) The number of available partitions.
partitionNum Number
The number of partitions.
partitionUsed Number
(Available since v1.214.1) The number of used partitions.
resourceGroupId String
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
saslDomainEndpoint String
(Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
securityGroup Changes to this property will trigger replacement. String
The ID of security group for this instance. If the security group is empty, system will create a default one.
selectedZones List<String>
The zones among which you want to deploy the instance.
serviceVersion String
The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
specType String
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.
sslDomainEndpoint String
(Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
sslEndpoint String
(Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
status Number
The status of the instance.
tags Map<String>
A mapping of tags to assign to the resource.
topicLeft Number
(Available since v1.214.1) The number of available topics.
topicNumOfBuy Number
(Available since v1.214.1) The number of purchased topics.
topicQuota Number
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.

Deprecated: Attribute topic_quota has been deprecated since 1.194.0 and it will be removed in the next future. Using new attribute partition_num instead.

topicUsed Number
(Available since v1.214.1) The number of used topics.
vpcId Changes to this property will trigger replacement. String
The VPC ID of the instance.
vswitchId Changes to this property will trigger replacement. String
The ID of attaching vswitch to instance.
vswitchIds List<String>
The IDs of the vSwitches with which the instance is associated.
zoneId Changes to this property will trigger replacement. String
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.

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud