prorm API Reference
    Preparing search index...

    Interface KinesisStoreOptions

    Connection options for KinesisStore.

    interface KinesisStoreOptions {
        region?: string;
        credentials?: {
            accessKeyId: string;
            secretAccessKey: string;
            sessionToken?: string;
        };
        endpoint?: string;
        client?: KinesisClientLike;
    }
    Index
    region? credentials? endpoint? client?
    region?: string

    AWS region, e.g. 'us-east-1'.

    credentials?: {
        accessKeyId: string;
        secretAccessKey: string;
        sessionToken?: string;
    }

    Static credentials. Omit to use the default AWS credential provider chain.

    endpoint?: string

    Override the service endpoint (e.g. 'http://localhost:4566' for LocalStack).

    client?: KinesisClientLike

    A pre-built KinesisClient (or compatible object). When provided, connect() uses it directly and does NOT require the SDK — this is how tests inject a mock client.

    Settings
    Member Visibility

    On This Page
    Properties