Reference documentation and code samples for the Cloud Spanner V1 Client class EncryptionConfig.
Encryption configuration for a Cloud Spanner database.
Generated from protobuf message google.spanner.admin.database.v1.EncryptionConfig
Namespace
Google \ Cloud \ Spanner \ Admin \ Database \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ kms_key_name
string
The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
↳ kms_key_names
array
Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>. The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples: * * For single region database instance configs, specify a single regional location KMS key. * * For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * * For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.
getKmsKeyName
The Cloud KMS key to be used for encrypting and decrypting
the database. Values are of the form
projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
Returns
Type
Description
string
setKmsKeyName
The Cloud KMS key to be used for encrypting and decrypting
the database. Values are of the form
projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getKmsKeyNames
Specifies the KMS configuration for the one or more keys used to encrypt
the database. Values are of the form
projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
The keys referenced by kms_key_names must fully cover all
regions of the database instance configuration. Some examples:
For single region database instance configs, specify a single regional
location KMS key.
For multi-regional database instance configs of type GOOGLE_MANAGED,
either specify a multi-regional location KMS key or multiple regional
location KMS keys that cover all regions in the instance config.
For a database instance config of type USER_MANAGED, please specify only
regional location KMS keys to cover each region in the instance config.
Multi-regional location KMS keys are not supported for USER_MANAGED
instance configs.
Specifies the KMS configuration for the one or more keys used to encrypt
the database. Values are of the form
projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
The keys referenced by kms_key_names must fully cover all
regions of the database instance configuration. Some examples:
For single region database instance configs, specify a single regional
location KMS key.
For multi-regional database instance configs of type GOOGLE_MANAGED,
either specify a multi-regional location KMS key or multiple regional
location KMS keys that cover all regions in the instance config.
For a database instance config of type USER_MANAGED, please specify only
regional location KMS keys to cover each region in the instance config.
Multi-regional location KMS keys are not supported for USER_MANAGED
instance configs.
[[["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-08-28 UTC."],[],[],null,["# Cloud Spanner V1 Client - Class EncryptionConfig (1.104.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.104.0 (latest)](/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.EncryptionConfig)\n- [1.103.0](/php/docs/reference/cloud-spanner/1.103.0/Admin.Database.V1.EncryptionConfig)\n- [1.102.0](/php/docs/reference/cloud-spanner/1.102.0/Admin.Database.V1.EncryptionConfig)\n- [1.101.0](/php/docs/reference/cloud-spanner/1.101.0/Admin.Database.V1.EncryptionConfig)\n- [1.100.0](/php/docs/reference/cloud-spanner/1.100.0/Admin.Database.V1.EncryptionConfig)\n- [1.98.0](/php/docs/reference/cloud-spanner/1.98.0/Admin.Database.V1.EncryptionConfig)\n- [1.97.0](/php/docs/reference/cloud-spanner/1.97.0/Admin.Database.V1.EncryptionConfig)\n- [1.96.0](/php/docs/reference/cloud-spanner/1.96.0/Admin.Database.V1.EncryptionConfig)\n- [1.95.0](/php/docs/reference/cloud-spanner/1.95.0/Admin.Database.V1.EncryptionConfig)\n- [1.94.0](/php/docs/reference/cloud-spanner/1.94.0/Admin.Database.V1.EncryptionConfig)\n- [1.93.1](/php/docs/reference/cloud-spanner/1.93.1/Admin.Database.V1.EncryptionConfig)\n- [1.92.1](/php/docs/reference/cloud-spanner/1.92.1/Admin.Database.V1.EncryptionConfig)\n- [1.91.0](/php/docs/reference/cloud-spanner/1.91.0/Admin.Database.V1.EncryptionConfig)\n- [1.90.0](/php/docs/reference/cloud-spanner/1.90.0/Admin.Database.V1.EncryptionConfig)\n- [1.89.0](/php/docs/reference/cloud-spanner/1.89.0/Admin.Database.V1.EncryptionConfig)\n- [1.88.0](/php/docs/reference/cloud-spanner/1.88.0/Admin.Database.V1.EncryptionConfig)\n- [1.87.0](/php/docs/reference/cloud-spanner/1.87.0/Admin.Database.V1.EncryptionConfig)\n- [1.86.0](/php/docs/reference/cloud-spanner/1.86.0/Admin.Database.V1.EncryptionConfig)\n- [1.85.0](/php/docs/reference/cloud-spanner/1.85.0/Admin.Database.V1.EncryptionConfig)\n- [1.84.0](/php/docs/reference/cloud-spanner/1.84.0/Admin.Database.V1.EncryptionConfig)\n- [1.83.0](/php/docs/reference/cloud-spanner/1.83.0/Admin.Database.V1.EncryptionConfig)\n- [1.82.0](/php/docs/reference/cloud-spanner/1.82.0/Admin.Database.V1.EncryptionConfig)\n- [1.81.0](/php/docs/reference/cloud-spanner/1.81.0/Admin.Database.V1.EncryptionConfig)\n- [1.80.0](/php/docs/reference/cloud-spanner/1.80.0/Admin.Database.V1.EncryptionConfig)\n- [1.79.0](/php/docs/reference/cloud-spanner/1.79.0/Admin.Database.V1.EncryptionConfig)\n- [1.78.0](/php/docs/reference/cloud-spanner/1.78.0/Admin.Database.V1.EncryptionConfig)\n- [1.77.0](/php/docs/reference/cloud-spanner/1.77.0/Admin.Database.V1.EncryptionConfig)\n- [1.76.1](/php/docs/reference/cloud-spanner/1.76.1/Admin.Database.V1.EncryptionConfig)\n- [1.68.0](/php/docs/reference/cloud-spanner/1.68.0/Admin.Database.V1.EncryptionConfig)\n- [1.67.0](/php/docs/reference/cloud-spanner/1.67.0/Admin.Database.V1.EncryptionConfig)\n- [1.66.0](/php/docs/reference/cloud-spanner/1.66.0/Admin.Database.V1.EncryptionConfig)\n- [1.65.0](/php/docs/reference/cloud-spanner/1.65.0/Admin.Database.V1.EncryptionConfig)\n- [1.64.0](/php/docs/reference/cloud-spanner/1.64.0/Admin.Database.V1.EncryptionConfig)\n- [1.63.2](/php/docs/reference/cloud-spanner/1.63.2/Admin.Database.V1.EncryptionConfig)\n- [1.62.1](/php/docs/reference/cloud-spanner/1.62.1/Admin.Database.V1.EncryptionConfig)\n- [1.61.0](/php/docs/reference/cloud-spanner/1.61.0/Admin.Database.V1.EncryptionConfig)\n- [1.60.0](/php/docs/reference/cloud-spanner/1.60.0/Admin.Database.V1.EncryptionConfig)\n- [1.59.0](/php/docs/reference/cloud-spanner/1.59.0/Admin.Database.V1.EncryptionConfig)\n- [1.58.4](/php/docs/reference/cloud-spanner/1.58.4/Admin.Database.V1.EncryptionConfig)\n- [1.57.0](/php/docs/reference/cloud-spanner/1.57.0/Admin.Database.V1.EncryptionConfig)\n- [1.56.0](/php/docs/reference/cloud-spanner/1.56.0/Admin.Database.V1.EncryptionConfig)\n- [1.55.0](/php/docs/reference/cloud-spanner/1.55.0/Admin.Database.V1.EncryptionConfig)\n- [1.54.2](/php/docs/reference/cloud-spanner/1.54.2/Admin.Database.V1.EncryptionConfig) \nReference documentation and code samples for the Cloud Spanner V1 Client class EncryptionConfig.\n\nEncryption configuration for a Cloud Spanner database.\n\nGenerated from protobuf message `google.spanner.admin.database.v1.EncryptionConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Spanner \\\\ Admin \\\\ Database \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getKmsKeyName\n\nThe Cloud KMS key to be used for encrypting and decrypting\nthe database. Values are of the form\n`projects/\u003cproject\u003e/locations/\u003clocation\u003e/keyRings/\u003ckey_ring\u003e/cryptoKeys/\u003ckms_key_name\u003e`.\n\n### setKmsKeyName\n\nThe Cloud KMS key to be used for encrypting and decrypting\nthe database. Values are of the form\n`projects/\u003cproject\u003e/locations/\u003clocation\u003e/keyRings/\u003ckey_ring\u003e/cryptoKeys/\u003ckms_key_name\u003e`.\n\n### getKmsKeyNames\n\nSpecifies the KMS configuration for the one or more keys used to encrypt\nthe database. Values are of the form\n`projects/\u003cproject\u003e/locations/\u003clocation\u003e/keyRings/\u003ckey_ring\u003e/cryptoKeys/\u003ckms_key_name\u003e`.\n\nThe keys referenced by kms_key_names must fully cover all\nregions of the database instance configuration. Some examples:\n\n- For single region database instance configs, specify a single regional location KMS key.\n- For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config.\n- For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.\n\n### setKmsKeyNames\n\nSpecifies the KMS configuration for the one or more keys used to encrypt\nthe database. Values are of the form\n`projects/\u003cproject\u003e/locations/\u003clocation\u003e/keyRings/\u003ckey_ring\u003e/cryptoKeys/\u003ckms_key_name\u003e`.\n\nThe keys referenced by kms_key_names must fully cover all\nregions of the database instance configuration. Some examples:\n\n- For single region database instance configs, specify a single regional location KMS key.\n- For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config.\n- For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs."]]