1. Docs
  2. Reference
  3. API
  4. Kafka
  5. Provider

Provider

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.

Create a Provider Resource

new Provider(name: string, args: ProviderArgs, opts?: CustomResourceOptions);
def Provider(resource_name, opts=None, bootstrap_servers=None, ca_cert=None, ca_cert_file=None, client_cert=None, client_cert_file=None, client_key=None, client_key_file=None, client_key_passphrase=None, sasl_mechanism=None, sasl_password=None, sasl_username=None, skip_tls_verify=None, timeout=None, tls_enabled=None, __props__=None);
func NewProvider(ctx *Context, name string, args ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Provider Resource Properties

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

Inputs

The Provider resource accepts the following input properties:

BootstrapServers List<string>

A list of kafka brokers

CaCert string

CA certificate file to validate the server’s certificate.

CaCertFile string

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

Deprecated: This parameter is now deprecated and will be removed in a later release, please use ca_cert instead.

ClientCert string

The client certificate.

ClientCertFile string

Path to a file containing the client certificate.

Deprecated: This parameter is now deprecated and will be removed in a later release, please use client_cert instead.

ClientKey string

The private key that the certificate was issued for.

ClientKeyFile string

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

Deprecated: This parameter is now deprecated and will be removed in a later release, please use client_key instead.

ClientKeyPassphrase string

The passphrase for the private key that the certificate was issued for.

SaslMechanism string

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

SaslPassword string

Password for SASL authentication.

SaslUsername string

Username for SASL authentication.

SkipTlsVerify bool

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

Timeout int

Timeout in seconds

TlsEnabled bool

Enable communication with the Kafka Cluster over TLS.

BootstrapServers []string

A list of kafka brokers

CaCert string

CA certificate file to validate the server’s certificate.

CaCertFile string

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

Deprecated: This parameter is now deprecated and will be removed in a later release, please use ca_cert instead.

ClientCert string

The client certificate.

ClientCertFile string

Path to a file containing the client certificate.

Deprecated: This parameter is now deprecated and will be removed in a later release, please use client_cert instead.

ClientKey string

The private key that the certificate was issued for.

ClientKeyFile string

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

Deprecated: This parameter is now deprecated and will be removed in a later release, please use client_key instead.

ClientKeyPassphrase string

The passphrase for the private key that the certificate was issued for.

SaslMechanism string

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

SaslPassword string

Password for SASL authentication.

SaslUsername string

Username for SASL authentication.

SkipTlsVerify bool

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

Timeout int

Timeout in seconds

TlsEnabled bool

Enable communication with the Kafka Cluster over TLS.

bootstrapServers string[]

A list of kafka brokers

caCert string

CA certificate file to validate the server’s certificate.

caCertFile string

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

Deprecated: This parameter is now deprecated and will be removed in a later release, please use ca_cert instead.

clientCert string

The client certificate.

clientCertFile string

Path to a file containing the client certificate.

Deprecated: This parameter is now deprecated and will be removed in a later release, please use client_cert instead.

clientKey string

The private key that the certificate was issued for.

clientKeyFile string

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

Deprecated: This parameter is now deprecated and will be removed in a later release, please use client_key instead.

clientKeyPassphrase string

The passphrase for the private key that the certificate was issued for.

saslMechanism string

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

saslPassword string

Password for SASL authentication.

saslUsername string

Username for SASL authentication.

skipTlsVerify boolean

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

timeout number

Timeout in seconds

tlsEnabled boolean

Enable communication with the Kafka Cluster over TLS.

bootstrap_servers List[str]

A list of kafka brokers

ca_cert str

CA certificate file to validate the server’s certificate.

ca_cert_file str

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

Deprecated: This parameter is now deprecated and will be removed in a later release, please use ca_cert instead.

client_cert str

The client certificate.

client_cert_file str

Path to a file containing the client certificate.

Deprecated: This parameter is now deprecated and will be removed in a later release, please use client_cert instead.

client_key str

The private key that the certificate was issued for.

client_key_file str

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

Deprecated: This parameter is now deprecated and will be removed in a later release, please use client_key instead.

client_key_passphrase str

The passphrase for the private key that the certificate was issued for.

sasl_mechanism str

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

sasl_password str

Password for SASL authentication.

sasl_username str

Username for SASL authentication.

skip_tls_verify bool

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

timeout float

Timeout in seconds

tls_enabled bool

Enable communication with the Kafka Cluster over TLS.

Outputs

All input properties are implicitly available as output properties. Additionally, the Provider 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 str
The provider-assigned unique ID for this managed resource.

Package Details

Repository
https://github.com/pulumi/pulumi-kafka
License
Apache-2.0
Notes
This Pulumi package is based on the kafka Terraform Provider.