Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig::CustomerManagedEncryptionOptions.
The configuration options for using CMEK (Customer Managed Encryption
Key) encryption.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#kms_key_name
defkms_key_name()->::String
Returns
(::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/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
#kms_key_name=
defkms_key_name=(value)->::String
Parameter
value (::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/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
Returns
(::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/{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"]],[["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-09-04 UTC."],[],[],null,["# Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig::CustomerManagedEncryptionOptions (v1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [1.6.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.6.0/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [1.5.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.5.0/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [1.4.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.4.1/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [1.3.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.3.0/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [1.2.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.2.0/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [1.1.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.1.0/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [1.0.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.0.1/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [0.18.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.18.0/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [0.17.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.17.1/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [0.16.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.16.0/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [0.15.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.15.0/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [0.14.3](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.14.3/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [0.13.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.13.0/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [0.12.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.12.0/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [0.11.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.11.0/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [0.10.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.10.0/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [0.9.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.9.0/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [0.8.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.8.0/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [0.7.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.7.1/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [0.6.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.6.0/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [0.5.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.5.0/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [0.4.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.4.0/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions)\n- [0.3.5](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.3.5/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig-CustomerManagedEncryptionOptions) \nReference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig::CustomerManagedEncryptionOptions.\n\nThe configuration options for using CMEK (Customer Managed Encryption\nKey) encryption. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #kms_key_name\n\n def kms_key_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. Only keys in the same location as the database are allowed to be used for encryption.\n\n For Firestore's nam5 multi-region, this corresponds to Cloud KMS\n multi-region us. For Firestore's eur3 multi-region, this corresponds to\n Cloud KMS multi-region europe. See\n https://cloud.google.com/kms/docs/locations.\n\n The expected format is\n `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.\n\n### #kms_key_name=\n\n def kms_key_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. Only keys in the same location as the database are allowed to be used for encryption.\n\n\n For Firestore's nam5 multi-region, this corresponds to Cloud KMS\n multi-region us. For Firestore's eur3 multi-region, this corresponds to\n Cloud KMS multi-region europe. See\n https://cloud.google.com/kms/docs/locations.\n\n The expected format is\n`projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. \n**Returns**\n\n- (::String) --- Required. Only keys in the same location as the database are allowed to be used for encryption.\n\n For Firestore's nam5 multi-region, this corresponds to Cloud KMS\n multi-region us. For Firestore's eur3 multi-region, this corresponds to\n Cloud KMS multi-region europe. See\n https://cloud.google.com/kms/docs/locations.\n\n The expected format is\n `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`."]]
