Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Kafka Provider
  3. API Docs
  4. Topic
Kafka v3.9.0 published on Sunday, Mar 9, 2025 by Pulumi
pulumi/pulumi-kafka

kafka.Topic

Explore with Pulumi AI

Kafka v3.9.0 published on Sunday, Mar 9, 2025 by Pulumi
pulumi/pulumi-kafka

A resource for managing Kafka topics. Increases partition count without destroying the topic.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as kafka from "@pulumi/kafka";

const logs = new kafka.Topic("logs", {
    name: "systemd_logs",
    replicationFactor: 2,
    partitions: 100,
    config: {
        "segment.ms": "20000",
        "cleanup.policy": "compact",
    },
});
Copy
import pulumi
import pulumi_kafka as kafka

logs = kafka.Topic("logs",
    name="systemd_logs",
    replication_factor=2,
    partitions=100,
    config={
        "segment.ms": "20000",
        "cleanup.policy": "compact",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-kafka/sdk/v3/go/kafka"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kafka.NewTopic(ctx, "logs", &kafka.TopicArgs{
			Name:              pulumi.String("systemd_logs"),
			ReplicationFactor: pulumi.Int(2),
			Partitions:        pulumi.Int(100),
			Config: pulumi.StringMap{
				"segment.ms":     pulumi.String("20000"),
				"cleanup.policy": pulumi.String("compact"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Kafka = Pulumi.Kafka;

return await Deployment.RunAsync(() => 
{
    var logs = new Kafka.Topic("logs", new()
    {
        Name = "systemd_logs",
        ReplicationFactor = 2,
        Partitions = 100,
        Config = 
        {
            { "segment.ms", "20000" },
            { "cleanup.policy", "compact" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.kafka.Topic;
import com.pulumi.kafka.TopicArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var logs = new Topic("logs", TopicArgs.builder()
            .name("systemd_logs")
            .replicationFactor(2)
            .partitions(100)
            .config(Map.ofEntries(
                Map.entry("segment.ms", "20000"),
                Map.entry("cleanup.policy", "compact")
            ))
            .build());

    }
}
Copy
resources:
  logs:
    type: kafka:Topic
    properties:
      name: systemd_logs
      replicationFactor: 2
      partitions: 100
      config:
        segment.ms: '20000'
        cleanup.policy: compact
Copy

Create Topic Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Topic(name: string, args: TopicArgs, opts?: CustomResourceOptions);
@overload
def Topic(resource_name: str,
          args: TopicArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Topic(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          partitions: Optional[int] = None,
          replication_factor: Optional[int] = None,
          config: Optional[Mapping[str, str]] = None,
          name: Optional[str] = None)
func NewTopic(ctx *Context, name string, args TopicArgs, opts ...ResourceOption) (*Topic, error)
public Topic(string name, TopicArgs args, CustomResourceOptions? opts = null)
public Topic(String name, TopicArgs args)
public Topic(String name, TopicArgs args, CustomResourceOptions options)

type: kafka:Topic
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TopicArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TopicArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TopicArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TopicArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TopicArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var topicResource = new Kafka.Topic("topicResource", new()
{
    Partitions = 0,
    ReplicationFactor = 0,
    Config = 
    {
        { "string", "string" },
    },
    Name = "string",
});
Copy
example, err := kafka.NewTopic(ctx, "topicResource", &kafka.TopicArgs{
	Partitions:        pulumi.Int(0),
	ReplicationFactor: pulumi.Int(0),
	Config: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})
Copy
var topicResource = new Topic("topicResource", TopicArgs.builder()
    .partitions(0)
    .replicationFactor(0)
    .config(Map.of("string", "string"))
    .name("string")
    .build());
Copy
topic_resource = kafka.Topic("topicResource",
    partitions=0,
    replication_factor=0,
    config={
        "string": "string",
    },
    name="string")
Copy
const topicResource = new kafka.Topic("topicResource", {
    partitions: 0,
    replicationFactor: 0,
    config: {
        string: "string",
    },
    name: "string",
});
Copy
type: kafka:Topic
properties:
    config:
        string: string
    name: string
    partitions: 0
    replicationFactor: 0
Copy

Topic Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Topic resource accepts the following input properties:

Partitions This property is required. int
The number of partitions the topic should have.
ReplicationFactor This property is required. int
The number of replicas the topic should have.
Config Dictionary<string, string>
A map of string k/v attributes.
Name Changes to this property will trigger replacement. string
The name of the topic.
Partitions This property is required. int
The number of partitions the topic should have.
ReplicationFactor This property is required. int
The number of replicas the topic should have.
Config map[string]string
A map of string k/v attributes.
Name Changes to this property will trigger replacement. string
The name of the topic.
partitions This property is required. Integer
The number of partitions the topic should have.
replicationFactor This property is required. Integer
The number of replicas the topic should have.
config Map<String,String>
A map of string k/v attributes.
name Changes to this property will trigger replacement. String
The name of the topic.
partitions This property is required. number
The number of partitions the topic should have.
replicationFactor This property is required. number
The number of replicas the topic should have.
config {[key: string]: string}
A map of string k/v attributes.
name Changes to this property will trigger replacement. string
The name of the topic.
partitions This property is required. int
The number of partitions the topic should have.
replication_factor This property is required. int
The number of replicas the topic should have.
config Mapping[str, str]
A map of string k/v attributes.
name Changes to this property will trigger replacement. str
The name of the topic.
partitions This property is required. Number
The number of partitions the topic should have.
replicationFactor This property is required. Number
The number of replicas the topic should have.
config Map<String>
A map of string k/v attributes.
name Changes to this property will trigger replacement. String
The name of the topic.

Outputs

All input properties are implicitly available as output properties. Additionally, the Topic resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Topic Resource

Get an existing Topic resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TopicState, opts?: CustomResourceOptions): Topic
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        partitions: Optional[int] = None,
        replication_factor: Optional[int] = None) -> Topic
func GetTopic(ctx *Context, name string, id IDInput, state *TopicState, opts ...ResourceOption) (*Topic, error)
public static Topic Get(string name, Input<string> id, TopicState? state, CustomResourceOptions? opts = null)
public static Topic get(String name, Output<String> id, TopicState state, CustomResourceOptions options)
resources:  _:    type: kafka:Topic    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Config Dictionary<string, string>
A map of string k/v attributes.
Name Changes to this property will trigger replacement. string
The name of the topic.
Partitions int
The number of partitions the topic should have.
ReplicationFactor int
The number of replicas the topic should have.
Config map[string]string
A map of string k/v attributes.
Name Changes to this property will trigger replacement. string
The name of the topic.
Partitions int
The number of partitions the topic should have.
ReplicationFactor int
The number of replicas the topic should have.
config Map<String,String>
A map of string k/v attributes.
name Changes to this property will trigger replacement. String
The name of the topic.
partitions Integer
The number of partitions the topic should have.
replicationFactor Integer
The number of replicas the topic should have.
config {[key: string]: string}
A map of string k/v attributes.
name Changes to this property will trigger replacement. string
The name of the topic.
partitions number
The number of partitions the topic should have.
replicationFactor number
The number of replicas the topic should have.
config Mapping[str, str]
A map of string k/v attributes.
name Changes to this property will trigger replacement. str
The name of the topic.
partitions int
The number of partitions the topic should have.
replication_factor int
The number of replicas the topic should have.
config Map<String>
A map of string k/v attributes.
name Changes to this property will trigger replacement. String
The name of the topic.
partitions Number
The number of partitions the topic should have.
replicationFactor Number
The number of replicas the topic should have.

Import

Topics can be imported using their ARN, e.g.

$ pulumi import kafka:index/topic:Topic logs systemd_logs
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Kafka pulumi/pulumi-kafka
License
Apache-2.0
Notes
This Pulumi package is based on the kafka Terraform Provider.
Kafka v3.9.0 published on Sunday, Mar 9, 2025 by Pulumi
pulumi/pulumi-kafka