Kafka

v3.3.0 published on Monday, May 16, 2022 by Pulumi

Topic

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

Example Usage

using Pulumi;
using Kafka = Pulumi.Kafka;

class MyStack : Stack
{
    public MyStack()
    {
        var logs = new Kafka.Topic("logs", new Kafka.TopicArgs
        {
            Config = 
            {
                { "cleanup.policy", "compact" },
                { "segment.ms", "20000" },
            },
            Partitions = 100,
            ReplicationFactor = 2,
        });
    }

}
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{
			Config: pulumi.AnyMap{
				"cleanup.policy": pulumi.Any("compact"),
				"segment.ms":     pulumi.Any("20000"),
			},
			Partitions:        pulumi.Int(100),
			ReplicationFactor: pulumi.Int(2),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_kafka as kafka

logs = kafka.Topic("logs",
    config={
        "cleanup.policy": "compact",
        "segment.ms": "20000",
    },
    partitions=100,
    replication_factor=2)
import * as pulumi from "@pulumi/pulumi";
import * as kafka from "@pulumi/kafka";

const logs = new kafka.Topic("logs", {
    config: {
        "cleanup.policy": "compact",
        "segment.ms": "20000",
    },
    partitions: 100,
    replicationFactor: 2,
});

Coming soon!

Create Topic Resource

new Topic(name: string, args: TopicArgs, opts?: CustomResourceOptions);
@overload
def Topic(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          config: Optional[Mapping[str, Any]] = None,
          name: Optional[str] = None,
          partitions: Optional[int] = None,
          replication_factor: Optional[int] = None)
@overload
def Topic(resource_name: str,
          args: TopicArgs,
          opts: Optional[ResourceOptions] = 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.

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.

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

The Topic resource accepts the following input properties:

Partitions int

The number of partitions the topic should have.

ReplicationFactor int

The number of replicas the topic should have.

Config Dictionary<string, object>

A map of string k/v attributes.

Name 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]interface{}

A map of string k/v attributes.

Name 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 Map<String,Object>

A map of string k/v attributes.

name 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 {[key: string]: any}

A map of string k/v attributes.

name string

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 Mapping[str, Any]

A map of string k/v attributes.

name str

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 Map<Any>

A map of string k/v attributes.

name 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, Any]] = 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)
Resource lookup is not supported in YAML
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:
Config Dictionary<string, object>

A map of string k/v attributes.

Name 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]interface{}

A map of string k/v attributes.

Name 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,Object>

A map of string k/v attributes.

name 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]: any}

A map of string k/v attributes.

name 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, Any]

A map of string k/v attributes.

name 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<Any>

A map of string k/v attributes.

name 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

Package Details

Repository
https://github.com/pulumi/pulumi-kafka
License
Apache-2.0
Notes

This Pulumi package is based on the kafka Terraform Provider.