Reference documentation and code samples for the Secret Manager V1 Client class CustomerManagedEncryption.
Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK).
Generated from protobuf message google.cloud.secretmanager.v1.CustomerManagedEncryption
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ kms_key_name |
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. For secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must reside in |
getKmsKeyName
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.
For secrets using the
Automatic
replication policy type, Cloud KMS CryptoKeys must reside in global.
The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.
| Returns | |
|---|---|
| Type | Description |
string | |
setKmsKeyName
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.
For secrets using the
Automatic
replication policy type, Cloud KMS CryptoKeys must reside in global.
The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |