Skip to content

TopicProps

Properties for defining a Topic.

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

Initializer 

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

Properties

Name Type Description
instanceId string | @alicloud/ros-cdk-core.IResolvable Property instanceId: The ID of the Message Queue for Apache Kafka instance where the topic is located.
remark string | @alicloud/ros-cdk-core.IResolvable Property remark: The description of the topic.
topic string | @alicloud/ros-cdk-core.IResolvable Property topic: The name of the topic.
compactTopic boolean | @alicloud/ros-cdk-core.IResolvable Property compactTopic: The log cleanup policy for the topic.
config @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property config: Supplementary configuration.
localTopic boolean | @alicloud/ros-cdk-core.IResolvable Property localTopic: The storage engine of the topic.
minInsyncReplicas number | @alicloud/ros-cdk-core.IResolvable Property minInsyncReplicas: The minimum number of ISR sync replicas.
partitionNum number | @alicloud/ros-cdk-core.IResolvable Property partitionNum: The number of partitions in the topic.
replicationFactor number | @alicloud/ros-cdk-core.IResolvable Property replicationFactor: The number of copies of the topic.
tags TagsProperty[] Property tags: Tags to attach to instance.

instanceIdRequired 

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

Property instanceId: The ID of the Message Queue for Apache Kafka instance where the topic is located.

You can call the GetInstanceList operation to query instances.

remarkRequired 

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

Property remark: The description of the topic.

The value of this parameter must meet the following requirements: The value can only contain letters, digits, hyphens (-), and underscores (_). The value must be 3 to 64 characters in length.

topicRequired 

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

Property topic: The name of the topic.

The value of this parameter must meet the following requirements: The name can only contain letters, digits, hyphens (-), and underscores (_). The name must be 3 to 64 characters in length, and will be automatically truncated if it contains more characters. The name cannot be modified after being created.

compactTopicOptional 

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

Property compactTopic: The log cleanup policy for the topic.

This parameter is available when the Local Storage mode is specified for the topic. Valid values: false: uses the default log cleanup policy. true: uses the Apache Kafka log compaction policy.

configOptional 

public readonly config: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}

Property config: Supplementary configuration.

Currently supports Key as replications. Indicates the number of Topic copies, the value type is Integer, and the value limit is 1~3. This parameter can only be specified if the LocalTopic value is true. NOTE If replications is specified in this parameter, the specified ReplicationFactor parameter no longer takes effect.

localTopicOptional 

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

Property localTopic: The storage engine of the topic.

Valid values: false: the Cloud Storage mode. true: the Local Storage mode.

minInsyncReplicasOptional 

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

Property minInsyncReplicas: The minimum number of ISR sync replicas.

This parameter can only be specified if the LocalTopic value is true. The value must be less than the number of Topic copies. The number of synchronous replicas is limited to 1~3.

partitionNumOptional 

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

Property partitionNum: The number of partitions in the topic.

Valid values: 1 to 48 We recommend that you set the number of partitions to a multiple of 6 to reduce the risk of data skew.Note:For special requirements,submit a ticket.

replicationFactorOptional 

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

Property replicationFactor: The number of copies of the topic.

This parameter can only be specified if the LocalTopic value is true. The number of copies is limited to 1~3. Note When the number of replicas is 1, there is a risk of data loss. Please set it carefully.

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.