Optional. A list ofServiceResolverswhere the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a singleServiceResolveris supported.
↳ etag
string
Optional. Etag of the currently storedEkmConnection.
↳ key_management_mode
int
Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults toMANUAL.
Optional. A list ofServiceResolverswhere
the EKM can be reached. There should be one ServiceResolver per EKM
replica. Currently, only a singleServiceResolveris
supported.
Optional. A list ofServiceResolverswhere
the EKM can be reached. There should be one ServiceResolver per EKM
replica. Currently, only a singleServiceResolveris
supported.
[[["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 EkmConnection (2.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.1 (latest)](/php/docs/reference/cloud-kms/latest/V1.EkmConnection)\n- [2.3.0](/php/docs/reference/cloud-kms/2.3.0/V1.EkmConnection)\n- [2.2.0](/php/docs/reference/cloud-kms/2.2.0/V1.EkmConnection)\n- [2.1.6](/php/docs/reference/cloud-kms/2.1.6/V1.EkmConnection)\n- [2.0.0](/php/docs/reference/cloud-kms/2.0.0/V1.EkmConnection)\n- [1.23.0](/php/docs/reference/cloud-kms/1.23.0/V1.EkmConnection)\n- [1.22.1](/php/docs/reference/cloud-kms/1.22.1/V1.EkmConnection)\n- [1.21.4](/php/docs/reference/cloud-kms/1.21.4/V1.EkmConnection)\n- [1.20.3](/php/docs/reference/cloud-kms/1.20.3/V1.EkmConnection)\n- [1.19.0](/php/docs/reference/cloud-kms/1.19.0/V1.EkmConnection)\n- [1.18.1](/php/docs/reference/cloud-kms/1.18.1/V1.EkmConnection)\n- [1.17.0](/php/docs/reference/cloud-kms/1.17.0/V1.EkmConnection)\n- [1.16.4](/php/docs/reference/cloud-kms/1.16.4/V1.EkmConnection)\n- [1.15.3](/php/docs/reference/cloud-kms/1.15.3/V1.EkmConnection) \nReference documentation and code samples for the Cloud KMS V1 Client class EkmConnection.\n\nAn [EkmConnection](/php/docs/reference/cloud-kms/latest/V1.EkmConnection) represents an\nindividual EKM connection. It can be used for creating\n[CryptoKeys](/php/docs/reference/cloud-kms/latest/V1.CryptoKey) and\n[CryptoKeyVersions](/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion) with a\n[ProtectionLevel](/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel) of\n[EXTERNAL_VPC](/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel#_Google_Cloud_Kms_V1_ProtectionLevel__EXTERNAL_VPC), as well as\nperforming cryptographic operations using keys created within the\n[EkmConnection](/php/docs/reference/cloud-kms/latest/V1.EkmConnection).\n\nGenerated from protobuf message `google.cloud.kms.v1.EkmConnection`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Kms \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. The resource name for the\n[EkmConnection](/php/docs/reference/cloud-kms/latest/V1.EkmConnection) in the format\n`projects/*/locations/*/ekmConnections/*`.\n\n### setName\n\nOutput only. The resource name for the\n[EkmConnection](/php/docs/reference/cloud-kms/latest/V1.EkmConnection) in the format\n`projects/*/locations/*/ekmConnections/*`.\n\n### getCreateTime\n\nOutput only. The time at which the\n[EkmConnection](/php/docs/reference/cloud-kms/latest/V1.EkmConnection) was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. The time at which the\n[EkmConnection](/php/docs/reference/cloud-kms/latest/V1.EkmConnection) was created.\n\n### getServiceResolvers\n\nOptional. A list of\n[ServiceResolvers](/php/docs/reference/cloud-kms/latest/V1.EkmConnection.ServiceResolver) where\nthe EKM can be reached. There should be one ServiceResolver per EKM\nreplica. Currently, only a single\n[ServiceResolver](/php/docs/reference/cloud-kms/latest/V1.EkmConnection.ServiceResolver) is\nsupported.\n\n### setServiceResolvers\n\nOptional. A list of\n[ServiceResolvers](/php/docs/reference/cloud-kms/latest/V1.EkmConnection.ServiceResolver) where\nthe EKM can be reached. There should be one ServiceResolver per EKM\nreplica. Currently, only a single\n[ServiceResolver](/php/docs/reference/cloud-kms/latest/V1.EkmConnection.ServiceResolver) is\nsupported.\n\n### getEtag\n\nOptional. Etag of the currently stored\n[EkmConnection](/php/docs/reference/cloud-kms/latest/V1.EkmConnection).\n\n### setEtag\n\nOptional. Etag of the currently stored\n[EkmConnection](/php/docs/reference/cloud-kms/latest/V1.EkmConnection).\n\n### getKeyManagementMode\n\nOptional. Describes who can perform control plane operations on the EKM. If\nunset, this defaults to\n[MANUAL](/php/docs/reference/cloud-kms/latest/V1.EkmConnection.KeyManagementMode#_Google_Cloud_Kms_V1_EkmConnection_KeyManagementMode__MANUAL).\n\n### setKeyManagementMode\n\nOptional. Describes who can perform control plane operations on the EKM. If\nunset, this defaults to\n[MANUAL](/php/docs/reference/cloud-kms/latest/V1.EkmConnection.KeyManagementMode#_Google_Cloud_Kms_V1_EkmConnection_KeyManagementMode__MANUAL).\n\n### getCryptoSpacePath\n\nOptional. Identifies the EKM Crypto Space that this\n[EkmConnection](/php/docs/reference/cloud-kms/latest/V1.EkmConnection) maps to. Note: This\nfield is required if\n[KeyManagementMode](/php/docs/reference/cloud-kms/latest/V1.EkmConnection.KeyManagementMode) is\n[CLOUD_KMS](/php/docs/reference/cloud-kms/latest/V1.EkmConnection.KeyManagementMode#_Google_Cloud_Kms_V1_EkmConnection_KeyManagementMode__CLOUD_KMS).\n\n### setCryptoSpacePath\n\nOptional. Identifies the EKM Crypto Space that this\n[EkmConnection](/php/docs/reference/cloud-kms/latest/V1.EkmConnection) maps to. Note: This\nfield is required if\n[KeyManagementMode](/php/docs/reference/cloud-kms/latest/V1.EkmConnection.KeyManagementMode) is\n[CLOUD_KMS](/php/docs/reference/cloud-kms/latest/V1.EkmConnection.KeyManagementMode#_Google_Cloud_Kms_V1_EkmConnection_KeyManagementMode__CLOUD_KMS)."]]
