Reference documentation and code samples for the KMS Inventory V1 API class Google::Cloud::Kms::V1::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.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#ekm_connection_key_path
defekm_connection_key_path()->::String
Returns
(::String) — The path to the external key material on the EKM when using
[EkmConnection][google.cloud.kms.v1.EkmConnection] e.g., "v0/my/key". Set
this field instead of external_key_uri when using an
[EkmConnection][google.cloud.kms.v1.EkmConnection].
#ekm_connection_key_path=
defekm_connection_key_path=(value)->::String
Parameter
value (::String) — The path to the external key material on the EKM when using
[EkmConnection][google.cloud.kms.v1.EkmConnection] e.g., "v0/my/key". Set
this field instead of external_key_uri when using an
[EkmConnection][google.cloud.kms.v1.EkmConnection].
Returns
(::String) — The path to the external key material on the EKM when using
[EkmConnection][google.cloud.kms.v1.EkmConnection] e.g., "v0/my/key". Set
this field instead of external_key_uri when using an
[EkmConnection][google.cloud.kms.v1.EkmConnection].
#external_key_uri
defexternal_key_uri()->::String
Returns
(::String) — The URI for an external resource that this
CryptoKeyVersion represents.
#external_key_uri=
defexternal_key_uri=(value)->::String
Parameter
value (::String) — The URI for an external resource that this
CryptoKeyVersion represents.
Returns
(::String) — The URI for an external resource that this
CryptoKeyVersion represents.
[[["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-09 UTC."],[],[],null,["# KMS Inventory V1 API - Class Google::Cloud::Kms::V1::ExternalProtectionLevelOptions (v0.15.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.15.1 (latest)](/ruby/docs/reference/google-cloud-kms-inventory-v1/latest/Google-Cloud-Kms-V1-ExternalProtectionLevelOptions)\n- [0.15.0](/ruby/docs/reference/google-cloud-kms-inventory-v1/0.15.0/Google-Cloud-Kms-V1-ExternalProtectionLevelOptions)\n- [0.14.1](/ruby/docs/reference/google-cloud-kms-inventory-v1/0.14.1/Google-Cloud-Kms-V1-ExternalProtectionLevelOptions)\n- [0.13.0](/ruby/docs/reference/google-cloud-kms-inventory-v1/0.13.0/Google-Cloud-Kms-V1-ExternalProtectionLevelOptions)\n- [0.12.2](/ruby/docs/reference/google-cloud-kms-inventory-v1/0.12.2/Google-Cloud-Kms-V1-ExternalProtectionLevelOptions)\n- [0.11.3](/ruby/docs/reference/google-cloud-kms-inventory-v1/0.11.3/Google-Cloud-Kms-V1-ExternalProtectionLevelOptions)\n- [0.10.0](/ruby/docs/reference/google-cloud-kms-inventory-v1/0.10.0/Google-Cloud-Kms-V1-ExternalProtectionLevelOptions)\n- [0.9.1](/ruby/docs/reference/google-cloud-kms-inventory-v1/0.9.1/Google-Cloud-Kms-V1-ExternalProtectionLevelOptions)\n- [0.8.3](/ruby/docs/reference/google-cloud-kms-inventory-v1/0.8.3/Google-Cloud-Kms-V1-ExternalProtectionLevelOptions)\n- [0.7.0](/ruby/docs/reference/google-cloud-kms-inventory-v1/0.7.0/Google-Cloud-Kms-V1-ExternalProtectionLevelOptions)\n- [0.6.1](/ruby/docs/reference/google-cloud-kms-inventory-v1/0.6.1/Google-Cloud-Kms-V1-ExternalProtectionLevelOptions)\n- [0.5.0](/ruby/docs/reference/google-cloud-kms-inventory-v1/0.5.0/Google-Cloud-Kms-V1-ExternalProtectionLevelOptions)\n- [0.4.0](/ruby/docs/reference/google-cloud-kms-inventory-v1/0.4.0/Google-Cloud-Kms-V1-ExternalProtectionLevelOptions)\n- [0.3.0](/ruby/docs/reference/google-cloud-kms-inventory-v1/0.3.0/Google-Cloud-Kms-V1-ExternalProtectionLevelOptions)\n- [0.2.1](/ruby/docs/reference/google-cloud-kms-inventory-v1/0.2.1/Google-Cloud-Kms-V1-ExternalProtectionLevelOptions)\n- [0.1.0](/ruby/docs/reference/google-cloud-kms-inventory-v1/0.1.0/Google-Cloud-Kms-V1-ExternalProtectionLevelOptions) \nReference documentation and code samples for the KMS Inventory V1 API class Google::Cloud::Kms::V1::ExternalProtectionLevelOptions.\n\nExternalProtectionLevelOptions stores a group of additional fields for\nconfiguring a [CryptoKeyVersion](/ruby/docs/reference/google-cloud-kms-inventory-v1/latest/Google-Cloud-Kms-V1-CryptoKeyVersion \"Google::Cloud::Kms::V1::CryptoKeyVersion (class)\") that\nare specific to the [EXTERNAL](/ruby/docs/reference/google-cloud-kms-inventory-v1/latest/Google-Cloud-Kms-V1-ProtectionLevel#Google__Cloud__Kms__V1__ProtectionLevel__EXTERNAL \"Google::Cloud::Kms::V1::ProtectionLevel::EXTERNAL (constant)\")\nprotection level and\n[EXTERNAL_VPC](/ruby/docs/reference/google-cloud-kms-inventory-v1/latest/Google-Cloud-Kms-V1-ProtectionLevel#Google__Cloud__Kms__V1__ProtectionLevel__EXTERNAL_VPC \"Google::Cloud::Kms::V1::ProtectionLevel::EXTERNAL_VPC (constant)\") protection\nlevels. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #ekm_connection_key_path\n\n def ekm_connection_key_path() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The path to the external key material on the EKM when using \\[EkmConnection\\]\\[google.cloud.kms.v1.EkmConnection\\] e.g., \"v0/my/key\". Set this field instead of external_key_uri when using an \\[EkmConnection\\]\\[google.cloud.kms.v1.EkmConnection\\].\n\n### #ekm_connection_key_path=\n\n def ekm_connection_key_path=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The path to the external key material on the EKM when using \\[EkmConnection\\]\\[google.cloud.kms.v1.EkmConnection\\] e.g., \"v0/my/key\". Set this field instead of external_key_uri when using an \\[EkmConnection\\]\\[google.cloud.kms.v1.EkmConnection\\]. \n**Returns**\n\n- (::String) --- The path to the external key material on the EKM when using \\[EkmConnection\\]\\[google.cloud.kms.v1.EkmConnection\\] e.g., \"v0/my/key\". Set this field instead of external_key_uri when using an \\[EkmConnection\\]\\[google.cloud.kms.v1.EkmConnection\\].\n\n### #external_key_uri\n\n def external_key_uri() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The URI for an external resource that this [CryptoKeyVersion](/ruby/docs/reference/google-cloud-kms-inventory-v1/latest/Google-Cloud-Kms-V1-CryptoKeyVersion \"Google::Cloud::Kms::V1::CryptoKeyVersion (class)\") represents.\n\n### #external_key_uri=\n\n def external_key_uri=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The URI for an external resource that this [CryptoKeyVersion](/ruby/docs/reference/google-cloud-kms-inventory-v1/latest/Google-Cloud-Kms-V1-CryptoKeyVersion \"Google::Cloud::Kms::V1::CryptoKeyVersion (class)\") represents. \n**Returns**\n\n- (::String) --- The URI for an external resource that this [CryptoKeyVersion](/ruby/docs/reference/google-cloud-kms-inventory-v1/latest/Google-Cloud-Kms-V1-CryptoKeyVersion \"Google::Cloud::Kms::V1::CryptoKeyVersion (class)\") represents."]]