Distributed Cloud Edge Container V1 API - Class Google::Cloud::EdgeContainer::V1::Cluster::ControlPlaneEncryption (v0.1.1)

Reference documentation and code samples for the Distributed Cloud Edge Container V1 API class Google::Cloud::EdgeContainer::V1::Cluster::ControlPlaneEncryption.

Configuration for Customer-managed KMS key support for remote control plane cluster disk encryption.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#kms_key

def kms_key() -> ::String
Returns
  • (::String) — Immutable. The Cloud KMS CryptoKey e.g. projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} to use for protecting control plane disks. If not specified, a Google-managed key will be used instead.

#kms_key=

def kms_key=(value) -> ::String
Parameter
  • value (::String) — Immutable. The Cloud KMS CryptoKey e.g. projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} to use for protecting control plane disks. If not specified, a Google-managed key will be used instead.
Returns
  • (::String) — Immutable. The Cloud KMS CryptoKey e.g. projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} to use for protecting control plane disks. If not specified, a Google-managed key will be used instead.

#kms_key_active_version

def kms_key_active_version() -> ::String
Returns
  • (::String) — Output only. The Cloud KMS CryptoKeyVersion currently in use for protecting control plane disks. Only applicable if kms_key is set.

#kms_key_state

def kms_key_state() -> ::Google::Cloud::EdgeContainer::V1::KmsKeyState
Returns
  • (::Google::Cloud::EdgeContainer::V1::KmsKeyState) — Output only. Availability of the Cloud KMS CryptoKey. If not KEY_AVAILABLE, then nodes may go offline as they cannot access their local data. This can be caused by a lack of permissions to use the key, or if the key is disabled or deleted.

#kms_status

def kms_status() -> ::Google::Rpc::Status
Returns
  • (::Google::Rpc::Status) — Output only. Error status returned by Cloud KMS when using this key. This field may be populated only if kms_key_state is not KMS_KEY_STATE_KEY_AVAILABLE. If populated, this field contains the error status reported by Cloud KMS.