Interface ClientEncryptionCreateDataKeyProviderOptions

Options to provide when creating a new data key.

interface ClientEncryptionCreateDataKeyProviderOptions {
    keyAltNames?: string[];
    keyMaterial?: Buffer<ArrayBufferLike> | Binary;
    masterKey?:
        | AWSEncryptionKeyOptions
        | AzureEncryptionKeyOptions
        | GCPEncryptionKeyOptions
        | KMIPEncryptionKeyOptions;
}

Properties

keyAltNames? keyMaterial? masterKey?

Properties

OptionalkeyAltNames

keyAltNames?: string[]

An optional list of string alternate names used to reference a key. If a key is created with alternate names, then encryption may refer to the key by the unique alternate name instead of by _id.

OptionalkeyMaterial

keyMaterial?: Buffer<ArrayBufferLike> | Binary

Optional 96-byte custom key material used when creating a data key instead of libmongocrypt’s random material. *

OptionalmasterKey

masterKey?:
    | AWSEncryptionKeyOptions
    | AzureEncryptionKeyOptions
    | GCPEncryptionKeyOptions
    | KMIPEncryptionKeyOptions

Identifies a new KMS-specific key used to encrypt the new data key

Settings

Member Visibility

On This Page

Properties