Reference documentation and code samples for the Cloud Firestore V1 Client class 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.
Generated from protobuf message google.firestore.admin.v1.Database.CmekConfig
Namespace
Google \ Cloud \ Firestore \ Admin \ V1 \ DatabaseMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ kms_key_name
string
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}
.
↳ active_key_version
array
Output only. Currently in-use KMS key versions
. During key rotation
, there can be multiple in-use key versions. The expected format is projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}
.
getKmsKeyName
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}
.
string
setKmsKeyName
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}
.
var
string
$this
getActiveKeyVersion
Output only. Currently in-use KMS key versions .
During key rotation
,
there can be multiple in-use key versions.
The expected format is projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}
.
setActiveKeyVersion
Output only. Currently in-use KMS key versions .
During key rotation
,
there can be multiple in-use key versions.
The expected format is projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}
.
var
string[]
$this
