Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. alikafka
  5. Instance
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.alikafka.Instance

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

    Import

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

    $ pulumi import alicloud:alikafka/instance:Instance instance <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,
             vswitch_id: Optional[str] = None,
             deploy_type: Optional[int] = None,
             disk_size: Optional[int] = None,
             disk_type: Optional[int] = None,
             partition_num: Optional[int] = None,
             selected_zones: Optional[Sequence[str]] = None,
             io_max_spec: Optional[str] = None,
             kms_key_id: Optional[str] = None,
             name: Optional[str] = None,
             paid_type: Optional[str] = None,
             config: Optional[str] = None,
             resource_group_id: Optional[str] = None,
             security_group: Optional[str] = None,
             io_max: Optional[int] = None,
             service_version: Optional[str] = None,
             spec_type: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None,
             topic_quota: Optional[int] = None,
             vpc_id: Optional[str] = None,
             eip_max: Optional[int] = 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()
{
    VswitchId = "string",
    DeployType = 0,
    DiskSize = 0,
    DiskType = 0,
    PartitionNum = 0,
    SelectedZones = new[]
    {
        "string",
    },
    IoMaxSpec = "string",
    KmsKeyId = "string",
    Name = "string",
    PaidType = "string",
    Config = "string",
    ResourceGroupId = "string",
    SecurityGroup = "string",
    IoMax = 0,
    ServiceVersion = "string",
    SpecType = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VpcId = "string",
    EipMax = 0,
    ZoneId = "string",
});

    example, err := alikafka.NewInstance(ctx, "instanceResource", &alikafka.InstanceArgs{
	VswitchId:    pulumi.String("string"),
	DeployType:   pulumi.Int(0),
	DiskSize:     pulumi.Int(0),
	DiskType:     pulumi.Int(0),
	PartitionNum: pulumi.Int(0),
	SelectedZones: pulumi.StringArray{
		pulumi.String("string"),
	},
	IoMaxSpec:       pulumi.String("string"),
	KmsKeyId:        pulumi.String("string"),
	Name:            pulumi.String("string"),
	PaidType:        pulumi.String("string"),
	Config:          pulumi.String("string"),
	ResourceGroupId: pulumi.String("string"),
	SecurityGroup:   pulumi.String("string"),
	IoMax:           pulumi.Int(0),
	ServiceVersion:  pulumi.String("string"),
	SpecType:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VpcId:  pulumi.String("string"),
	EipMax: pulumi.Int(0),
	ZoneId: pulumi.String("string"),
})

    var instanceResource = new Instance("instanceResource", InstanceArgs.builder()
    .vswitchId("string")
    .deployType(0)
    .diskSize(0)
    .diskType(0)
    .partitionNum(0)
    .selectedZones("string")
    .ioMaxSpec("string")
    .kmsKeyId("string")
    .name("string")
    .paidType("string")
    .config("string")
    .resourceGroupId("string")
    .securityGroup("string")
    .ioMax(0)
    .serviceVersion("string")
    .specType("string")
    .tags(Map.of("string", "string"))
    .vpcId("string")
    .eipMax(0)
    .zoneId("string")
    .build());

    instance_resource = alicloud.alikafka.Instance("instanceResource",
    vswitch_id="string",
    deploy_type=0,
    disk_size=0,
    disk_type=0,
    partition_num=0,
    selected_zones=["string"],
    io_max_spec="string",
    kms_key_id="string",
    name="string",
    paid_type="string",
    config="string",
    resource_group_id="string",
    security_group="string",
    io_max=0,
    service_version="string",
    spec_type="string",
    tags={
        "string": "string",
    },
    vpc_id="string",
    eip_max=0,
    zone_id="string")

    const instanceResource = new alicloud.alikafka.Instance("instanceResource", {
    vswitchId: "string",
    deployType: 0,
    diskSize: 0,
    diskType: 0,
    partitionNum: 0,
    selectedZones: ["string"],
    ioMaxSpec: "string",
    kmsKeyId: "string",
    name: "string",
    paidType: "string",
    config: "string",
    resourceGroupId: "string",
    securityGroup: "string",
    ioMax: 0,
    serviceVersion: "string",
    specType: "string",
    tags: {
        string: "string",
    },
    vpcId: "string",
    eipMax: 0,
    zoneId: "string",
});

    type: alicloud:alikafka:Instance
properties:
    config: string
    deployType: 0
    diskSize: 0
    diskType: 0
    eipMax: 0
    ioMax: 0
    ioMaxSpec: string
    kmsKeyId: string
    name: string
    paidType: string
    partitionNum: 0
    resourceGroupId: string
    securityGroup: string
    selectedZones:
        - string
    serviceVersion: string
    specType: string
    tags:
        string: string
    vpcId: string
    vswitchId: string
    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:

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

    • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
    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.
    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 paid type of the instance. Support two type, "PrePaid": pre paid type instance, "PostPaid": post paid type instance. Default is PostPaid. When modify this value, it only support adjust from post pay to pre pay.
    PartitionNum int
    The number of partitions.
    ResourceGroupId string
    The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    SecurityGroup 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.

    NOTE: Arguments io_max, disk_size, topic_quota, eip_max should follow the following constraints.

    | io_max | disk_size(min-max:lag) | topic_quota(min-max:lag) | eip_max(min-max:lag) | |------|-------------|:----:|:-----:| |20 | 500-6100:100 | 50-450:1 | 1-160:1 | |30 | 800-6100:100 | 50-450:1 | 1-240:1 | |60 | 1400-6100:100 | 80-450:1 | 1-500:1 | |90 | 2100-6100:100 | 100-450:1 | 1-500:1 | |120 | 2700-6100:100 | 150-450:1 | 1-500:1 |

    ServiceVersion string
    The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    SpecType string
    The spec type of the instance. Support two type, "normal": normal version instance, "professional": professional version instance. Default is normal. When modify this value, it only support adjust from normal to professional. Note only pre paid type instance support professional specific type.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    TopicQuota int
    The max num of topic can be creation of the instance. It has been deprecated since version 1.194.0 and using partition_num instead. Currently, its value only can be set to 50 when creating it, and finally depends on partition_num value: <topic_quota> = 1000 + <partition_num>. Therefore, you can update it by updating the partition_num, and it is the only updating path.

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

    VpcId string
    The VPC ID of the instance.
    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:

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

    • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
    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.
    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 paid type of the instance. Support two type, "PrePaid": pre paid type instance, "PostPaid": post paid type instance. Default is PostPaid. When modify this value, it only support adjust from post pay to pre pay.
    PartitionNum int
    The number of partitions.
    ResourceGroupId string
    The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    SecurityGroup 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.

    NOTE: Arguments io_max, disk_size, topic_quota, eip_max should follow the following constraints.

    | io_max | disk_size(min-max:lag) | topic_quota(min-max:lag) | eip_max(min-max:lag) | |------|-------------|:----:|:-----:| |20 | 500-6100:100 | 50-450:1 | 1-160:1 | |30 | 800-6100:100 | 50-450:1 | 1-240:1 | |60 | 1400-6100:100 | 80-450:1 | 1-500:1 | |90 | 2100-6100:100 | 100-450:1 | 1-500:1 | |120 | 2700-6100:100 | 150-450:1 | 1-500:1 |

    ServiceVersion string
    The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    SpecType string
    The spec type of the instance. Support two type, "normal": normal version instance, "professional": professional version instance. Default is normal. When modify this value, it only support adjust from normal to professional. Note only pre paid type instance support professional specific type.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    TopicQuota int
    The max num of topic can be creation of the instance. It has been deprecated since version 1.194.0 and using partition_num instead. Currently, its value only can be set to 50 when creating it, and finally depends on partition_num value: <topic_quota> = 1000 + <partition_num>. Therefore, you can update it by updating the partition_num, and it is the only updating path.

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

    VpcId string
    The VPC ID of the instance.
    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:

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

    • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
    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.
    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 paid type of the instance. Support two type, "PrePaid": pre paid type instance, "PostPaid": post paid type instance. Default is PostPaid. When modify this value, it only support adjust from post pay to pre pay.
    partitionNum Integer
    The number of partitions.
    resourceGroupId String
    The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    securityGroup 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.

    NOTE: Arguments io_max, disk_size, topic_quota, eip_max should follow the following constraints.

    | io_max | disk_size(min-max:lag) | topic_quota(min-max:lag) | eip_max(min-max:lag) | |------|-------------|:----:|:-----:| |20 | 500-6100:100 | 50-450:1 | 1-160:1 | |30 | 800-6100:100 | 50-450:1 | 1-240:1 | |60 | 1400-6100:100 | 80-450:1 | 1-500:1 | |90 | 2100-6100:100 | 100-450:1 | 1-500:1 | |120 | 2700-6100:100 | 150-450:1 | 1-500:1 |

    serviceVersion String
    The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    specType String
    The spec type of the instance. Support two type, "normal": normal version instance, "professional": professional version instance. Default is normal. When modify this value, it only support adjust from normal to professional. Note only pre paid type instance support professional specific type.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    topicQuota Integer
    The max num of topic can be creation of the instance. It has been deprecated since version 1.194.0 and using partition_num instead. Currently, its value only can be set to 50 when creating it, and finally depends on partition_num value: <topic_quota> = 1000 + <partition_num>. Therefore, you can update it by updating the partition_num, and it is the only updating path.

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

    vpcId String
    The VPC ID of the instance.
    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:

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

    • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
    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.
    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 paid type of the instance. Support two type, "PrePaid": pre paid type instance, "PostPaid": post paid type instance. Default is PostPaid. When modify this value, it only support adjust from post pay to pre pay.
    partitionNum number
    The number of partitions.
    resourceGroupId string
    The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    securityGroup 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.

    NOTE: Arguments io_max, disk_size, topic_quota, eip_max should follow the following constraints.

    | io_max | disk_size(min-max:lag) | topic_quota(min-max:lag) | eip_max(min-max:lag) | |------|-------------|:----:|:-----:| |20 | 500-6100:100 | 50-450:1 | 1-160:1 | |30 | 800-6100:100 | 50-450:1 | 1-240:1 | |60 | 1400-6100:100 | 80-450:1 | 1-500:1 | |90 | 2100-6100:100 | 100-450:1 | 1-500:1 | |120 | 2700-6100:100 | 150-450:1 | 1-500:1 |

    serviceVersion string
    The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    specType string
    The spec type of the instance. Support two type, "normal": normal version instance, "professional": professional version instance. Default is normal. When modify this value, it only support adjust from normal to professional. Note only pre paid type instance support professional specific type.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    topicQuota number
    The max num of topic can be creation of the instance. It has been deprecated since version 1.194.0 and using partition_num instead. Currently, its value only can be set to 50 when creating it, and finally depends on partition_num value: <topic_quota> = 1000 + <partition_num>. Therefore, you can update it by updating the partition_num, and it is the only updating path.

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

    vpcId string
    The VPC ID of the instance.
    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:

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

    • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
    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.
    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 paid type of the instance. Support two type, "PrePaid": pre paid type instance, "PostPaid": post paid type instance. Default is PostPaid. When modify this value, it only support adjust from post pay to pre pay.
    partition_num int
    The number of partitions.
    resource_group_id str
    The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    security_group 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.

    NOTE: Arguments io_max, disk_size, topic_quota, eip_max should follow the following constraints.

    | io_max | disk_size(min-max:lag) | topic_quota(min-max:lag) | eip_max(min-max:lag) | |------|-------------|:----:|:-----:| |20 | 500-6100:100 | 50-450:1 | 1-160:1 | |30 | 800-6100:100 | 50-450:1 | 1-240:1 | |60 | 1400-6100:100 | 80-450:1 | 1-500:1 | |90 | 2100-6100:100 | 100-450:1 | 1-500:1 | |120 | 2700-6100:100 | 150-450:1 | 1-500:1 |

    service_version str
    The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    spec_type str
    The spec type of the instance. Support two type, "normal": normal version instance, "professional": professional version instance. Default is normal. When modify this value, it only support adjust from normal to professional. Note only pre paid type instance support professional specific type.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    topic_quota int
    The max num of topic can be creation of the instance. It has been deprecated since version 1.194.0 and using partition_num instead. Currently, its value only can be set to 50 when creating it, and finally depends on partition_num value: <topic_quota> = 1000 + <partition_num>. Therefore, you can update it by updating the partition_num, and it is the only updating path.

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

    vpc_id str
    The VPC ID of the instance.
    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:

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

    • enable.vpc_sasl_ssl: Specifies whether to enable VPC transmission encryption. Default value: false. Valid values:
    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.
    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 paid type of the instance. Support two type, "PrePaid": pre paid type instance, "PostPaid": post paid type instance. Default is PostPaid. When modify this value, it only support adjust from post pay to pre pay.
    partitionNum Number
    The number of partitions.
    resourceGroupId String
    The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    securityGroup 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.

    NOTE: Arguments io_max, disk_size, topic_quota, eip_max should follow the following constraints.

    | io_max | disk_size(min-max:lag) | topic_quota(min-max:lag) | eip_max(min-max:lag) | |------|-------------|:----:|:-----:| |20 | 500-6100:100 | 50-450:1 | 1-160:1 | |30 | 800-6100:100 | 50-450:1 | 1-240:1 | |60 | 1400-6100:100 | 80-450:1 | 1-500:1 | |90 | 2100-6100:100 | 100-450:1 | 1-500:1 | |120 | 2700-6100:100 | 150-450:1 | 1-500:1 |

    serviceVersion String
    The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    specType String
    The spec type of the instance. Support two type, "normal": normal version instance, "professional": professional version instance. Default is normal. When modify this value, it only support adjust from normal to professional. Note only pre paid type instance support professional specific type.
    tags Map<String>
    A mapping of tags to assign to the resource.
    topicQuota Number
    The max num of topic can be creation of the instance. It has been deprecated since version 1.194.0 and using partition_num instead. Currently, its value only can be set to 50 when creating it, and finally depends on partition_num value: <topic_quota> = 1000 + <partition_num>. Therefore, you can update it by updating the partition_num, and it is the only updating path.

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

    vpcId String
    The VPC ID of the instance.
    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,
        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,
        end_point: Optional[str] = None,
        group_left: Optional[int] = None,
        group_used: Optional[int] = None,
        io_max: Optional[int] = None,
        io_max_spec: Optional[str] = None,
        is_partition_buy: Optional[int] = None,
        kms_key_id: Optional[str] = None,
        name: Optional[str] = None,
        paid_type: Optional[str] = None,
        partition_left: Optional[int] = None,
        partition_num: Optional[int] = None,
        partition_used: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        sasl_domain_endpoint: Optional[str] = None,
        security_group: Optional[str] = None,
        selected_zones: Optional[Sequence[str]] = None,
        service_version: Optional[str] = None,
        spec_type: Optional[str] = None,
        ssl_domain_endpoint: Optional[str] = None,
        ssl_endpoint: Optional[str] = None,
        status: Optional[int] = None,
        tags: Optional[Mapping[str, str]] = None,
        topic_left: Optional[int] = None,
        topic_num_of_buy: Optional[int] = None,
        topic_quota: Optional[int] = None,
        topic_used: Optional[int] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        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)
    Resource lookup is not supported in YAML
    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:
    DeployType int
    The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

    • 4: eip/vpc instance
    • 5: vpc instance.
    DiskSize int
    The disk size of the instance. When modify this value, it only supports adjust to a greater value.
    DiskType int
    The disk type of the instance. 0: efficient cloud disk , 1: SSD.
    DomainEndpoint string
    (Available since v1.234.0) The default endpoint of the instance in domain name mode.
    EipMax int
    The max bandwidth of the instance. It will be ignored when deploy_type = 5. When modify this value, it only supports adjust to a greater value.
    EndPoint string
    The EndPoint to access the kafka instance.
    GroupLeft int
    (Available since v1.214.1) The number of available groups.
    GroupUsed int
    (Available since v1.214.1) The number of used groups.
    IoMax int
    The max value of io of the instance. When modify this value, it only support adjust to a greater value.
    IoMaxSpec string
    The traffic specification of the instance. We recommend that you configure this parameter.

    • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
    • For more information about the valid values, see Billing.
    IsPartitionBuy int
    (Available since v1.214.1) The method that you use to purchase partitions.
    KmsKeyId string
    The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
    Name string
    Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
    PaidType string
    The paid type of the instance. Support two type, "PrePaid": pre paid type instance, "PostPaid": post paid type instance. Default is PostPaid. When modify this value, it only support adjust from post pay to pre pay.
    PartitionLeft int
    (Available since v1.214.1) The number of available partitions.
    PartitionNum int
    The number of partitions.
    PartitionUsed int
    (Available since v1.214.1) The number of used partitions.
    ResourceGroupId string
    The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    SaslDomainEndpoint string
    (Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
    SecurityGroup 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.

    NOTE: Arguments io_max, disk_size, topic_quota, eip_max should follow the following constraints.

    | io_max | disk_size(min-max:lag) | topic_quota(min-max:lag) | eip_max(min-max:lag) | |------|-------------|:----:|:-----:| |20 | 500-6100:100 | 50-450:1 | 1-160:1 | |30 | 800-6100:100 | 50-450:1 | 1-240:1 | |60 | 1400-6100:100 | 80-450:1 | 1-500:1 | |90 | 2100-6100:100 | 100-450:1 | 1-500:1 | |120 | 2700-6100:100 | 150-450:1 | 1-500:1 |

    ServiceVersion string
    The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    SpecType string
    The spec type of the instance. Support two type, "normal": normal version instance, "professional": professional version instance. Default is normal. When modify this value, it only support adjust from normal to professional. Note only pre paid type instance support professional specific type.
    SslDomainEndpoint string
    (Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
    SslEndpoint string
    (Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
    Status int
    The status of the instance.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    TopicLeft int
    (Available since v1.214.1) The number of available topics.
    TopicNumOfBuy int
    (Available since v1.214.1) The number of purchased topics.
    TopicQuota int
    The max num of topic can be creation of the instance. It has been deprecated since version 1.194.0 and using partition_num instead. Currently, its value only can be set to 50 when creating it, and finally depends on partition_num value: <topic_quota> = 1000 + <partition_num>. Therefore, you can update it by updating the partition_num, and it is the only updating path.

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

    TopicUsed int
    (Available since v1.214.1) The number of used topics.
    VpcId string
    The VPC ID of the instance.
    VswitchId string
    The ID of attaching vswitch to instance.
    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:
    DeployType int
    The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

    • 4: eip/vpc instance
    • 5: vpc instance.
    DiskSize int
    The disk size of the instance. When modify this value, it only supports adjust to a greater value.
    DiskType int
    The disk type of the instance. 0: efficient cloud disk , 1: SSD.
    DomainEndpoint string
    (Available since v1.234.0) The default endpoint of the instance in domain name mode.
    EipMax int
    The max bandwidth of the instance. It will be ignored when deploy_type = 5. When modify this value, it only supports adjust to a greater value.
    EndPoint string
    The EndPoint to access the kafka instance.
    GroupLeft int
    (Available since v1.214.1) The number of available groups.
    GroupUsed int
    (Available since v1.214.1) The number of used groups.
    IoMax int
    The max value of io of the instance. When modify this value, it only support adjust to a greater value.
    IoMaxSpec string
    The traffic specification of the instance. We recommend that you configure this parameter.

    • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
    • For more information about the valid values, see Billing.
    IsPartitionBuy int
    (Available since v1.214.1) The method that you use to purchase partitions.
    KmsKeyId string
    The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
    Name string
    Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
    PaidType string
    The paid type of the instance. Support two type, "PrePaid": pre paid type instance, "PostPaid": post paid type instance. Default is PostPaid. When modify this value, it only support adjust from post pay to pre pay.
    PartitionLeft int
    (Available since v1.214.1) The number of available partitions.
    PartitionNum int
    The number of partitions.
    PartitionUsed int
    (Available since v1.214.1) The number of used partitions.
    ResourceGroupId string
    The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    SaslDomainEndpoint string
    (Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
    SecurityGroup 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.

    NOTE: Arguments io_max, disk_size, topic_quota, eip_max should follow the following constraints.

    | io_max | disk_size(min-max:lag) | topic_quota(min-max:lag) | eip_max(min-max:lag) | |------|-------------|:----:|:-----:| |20 | 500-6100:100 | 50-450:1 | 1-160:1 | |30 | 800-6100:100 | 50-450:1 | 1-240:1 | |60 | 1400-6100:100 | 80-450:1 | 1-500:1 | |90 | 2100-6100:100 | 100-450:1 | 1-500:1 | |120 | 2700-6100:100 | 150-450:1 | 1-500:1 |

    ServiceVersion string
    The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    SpecType string
    The spec type of the instance. Support two type, "normal": normal version instance, "professional": professional version instance. Default is normal. When modify this value, it only support adjust from normal to professional. Note only pre paid type instance support professional specific type.
    SslDomainEndpoint string
    (Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
    SslEndpoint string
    (Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
    Status int
    The status of the instance.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    TopicLeft int
    (Available since v1.214.1) The number of available topics.
    TopicNumOfBuy int
    (Available since v1.214.1) The number of purchased topics.
    TopicQuota int
    The max num of topic can be creation of the instance. It has been deprecated since version 1.194.0 and using partition_num instead. Currently, its value only can be set to 50 when creating it, and finally depends on partition_num value: <topic_quota> = 1000 + <partition_num>. Therefore, you can update it by updating the partition_num, and it is the only updating path.

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

    TopicUsed int
    (Available since v1.214.1) The number of used topics.
    VpcId string
    The VPC ID of the instance.
    VswitchId string
    The ID of attaching vswitch to instance.
    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:
    deployType Integer
    The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

    • 4: eip/vpc instance
    • 5: vpc instance.
    diskSize Integer
    The disk size of the instance. When modify this value, it only supports adjust to a greater value.
    diskType Integer
    The disk type of the instance. 0: efficient cloud disk , 1: SSD.
    domainEndpoint String
    (Available since v1.234.0) The default endpoint of the instance in domain name mode.
    eipMax Integer
    The max bandwidth of the instance. It will be ignored when deploy_type = 5. When modify this value, it only supports adjust to a greater value.
    endPoint String
    The EndPoint to access the kafka instance.
    groupLeft Integer
    (Available since v1.214.1) The number of available groups.
    groupUsed Integer
    (Available since v1.214.1) The number of used groups.
    ioMax Integer
    The max value of io of the instance. When modify this value, it only support adjust to a greater value.
    ioMaxSpec String
    The traffic specification of the instance. We recommend that you configure this parameter.

    • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
    • For more information about the valid values, see Billing.
    isPartitionBuy Integer
    (Available since v1.214.1) The method that you use to purchase partitions.
    kmsKeyId String
    The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
    name String
    Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
    paidType String
    The paid type of the instance. Support two type, "PrePaid": pre paid type instance, "PostPaid": post paid type instance. Default is PostPaid. When modify this value, it only support adjust from post pay to pre pay.
    partitionLeft Integer
    (Available since v1.214.1) The number of available partitions.
    partitionNum Integer
    The number of partitions.
    partitionUsed Integer
    (Available since v1.214.1) The number of used partitions.
    resourceGroupId String
    The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    saslDomainEndpoint String
    (Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
    securityGroup 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.

    NOTE: Arguments io_max, disk_size, topic_quota, eip_max should follow the following constraints.

    | io_max | disk_size(min-max:lag) | topic_quota(min-max:lag) | eip_max(min-max:lag) | |------|-------------|:----:|:-----:| |20 | 500-6100:100 | 50-450:1 | 1-160:1 | |30 | 800-6100:100 | 50-450:1 | 1-240:1 | |60 | 1400-6100:100 | 80-450:1 | 1-500:1 | |90 | 2100-6100:100 | 100-450:1 | 1-500:1 | |120 | 2700-6100:100 | 150-450:1 | 1-500:1 |

    serviceVersion String
    The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    specType String
    The spec type of the instance. Support two type, "normal": normal version instance, "professional": professional version instance. Default is normal. When modify this value, it only support adjust from normal to professional. Note only pre paid type instance support professional specific type.
    sslDomainEndpoint String
    (Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
    sslEndpoint String
    (Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
    status Integer
    The status of the instance.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    topicLeft Integer
    (Available since v1.214.1) The number of available topics.
    topicNumOfBuy Integer
    (Available since v1.214.1) The number of purchased topics.
    topicQuota Integer
    The max num of topic can be creation of the instance. It has been deprecated since version 1.194.0 and using partition_num instead. Currently, its value only can be set to 50 when creating it, and finally depends on partition_num value: <topic_quota> = 1000 + <partition_num>. Therefore, you can update it by updating the partition_num, and it is the only updating path.

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

    topicUsed Integer
    (Available since v1.214.1) The number of used topics.
    vpcId String
    The VPC ID of the instance.
    vswitchId String
    The ID of attaching vswitch to instance.
    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:
    deployType number
    The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

    • 4: eip/vpc instance
    • 5: vpc instance.
    diskSize number
    The disk size of the instance. When modify this value, it only supports adjust to a greater value.
    diskType number
    The disk type of the instance. 0: efficient cloud disk , 1: SSD.
    domainEndpoint string
    (Available since v1.234.0) The default endpoint of the instance in domain name mode.
    eipMax number
    The max bandwidth of the instance. It will be ignored when deploy_type = 5. When modify this value, it only supports adjust to a greater value.
    endPoint string
    The EndPoint to access the kafka instance.
    groupLeft number
    (Available since v1.214.1) The number of available groups.
    groupUsed number
    (Available since v1.214.1) The number of used groups.
    ioMax number
    The max value of io of the instance. When modify this value, it only support adjust to a greater value.
    ioMaxSpec string
    The traffic specification of the instance. We recommend that you configure this parameter.

    • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
    • For more information about the valid values, see Billing.
    isPartitionBuy number
    (Available since v1.214.1) The method that you use to purchase partitions.
    kmsKeyId string
    The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
    name string
    Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
    paidType string
    The paid type of the instance. Support two type, "PrePaid": pre paid type instance, "PostPaid": post paid type instance. Default is PostPaid. When modify this value, it only support adjust from post pay to pre pay.
    partitionLeft number
    (Available since v1.214.1) The number of available partitions.
    partitionNum number
    The number of partitions.
    partitionUsed number
    (Available since v1.214.1) The number of used partitions.
    resourceGroupId string
    The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    saslDomainEndpoint string
    (Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
    securityGroup 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.

    NOTE: Arguments io_max, disk_size, topic_quota, eip_max should follow the following constraints.

    | io_max | disk_size(min-max:lag) | topic_quota(min-max:lag) | eip_max(min-max:lag) | |------|-------------|:----:|:-----:| |20 | 500-6100:100 | 50-450:1 | 1-160:1 | |30 | 800-6100:100 | 50-450:1 | 1-240:1 | |60 | 1400-6100:100 | 80-450:1 | 1-500:1 | |90 | 2100-6100:100 | 100-450:1 | 1-500:1 | |120 | 2700-6100:100 | 150-450:1 | 1-500:1 |

    serviceVersion string
    The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    specType string
    The spec type of the instance. Support two type, "normal": normal version instance, "professional": professional version instance. Default is normal. When modify this value, it only support adjust from normal to professional. Note only pre paid type instance support professional specific type.
    sslDomainEndpoint string
    (Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
    sslEndpoint string
    (Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
    status number
    The status of the instance.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    topicLeft number
    (Available since v1.214.1) The number of available topics.
    topicNumOfBuy number
    (Available since v1.214.1) The number of purchased topics.
    topicQuota number
    The max num of topic can be creation of the instance. It has been deprecated since version 1.194.0 and using partition_num instead. Currently, its value only can be set to 50 when creating it, and finally depends on partition_num value: <topic_quota> = 1000 + <partition_num>. Therefore, you can update it by updating the partition_num, and it is the only updating path.

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

    topicUsed number
    (Available since v1.214.1) The number of used topics.
    vpcId string
    The VPC ID of the instance.
    vswitchId string
    The ID of attaching vswitch to instance.
    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:
    deploy_type int
    The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

    • 4: eip/vpc instance
    • 5: vpc instance.
    disk_size int
    The disk size of the instance. When modify this value, it only supports adjust to a greater value.
    disk_type int
    The disk type of the instance. 0: efficient cloud disk , 1: SSD.
    domain_endpoint str
    (Available since v1.234.0) The default endpoint of the instance in domain name mode.
    eip_max int
    The max bandwidth of the instance. It will be ignored when deploy_type = 5. When modify this value, it only supports adjust to a greater value.
    end_point str
    The EndPoint to access the kafka instance.
    group_left int
    (Available since v1.214.1) The number of available groups.
    group_used int
    (Available since v1.214.1) The number of used groups.
    io_max int
    The max value of io of the instance. When modify this value, it only support adjust to a greater value.
    io_max_spec str
    The traffic specification of the instance. We recommend that you configure this parameter.

    • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
    • For more information about the valid values, see Billing.
    is_partition_buy int
    (Available since v1.214.1) The method that you use to purchase partitions.
    kms_key_id str
    The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
    name str
    Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
    paid_type str
    The paid type of the instance. Support two type, "PrePaid": pre paid type instance, "PostPaid": post paid type instance. Default is PostPaid. When modify this value, it only support adjust from post pay to pre pay.
    partition_left int
    (Available since v1.214.1) The number of available partitions.
    partition_num int
    The number of partitions.
    partition_used int
    (Available since v1.214.1) The number of used partitions.
    resource_group_id str
    The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    sasl_domain_endpoint str
    (Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
    security_group 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.

    NOTE: Arguments io_max, disk_size, topic_quota, eip_max should follow the following constraints.

    | io_max | disk_size(min-max:lag) | topic_quota(min-max:lag) | eip_max(min-max:lag) | |------|-------------|:----:|:-----:| |20 | 500-6100:100 | 50-450:1 | 1-160:1 | |30 | 800-6100:100 | 50-450:1 | 1-240:1 | |60 | 1400-6100:100 | 80-450:1 | 1-500:1 | |90 | 2100-6100:100 | 100-450:1 | 1-500:1 | |120 | 2700-6100:100 | 150-450:1 | 1-500:1 |

    service_version str
    The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    spec_type str
    The spec type of the instance. Support two type, "normal": normal version instance, "professional": professional version instance. Default is normal. When modify this value, it only support adjust from normal to professional. Note only pre paid type instance support professional specific type.
    ssl_domain_endpoint str
    (Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
    ssl_endpoint str
    (Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
    status int
    The status of the instance.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    topic_left int
    (Available since v1.214.1) The number of available topics.
    topic_num_of_buy int
    (Available since v1.214.1) The number of purchased topics.
    topic_quota int
    The max num of topic can be creation of the instance. It has been deprecated since version 1.194.0 and using partition_num instead. Currently, its value only can be set to 50 when creating it, and finally depends on partition_num value: <topic_quota> = 1000 + <partition_num>. Therefore, you can update it by updating the partition_num, and it is the only updating path.

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

    topic_used int
    (Available since v1.214.1) The number of used topics.
    vpc_id str
    The VPC ID of the instance.
    vswitch_id str
    The ID of attaching vswitch to instance.
    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:
    deployType Number
    The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:

    • 4: eip/vpc instance
    • 5: vpc instance.
    diskSize Number
    The disk size of the instance. When modify this value, it only supports adjust to a greater value.
    diskType Number
    The disk type of the instance. 0: efficient cloud disk , 1: SSD.
    domainEndpoint String
    (Available since v1.234.0) The default endpoint of the instance in domain name mode.
    eipMax Number
    The max bandwidth of the instance. It will be ignored when deploy_type = 5. When modify this value, it only supports adjust to a greater value.
    endPoint String
    The EndPoint to access the kafka instance.
    groupLeft Number
    (Available since v1.214.1) The number of available groups.
    groupUsed Number
    (Available since v1.214.1) The number of used groups.
    ioMax Number
    The max value of io of the instance. When modify this value, it only support adjust to a greater value.
    ioMaxSpec String
    The traffic specification of the instance. We recommend that you configure this parameter.

    • You should specify one of the io_max and io_max_spec parameters, and io_max_spec is recommended.
    • For more information about the valid values, see Billing.
    isPartitionBuy Number
    (Available since v1.214.1) The method that you use to purchase partitions.
    kmsKeyId String
    The ID of the key that is used to encrypt data on standard SSDs in the region of the instance.
    name String
    Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
    paidType String
    The paid type of the instance. Support two type, "PrePaid": pre paid type instance, "PostPaid": post paid type instance. Default is PostPaid. When modify this value, it only support adjust from post pay to pre pay.
    partitionLeft Number
    (Available since v1.214.1) The number of available partitions.
    partitionNum Number
    The number of partitions.
    partitionUsed Number
    (Available since v1.214.1) The number of used partitions.
    resourceGroupId String
    The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    saslDomainEndpoint String
    (Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
    securityGroup 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.

    NOTE: Arguments io_max, disk_size, topic_quota, eip_max should follow the following constraints.

    | io_max | disk_size(min-max:lag) | topic_quota(min-max:lag) | eip_max(min-max:lag) | |------|-------------|:----:|:-----:| |20 | 500-6100:100 | 50-450:1 | 1-160:1 | |30 | 800-6100:100 | 50-450:1 | 1-240:1 | |60 | 1400-6100:100 | 80-450:1 | 1-500:1 | |90 | 2100-6100:100 | 100-450:1 | 1-500:1 | |120 | 2700-6100:100 | 150-450:1 | 1-500:1 |

    serviceVersion String
    The version of the ApsaraMQ for Kafka instance. Default value: 2.2.0. Valid values: 2.2.0, 2.6.2.
    specType String
    The spec type of the instance. Support two type, "normal": normal version instance, "professional": professional version instance. Default is normal. When modify this value, it only support adjust from normal to professional. Note only pre paid type instance support professional specific type.
    sslDomainEndpoint String
    (Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
    sslEndpoint String
    (Available since v1.234.0) The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode.
    status Number
    The status of the instance.
    tags Map<String>
    A mapping of tags to assign to the resource.
    topicLeft Number
    (Available since v1.214.1) The number of available topics.
    topicNumOfBuy Number
    (Available since v1.214.1) The number of purchased topics.
    topicQuota Number
    The max num of topic can be creation of the instance. It has been deprecated since version 1.194.0 and using partition_num instead. Currently, its value only can be set to 50 when creating it, and finally depends on partition_num value: <topic_quota> = 1000 + <partition_num>. Therefore, you can update it by updating the partition_num, and it is the only updating path.

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

    topicUsed Number
    (Available since v1.214.1) The number of used topics.
    vpcId String
    The VPC ID of the instance.
    vswitchId String
    The ID of attaching vswitch to instance.
    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.

    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.66.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-alicloud