Kafka v3.9.0, Mar 9 25

Kafka v3.9.0 published on Sunday, Mar 9, 2025 by Pulumi

kafka.Provider

Explore with Pulumi AI

Kafka v3.9.0 published on Sunday, Mar 9, 2025 by Pulumi

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 Provider Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Provider(name: string, args: ProviderArgs, opts?: CustomResourceOptions);

@overload
def Provider(resource_name: str,
             args: ProviderArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             bootstrap_servers: Optional[Sequence[str]] = None,
             ca_cert: Optional[str] = None,
             ca_cert_file: Optional[str] = None,
             client_cert: Optional[str] = None,
             client_cert_file: Optional[str] = None,
             client_key: Optional[str] = None,
             client_key_file: Optional[str] = None,
             client_key_passphrase: Optional[str] = None,
             kafka_version: Optional[str] = None,
             sasl_aws_access_key: Optional[str] = None,
             sasl_aws_container_authorization_token_file: Optional[str] = None,
             sasl_aws_container_credentials_full_uri: Optional[str] = None,
             sasl_aws_creds_debug: Optional[bool] = None,
             sasl_aws_profile: Optional[str] = None,
             sasl_aws_region: Optional[str] = None,
             sasl_aws_role_arn: Optional[str] = None,
             sasl_aws_secret_key: Optional[str] = None,
             sasl_aws_token: Optional[str] = None,
             sasl_mechanism: Optional[str] = None,
             sasl_password: Optional[str] = None,
             sasl_token_url: Optional[str] = None,
             sasl_username: Optional[str] = None,
             skip_tls_verify: Optional[bool] = None,
             timeout: Optional[int] = None,
             tls_enabled: Optional[bool] = None)

func NewProvider(ctx *Context, name string, args ProviderArgs, opts ...ResourceOption) (*Provider, error)

public Provider(string name, ProviderArgs args, CustomResourceOptions? opts = null)

public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

type: pulumi:providers:kafka
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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.
args ProviderArgs: 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 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.

name String: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

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.
KafkaVersion string: The version of Kafka protocol to use in $MAJOR.$MINOR.$PATCH format. Some features may not be available on older versions. Default is 2.7.0.
SaslAwsAccessKey string: The AWS access key.
SaslAwsContainerAuthorizationTokenFile string: Path to a file containing the AWS pod identity authorization token
SaslAwsContainerCredentialsFullUri string: URI to retrieve AWS credentials from
SaslAwsCredsDebug bool: Set this to true to turn AWS credentials debug.
SaslAwsProfile string: AWS profile name to use
SaslAwsRegion string: AWS region where MSK is deployed.
SaslAwsRoleArn string: Arn of an AWS IAM role to assume
SaslAwsSecretKey string: The AWS secret key.
SaslAwsToken string: The AWS session token. Only required if you are using temporary security credentials.
SaslMechanism string: SASL mechanism, can be plain, scram-sha512, scram-sha256, aws-iam It can also be sourced from the following environment variable: KAFKA_SASL_MECHANISM
SaslPassword string: Password for SASL authentication.
SaslTokenUrl string: The url to retrieve oauth2 tokens from, when using sasl mechanism oauthbearer
SaslUsername string: Username for SASL authentication.
SkipTlsVerify bool: Set this to true only if the target Kafka server is an insecure development instance. It can also be sourced from the following environment variable: KAFKA_SKIP_VERIFY
Timeout int: Timeout in seconds
TlsEnabled bool: Enable communication with the Kafka Cluster over TLS. It can also be sourced from the following environment variable: KAFKA_ENABLE_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.
KafkaVersion string: The version of Kafka protocol to use in $MAJOR.$MINOR.$PATCH format. Some features may not be available on older versions. Default is 2.7.0.
SaslAwsAccessKey string: The AWS access key.
SaslAwsContainerAuthorizationTokenFile string: Path to a file containing the AWS pod identity authorization token
SaslAwsContainerCredentialsFullUri string: URI to retrieve AWS credentials from
SaslAwsCredsDebug bool: Set this to true to turn AWS credentials debug.
SaslAwsProfile string: AWS profile name to use
SaslAwsRegion string: AWS region where MSK is deployed.
SaslAwsRoleArn string: Arn of an AWS IAM role to assume
SaslAwsSecretKey string: The AWS secret key.
SaslAwsToken string: The AWS session token. Only required if you are using temporary security credentials.
SaslMechanism string: SASL mechanism, can be plain, scram-sha512, scram-sha256, aws-iam It can also be sourced from the following environment variable: KAFKA_SASL_MECHANISM
SaslPassword string: Password for SASL authentication.
SaslTokenUrl string: The url to retrieve oauth2 tokens from, when using sasl mechanism oauthbearer
SaslUsername string: Username for SASL authentication.
SkipTlsVerify bool: Set this to true only if the target Kafka server is an insecure development instance. It can also be sourced from the following environment variable: KAFKA_SKIP_VERIFY
Timeout int: Timeout in seconds
TlsEnabled bool: Enable communication with the Kafka Cluster over TLS. It can also be sourced from the following environment variable: KAFKA_ENABLE_TLS

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.
kafkaVersion String: The version of Kafka protocol to use in $MAJOR.$MINOR.$PATCH format. Some features may not be available on older versions. Default is 2.7.0.
saslAwsAccessKey String: The AWS access key.
saslAwsContainerAuthorizationTokenFile String: Path to a file containing the AWS pod identity authorization token
saslAwsContainerCredentialsFullUri String: URI to retrieve AWS credentials from
saslAwsCredsDebug Boolean: Set this to true to turn AWS credentials debug.
saslAwsProfile String: AWS profile name to use
saslAwsRegion String: AWS region where MSK is deployed.
saslAwsRoleArn String: Arn of an AWS IAM role to assume
saslAwsSecretKey String: The AWS secret key.
saslAwsToken String: The AWS session token. Only required if you are using temporary security credentials.
saslMechanism String: SASL mechanism, can be plain, scram-sha512, scram-sha256, aws-iam It can also be sourced from the following environment variable: KAFKA_SASL_MECHANISM
saslPassword String: Password for SASL authentication.
saslTokenUrl String: The url to retrieve oauth2 tokens from, when using sasl mechanism oauthbearer
saslUsername String: Username for SASL authentication.
skipTlsVerify Boolean: Set this to true only if the target Kafka server is an insecure development instance. It can also be sourced from the following environment variable: KAFKA_SKIP_VERIFY
timeout Integer: Timeout in seconds
tlsEnabled Boolean: Enable communication with the Kafka Cluster over TLS. It can also be sourced from the following environment variable: KAFKA_ENABLE_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.
kafkaVersion string: The version of Kafka protocol to use in $MAJOR.$MINOR.$PATCH format. Some features may not be available on older versions. Default is 2.7.0.
saslAwsAccessKey string: The AWS access key.
saslAwsContainerAuthorizationTokenFile string: Path to a file containing the AWS pod identity authorization token
saslAwsContainerCredentialsFullUri string: URI to retrieve AWS credentials from
saslAwsCredsDebug boolean: Set this to true to turn AWS credentials debug.
saslAwsProfile string: AWS profile name to use
saslAwsRegion string: AWS region where MSK is deployed.
saslAwsRoleArn string: Arn of an AWS IAM role to assume
saslAwsSecretKey string: The AWS secret key.
saslAwsToken string: The AWS session token. Only required if you are using temporary security credentials.
saslMechanism string: SASL mechanism, can be plain, scram-sha512, scram-sha256, aws-iam It can also be sourced from the following environment variable: KAFKA_SASL_MECHANISM
saslPassword string: Password for SASL authentication.
saslTokenUrl string: The url to retrieve oauth2 tokens from, when using sasl mechanism oauthbearer
saslUsername string: Username for SASL authentication.
skipTlsVerify boolean: Set this to true only if the target Kafka server is an insecure development instance. It can also be sourced from the following environment variable: KAFKA_SKIP_VERIFY
timeout number: Timeout in seconds
tlsEnabled boolean: Enable communication with the Kafka Cluster over TLS. It can also be sourced from the following environment variable: KAFKA_ENABLE_TLS

bootstrap_servers Sequence[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.
kafka_version str: The version of Kafka protocol to use in $MAJOR.$MINOR.$PATCH format. Some features may not be available on older versions. Default is 2.7.0.
sasl_aws_access_key str: The AWS access key.
sasl_aws_container_authorization_token_file str: Path to a file containing the AWS pod identity authorization token
sasl_aws_container_credentials_full_uri str: URI to retrieve AWS credentials from
sasl_aws_creds_debug bool: Set this to true to turn AWS credentials debug.
sasl_aws_profile str: AWS profile name to use
sasl_aws_region str: AWS region where MSK is deployed.
sasl_aws_role_arn str: Arn of an AWS IAM role to assume
sasl_aws_secret_key str: The AWS secret key.
sasl_aws_token str: The AWS session token. Only required if you are using temporary security credentials.
sasl_mechanism str: SASL mechanism, can be plain, scram-sha512, scram-sha256, aws-iam It can also be sourced from the following environment variable: KAFKA_SASL_MECHANISM
sasl_password str: Password for SASL authentication.
sasl_token_url str: The url to retrieve oauth2 tokens from, when using sasl mechanism oauthbearer
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. It can also be sourced from the following environment variable: KAFKA_SKIP_VERIFY
timeout int: Timeout in seconds
tls_enabled bool: Enable communication with the Kafka Cluster over TLS. It can also be sourced from the following environment variable: KAFKA_ENABLE_TLS

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.
kafkaVersion String: The version of Kafka protocol to use in $MAJOR.$MINOR.$PATCH format. Some features may not be available on older versions. Default is 2.7.0.
saslAwsAccessKey String: The AWS access key.
saslAwsContainerAuthorizationTokenFile String: Path to a file containing the AWS pod identity authorization token
saslAwsContainerCredentialsFullUri String: URI to retrieve AWS credentials from
saslAwsCredsDebug Boolean: Set this to true to turn AWS credentials debug.
saslAwsProfile String: AWS profile name to use
saslAwsRegion String: AWS region where MSK is deployed.
saslAwsRoleArn String: Arn of an AWS IAM role to assume
saslAwsSecretKey String: The AWS secret key.
saslAwsToken String: The AWS session token. Only required if you are using temporary security credentials.
saslMechanism String: SASL mechanism, can be plain, scram-sha512, scram-sha256, aws-iam It can also be sourced from the following environment variable: KAFKA_SASL_MECHANISM
saslPassword String: Password for SASL authentication.
saslTokenUrl String: The url to retrieve oauth2 tokens from, when using sasl mechanism oauthbearer
saslUsername String: Username for SASL authentication.
skipTlsVerify Boolean: Set this to true only if the target Kafka server is an insecure development instance. It can also be sourced from the following environment variable: KAFKA_SKIP_VERIFY
timeout Number: Timeout in seconds
tlsEnabled Boolean: Enable communication with the Kafka Cluster over TLS. It can also be sourced from the following environment variable: KAFKA_ENABLE_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 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.

Package Details

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

Kafka v3.9.0 published on Sunday, Mar 9, 2025 by Pulumi

pulumi/pulumi-kafka

kafka.Provider

On this page

On this page

Create Provider Resource

Constructor syntax

Parameters

Provider Resource Properties

Inputs

Outputs

Package Details

On this page

On this page