Reference documentation and code samples for the Cloud Bigtable V2 Client class EncryptionConfig.
Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected
cluster.
Generated from protobuf messagegoogle.bigtable.admin.v2.Cluster.EncryptionConfig
Namespace
Google \ Cloud \ Bigtable \ Admin \ V2 \ Cluster
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ kms_key_name
string
Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted thecloudkms.cryptoKeyEncrypterDecrypterrole on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. Values are of the formprojects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}
getKmsKeyName
Describes the Cloud KMS encryption key that will be used to protect the
destination Bigtable cluster. The requirements for this key are:
1) The Cloud Bigtable service account associated with the project that
contains this cluster must be granted thecloudkms.cryptoKeyEncrypterDecrypterrole on the CMEK key.
2) Only regional keys can be used and the region of the CMEK key must
match the region of the cluster.
Values are of the formprojects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}
Returns
Type
Description
string
setKmsKeyName
Describes the Cloud KMS encryption key that will be used to protect the
destination Bigtable cluster. The requirements for this key are:
1) The Cloud Bigtable service account associated with the project that
contains this cluster must be granted thecloudkms.cryptoKeyEncrypterDecrypterrole on the CMEK key.
2) Only regional keys can be used and the region of the CMEK key must
match the region of the cluster.
Values are of the formprojects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{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 Bigtable V2 Client - Class EncryptionConfig (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/Admin.V2.Cluster.EncryptionConfig)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/Admin.V2.Cluster.EncryptionConfig)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/Admin.V2.Cluster.EncryptionConfig)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/Admin.V2.Cluster.EncryptionConfig)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/Admin.V2.Cluster.EncryptionConfig)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/Admin.V2.Cluster.EncryptionConfig)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/Admin.V2.Cluster.EncryptionConfig)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/Admin.V2.Cluster.EncryptionConfig)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/Admin.V2.Cluster.EncryptionConfig)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/Admin.V2.Cluster.EncryptionConfig)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/Admin.V2.Cluster.EncryptionConfig)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/Admin.V2.Cluster.EncryptionConfig)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/Admin.V2.Cluster.EncryptionConfig)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/Admin.V2.Cluster.EncryptionConfig)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/Admin.V2.Cluster.EncryptionConfig)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/Admin.V2.Cluster.EncryptionConfig)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/Admin.V2.Cluster.EncryptionConfig)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/Admin.V2.Cluster.EncryptionConfig)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/Admin.V2.Cluster.EncryptionConfig)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/Admin.V2.Cluster.EncryptionConfig)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/Admin.V2.Cluster.EncryptionConfig)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/Admin.V2.Cluster.EncryptionConfig)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/Admin.V2.Cluster.EncryptionConfig)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/Admin.V2.Cluster.EncryptionConfig)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/Admin.V2.Cluster.EncryptionConfig)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/Admin.V2.Cluster.EncryptionConfig)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/Admin.V2.Cluster.EncryptionConfig)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/Admin.V2.Cluster.EncryptionConfig)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/Admin.V2.Cluster.EncryptionConfig)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/Admin.V2.Cluster.EncryptionConfig)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/Admin.V2.Cluster.EncryptionConfig) \nReference documentation and code samples for the Cloud Bigtable V2 Client class EncryptionConfig.\n\nCloud Key Management Service (Cloud KMS) settings for a CMEK-protected\ncluster.\n\nGenerated from protobuf message `google.bigtable.admin.v2.Cluster.EncryptionConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ Admin \\\\ V2 \\\\ Cluster\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getKmsKeyName\n\nDescribes the Cloud KMS encryption key that will be used to protect the\ndestination Bigtable cluster. The requirements for this key are:\n1) The Cloud Bigtable service account associated with the project that\ncontains this cluster must be granted the\n`cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key.\n\n2) Only regional keys can be used and the region of the CMEK key must\nmatch the region of the cluster.\nValues are of the form\n`projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`\n\n### setKmsKeyName\n\nDescribes the Cloud KMS encryption key that will be used to protect the\ndestination Bigtable cluster. The requirements for this key are:\n1) The Cloud Bigtable service account associated with the project that\ncontains this cluster must be granted the\n`cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key.\n\n2) Only regional keys can be used and the region of the CMEK key must\nmatch the region of the cluster.\nValues are of the form\n`projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`"]]
