Reference documentation and code samples for the Cloud Spanner V1 Client class CopyBackupEncryptionConfig.
Encryption configuration for the copied backup.
Generated from protobuf message google.spanner.admin.database.v1.CopyBackupEncryptionConfig
Namespace
Google \ Cloud \ Spanner \ Admin \ Database \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ encryption_type
int
Required. The encryption type of the backup.
↳ kms_key_name
string
Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
↳ kms_key_names
array
Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>. Kms keys specified can be in any order. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * * For single region instance configs, specify a single regional location KMS key. * * For multi-regional 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 an 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.
getEncryptionType
Required. The encryption type of the backup.
Returns
Type
Description
int
setEncryptionType
Required. The encryption type of the backup.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getKmsKeyName
Optional. The Cloud KMS key that will be used to protect the backup.
This field should be set only when
encryption_type
is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form
projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
Returns
Type
Description
string
setKmsKeyName
Optional. The Cloud KMS key that will be used to protect the backup.
This field should be set only when
encryption_type
is CUSTOMER_MANAGED_ENCRYPTION. 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
Optional. Specifies the KMS configuration for the one or more keys used to
protect the backup. Values are of the form
projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
Kms keys specified can be in any order.
The keys referenced by kms_key_names must fully cover all
regions of the backup's instance configuration. Some examples:
For single region instance configs, specify a single regional
location KMS key.
For multi-regional 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 an 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.
Optional. Specifies the KMS configuration for the one or more keys used to
protect the backup. Values are of the form
projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
Kms keys specified can be in any order.
The keys referenced by kms_key_names must fully cover all
regions of the backup's instance configuration. Some examples:
For single region instance configs, specify a single regional
location KMS key.
For multi-regional 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 an 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-09-04 UTC."],[],[],null,["# Cloud Spanner V1 Client - Class CopyBackupEncryptionConfig (1.104.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.104.0 (latest)](/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.103.0](/php/docs/reference/cloud-spanner/1.103.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.102.0](/php/docs/reference/cloud-spanner/1.102.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.101.0](/php/docs/reference/cloud-spanner/1.101.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.100.0](/php/docs/reference/cloud-spanner/1.100.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.98.0](/php/docs/reference/cloud-spanner/1.98.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.97.0](/php/docs/reference/cloud-spanner/1.97.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.96.0](/php/docs/reference/cloud-spanner/1.96.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.95.0](/php/docs/reference/cloud-spanner/1.95.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.94.0](/php/docs/reference/cloud-spanner/1.94.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.93.1](/php/docs/reference/cloud-spanner/1.93.1/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.92.1](/php/docs/reference/cloud-spanner/1.92.1/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.91.0](/php/docs/reference/cloud-spanner/1.91.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.90.0](/php/docs/reference/cloud-spanner/1.90.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.89.0](/php/docs/reference/cloud-spanner/1.89.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.88.0](/php/docs/reference/cloud-spanner/1.88.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.87.0](/php/docs/reference/cloud-spanner/1.87.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.86.0](/php/docs/reference/cloud-spanner/1.86.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.85.0](/php/docs/reference/cloud-spanner/1.85.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.84.0](/php/docs/reference/cloud-spanner/1.84.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.83.0](/php/docs/reference/cloud-spanner/1.83.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.82.0](/php/docs/reference/cloud-spanner/1.82.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.81.0](/php/docs/reference/cloud-spanner/1.81.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.80.0](/php/docs/reference/cloud-spanner/1.80.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.79.0](/php/docs/reference/cloud-spanner/1.79.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.78.0](/php/docs/reference/cloud-spanner/1.78.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.77.0](/php/docs/reference/cloud-spanner/1.77.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.76.1](/php/docs/reference/cloud-spanner/1.76.1/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.68.0](/php/docs/reference/cloud-spanner/1.68.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.67.0](/php/docs/reference/cloud-spanner/1.67.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.66.0](/php/docs/reference/cloud-spanner/1.66.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.65.0](/php/docs/reference/cloud-spanner/1.65.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.64.0](/php/docs/reference/cloud-spanner/1.64.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.63.2](/php/docs/reference/cloud-spanner/1.63.2/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.62.1](/php/docs/reference/cloud-spanner/1.62.1/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.61.0](/php/docs/reference/cloud-spanner/1.61.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.60.0](/php/docs/reference/cloud-spanner/1.60.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.59.0](/php/docs/reference/cloud-spanner/1.59.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.58.4](/php/docs/reference/cloud-spanner/1.58.4/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.57.0](/php/docs/reference/cloud-spanner/1.57.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.56.0](/php/docs/reference/cloud-spanner/1.56.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.55.0](/php/docs/reference/cloud-spanner/1.55.0/Admin.Database.V1.CopyBackupEncryptionConfig)\n- [1.54.2](/php/docs/reference/cloud-spanner/1.54.2/Admin.Database.V1.CopyBackupEncryptionConfig) \nReference documentation and code samples for the Cloud Spanner V1 Client class CopyBackupEncryptionConfig.\n\nEncryption configuration for the copied backup.\n\nGenerated from protobuf message `google.spanner.admin.database.v1.CopyBackupEncryptionConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Spanner \\\\ Admin \\\\ Database \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getEncryptionType\n\nRequired. The encryption type of the backup.\n\n### setEncryptionType\n\nRequired. The encryption type of the backup.\n\n### getKmsKeyName\n\nOptional. The Cloud KMS key that will be used to protect the backup.\n\nThis field should be set only when\n[encryption_type](/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.CopyBackupEncryptionConfig#_Google_Cloud_Spanner_Admin_Database_V1_CopyBackupEncryptionConfig__getEncryptionType__)\nis `CUSTOMER_MANAGED_ENCRYPTION`. 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\nOptional. The Cloud KMS key that will be used to protect the backup.\n\nThis field should be set only when\n[encryption_type](/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.CopyBackupEncryptionConfig#_Google_Cloud_Spanner_Admin_Database_V1_CopyBackupEncryptionConfig__getEncryptionType__)\nis `CUSTOMER_MANAGED_ENCRYPTION`. 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\nOptional. Specifies the KMS configuration for the one or more keys used to\nprotect the backup. Values are of the form\n`projects/\u003cproject\u003e/locations/\u003clocation\u003e/keyRings/\u003ckey_ring\u003e/cryptoKeys/\u003ckms_key_name\u003e`.\n\nKms keys specified can be in any order.\nThe keys referenced by kms_key_names must fully cover all\nregions of the backup's instance configuration. Some examples:\n\n- For single region instance configs, specify a single regional location KMS key.\n- For multi-regional 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 an 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\nOptional. Specifies the KMS configuration for the one or more keys used to\nprotect the backup. Values are of the form\n`projects/\u003cproject\u003e/locations/\u003clocation\u003e/keyRings/\u003ckey_ring\u003e/cryptoKeys/\u003ckms_key_name\u003e`.\n\nKms keys specified can be in any order.\nThe keys referenced by kms_key_names must fully cover all\nregions of the backup's instance configuration. Some examples:\n\n- For single region instance configs, specify a single regional location KMS key.\n- For multi-regional 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 an 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."]]
