Alias of source cluster
| Type: | string |
|---|---|
| Default: | |
| Valid Values: | |
| Importance: | high |
The password of the private key in the key store file or the PEM key specified in 'ssl.keystore.key'.
| Type: | password |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | high |
Certificate chain in the format specified by 'ssl.keystore.type'. Default SSL engine factory supports only PEM format with a list of X.509 certificates
| Type: | password |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | high |
Private key in the format specified by 'ssl.keystore.type'. Default SSL engine factory supports only PEM format with PKCS#8 keys. If the key is encrypted, key password must be specified using 'ssl.key.password'
| Type: | password |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | high |
The location of the key store file. This is optional for client and can be used for two-way authentication for client.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | high |
The store password for the key store file. This is optional for client and only needed if 'ssl.keystore.location' is configured. Key store password is not supported for PEM format.
| Type: | password |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | high |
Trusted certificates in the format specified by 'ssl.truststore.type'. Default SSL engine factory supports only PEM format with X.509 certificates.
| Type: | password |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | high |
The location of the trust store file.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | high |
The password for the trust store file. If a password is not set, trust store file configured will still be used, but integrity checking is disabled. Trust store password is not supported for PEM format.
| Type: | password |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | high |
Alias of target cluster. Used in metrics reporting.
| Type: | string |
|---|---|
| Default: | target |
| Valid Values: | |
| Importance: | high |
The fully qualified name of a SASL client callback handler class that implements the AuthenticateCallbackHandler interface.
| Type: | class |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
JAAS login context parameters for SASL connections in the format used by JAAS configuration files. JAAS configuration file format is described here. The format for the value is: loginModuleClass controlFlag (optionName=optionValue)*;. For brokers, the config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.jaas.config=com.example.ScramLoginModule required;
| Type: | password |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
The fully qualified name of a SASL login callback handler class that implements the AuthenticateCallbackHandler interface. For brokers, login callback handler config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.login.callback.handler.class=com.example.CustomScramLoginCallbackHandler
| Type: | class |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
The fully qualified name of a class that implements the Login interface. For brokers, login config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.login.class=com.example.CustomScramLogin
| Type: | class |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
SASL mechanism used for client connections. This may be any mechanism for which a security provider is available. GSSAPI is the default mechanism.
| Type: | string |
|---|---|
| Default: | GSSAPI |
| Valid Values: | |
| Importance: | medium |
The algorithm the Apache Kafka client should use to sign the assertion sent to the identity provider. It is also used as the value of the OAuth alg (Algorithm) header in the JWT assertion.
Note: If a value for sasl.oauthbearer.assertion.file is provided, this configuration will be ignored.
| Type: | string |
|---|---|
| Default: | RS256 |
| Valid Values: | (case insensitive) [ES256, RS256] |
| Importance: | medium |
The JWT aud (Audience) claim which will be included in the client JWT assertion created locally.
Note: If a value for sasl.oauthbearer.assertion.file is provided, this configuration will be ignored.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
The value to be used as the iss (Issuer) claim which will be included in the client JWT assertion created locally.
Note: If a value for sasl.oauthbearer.assertion.file is provided, this configuration will be ignored.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
Flag that determines if the JWT assertion should generate a unique ID for the JWT and include it in the jti (JWT ID) claim.
Note: If a value for sasl.oauthbearer.assertion.file is provided, this configuration will be ignored.
| Type: | boolean |
|---|---|
| Default: | false |
| Valid Values: | |
| Importance: | medium |
The value to be used as the sub (Subject) claim which will be included in the client JWT assertion created locally.
Note: If a value for sasl.oauthbearer.assertion.file is provided, this configuration will be ignored.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
File that contains a pre-generated JWT assertion.
The underlying implementation caches the file contents to avoid the performance hit of loading the file on each access. The caching mechanism will detect whenthe file changes to allow for the file to be reloaded on modifications. This allows for "live" assertion rotation without restarting the Kafka client.
The file contains the assertion in the serialized, three part JWT format:
alg (Algorithm), typ (Type, always the literal value JWT), etc.aud (Audience), iss (Issuer), sub (Subject), etc.See RFC 7519 and RFC 7515 for more details on the JWT and JWS formats.
Note: If a value for sasl.oauthbearer.assertion.file is provided, all other sasl.oauthbearer.assertion.* configurations are ignored.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
File that contains a private key in the standard PEM format which is used to sign the JWT assertion sent to the identity provider.
The underlying implementation caches the file contents to avoid the performance hit of loading the file on each access. The caching mechanism will detect when the file changes to allow for the file to be reloaded on modifications. This allows for "live" private key rotation without restarting the Kafka client.
Note: If a value for sasl.oauthbearer.assertion.file is provided, this configuration will be ignored.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
The optional passphrase to decrypt the private key file specified by sasl.oauthbearer.assertion.private.key.file.
Note: If the file referred to by sasl.oauthbearer.assertion.private.key.file is modified on the file system at runtime and it was created with a different passphrase than it was previously, the client will not be able to access the private key file because the passphrase is now out of date. For that reason, when using private key passphrases, either use the same passphrase each time, or—for improved security—restart the Kafka client using the new passphrase configuration.
Note: If a value for sasl.oauthbearer.assertion.file is provided, this configuration will be ignored.
| Type: | password |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
This optional configuration specifies the file containing the JWT headers and/or payload claims to be used when creating the JWT assertion.
Not all identity providers require the same set of claims; some may require a given claim while others may prohibit it. In order to provide the most flexibility, this configuration allows the user to provide the static header values and claims that are to be included in the JWT.
Note: If a value for sasl.oauthbearer.assertion.file is provided, this configuration will be ignored.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
The ID (defined in/by the OAuth identity provider) to identify the client requesting the token.
The client ID was previously stored as part of the sasl.jaas.config configuration with the key clientId. For backward compatibility, the clientId JAAS option can still be used, but it is deprecated and will be removed in a future version.
Order of precedence:
sasl.oauthbearer.client.credentials.client.id from configurationclientId from JAAS| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
The secret (defined by either the user or preassigned, depending on the identity provider) of the client requesting the token.
The client secret was previously stored as part of the sasl.jaas.config configuration with the key clientSecret. For backward compatibility, the clientSecret JAAS option can still be used, but it is deprecated and will be removed in a future version.
Order of precedence:
sasl.oauthbearer.client.credentials.client.secret from configurationclientSecret from JAAS| Type: | password |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
The OAuth/OIDC provider URL from which the provider's JWKS (JSON Web Key Set) can be retrieved. The URL can be HTTP(S)-based or file-based. If the URL is HTTP(S)-based, the JWKS data will be retrieved from the OAuth/OIDC provider via the configured URL on broker startup. All then-current keys will be cached on the broker for incoming requests. If an authentication request is received for a JWT that includes a "kid" header claim value that isn't yet in the cache, the JWKS endpoint will be queried again on demand. However, the broker polls the URL every sasl.oauthbearer.jwks.endpoint.refresh.ms milliseconds to refresh the cache with any forthcoming keys before any JWT requests that include them are received. If the URL is file-based, the broker will load the JWKS file from a configured location on startup. In the event that the JWT includes a "kid" header value that isn't in the JWKS file, the broker will reject the JWT and authentication will fail.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
The fully-qualified class name of a JwtRetriever implementation used to request tokens from the identity provider.
The default configuration value represents a class that maintains backward compatibility with previous versions of Apache Kafka. The default implementation uses the configuration to determine which concrete implementation to create.
Other implementations that are provided include:
org.apache.kafka.common.security.oauthbearer.ClientCredentialsJwtRetrieverorg.apache.kafka.common.security.oauthbearer.DefaultJwtRetrieverorg.apache.kafka.common.security.oauthbearer.FileJwtRetrieverorg.apache.kafka.common.security.oauthbearer.JwtBearerJwtRetriever| Type: | class |
|---|---|
| Default: | org.apache.kafka.common.security.oauthbearer.DefaultJwtRetriever |
| Valid Values: | |
| Importance: | medium |
The fully-qualified class name of a JwtValidator implementation used to validate the JWT from the identity provider.
The default validator (org.apache.kafka.common.security.oauthbearer.DefaultJwtValidator) maintains backward compatibility with previous versions of Apache Kafka. The default validator uses configuration to determine which concrete implementation to create.
The built-in JwtValidator implementations are:
org.apache.kafka.common.security.oauthbearer.BrokerJwtValidatororg.apache.kafka.common.security.oauthbearer.ClientJwtValidatororg.apache.kafka.common.security.oauthbearer.DefaultJwtValidator| Type: | class |
|---|---|
| Default: | org.apache.kafka.common.security.oauthbearer.DefaultJwtValidator |
| Valid Values: | |
| Importance: | medium |
This is the level of access a client application is granted to a resource or API which is included in the token request. If provided, it should match one or more scopes configured in the identity provider.
The scope was previously stored as part of the sasl.jaas.config configuration with the key scope. For backward compatibility, the scope JAAS option can still be used, but it is deprecated and will be removed in a future version.
Order of precedence:
sasl.oauthbearer.scope from configurationscope from JAAS| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
The URL for the OAuth/OIDC identity provider. If the URL is HTTP(S)-based, it is the issuer's token endpoint URL to which requests will be made to login based on the configuration in sasl.oauthbearer.jwt.retriever.class. If the URL is file-based, it specifies a file containing an access token (in JWT serialized form) issued by the OAuth/OIDC identity provider to use for authorization.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
Protocol used to communicate with brokers.
| Type: | string |
|---|---|
| Default: | PLAINTEXT |
| Valid Values: | (case insensitive) [SASL_SSL, PLAINTEXT, SSL, SASL_PLAINTEXT] |
| Importance: | medium |
The list of protocols enabled for SSL connections. The default is 'TLSv1.2,TLSv1.3'. This means that clients and servers will prefer TLSv1.3 if both support it and fallback to TLSv1.2 otherwise (assuming both support at least TLSv1.2). This default should be fine for most use cases. Also see the config documentation for `ssl.protocol` to understand how it can impact the TLS version negotiation behavior.
| Type: | list |
|---|---|
| Default: | TLSv1.2,TLSv1.3 |
| Valid Values: | |
| Importance: | medium |
The file format of the key store file. This is optional for client. The values currently supported by the default `ssl.engine.factory.class` are [JKS, PKCS12, PEM].
| Type: | string |
|---|---|
| Default: | JKS |
| Valid Values: | |
| Importance: | medium |
The SSL protocol used to generate the SSLContext. The default is 'TLSv1.3', which should be fine for most use cases. A typical alternative to the default is 'TLSv1.2'. Allowed values for this config are dependent on the JVM. Clients using the defaults for this config and 'ssl.enabled.protocols' will downgrade to 'TLSv1.2' if the server does not support 'TLSv1.3'. If this config is set to 'TLSv1.2', however, clients will not use 'TLSv1.3' even if it is one of the values in `ssl.enabled.protocols` and the server only supports 'TLSv1.3'.
| Type: | string |
|---|---|
| Default: | TLSv1.3 |
| Valid Values: | |
| Importance: | medium |
The name of the security provider used for SSL connections. Default value is the default security provider of the JVM.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | medium |
The file format of the trust store file. The values currently supported by the default `ssl.engine.factory.class` are [JKS, PKCS12, PEM].
| Type: | string |
|---|---|
| Default: | JKS |
| Valid Values: | |
| Importance: | medium |
Timeout for administrative tasks, e.g. detecting new topics.
| Type: | long |
|---|---|
| Default: | 60000 (1 minute) |
| Valid Values: | |
| Importance: | low |
Whether to replicate source->target.
| Type: | boolean |
|---|---|
| Default: | true |
| Valid Values: | |
| Importance: | low |
Class which extends ForwardingAdmin to define custom cluster resource management (topics, configs, etc). The class must have a constructor with signature (Map that is used to configure a KafkaAdminClient and may also be used to configure clients for external systems if necessary.
| Type: | class |
|---|---|
| Default: | org.apache.kafka.clients.admin.ForwardingAdmin |
| Valid Values: | |
| Importance: | low |
A list of classes to use as metrics reporters. Implementing the org.apache.kafka.common.metrics.MetricsReporter interface allows plugging in classes that will be notified of new metric creation. When custom reporters are set and org.apache.kafka.common.metrics.JmxReporter is needed, it has to be explicitly added to the list.
| Type: | list |
|---|---|
| Default: | org.apache.kafka.common.metrics.JmxReporter |
| Valid Values: | |
| Importance: | low |
Class which defines the remote topic naming convention.
| Type: | class |
|---|---|
| Default: | org.apache.kafka.connect.mirror.DefaultReplicationPolicy |
| Valid Values: | |
| Importance: | low |
Whether to use replication.policy.separator to control the names of topics used for checkpoints and offset syncs. By default, custom separators are used in these topic names; however, if upgrading MirrorMaker 2 from older versions that did not allow for these topic names to be customized, it may be necessary to set this property to 'false' in order to continue using the same names for those topics.
| Type: | boolean |
|---|---|
| Default: | true |
| Valid Values: | |
| Importance: | low |
Separator used in remote topic naming convention.
| Type: | string |
|---|---|
| Default: | . |
| Valid Values: | |
| Importance: | low |
Kerberos kinit command path.
| Type: | string |
|---|---|
| Default: | /usr/bin/kinit |
| Valid Values: | |
| Importance: | low |
Login thread sleep time between refresh attempts.
| Type: | long |
|---|---|
| Default: | 60000 |
| Valid Values: | |
| Importance: | low |
Percentage of random jitter added to the renewal time.
| Type: | double |
|---|---|
| Default: | 0.05 |
| Valid Values: | |
| Importance: | low |
Login thread will sleep until the specified window factor of time from last refresh to ticket's expiry has been reached, at which time it will try to renew the ticket.
| Type: | double |
|---|---|
| Default: | 0.8 |
| Valid Values: | |
| Importance: | low |
The (optional) value in milliseconds for the external authentication provider connection timeout. Currently applies only to OAUTHBEARER.
| Type: | int |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | low |
The (optional) value in milliseconds for the external authentication provider read timeout. Currently applies only to OAUTHBEARER.
| Type: | int |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | low |
The amount of buffer time before credential expiration to maintain when refreshing a credential, in seconds. If a refresh would otherwise occur closer to expiration than the number of buffer seconds then the refresh will be moved up to maintain as much of the buffer time as possible. Legal values are between 0 and 3600 (1 hour); a default value of 300 (5 minutes) is used if no value is specified. This value and sasl.login.refresh.min.period.seconds are both ignored if their sum exceeds the remaining lifetime of a credential. Currently applies only to OAUTHBEARER.
| Type: | short |
|---|---|
| Default: | 300 |
| Valid Values: | [0,...,3600] |
| Importance: | low |
The desired minimum time for the login refresh thread to wait before refreshing a credential, in seconds. Legal values are between 0 and 900 (15 minutes); a default value of 60 (1 minute) is used if no value is specified. This value and sasl.login.refresh.buffer.seconds are both ignored if their sum exceeds the remaining lifetime of a credential. Currently applies only to OAUTHBEARER.
| Type: | short |
|---|---|
| Default: | 60 |
| Valid Values: | [0,...,900] |
| Importance: | low |
Login refresh thread will sleep until the specified window factor relative to the credential's lifetime has been reached, at which time it will try to refresh the credential. Legal values are between 0.5 (50%) and 1.0 (100%) inclusive; a default value of 0.8 (80%) is used if no value is specified. Currently applies only to OAUTHBEARER.
| Type: | double |
|---|---|
| Default: | 0.8 |
| Valid Values: | [0.5,...,1.0] |
| Importance: | low |
The maximum amount of random jitter relative to the credential's lifetime that is added to the login refresh thread's sleep time. Legal values are between 0 and 0.25 (25%) inclusive; a default value of 0.05 (5%) is used if no value is specified. Currently applies only to OAUTHBEARER.
| Type: | double |
|---|---|
| Default: | 0.05 |
| Valid Values: | [0.0,...,0.25] |
| Importance: | low |
The (optional) value in milliseconds for the maximum wait between login attempts to the external authentication provider. Login uses an exponential backoff algorithm with an initial wait based on the sasl.login.retry.backoff.ms setting and will double in wait length between attempts up to a maximum wait length specified by the sasl.login.retry.backoff.max.ms setting. Currently applies only to OAUTHBEARER.
| Type: | long |
|---|---|
| Default: | 10000 (10 seconds) |
| Valid Values: | |
| Importance: | low |
The (optional) value in milliseconds for the initial wait between login attempts to the external authentication provider. Login uses an exponential backoff algorithm with an initial wait based on the sasl.login.retry.backoff.ms setting and will double in wait length between attempts up to a maximum wait length specified by the sasl.login.retry.backoff.max.ms setting. Currently applies only to OAUTHBEARER.
| Type: | long |
|---|---|
| Default: | 100 |
| Valid Values: | |
| Importance: | low |
The number of seconds in the future for which the JWT is valid. The value is used to determine the JWT exp (Expiration) claim based on the current system time when the JWT is created.
The formula to generate the exp claim is very simple:
Let:
x = the current timestamp in seconds, on client
y = the value of this configuration
Then:
exp = x + y
Note: If a value for sasl.oauthbearer.assertion.file is provided, this configuration will be ignored.
| Type: | int |
|---|---|
| Default: | 300 |
| Valid Values: | [0,...,86400] |
| Importance: | low |
The number of seconds in the past from which the JWT is valid. The value is used to determine the JWT nbf (Not Before) claim based on the current system time when the JWT is created.
The formula to generate the nbf claim is very simple:
Let:
x = the current timestamp in seconds, on client
y = the value of this configuration
Then:
nbf = x - y
Note: If a value for sasl.oauthbearer.assertion.file is provided, this configuration will be ignored.
| Type: | int |
|---|---|
| Default: | 60 |
| Valid Values: | [0,...,3600] |
| Importance: | low |
The (optional) value in seconds to allow for differences between the time of the OAuth/OIDC identity provider and the broker.
| Type: | int |
|---|---|
| Default: | 30 |
| Valid Values: | |
| Importance: | low |
The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences. The JWT will be inspected for the standard OAuth "aud" claim and if this value is set, the broker will match the value from JWT's "aud" claim to see if there is an exact match. If there is no match, the broker will reject the JWT and authentication will fail.
| Type: | list |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | low |
The (optional) setting for the broker to use to verify that the JWT was created by the expected issuer. The JWT will be inspected for the standard OAuth "iss" claim and if this value is set, the broker will match it exactly against what is in the JWT's "iss" claim. If there is no match, the broker will reject the JWT and authentication will fail.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | low |
The (optional) setting to enable the OAuth client to URL-encode the client_id and client_secret in the authorization header in accordance with RFC6749, see here for more details. The default value is set to 'false' for backward compatibility
| Type: | boolean |
|---|---|
| Default: | false |
| Valid Values: | |
| Importance: | low |
The (optional) value in milliseconds for the broker to wait between refreshing its JWKS (JSON Web Key Set) cache that contains the keys to verify the signature of the JWT.
| Type: | long |
|---|---|
| Default: | 3600000 (1 hour) |
| Valid Values: | |
| Importance: | low |
The (optional) value in milliseconds for the maximum wait between attempts to retrieve the JWKS (JSON Web Key Set) from the external authentication provider. JWKS retrieval uses an exponential backoff algorithm with an initial wait based on the sasl.oauthbearer.jwks.endpoint.retry.backoff.ms setting and will double in wait length between attempts up to a maximum wait length specified by the sasl.oauthbearer.jwks.endpoint.retry.backoff.max.ms setting.
| Type: | long |
|---|---|
| Default: | 10000 (10 seconds) |
| Valid Values: | |
| Importance: | low |
The (optional) value in milliseconds for the initial wait between JWKS (JSON Web Key Set) retrieval attempts from the external authentication provider. JWKS retrieval uses an exponential backoff algorithm with an initial wait based on the sasl.oauthbearer.jwks.endpoint.retry.backoff.ms setting and will double in wait length between attempts up to a maximum wait length specified by the sasl.oauthbearer.jwks.endpoint.retry.backoff.max.ms setting.
| Type: | long |
|---|---|
| Default: | 100 |
| Valid Values: | |
| Importance: | low |
The OAuth claim for the scope is often named "scope", but this (optional) setting can provide a different name to use for the scope included in the JWT payload's claims if the OAuth/OIDC provider uses a different name for that claim.
| Type: | string |
|---|---|
| Default: | scope |
| Valid Values: | |
| Importance: | low |
The OAuth claim for the subject is often named "sub", but this (optional) setting can provide a different name to use for the subject included in the JWT payload's claims if the OAuth/OIDC provider uses a different name for that claim.
| Type: | string |
|---|---|
| Default: | sub |
| Valid Values: | |
| Importance: | low |
A list of cipher suites. This is a named combination of authentication, encryption, MAC and key exchange algorithm used to negotiate the security settings for a network connection using TLS or SSL network protocol. By default all the available cipher suites are supported.
| Type: | list |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | low |
The endpoint identification algorithm to validate server hostname using server certificate.
| Type: | string |
|---|---|
| Default: | https |
| Valid Values: | |
| Importance: | low |
The class of type org.apache.kafka.common.security.auth.SslEngineFactory to provide SSLEngine objects. Default value is org.apache.kafka.common.security.ssl.DefaultSslEngineFactory. Alternatively, setting this to org.apache.kafka.common.security.ssl.CommonNameLoggingSslEngineFactory will log the common name of expired SSL certificates used by clients to authenticate at any of the brokers with log level INFO. Note that this will cause a tiny delay during establishment of new connections from mTLS clients to brokers due to the extra code for examining the certificate chain provided by the client. Note further that the implementation uses a custom truststore based on the standard Java truststore and thus might be considered a security risk due to not being as mature as the standard one.
| Type: | class |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | low |
The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine.
| Type: | string |
|---|---|
| Default: | SunX509 |
| Valid Values: | |
| Importance: | low |
The SecureRandom PRNG implementation to use for SSL cryptography operations.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | |
| Importance: | low |
The algorithm used by trust manager factory for SSL connections. Default value is the trust manager factory algorithm configured for the Java Virtual Machine.
| Type: | string |
|---|---|
| Default: | PKIX |
| Valid Values: | |
| Importance: | low |
Globally unique name to use for this connector.
| Type: | string |
|---|---|
| Default: | |
| Valid Values: | non-empty string without ISO control characters |
| Importance: | high |
Name or alias of the class for this connector. Must be a subclass of org.apache.kafka.connect.connector.Connector. If the connector is org.apache.kafka.connect.file.FileStreamSinkConnector, you can either specify this full name, or use "FileStreamSink" or "FileStreamSinkConnector" to make the configuration a bit shorter
| Type: | string |
|---|---|
| Default: | |
| Valid Values: | |
| Importance: | high |
Version of the connector.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | org.apache.kafka.connect.runtime.ConnectorConfig$PluginVersionValidator@3d921e20 |
| Importance: | medium |
Maximum number of tasks to use for this connector.
| Type: | int |
|---|---|
| Default: | 1 |
| Valid Values: | [1,...] |
| Importance: | high |
(Deprecated) Whether to enforce that the tasks.max property is respected by the connector. By default, connectors that generate too many tasks will fail, and existing sets of tasks that exceed the tasks.max property will also be failed. If this property is set to false, then connectors will be allowed to generate more than the maximum number of tasks, and existing sets of tasks that exceed the tasks.max property will be allowed to run. This property is deprecated and will be removed in an upcoming major release.
| Type: | boolean |
|---|---|
| Default: | true |
| Valid Values: | |
| Importance: | low |
Converter class used to convert between Kafka Connect format and the serialized form that is written to Kafka. This controls the format of the keys in messages written to or read from Kafka, and since this is independent of connectors it allows any connector to work with any serialization format. Examples of common formats include JSON and Avro.
| Type: | class |
|---|---|
| Default: | null |
| Valid Values: | A concrete subclass of org.apache.kafka.connect.storage.Converter, A class with a public, no-argument constructor |
| Importance: | low |
Version of the key converter.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | org.apache.kafka.connect.runtime.ConnectorConfig$PluginVersionValidator@36b4cef0 |
| Importance: | low |
Converter class used to convert between Kafka Connect format and the serialized form that is written to Kafka. This controls the format of the values in messages written to or read from Kafka, and since this is independent of connectors it allows any connector to work with any serialization format. Examples of common formats include JSON and Avro.
| Type: | class |
|---|---|
| Default: | null |
| Valid Values: | A concrete subclass of org.apache.kafka.connect.storage.Converter, A class with a public, no-argument constructor |
| Importance: | low |
Version of the value converter.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | org.apache.kafka.connect.runtime.ConnectorConfig$PluginVersionValidator@fad74ee |
| Importance: | low |
HeaderConverter class used to convert between Kafka Connect format and the serialized form that is written to Kafka. This controls the format of the header values in messages written to or read from Kafka, and since this is independent of connectors it allows any connector to work with any serialization format. Examples of common formats include JSON and Avro. By default, the SimpleHeaderConverter is used to serialize header values to strings and deserialize them by inferring the schemas.
| Type: | class |
|---|---|
| Default: | null |
| Valid Values: | A concrete subclass of org.apache.kafka.connect.storage.HeaderConverter, A class with a public, no-argument constructor |
| Importance: | low |
Version of the header converter.
| Type: | string |
|---|---|
| Default: | null |
| Valid Values: | org.apache.kafka.connect.runtime.ConnectorConfig$PluginVersionValidator@1a1d6a08 |
| Importance: | low |
The action that Connect should take on the connector when changes in external configuration providers result in a change in the connector's configuration properties. A value of 'none' indicates that Connect will do nothing. A value of 'restart' indicates that Connect should restart/reload the connector with the updated configuration properties.The restart may actually be scheduled in the future if the external configuration provider indicates that a configuration value will expire in the future.
| Type: | string |
|---|---|
| Default: | restart |
| Valid Values: | [none, restart] |
| Importance: | low |
Aliases for the transformations to be applied to records.
| Type: | list |
|---|---|
| Default: | "" |
| Valid Values: | non-null string, unique transformation aliases |
| Importance: | low |
Aliases for the predicates used by transformations.
| Type: | list |
|---|---|
| Default: | "" |
| Valid Values: | non-null string, unique predicate aliases |
| Importance: | low |
The maximum duration in milliseconds that a failed operation will be reattempted. The default is 0, which means no retries will be attempted. Use -1 for infinite retries.
| Type: | long |
|---|---|
| Default: | 0 |
| Valid Values: | |
| Importance: | medium |
The maximum duration in milliseconds between consecutive retry attempts. Jitter will be added to the delay once this limit is reached to prevent thundering herd issues.
| Type: | long |
|---|---|
| Default: | 60000 (1 minute) |
| Valid Values: | |
| Importance: | medium |
Behavior for tolerating errors during connector operation. 'none' is the default value and signals that any error will result in an immediate connector task failure; 'all' changes the behavior to skip over problematic records.
| Type: | string |
|---|---|
| Default: | none |
| Valid Values: | [none, all] |
| Importance: | medium |
If true, write each error and the details of the failed operation and problematic record to the Connect application log. This is 'false' by default, so that only errors that are not tolerated are reported.
| Type: | boolean |
|---|---|
| Default: | false |
| Valid Values: | |
| Importance: | medium |
Whether to include in the log the Connect record that resulted in a failure. For sink records, the topic, partition, offset, and timestamp will be logged. For source records, the key and value (and their schemas), all headers, and the timestamp, Kafka topic, Kafka partition, source partition, and source offset will be logged. This is 'false' by default, which will prevent record keys, values, and headers from being written to log files.
| Type: | boolean |
|---|---|
| Default: | false |
| Valid Values: | |
| Importance: | medium |