Class ClientEncryptionOptions

Namespace

MongoDB.Driver.Encryption

Assembly

MongoDB.Driver.dll

Client encryption options.

public class ClientEncryptionOptions

Inheritance

object

ClientEncryptionOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ClientEncryptionOptions(IMongoClient, CollectionNamespace, IReadOnlyDictionary<string, IReadOnlyDictionary<string, object>>, Optional<IReadOnlyDictionary<string, SslSettings>>)

Initializes a new instance of the ClientEncryptionOptions class.

public ClientEncryptionOptions(IMongoClient keyVaultClient, CollectionNamespace keyVaultNamespace, IReadOnlyDictionary<string, IReadOnlyDictionary<string, object>> kmsProviders, Optional<IReadOnlyDictionary<string, SslSettings>> tlsOptions = default)

Parameters

keyVaultClient IMongoClient

The key vault client.

keyVaultNamespace CollectionNamespace

The key vault namespace.

kmsProviders IReadOnlyDictionary<string, IReadOnlyDictionary<string, object>>

The KMS providers.

tlsOptions Optional<IReadOnlyDictionary<string, SslSettings>>

The tls options.

Properties

KeyVaultClient

Gets the key vault client.

public IMongoClient KeyVaultClient { get; }

Property Value

IMongoClient

The key vault client.

KeyVaultNamespace

Gets the key vault namespace.

public CollectionNamespace KeyVaultNamespace { get; }

Property Value

CollectionNamespace

The key vault namespace.

KmsProviders

Gets the KMS providers.

public IReadOnlyDictionary<string, IReadOnlyDictionary<string, object>> KmsProviders { get; }

Property Value

IReadOnlyDictionary<string, IReadOnlyDictionary<string, object>>

The KMS providers.

TlsOptions

Gets the tls options.

public IReadOnlyDictionary<string, SslSettings> TlsOptions { get; }

Property Value

IReadOnlyDictionary<string, SslSettings>

The tls options.

Methods

With(Optional<IMongoClient>, Optional<CollectionNamespace>, Optional<IReadOnlyDictionary<string, IReadOnlyDictionary<string, object>>>, Optional<IReadOnlyDictionary<string, SslSettings>>)

Returns a new ClientEncryptionOptions instance with some settings changed.

public ClientEncryptionOptions With(Optional<IMongoClient> keyVaultClient = default, Optional<CollectionNamespace> keyVaultNamespace = default, Optional<IReadOnlyDictionary<string, IReadOnlyDictionary<string, object>>> kmsProviders = default, Optional<IReadOnlyDictionary<string, SslSettings>> tlsOptions = default)

Parameters

keyVaultClient Optional<IMongoClient>

The key vault client.

keyVaultNamespace Optional<CollectionNamespace>

The key vault namespace.

kmsProviders Optional<IReadOnlyDictionary<string, IReadOnlyDictionary<string, object>>>

The KMS providers.

tlsOptions Optional<IReadOnlyDictionary<string, SslSettings>>

The tls options.

Returns

ClientEncryptionOptions

A new ClientEncryptionOptions instance.