ADLS Sink properties reference

The properties listed in this reference must be added to the connector configuration with the following prefix:

parameter.[***CONNECTOR NAME***] Parameters:

In addition to the properties listed here, this connector also accepts certain properties of the Kafka Connect framework as well as the properties of the NiFi Stateless Sink connector. When creating a new connector using the SMM UI, all valid properties are presented in the default configuration template. You can view the configuration template to get a full list of valid properties. In addition, for more information regarding the accepted properties not listed here, you can review the Apache Kafka documentation and the Stateless NiFi Sink properties reference.

ADLS Account Key

Description: The Storage Account Key to use for authentication to Azure. Required when Account Key authentication is used.
Default Value
Accepted Values
Required: false

ADLS Account Name

Description: The name of the Azure Storage Account to use for authentication to Azure and the target account where the output file is uploaded.
Default Value
Accepted Values
Required: true

ADLS Directory Name

Description: The name of the directory where the output file is uploaded. Use an empty string to specify the root directory.
Default Value
Accepted Values
Required: true

ADLS Endpoint Suffix

Description: Specifies the endpoint suffix used for accessing the ADLS service.
Default Value: dfs.core.windows.net
Accepted Values
Required: true

ADLS Filesystem Name

Description: The name of the filesystem (or container) in the Azure Storage Account where the output file is uploaded.
Default Value
Accepted Values
Required: true

ADLS SAS Token

Description: The SAS Token to use for authentication to Azure. Required when SAS Token authentication is used.
Default Value
Accepted Values
Required: false

Avro Schema Write Strategy

Description

Specifies how the record schema is attached to the output data file. Applicable only for Avro output (Output File Data Format is set to Avro).

Do Not Write Schema: Neither the schema nor reference to the schema is attached to the output Avro messages.
Embed Avro Schema: The schema is embedded in every output Avro message.
HWX Content-Encoded Schema Reference: A reference to the schema (identified by Schema Name) within Schema Registry is encoded in the content of the outgoing Avro messages.

Default Value

Embed Avro Schema

Accepted Values

Embed Avro Schema, Do Not Write Schema, HWX Content-Encoded Schema Reference

Required

false

Azure Service Principal Client ID

Description: The Client ID of the Service Principal to use for authentication to Azure. Required when Service Principal authentication is used.
Default Value
Accepted Values
Required: false

Azure Service Principal Client Secret

Description: The Client Secret of the Service Principal to use for authentication to Azure. Required when Service Principal authentication is used.
Default Value
Accepted Values
Required: false

Azure Service Principal Tenant ID

Description: The Tenant ID of the Service Principal to use for authentication to Azure. Required when Service Principal authentication is used.
Default Value
Accepted Values
Required: false

Date Format

Description: Specifies the format to use when writing date fields to JSON or CSV.
Default Value: yyyy-MM-dd
Accepted Values
Required: true

Kafka Message Data Format

Description: Specifies the format of the messages the connector receives from Kafka. If set to Avro or JSON, record processing is enabled. Raw can be used for unstructured text or binary data.
Default Value: Avro
Accepted Values: Avro, JSON, Raw
Required: true

Kerberos Keytab

Description: The fully-qualified filename of the Kerberos keytab associated with the principal for accessing Schema Registry.
Default Value: The location of the default keytab which is empty and can only be used for unsecure connections.
Accepted Values
Required: true

Kerberos Principal

Description: The Kerberos principal used for authenticating to Schema Registry.
Default Value: default
Accepted Values
Required: true

Maximum File Size

Description: The maximum size of the output data file. No size limit is applied if this property is not specified. Example values: 100 MB, 1 GB.
Default Value
Accepted Values
Required: false

Maximum Number of Entries

Description: The maximum number of entries in the output data file. In the context of this property, entry can mean one of two things. If record processing is enabled (Output File Data Format is set to Avro or JSON), an entry is a record. Otherwise, entry means a Kafka message. Set this property to 1 if you want to create a separate output file for each Kafka message.
Default Value: 1000000
Accepted Values
Required: true

Output File Data Format

Description: Specifies the format of the records written to the output file. Required when record processing is enabled (Kafka Message Data Format is set to Avro or JSON).
Default Value: Avro
Accepted Values: Avro, JSON, CSV
Required: false

Output File Demarcator

Description: Specifies the character sequence for demarcating (delimiting) message boundaries when multiple Kafka messages are ingested into an output file as raw messages (no record processing). This property can only be used if Kafka Message Data Format is set to Raw. If you want to use newline as the delimiter, set this property to \n.
Default Value
Accepted Values
Required: false

Output Filename Pattern

Description

Specifies the structure of the name of the output file. The pattern can contain string literal (fixed text) parts and one or more of the following expressions:

${filename.uuid}: Inserts a generated UUID in the filename.
${filename.timestamp}: Inserts the current timestamp in the filename.
${filename.sequence}: Inserts an incrementing sequence value in the filename.

In order to generate unique filenames, either ${filename.uuid} or ${filename.sequence} must be used in the pattern.

Examples:

data_${filename.uuid}.json
records_${filename.timestamp}_${filename.sequence}.avro

Default Value

${filename.uuid}

Accepted Values

Required

false

Output Filename Sequence Initial Value

Description: This property is used to configure the initial value of the ${filename.sequence} expression. The value you set in this property is not the initial value of the sequence. The sequence starts at the value of this property +1. For example, if you set this property to 0, the sequence starts at 1.
Default Value: 0
Accepted Values
Required: false

Output Filename Sequence Padding Length

Description: Specifies the length of the ${filename.sequence} expression in characters. If the sequence has fewer characters than the value set in this property, it is padded with zeros (0). Padding is added to the left of the sequence.
Default Value: 6
Accepted Values
Required: false

Output Filename Timestamp Format

Description: The timestamp format to use for the ${filename.timestamp} expression. For example, yyyyMMdd_HHmmss_SSS.
Default Value
Accepted Values
Required: false

Schema Access Strategy

Description

Specifies the strategy used for determining the schema of the Kafka record. The value you set here depends on the data format set in

Kafka Message Data
              Format.

If set to Schema Registry, the schema is read from Schema Registry. This setting can be used with both Avro and JSON formats.
If set to Infer Schema, the schema is inferred based on the input file. This setting can only be used if Kafka Message Data Format is JSON.
If set to Embedded Schema, the schema embedded in the input is used. This setting can only be used if Kafka Message Data Format is Avro.
If set to HWX Content-Encoded Schema Reference, the schema is read from Schema Registry. This setting can only be used if Kafka Message Data Format is Avro. In this case the Avro messages are expected to have a reference to the schema in Schema Registry encoded within the message content.

This property is not used if record processing is disabled (

Kafka Message
              Data Format

is set to Raw).

Default Value

Schema Registry

Accepted Values

Schema Registry, Infer Schema, Embedded Schema, HWX Content-Encoded Schema Reference

Required

true

Schema Branch

Description: The name of the branch to use when looking up the schema in Schema Registry. Schema Branch and Schema Version cannot be specified at the same time. If one is specified, the other needs to be removed from the configuration. If Schema Registry is not used, this property must be completely removed from the configuration.
Default Value
Accepted Values
Required: false

Schema Name

Description: The schema name to look up in Schema Registry. If the Schema Access Strategy property is set to Schema Registry, this property must contain a valid schema name. If Schema Registry is not used, this property must be completely removed from the configuration JSON.
Default Value
Accepted Values
Required: false

Schema Registry URL

Description: The URL of the Schema Registry server. If Schema Registry is not used, this property must be completely removed from the configuration JSON.
Default Value: http://localhost:7788/api/v1
Accepted Values
Required: true

Schema Version

Description: The version of the schema to look up in Schema Registry. If Schema Registry is used and a schema version is not specified, the latest version of the schema is retrieved. Schema Branch and Schema Version cannot be specified at the same time. If one is specified, the other needs to be removed from the configuration. If Schema Registry is not used, this property must be completely removed from the configuration.
Default Value
Accepted Values
Required: false

Time Format

Description: Specifies the format to use when writing Time fields to JSON or CSV.
Default Value: HH:mm:ss
Accepted Values
Required: true

Timestamp Format

Description: Specifies the format to use when writing Timestamp fields to JSON or CSV.
Default Value: yyyy-MM-dd HH:mm:ss.SSS
Accepted Values
Required: true

Truststore Filename

Description: The fully-qualified filename of a truststore. This truststore is used to establish a secure connection with Schema Registry using HTTPS.
Default Value: The location of the default truststore which is empty and can only be used for unsecure connections.
Accepted Values
Required: true

Truststore Password

Description: The password used to access the contents of the truststore configured in the Truststore Filename property.
Default Value: password
Accepted Values
Required: true

Truststore Type

Description: The type of the truststore configured in the Truststore Filename property.
Default Value: JKS
Accepted Values: BCFKS, PKCS12, JKS
Required: true

Use Azure Managed Identity

Description: Turns on authentication using Managed Identity.
Default Value: false
Accepted Values: true, false
Required: true