Reference documentation and code samples for the Cloud KMS V1 Client class ExternalProtectionLevelOptions.
ExternalProtectionLevelOptions stores a group of additional fields for
configuring aCryptoKeyVersionthat
are specific to theEXTERNALprotection level andEXTERNAL_VPCprotection
levels.
Generated from protobuf messagegoogle.cloud.kms.v1.ExternalProtectionLevelOptions
Namespace
Google \ Cloud \ Kms \ V1
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 thisCryptoKeyVersionrepresents.
↳ ekm_connection_key_path
string
The path to the external key material on the EKM when usingEkmConnectione.g., "v0/my/key". Set this field instead of external_key_uri when using anEkmConnection.
getExternalKeyUri
The URI for an external resource that thisCryptoKeyVersionrepresents.
Returns
Type
Description
string
setExternalKeyUri
The URI for an external resource that thisCryptoKeyVersionrepresents.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getEkmConnectionKeyPath
The path to the external key material on the EKM when usingEkmConnectione.g., "v0/my/key". Set
this field instead of external_key_uri when using anEkmConnection.
Returns
Type
Description
string
setEkmConnectionKeyPath
The path to the external key material on the EKM when usingEkmConnectione.g., "v0/my/key". Set
this field instead of external_key_uri when using anEkmConnection.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud KMS V1 Client - Class ExternalProtectionLevelOptions (2.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.1 (latest)](/php/docs/reference/cloud-kms/latest/V1.ExternalProtectionLevelOptions)\n- [2.3.0](/php/docs/reference/cloud-kms/2.3.0/V1.ExternalProtectionLevelOptions)\n- [2.2.0](/php/docs/reference/cloud-kms/2.2.0/V1.ExternalProtectionLevelOptions)\n- [2.1.6](/php/docs/reference/cloud-kms/2.1.6/V1.ExternalProtectionLevelOptions)\n- [2.0.0](/php/docs/reference/cloud-kms/2.0.0/V1.ExternalProtectionLevelOptions)\n- [1.23.0](/php/docs/reference/cloud-kms/1.23.0/V1.ExternalProtectionLevelOptions)\n- [1.22.1](/php/docs/reference/cloud-kms/1.22.1/V1.ExternalProtectionLevelOptions)\n- [1.21.4](/php/docs/reference/cloud-kms/1.21.4/V1.ExternalProtectionLevelOptions)\n- [1.20.3](/php/docs/reference/cloud-kms/1.20.3/V1.ExternalProtectionLevelOptions)\n- [1.19.0](/php/docs/reference/cloud-kms/1.19.0/V1.ExternalProtectionLevelOptions)\n- [1.18.1](/php/docs/reference/cloud-kms/1.18.1/V1.ExternalProtectionLevelOptions)\n- [1.17.0](/php/docs/reference/cloud-kms/1.17.0/V1.ExternalProtectionLevelOptions)\n- [1.16.4](/php/docs/reference/cloud-kms/1.16.4/V1.ExternalProtectionLevelOptions)\n- [1.15.3](/php/docs/reference/cloud-kms/1.15.3/V1.ExternalProtectionLevelOptions) \nReference documentation and code samples for the Cloud KMS V1 Client class ExternalProtectionLevelOptions.\n\nExternalProtectionLevelOptions stores a group of additional fields for\nconfiguring a [CryptoKeyVersion](/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion) that\nare specific to the [EXTERNAL](/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel#_Google_Cloud_Kms_V1_ProtectionLevel__EXTERNAL)\nprotection level and\n[EXTERNAL_VPC](/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel#_Google_Cloud_Kms_V1_ProtectionLevel__EXTERNAL_VPC) protection\nlevels.\n\nGenerated from protobuf message `google.cloud.kms.v1.ExternalProtectionLevelOptions`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Kms \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getExternalKeyUri\n\nThe URI for an external resource that this\n[CryptoKeyVersion](/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion) represents.\n\n### setExternalKeyUri\n\nThe URI for an external resource that this\n[CryptoKeyVersion](/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion) represents.\n\n### getEkmConnectionKeyPath\n\nThe path to the external key material on the EKM when using\n[EkmConnection](/php/docs/reference/cloud-kms/latest/V1.EkmConnection) e.g., \"v0/my/key\". Set\nthis field instead of external_key_uri when using an\n[EkmConnection](/php/docs/reference/cloud-kms/latest/V1.EkmConnection).\n\n### setEkmConnectionKeyPath\n\nThe path to the external key material on the EKM when using\n[EkmConnection](/php/docs/reference/cloud-kms/latest/V1.EkmConnection) e.g., \"v0/my/key\". Set\nthis field instead of external_key_uri when using an\n[EkmConnection](/php/docs/reference/cloud-kms/latest/V1.EkmConnection)."]]
