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 \ V1Methods
__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 |
↳ kms_key_names |
array
Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form |
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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setKmsKeyNames
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.
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |