Come join Pulumi for the industry's first Cloud Engineering Summit! October 7–8. Save Your Spot

This page documents the language specification for the kafka package. If you're looking for help working with the inputs, outputs, or functions of kafka resources in a Pulumi program, please see the resource documentation for examples and API reference.

Pulumi Kafka

class pulumi_kafka.Acl(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, acl_host: Union[str, Awaitable[str], Output[T], None] = None, acl_operation: Union[str, Awaitable[str], Output[T], None] = None, acl_permission_type: Union[str, Awaitable[str], Output[T], None] = None, acl_principal: Union[str, Awaitable[str], Output[T], None] = None, acl_resource_name: Union[str, Awaitable[str], Output[T], None] = None, acl_resource_type: Union[str, Awaitable[str], Output[T], None] = None, resource_pattern_type_filter: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Create a Acl resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] acl_resource_name: The name of the resource

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, acl_host: Union[str, Awaitable[str], Output[T], None] = None, acl_operation: Union[str, Awaitable[str], Output[T], None] = None, acl_permission_type: Union[str, Awaitable[str], Output[T], None] = None, acl_principal: Union[str, Awaitable[str], Output[T], None] = None, acl_resource_name: Union[str, Awaitable[str], Output[T], None] = None, acl_resource_type: Union[str, Awaitable[str], Output[T], None] = None, resource_pattern_type_filter: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_kafka.acl.Acl

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • acl_resource_name (pulumi.Input[str]) – The name of the resource

property acl_resource_name

The name of the resource

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kafka.Provider(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, bootstrap_servers: Union[List[Union[str, Awaitable[str], Output[T]]], Awaitable[List[Union[str, Awaitable[str], Output[T]]]], Output[T], None] = None, ca_cert: Union[str, Awaitable[str], Output[T], None] = None, ca_cert_file: Union[str, Awaitable[str], Output[T], None] = None, client_cert: Union[str, Awaitable[str], Output[T], None] = None, client_cert_file: Union[str, Awaitable[str], Output[T], None] = None, client_key: Union[str, Awaitable[str], Output[T], None] = None, client_key_file: Union[str, Awaitable[str], Output[T], None] = None, client_key_passphrase: Union[str, Awaitable[str], Output[T], None] = None, sasl_mechanism: Union[str, Awaitable[str], Output[T], None] = None, sasl_password: Union[str, Awaitable[str], Output[T], None] = None, sasl_username: Union[str, Awaitable[str], Output[T], None] = None, skip_tls_verify: Union[bool, Awaitable[bool], Output[T], None] = None, timeout: Union[float, Awaitable[float], Output[T], None] = None, tls_enabled: Union[bool, Awaitable[bool], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • bootstrap_servers (pulumi.Input[List[pulumi.Input[str]]]) – A list of kafka brokers

  • ca_cert (pulumi.Input[str]) – CA certificate file to validate the server’s certificate.

  • ca_cert_file (pulumi.Input[str]) – Path to a CA certificate file to validate the server’s certificate.

  • client_cert (pulumi.Input[str]) – The client certificate.

  • client_cert_file (pulumi.Input[str]) – Path to a file containing the client certificate.

  • client_key (pulumi.Input[str]) – The private key that the certificate was issued for.

  • client_key_file (pulumi.Input[str]) – Path to a file containing the private key that the certificate was issued for.

  • client_key_passphrase (pulumi.Input[str]) – The passphrase for the private key that the certificate was issued for.

  • sasl_mechanism (pulumi.Input[str]) – SASL mechanism, can be plain, scram-sha512, scram-sha256

  • sasl_password (pulumi.Input[str]) – Password for SASL authentication.

  • sasl_username (pulumi.Input[str]) – Username for SASL authentication.

  • skip_tls_verify (pulumi.Input[bool]) – Set this to true only if the target Kafka server is an insecure development instance.

  • timeout (pulumi.Input[float]) – Timeout in seconds

  • tls_enabled (pulumi.Input[bool]) – Enable communication with the Kafka Cluster over TLS.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kafka.Topic(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, config: Union[Mapping[str, Any], Awaitable[Mapping[str, Any]], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, partitions: Union[float, Awaitable[float], Output[T], None] = None, replication_factor: Union[float, Awaitable[float], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Create a Topic resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[Mapping[str, Any]] config: A map of string k/v attributes. :param pulumi.Input[str] name: The name of the topic. :param pulumi.Input[float] partitions: Number of partitions. :param pulumi.Input[float] replication_factor: Number of replicas.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, config: Union[Mapping[str, Any], Awaitable[Mapping[str, Any]], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, partitions: Union[float, Awaitable[float], Output[T], None] = None, replication_factor: Union[float, Awaitable[float], Output[T], None] = None) → pulumi_kafka.topic.Topic

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • Any]] config (pulumi.Input[Mapping[str,) – A map of string k/v attributes.

  • name (pulumi.Input[str]) – The name of the topic.

  • partitions (pulumi.Input[float]) – Number of partitions.

  • replication_factor (pulumi.Input[float]) – Number of replicas.

property config

A map of string k/v attributes.

property name

The name of the topic.

property partitions

Number of partitions.

property replication_factor

Number of replicas.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str