Reference documentation and code samples for the Cloud Bigtable Admin V2 API class Google::Cloud::Bigtable::Admin::V2::Cluster::EncryptionConfig.
Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#kms_key_name
def kms_key_name() -> ::String
Returns
-
(::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
cloudkms.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. 3) All clusters within an instance must use the same CMEK key. Values are of the formprojects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}
#kms_key_name=
def kms_key_name=(value) -> ::String
Parameter
-
value (::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
cloudkms.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. 3) All clusters within an instance must use the same CMEK key. Values are of the formprojects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}
Returns
-
(::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
cloudkms.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. 3) All clusters within an instance must use the same CMEK key. Values are of the formprojects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}