AivenKafkaTopicHandle

interface AivenKafkaTopicHandle<Key extends string = string> {
[aivenKafkaTopicHandleBrand]: true;
key: Key;
kind: 'topic';
}

Plan-time reference to a topic declaration identified by its stable map key.

Remarks

Handles are created by defineAivenKafkaTopics. They are not Pulumi resources or outputs.

Type Parameters

Key extends string = string

Example

CODE

const topics = defineAivenKafkaTopics({
  orders: { create: { topicName: 'orders', partitions: 3, replication: 3 } },
});
const orders: AivenKafkaTopicHandle<'orders'> = topics.orders;

Properties

`[aivenKafkaTopicHandleBrand]: true`

readonly

Nominal topic-handle brand.

`key: Key`

readonly

Stable topic map key.

`kind: 'topic'`

readonly

Handle discriminator.