Reference documentation and code samples for the Cloud KMS V1 Client class ExternalProtectionLevelOptions.
ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
Generated from protobuf message google.cloud.kms.v1.ExternalProtectionLevelOptions
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ external_key_uri |
string
The URI for an external resource that this CryptoKeyVersion represents. |
↳ ekm_connection_key_path |
string
The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. |
getExternalKeyUri
The URI for an external resource that this CryptoKeyVersion represents.
| Returns | |
|---|---|
| Type | Description |
string | |
setExternalKeyUri
The URI for an external resource that this CryptoKeyVersion represents.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEkmConnectionKeyPath
The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
| Returns | |
|---|---|
| Type | Description |
string | |
setEkmConnectionKeyPath
The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |