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

deployType^Required

public readonly deployType: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

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.

deletionForce^Optional

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

deployOption^Optional

public readonly deployOption: IResolvable | DeployOptionProperty;

• Type: @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^Optional

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.

diskType^Optional

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

eipMax^Optional

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.

ioMax^Optional

public readonly ioMax: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

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.

ioMaxSpec^Optional

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

openConnector^Optional

public readonly openConnector: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property openConnector: Whether open kafka connector or not.

partitionNum^Optional

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.

payType^Optional

public readonly payType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property payType: Pay by hour or month.

serverlessConfig^Optional

public readonly serverlessConfig: IResolvable | ServerlessConfigProperty;

• Type: @alicloud/ros-cdk-core.IResolvable | ServerlessConfigProperty

Property serverlessConfig: The settings of the Serverless instance.

This parameter is required if you create a Serverless instance.

specType^Optional

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: normal: Normal version professional: Professional Edition (high writing edition) professionalForHighRead: Professional Edition (high reading edition) basic: Basic Edition (only for serverless)

tags^Optional

public readonly tags: TagsProperty[];

• Type: 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.

topicQuota^Optional

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.