Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkkafka"
&alicloudroscdkkafka.InstanceProps {
    DeployType: interface{},
    DeletionForce: interface{},
    DeployOption: interface{},
    DiskSize: interface{},
    DiskType: interface{},
    EipMax: interface{},
    IoMax: interface{},
    IoMaxSpec: interface{},
    OpenConnector: interface{},
    PartitionNum: interface{},
    PayType: interface{},
    ServerlessConfig: interface{},
    SpecType: interface{},
    Tags: *[]github.com/alibabacloud-go/ros-cdk/alicloudroscdkkafka.RosInstance.TagsProperty,
    TopicQuota: interface{},
}

Properties

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

DeployTypeRequired

DeployType interface{}
  • Type: interface{}

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

DeletionForce interface{}
  • Type: interface{}

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

Default is false


DeployOptionOptional

DeployOption interface{}
  • Type: interface{}

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


DiskSizeOptional

DiskSize interface{}
  • Type: interface{}

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


DiskTypeOptional

DiskType interface{}
  • Type: interface{}

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

EipMax interface{}
  • Type: interface{}

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

IoMax interface{}
  • Type: interface{}

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

IoMaxSpec interface{}
  • Type: interface{}

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

OpenConnector interface{}
  • Type: interface{}

Property openConnector: Whether open kafka connector or not.


PartitionNumOptional

PartitionNum interface{}
  • Type: interface{}

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

PayType interface{}
  • Type: interface{}

Property payType: Pay by hour or month.


ServerlessConfigOptional

ServerlessConfig interface{}
  • Type: interface{}

Property serverlessConfig: The settings of the Serverless instance.

This parameter is required if you create a Serverless instance.


SpecTypeOptional

SpecType interface{}
  • Type: interface{}

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

Tags *[]TagsProperty

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

TopicQuota interface{}
  • Type: interface{}

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.