Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer 

import { InstanceProps } from '@alicloud/ros-cdk-kafka'
const instanceProps: InstanceProps = { ... }

Properties

Name Type Description
deployType number | @alicloud/ros-cdk-core.IResolvable Property deployType: The deployment mode of the Message Queue for Apache Kafka instance.
deletionForce boolean | @alicloud/ros-cdk-core.IResolvable Property deletionForce: Whether delete all topics, consumer groups of the kafka instance and then delete instance.
deployOption @alicloud/ros-cdk-core.IResolvable | DeployOptionProperty Property deployOption: If you want to deploy instance after create at once, the VSwitchId and DeployModule parameters is required.
diskSize number | @alicloud/ros-cdk-core.IResolvable Property diskSize: The size of the disk to be configured for the Message Queue for Apache Kafka instance.
diskType string | @alicloud/ros-cdk-core.IResolvable Property diskType: The type of the disk to be configured for the Message Queue for Apache Kafka instance.
eipMax number | @alicloud/ros-cdk-core.IResolvable Property eipMax: The public traffic to be configured for the Message Queue for Apache Kafka instance.
ioMax number | @alicloud/ros-cdk-core.IResolvable Property ioMax: The peak traffic to be configured for the Message Queue for Apache Kafka instance.
ioMaxSpec string | @alicloud/ros-cdk-core.IResolvable Property ioMaxSpec: Flow specification (recommended) The IoMax and IoMaxSpec must be optional.
openConnector boolean | @alicloud/ros-cdk-core.IResolvable Property openConnector: Whether open kafka connector or not.
partitionNum number | @alicloud/ros-cdk-core.IResolvable Property partitionNum: Number of partitions(recommended).
payType string | @alicloud/ros-cdk-core.IResolvable Property payType: Pay by hour or month.
serverlessConfig @alicloud/ros-cdk-core.IResolvable | ServerlessConfigProperty Property serverlessConfig: Serverless instance related settings.
specType string | @alicloud/ros-cdk-core.IResolvable Property specType: The edition of the Message Queue for Apache Kafka instance.
tags TagsProperty[] Property tags: Tags to attach to instance.
topicQuota number | @alicloud/ros-cdk-core.IResolvable Property topicQuota: Number of topics (not recommended).

deployTypeRequired 

public readonly deployType: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property deployType: The deployment mode of the Message Queue for Apache Kafka instance.

Valid values: 4: Instance of the public type 5: Instance of the VPC type

deletionForceOptional 

public readonly deletionForce: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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

Default is false

deployOptionOptional 

public readonly deployOption: IResolvable | DeployOptionProperty;

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

diskSizeOptional 

public readonly diskSize: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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

diskTypeOptional 

public readonly diskType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 readonly eipMax: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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 readonly ioMax: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property ioMax: The peak traffic to be configured for the Message Queue for Apache Kafka instance.

For more information about the value range, see Billing.

ioMaxSpecOptional 

public readonly ioMaxSpec: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 readonly openConnector: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property openConnector: Whether open kafka connector or not.

partitionNumOptional 

public readonly partitionNum: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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 readonly payType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property payType: Pay by hour or month.

serverlessConfigOptional 

public readonly serverlessConfig: IResolvable | ServerlessConfigProperty;

Property serverlessConfig: Serverless instance related settings.

specTypeOptional 

public readonly specType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

Valid values: professional: Professional Edition normal: Normal version

tagsOptional 

public readonly 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 

public readonly topicQuota: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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.