Reference documentation and code samples for the Cloud Firestore V1 Client class CustomerManagedEncryptionOptions.
The configuration options for using CMEK (Customer Managed Encryption Key) encryption.
Generated from protobuf message google.firestore.admin.v1.Database.EncryptionConfig.CustomerManagedEncryptionOptions
Namespace
Google \ Cloud \ Firestore \ Admin \ V1 \ Database \ EncryptionConfigMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ kms_key_name |
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 |
getKmsKeyName
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 | |
|---|---|
| Type | Description |
string |
|
setKmsKeyName
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}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|