Use Customer Managed Encryption Keys (CMEK) for encryption.
GoogleDefaultEncryptionOptions
This type has no fields.
The configuration options for using Google default encryption.
SourceEncryptionOptions
This type has no fields.
The configuration options for using the same encryption method as the source.
CustomerManagedEncryptionOptions
The configuration options for using CMEK (Customer Managed Encryption Key) encryption.
JSON representation
{"kmsKeyName": string}
Fields
kmsKeyName
string
Required. Only keys in the same location as the 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/{projectId}/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"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-01 UTC."],[],[],null,["# EncryptionConfig\n\nEncryption configuration for a new database being created from another source.\n\nThe source could be a [Backup](/firestore/docs/reference/rest/v1/projects.locations.backups#Backup) .\n\nGoogleDefaultEncryptionOptions\n------------------------------\n\nThis type has no fields.\nThe configuration options for using Google default encryption.\n\nSourceEncryptionOptions\n-----------------------\n\nThis type has no fields.\nThe configuration options for using the same encryption method as the source.\n\nCustomerManagedEncryptionOptions\n--------------------------------\n\nThe configuration options for using CMEK (Customer Managed Encryption Key) encryption."]]