Reference documentation and code samples for the Cloud Spanner Database Admin V1 API class Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig.
Encryption configuration for the backup to create.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#encryption_type
def encryption_type() -> ::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig::EncryptionType
- (::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig::EncryptionType) — Required. The encryption type of the backup.
#encryption_type=
def encryption_type=(value) -> ::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig::EncryptionType
- value (::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig::EncryptionType) — Required. The encryption type of the backup.
- (::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig::EncryptionType) — Required. The encryption type of the backup.
#kms_key_name
def kms_key_name() -> ::String
-
(::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 formprojects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>
.
#kms_key_name=
def kms_key_name=(value) -> ::String
-
value (::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 formprojects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<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 formprojects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>
.
#kms_key_names
def kms_key_names() -> ::Array<::String>
-
(::Array<::String>) —
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>
.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.
#kms_key_names=
def kms_key_names=(value) -> ::Array<::String>
-
value (::Array<::String>) —
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>
.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.
-
(::Array<::String>) —
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>
.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.