public sealed class Cluster.Types.EncryptionConfig : IMessage<Cluster.Types.EncryptionConfig>, IEquatable<Cluster.Types.EncryptionConfig>, IDeepCloneable<Cluster.Types.EncryptionConfig>, IBufferMessage, IMessage
Reference documentation and code samples for the Google Cloud Bigtable Administration v2 API class Cluster.Types.EncryptionConfig.
Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected
cluster.
Describes the Cloud KMS encryption key that will be used to protect the
destination Bigtable cluster. The requirements for this key are:
1) The Cloud Bigtable service account associated with the project that
contains this cluster must be granted the
cloudkms.cryptoKeyEncrypterDecrypter role on the CMEK key.
2) Only regional keys can be used and the region of the CMEK key must
match the region of the cluster.
Values are of the form
projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}
[[["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-08 UTC."],[[["\u003cp\u003eThis webpage provides documentation for the \u003ccode\u003eCluster.Types.EncryptionConfig\u003c/code\u003e class within the Google Cloud Bigtable Administration v2 API, specifically in the context of .NET development.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCluster.Types.EncryptionConfig\u003c/code\u003e class is used to define Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.\u003c/p\u003e\n"],["\u003cp\u003eThe page lists various versions of the Bigtable Admin v2 API, ranging from version 3.24.0 (latest) down to 2.4.0, each linking to its respective documentation, including the current version highlighted as the latest.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eEncryptionConfig\u003c/code\u003e class allows setting a \u003ccode\u003eKmsKeyName\u003c/code\u003e property, which is a string that holds the resource name of the Cloud KMS encryption key, including project, location, keyring and key, that will be used to protect the cluster.\u003c/p\u003e\n"],["\u003cp\u003eThe class implements several interfaces, such as \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, and includes constructors for creating new instances, either default or by copying existing encryption configurations.\u003c/p\u003e\n"]]],[],null,["# Google Cloud Bigtable Administration v2 API - Class Cluster.Types.EncryptionConfig (3.29.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.29.0 (latest)](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.28.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.28.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.27.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.27.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.26.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.26.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.25.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.25.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.24.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.24.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.23.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.23.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.22.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.22.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.21.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.21.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.20.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.20.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.19.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.19.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.18.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.18.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.17.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.17.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.16.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.16.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.15.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.15.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.14.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.14.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.13.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.13.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.12.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.12.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.11.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.11.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.10.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.10.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.9.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.9.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.8.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.7.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.6.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.5.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.4.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.3.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.2.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.1.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/3.0.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [2.9.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/2.9.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [2.8.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/2.8.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [2.7.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/2.7.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [2.6.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/2.6.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/2.5.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/2.4.0/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig) \n\n public sealed class Cluster.Types.EncryptionConfig : IMessage\u003cCluster.Types.EncryptionConfig\u003e, IEquatable\u003cCluster.Types.EncryptionConfig\u003e, IDeepCloneable\u003cCluster.Types.EncryptionConfig\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Google Cloud Bigtable Administration v2 API class Cluster.Types.EncryptionConfig.\n\nCloud Key Management Service (Cloud KMS) settings for a CMEK-protected\ncluster. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e Cluster.Types.EncryptionConfig \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Cluster](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Cluster)[Types](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Cluster.Types)[EncryptionConfig](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Cluster](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Cluster)[Types](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Cluster.Types)[EncryptionConfig](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Cluster](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Cluster)[Types](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Cluster.Types)[EncryptionConfig](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig), [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.Bigtable.Admin.V2](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2)\n\nAssembly\n--------\n\nGoogle.Cloud.Bigtable.Admin.V2.dll\n\nConstructors\n------------\n\n### EncryptionConfig()\n\n public EncryptionConfig()\n\n### EncryptionConfig(EncryptionConfig)\n\n public EncryptionConfig(Cluster.Types.EncryptionConfig other)\n\nProperties\n----------\n\n### KmsKeyName\n\n public string KmsKeyName { get; set; }\n\nDescribes the Cloud KMS encryption key that will be used to protect the\ndestination Bigtable cluster. The requirements for this key are:\n1) The Cloud Bigtable service account associated with the project that\ncontains this cluster must be granted the\n`cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key.\n2) Only regional keys can be used and the region of the CMEK key must\nmatch the region of the cluster.\nValues are of the form\n`projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`\n\n### KmsKeyNameAsCryptoKeyName\n\n public CryptoKeyName KmsKeyNameAsCryptoKeyName { get; set; }\n\n[CryptoKeyName](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.CryptoKeyName)-typed view over the [KmsKeyName](/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Cluster.Types.EncryptionConfig#Google_Cloud_Bigtable_Admin_V2_Cluster_Types_EncryptionConfig_KmsKeyName) resource name property."]]