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\u003eThe latest version for \u003ccode\u003eDatabase.Types.CmekConfig\u003c/code\u003e is 3.12.0, with previous versions ranging from 3.11.0 down to 2.2.0, each linked to its respective documentation page.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eDatabase.Types.CmekConfig\u003c/code\u003e is a class that 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, within the \u003ccode\u003eGoogle.Cloud.Firestore.Admin.V1\u003c/code\u003e namespace.\u003c/p\u003e\n"],["\u003cp\u003eThis class configures Customer Managed Encryption Keys (CMEK) for a Firestore database, allowing for encryption with customer-managed keys instead of the default Google encryption key.\u003c/p\u003e\n"],["\u003cp\u003eThe class includes two constructors, \u003ccode\u003eCmekConfig()\u003c/code\u003e and \u003ccode\u003eCmekConfig(Database.Types.CmekConfig other)\u003c/code\u003e, and two properties: \u003ccode\u003eActiveKeyVersion\u003c/code\u003e to get the currently in-use KMS key versions and \u003ccode\u003eKmsKeyName\u003c/code\u003e to set the required key name for encryption, which must be in the same location as the database.\u003c/p\u003e\n"]]],[],null,[]]
