1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. alikafka
  5. Instance
Alibaba Cloud v3.82.0 published on Tuesday, Jul 8, 2025 by Pulumi

alicloud.alikafka.Instance

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.82.0 published on Tuesday, Jul 8, 2025 by Pulumi

    Import

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

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

    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,
                 deploy_type: Optional[int] = None,
                 paid_type: Optional[str] = None,
                 topic_quota: Optional[int] = None,
                 confluent_config: Optional[InstanceConfluentConfigArgs] = None,
                 disk_size: Optional[int] = None,
                 partition_num: Optional[int] = None,
                 eip_max: Optional[int] = None,
                 enable_auto_group: Optional[bool] = None,
                 enable_auto_topic: Optional[str] = None,
                 instance_type: Optional[str] = None,
                 io_max: Optional[int] = None,
                 io_max_spec: Optional[str] = None,
                 kms_key_id: Optional[str] = None,
                 default_topic_partition_num: Optional[int] = None,
                 name: Optional[str] = None,
                 disk_type: Optional[int] = None,
                 password: Optional[str] = None,
                 resource_group_id: Optional[str] = None,
                 security_group: Optional[str] = None,
                 selected_zones: Optional[Sequence[str]] = None,
                 serverless_config: Optional[InstanceServerlessConfigArgs] = None,
                 service_version: Optional[str] = None,
                 spec_type: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 config: Optional[str] = None,
                 vpc_id: Optional[str] = None,
                 vswitch_id: Optional[str] = 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 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 instanceResource = new AliCloud.AliKafka.Instance("instanceResource", new()
    {
        DeployType = 0,
        PaidType = "string",
        ConfluentConfig = new AliCloud.AliKafka.Inputs.InstanceConfluentConfigArgs
        {
            ConnectCu = 0,
            ConnectReplica = 0,
            ControlCenterCu = 0,
            ControlCenterReplica = 0,
            ControlCenterStorage = 0,
            KafkaCu = 0,
            KafkaReplica = 0,
            KafkaRestProxyCu = 0,
            KafkaRestProxyReplica = 0,
            KafkaStorage = 0,
            KsqlCu = 0,
            KsqlReplica = 0,
            KsqlStorage = 0,
            SchemaRegistryCu = 0,
            SchemaRegistryReplica = 0,
            ZookeeperCu = 0,
            ZookeeperReplica = 0,
            ZookeeperStorage = 0,
        },
        DiskSize = 0,
        PartitionNum = 0,
        EipMax = 0,
        EnableAutoGroup = false,
        EnableAutoTopic = "string",
        InstanceType = "string",
        IoMax = 0,
        IoMaxSpec = "string",
        KmsKeyId = "string",
        DefaultTopicPartitionNum = 0,
        Name = "string",
        DiskType = 0,
        Password = "string",
        ResourceGroupId = "string",
        SecurityGroup = "string",
        SelectedZones = new[]
        {
            "string",
        },
        ServerlessConfig = new AliCloud.AliKafka.Inputs.InstanceServerlessConfigArgs
        {
            ReservedPublishCapacity = 0,
            ReservedSubscribeCapacity = 0,
        },
        ServiceVersion = "string",
        SpecType = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Config = "string",
        VpcId = "string",
        VswitchId = "string",
        VswitchIds = new[]
        {
            "string",
        },
        ZoneId = "string",
    });
    
    example, err := alikafka.NewInstance(ctx, "instanceResource", &alikafka.InstanceArgs{
    	DeployType: pulumi.Int(0),
    	PaidType:   pulumi.String("string"),
    	ConfluentConfig: &alikafka.InstanceConfluentConfigArgs{
    		ConnectCu:             pulumi.Int(0),
    		ConnectReplica:        pulumi.Int(0),
    		ControlCenterCu:       pulumi.Int(0),
    		ControlCenterReplica:  pulumi.Int(0),
    		ControlCenterStorage:  pulumi.Int(0),
    		KafkaCu:               pulumi.Int(0),
    		KafkaReplica:          pulumi.Int(0),
    		KafkaRestProxyCu:      pulumi.Int(0),
    		KafkaRestProxyReplica: pulumi.Int(0),
    		KafkaStorage:          pulumi.Int(0),
    		KsqlCu:                pulumi.Int(0),
    		KsqlReplica:           pulumi.Int(0),
    		KsqlStorage:           pulumi.Int(0),
    		SchemaRegistryCu:      pulumi.Int(0),
    		SchemaRegistryReplica: pulumi.Int(0),
    		ZookeeperCu:           pulumi.Int(0),
    		ZookeeperReplica:      pulumi.Int(0),
    		ZookeeperStorage:      pulumi.Int(0),
    	},
    	DiskSize:                 pulumi.Int(0),
    	PartitionNum:             pulumi.Int(0),
    	EipMax:                   pulumi.Int(0),
    	EnableAutoGroup:          pulumi.Bool(false),
    	EnableAutoTopic:          pulumi.String("string"),
    	InstanceType:             pulumi.String("string"),
    	IoMax:                    pulumi.Int(0),
    	IoMaxSpec:                pulumi.String("string"),
    	KmsKeyId:                 pulumi.String("string"),
    	DefaultTopicPartitionNum: pulumi.Int(0),
    	Name:                     pulumi.String("string"),
    	DiskType:                 pulumi.Int(0),
    	Password:                 pulumi.String("string"),
    	ResourceGroupId:          pulumi.String("string"),
    	SecurityGroup:            pulumi.String("string"),
    	SelectedZones: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ServerlessConfig: &alikafka.InstanceServerlessConfigArgs{
    		ReservedPublishCapacity:   pulumi.Int(0),
    		ReservedSubscribeCapacity: pulumi.Int(0),
    	},
    	ServiceVersion: pulumi.String("string"),
    	SpecType:       pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Config:    pulumi.String("string"),
    	VpcId:     pulumi.String("string"),
    	VswitchId: pulumi.String("string"),
    	VswitchIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ZoneId: pulumi.String("string"),
    })
    
    var instanceResource = new com.pulumi.alicloud.alikafka.Instance("instanceResource", com.pulumi.alicloud.alikafka.InstanceArgs.builder()
        .deployType(0)
        .paidType("string")
        .confluentConfig(InstanceConfluentConfigArgs.builder()
            .connectCu(0)
            .connectReplica(0)
            .controlCenterCu(0)
            .controlCenterReplica(0)
            .controlCenterStorage(0)
            .kafkaCu(0)
            .kafkaReplica(0)
            .kafkaRestProxyCu(0)
            .kafkaRestProxyReplica(0)
            .kafkaStorage(0)
            .ksqlCu(0)
            .ksqlReplica(0)
            .ksqlStorage(0)
            .schemaRegistryCu(0)
            .schemaRegistryReplica(0)
            .zookeeperCu(0)
            .zookeeperReplica(0)
            .zookeeperStorage(0)
            .build())
        .diskSize(0)
        .partitionNum(0)
        .eipMax(0)
        .enableAutoGroup(false)
        .enableAutoTopic("string")
        .instanceType("string")
        .ioMax(0)
        .ioMaxSpec("string")
        .kmsKeyId("string")
        .defaultTopicPartitionNum(0)
        .name("string")
        .diskType(0)
        .password("string")
        .resourceGroupId("string")
        .securityGroup("string")
        .selectedZones("string")
        .serverlessConfig(InstanceServerlessConfigArgs.builder()
            .reservedPublishCapacity(0)
            .reservedSubscribeCapacity(0)
            .build())
        .serviceVersion("string")
        .specType("string")
        .tags(Map.of("string", "string"))
        .config("string")
        .vpcId("string")
        .vswitchId("string")
        .vswitchIds("string")
        .zoneId("string")
        .build());
    
    instance_resource = alicloud.alikafka.Instance("instanceResource",
        deploy_type=0,
        paid_type="string",
        confluent_config={
            "connect_cu": 0,
            "connect_replica": 0,
            "control_center_cu": 0,
            "control_center_replica": 0,
            "control_center_storage": 0,
            "kafka_cu": 0,
            "kafka_replica": 0,
            "kafka_rest_proxy_cu": 0,
            "kafka_rest_proxy_replica": 0,
            "kafka_storage": 0,
            "ksql_cu": 0,
            "ksql_replica": 0,
            "ksql_storage": 0,
            "schema_registry_cu": 0,
            "schema_registry_replica": 0,
            "zookeeper_cu": 0,
            "zookeeper_replica": 0,
            "zookeeper_storage": 0,
        },
        disk_size=0,
        partition_num=0,
        eip_max=0,
        enable_auto_group=False,
        enable_auto_topic="string",
        instance_type="string",
        io_max=0,
        io_max_spec="string",
        kms_key_id="string",
        default_topic_partition_num=0,
        name="string",
        disk_type=0,
        password="string",
        resource_group_id="string",
        security_group="string",
        selected_zones=["string"],
        serverless_config={
            "reserved_publish_capacity": 0,
            "reserved_subscribe_capacity": 0,
        },
        service_version="string",
        spec_type="string",
        tags={
            "string": "string",
        },
        config="string",
        vpc_id="string",
        vswitch_id="string",
        vswitch_ids=["string"],
        zone_id="string")
    
    const instanceResource = new alicloud.alikafka.Instance("instanceResource", {
        deployType: 0,
        paidType: "string",
        confluentConfig: {
            connectCu: 0,
            connectReplica: 0,
            controlCenterCu: 0,
            controlCenterReplica: 0,
            controlCenterStorage: 0,
            kafkaCu: 0,
            kafkaReplica: 0,
            kafkaRestProxyCu: 0,
            kafkaRestProxyReplica: 0,
            kafkaStorage: 0,
            ksqlCu: 0,
            ksqlReplica: 0,
            ksqlStorage: 0,
            schemaRegistryCu: 0,
            schemaRegistryReplica: 0,
            zookeeperCu: 0,
            zookeeperReplica: 0,
            zookeeperStorage: 0,
        },
        diskSize: 0,
        partitionNum: 0,
        eipMax: 0,
        enableAutoGroup: false,
        enableAutoTopic: "string",
        instanceType: "string",
        ioMax: 0,
        ioMaxSpec: "string",
        kmsKeyId: "string",
        defaultTopicPartitionNum: 0,
        name: "string",
        diskType: 0,
        password: "string",
        resourceGroupId: "string",
        securityGroup: "string",
        selectedZones: ["string"],
        serverlessConfig: {
            reservedPublishCapacity: 0,
            reservedSubscribeCapacity: 0,
        },
        serviceVersion: "string",
        specType: "string",
        tags: {
            string: "string",
        },
        config: "string",
        vpcId: "string",
        vswitchId: "string",
        vswitchIds: ["string"],
        zoneId: "string",
    });
    
    type: alicloud:alikafka:Instance
    properties:
        config: string
        confluentConfig:
            connectCu: 0
            connectReplica: 0
            controlCenterCu: 0
            controlCenterReplica: 0
            controlCenterStorage: 0
            kafkaCu: 0
            kafkaReplica: 0
            kafkaRestProxyCu: 0
            kafkaRestProxyReplica: 0
            kafkaStorage: 0
            ksqlCu: 0
            ksqlReplica: 0
            ksqlStorage: 0
            schemaRegistryCu: 0
            schemaRegistryReplica: 0
            zookeeperCu: 0
            zookeeperReplica: 0
            zookeeperStorage: 0
        defaultTopicPartitionNum: 0
        deployType: 0
        diskSize: 0
        diskType: 0
        eipMax: 0
        enableAutoGroup: false
        enableAutoTopic: string
        instanceType: string
        ioMax: 0
        ioMaxSpec: string
        kmsKeyId: string
        name: string
        paidType: string
        partitionNum: 0
        password: string
        resourceGroupId: string
        securityGroup: string
        selectedZones:
            - string
        serverlessConfig:
            reservedPublishCapacity: 0
            reservedSubscribeCapacity: 0
        serviceVersion: string
        specType: string
        tags:
            string: string
        vpcId: string
        vswitchId: string
        vswitchIds:
            - 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:

    DeployType int
    The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:
    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:
    ConfluentConfig Pulumi.AliCloud.AliKafka.Inputs.InstanceConfluentConfig

    The configurations of Confluent. See confluent_config below.

    NOTE: If instance_type is set to alikafka_confluent, confluent_config is required.

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

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

    NOTE: If instance_type is set to alikafka, disk_size is required.

    DiskType int
    The disk type of the instance. Valid values:
    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:
    InstanceType string
    The type of the Instance. Default value: alikafka. 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 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 billing method of the instance. Default value: PostPaid. Valid values: PostPaid, PrePaid. When modify this value, it only support adjust from PostPaid to PrePaid.
    PartitionNum int
    The number of partitions.
    Password string
    The instance password. NOTE: If instance_type is set to alikafka_confluent, password is required.
    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 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.
    ServerlessConfig Pulumi.AliCloud.AliKafka.Inputs.InstanceServerlessConfig

    The parameters configured for the serverless ApsaraMQ for Kafka instance. See serverless_config below.

    NOTE: If instance_type is set to alikafka_serverless, serverless_config is required.

    ServiceVersion string
    The version of the Instance. Valid values:

    • If instance_type is set to alikafka. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    • If instance_type is set to alikafka_serverless. Default value: 3.3.1. Valid values: 3.3.1.
    • If instance_type is set to alikafka_confluent. Default value: 7.4.0. Valid values: 7.4.0.
    SpecType string
    The instance edition. Default value: normal. Valid values:

    • If instance_type is set to alikafka. Valid values: normal, professional, professionalForHighRead.
    • If instance_type is set to alikafka_serverless. Valid values: normal.
    • If instance_type is set to alikafka_confluent. Valid values: professional, enterprise.
    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 string
    The VPC ID of the instance.
    VswitchId string
    The ID of attaching vswitch to instance.
    VswitchIds List<string>
    The IDs of the vSwitches with which the instance is associated.
    ZoneId 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 int
    The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:
    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:
    ConfluentConfig InstanceConfluentConfigArgs

    The configurations of Confluent. See confluent_config below.

    NOTE: If instance_type is set to alikafka_confluent, confluent_config is required.

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

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

    NOTE: If instance_type is set to alikafka, disk_size is required.

    DiskType int
    The disk type of the instance. Valid values:
    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:
    InstanceType string
    The type of the Instance. Default value: alikafka. 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 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 billing method of the instance. Default value: PostPaid. Valid values: PostPaid, PrePaid. When modify this value, it only support adjust from PostPaid to PrePaid.
    PartitionNum int
    The number of partitions.
    Password string
    The instance password. NOTE: If instance_type is set to alikafka_confluent, password is required.
    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 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.
    ServerlessConfig InstanceServerlessConfigArgs

    The parameters configured for the serverless ApsaraMQ for Kafka instance. See serverless_config below.

    NOTE: If instance_type is set to alikafka_serverless, serverless_config is required.

    ServiceVersion string
    The version of the Instance. Valid values:

    • If instance_type is set to alikafka. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    • If instance_type is set to alikafka_serverless. Default value: 3.3.1. Valid values: 3.3.1.
    • If instance_type is set to alikafka_confluent. Default value: 7.4.0. Valid values: 7.4.0.
    SpecType string
    The instance edition. Default value: normal. Valid values:

    • If instance_type is set to alikafka. Valid values: normal, professional, professionalForHighRead.
    • If instance_type is set to alikafka_serverless. Valid values: normal.
    • If instance_type is set to alikafka_confluent. Valid values: professional, enterprise.
    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 string
    The VPC ID of the instance.
    VswitchId string
    The ID of attaching vswitch to instance.
    VswitchIds []string
    The IDs of the vSwitches with which the instance is associated.
    ZoneId 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 Integer
    The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:
    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:
    confluentConfig InstanceConfluentConfig

    The configurations of Confluent. See confluent_config below.

    NOTE: If instance_type is set to alikafka_confluent, confluent_config is required.

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

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

    NOTE: If instance_type is set to alikafka, disk_size is required.

    diskType Integer
    The disk type of the instance. Valid values:
    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:
    instanceType String
    The type of the Instance. Default value: alikafka. 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 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 billing method of the instance. Default value: PostPaid. Valid values: PostPaid, PrePaid. When modify this value, it only support adjust from PostPaid to PrePaid.
    partitionNum Integer
    The number of partitions.
    password String
    The instance password. NOTE: If instance_type is set to alikafka_confluent, password is required.
    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 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.
    serverlessConfig InstanceServerlessConfig

    The parameters configured for the serverless ApsaraMQ for Kafka instance. See serverless_config below.

    NOTE: If instance_type is set to alikafka_serverless, serverless_config is required.

    serviceVersion String
    The version of the Instance. Valid values:

    • If instance_type is set to alikafka. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    • If instance_type is set to alikafka_serverless. Default value: 3.3.1. Valid values: 3.3.1.
    • If instance_type is set to alikafka_confluent. Default value: 7.4.0. Valid values: 7.4.0.
    specType String
    The instance edition. Default value: normal. Valid values:

    • If instance_type is set to alikafka. Valid values: normal, professional, professionalForHighRead.
    • If instance_type is set to alikafka_serverless. Valid values: normal.
    • If instance_type is set to alikafka_confluent. Valid values: professional, enterprise.
    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 String
    The VPC ID of the instance.
    vswitchId String
    The ID of attaching vswitch to instance.
    vswitchIds List<String>
    The IDs of the vSwitches with which the instance is associated.
    zoneId 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 number
    The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:
    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:
    confluentConfig InstanceConfluentConfig

    The configurations of Confluent. See confluent_config below.

    NOTE: If instance_type is set to alikafka_confluent, confluent_config is required.

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

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

    NOTE: If instance_type is set to alikafka, disk_size is required.

    diskType number
    The disk type of the instance. Valid values:
    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:
    instanceType string
    The type of the Instance. Default value: alikafka. 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 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 billing method of the instance. Default value: PostPaid. Valid values: PostPaid, PrePaid. When modify this value, it only support adjust from PostPaid to PrePaid.
    partitionNum number
    The number of partitions.
    password string
    The instance password. NOTE: If instance_type is set to alikafka_confluent, password is required.
    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 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.
    serverlessConfig InstanceServerlessConfig

    The parameters configured for the serverless ApsaraMQ for Kafka instance. See serverless_config below.

    NOTE: If instance_type is set to alikafka_serverless, serverless_config is required.

    serviceVersion string
    The version of the Instance. Valid values:

    • If instance_type is set to alikafka. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    • If instance_type is set to alikafka_serverless. Default value: 3.3.1. Valid values: 3.3.1.
    • If instance_type is set to alikafka_confluent. Default value: 7.4.0. Valid values: 7.4.0.
    specType string
    The instance edition. Default value: normal. Valid values:

    • If instance_type is set to alikafka. Valid values: normal, professional, professionalForHighRead.
    • If instance_type is set to alikafka_serverless. Valid values: normal.
    • If instance_type is set to alikafka_confluent. Valid values: professional, enterprise.
    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 string
    The VPC ID of the instance.
    vswitchId string
    The ID of attaching vswitch to instance.
    vswitchIds string[]
    The IDs of the vSwitches with which the instance is associated.
    zoneId 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 int
    The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:
    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:
    confluent_config InstanceConfluentConfigArgs

    The configurations of Confluent. See confluent_config below.

    NOTE: If instance_type is set to alikafka_confluent, confluent_config is required.

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

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

    NOTE: If instance_type is set to alikafka, disk_size is required.

    disk_type int
    The disk type of the instance. Valid values:
    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:
    instance_type str
    The type of the Instance. Default value: alikafka. 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 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 billing method of the instance. Default value: PostPaid. Valid values: PostPaid, PrePaid. When modify this value, it only support adjust from PostPaid to PrePaid.
    partition_num int
    The number of partitions.
    password str
    The instance password. NOTE: If instance_type is set to alikafka_confluent, password is required.
    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 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.
    serverless_config InstanceServerlessConfigArgs

    The parameters configured for the serverless ApsaraMQ for Kafka instance. See serverless_config below.

    NOTE: If instance_type is set to alikafka_serverless, serverless_config is required.

    service_version str
    The version of the Instance. Valid values:

    • If instance_type is set to alikafka. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    • If instance_type is set to alikafka_serverless. Default value: 3.3.1. Valid values: 3.3.1.
    • If instance_type is set to alikafka_confluent. Default value: 7.4.0. Valid values: 7.4.0.
    spec_type str
    The instance edition. Default value: normal. Valid values:

    • If instance_type is set to alikafka. Valid values: normal, professional, professionalForHighRead.
    • If instance_type is set to alikafka_serverless. Valid values: normal.
    • If instance_type is set to alikafka_confluent. Valid values: professional, enterprise.
    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 str
    The VPC ID of the instance.
    vswitch_id 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 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 Number
    The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:
    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:
    confluentConfig Property Map

    The configurations of Confluent. See confluent_config below.

    NOTE: If instance_type is set to alikafka_confluent, confluent_config is required.

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

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

    NOTE: If instance_type is set to alikafka, disk_size is required.

    diskType Number
    The disk type of the instance. Valid values:
    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:
    instanceType String
    The type of the Instance. Default value: alikafka. 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 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 billing method of the instance. Default value: PostPaid. Valid values: PostPaid, PrePaid. When modify this value, it only support adjust from PostPaid to PrePaid.
    partitionNum Number
    The number of partitions.
    password String
    The instance password. NOTE: If instance_type is set to alikafka_confluent, password is required.
    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 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.
    serverlessConfig Property Map

    The parameters configured for the serverless ApsaraMQ for Kafka instance. See serverless_config below.

    NOTE: If instance_type is set to alikafka_serverless, serverless_config is required.

    serviceVersion String
    The version of the Instance. Valid values:

    • If instance_type is set to alikafka. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    • If instance_type is set to alikafka_serverless. Default value: 3.3.1. Valid values: 3.3.1.
    • If instance_type is set to alikafka_confluent. Default value: 7.4.0. Valid values: 7.4.0.
    specType String
    The instance edition. Default value: normal. Valid values:

    • If instance_type is set to alikafka. Valid values: normal, professional, professionalForHighRead.
    • If instance_type is set to alikafka_serverless. Valid values: normal.
    • If instance_type is set to alikafka_confluent. Valid values: professional, enterprise.
    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 String
    The VPC ID of the instance.
    vswitchId String
    The ID of attaching vswitch to instance.
    vswitchIds List<String>
    The IDs of the vSwitches with which the instance is associated.
    zoneId 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,
            confluent_config: Optional[InstanceConfluentConfigArgs] = 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,
            instance_type: Optional[str] = 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,
            password: Optional[str] = None,
            resource_group_id: Optional[str] = None,
            sasl_domain_endpoint: Optional[str] = None,
            security_group: Optional[str] = None,
            selected_zones: Optional[Sequence[str]] = None,
            serverless_config: Optional[InstanceServerlessConfigArgs] = 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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    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:
    ConfluentConfig Pulumi.AliCloud.AliKafka.Inputs.InstanceConfluentConfig

    The configurations of Confluent. See confluent_config below.

    NOTE: If instance_type is set to alikafka_confluent, confluent_config is required.

    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:
    DiskSize int

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

    NOTE: If instance_type is set to alikafka, disk_size is required.

    DiskType int
    The disk type of the instance. Valid values:
    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.
    InstanceType string
    The type of the Instance. Default value: alikafka. 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.
    IsPartitionBuy int
    (Available since v1.214.1) The method that you use to purchase partitions.
    KmsKeyId 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 billing method of the instance. Default value: PostPaid. Valid values: PostPaid, PrePaid. When modify this value, it only support adjust from PostPaid to PrePaid.
    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.
    Password string
    The instance password. NOTE: If instance_type is set to alikafka_confluent, password is required.
    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 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.
    ServerlessConfig Pulumi.AliCloud.AliKafka.Inputs.InstanceServerlessConfig

    The parameters configured for the serverless ApsaraMQ for Kafka instance. See serverless_config below.

    NOTE: If instance_type is set to alikafka_serverless, serverless_config is required.

    ServiceVersion string
    The version of the Instance. Valid values:

    • If instance_type is set to alikafka. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    • If instance_type is set to alikafka_serverless. Default value: 3.3.1. Valid values: 3.3.1.
    • If instance_type is set to alikafka_confluent. Default value: 7.4.0. Valid values: 7.4.0.
    SpecType string
    The instance edition. Default value: normal. Valid values:

    • If instance_type is set to alikafka. Valid values: normal, professional, professionalForHighRead.
    • If instance_type is set to alikafka_serverless. Valid values: normal.
    • If instance_type is set to alikafka_confluent. Valid values: professional, enterprise.
    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 string
    The VPC ID of the instance.
    VswitchId string
    The ID of attaching vswitch to instance.
    VswitchIds List<string>
    The IDs of the vSwitches with which the instance is associated.
    ZoneId 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:
    ConfluentConfig InstanceConfluentConfigArgs

    The configurations of Confluent. See confluent_config below.

    NOTE: If instance_type is set to alikafka_confluent, confluent_config is required.

    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:
    DiskSize int

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

    NOTE: If instance_type is set to alikafka, disk_size is required.

    DiskType int
    The disk type of the instance. Valid values:
    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.
    InstanceType string
    The type of the Instance. Default value: alikafka. 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.
    IsPartitionBuy int
    (Available since v1.214.1) The method that you use to purchase partitions.
    KmsKeyId 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 billing method of the instance. Default value: PostPaid. Valid values: PostPaid, PrePaid. When modify this value, it only support adjust from PostPaid to PrePaid.
    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.
    Password string
    The instance password. NOTE: If instance_type is set to alikafka_confluent, password is required.
    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 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.
    ServerlessConfig InstanceServerlessConfigArgs

    The parameters configured for the serverless ApsaraMQ for Kafka instance. See serverless_config below.

    NOTE: If instance_type is set to alikafka_serverless, serverless_config is required.

    ServiceVersion string
    The version of the Instance. Valid values:

    • If instance_type is set to alikafka. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    • If instance_type is set to alikafka_serverless. Default value: 3.3.1. Valid values: 3.3.1.
    • If instance_type is set to alikafka_confluent. Default value: 7.4.0. Valid values: 7.4.0.
    SpecType string
    The instance edition. Default value: normal. Valid values:

    • If instance_type is set to alikafka. Valid values: normal, professional, professionalForHighRead.
    • If instance_type is set to alikafka_serverless. Valid values: normal.
    • If instance_type is set to alikafka_confluent. Valid values: professional, enterprise.
    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 string
    The VPC ID of the instance.
    VswitchId string
    The ID of attaching vswitch to instance.
    VswitchIds []string
    The IDs of the vSwitches with which the instance is associated.
    ZoneId 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:
    confluentConfig InstanceConfluentConfig

    The configurations of Confluent. See confluent_config below.

    NOTE: If instance_type is set to alikafka_confluent, confluent_config is required.

    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:
    diskSize Integer

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

    NOTE: If instance_type is set to alikafka, disk_size is required.

    diskType Integer
    The disk type of the instance. Valid values:
    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.
    instanceType String
    The type of the Instance. Default value: alikafka. 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.
    isPartitionBuy Integer
    (Available since v1.214.1) The method that you use to purchase partitions.
    kmsKeyId 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 billing method of the instance. Default value: PostPaid. Valid values: PostPaid, PrePaid. When modify this value, it only support adjust from PostPaid to PrePaid.
    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.
    password String
    The instance password. NOTE: If instance_type is set to alikafka_confluent, password is required.
    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 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.
    serverlessConfig InstanceServerlessConfig

    The parameters configured for the serverless ApsaraMQ for Kafka instance. See serverless_config below.

    NOTE: If instance_type is set to alikafka_serverless, serverless_config is required.

    serviceVersion String
    The version of the Instance. Valid values:

    • If instance_type is set to alikafka. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    • If instance_type is set to alikafka_serverless. Default value: 3.3.1. Valid values: 3.3.1.
    • If instance_type is set to alikafka_confluent. Default value: 7.4.0. Valid values: 7.4.0.
    specType String
    The instance edition. Default value: normal. Valid values:

    • If instance_type is set to alikafka. Valid values: normal, professional, professionalForHighRead.
    • If instance_type is set to alikafka_serverless. Valid values: normal.
    • If instance_type is set to alikafka_confluent. Valid values: professional, enterprise.
    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 String
    The VPC ID of the instance.
    vswitchId String
    The ID of attaching vswitch to instance.
    vswitchIds List<String>
    The IDs of the vSwitches with which the instance is associated.
    zoneId 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:
    confluentConfig InstanceConfluentConfig

    The configurations of Confluent. See confluent_config below.

    NOTE: If instance_type is set to alikafka_confluent, confluent_config is required.

    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:
    diskSize number

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

    NOTE: If instance_type is set to alikafka, disk_size is required.

    diskType number
    The disk type of the instance. Valid values:
    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.
    instanceType string
    The type of the Instance. Default value: alikafka. 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.
    isPartitionBuy number
    (Available since v1.214.1) The method that you use to purchase partitions.
    kmsKeyId 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 billing method of the instance. Default value: PostPaid. Valid values: PostPaid, PrePaid. When modify this value, it only support adjust from PostPaid to PrePaid.
    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.
    password string
    The instance password. NOTE: If instance_type is set to alikafka_confluent, password is required.
    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 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.
    serverlessConfig InstanceServerlessConfig

    The parameters configured for the serverless ApsaraMQ for Kafka instance. See serverless_config below.

    NOTE: If instance_type is set to alikafka_serverless, serverless_config is required.

    serviceVersion string
    The version of the Instance. Valid values:

    • If instance_type is set to alikafka. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    • If instance_type is set to alikafka_serverless. Default value: 3.3.1. Valid values: 3.3.1.
    • If instance_type is set to alikafka_confluent. Default value: 7.4.0. Valid values: 7.4.0.
    specType string
    The instance edition. Default value: normal. Valid values:

    • If instance_type is set to alikafka. Valid values: normal, professional, professionalForHighRead.
    • If instance_type is set to alikafka_serverless. Valid values: normal.
    • If instance_type is set to alikafka_confluent. Valid values: professional, enterprise.
    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 string
    The VPC ID of the instance.
    vswitchId string
    The ID of attaching vswitch to instance.
    vswitchIds string[]
    The IDs of the vSwitches with which the instance is associated.
    zoneId 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:
    confluent_config InstanceConfluentConfigArgs

    The configurations of Confluent. See confluent_config below.

    NOTE: If instance_type is set to alikafka_confluent, confluent_config is required.

    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:
    disk_size int

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

    NOTE: If instance_type is set to alikafka, disk_size is required.

    disk_type int
    The disk type of the instance. Valid values:
    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.
    instance_type str
    The type of the Instance. Default value: alikafka. 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.
    is_partition_buy int
    (Available since v1.214.1) The method that you use to purchase partitions.
    kms_key_id 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 billing method of the instance. Default value: PostPaid. Valid values: PostPaid, PrePaid. When modify this value, it only support adjust from PostPaid to PrePaid.
    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.
    password str
    The instance password. NOTE: If instance_type is set to alikafka_confluent, password is required.
    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 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.
    serverless_config InstanceServerlessConfigArgs

    The parameters configured for the serverless ApsaraMQ for Kafka instance. See serverless_config below.

    NOTE: If instance_type is set to alikafka_serverless, serverless_config is required.

    service_version str
    The version of the Instance. Valid values:

    • If instance_type is set to alikafka. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    • If instance_type is set to alikafka_serverless. Default value: 3.3.1. Valid values: 3.3.1.
    • If instance_type is set to alikafka_confluent. Default value: 7.4.0. Valid values: 7.4.0.
    spec_type str
    The instance edition. Default value: normal. Valid values:

    • If instance_type is set to alikafka. Valid values: normal, professional, professionalForHighRead.
    • If instance_type is set to alikafka_serverless. Valid values: normal.
    • If instance_type is set to alikafka_confluent. Valid values: professional, enterprise.
    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 str
    The VPC ID of the instance.
    vswitch_id 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 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:
    confluentConfig Property Map

    The configurations of Confluent. See confluent_config below.

    NOTE: If instance_type is set to alikafka_confluent, confluent_config is required.

    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:
    diskSize Number

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

    NOTE: If instance_type is set to alikafka, disk_size is required.

    diskType Number
    The disk type of the instance. Valid values:
    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.
    instanceType String
    The type of the Instance. Default value: alikafka. 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.
    isPartitionBuy Number
    (Available since v1.214.1) The method that you use to purchase partitions.
    kmsKeyId 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 billing method of the instance. Default value: PostPaid. Valid values: PostPaid, PrePaid. When modify this value, it only support adjust from PostPaid to PrePaid.
    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.
    password String
    The instance password. NOTE: If instance_type is set to alikafka_confluent, password is required.
    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 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.
    serverlessConfig Property Map

    The parameters configured for the serverless ApsaraMQ for Kafka instance. See serverless_config below.

    NOTE: If instance_type is set to alikafka_serverless, serverless_config is required.

    serviceVersion String
    The version of the Instance. Valid values:

    • If instance_type is set to alikafka. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    • If instance_type is set to alikafka_serverless. Default value: 3.3.1. Valid values: 3.3.1.
    • If instance_type is set to alikafka_confluent. Default value: 7.4.0. Valid values: 7.4.0.
    specType String
    The instance edition. Default value: normal. Valid values:

    • If instance_type is set to alikafka. Valid values: normal, professional, professionalForHighRead.
    • If instance_type is set to alikafka_serverless. Valid values: normal.
    • If instance_type is set to alikafka_confluent. Valid values: professional, enterprise.
    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 String
    The VPC ID of the instance.
    vswitchId String
    The ID of attaching vswitch to instance.
    vswitchIds List<String>
    The IDs of the vSwitches with which the instance is associated.
    zoneId 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.

    Supporting Types

    InstanceConfluentConfig, InstanceConfluentConfigArgs

    ConnectCu int
    The number of CPU cores of Connect.
    ConnectReplica int
    The number of replicas of Connect.
    ControlCenterCu int
    The number of CPU cores of Control Center.
    ControlCenterReplica int
    The number of replicas of Control Center.
    ControlCenterStorage int
    The disk capacity of Control Center.
    KafkaCu int
    The number of CPU cores of the Kafka broker.
    KafkaReplica int
    The number of replicas of the Kafka broker.
    KafkaRestProxyCu int
    The number of CPU cores of Kafka Rest Proxy.
    KafkaRestProxyReplica int
    The number of replicas of Kafka Rest Proxy.
    KafkaStorage int
    The disk capacity of the Kafka broker.
    KsqlCu int
    The number of CPU cores of ksqlDB.
    KsqlReplica int
    The number of replicas of ksqlDB.
    KsqlStorage int
    The disk capacity of ksqlDB.
    SchemaRegistryCu int
    The number of CPU cores of Schema Registry.
    SchemaRegistryReplica int
    The number of replicas of Schema Registry.
    ZookeeperCu int
    The number of CPU cores of ZooKeeper.
    ZookeeperReplica int
    The number of replicas of ZooKeeper.
    ZookeeperStorage int
    The disk capacity of ZooKeeper.
    ConnectCu int
    The number of CPU cores of Connect.
    ConnectReplica int
    The number of replicas of Connect.
    ControlCenterCu int
    The number of CPU cores of Control Center.
    ControlCenterReplica int
    The number of replicas of Control Center.
    ControlCenterStorage int
    The disk capacity of Control Center.
    KafkaCu int
    The number of CPU cores of the Kafka broker.
    KafkaReplica int
    The number of replicas of the Kafka broker.
    KafkaRestProxyCu int
    The number of CPU cores of Kafka Rest Proxy.
    KafkaRestProxyReplica int
    The number of replicas of Kafka Rest Proxy.
    KafkaStorage int
    The disk capacity of the Kafka broker.
    KsqlCu int
    The number of CPU cores of ksqlDB.
    KsqlReplica int
    The number of replicas of ksqlDB.
    KsqlStorage int
    The disk capacity of ksqlDB.
    SchemaRegistryCu int
    The number of CPU cores of Schema Registry.
    SchemaRegistryReplica int
    The number of replicas of Schema Registry.
    ZookeeperCu int
    The number of CPU cores of ZooKeeper.
    ZookeeperReplica int
    The number of replicas of ZooKeeper.
    ZookeeperStorage int
    The disk capacity of ZooKeeper.
    connectCu Integer
    The number of CPU cores of Connect.
    connectReplica Integer
    The number of replicas of Connect.
    controlCenterCu Integer
    The number of CPU cores of Control Center.
    controlCenterReplica Integer
    The number of replicas of Control Center.
    controlCenterStorage Integer
    The disk capacity of Control Center.
    kafkaCu Integer
    The number of CPU cores of the Kafka broker.
    kafkaReplica Integer
    The number of replicas of the Kafka broker.
    kafkaRestProxyCu Integer
    The number of CPU cores of Kafka Rest Proxy.
    kafkaRestProxyReplica Integer
    The number of replicas of Kafka Rest Proxy.
    kafkaStorage Integer
    The disk capacity of the Kafka broker.
    ksqlCu Integer
    The number of CPU cores of ksqlDB.
    ksqlReplica Integer
    The number of replicas of ksqlDB.
    ksqlStorage Integer
    The disk capacity of ksqlDB.
    schemaRegistryCu Integer
    The number of CPU cores of Schema Registry.
    schemaRegistryReplica Integer
    The number of replicas of Schema Registry.
    zookeeperCu Integer
    The number of CPU cores of ZooKeeper.
    zookeeperReplica Integer
    The number of replicas of ZooKeeper.
    zookeeperStorage Integer
    The disk capacity of ZooKeeper.
    connectCu number
    The number of CPU cores of Connect.
    connectReplica number
    The number of replicas of Connect.
    controlCenterCu number
    The number of CPU cores of Control Center.
    controlCenterReplica number
    The number of replicas of Control Center.
    controlCenterStorage number
    The disk capacity of Control Center.
    kafkaCu number
    The number of CPU cores of the Kafka broker.
    kafkaReplica number
    The number of replicas of the Kafka broker.
    kafkaRestProxyCu number
    The number of CPU cores of Kafka Rest Proxy.
    kafkaRestProxyReplica number
    The number of replicas of Kafka Rest Proxy.
    kafkaStorage number
    The disk capacity of the Kafka broker.
    ksqlCu number
    The number of CPU cores of ksqlDB.
    ksqlReplica number
    The number of replicas of ksqlDB.
    ksqlStorage number
    The disk capacity of ksqlDB.
    schemaRegistryCu number
    The number of CPU cores of Schema Registry.
    schemaRegistryReplica number
    The number of replicas of Schema Registry.
    zookeeperCu number
    The number of CPU cores of ZooKeeper.
    zookeeperReplica number
    The number of replicas of ZooKeeper.
    zookeeperStorage number
    The disk capacity of ZooKeeper.
    connect_cu int
    The number of CPU cores of Connect.
    connect_replica int
    The number of replicas of Connect.
    control_center_cu int
    The number of CPU cores of Control Center.
    control_center_replica int
    The number of replicas of Control Center.
    control_center_storage int
    The disk capacity of Control Center.
    kafka_cu int
    The number of CPU cores of the Kafka broker.
    kafka_replica int
    The number of replicas of the Kafka broker.
    kafka_rest_proxy_cu int
    The number of CPU cores of Kafka Rest Proxy.
    kafka_rest_proxy_replica int
    The number of replicas of Kafka Rest Proxy.
    kafka_storage int
    The disk capacity of the Kafka broker.
    ksql_cu int
    The number of CPU cores of ksqlDB.
    ksql_replica int
    The number of replicas of ksqlDB.
    ksql_storage int
    The disk capacity of ksqlDB.
    schema_registry_cu int
    The number of CPU cores of Schema Registry.
    schema_registry_replica int
    The number of replicas of Schema Registry.
    zookeeper_cu int
    The number of CPU cores of ZooKeeper.
    zookeeper_replica int
    The number of replicas of ZooKeeper.
    zookeeper_storage int
    The disk capacity of ZooKeeper.
    connectCu Number
    The number of CPU cores of Connect.
    connectReplica Number
    The number of replicas of Connect.
    controlCenterCu Number
    The number of CPU cores of Control Center.
    controlCenterReplica Number
    The number of replicas of Control Center.
    controlCenterStorage Number
    The disk capacity of Control Center.
    kafkaCu Number
    The number of CPU cores of the Kafka broker.
    kafkaReplica Number
    The number of replicas of the Kafka broker.
    kafkaRestProxyCu Number
    The number of CPU cores of Kafka Rest Proxy.
    kafkaRestProxyReplica Number
    The number of replicas of Kafka Rest Proxy.
    kafkaStorage Number
    The disk capacity of the Kafka broker.
    ksqlCu Number
    The number of CPU cores of ksqlDB.
    ksqlReplica Number
    The number of replicas of ksqlDB.
    ksqlStorage Number
    The disk capacity of ksqlDB.
    schemaRegistryCu Number
    The number of CPU cores of Schema Registry.
    schemaRegistryReplica Number
    The number of replicas of Schema Registry.
    zookeeperCu Number
    The number of CPU cores of ZooKeeper.
    zookeeperReplica Number
    The number of replicas of ZooKeeper.
    zookeeperStorage Number
    The disk capacity of ZooKeeper.

    InstanceServerlessConfig, InstanceServerlessConfigArgs

    ReservedPublishCapacity int
    The reserved capacity for publishing messages.
    ReservedSubscribeCapacity int
    The reserved capacity for subscribing to message.
    ReservedPublishCapacity int
    The reserved capacity for publishing messages.
    ReservedSubscribeCapacity int
    The reserved capacity for subscribing to message.
    reservedPublishCapacity Integer
    The reserved capacity for publishing messages.
    reservedSubscribeCapacity Integer
    The reserved capacity for subscribing to message.
    reservedPublishCapacity number
    The reserved capacity for publishing messages.
    reservedSubscribeCapacity number
    The reserved capacity for subscribing to message.
    reserved_publish_capacity int
    The reserved capacity for publishing messages.
    reserved_subscribe_capacity int
    The reserved capacity for subscribing to message.
    reservedPublishCapacity Number
    The reserved capacity for publishing messages.
    reservedSubscribeCapacity Number
    The reserved capacity for subscribing to message.

    Package Details

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