Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Redpanda Provider
  3. API Docs
  4. Topic
redpanda 0.13.0 published on Monday, Mar 17, 2025 by redpanda-data
redpanda-data/terraform-provider-redpanda

redpanda.Topic

Explore with Pulumi AI

redpanda logo
redpanda 0.13.0 published on Monday, Mar 17, 2025 by redpanda-data
redpanda-data/terraform-provider-redpanda

    Topic represents a Kafka topic configuration

    Creates a topic in a Redpanda Cluster

    Usage

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

const testResourceGroup = new redpanda.ResourceGroup("testResourceGroup", {});
const config = new pulumi.Config();
const region = config.get("region") || "us-east-2";
const cloudProvider = config.get("cloudProvider") || "aws";
const testNetwork = new redpanda.Network("testNetwork", {
    resourceGroupId: testResourceGroup.id,
    cloudProvider: cloudProvider,
    region: region,
    clusterType: "dedicated",
    cidrBlock: "10.0.0.0/20",
});
const zones = config.getObject("zones") || [
    "use2-az1",
    "use2-az2",
    "use2-az3",
];
const throughputTier = config.get("throughputTier") || "tier-1-aws-v2-arm";
const testCluster = new redpanda.Cluster("testCluster", {
    resourceGroupId: testResourceGroup.id,
    networkId: testNetwork.id,
    cloudProvider: cloudProvider,
    region: region,
    clusterType: "dedicated",
    connectionType: "public",
    throughputTier: throughputTier,
    zones: zones,
    allowDeletion: true,
    tags: {
        key: "value",
    },
});
// aws_private_link = {
//   enabled         = true
//   connect_console = true
//   allowed_principals = ["arn:aws:iam::123456789024:root"]
// }
const resourceGroupName = config.get("resourceGroupName") || "testname";
const networkName = config.get("networkName") || "testname";
const clusterName = config.get("clusterName") || "testname";
const userPw = config.get("userPw") || "password";
const mechanism = config.get("mechanism") || "scram-sha-256";
const testUser = new redpanda.User("testUser", {
    password: userPw,
    mechanism: mechanism,
    clusterApiUrl: testCluster.clusterApiUrl,
});
const partitionCount = config.getNumber("partitionCount") || 3;
const replicationFactor = config.getNumber("replicationFactor") || 3;
const testTopic = new redpanda.Topic("testTopic", {
    partitionCount: partitionCount,
    replicationFactor: replicationFactor,
    clusterApiUrl: testCluster.clusterApiUrl,
    allowDeletion: true,
});
const testAcl = new redpanda.Acl("testAcl", {
    resourceType: "TOPIC",
    resourceName: testTopic.name,
    resourcePatternType: "LITERAL",
    principal: pulumi.interpolate`User:${testUser.name}`,
    host: "*",
    operation: "READ",
    permissionType: "ALLOW",
    clusterApiUrl: testCluster.clusterApiUrl,
});
const userName = config.get("userName") || "test-username";
const topicName = config.get("topicName") || "test-topic";

    import pulumi
import pulumi_redpanda as redpanda

test_resource_group = redpanda.ResourceGroup("testResourceGroup")
config = pulumi.Config()
region = config.get("region")
if region is None:
    region = "us-east-2"
cloud_provider = config.get("cloudProvider")
if cloud_provider is None:
    cloud_provider = "aws"
test_network = redpanda.Network("testNetwork",
    resource_group_id=test_resource_group.id,
    cloud_provider=cloud_provider,
    region=region,
    cluster_type="dedicated",
    cidr_block="10.0.0.0/20")
zones = config.get_object("zones")
if zones is None:
    zones = [
        "use2-az1",
        "use2-az2",
        "use2-az3",
    ]
throughput_tier = config.get("throughputTier")
if throughput_tier is None:
    throughput_tier = "tier-1-aws-v2-arm"
test_cluster = redpanda.Cluster("testCluster",
    resource_group_id=test_resource_group.id,
    network_id=test_network.id,
    cloud_provider=cloud_provider,
    region=region,
    cluster_type="dedicated",
    connection_type="public",
    throughput_tier=throughput_tier,
    zones=zones,
    allow_deletion=True,
    tags={
        "key": "value",
    })
# aws_private_link = {
#   enabled         = true
#   connect_console = true
#   allowed_principals = ["arn:aws:iam::123456789024:root"]
# }
resource_group_name = config.get("resourceGroupName")
if resource_group_name is None:
    resource_group_name = "testname"
network_name = config.get("networkName")
if network_name is None:
    network_name = "testname"
cluster_name = config.get("clusterName")
if cluster_name is None:
    cluster_name = "testname"
user_pw = config.get("userPw")
if user_pw is None:
    user_pw = "password"
mechanism = config.get("mechanism")
if mechanism is None:
    mechanism = "scram-sha-256"
test_user = redpanda.User("testUser",
    password=user_pw,
    mechanism=mechanism,
    cluster_api_url=test_cluster.cluster_api_url)
partition_count = config.get_float("partitionCount")
if partition_count is None:
    partition_count = 3
replication_factor = config.get_float("replicationFactor")
if replication_factor is None:
    replication_factor = 3
test_topic = redpanda.Topic("testTopic",
    partition_count=partition_count,
    replication_factor=replication_factor,
    cluster_api_url=test_cluster.cluster_api_url,
    allow_deletion=True)
test_acl = redpanda.Acl("testAcl",
    resource_type="TOPIC",
    resource_name_=test_topic.name,
    resource_pattern_type="LITERAL",
    principal=test_user.name.apply(lambda name: f"User:{name}"),
    host="*",
    operation="READ",
    permission_type="ALLOW",
    cluster_api_url=test_cluster.cluster_api_url)
user_name = config.get("userName")
if user_name is None:
    user_name = "test-username"
topic_name = config.get("topicName")
if topic_name is None:
    topic_name = "test-topic"

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/redpanda/redpanda"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testResourceGroup, err := redpanda.NewResourceGroup(ctx, "testResourceGroup", nil)
		if err != nil {
			return err
		}
		cfg := config.New(ctx, "")
		region := "us-east-2"
		if param := cfg.Get("region"); param != "" {
			region = param
		}
		cloudProvider := "aws"
		if param := cfg.Get("cloudProvider"); param != "" {
			cloudProvider = param
		}
		testNetwork, err := redpanda.NewNetwork(ctx, "testNetwork", &redpanda.NetworkArgs{
			ResourceGroupId: testResourceGroup.ID(),
			CloudProvider:   pulumi.String(cloudProvider),
			Region:          pulumi.String(region),
			ClusterType:     pulumi.String("dedicated"),
			CidrBlock:       pulumi.String("10.0.0.0/20"),
		})
		if err != nil {
			return err
		}
		zones := []string{
			"use2-az1",
			"use2-az2",
			"use2-az3",
		}
		if param := cfg.GetObject("zones"); param != nil {
			zones = param
		}
		throughputTier := "tier-1-aws-v2-arm"
		if param := cfg.Get("throughputTier"); param != "" {
			throughputTier = param
		}
		testCluster, err := redpanda.NewCluster(ctx, "testCluster", &redpanda.ClusterArgs{
			ResourceGroupId: testResourceGroup.ID(),
			NetworkId:       testNetwork.ID(),
			CloudProvider:   pulumi.String(cloudProvider),
			Region:          pulumi.String(region),
			ClusterType:     pulumi.String("dedicated"),
			ConnectionType:  pulumi.String("public"),
			ThroughputTier:  pulumi.String(throughputTier),
			Zones:           pulumi.Any(zones),
			AllowDeletion:   pulumi.Bool(true),
			Tags: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
		})
		if err != nil {
			return err
		}
		resourceGroupName := "testname"
		if param := cfg.Get("resourceGroupName"); param != "" {
			resourceGroupName = param
		}
		networkName := "testname"
		if param := cfg.Get("networkName"); param != "" {
			networkName = param
		}
		clusterName := "testname"
		if param := cfg.Get("clusterName"); param != "" {
			clusterName = param
		}
		userPw := "password"
		if param := cfg.Get("userPw"); param != "" {
			userPw = param
		}
		mechanism := "scram-sha-256"
		if param := cfg.Get("mechanism"); param != "" {
			mechanism = param
		}
		testUser, err := redpanda.NewUser(ctx, "testUser", &redpanda.UserArgs{
			Password:      pulumi.String(userPw),
			Mechanism:     pulumi.String(mechanism),
			ClusterApiUrl: testCluster.ClusterApiUrl,
		})
		if err != nil {
			return err
		}
		partitionCount := float64(3)
		if param := cfg.GetFloat64("partitionCount"); param != 0 {
			partitionCount = param
		}
		replicationFactor := float64(3)
		if param := cfg.GetFloat64("replicationFactor"); param != 0 {
			replicationFactor = param
		}
		testTopic, err := redpanda.NewTopic(ctx, "testTopic", &redpanda.TopicArgs{
			PartitionCount:    pulumi.Float64(partitionCount),
			ReplicationFactor: pulumi.Float64(replicationFactor),
			ClusterApiUrl:     testCluster.ClusterApiUrl,
			AllowDeletion:     pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = redpanda.NewAcl(ctx, "testAcl", &redpanda.AclArgs{
			ResourceType:        pulumi.String("TOPIC"),
			ResourceName:        testTopic.Name,
			ResourcePatternType: pulumi.String("LITERAL"),
			Principal: testUser.Name.ApplyT(func(name string) (string, error) {
				return fmt.Sprintf("User:%v", name), nil
			}).(pulumi.StringOutput),
			Host:           pulumi.String("*"),
			Operation:      pulumi.String("READ"),
			PermissionType: pulumi.String("ALLOW"),
			ClusterApiUrl:  testCluster.ClusterApiUrl,
		})
		if err != nil {
			return err
		}
		userName := "test-username"
		if param := cfg.Get("userName"); param != "" {
			userName = param
		}
		topicName := "test-topic"
		if param := cfg.Get("topicName"); param != "" {
			topicName = param
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Redpanda = Pulumi.Redpanda;

return await Deployment.RunAsync(() => 
{
    var testResourceGroup = new Redpanda.ResourceGroup("testResourceGroup");

    var config = new Config();
    var region = config.Get("region") ?? "us-east-2";
    var cloudProvider = config.Get("cloudProvider") ?? "aws";
    var testNetwork = new Redpanda.Network("testNetwork", new()
    {
        ResourceGroupId = testResourceGroup.Id,
        CloudProvider = cloudProvider,
        Region = region,
        ClusterType = "dedicated",
        CidrBlock = "10.0.0.0/20",
    });

    var zones = config.GetObject<dynamic>("zones") ?? new[]
    {
        "use2-az1",
        "use2-az2",
        "use2-az3",
    };
    var throughputTier = config.Get("throughputTier") ?? "tier-1-aws-v2-arm";
    var testCluster = new Redpanda.Cluster("testCluster", new()
    {
        ResourceGroupId = testResourceGroup.Id,
        NetworkId = testNetwork.Id,
        CloudProvider = cloudProvider,
        Region = region,
        ClusterType = "dedicated",
        ConnectionType = "public",
        ThroughputTier = throughputTier,
        Zones = zones,
        AllowDeletion = true,
        Tags = 
        {
            { "key", "value" },
        },
    });

    // aws_private_link = {
    //   enabled         = true
    //   connect_console = true
    //   allowed_principals = ["arn:aws:iam::123456789024:root"]
    // }
    var resourceGroupName = config.Get("resourceGroupName") ?? "testname";
    var networkName = config.Get("networkName") ?? "testname";
    var clusterName = config.Get("clusterName") ?? "testname";
    var userPw = config.Get("userPw") ?? "password";
    var mechanism = config.Get("mechanism") ?? "scram-sha-256";
    var testUser = new Redpanda.User("testUser", new()
    {
        Password = userPw,
        Mechanism = mechanism,
        ClusterApiUrl = testCluster.ClusterApiUrl,
    });

    var partitionCount = config.GetDouble("partitionCount") ?? 3;
    var replicationFactor = config.GetDouble("replicationFactor") ?? 3;
    var testTopic = new Redpanda.Topic("testTopic", new()
    {
        PartitionCount = partitionCount,
        ReplicationFactor = replicationFactor,
        ClusterApiUrl = testCluster.ClusterApiUrl,
        AllowDeletion = true,
    });

    var testAcl = new Redpanda.Acl("testAcl", new()
    {
        ResourceType = "TOPIC",
        ResourceName = testTopic.Name,
        ResourcePatternType = "LITERAL",
        Principal = testUser.Name.Apply(name => $"User:{name}"),
        Host = "*",
        Operation = "READ",
        PermissionType = "ALLOW",
        ClusterApiUrl = testCluster.ClusterApiUrl,
    });

    var userName = config.Get("userName") ?? "test-username";
    var topicName = config.Get("topicName") ?? "test-topic";
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.redpanda.ResourceGroup;
import com.pulumi.redpanda.Network;
import com.pulumi.redpanda.NetworkArgs;
import com.pulumi.redpanda.Cluster;
import com.pulumi.redpanda.ClusterArgs;
import com.pulumi.redpanda.User;
import com.pulumi.redpanda.UserArgs;
import com.pulumi.redpanda.Topic;
import com.pulumi.redpanda.TopicArgs;
import com.pulumi.redpanda.Acl;
import com.pulumi.redpanda.AclArgs;
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) {
        final var config = ctx.config();
        var testResourceGroup = new ResourceGroup("testResourceGroup");

        final var region = config.get("region").orElse("us-east-2");
        final var cloudProvider = config.get("cloudProvider").orElse("aws");
        var testNetwork = new Network("testNetwork", NetworkArgs.builder()
            .resourceGroupId(testResourceGroup.id())
            .cloudProvider(cloudProvider)
            .region(region)
            .clusterType("dedicated")
            .cidrBlock("10.0.0.0/20")
            .build());

        final var zones = config.get("zones").orElse(        
            "use2-az1",
            "use2-az2",
            "use2-az3");
        final var throughputTier = config.get("throughputTier").orElse("tier-1-aws-v2-arm");
        var testCluster = new Cluster("testCluster", ClusterArgs.builder()
            .resourceGroupId(testResourceGroup.id())
            .networkId(testNetwork.id())
            .cloudProvider(cloudProvider)
            .region(region)
            .clusterType("dedicated")
            .connectionType("public")
            .throughputTier(throughputTier)
            .zones(zones)
            .allowDeletion(true)
            .tags(Map.of("key", "value"))
            .build());

        // aws_private_link = {
        //   enabled         = true
        //   connect_console = true
        //   allowed_principals = ["arn:aws:iam::123456789024:root"]
        // }
        final var resourceGroupName = config.get("resourceGroupName").orElse("testname");
        final var networkName = config.get("networkName").orElse("testname");
        final var clusterName = config.get("clusterName").orElse("testname");
        final var userPw = config.get("userPw").orElse("password");
        final var mechanism = config.get("mechanism").orElse("scram-sha-256");
        var testUser = new User("testUser", UserArgs.builder()
            .password(userPw)
            .mechanism(mechanism)
            .clusterApiUrl(testCluster.clusterApiUrl())
            .build());

        final var partitionCount = config.get("partitionCount").orElse(3);
        final var replicationFactor = config.get("replicationFactor").orElse(3);
        var testTopic = new Topic("testTopic", TopicArgs.builder()
            .partitionCount(partitionCount)
            .replicationFactor(replicationFactor)
            .clusterApiUrl(testCluster.clusterApiUrl())
            .allowDeletion(true)
            .build());

        var testAcl = new Acl("testAcl", AclArgs.builder()
            .resourceType("TOPIC")
            .resourceName(testTopic.name())
            .resourcePatternType("LITERAL")
            .principal(testUser.name().applyValue(name -> String.format("User:%s", name)))
            .host("*")
            .operation("READ")
            .permissionType("ALLOW")
            .clusterApiUrl(testCluster.clusterApiUrl())
            .build());

        final var userName = config.get("userName").orElse("test-username");
        final var topicName = config.get("topicName").orElse("test-topic");
    }
}

    configuration:
  resourceGroupName:
    type: string
    default: testname
  networkName:
    type: string
    default: testname
  clusterName:
    type: string
    default: testname
  region:
    type: string
    default: us-east-2
  zones:
    type: dynamic
    default:
      - use2-az1
      - use2-az2
      - use2-az3
  cloudProvider:
    type: string
    default: aws
  throughputTier:
    type: string
    default: tier-1-aws-v2-arm
  userName:
    type: string
    default: test-username
  userPw:
    type: string
    default: password
  mechanism:
    type: string
    default: scram-sha-256
  topicName:
    type: string
    default: test-topic
  partitionCount:
    type: number
    default: 3
  replicationFactor:
    type: number
    default: 3
resources:
  testResourceGroup:
    type: redpanda:ResourceGroup
  testNetwork:
    type: redpanda:Network
    properties:
      resourceGroupId: ${testResourceGroup.id}
      cloudProvider: ${cloudProvider}
      region: ${region}
      clusterType: dedicated
      cidrBlock: 10.0.0.0/20
  testCluster:
    type: redpanda:Cluster
    properties:
      resourceGroupId: ${testResourceGroup.id}
      networkId: ${testNetwork.id}
      cloudProvider: ${cloudProvider}
      region: ${region}
      clusterType: dedicated
      connectionType: public
      throughputTier: ${throughputTier}
      zones: ${zones}
      allowDeletion: true
      tags:
        key: value
  testUser:
    type: redpanda:User
    properties:
      password: ${userPw}
      mechanism: ${mechanism}
      clusterApiUrl: ${testCluster.clusterApiUrl}
  testTopic:
    type: redpanda:Topic
    properties:
      partitionCount: ${partitionCount}
      replicationFactor: ${replicationFactor}
      clusterApiUrl: ${testCluster.clusterApiUrl}
      allowDeletion: true
  testAcl:
    type: redpanda:Acl
    properties:
      resourceType: TOPIC
      resourceName: ${testTopic.name}
      resourcePatternType: LITERAL
      principal: User:${testUser.name}
      host: '*'
      operation: READ
      permissionType: ALLOW
      clusterApiUrl: ${testCluster.clusterApiUrl}

    Limitations

    We are not currently able to support topic creation in self hosted clusters. This is an area of active development so expect that to change soon.

    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,
          cluster_api_url: Optional[str] = None,
          allow_deletion: Optional[bool] = None,
          configuration: Optional[Mapping[str, str]] = None,
          name: Optional[str] = None,
          partition_count: Optional[float] = None,
          replication_factor: Optional[float] = 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: redpanda:Topic
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TopicArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args TopicArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TopicArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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 Redpanda.Topic("topicResource", new()
{
    ClusterApiUrl = "string",
    AllowDeletion = false,
    Configuration = 
    {
        { "string", "string" },
    },
    Name = "string",
    PartitionCount = 0,
    ReplicationFactor = 0,
});

    example, err := redpanda.NewTopic(ctx, "topicResource", &redpanda.TopicArgs{
ClusterApiUrl: pulumi.String("string"),
AllowDeletion: pulumi.Bool(false),
Configuration: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
PartitionCount: pulumi.Float64(0),
ReplicationFactor: pulumi.Float64(0),
})

    var topicResource = new Topic("topicResource", TopicArgs.builder()
    .clusterApiUrl("string")
    .allowDeletion(false)
    .configuration(Map.of("string", "string"))
    .name("string")
    .partitionCount(0)
    .replicationFactor(0)
    .build());

    topic_resource = redpanda.Topic("topicResource",
    cluster_api_url="string",
    allow_deletion=False,
    configuration={
        "string": "string",
    },
    name="string",
    partition_count=0,
    replication_factor=0)

    const topicResource = new redpanda.Topic("topicResource", {
    clusterApiUrl: "string",
    allowDeletion: false,
    configuration: {
        string: "string",
    },
    name: "string",
    partitionCount: 0,
    replicationFactor: 0,
});

    type: redpanda:Topic
properties:
    allowDeletion: false
    clusterApiUrl: string
    configuration:
        string: string
    name: string
    partitionCount: 0
    replicationFactor: 0

    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:

    ClusterApiUrl string
    The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
    AllowDeletion bool
    Indicates whether the topic can be deleted.
    Configuration Dictionary<string, string>
    A map of string key/value pairs of topic configurations.
    Name string
    The name of the topic.
    PartitionCount double
    The number of partitions for the topic. This determines how the data is distributed across brokers.
    ReplicationFactor double
    The replication factor for the topic, which defines how many copies of the data are kept across different brokers for fault tolerance.
    ClusterApiUrl string
    The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
    AllowDeletion bool
    Indicates whether the topic can be deleted.
    Configuration map[string]string
    A map of string key/value pairs of topic configurations.
    Name string
    The name of the topic.
    PartitionCount float64
    The number of partitions for the topic. This determines how the data is distributed across brokers.
    ReplicationFactor float64
    The replication factor for the topic, which defines how many copies of the data are kept across different brokers for fault tolerance.
    clusterApiUrl String
    The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
    allowDeletion Boolean
    Indicates whether the topic can be deleted.
    configuration Map<String,String>
    A map of string key/value pairs of topic configurations.
    name String
    The name of the topic.
    partitionCount Double
    The number of partitions for the topic. This determines how the data is distributed across brokers.
    replicationFactor Double
    The replication factor for the topic, which defines how many copies of the data are kept across different brokers for fault tolerance.
    clusterApiUrl string
    The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
    allowDeletion boolean
    Indicates whether the topic can be deleted.
    configuration {[key: string]: string}
    A map of string key/value pairs of topic configurations.
    name string
    The name of the topic.
    partitionCount number
    The number of partitions for the topic. This determines how the data is distributed across brokers.
    replicationFactor number
    The replication factor for the topic, which defines how many copies of the data are kept across different brokers for fault tolerance.
    cluster_api_url str
    The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
    allow_deletion bool
    Indicates whether the topic can be deleted.
    configuration Mapping[str, str]
    A map of string key/value pairs of topic configurations.
    name str
    The name of the topic.
    partition_count float
    The number of partitions for the topic. This determines how the data is distributed across brokers.
    replication_factor float
    The replication factor for the topic, which defines how many copies of the data are kept across different brokers for fault tolerance.
    clusterApiUrl String
    The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
    allowDeletion Boolean
    Indicates whether the topic can be deleted.
    configuration Map<String>
    A map of string key/value pairs of topic configurations.
    name String
    The name of the topic.
    partitionCount Number
    The number of partitions for the topic. This determines how the data is distributed across brokers.
    replicationFactor Number
    The replication factor for the topic, which defines how many copies of the data are kept across different brokers for fault tolerance.

    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,
        allow_deletion: Optional[bool] = None,
        cluster_api_url: Optional[str] = None,
        configuration: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        partition_count: Optional[float] = None,
        replication_factor: Optional[float] = 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: redpanda:Topic    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    AllowDeletion bool
    Indicates whether the topic can be deleted.
    ClusterApiUrl string
    The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
    Configuration Dictionary<string, string>
    A map of string key/value pairs of topic configurations.
    Name string
    The name of the topic.
    PartitionCount double
    The number of partitions for the topic. This determines how the data is distributed across brokers.
    ReplicationFactor double
    The replication factor for the topic, which defines how many copies of the data are kept across different brokers for fault tolerance.
    AllowDeletion bool
    Indicates whether the topic can be deleted.
    ClusterApiUrl string
    The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
    Configuration map[string]string
    A map of string key/value pairs of topic configurations.
    Name string
    The name of the topic.
    PartitionCount float64
    The number of partitions for the topic. This determines how the data is distributed across brokers.
    ReplicationFactor float64
    The replication factor for the topic, which defines how many copies of the data are kept across different brokers for fault tolerance.
    allowDeletion Boolean
    Indicates whether the topic can be deleted.
    clusterApiUrl String
    The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
    configuration Map<String,String>
    A map of string key/value pairs of topic configurations.
    name String
    The name of the topic.
    partitionCount Double
    The number of partitions for the topic. This determines how the data is distributed across brokers.
    replicationFactor Double
    The replication factor for the topic, which defines how many copies of the data are kept across different brokers for fault tolerance.
    allowDeletion boolean
    Indicates whether the topic can be deleted.
    clusterApiUrl string
    The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
    configuration {[key: string]: string}
    A map of string key/value pairs of topic configurations.
    name string
    The name of the topic.
    partitionCount number
    The number of partitions for the topic. This determines how the data is distributed across brokers.
    replicationFactor number
    The replication factor for the topic, which defines how many copies of the data are kept across different brokers for fault tolerance.
    allow_deletion bool
    Indicates whether the topic can be deleted.
    cluster_api_url str
    The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
    configuration Mapping[str, str]
    A map of string key/value pairs of topic configurations.
    name str
    The name of the topic.
    partition_count float
    The number of partitions for the topic. This determines how the data is distributed across brokers.
    replication_factor float
    The replication factor for the topic, which defines how many copies of the data are kept across different brokers for fault tolerance.
    allowDeletion Boolean
    Indicates whether the topic can be deleted.
    clusterApiUrl String
    The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
    configuration Map<String>
    A map of string key/value pairs of topic configurations.
    name String
    The name of the topic.
    partitionCount Number
    The number of partitions for the topic. This determines how the data is distributed across brokers.
    replicationFactor Number
    The replication factor for the topic, which defines how many copies of the data are kept across different brokers for fault tolerance.

    Import

    $ pulumi import redpanda:index/topic:Topic example topicName,clusterId

    Where clusterId is the ID of the cluster in Redpanda Cloud

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

    Package Details

    Repository
    redpanda redpanda-data/terraform-provider-redpanda
    License
    Notes
    This Pulumi package is based on the redpanda Terraform Provider.
    redpanda logo
    redpanda 0.13.0 published on Monday, Mar 17, 2025 by redpanda-data
    redpanda-data/terraform-provider-redpanda