public sealed class Database.Types.CmekConfig : IMessage<Database.Types.CmekConfig>, IEquatable<Database.Types.CmekConfig>, IDeepCloneable<Database.Types.CmekConfig>, IBufferMessage, IMessage
Reference documentation and code samples for the Firestore Admin v1 API class Database.Types.CmekConfig.
The CMEK (Customer Managed Encryption Key) configuration for a Firestore
database. If not present, the database is secured by the default Google
encryption key.
Required. Only keys in the same location as this database are allowed to
be used for encryption.
For Firestore's nam5 multi-region, this corresponds to Cloud KMS
multi-region us. For Firestore's eur3 multi-region, this corresponds to
Cloud KMS multi-region europe. See
https://cloud.google.com/kms/docs/locations.
The expected format is
projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis documentation provides reference information for the \u003ccode\u003eDatabase.Types.CmekConfig\u003c/code\u003e class within the Firestore Admin v1 API, specifically for .NET development.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCmekConfig\u003c/code\u003e is used to define Customer Managed Encryption Key (CMEK) settings for a Firestore database, allowing control over encryption keys instead of using default Google encryption.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCmekConfig\u003c/code\u003e class includes properties such as \u003ccode\u003eActiveKeyVersion\u003c/code\u003e which displays the KMS key versions in current use, and \u003ccode\u003eKmsKeyName\u003c/code\u003e that specifies the encryption key for the database and mandates that the keys are in the same location.\u003c/p\u003e\n"],["\u003cp\u003eThis class inherits from \u003ccode\u003eobject\u003c/code\u003e and implements several interfaces including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, enhancing its functionality within the .NET ecosystem.\u003c/p\u003e\n"],["\u003cp\u003eThe documentation covers various versions of the .NET package for Firestore Admin v1 API, ranging from version 2.2.0 up to the latest version, 3.12.0, giving access to previous versions of \u003ccode\u003eCmekConfig\u003c/code\u003e in the event it's needed.\u003c/p\u003e\n"]]],[],null,[]]