Skip to content

InstanceProps

Properties for defining a Instance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kafka-instance

Initializer

using AlibabaCloud.SDK.ROS.CDK.Kafka;
new InstanceProps {
    object DeployType,
    object DeletionForce = null,
    object DeployOption = null,
    object DiskSize = null,
    object DiskType = null,
    object EipMax = null,
    object IoMax = null,
    object IoMaxSpec = null,
    object OpenConnector = null,
    object PartitionNum = null,
    object PayType = null,
    object ServerlessConfig = null,
    object SpecType = null,
    TagsProperty[] Tags = null,
    object TopicQuota = null
};

Properties

Name Type Description
DeployType object Property deployType: The deployment type.
DeletionForce object Property deletionForce: Whether delete all topics, consumer groups of the kafka instance and then delete instance.
DeployOption object Property deployOption: If you want to deploy instance after create at once, the VSwitchId and DeployModule parameters is required.
DiskSize object Property diskSize: The size of the disk to be configured for the Message Queue for Apache Kafka instance.
DiskType object Property diskType: The type of the disk to be configured for the Message Queue for Apache Kafka instance.
EipMax object Property eipMax: The public traffic to be configured for the Message Queue for Apache Kafka instance.
IoMax object Property ioMax: The traffic peak (not recommended).
IoMaxSpec object Property ioMaxSpec: Flow specification (recommended) The IoMax and IoMaxSpec must be optional.
OpenConnector object Property openConnector: Whether open kafka connector or not.
PartitionNum object Property partitionNum: Number of partitions(recommended).
PayType object Property payType: Pay by hour or month.
ServerlessConfig object Property serverlessConfig: The settings of the Serverless instance.
SpecType object Property specType: The edition of the Message Queue for Apache Kafka instance.
Tags TagsProperty[] Property tags: Tags to attach to instance.
TopicQuota object Property topicQuota: Number of topics (not recommended).

DeployTypeRequired

public object DeployType { get; set; }
  • Type: object

Property deployType: The deployment type.

Valid values:

  • 4: Internet/VPC instance
  • 5: VPC instance

If you are creating a Confluent series instance, you cannot select the deployment type. You can only set the value to 5. After the purchase, you can adjust whether each component is open to the Internet.


DeletionForceOptional

public object DeletionForce { get; set; }
  • Type: object

Property deletionForce: Whether delete all topics, consumer groups of the kafka instance and then delete instance.

Default is false


DeployOptionOptional

public object DeployOption { get; set; }
  • Type: object

Property deployOption: If you want to deploy instance after create at once, the VSwitchId and DeployModule parameters is required.


DiskSizeOptional

public object DiskSize { get; set; }
  • Type: object

Property diskSize: The size of the disk to be configured for the Message Queue for Apache Kafka instance.


DiskTypeOptional

public object DiskType { get; set; }
  • Type: object

Property diskType: The type of the disk to be configured for the Message Queue for Apache Kafka instance.

Valid values: 0: Ultra disk 1: SSD


EipMaxOptional

public object EipMax { get; set; }
  • Type: object

Property eipMax: The public traffic to be configured for the Message Queue for Apache Kafka instance.

This parameter must be specified when the DeployType parameter is set to 4.


IoMaxOptional

public object IoMax { get; set; }
  • Type: object

Property ioMax: The traffic peak (not recommended).

  • You must specify either IoMax or IoMaxSpec. If you specify both parameters, IoMaxSpec takes precedence. We recommend that you specify only IoMaxSpec.
  • For the valid values, see Billing.

If you are creating a Confluent series instance, you do not need to pass this parameter.


IoMaxSpecOptional

public object IoMaxSpec { get; set; }
  • Type: object

Property ioMaxSpec: Flow specification (recommended) The IoMax and IoMaxSpec must be optional.

When filling in at the same time, subject to IoMaxSpec. It is recommended that you only fill in the flow specification


OpenConnectorOptional

public object OpenConnector { get; set; }
  • Type: object

Property openConnector: Whether open kafka connector or not.


PartitionNumOptional

public object PartitionNum { get; set; }
  • Type: object

Property partitionNum: Number of partitions(recommended).

The number of partitions to be configured for the Message Queue for Apache Kafka instance. PartitionNum and TopicQuota must be selected. It is recommended that you only fill in the number of partitions.


PayTypeOptional

public object PayType { get; set; }
  • Type: object

Property payType: Pay by hour or month.


ServerlessConfigOptional

public object ServerlessConfig { get; set; }
  • Type: object

Property serverlessConfig: The settings of the Serverless instance.

This parameter is required if you create a Serverless instance.


SpecTypeOptional

public object SpecType { get; set; }
  • Type: object

Property specType: The edition of the Message Queue for Apache Kafka instance.

Valid values: normal: Normal version professional: Professional Edition (high writing edition) professionalForHighRead: Professional Edition (high reading edition) basic: Basic Edition (only for serverless)


TagsOptional

public TagsProperty[] Tags { get; set; }

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.


TopicQuotaOptional

public object TopicQuota { get; set; }
  • Type: object

Property topicQuota: Number of topics (not recommended).

The number of topics to be configured for the Message Queue for Apache Kafka instance. PartitionNum and TopicQuota must be selected. It is recommended that you only fill in the number of partitions. The default value of this parameter varies with different peak traffic values. Additional fees are charged if the default values are exceeded. Different specifications have different default values, and extra fees are charged. For more information, see Billing.