Class: Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/spanner/admin/database/v1/backup.rb

Overview

Encryption configuration for the backup to create.

Defined Under Namespace

Modules: EncryptionType

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_type ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig::EncryptionType

Returns Required. The encryption type of the backup.

Returns:



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 514

class CreateBackupEncryptionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Encryption types for the backup.
  module EncryptionType
    # Unspecified. Do not use.
    ENCRYPTION_TYPE_UNSPECIFIED = 0

    # Use the same encryption configuration as the database. This is the
    # default option when
    # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig encryption_config} is empty.
    # For example, if the database is using `Customer_Managed_Encryption`, the
    # backup will be using the same Cloud KMS key as the database.
    USE_DATABASE_ENCRYPTION = 1

    # Use Google default encryption.
    GOOGLE_DEFAULT_ENCRYPTION = 2

    # Use customer managed encryption. If specified, `kms_key_name`
    # must contain a valid Cloud KMS key.
    CUSTOMER_MANAGED_ENCRYPTION = 3
  end
end

#kms_key_name ⇒ ::String

Returns 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:

  • (::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>.



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 514

class CreateBackupEncryptionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Encryption types for the backup.
  module EncryptionType
    # Unspecified. Do not use.
    ENCRYPTION_TYPE_UNSPECIFIED = 0

    # Use the same encryption configuration as the database. This is the
    # default option when
    # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig encryption_config} is empty.
    # For example, if the database is using `Customer_Managed_Encryption`, the
    # backup will be using the same Cloud KMS key as the database.
    USE_DATABASE_ENCRYPTION = 1

    # Use Google default encryption.
    GOOGLE_DEFAULT_ENCRYPTION = 2

    # Use customer managed encryption. If specified, `kms_key_name`
    # must contain a valid Cloud KMS key.
    CUSTOMER_MANAGED_ENCRYPTION = 3
  end
end