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 message google.bigtable.admin.v2.Cluster.EncryptionConfig
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 the |
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 the
cloudkms.cryptoKeyEncrypterDecrypter role 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.
3) All clusters within an instance must use the same CMEK key.
Values are of the form
projects/{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 the
cloudkms.cryptoKeyEncrypterDecrypter role 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.
3) All clusters within an instance must use the same CMEK key.
Values are of the form
projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |