alicloud.alikafka.Instance
Explore with Pulumi AI
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:
- Deploy
Type 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:
- Confluent
Config Pulumi.Ali Cloud. Ali Kafka. Inputs. Instance Confluent Config The configurations of Confluent. See
confluent_config
below.NOTE: If
instance_type
is set toalikafka_confluent
,confluent_config
is required.- Default
Topic intPartition Num - 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 toalikafka
,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 boolGroup - Specify whether to enable the flexible group creation feature. Default value:
false
. Valid values: - Enable
Auto stringTopic - Specify whether to enable the automatic topic creation feature. Default value:
disable
. Valid values: - Instance
Type string - 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 stringSpec - The traffic specification of the instance. We recommend that you configure this parameter.
- You should specify one of the
io_max
andio_max_spec
parameters, andio_max_spec
is recommended. - For more information about the valid values, see Billing.
- You should specify one of the
- Kms
Key stringId - 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.
- Paid
Type string - The billing method of the instance. Default value:
PostPaid
. Valid values:PostPaid
,PrePaid
. When modify this value, it only support adjust fromPostPaid
toPrePaid
. - Partition
Num int - The number of partitions.
- Password string
- The instance password. NOTE: If
instance_type
is set toalikafka_confluent
,password
is required. - Resource
Group stringId - 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 string - The ID of security group for this instance. If the security group is empty, system will create a default one.
- Selected
Zones List<string> - The zones among which you want to deploy the instance.
- Serverless
Config Pulumi.Ali Cloud. Ali Kafka. Inputs. Instance Serverless Config The parameters configured for the serverless ApsaraMQ for Kafka instance. See
serverless_config
below.NOTE: If
instance_type
is set toalikafka_serverless
,serverless_config
is required.- Service
Version string - The version of the Instance. Valid values:
- If
instance_type
is set toalikafka
. Default value:2.2.0
. Valid values:2.2.0
,2.6.2
. - If
instance_type
is set toalikafka_serverless
. Default value:3.3.1
. Valid values:3.3.1
. - If
instance_type
is set toalikafka_confluent
. Default value:7.4.0
. Valid values:7.4.0
.
- If
- Spec
Type string - The instance edition. Default value:
normal
. Valid values:- If
instance_type
is set toalikafka
. Valid values:normal
,professional
,professionalForHighRead
. - If
instance_type
is set toalikafka_serverless
. Valid values:normal
. - If
instance_type
is set toalikafka_confluent
. Valid values:professional
,enterprise
.
- If
- Dictionary<string, string>
- 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 onpartition_num
value: <topic_quota
> = 1000 + <partition_num
>. Therefore, you can update it by updating thepartition_num
, and it is the only updating path. - Vpc
Id string - The VPC ID of the instance.
- Vswitch
Id string - The ID of attaching vswitch to instance.
- Vswitch
Ids List<string> - The IDs of the vSwitches with which the instance is associated.
- Zone
Id 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 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:
- Confluent
Config InstanceConfluent Config Args The configurations of Confluent. See
confluent_config
below.NOTE: If
instance_type
is set toalikafka_confluent
,confluent_config
is required.- Default
Topic intPartition Num - 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 toalikafka
,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 boolGroup - Specify whether to enable the flexible group creation feature. Default value:
false
. Valid values: - Enable
Auto stringTopic - Specify whether to enable the automatic topic creation feature. Default value:
disable
. Valid values: - Instance
Type string - 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 stringSpec - The traffic specification of the instance. We recommend that you configure this parameter.
- You should specify one of the
io_max
andio_max_spec
parameters, andio_max_spec
is recommended. - For more information about the valid values, see Billing.
- You should specify one of the
- Kms
Key stringId - 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.
- Paid
Type string - The billing method of the instance. Default value:
PostPaid
. Valid values:PostPaid
,PrePaid
. When modify this value, it only support adjust fromPostPaid
toPrePaid
. - Partition
Num int - The number of partitions.
- Password string
- The instance password. NOTE: If
instance_type
is set toalikafka_confluent
,password
is required. - Resource
Group stringId - 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 string - The ID of security group for this instance. If the security group is empty, system will create a default one.
- Selected
Zones []string - The zones among which you want to deploy the instance.
- Serverless
Config InstanceServerless Config Args The parameters configured for the serverless ApsaraMQ for Kafka instance. See
serverless_config
below.NOTE: If
instance_type
is set toalikafka_serverless
,serverless_config
is required.- Service
Version string - The version of the Instance. Valid values:
- If
instance_type
is set toalikafka
. Default value:2.2.0
. Valid values:2.2.0
,2.6.2
. - If
instance_type
is set toalikafka_serverless
. Default value:3.3.1
. Valid values:3.3.1
. - If
instance_type
is set toalikafka_confluent
. Default value:7.4.0
. Valid values:7.4.0
.
- If
- Spec
Type string - The instance edition. Default value:
normal
. Valid values:- If
instance_type
is set toalikafka
. Valid values:normal
,professional
,professionalForHighRead
. - If
instance_type
is set toalikafka_serverless
. Valid values:normal
. - If
instance_type
is set toalikafka_confluent
. Valid values:professional
,enterprise
.
- If
- map[string]string
- 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 onpartition_num
value: <topic_quota
> = 1000 + <partition_num
>. Therefore, you can update it by updating thepartition_num
, and it is the only updating path. - Vpc
Id string - The VPC ID of the instance.
- Vswitch
Id string - The ID of attaching vswitch to instance.
- Vswitch
Ids []string - The IDs of the vSwitches with which the instance is associated.
- Zone
Id 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 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:
- confluent
Config InstanceConfluent Config The configurations of Confluent. See
confluent_config
below.NOTE: If
instance_type
is set toalikafka_confluent
,confluent_config
is required.- default
Topic IntegerPartition Num - The number of partitions in a topic that is automatically created.
- disk
Size 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 toalikafka
,disk_size
is required.- disk
Type Integer - The disk type of the instance. Valid values:
- eip
Max 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. - enable
Auto BooleanGroup - Specify whether to enable the flexible group creation feature. Default value:
false
. Valid values: - enable
Auto StringTopic - Specify whether to enable the automatic topic creation feature. Default value:
disable
. Valid values: - instance
Type String - The type of the Instance. Default value:
alikafka
. Valid values: - io
Max Integer - The max value of io of the instance. When modify this value, it only support adjust to a greater value.
- io
Max StringSpec - The traffic specification of the instance. We recommend that you configure this parameter.
- You should specify one of the
io_max
andio_max_spec
parameters, andio_max_spec
is recommended. - For more information about the valid values, see Billing.
- You should specify one of the
- kms
Key StringId - 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.
- paid
Type String - The billing method of the instance. Default value:
PostPaid
. Valid values:PostPaid
,PrePaid
. When modify this value, it only support adjust fromPostPaid
toPrePaid
. - partition
Num Integer - The number of partitions.
- password String
- The instance password. NOTE: If
instance_type
is set toalikafka_confluent
,password
is required. - resource
Group StringId - 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 String - The ID of security group for this instance. If the security group is empty, system will create a default one.
- selected
Zones List<String> - The zones among which you want to deploy the instance.
- serverless
Config InstanceServerless Config The parameters configured for the serverless ApsaraMQ for Kafka instance. See
serverless_config
below.NOTE: If
instance_type
is set toalikafka_serverless
,serverless_config
is required.- service
Version String - The version of the Instance. Valid values:
- If
instance_type
is set toalikafka
. Default value:2.2.0
. Valid values:2.2.0
,2.6.2
. - If
instance_type
is set toalikafka_serverless
. Default value:3.3.1
. Valid values:3.3.1
. - If
instance_type
is set toalikafka_confluent
. Default value:7.4.0
. Valid values:7.4.0
.
- If
- spec
Type String - The instance edition. Default value:
normal
. Valid values:- If
instance_type
is set toalikafka
. Valid values:normal
,professional
,professionalForHighRead
. - If
instance_type
is set toalikafka_serverless
. Valid values:normal
. - If
instance_type
is set toalikafka_confluent
. Valid values:professional
,enterprise
.
- If
- Map<String,String>
- A mapping of tags to assign to the resource.
- topic
Quota 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 onpartition_num
value: <topic_quota
> = 1000 + <partition_num
>. Therefore, you can update it by updating thepartition_num
, and it is the only updating path. - vpc
Id String - The VPC ID of the instance.
- vswitch
Id String - The ID of attaching vswitch to instance.
- vswitch
Ids List<String> - The IDs of the vSwitches with which the instance is associated.
- zone
Id 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 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:
- confluent
Config InstanceConfluent Config The configurations of Confluent. See
confluent_config
below.NOTE: If
instance_type
is set toalikafka_confluent
,confluent_config
is required.- default
Topic numberPartition Num - The number of partitions in a topic that is automatically created.
- disk
Size 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 toalikafka
,disk_size
is required.- disk
Type number - The disk type of the instance. Valid values:
- eip
Max 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. - enable
Auto booleanGroup - Specify whether to enable the flexible group creation feature. Default value:
false
. Valid values: - enable
Auto stringTopic - Specify whether to enable the automatic topic creation feature. Default value:
disable
. Valid values: - instance
Type string - The type of the Instance. Default value:
alikafka
. Valid values: - io
Max number - The max value of io of the instance. When modify this value, it only support adjust to a greater value.
- io
Max stringSpec - The traffic specification of the instance. We recommend that you configure this parameter.
- You should specify one of the
io_max
andio_max_spec
parameters, andio_max_spec
is recommended. - For more information about the valid values, see Billing.
- You should specify one of the
- kms
Key stringId - 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.
- paid
Type string - The billing method of the instance. Default value:
PostPaid
. Valid values:PostPaid
,PrePaid
. When modify this value, it only support adjust fromPostPaid
toPrePaid
. - partition
Num number - The number of partitions.
- password string
- The instance password. NOTE: If
instance_type
is set toalikafka_confluent
,password
is required. - resource
Group stringId - 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 string - The ID of security group for this instance. If the security group is empty, system will create a default one.
- selected
Zones string[] - The zones among which you want to deploy the instance.
- serverless
Config InstanceServerless Config The parameters configured for the serverless ApsaraMQ for Kafka instance. See
serverless_config
below.NOTE: If
instance_type
is set toalikafka_serverless
,serverless_config
is required.- service
Version string - The version of the Instance. Valid values:
- If
instance_type
is set toalikafka
. Default value:2.2.0
. Valid values:2.2.0
,2.6.2
. - If
instance_type
is set toalikafka_serverless
. Default value:3.3.1
. Valid values:3.3.1
. - If
instance_type
is set toalikafka_confluent
. Default value:7.4.0
. Valid values:7.4.0
.
- If
- spec
Type string - The instance edition. Default value:
normal
. Valid values:- If
instance_type
is set toalikafka
. Valid values:normal
,professional
,professionalForHighRead
. - If
instance_type
is set toalikafka_serverless
. Valid values:normal
. - If
instance_type
is set toalikafka_confluent
. Valid values:professional
,enterprise
.
- If
- {[key: string]: string}
- A mapping of tags to assign to the resource.
- topic
Quota 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 onpartition_num
value: <topic_quota
> = 1000 + <partition_num
>. Therefore, you can update it by updating thepartition_num
, and it is the only updating path. - vpc
Id string - The VPC ID of the instance.
- vswitch
Id string - The ID of attaching vswitch to instance.
- vswitch
Ids string[] - The IDs of the vSwitches with which the instance is associated.
- zone
Id 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 InstanceConfluent Config Args The configurations of Confluent. See
confluent_config
below.NOTE: If
instance_type
is set toalikafka_confluent
,confluent_config
is required.- default_
topic_ intpartition_ num - 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 toalikafka
,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_ boolgroup - Specify whether to enable the flexible group creation feature. Default value:
false
. Valid values: - enable_
auto_ strtopic - 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_ strspec - The traffic specification of the instance. We recommend that you configure this parameter.
- You should specify one of the
io_max
andio_max_spec
parameters, andio_max_spec
is recommended. - For more information about the valid values, see Billing.
- You should specify one of the
- kms_
key_ strid - 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 fromPostPaid
toPrePaid
. - partition_
num int - The number of partitions.
- password str
- The instance password. NOTE: If
instance_type
is set toalikafka_confluent
,password
is required. - resource_
group_ strid - 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 InstanceServerless Config Args The parameters configured for the serverless ApsaraMQ for Kafka instance. See
serverless_config
below.NOTE: If
instance_type
is set toalikafka_serverless
,serverless_config
is required.- service_
version str - The version of the Instance. Valid values:
- If
instance_type
is set toalikafka
. Default value:2.2.0
. Valid values:2.2.0
,2.6.2
. - If
instance_type
is set toalikafka_serverless
. Default value:3.3.1
. Valid values:3.3.1
. - If
instance_type
is set toalikafka_confluent
. Default value:7.4.0
. Valid values:7.4.0
.
- If
- spec_
type str - The instance edition. Default value:
normal
. Valid values:- If
instance_type
is set toalikafka
. Valid values:normal
,professional
,professionalForHighRead
. - If
instance_type
is set toalikafka_serverless
. Valid values:normal
. - If
instance_type
is set toalikafka_confluent
. Valid values:professional
,enterprise
.
- If
- 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 onpartition_num
value: <topic_quota
> = 1000 + <partition_num
>. Therefore, you can update it by updating thepartition_num
, and it is the only updating path. - 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.
- deploy
Type 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:
- confluent
Config Property Map The configurations of Confluent. See
confluent_config
below.NOTE: If
instance_type
is set toalikafka_confluent
,confluent_config
is required.- default
Topic NumberPartition Num - The number of partitions in a topic that is automatically created.
- disk
Size 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 toalikafka
,disk_size
is required.- disk
Type Number - The disk type of the instance. Valid values:
- eip
Max 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. - enable
Auto BooleanGroup - Specify whether to enable the flexible group creation feature. Default value:
false
. Valid values: - enable
Auto StringTopic - Specify whether to enable the automatic topic creation feature. Default value:
disable
. Valid values: - instance
Type String - The type of the Instance. Default value:
alikafka
. Valid values: - io
Max Number - The max value of io of the instance. When modify this value, it only support adjust to a greater value.
- io
Max StringSpec - The traffic specification of the instance. We recommend that you configure this parameter.
- You should specify one of the
io_max
andio_max_spec
parameters, andio_max_spec
is recommended. - For more information about the valid values, see Billing.
- You should specify one of the
- kms
Key StringId - 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.
- paid
Type String - The billing method of the instance. Default value:
PostPaid
. Valid values:PostPaid
,PrePaid
. When modify this value, it only support adjust fromPostPaid
toPrePaid
. - partition
Num Number - The number of partitions.
- password String
- The instance password. NOTE: If
instance_type
is set toalikafka_confluent
,password
is required. - resource
Group StringId - 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 String - The ID of security group for this instance. If the security group is empty, system will create a default one.
- selected
Zones List<String> - The zones among which you want to deploy the instance.
- serverless
Config Property Map The parameters configured for the serverless ApsaraMQ for Kafka instance. See
serverless_config
below.NOTE: If
instance_type
is set toalikafka_serverless
,serverless_config
is required.- service
Version String - The version of the Instance. Valid values:
- If
instance_type
is set toalikafka
. Default value:2.2.0
. Valid values:2.2.0
,2.6.2
. - If
instance_type
is set toalikafka_serverless
. Default value:3.3.1
. Valid values:3.3.1
. - If
instance_type
is set toalikafka_confluent
. Default value:7.4.0
. Valid values:7.4.0
.
- If
- spec
Type String - The instance edition. Default value:
normal
. Valid values:- If
instance_type
is set toalikafka
. Valid values:normal
,professional
,professionalForHighRead
. - If
instance_type
is set toalikafka_serverless
. Valid values:normal
. - If
instance_type
is set toalikafka_confluent
. Valid values:professional
,enterprise
.
- If
- Map<String>
- A mapping of tags to assign to the resource.
- topic
Quota 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 onpartition_num
value: <topic_quota
> = 1000 + <partition_num
>. Therefore, you can update it by updating thepartition_num
, and it is the only updating path. - vpc
Id String - The VPC ID of the instance.
- vswitch
Id String - The ID of attaching vswitch to instance.
- vswitch
Ids List<String> - The IDs of the vSwitches with which the instance is associated.
- zone
Id 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:
- Domain
Endpoint string - (Available since v1.234.0) The default endpoint of the instance in domain name mode.
- End
Point string - 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 string
- The provider-assigned unique ID for this managed resource.
- Is
Partition intBuy - (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 stringEndpoint - (Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
- Ssl
Domain stringEndpoint - (Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
- Ssl
Endpoint 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.
- Topic
Left int - (Available since v1.214.1) The number of available topics.
- Topic
Num intOf Buy - (Available since v1.214.1) The number of purchased topics.
- Topic
Used int - (Available since v1.214.1) The number of used topics.
- Domain
Endpoint string - (Available since v1.234.0) The default endpoint of the instance in domain name mode.
- End
Point string - 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 string
- The provider-assigned unique ID for this managed resource.
- Is
Partition intBuy - (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 stringEndpoint - (Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
- Ssl
Domain stringEndpoint - (Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
- Ssl
Endpoint 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.
- Topic
Left int - (Available since v1.214.1) The number of available topics.
- Topic
Num intOf Buy - (Available since v1.214.1) The number of purchased topics.
- Topic
Used int - (Available since v1.214.1) The number of used topics.
- domain
Endpoint String - (Available since v1.234.0) The default endpoint of the instance in domain name mode.
- end
Point String - The EndPoint to access the kafka instance.
- group
Left Integer - (Available since v1.214.1) The number of available groups.
- group
Used Integer - (Available since v1.214.1) The number of used groups.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Partition IntegerBuy - (Available since v1.214.1) The method that you use to purchase partitions.
- partition
Left Integer - (Available since v1.214.1) The number of available partitions.
- partition
Used Integer - (Available since v1.214.1) The number of used partitions.
- sasl
Domain StringEndpoint - (Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
- ssl
Domain StringEndpoint - (Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
- ssl
Endpoint 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.
- topic
Left Integer - (Available since v1.214.1) The number of available topics.
- topic
Num IntegerOf Buy - (Available since v1.214.1) The number of purchased topics.
- topic
Used Integer - (Available since v1.214.1) The number of used topics.
- domain
Endpoint string - (Available since v1.234.0) The default endpoint of the instance in domain name mode.
- end
Point string - The EndPoint to access the kafka instance.
- group
Left number - (Available since v1.214.1) The number of available groups.
- group
Used number - (Available since v1.214.1) The number of used groups.
- id string
- The provider-assigned unique ID for this managed resource.
- is
Partition numberBuy - (Available since v1.214.1) The method that you use to purchase partitions.
- partition
Left number - (Available since v1.214.1) The number of available partitions.
- partition
Used number - (Available since v1.214.1) The number of used partitions.
- sasl
Domain stringEndpoint - (Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
- ssl
Domain stringEndpoint - (Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
- ssl
Endpoint 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.
- topic
Left number - (Available since v1.214.1) The number of available topics.
- topic
Num numberOf Buy - (Available since v1.214.1) The number of purchased topics.
- topic
Used 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_ intbuy - (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_ strendpoint - (Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
- ssl_
domain_ strendpoint - (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_ intof_ buy - (Available since v1.214.1) The number of purchased topics.
- topic_
used int - (Available since v1.214.1) The number of used topics.
- domain
Endpoint String - (Available since v1.234.0) The default endpoint of the instance in domain name mode.
- end
Point String - The EndPoint to access the kafka instance.
- group
Left Number - (Available since v1.214.1) The number of available groups.
- group
Used Number - (Available since v1.214.1) The number of used groups.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Partition NumberBuy - (Available since v1.214.1) The method that you use to purchase partitions.
- partition
Left Number - (Available since v1.214.1) The number of available partitions.
- partition
Used Number - (Available since v1.214.1) The number of used partitions.
- sasl
Domain StringEndpoint - (Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
- ssl
Domain StringEndpoint - (Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
- ssl
Endpoint 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.
- topic
Left Number - (Available since v1.214.1) The number of available topics.
- topic
Num NumberOf Buy - (Available since v1.214.1) The number of purchased topics.
- topic
Used 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.
- 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:
- Confluent
Config Pulumi.Ali Cloud. Ali Kafka. Inputs. Instance Confluent Config The configurations of Confluent. See
confluent_config
below.NOTE: If
instance_type
is set toalikafka_confluent
,confluent_config
is required.- Default
Topic intPartition Num - 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 toalikafka
,disk_size
is required.- Disk
Type int - The disk type of the instance. Valid values:
- Domain
Endpoint string - (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 boolGroup - Specify whether to enable the flexible group creation feature. Default value:
false
. Valid values: - Enable
Auto stringTopic - Specify whether to enable the automatic topic creation feature. Default value:
disable
. Valid values: - End
Point string - 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 string - 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 stringSpec - The traffic specification of the instance. We recommend that you configure this parameter.
- You should specify one of the
io_max
andio_max_spec
parameters, andio_max_spec
is recommended. - For more information about the valid values, see Billing.
- You should specify one of the
- Is
Partition intBuy - (Available since v1.214.1) The method that you use to purchase partitions.
- Kms
Key stringId - 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.
- Paid
Type string - The billing method of the instance. Default value:
PostPaid
. Valid values:PostPaid
,PrePaid
. When modify this value, it only support adjust fromPostPaid
toPrePaid
. - 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 string
- The instance password. NOTE: If
instance_type
is set toalikafka_confluent
,password
is required. - Resource
Group stringId - 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 stringEndpoint - (Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
- Security
Group string - The ID of security group for this instance. If the security group is empty, system will create a default one.
- Selected
Zones List<string> - The zones among which you want to deploy the instance.
- Serverless
Config Pulumi.Ali Cloud. Ali Kafka. Inputs. Instance Serverless Config The parameters configured for the serverless ApsaraMQ for Kafka instance. See
serverless_config
below.NOTE: If
instance_type
is set toalikafka_serverless
,serverless_config
is required.- Service
Version string - The version of the Instance. Valid values:
- If
instance_type
is set toalikafka
. Default value:2.2.0
. Valid values:2.2.0
,2.6.2
. - If
instance_type
is set toalikafka_serverless
. Default value:3.3.1
. Valid values:3.3.1
. - If
instance_type
is set toalikafka_confluent
. Default value:7.4.0
. Valid values:7.4.0
.
- If
- Spec
Type string - The instance edition. Default value:
normal
. Valid values:- If
instance_type
is set toalikafka
. Valid values:normal
,professional
,professionalForHighRead
. - If
instance_type
is set toalikafka_serverless
. Valid values:normal
. - If
instance_type
is set toalikafka_confluent
. Valid values:professional
,enterprise
.
- If
- Ssl
Domain stringEndpoint - (Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
- Ssl
Endpoint 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.
- Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Topic
Left int - (Available since v1.214.1) The number of available topics.
- Topic
Num intOf Buy - (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 onpartition_num
value: <topic_quota
> = 1000 + <partition_num
>. Therefore, you can update it by updating thepartition_num
, and it is the only updating path. - Topic
Used int - (Available since v1.214.1) The number of used topics.
- Vpc
Id string - The VPC ID of the instance.
- Vswitch
Id string - The ID of attaching vswitch to instance.
- Vswitch
Ids List<string> - The IDs of the vSwitches with which the instance is associated.
- Zone
Id 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:
- Confluent
Config InstanceConfluent Config Args The configurations of Confluent. See
confluent_config
below.NOTE: If
instance_type
is set toalikafka_confluent
,confluent_config
is required.- Default
Topic intPartition Num - 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 toalikafka
,disk_size
is required.- Disk
Type int - The disk type of the instance. Valid values:
- Domain
Endpoint string - (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 boolGroup - Specify whether to enable the flexible group creation feature. Default value:
false
. Valid values: - Enable
Auto stringTopic - Specify whether to enable the automatic topic creation feature. Default value:
disable
. Valid values: - End
Point string - 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 string - 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 stringSpec - The traffic specification of the instance. We recommend that you configure this parameter.
- You should specify one of the
io_max
andio_max_spec
parameters, andio_max_spec
is recommended. - For more information about the valid values, see Billing.
- You should specify one of the
- Is
Partition intBuy - (Available since v1.214.1) The method that you use to purchase partitions.
- Kms
Key stringId - 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.
- Paid
Type string - The billing method of the instance. Default value:
PostPaid
. Valid values:PostPaid
,PrePaid
. When modify this value, it only support adjust fromPostPaid
toPrePaid
. - 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 string
- The instance password. NOTE: If
instance_type
is set toalikafka_confluent
,password
is required. - Resource
Group stringId - 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 stringEndpoint - (Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
- Security
Group string - The ID of security group for this instance. If the security group is empty, system will create a default one.
- Selected
Zones []string - The zones among which you want to deploy the instance.
- Serverless
Config InstanceServerless Config Args The parameters configured for the serverless ApsaraMQ for Kafka instance. See
serverless_config
below.NOTE: If
instance_type
is set toalikafka_serverless
,serverless_config
is required.- Service
Version string - The version of the Instance. Valid values:
- If
instance_type
is set toalikafka
. Default value:2.2.0
. Valid values:2.2.0
,2.6.2
. - If
instance_type
is set toalikafka_serverless
. Default value:3.3.1
. Valid values:3.3.1
. - If
instance_type
is set toalikafka_confluent
. Default value:7.4.0
. Valid values:7.4.0
.
- If
- Spec
Type string - The instance edition. Default value:
normal
. Valid values:- If
instance_type
is set toalikafka
. Valid values:normal
,professional
,professionalForHighRead
. - If
instance_type
is set toalikafka_serverless
. Valid values:normal
. - If
instance_type
is set toalikafka_confluent
. Valid values:professional
,enterprise
.
- If
- Ssl
Domain stringEndpoint - (Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
- Ssl
Endpoint 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.
- map[string]string
- A mapping of tags to assign to the resource.
- Topic
Left int - (Available since v1.214.1) The number of available topics.
- Topic
Num intOf Buy - (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 onpartition_num
value: <topic_quota
> = 1000 + <partition_num
>. Therefore, you can update it by updating thepartition_num
, and it is the only updating path. - Topic
Used int - (Available since v1.214.1) The number of used topics.
- Vpc
Id string - The VPC ID of the instance.
- Vswitch
Id string - The ID of attaching vswitch to instance.
- Vswitch
Ids []string - The IDs of the vSwitches with which the instance is associated.
- Zone
Id 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:
- confluent
Config InstanceConfluent Config The configurations of Confluent. See
confluent_config
below.NOTE: If
instance_type
is set toalikafka_confluent
,confluent_config
is required.- default
Topic IntegerPartition Num - The number of partitions in a topic that is automatically created.
- deploy
Type Integer - The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:
- disk
Size 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 toalikafka
,disk_size
is required.- disk
Type Integer - The disk type of the instance. Valid values:
- domain
Endpoint String - (Available since v1.234.0) The default endpoint of the instance in domain name mode.
- eip
Max 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. - enable
Auto BooleanGroup - Specify whether to enable the flexible group creation feature. Default value:
false
. Valid values: - enable
Auto StringTopic - Specify whether to enable the automatic topic creation feature. Default value:
disable
. Valid values: - end
Point String - The EndPoint to access the kafka instance.
- group
Left Integer - (Available since v1.214.1) The number of available groups.
- group
Used Integer - (Available since v1.214.1) The number of used groups.
- instance
Type String - The type of the Instance. Default value:
alikafka
. Valid values: - io
Max Integer - The max value of io of the instance. When modify this value, it only support adjust to a greater value.
- io
Max StringSpec - The traffic specification of the instance. We recommend that you configure this parameter.
- You should specify one of the
io_max
andio_max_spec
parameters, andio_max_spec
is recommended. - For more information about the valid values, see Billing.
- You should specify one of the
- is
Partition IntegerBuy - (Available since v1.214.1) The method that you use to purchase partitions.
- kms
Key StringId - 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.
- paid
Type String - The billing method of the instance. Default value:
PostPaid
. Valid values:PostPaid
,PrePaid
. When modify this value, it only support adjust fromPostPaid
toPrePaid
. - partition
Left Integer - (Available since v1.214.1) The number of available partitions.
- partition
Num Integer - The number of partitions.
- partition
Used Integer - (Available since v1.214.1) The number of used partitions.
- password String
- The instance password. NOTE: If
instance_type
is set toalikafka_confluent
,password
is required. - resource
Group StringId - 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 StringEndpoint - (Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
- security
Group String - The ID of security group for this instance. If the security group is empty, system will create a default one.
- selected
Zones List<String> - The zones among which you want to deploy the instance.
- serverless
Config InstanceServerless Config The parameters configured for the serverless ApsaraMQ for Kafka instance. See
serverless_config
below.NOTE: If
instance_type
is set toalikafka_serverless
,serverless_config
is required.- service
Version String - The version of the Instance. Valid values:
- If
instance_type
is set toalikafka
. Default value:2.2.0
. Valid values:2.2.0
,2.6.2
. - If
instance_type
is set toalikafka_serverless
. Default value:3.3.1
. Valid values:3.3.1
. - If
instance_type
is set toalikafka_confluent
. Default value:7.4.0
. Valid values:7.4.0
.
- If
- spec
Type String - The instance edition. Default value:
normal
. Valid values:- If
instance_type
is set toalikafka
. Valid values:normal
,professional
,professionalForHighRead
. - If
instance_type
is set toalikafka_serverless
. Valid values:normal
. - If
instance_type
is set toalikafka_confluent
. Valid values:professional
,enterprise
.
- If
- ssl
Domain StringEndpoint - (Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
- ssl
Endpoint 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.
- Map<String,String>
- A mapping of tags to assign to the resource.
- topic
Left Integer - (Available since v1.214.1) The number of available topics.
- topic
Num IntegerOf Buy - (Available since v1.214.1) The number of purchased topics.
- topic
Quota 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 onpartition_num
value: <topic_quota
> = 1000 + <partition_num
>. Therefore, you can update it by updating thepartition_num
, and it is the only updating path. - topic
Used Integer - (Available since v1.214.1) The number of used topics.
- vpc
Id String - The VPC ID of the instance.
- vswitch
Id String - The ID of attaching vswitch to instance.
- vswitch
Ids List<String> - The IDs of the vSwitches with which the instance is associated.
- zone
Id 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:
- confluent
Config InstanceConfluent Config The configurations of Confluent. See
confluent_config
below.NOTE: If
instance_type
is set toalikafka_confluent
,confluent_config
is required.- default
Topic numberPartition Num - The number of partitions in a topic that is automatically created.
- deploy
Type number - The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:
- disk
Size 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 toalikafka
,disk_size
is required.- disk
Type number - The disk type of the instance. Valid values:
- domain
Endpoint string - (Available since v1.234.0) The default endpoint of the instance in domain name mode.
- eip
Max 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. - enable
Auto booleanGroup - Specify whether to enable the flexible group creation feature. Default value:
false
. Valid values: - enable
Auto stringTopic - Specify whether to enable the automatic topic creation feature. Default value:
disable
. Valid values: - end
Point string - The EndPoint to access the kafka instance.
- group
Left number - (Available since v1.214.1) The number of available groups.
- group
Used number - (Available since v1.214.1) The number of used groups.
- instance
Type string - The type of the Instance. Default value:
alikafka
. Valid values: - io
Max number - The max value of io of the instance. When modify this value, it only support adjust to a greater value.
- io
Max stringSpec - The traffic specification of the instance. We recommend that you configure this parameter.
- You should specify one of the
io_max
andio_max_spec
parameters, andio_max_spec
is recommended. - For more information about the valid values, see Billing.
- You should specify one of the
- is
Partition numberBuy - (Available since v1.214.1) The method that you use to purchase partitions.
- kms
Key stringId - 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.
- paid
Type string - The billing method of the instance. Default value:
PostPaid
. Valid values:PostPaid
,PrePaid
. When modify this value, it only support adjust fromPostPaid
toPrePaid
. - partition
Left number - (Available since v1.214.1) The number of available partitions.
- partition
Num number - The number of partitions.
- partition
Used number - (Available since v1.214.1) The number of used partitions.
- password string
- The instance password. NOTE: If
instance_type
is set toalikafka_confluent
,password
is required. - resource
Group stringId - 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 stringEndpoint - (Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
- security
Group string - The ID of security group for this instance. If the security group is empty, system will create a default one.
- selected
Zones string[] - The zones among which you want to deploy the instance.
- serverless
Config InstanceServerless Config The parameters configured for the serverless ApsaraMQ for Kafka instance. See
serverless_config
below.NOTE: If
instance_type
is set toalikafka_serverless
,serverless_config
is required.- service
Version string - The version of the Instance. Valid values:
- If
instance_type
is set toalikafka
. Default value:2.2.0
. Valid values:2.2.0
,2.6.2
. - If
instance_type
is set toalikafka_serverless
. Default value:3.3.1
. Valid values:3.3.1
. - If
instance_type
is set toalikafka_confluent
. Default value:7.4.0
. Valid values:7.4.0
.
- If
- spec
Type string - The instance edition. Default value:
normal
. Valid values:- If
instance_type
is set toalikafka
. Valid values:normal
,professional
,professionalForHighRead
. - If
instance_type
is set toalikafka_serverless
. Valid values:normal
. - If
instance_type
is set toalikafka_confluent
. Valid values:professional
,enterprise
.
- If
- ssl
Domain stringEndpoint - (Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
- ssl
Endpoint 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.
- {[key: string]: string}
- A mapping of tags to assign to the resource.
- topic
Left number - (Available since v1.214.1) The number of available topics.
- topic
Num numberOf Buy - (Available since v1.214.1) The number of purchased topics.
- topic
Quota 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 onpartition_num
value: <topic_quota
> = 1000 + <partition_num
>. Therefore, you can update it by updating thepartition_num
, and it is the only updating path. - topic
Used number - (Available since v1.214.1) The number of used topics.
- vpc
Id string - The VPC ID of the instance.
- vswitch
Id string - The ID of attaching vswitch to instance.
- vswitch
Ids string[] - The IDs of the vSwitches with which the instance is associated.
- zone
Id 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 InstanceConfluent Config Args The configurations of Confluent. See
confluent_config
below.NOTE: If
instance_type
is set toalikafka_confluent
,confluent_config
is required.- default_
topic_ intpartition_ num - 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 toalikafka
,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_ boolgroup - Specify whether to enable the flexible group creation feature. Default value:
false
. Valid values: - enable_
auto_ strtopic - 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_ strspec - The traffic specification of the instance. We recommend that you configure this parameter.
- You should specify one of the
io_max
andio_max_spec
parameters, andio_max_spec
is recommended. - For more information about the valid values, see Billing.
- You should specify one of the
- is_
partition_ intbuy - (Available since v1.214.1) The method that you use to purchase partitions.
- kms_
key_ strid - 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 fromPostPaid
toPrePaid
. - 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 toalikafka_confluent
,password
is required. - resource_
group_ strid - 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_ strendpoint - (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 InstanceServerless Config Args The parameters configured for the serverless ApsaraMQ for Kafka instance. See
serverless_config
below.NOTE: If
instance_type
is set toalikafka_serverless
,serverless_config
is required.- service_
version str - The version of the Instance. Valid values:
- If
instance_type
is set toalikafka
. Default value:2.2.0
. Valid values:2.2.0
,2.6.2
. - If
instance_type
is set toalikafka_serverless
. Default value:3.3.1
. Valid values:3.3.1
. - If
instance_type
is set toalikafka_confluent
. Default value:7.4.0
. Valid values:7.4.0
.
- If
- spec_
type str - The instance edition. Default value:
normal
. Valid values:- If
instance_type
is set toalikafka
. Valid values:normal
,professional
,professionalForHighRead
. - If
instance_type
is set toalikafka_serverless
. Valid values:normal
. - If
instance_type
is set toalikafka_confluent
. Valid values:professional
,enterprise
.
- If
- ssl_
domain_ strendpoint - (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.
- 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_ intof_ buy - (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 onpartition_num
value: <topic_quota
> = 1000 + <partition_num
>. Therefore, you can update it by updating thepartition_num
, and it is the only updating path. - 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:
- confluent
Config Property Map The configurations of Confluent. See
confluent_config
below.NOTE: If
instance_type
is set toalikafka_confluent
,confluent_config
is required.- default
Topic NumberPartition Num - The number of partitions in a topic that is automatically created.
- deploy
Type Number - The deployment type of the instance. NOTE: From version 1.161.0, this attribute supports to be updated. Valid values:
- disk
Size 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 toalikafka
,disk_size
is required.- disk
Type Number - The disk type of the instance. Valid values:
- domain
Endpoint String - (Available since v1.234.0) The default endpoint of the instance in domain name mode.
- eip
Max 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. - enable
Auto BooleanGroup - Specify whether to enable the flexible group creation feature. Default value:
false
. Valid values: - enable
Auto StringTopic - Specify whether to enable the automatic topic creation feature. Default value:
disable
. Valid values: - end
Point String - The EndPoint to access the kafka instance.
- group
Left Number - (Available since v1.214.1) The number of available groups.
- group
Used Number - (Available since v1.214.1) The number of used groups.
- instance
Type String - The type of the Instance. Default value:
alikafka
. Valid values: - io
Max Number - The max value of io of the instance. When modify this value, it only support adjust to a greater value.
- io
Max StringSpec - The traffic specification of the instance. We recommend that you configure this parameter.
- You should specify one of the
io_max
andio_max_spec
parameters, andio_max_spec
is recommended. - For more information about the valid values, see Billing.
- You should specify one of the
- is
Partition NumberBuy - (Available since v1.214.1) The method that you use to purchase partitions.
- kms
Key StringId - 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.
- paid
Type String - The billing method of the instance. Default value:
PostPaid
. Valid values:PostPaid
,PrePaid
. When modify this value, it only support adjust fromPostPaid
toPrePaid
. - partition
Left Number - (Available since v1.214.1) The number of available partitions.
- partition
Num Number - The number of partitions.
- partition
Used Number - (Available since v1.214.1) The number of used partitions.
- password String
- The instance password. NOTE: If
instance_type
is set toalikafka_confluent
,password
is required. - resource
Group StringId - 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 StringEndpoint - (Available since v1.234.0) The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode.
- security
Group String - The ID of security group for this instance. If the security group is empty, system will create a default one.
- selected
Zones List<String> - The zones among which you want to deploy the instance.
- serverless
Config Property Map The parameters configured for the serverless ApsaraMQ for Kafka instance. See
serverless_config
below.NOTE: If
instance_type
is set toalikafka_serverless
,serverless_config
is required.- service
Version String - The version of the Instance. Valid values:
- If
instance_type
is set toalikafka
. Default value:2.2.0
. Valid values:2.2.0
,2.6.2
. - If
instance_type
is set toalikafka_serverless
. Default value:3.3.1
. Valid values:3.3.1
. - If
instance_type
is set toalikafka_confluent
. Default value:7.4.0
. Valid values:7.4.0
.
- If
- spec
Type String - The instance edition. Default value:
normal
. Valid values:- If
instance_type
is set toalikafka
. Valid values:normal
,professional
,professionalForHighRead
. - If
instance_type
is set toalikafka_serverless
. Valid values:normal
. - If
instance_type
is set toalikafka_confluent
. Valid values:professional
,enterprise
.
- If
- ssl
Domain StringEndpoint - (Available since v1.234.0) The SSL endpoint of the instance in domain name mode.
- ssl
Endpoint 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.
- Map<String>
- A mapping of tags to assign to the resource.
- topic
Left Number - (Available since v1.214.1) The number of available topics.
- topic
Num NumberOf Buy - (Available since v1.214.1) The number of purchased topics.
- topic
Quota 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 onpartition_num
value: <topic_quota
> = 1000 + <partition_num
>. Therefore, you can update it by updating thepartition_num
, and it is the only updating path. - topic
Used Number - (Available since v1.214.1) The number of used topics.
- vpc
Id String - The VPC ID of the instance.
- vswitch
Id String - The ID of attaching vswitch to instance.
- vswitch
Ids List<String> - The IDs of the vSwitches with which the instance is associated.
- zone
Id 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
- Connect
Cu int - The number of CPU cores of Connect.
- Connect
Replica int - The number of replicas of Connect.
- Control
Center intCu - The number of CPU cores of Control Center.
- Control
Center intReplica - The number of replicas of Control Center.
- Control
Center intStorage - 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 intProxy Cu - The number of CPU cores of Kafka Rest Proxy.
- Kafka
Rest intProxy Replica - 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 intCu - The number of CPU cores of Schema Registry.
- Schema
Registry intReplica - 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.
- Connect
Cu int - The number of CPU cores of Connect.
- Connect
Replica int - The number of replicas of Connect.
- Control
Center intCu - The number of CPU cores of Control Center.
- Control
Center intReplica - The number of replicas of Control Center.
- Control
Center intStorage - 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 intProxy Cu - The number of CPU cores of Kafka Rest Proxy.
- Kafka
Rest intProxy Replica - 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 intCu - The number of CPU cores of Schema Registry.
- Schema
Registry intReplica - 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.
- connect
Cu Integer - The number of CPU cores of Connect.
- connect
Replica Integer - The number of replicas of Connect.
- control
Center IntegerCu - The number of CPU cores of Control Center.
- control
Center IntegerReplica - The number of replicas of Control Center.
- control
Center IntegerStorage - The disk capacity of Control Center.
- kafka
Cu Integer - The number of CPU cores of the Kafka broker.
- kafka
Replica Integer - The number of replicas of the Kafka broker.
- kafka
Rest IntegerProxy Cu - The number of CPU cores of Kafka Rest Proxy.
- kafka
Rest IntegerProxy Replica - The number of replicas of Kafka Rest Proxy.
- kafka
Storage Integer - The disk capacity of the Kafka broker.
- ksql
Cu Integer - The number of CPU cores of ksqlDB.
- ksql
Replica Integer - The number of replicas of ksqlDB.
- ksql
Storage Integer - The disk capacity of ksqlDB.
- schema
Registry IntegerCu - The number of CPU cores of Schema Registry.
- schema
Registry IntegerReplica - The number of replicas of Schema Registry.
- zookeeper
Cu Integer - The number of CPU cores of ZooKeeper.
- zookeeper
Replica Integer - The number of replicas of ZooKeeper.
- zookeeper
Storage Integer - The disk capacity of ZooKeeper.
- connect
Cu number - The number of CPU cores of Connect.
- connect
Replica number - The number of replicas of Connect.
- control
Center numberCu - The number of CPU cores of Control Center.
- control
Center numberReplica - The number of replicas of Control Center.
- control
Center numberStorage - The disk capacity of Control Center.
- kafka
Cu number - The number of CPU cores of the Kafka broker.
- kafka
Replica number - The number of replicas of the Kafka broker.
- kafka
Rest numberProxy Cu - The number of CPU cores of Kafka Rest Proxy.
- kafka
Rest numberProxy Replica - The number of replicas of Kafka Rest Proxy.
- kafka
Storage number - The disk capacity of the Kafka broker.
- ksql
Cu number - The number of CPU cores of ksqlDB.
- ksql
Replica number - The number of replicas of ksqlDB.
- ksql
Storage number - The disk capacity of ksqlDB.
- schema
Registry numberCu - The number of CPU cores of Schema Registry.
- schema
Registry numberReplica - The number of replicas of Schema Registry.
- zookeeper
Cu number - The number of CPU cores of ZooKeeper.
- zookeeper
Replica number - The number of replicas of ZooKeeper.
- zookeeper
Storage 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_ intcu - The number of CPU cores of Control Center.
- control_
center_ intreplica - The number of replicas of Control Center.
- control_
center_ intstorage - 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_ intproxy_ cu - The number of CPU cores of Kafka Rest Proxy.
- kafka_
rest_ intproxy_ replica - 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_ intcu - The number of CPU cores of Schema Registry.
- schema_
registry_ intreplica - 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.
- connect
Cu Number - The number of CPU cores of Connect.
- connect
Replica Number - The number of replicas of Connect.
- control
Center NumberCu - The number of CPU cores of Control Center.
- control
Center NumberReplica - The number of replicas of Control Center.
- control
Center NumberStorage - The disk capacity of Control Center.
- kafka
Cu Number - The number of CPU cores of the Kafka broker.
- kafka
Replica Number - The number of replicas of the Kafka broker.
- kafka
Rest NumberProxy Cu - The number of CPU cores of Kafka Rest Proxy.
- kafka
Rest NumberProxy Replica - The number of replicas of Kafka Rest Proxy.
- kafka
Storage Number - The disk capacity of the Kafka broker.
- ksql
Cu Number - The number of CPU cores of ksqlDB.
- ksql
Replica Number - The number of replicas of ksqlDB.
- ksql
Storage Number - The disk capacity of ksqlDB.
- schema
Registry NumberCu - The number of CPU cores of Schema Registry.
- schema
Registry NumberReplica - The number of replicas of Schema Registry.
- zookeeper
Cu Number - The number of CPU cores of ZooKeeper.
- zookeeper
Replica Number - The number of replicas of ZooKeeper.
- zookeeper
Storage Number - The disk capacity of ZooKeeper.
InstanceServerlessConfig, InstanceServerlessConfigArgs
- Reserved
Publish intCapacity - The reserved capacity for publishing messages.
- Reserved
Subscribe intCapacity - The reserved capacity for subscribing to message.
- Reserved
Publish intCapacity - The reserved capacity for publishing messages.
- Reserved
Subscribe intCapacity - The reserved capacity for subscribing to message.
- reserved
Publish IntegerCapacity - The reserved capacity for publishing messages.
- reserved
Subscribe IntegerCapacity - The reserved capacity for subscribing to message.
- reserved
Publish numberCapacity - The reserved capacity for publishing messages.
- reserved
Subscribe numberCapacity - The reserved capacity for subscribing to message.
- reserved_
publish_ intcapacity - The reserved capacity for publishing messages.
- reserved_
subscribe_ intcapacity - The reserved capacity for subscribing to message.
- reserved
Publish NumberCapacity - The reserved capacity for publishing messages.
- reserved
Subscribe NumberCapacity - 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.