public sealed class EkmConnection : IMessage<EkmConnection>, IEquatable<EkmConnection>, IDeepCloneable<EkmConnection>, IBufferMessage, IMessage
Reference documentation and code samples for the Google Cloud Key Management Service v1 API class EkmConnection.
An [EkmConnection][google.cloud.kms.v1.EkmConnection] represents an
individual EKM connection. It can be used for creating
[CryptoKeys][google.cloud.kms.v1.CryptoKey] and
[CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] with a
[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of
[EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC], as well as
performing cryptographic operations using keys created within the
[EkmConnection][google.cloud.kms.v1.EkmConnection].
Optional. Identifies the EKM Crypto Space that this
[EkmConnection][google.cloud.kms.v1.EkmConnection] maps to. Note: This
field is required if
[KeyManagementMode][google.cloud.kms.v1.EkmConnection.KeyManagementMode] is
[CLOUD_KMS][google.cloud.kms.v1.EkmConnection.KeyManagementMode.CLOUD_KMS].
public EkmConnection.Types.KeyManagementMode KeyManagementMode { get; set; }
Optional. Describes who can perform control plane operations on the EKM. If
unset, this defaults to
[MANUAL][google.cloud.kms.v1.EkmConnection.KeyManagementMode.MANUAL].
public RepeatedField<EkmConnection.Types.ServiceResolver> ServiceResolvers { get; }
Optional. A list of
[ServiceResolvers][google.cloud.kms.v1.EkmConnection.ServiceResolver] where
the EKM can be reached. There should be one ServiceResolver per EKM
replica. Currently, only a single
[ServiceResolver][google.cloud.kms.v1.EkmConnection.ServiceResolver] is
supported.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe latest version of the Google Cloud Key Management Service v1 API class EkmConnection is 3.16.0, with several previous versions available, ranging down to 2.2.0.\u003c/p\u003e\n"],["\u003cp\u003eThe EkmConnection class represents an individual EKM connection, enabling the creation of CryptoKeys and CryptoKeyVersions with an EXTERNAL_VPC ProtectionLevel and facilitating cryptographic operations using keys within the connection.\u003c/p\u003e\n"],["\u003cp\u003eEkmConnection includes properties like CreateTime, CryptoSpacePath, EkmConnectionName, Etag, KeyManagementMode, Name, and ServiceResolvers, allowing for detailed configuration and management of EKM connections.\u003c/p\u003e\n"],["\u003cp\u003eThe EkmConnection class, which implements IMessage, IEquatable, IDeepCloneable, and IBufferMessage interfaces, has constructors that allow the creation of a new instance and the cloning of an existing one, supporting various initialization options.\u003c/p\u003e\n"],["\u003cp\u003eThe EkmConnection resource is identified by a unique name in the format \u003ccode\u003eprojects/*/locations/*/ekmConnections/*\u003c/code\u003e, and the API supports the optional definition of ServiceResolvers to specify how the EKM can be reached.\u003c/p\u003e\n"]]],[],null,["# Google Cloud Key Management Service v1 API - Class EkmConnection (3.18.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.18.0 (latest)](/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.EkmConnection)\n- [3.17.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.17.0/Google.Cloud.Kms.V1.EkmConnection)\n- [3.16.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.16.0/Google.Cloud.Kms.V1.EkmConnection)\n- [3.15.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.15.0/Google.Cloud.Kms.V1.EkmConnection)\n- [3.14.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.14.0/Google.Cloud.Kms.V1.EkmConnection)\n- [3.13.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.13.0/Google.Cloud.Kms.V1.EkmConnection)\n- [3.12.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.12.0/Google.Cloud.Kms.V1.EkmConnection)\n- [3.11.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.11.0/Google.Cloud.Kms.V1.EkmConnection)\n- [3.10.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.10.0/Google.Cloud.Kms.V1.EkmConnection)\n- [3.9.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.9.0/Google.Cloud.Kms.V1.EkmConnection)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.8.0/Google.Cloud.Kms.V1.EkmConnection)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.7.0/Google.Cloud.Kms.V1.EkmConnection)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.6.0/Google.Cloud.Kms.V1.EkmConnection)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.5.0/Google.Cloud.Kms.V1.EkmConnection)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.4.0/Google.Cloud.Kms.V1.EkmConnection)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.3.0/Google.Cloud.Kms.V1.EkmConnection)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.2.0/Google.Cloud.Kms.V1.EkmConnection)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.1.0/Google.Cloud.Kms.V1.EkmConnection)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/3.0.0/Google.Cloud.Kms.V1.EkmConnection)\n- [2.9.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/2.9.0/Google.Cloud.Kms.V1.EkmConnection)\n- [2.8.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/2.8.0/Google.Cloud.Kms.V1.EkmConnection)\n- [2.7.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/2.7.0/Google.Cloud.Kms.V1.EkmConnection)\n- [2.6.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/2.6.0/Google.Cloud.Kms.V1.EkmConnection)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/2.5.0/Google.Cloud.Kms.V1.EkmConnection)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/2.4.0/Google.Cloud.Kms.V1.EkmConnection)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/2.3.0/Google.Cloud.Kms.V1.EkmConnection)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.Kms.V1/2.2.0/Google.Cloud.Kms.V1.EkmConnection) \n\n public sealed class EkmConnection : IMessage\u003cEkmConnection\u003e, IEquatable\u003cEkmConnection\u003e, IDeepCloneable\u003cEkmConnection\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Google Cloud Key Management Service v1 API class EkmConnection.\n\nAn \\[EkmConnection\\]\\[google.cloud.kms.v1.EkmConnection\\] represents an\nindividual EKM connection. It can be used for creating\n\\[CryptoKeys\\]\\[google.cloud.kms.v1.CryptoKey\\] and\n\\[CryptoKeyVersions\\]\\[google.cloud.kms.v1.CryptoKeyVersion\\] with a\n\\[ProtectionLevel\\]\\[google.cloud.kms.v1.ProtectionLevel\\] of\n\\[EXTERNAL_VPC\\]\\[google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC\\], as well as\nperforming cryptographic operations using keys created within the\n\\[EkmConnection\\]\\[google.cloud.kms.v1.EkmConnection\\]. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e EkmConnection \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[EkmConnection](/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.EkmConnection), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[EkmConnection](/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.EkmConnection), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[EkmConnection](/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.EkmConnection), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Kms.V1](/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.Kms.V1.dll\n\nConstructors\n------------\n\n### EkmConnection()\n\n public EkmConnection()\n\n### EkmConnection(EkmConnection)\n\n public EkmConnection(EkmConnection other)\n\nProperties\n----------\n\n### CreateTime\n\n public Timestamp CreateTime { get; set; }\n\nOutput only. The time at which the\n\\[EkmConnection\\]\\[google.cloud.kms.v1.EkmConnection\\] was created.\n\n### CryptoSpacePath\n\n public string CryptoSpacePath { get; set; }\n\nOptional. Identifies the EKM Crypto Space that this\n\\[EkmConnection\\]\\[google.cloud.kms.v1.EkmConnection\\] maps to. Note: This\nfield is required if\n\\[KeyManagementMode\\]\\[google.cloud.kms.v1.EkmConnection.KeyManagementMode\\] is\n\\[CLOUD_KMS\\]\\[google.cloud.kms.v1.EkmConnection.KeyManagementMode.CLOUD_KMS\\].\n\n### EkmConnectionName\n\n public EkmConnectionName EkmConnectionName { get; set; }\n\n[EkmConnectionName](/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.EkmConnectionName)-typed view over the [Name](/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.EkmConnection#Google_Cloud_Kms_V1_EkmConnection_Name) resource name property.\n\n### Etag\n\n public string Etag { get; set; }\n\nOptional. Etag of the currently stored\n\\[EkmConnection\\]\\[google.cloud.kms.v1.EkmConnection\\].\n\n### KeyManagementMode\n\n public EkmConnection.Types.KeyManagementMode KeyManagementMode { get; set; }\n\nOptional. Describes who can perform control plane operations on the EKM. If\nunset, this defaults to\n\\[MANUAL\\]\\[google.cloud.kms.v1.EkmConnection.KeyManagementMode.MANUAL\\].\n\n### Name\n\n public string Name { get; set; }\n\nOutput only. The resource name for the\n\\[EkmConnection\\]\\[google.cloud.kms.v1.EkmConnection\\] in the format\n`projects/*/locations/*/ekmConnections/*`.\n\n### ServiceResolvers\n\n public RepeatedField\u003cEkmConnection.Types.ServiceResolver\u003e ServiceResolvers { get; }\n\nOptional. A list of\n\\[ServiceResolvers\\]\\[google.cloud.kms.v1.EkmConnection.ServiceResolver\\] where\nthe EKM can be reached. There should be one ServiceResolver per EKM\nreplica. Currently, only a single\n\\[ServiceResolver\\]\\[google.cloud.kms.v1.EkmConnection.ServiceResolver\\] is\nsupported."]]
