Interface ClientEncryptionOptions

Additional settings to provide when creating a new ClientEncryption instance.

interface ClientEncryptionOptions {
    keyVaultClient?: MongoClient;
    keyVaultNamespace: string;
    kmsProviders?: KMSProviders;
    proxyOptions?: ProxyOptions;
    tlsOptions?: CSFLEKMSTlsOptions;
}

Index

Properties

keyVaultClient? keyVaultNamespace kmsProviders? proxyOptions? tlsOptions?

Properties

`Optional`keyVaultClient

keyVaultClient?: MongoClient

A MongoClient used to fetch keys from a key vault. Defaults to client.

keyVaultNamespace

keyVaultNamespace: string

The namespace of the key vault, used to store encryption keys

`Optional`kmsProviders

kmsProviders?: KMSProviders

Options for specific KMS providers to use

`Optional`proxyOptions

proxyOptions?: ProxyOptions

Options for specifying a Socks5 proxy to use for connecting to the KMS.

`Optional`tlsOptions

tlsOptions?: CSFLEKMSTlsOptions

TLS options for kms providers to use.