Secret Manager V1 API - Class Google::Cloud::SecretManager::V1::CustomerManagedEncryption (v1.0.0)

Reference documentation and code samples for the Secret Manager V1 API class Google::Cloud::SecretManager::V1::CustomerManagedEncryption.

Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK).

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#kms_key_name

def kms_key_name() -> ::String
Returns
  • (::String) — Required. The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads.

    For secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the same location as the [replica location][Secret.UserManaged.Replica.location].

    For secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must reside in global.

    The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

#kms_key_name=

def kms_key_name=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads.

    For secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the same location as the [replica location][Secret.UserManaged.Replica.location].

    For secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must reside in global.

    The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

Returns
  • (::String) — Required. The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads.

    For secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the same location as the [replica location][Secret.UserManaged.Replica.location].

    For secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must reside in global.

    The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.