Databricks SDK for JavaScript
    Preparing search index...

    Interface KinesisStreamConfig

    Kinesis-specific configuration for a Stream. For the underlying connector and its source options, see the documentation on connecting to Amazon Kinesis (https://docs.databricks.com/aws/en/connect/streaming/kinesis).

    interface KinesisStreamConfig {
        extraOptions?: Record<string, string>;
        streamIdentifier?:
            | { $case: "streamNames"; streamNames: StreamNameList }
            | { $case: "streamArns"; streamArns: StreamArnList };
    }
    Index

    Properties

    extraOptions? streamIdentifier?

    Properties

    extraOptions?: Record<string, string>

    Optional Kinesis source options, validated against a server-side allowlist at request time. Allowed keys:

    • consumerMode
    • consumerNamePrefix
    • maxFetchRate
    • minFetchPeriod
    • maxFetchDuration
    • maxRecordsPerFetch
    • shardsPerTask
    • fetchBufferSize
    • shardFetchInterval consumerMode must be efo or polling (case-insensitive). maxRecordsPerFetch applies only during ingestion and does not affect the materialization pipeline. Auth and connection details belong on the parent Stream's connection_config, not here.
    streamIdentifier?:
        | { $case: "streamNames"; streamNames: StreamNameList }
        | { $case: "streamArns"; streamArns: StreamArnList }

    Identifies the Kinesis data stream(s) to read from. Set exactly one of stream_names or stream_arns (identify the streams by name or by ARN, but not both). A single Stream may read from one or more Kinesis streams.

    Type Declaration

    Settings

    Member Visibility

    On This Page

    Properties