A KMS key is identified by itsproject_id,location,key_ring, andkms_key_name.
Note:This class makes no effort to validate the components of the key, It is the application's responsibility to provide a valid project id, location, key ring, and KMS key name. Passing invalid values will not be checked until the key is used in a RPC.
Seehttps://cloud.google.com/kms/docsfor more information on KMS.
Constructors
KmsKeyName
Parameter
Name
Description
KmsKeyName const &
KmsKeyName
Parameter
Name
Description
KmsKeyName &&
KmsKeyName
Constructs aKmsKeyNameobject identified by the givenproject_id,location,key_ring, andkms_key_name.
Parameters
Name
Description
project_id
std::string const &
location
std::string const &
key_ring
std::string const &
kms_key_name
std::string const &
Operators
operator=
Parameter
Name
Description
KmsKeyName const &
Returns
Type
Description
KmsKeyName &
operator=
Parameter
Name
Description
KmsKeyName &&
Returns
Type
Description
KmsKeyName &
Functions
FullName
Returns the fully qualified KMS Key name as a string of the form: "projects/
[[["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."],[[["\u003cp\u003eThis page details the \u003ccode\u003eKmsKeyName\u003c/code\u003e class, which is used to identify a Google Cloud KMS key using its \u003ccode\u003eproject_id\u003c/code\u003e, \u003ccode\u003elocation\u003c/code\u003e, \u003ccode\u003ekey_ring\u003c/code\u003e, and \u003ccode\u003ekms_key_name\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe class does not validate the key's components, meaning it is the application's responsibility to provide valid values.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version available is \u003ccode\u003e2.37.0-rc\u003c/code\u003e, with various prior versions, down to \u003ccode\u003e2.10.1\u003c/code\u003e, also being accessible.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eKmsKeyName\u003c/code\u003e objects can be constructed using specified \u003ccode\u003eproject_id\u003c/code\u003e, \u003ccode\u003elocation\u003c/code\u003e, \u003ccode\u003ekey_ring\u003c/code\u003e, and \u003ccode\u003ekms_key_name\u003c/code\u003e, or using move or copy semantics.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eFullName\u003c/code\u003e function returns the fully qualified KMS Key name as a string.\u003c/p\u003e\n"]]],[],null,["# Class google::cloud::KmsKeyName (2.10.1)\n\nVersion 2.10.1keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/common/latest/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.41.0](/cpp/docs/reference/common/2.41.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.40.0](/cpp/docs/reference/common/2.40.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.39.0](/cpp/docs/reference/common/2.39.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.38.0](/cpp/docs/reference/common/2.38.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.37.0](/cpp/docs/reference/common/2.37.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.36.0](/cpp/docs/reference/common/2.36.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.35.0](/cpp/docs/reference/common/2.35.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.34.0](/cpp/docs/reference/common/2.34.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.33.0](/cpp/docs/reference/common/2.33.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.32.0](/cpp/docs/reference/common/2.32.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.31.0](/cpp/docs/reference/common/2.31.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.30.0](/cpp/docs/reference/common/2.30.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.29.0](/cpp/docs/reference/common/2.29.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.28.0](/cpp/docs/reference/common/2.28.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.27.0](/cpp/docs/reference/common/2.27.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.26.0](/cpp/docs/reference/common/2.26.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.25.1](/cpp/docs/reference/common/2.25.1/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.24.0](/cpp/docs/reference/common/2.24.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.23.0](/cpp/docs/reference/common/2.23.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.22.1](/cpp/docs/reference/common/2.22.1/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.21.0](/cpp/docs/reference/common/2.21.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.20.0](/cpp/docs/reference/common/2.20.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.19.0](/cpp/docs/reference/common/2.19.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.18.0](/cpp/docs/reference/common/2.18.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.17.0](/cpp/docs/reference/common/2.17.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.16.0](/cpp/docs/reference/common/2.16.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.15.1](/cpp/docs/reference/common/2.15.1/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.14.0](/cpp/docs/reference/common/2.14.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.13.0](/cpp/docs/reference/common/2.13.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.12.0](/cpp/docs/reference/common/2.12.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.11.0](/cpp/docs/reference/common/2.11.0/classgoogle_1_1cloud_1_1KmsKeyName)\n- [2.10.1](/cpp/docs/reference/common/2.10.1/classgoogle_1_1cloud_1_1KmsKeyName) \nThis class identifies a Google Cloud KMS Key. \nA KMS key is identified by its `project_id`, `location`, `key_ring`, and `kms_key_name`.\n\u003e **Note:**\n\u003e This class makes no effort to validate the components of the key, It is the application's responsibility to provide a valid project id, location, key ring, and KMS key name. Passing invalid values will not be checked until the key is used in a RPC.\n\u003e See \u003chttps://cloud.google.com/kms/docs\u003e for more information on KMS.\n\nConstructors\n------------\n\n### KmsKeyName\n\n### KmsKeyName\n\n### KmsKeyName\n\nConstructs a [KmsKeyName](/cpp/docs/reference/common/2.10.1/classgoogle_1_1cloud_1_1KmsKeyName) object identified by the given `project_id`, `location`, `key_ring`, and `kms_key_name`.\n\nOperators\n---------\n\n### operator=\n\n### operator=\n\nFunctions\n---------\n\n### FullName\n\nReturns the fully qualified KMS Key name as a string of the form: \"projects/"]]
