Interface KMSProviders

Configuration options that are used by specific KMS providers during key generation, encryption, and decryption.

Named KMS providers are not supported for automatic KMS credential fetching.

interface KMSProviders {
    aws?: AWSKMSProviderConfiguration | Record<string, never>;
    azure?: AzureKMSProviderConfiguration | Record<string, never>;
    gcp?: GCPKMSProviderConfiguration | Record<string, never>;
    kmip?: KMIPKMSProviderConfiguration;
    local?: LocalKMSProviderConfiguration;
    [key: `aws:${string}`]: AWSKMSProviderConfiguration;
    [key: `local:${string}`]: LocalKMSProviderConfiguration;
    [key: `kmip:${string}`]: KMIPKMSProviderConfiguration;
    [key: `azure:${string}`]: AzureKMSProviderConfiguration;
    [key: `gcp:${string}`]: GCPKMSProviderConfiguration;
}

Indexable

Properties

aws? azure? gcp? kmip? local?

Properties

Optionalaws

aws?: AWSKMSProviderConfiguration | Record<string, never>

Configuration options for using 'aws' as your KMS provider

Optionalazure

azure?: AzureKMSProviderConfiguration | Record<string, never>

Configuration options for using 'azure' as your KMS provider

Optionalgcp

gcp?: GCPKMSProviderConfiguration | Record<string, never>

Configuration options for using 'gcp' as your KMS provider

Optionalkmip

kmip?: KMIPKMSProviderConfiguration

Configuration options for using 'kmip' as your KMS provider

Optionallocal

local?: LocalKMSProviderConfiguration

Configuration options for using 'local' as your KMS provider

Settings

Member Visibility

On This Page

Properties