prorm API Reference
    Preparing search index...

    Interface NeptuneStoreOptions

    interface NeptuneStoreOptions {
        endpoint?: string;
        port?: number;
        url?: string;
        useSsl?: boolean;
        traversalSource?: string;
        rejectUnauthorized?: boolean;
        headers?: Record<string, string>;
        authHeaderProvider?: NeptuneAuthHeaderProvider;
        connectionOptions?: Record<string, unknown>;
    }
    Index
    endpoint?: string

    Neptune cluster/instance endpoint hostname, e.g. 'my-cluster.cluster-xxxxxxxxxxxx.us-east-1.neptune.amazonaws.com'. Combined with port (default 8182) and useSsl (default true) into a wss://host:port/gremlin URL. Ignored if url is set.

    port?: number

    Port for endpoint. Defaults to 8182 (Neptune's default Gremlin websocket port).

    url?: string

    Full connection URL, e.g. 'wss://my-endpoint:8182/gremlin'. Takes precedence over endpoint/port/useSsl when set — use this for non-standard paths/ports or when connecting through a proxy/tunnel.

    useSsl?: boolean

    Whether to use wss:// (true, default) or plain ws:// (local testing only — Neptune itself requires TLS).

    traversalSource?: string

    Gremlin traversal source name on the server. Defaults to 'g'.

    rejectUnauthorized?: boolean

    Verify the server's TLS certificate. Defaults to true; only disable for local/self-signed test setups.

    headers?: Record<string, string>

    Static pre-signed IAM auth headers, merged with (and overridden by) authHeaderProvider's result if both are given. Omit entirely when connecting to a cluster with IAM auth disabled. See the "IAM authentication" section above.

    authHeaderProvider?: NeptuneAuthHeaderProvider

    Called on every connect() to obtain fresh pre-signed IAM auth headers. See the "IAM authentication" section above.

    connectionOptions?: Record<string, unknown>

    Passed straight through to the underlying DriverRemoteConnection/ Client constructors for anything not covered above (ca, cert, pfx, mimeType, agent, enableCompression, ...).