InstanceProps

Properties for defining a Instance.

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

Initializer

import ros_cdk_kafka
ros_cdk_kafka.InstanceProps(
  deploy_type: typing.Union[typing.Union[int, float], IResolvable],
  deletion_force: typing.Union[bool, IResolvable] = None,
  deploy_option: typing.Union[IResolvable, DeployOptionProperty] = None,
  disk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  disk_type: typing.Union[str, IResolvable] = None,
  eip_max: typing.Union[typing.Union[int, float], IResolvable] = None,
  io_max: typing.Union[typing.Union[int, float], IResolvable] = None,
  io_max_spec: typing.Union[str, IResolvable] = None,
  open_connector: typing.Union[bool, IResolvable] = None,
  partition_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  pay_type: typing.Union[str, IResolvable] = None,
  serverless_config: typing.Union[IResolvable, ServerlessConfigProperty] = None,
  spec_type: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  topic_quota: typing.Union[typing.Union[int, float], IResolvable] = None
)

Properties

deploy_type^Required

deploy_type: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], 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.

deletion_force^Optional

deletion_force: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

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

Default is false

deploy_option^Optional

deploy_option: typing.Union[IResolvable, DeployOptionProperty]

• Type: typing.Union[ros_cdk_core.IResolvable, DeployOptionProperty]

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

disk_size^Optional

disk_size: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

disk_type^Optional

disk_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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

eip_max^Optional

eip_max: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], 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.

io_max^Optional

io_max: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], 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.

io_max_spec^Optional

io_max_spec: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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

open_connector^Optional

open_connector: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property openConnector: Whether open kafka connector or not.

partition_num^Optional

partition_num: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], 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.

pay_type^Optional

pay_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property payType: Pay by hour or month.

serverless_config^Optional

serverless_config: typing.Union[IResolvable, ServerlessConfigProperty]

• Type: typing.Union[ros_cdk_core.IResolvable, ServerlessConfigProperty]

Property serverlessConfig: The settings of the Serverless instance.

This parameter is required if you create a Serverless instance.

spec_type^Optional

spec_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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

tags: typing.List[TagsProperty]

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

topic_quota^Optional

topic_quota: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], 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.