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

Module config

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.

APIs

• bootstrapServers
• caCert
• caCertFile
• clientCert
• clientCertFile
• clientKey
• clientKeyFile
• saslMechanism
• saslPassword
• saslUsername
• skipTlsVerify
• timeout
• tlsEnabled

APIs

let bootstrapServers

let bootstrapServers: string[] | undefined =  __config.getObject<string[]>("bootstrapServers");

A list of kafka brokers

let caCert

let caCert: string | undefined =  __config.get("caCert") || utilities.getEnv("KAFKA_CA_CERT");

CA certificate file to validate the server’s certificate.

let caCertFile

let caCertFile: string | undefined =  __config.get("caCertFile");

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

let clientCert

let clientCert: string | undefined =  __config.get("clientCert") || utilities.getEnv("KAFKA_CLIENT_CERT");

The client certificate.

let clientCertFile

let clientCertFile: string | undefined =  __config.get("clientCertFile");

Path to a file containing the client certificate.

let clientKey

let clientKey: string | undefined =  __config.get("clientKey") || utilities.getEnv("KAFKA_CLIENT_KEY");

The private key that the certificate was issued for.

let clientKeyFile

let clientKeyFile: string | undefined =  __config.get("clientKeyFile");

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

let saslMechanism

let saslMechanism: string | undefined =  __config.get("saslMechanism") || (utilities.getEnv("KAFKA_SASL_MECHANISM") || "plain");

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

let saslPassword

let saslPassword: string | undefined =  __config.get("saslPassword") || utilities.getEnv("KAFKA_SASL_PASSWORD");

Password for SASL authentication.

let saslUsername

let saslUsername: string | undefined =  __config.get("saslUsername") || utilities.getEnv("KAFKA_SASL_USERNAME");

Username for SASL authentication.

let skipTlsVerify

let skipTlsVerify: boolean | undefined =  __config.getObject<boolean>("skipTlsVerify") || (utilities.getEnvBoolean("KAFKA_SKIP_VERIFY") || false);

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

let timeout

let timeout: number | undefined =  __config.getObject<number>("timeout");

Timeout in seconds

let tlsEnabled

let tlsEnabled: boolean | undefined =  __config.getObject<boolean>("tlsEnabled") || (utilities.getEnvBoolean("KAFKA_ENABLE_TLS") || true);

Enable communication with the Kafka Cluster over TLS.