1. Docs
  2. Reference
  3. API
  4. @pulumi/kafka

Package @pulumi/kafka

This provider is a derived work of the Terraform Provider distributed under MIT. If you encounter a bug or missing feature, first check the pulumi/pulumi-kafka repo; however, if that doesn’t turn up anything, please consult the source Mongey/terraform-provider-kafka repo.

var kafka = require("@pulumi/kafka");

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

Modules

Resources

Others

Resources

Resource Acl

class Acl extends CustomResource

constructor

new Acl(name: string, args: AclArgs, opts?: pulumi.CustomResourceOptions)

Create a Acl resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AclState, opts?: pulumi.CustomResourceOptions): Acl

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Acl

Returns true if the given object is an instance of Acl. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property aclHost

public aclHost: pulumi.Output<string>;

property aclOperation

public aclOperation: pulumi.Output<string>;

property aclPermissionType

public aclPermissionType: pulumi.Output<string>;

property aclPrincipal

public aclPrincipal: pulumi.Output<string>;

property aclResourceName

public aclResourceName: pulumi.Output<string>;

The name of the resource

property aclResourceType

public aclResourceType: pulumi.Output<string>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property resourcePatternTypeFilter

public resourcePatternTypeFilter: pulumi.Output<string | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Provider

class Provider extends ProviderResource

The provider type for the kafka package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

constructor

new Provider(name: string, args: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Provider

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Topic

class Topic extends CustomResource

constructor

new Topic(name: string, args: TopicArgs, opts?: pulumi.CustomResourceOptions)

Create a Topic resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TopicState, opts?: pulumi.CustomResourceOptions): Topic

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Topic

Returns true if the given object is an instance of Topic. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property config

public config: pulumi.Output<{[key: string]: any} | undefined>;

A map of string k/v attributes.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the topic.

property partitions

public partitions: pulumi.Output<number>;

Number of partitions.

property replicationFactor

public replicationFactor: pulumi.Output<number>;

Number of replicas.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface AclArgs

interface AclArgs

The set of arguments for constructing a Acl resource.

property aclHost

aclHost: pulumi.Input<string>;

property aclOperation

aclOperation: pulumi.Input<string>;

property aclPermissionType

aclPermissionType: pulumi.Input<string>;

property aclPrincipal

aclPrincipal: pulumi.Input<string>;

property aclResourceName

aclResourceName: pulumi.Input<string>;

The name of the resource

property aclResourceType

aclResourceType: pulumi.Input<string>;

property resourcePatternTypeFilter

resourcePatternTypeFilter?: pulumi.Input<string>;

interface AclState

interface AclState

Input properties used for looking up and filtering Acl resources.

property aclHost

aclHost?: pulumi.Input<string>;

property aclOperation

aclOperation?: pulumi.Input<string>;

property aclPermissionType

aclPermissionType?: pulumi.Input<string>;

property aclPrincipal

aclPrincipal?: pulumi.Input<string>;

property aclResourceName

aclResourceName?: pulumi.Input<string>;

The name of the resource

property aclResourceType

aclResourceType?: pulumi.Input<string>;

property resourcePatternTypeFilter

resourcePatternTypeFilter?: pulumi.Input<string>;

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

function getVersion

getVersion(): string

interface ProviderArgs

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property bootstrapServers

bootstrapServers: pulumi.Input<pulumi.Input<string>[]>;

A list of kafka brokers

property caCert

caCert?: pulumi.Input<string>;

CA certificate file to validate the server’s certificate.

property caCertFile

DEPRECATED This parameter is now deprecated and will be removed in a later release, please use ca_cert instead.
caCertFile?: pulumi.Input<string>;

Path * to * a * CA * certificate * file * to * validate * the * server’s * certificate. *

property clientCert

clientCert?: pulumi.Input<string>;

The client certificate.

property clientCertFile

DEPRECATED This parameter is now deprecated and will be removed in a later release, please use client_cert instead.
clientCertFile?: pulumi.Input<string>;

Path * to * a * file * containing * the * client * certificate. *

property clientKey

clientKey?: pulumi.Input<string>;

The private key that the certificate was issued for.

property clientKeyFile

DEPRECATED This parameter is now deprecated and will be removed in a later release, please use client_key instead.
clientKeyFile?: pulumi.Input<string>;

Path * to * a * file * containing * the * private * key * that * the * certificate * was * issued * for. *

property saslMechanism

saslMechanism?: pulumi.Input<string>;

SASL mechanism, can be plain, scram-sha512, scram-sha256

property saslPassword

saslPassword?: pulumi.Input<string>;

Password for SASL authentication.

property saslUsername

saslUsername?: pulumi.Input<string>;

Username for SASL authentication.

property skipTlsVerify

skipTlsVerify?: pulumi.Input<boolean>;

Set this to true only if the target Kafka server is an insecure development instance.

property timeout

timeout?: pulumi.Input<number>;

Timeout in seconds

property tlsEnabled

tlsEnabled?: pulumi.Input<boolean>;

Enable communication with the Kafka Cluster over TLS.

interface TopicArgs

interface TopicArgs

The set of arguments for constructing a Topic resource.

property config

config?: pulumi.Input<{[key: string]: any}>;

A map of string k/v attributes.

property name

name?: pulumi.Input<string>;

The name of the topic.

property partitions

partitions: pulumi.Input<number>;

Number of partitions.

property replicationFactor

replicationFactor: pulumi.Input<number>;

Number of replicas.

interface TopicState

interface TopicState

Input properties used for looking up and filtering Topic resources.

property config

config?: pulumi.Input<{[key: string]: any}>;

A map of string k/v attributes.

property name

name?: pulumi.Input<string>;

The name of the topic.

property partitions

partitions?: pulumi.Input<number>;

Number of partitions.

property replicationFactor

replicationFactor?: pulumi.Input<number>;

Number of replicas.